Jump to content

  • Log In with Google      Sign In   
  • Create Account

Interested in a FREE copy of HTML5 game maker Construct 2?

We'll be giving away three Personal Edition licences in next Tuesday's GDNet Direct email newsletter!

Sign up from the right-hand sidebar on our homepage and read Tuesday's newsletter for details!


Class instances gone wrong!

  • You cannot reply to this topic
26 replies to this topic

#1 blueshogun96   Crossbones+   -  Reputation: 1035

Like
2Likes
Like

Posted 20 March 2013 - 09:09 PM

Dear C++ newbies, experts and all of you people in between,

 

Today, I ended up doing something really stupid, and I don't want any of you doing what I did today.  If breakpoints and debugging features are part of your IDE, please, for the love of God, please use them!  sad.png

 

While working on a new game concept I thought of a couple of days ago, I stopped and thought to myself "I'm going to use C++ this time and not use pure C to avoid the mistake of letting my cross platform code base getting messy again now that I'm more comfortable with the various mobile and desktop APIs and what not".  So I start writing my basic application classes with portability in mind.  For reasons I don't feel like getting into, I made my decision to use OpenGL via GLUT on MacOSX.  I know, I know, I've never recommended GLUT in the past, but this time, I felt like using it since the game only uses either a mouse or a touch screen anyway (except for the old fashioned exit procedure; the escape key).

 

I don't know about you, but I have a tendancy to think about how I want my app to execute!  I liking having my main() function contain as little code as possible.  With that in mind, I ended up writing my main.cpp file to look like this:

 

game_app_t* app = NULL;

void exit_func()
{
    if( app )
        delete app;
}

//-----------------------------------------------------------------------------
// Name: main
// Desc: Program entry point.
//-----------------------------------------------------------------------------
int main( int argc, char* argv[] )
{
    atexit( exit_func );
    app = new game_app_t;

    return 0;
}

 

Okay, hold on, I promise you the problem with this code is NOT that obvious!  You're probably thinking "Yeah, no s@#% sherlock! You didn't call delete or your game loop function!"  Actually, I did.  The class constructor calls the initialization function where glutMainLoop is called upon success.  Instinctively, I check my code to verify that everything is uninitialized properly, even more than I check for successful initialization.  So I put a breakpoint inside of exit_func to verify that it's being called (well, I knew the function works, but I habitually check anyway).  Just in case you're wondering, the code for my class (the initialization stuff) looked like this:

 


#include "game.h"
#include <assert.h>


/* Useful macros */
#define safe_delete(x) if(x) { delete x; x = NULL; }
#define fail_safe(x) if(!x) return;

/* Global class instance */
game_app_t* This = NULL;


/* Default constructor/deconstructor */
game_app_t::game_app_t()
{
    this->init();
}

game_app_t::~game_app_t()
{
    this->uninit();
}

/* Initialization and uninitialization */
bool game_app_t::init()
{
    /* Set global class instance */
    This = this;
    
    /* Initialize OpenGL */
    m_ogldrv = new ogldrv_t();
    assert( m_ogldrv != NULL );
    
    if( !m_ogldrv->init( 0, NULL, 640, 480, GLUT_RGBA | GLUT_DOUBLE | GLUT_DEPTH, "Loop-til" ) )
        return false;
    
    /* Set default callbacks */
    glutDisplayFunc( this->display_func );
    glutIdleFunc( this->idle_func );
    glutKeyboardFunc( this->keyboard_func );
    glutReshapeFunc( this->reshape_func );
    glutMouseFunc( this->mouse_click_func );
    glutPassiveMotionFunc( this->mouse_move_func );
    
    /* Start the main loop */
    glutMainLoop();
    
    return true;
}

void game_app_t::uninit()
{
    safe_delete( m_ogldrv );
}

/* Event callback functions */
void game_app_t::display_func()
{
    fail_safe(This->m_ogldrv);
    
    /* Clear the rendering buffers */
    This->m_ogldrv->clear_buffers();
    
    /* Swap the double buffer */
    This->m_ogldrv->swap_buffers();
}

void game_app_t::idle_func()
{
    glutPostRedisplay();
}

/* Blah blah blah */

 

 

And yes, the event callback functions were declared as static, so I needed an extra copy of my this pointer.  Since there only needs to be one instance of this class, it doesn't really matter, IMHO.

 

This is where I found my REAL problem: app is still NULL!  I was kinda dumbfounded when I realized that the class instance didn't get uninitialized (hence my deconstructor was never called).  I spent a few minutes going over the code to see why this wasn't working.  The last thing I wanted was to be leaking memory every launch.  After a few more moments of scratching my head, I realized that the problem was that it the call to "new" doesn't return anyway.  So the logical thing to do was to use the copy of my this pointer and delete that explicitly instead.  After that thought, I added another function:

 

void game_app_t::exit_func()
{
    safe_delete(This);
}


/* Added after setting all the other callbacks */
atexit( this->exit_func );

 

So, I added a breakpoint, ran my app in debug mode, and this time, my class instance not only gets deleted properly, but now my deconstructor gets called, and calls the uninit function.  Bam, problem solved!  Now my main function looks like this:

int main( int argc, char* argv[] )
{
    new game_app_t;

    return 0;
} 

 

So short, so sweet.  Isn't C++ great once you use it properly?

 

So, the moral of the story is- "Don't be as stupid as Shogun?"  Yeah, that too, but please, use your breakpoints and always, ALWAYS, cover your digital butt!  I've seen a handful of rookie game programmers who have never learned to use breakpoints (I was one of those).  What I did was dumb.  I made this mistake for you, please don't do it for yourself. ph34r.png

 

Shogun.

 

 


Follow Shogun3D on the official website: http://shogun3d.net

 

blogger.png twitter.png tumblr_32.png facebook.png

 

"Yo mama so fat, she can't be frustum culled." - yoshi_lol


Sponsor:

#2 Alpha_ProgDes   Crossbones+   -  Reputation: 4692

Like
0Likes
Like

Posted 20 March 2013 - 09:35 PM

I have a question. Why are these macros and not methods or even functions?

/* Useful macros */
#define safe_delete(x) if(x) { delete x; x = NULL; }
#define fail_safe(x) if(!x) return;
 

Beginner in Game Development? Read here.
 
Super Mario Bros clone tutorial written in XNA 4.0 [MonoGame, ANX, and MonoXNA] by Scott Haley
 
If you have found any of the posts helpful, please show your appreciation by clicking the up arrow on those posts Posted Image
 
Spoiler

#3 Alpha_ProgDes   Crossbones+   -  Reputation: 4692

Like
0Likes
Like

Posted 20 March 2013 - 09:40 PM

Another question. Why are you using

/* Global class instance */
game_app_t* This = NULL;
 

 

and not

 

int main( int argc, char* argv[] )
{
    app = new game_app_t();
    /* where game_app_t is an actual class */
    return 0;
}
 

Beginner in Game Development? Read here.
 
Super Mario Bros clone tutorial written in XNA 4.0 [MonoGame, ANX, and MonoXNA] by Scott Haley
 
If you have found any of the posts helpful, please show your appreciation by clicking the up arrow on those posts Posted Image
 
Spoiler

#4 Hodgman   Moderators   -  Reputation: 30850

Like
3Likes
Like

Posted 20 March 2013 - 10:15 PM

Why 'new' tongue.png
int main()
{
    game_app_t app;
}

I have a question. Why are these macros and not methods or even functions?

/* Useful macros */
#define fail_safe(x) if(!x) return;
 


That would make a pretty good WTF as a function ;)
void fail_safe(void* x) { if(!x) return; }
void game_app_t::display_func()
{
    fail_safe(This->m_ogldrv);
    
    /* Clear the rendering buffers */
    This->m_ogldrv->clear_buffers();
    
    /* Swap the double buffer */
    This->m_ogldrv->swap_buffers();
}


#5 Alpha_ProgDes   Crossbones+   -  Reputation: 4692

Like
0Likes
Like

Posted 21 March 2013 - 12:09 AM

Why 'new' tongue.png

int main()
{
    game_app_t app;
}

I have a question. Why are these macros and not methods or even functions?

/* Useful macros */
#define fail_safe(x) if(!x) return;
 

 

That would make a pretty good WTF as a function ;)
void fail_safe(void* x) { if(!x) return; }
void game_app_t::display_func()
{
    fail_safe(This->m_ogldrv);
    
    /* Clear the rendering buffers */
    This->m_ogldrv->clear_buffers();
    
    /* Swap the double buffer */
    This->m_ogldrv->swap_buffers();
}

 

Be nice. I haven't C++'d since college. But I've been VB.net and C#'ing for years now :D lol

 

Though in all seriousness, shouldn't fail_safe be an exception in a function as opposed to a macro?

 

Note: I'm well aware that the OP is moving from C to C++, so idiomatic C++ is not expected from the start. But there's no harm in asking :)


Beginner in Game Development? Read here.
 
Super Mario Bros clone tutorial written in XNA 4.0 [MonoGame, ANX, and MonoXNA] by Scott Haley
 
If you have found any of the posts helpful, please show your appreciation by clicking the up arrow on those posts Posted Image
 
Spoiler

#6 blueshogun96   Crossbones+   -  Reputation: 1035

Like
0Likes
Like

Posted 21 March 2013 - 10:05 PM

Wow, you guys are mean! tongue.png

 

 

I have a question. Why are these macros and not methods or even functions?

/* Useful macros */
#define safe_delete(x) if(x) { delete x; x = NULL; }
#define fail_safe(x) if(!x) return;

 

Does it matter?

 

 

Another question. Why are you using

/* Global class instance */
game_app_t* This = NULL;
 

 

and not

 

int main( int argc, char* argv[] )
{
    app = new game_app_t();
    /* where game_app_t is an actual class */
    return 0;
}
 

 

Well, you can't explicitly use "this" in a static function, hence why I created a copy of it.  I didn't feel like changing the code structure again if I didn't have to.  Second, I forgot to add the '()'.

 

Mr. Hodgeman, I'm a "heap freak". smile.png

 

Oh, and the macros were just a quick way of getting around. Second, macros can be more optimal (IMO) and for small operations I'd much rather use them to do things that require 2 lines of code than an actual short function.  Even if you inline a function that you use frequently, a macro is faster because the compiler doesn't have to push the parameters, call the function, pop them off the stack, do push the registers (eax, ebx, etc.), do whatever, restore the registers and return.  I know that it doesn't impact performance really, but after writing and reading so much assembly code, I tend to think about these things a bit too much.

 

Shogun


Edited by blueshogun96, 21 March 2013 - 10:18 PM.

Follow Shogun3D on the official website: http://shogun3d.net

 

blogger.png twitter.png tumblr_32.png facebook.png

 

"Yo mama so fat, she can't be frustum culled." - yoshi_lol


#7 Alpha_ProgDes   Crossbones+   -  Reputation: 4692

Like
0Likes
Like

Posted 21 March 2013 - 10:19 PM

Does it matter?

 

I'll let skilled C++ programmers answer that. As I would just be saying stuff that may or may not be true.


Beginner in Game Development? Read here.
 
Super Mario Bros clone tutorial written in XNA 4.0 [MonoGame, ANX, and MonoXNA] by Scott Haley
 
If you have found any of the posts helpful, please show your appreciation by clicking the up arrow on those posts Posted Image
 
Spoiler

#8 Hodgman   Moderators   -  Reputation: 30850

Like
5Likes
Like

Posted 21 March 2013 - 10:36 PM

Does it matter?

Inline functions are preferred over macros in most C++ style guides, and should only be used where absolutely necessary.

In the case of safe_delete, an inline function is just as applicable, which means a macro isn't necessary.

 

template<class T> void safe_delete(T* x) { delete x; x = NULL; }

BTW, the if isn't necessary, as delete NULL; is valid (it does nothing) -- the if statement is often put there by programmers who learned on MSVC 6.0, which implemented "Microsoft C++", rather than C++98.

 

The main evilness about macros is that they don't obey C++ name scoping rules, so they can inadvertantly break other code.

e.g. say that I buy your code as a bit of middleware, and #include it into my own code that follows:

 

#include "cool_middleware.h"
namespace hodgman
{
  template<class T> void safe_delete(T* x) { if(x) x->Release; }
 
  void Frobnicate(Foo* foo)
  {
    foo->DoStuff();
    safe_delete(foo);
  }
}

This as soon as I #include your code in this file, my code breaks because of the macro! It becomes quite different:

 

 
  void Frobnicate(Foo* foo)
  {
    foo->DoStuff();
    if(foo) { delete foo; foo = NULL; }
  }

If you'd used an inline function for safe_delete, then everything would be fine

 

Further reading:

http://www.parashift.com/c++-faq/inline-vs-macros.html

http://www.parashift.com/c++-faq/macros-with-if.html

http://www.parashift.com/c++-faq/macros-with-multi-stmts.html

http://www.parashift.com/c++-faq/macros-with-token-pasting.html


Edited by Hodgman, 21 March 2013 - 11:16 PM.


#9 IncidentRay   Members   -  Reputation: 154

Like
2Likes
Like

Posted 21 March 2013 - 10:52 PM

template void safe_delete(T* x) { delete x; x = NULL; }

 

This should probably be safe_delete(T*& x) as otherwise you're only assigning the local variable to NULL.


Edited by IncidentRay, 21 March 2013 - 10:52 PM.


#10 blueshogun96   Crossbones+   -  Reputation: 1035

Like
0Likes
Like

Posted 21 March 2013 - 10:53 PM

Wow, are you psychic or something?  How did you know I started with MSVC 6.0? dry.png   Heh, I guess when you're experienced enough, it's just obvious.

 

As you can see, I'm really old fashioned.  No one ever told me that delete NULL was valid, so I'm going to gladly take your advice.

 

Shogun.


Follow Shogun3D on the official website: http://shogun3d.net

 

blogger.png twitter.png tumblr_32.png facebook.png

 

"Yo mama so fat, she can't be frustum culled." - yoshi_lol


#11 Cornstalks   Crossbones+   -  Reputation: 6991

Like
2Likes
Like

Posted 21 March 2013 - 10:55 PM

So short, so sweet.  Isn't C++ great once you use it properly?

Sure, except for you're not using it properly (to put it bluntly). Seeing as the constructor never finishes being called, and the non-trivial destructor is called (while effectively in the constructor), you've officially invoked undefined behavior. See this StackOverflow question for some details
[ I was ninja'd 71 times before I stopped counting a long time ago ] [ f.k.a. MikeTacular ] [ My Blog ] [ SWFer: Gaplessly looped MP3s in your Flash games ]

#12 blueshogun96   Crossbones+   -  Reputation: 1035

Like
0Likes
Like

Posted 21 March 2013 - 11:04 PM

So short, so sweet.  Isn't C++ great once you use it properly?

Sure, except for you're not using it properly (to put it bluntly). Seeing as the constructor never finishes being called, and the non-trivial destructor is called (while effectively in the constructor), you've officially invoked undefined behavior. See this StackOverflow question for some details

What if I used the stack instead?


Follow Shogun3D on the official website: http://shogun3d.net

 

blogger.png twitter.png tumblr_32.png facebook.png

 

"Yo mama so fat, she can't be frustum culled." - yoshi_lol


#13 Cornstalks   Crossbones+   -  Reputation: 6991

Like
1Likes
Like

Posted 21 March 2013 - 11:07 PM

What if I used the stack instead?

Nope. First, you can't delete things on the stack. And second, even if you manually called the destructor, it's still undefined behavior. If you use the non-trivial destructor in any way before returning from the constructor, it's undefined behavior.

Edited by Cornstalks, 21 March 2013 - 11:12 PM.

[ I was ninja'd 71 times before I stopped counting a long time ago ] [ f.k.a. MikeTacular ] [ My Blog ] [ SWFer: Gaplessly looped MP3s in your Flash games ]

#14 Hodgman   Moderators   -  Reputation: 30850

Like
0Likes
Like

Posted 21 March 2013 - 11:14 PM

Wow, are you psychic or something?  How did you know I started with MSVC 6.0? dry.png   Heh, I guess when you're experienced enough, it's just obvious.

Hahahah, I didn't actually mean to level that particular accusation at you! I actually assumed you'd picked up that macro from reading tutorials etc, as it's quite common, due to MSVC 6 being very popular back in the day.
It was where I cut my teeth on C++ as well cool.png



#15 blueshogun96   Crossbones+   -  Reputation: 1035

Like
1Likes
Like

Posted 21 March 2013 - 11:26 PM

^lol, no worries.  I started C++ before .net and ended up picking up many bad programming practices.  Back then, I was very smug and thought I knew everything (mostly because I stayed in a small town in the midwest where there was no one to challenge what little skill I had, or call me out on my BS).  Even then, I had no excuse.  That what you guys are for. wink.png

 

What if I used the stack instead?

Nope. First, you can't delete things on the stack. And second, even if you manually called the destructor, it's still undefined behavior. If you use the non-trivial destructor in any way before returning from the constructor, it's undefined behavior.

Well, I'd never call delete on a stack object. >.<

 

I was thinking of changing it to this so the constructor returns and the lifecycle begins:

 

int main(...)
{
    game_app_t* app = new game_app_t();
    app->kick_off(); /* Start the main loop */

    return 0;
}

 

Shogun.


Follow Shogun3D on the official website: http://shogun3d.net

 

blogger.png twitter.png tumblr_32.png facebook.png

 

"Yo mama so fat, she can't be frustum culled." - yoshi_lol


#16 Ectara   Crossbones+   -  Reputation: 3015

Like
0Likes
Like

Posted 22 March 2013 - 12:03 AM

 

I have a question. Why are these macros and not methods or even functions?

/* Useful macros */
#define safe_delete(x) if(x) { delete x; x = NULL; }
#define fail_safe(x) if(!x) return;

 

Does it matter?

/* I'll be clever with some temporary variables... */
Foo ** ptr = array_of_arrays_of_foo;
while(length--)
        safe_delete(*(ptr++));

safe_delete(array_of_arrays_of_foo);

Wait, why did I segfault?



#17 blueshogun96   Crossbones+   -  Reputation: 1035

Like
0Likes
Like

Posted 22 March 2013 - 12:33 AM

What does that have to do with macros and functions?

 

Shogun.


Follow Shogun3D on the official website: http://shogun3d.net

 

blogger.png twitter.png tumblr_32.png facebook.png

 

"Yo mama so fat, she can't be frustum culled." - yoshi_lol


#18 Ectara   Crossbones+   -  Reputation: 3015

Like
0Likes
Like

Posted 22 March 2013 - 02:10 AM

What does that have to do with macros and functions?



Shogun.

 

Everything. If it were a function, it'd be conceptually like this:

x = *(ptr++);
if(x){
        delete x;
        x = NULL;
}

Since it is a macro, which deals only with tokens and knows nothing about the other phases of compilation, it looks (literally) like this:

if(*(ptr++)) { delete *(ptr++); *(ptr++) = NULL; }

Notice how I only increment once in the invocation of the macro, but the token "x" is replaced with the macro parameter three times, resulting in it incrementing the pointer three separate times. This puts it past the end of the array, and causes undefined behavior.

Anybody (you, or someone else that uses your code) might make the assumption that this wouldn't happen. You might forget the body of the macro, and later on do something like I posted, which will crash the program. My policy on it is if the macro is to be used outside of that module that it was defined, it should not have any multiple-evaluation side effects; otherwise, I should provide it as a function, instead. I only use "unsafe" (in this sense) macros where I know what all of the inputs will be, and can guarantee that it will be safe.

I'm sure it's in a C/C++ FAQ somewhere, but here are a couple articles I found with a quick search:
http://www.brainbell.com/tutors/c/Advice_and_Warnings_for_C/Macros_and_Miscellaneous_Pitfalls.html
http://www.mikeash.com/pyblog/friday-qa-2010-12-31-c-macro-tips-and-tricks.html

The reason we're asking is because there are now better tools to do these things, and if you are not careful, this can come back to bite you. Also, most debuggers can't step into a macro invocation; they'll display the line where the macro was invoked, so it is up to you to figure out how the preprocessor expanded the macro, and what went wrong by hand, or dump the preprocessed output through compiler switches, and sift through it manually.

 

compiler doesn't have to push the parameters, call the function, pop them off the stack, do push the registers (eax, ebx, etc.), do whatever, restore the registers and return.


Also, I want to point out, that this is exactly what inline functions were designed to do. The body of the function is compiled "inline" where it is called. For your example, a macro and an inline function would have more or less the exact same result. Different compilers have different rules for what they will and won't inline, and how small the function must be for it to be inlined. However, for an inline function to do this task, it will do none of the things you mentioned, and essentially generate the same code that the macro would have, given that it was used correctly. It might even wind up being more efficient, by storing the result of x once and reusing it, rather than recalculating it three times, with potentially harmful side-effects.

Edited by Ectara, 22 March 2013 - 03:15 AM.


#19 wintertime   Members   -  Reputation: 1790

Like
2Likes
Like

Posted 22 March 2013 - 04:58 AM

Oh please forget about such safe_delete macros. They are not safe as you still need to not forget to call them. You are still in the half C and half C++ trap.

Also that Java method of using new for everything when you could just use a normal stackvariable is more complicated, more dangerous of making errors and slower at same time.

Even if you want to use new, think about using std::unique_ptr which automagically calls delete for you.



#20 Postie   Members   -  Reputation: 1039

Like
0Likes
Like

Posted 22 March 2013 - 05:59 PM

This thread is a perfect example of why only experienced programmers should learn c++.

 

Not trying to start a holy war, c++ has its place, but the assumed knowledge to prevent shooting your own foot off is pretty high. :)


Currently working on an open world survival RPG - For info check out my Development blog: ByteWrangler





PARTNERS