[GEN][ZH] Fix undefined behavior with MemoryPoolObject::deleteInstance

Core/GameEngine/Source/Common/System/XferSave.cpp

@@ -91,7 +91,7 @@ XferSave::~XferSave( void )
 		{
 
 			next = m_blockStack->next;
-			m_blockStack->deleteInstance();
+			deleteInstance(m_blockStack);
 			m_blockStack = next;
 
 		}  // end while
@@ -247,7 +247,7 @@ void XferSave::endBlock( void )
 	fseek( m_fileFP, currentFilePos, SEEK_SET );
 
 	// delete the block data as it's all used up now
-	top->deleteInstance();
+	deleteInstance(top);
 
 }  // end endBlock
 

Generals/Code/GameEngine/Include/Common/GameMemory.h

@@ -756,17 +756,21 @@ class MemoryPoolObject
 
 public: 
 
-	void deleteInstance() 
+	static void deleteInstance(MemoryPoolObject* mpo) 
 	{	
-		if (this)
+		if (mpo)
 		{
-			MemoryPool *pool = this->getObjectMemoryPool(); // save this, since the dtor will nuke our vtbl
-			this->~MemoryPoolObject();	// it's virtual, so the right one will be called.
-			pool->freeBlock((void *)this); 
+			MemoryPool *pool = mpo->getObjectMemoryPool(); // save this, since the dtor will nuke our vtbl
+			mpo->~MemoryPoolObject();	// it's virtual, so the right one will be called.
+			pool->freeBlock((void *)mpo); 
 		}
 	} 
 };
 
+inline void deleteInstance(MemoryPoolObject* mpo)
+{
+	MemoryPoolObject::deleteInstance(mpo);
+}
 
 
 // INLINING ///////////////////////////////////////////////////////////////////
@@ -906,22 +910,10 @@ class MemoryPoolObjectHolder
 	MemoryPoolObjectHolder(MemoryPoolObject *mpo = NULL) : m_mpo(mpo) { }
 	void hold(MemoryPoolObject *mpo) { DEBUG_ASSERTCRASH(!m_mpo, ("already holding")); m_mpo = mpo; }
 	void release() { m_mpo = NULL; }
-	~MemoryPoolObjectHolder() { m_mpo->deleteInstance(); }
+	~MemoryPoolObjectHolder() { deleteInstance(m_mpo); }
 };
 
 
-// ----------------------------------------------------------------------------
-/**
-	Sometimes you want to make a class's destructor protected so that it can only
-	be destroyed under special circumstances. MemoryPoolObject short-circuits this
-	by making the destructor always be protected, and the true delete technique
-	(namely, deleteInstance) always public by default. You can simulate the behavior
-	you really want by including this macro 
-*/
-#define MEMORY_POOL_DELETEINSTANCE_VISIBILITY(ARGVIS)\
-ARGVIS:	void deleteInstance() { MemoryPoolObject::deleteInstance(); } public: 
-
-
 #define EMPTY_DTOR(CLASS) inline CLASS::~CLASS() { }
 
 #endif // _GAME_MEMORY_H_

Generals/Code/GameEngine/Include/Common/GameMemoryNull.h

@@ -108,12 +108,17 @@ class MemoryPoolObject
 
 public:
 
-	void deleteInstance() 
+	static void deleteInstance(MemoryPoolObject* mpo) 
 	{
-		delete this;
+		delete mpo;
 	}
 };
 
+inline void deleteInstance(MemoryPoolObject* mpo)
+{
+	MemoryPoolObject::deleteInstance(mpo);
+}
+
 
 /**
 	Initialize the memory manager. Construct a new MemoryPoolFactory and 

Generals/Code/GameEngine/Include/Common/Overridable.h

@@ -108,7 +108,7 @@ class Overridable : public MemoryPoolObject
 		{
 			if ( m_isOverride )
 			{
-				deleteInstance();
+				deleteInstance(this);
 				return NULL;
 			}
 			else if ( m_nextOverride )
@@ -123,7 +123,7 @@ class Overridable : public MemoryPoolObject
 __inline Overridable::~Overridable() 
 {
 	if (m_nextOverride) 
-		m_nextOverride->deleteInstance();
+		deleteInstance(m_nextOverride);
 }
 
 

Generals/Code/GameEngine/Include/Common/ThingTemplate.h

@@ -159,7 +159,7 @@ class AudioArray
 	{
 		for (Int i = 0; i < TTAUDIO_COUNT; ++i)
 			if (m_audio[i])
-				m_audio[i]->deleteInstance();
+				deleteInstance(m_audio[i]);
 	}
 
 	AudioArray(const AudioArray& that)

Generals/Code/GameEngine/Include/GameLogic/Object.h

@@ -158,8 +158,6 @@ class Object : public Thing, public Snapshot
 {
 
 	MEMORY_POOL_GLUE_WITH_USERLOOKUP_CREATE(Object, "ObjectPool" )		
-	/// destructor is non-public in order to require the use of TheGameLogic->destroyObject()
-	MEMORY_POOL_DELETEINSTANCE_VISIBILITY(protected)
 
 public:
 
@@ -386,7 +384,7 @@ class Object : public Thing, public Snapshot
 	Bool isInList(Object **pListHead) const;
 
 	// this is intended for use ONLY by GameLogic.
-	void friend_deleteInstance() { deleteInstance(); }
+	static void friend_deleteInstance(Object* object) { deleteInstance(object); }
 
 	/// cache the partition module (should be called only by PartitionData)
 	void friend_setPartitionData(PartitionData *pd) { m_partitionData = pd; }
@@ -765,6 +763,9 @@ class Object : public Thing, public Snapshot
 
 };  // end class Object
 
+// deleteInstance is not meant to be used with Object in order to require the use of TheGameLogic->destroyObject()
+void deleteInstance(Object* object) CPP_11(= delete);
+
 // describe an object as an AsciiString: e.g. "Object 102 (KillerBuggy) [GLARocketBuggy, owned by player 2 (GLAIntroPlayer)]"
 AsciiString DebugDescribeObject(const Object *obj);
 

Generals/Code/GameEngine/Include/GameLogic/ObjectIter.h

@@ -67,7 +67,7 @@ enum IterOrderType CPP_11(: Int)
 	{
 		// do something with other
 	}
-	iter->deleteInstance();								// you own it, so you must delete it
+	deleteInstance(iter);								// you own it, so you must delete it
 
 	note that the iterator is required to deal intelligently with deleted objects; 
 	in particular, next() will check if an obj has been killed and simply skip it.

Generals/Code/GameEngine/Source/Common/Audio/GameAudio.cpp

@@ -188,7 +188,7 @@ AudioManager::~AudioManager()
 	for (it = m_allAudioEventInfo.begin(); it != m_allAudioEventInfo.end(); ++it) {
 		AudioEventInfo *eventInfo = (*it).second;
 		if (eventInfo) {
-			eventInfo->deleteInstance();
+			deleteInstance(eventInfo);
 			eventInfo = NULL;
 		}
 	}
@@ -811,7 +811,7 @@ AudioRequest *AudioManager::allocateAudioRequest( Bool useAudioEvent )
 void AudioManager::releaseAudioRequest( AudioRequest *requestToRelease )
 {
 	if (requestToRelease) {
-		requestToRelease->deleteInstance();
+		deleteInstance(requestToRelease);
 	}
 }
 
@@ -894,7 +894,7 @@ void AudioManager::removeLevelSpecificAudioEventInfos(void)
 
     if ( it->second->isLevelSpecific() )
     {
-      it->second->deleteInstance();
+      deleteInstance(it->second);
       m_allAudioEventInfo.erase( it );
     }
 

Generals/Code/GameEngine/Source/Common/GameEngine.cpp

@@ -536,7 +536,7 @@ void GameEngine::reset( void )
 	if(background)
 	{
 		background->destroyWindows();
-		background->deleteInstance();
+		deleteInstance(background);
 		background = NULL;
 	}
 }

Generals/Code/GameEngine/Source/Common/GlobalData.cpp

@@ -1061,7 +1061,7 @@ GlobalData::~GlobalData( void )
 	DEBUG_ASSERTCRASH( TheWritableGlobalData->m_next == NULL, ("~GlobalData: theOriginal is not original\n") );
 
 	if (m_weaponBonusSet)
-		m_weaponBonusSet->deleteInstance();
+		deleteInstance(m_weaponBonusSet);
 
 	if( m_theOriginal == this )	{
 		m_theOriginal = NULL;

Generals/Code/GameEngine/Source/Common/INI/INI.cpp

@@ -1151,7 +1151,7 @@ void INI::parseDynamicAudioEventRTS( INI *ini, void * /*instance*/, void *store,
 	{
 		if (*theSound)
 		{
-			(*theSound)->deleteInstance();
+			deleteInstance(*theSound);
 			*theSound = NULL;
 		}
 	}

Generals/Code/GameEngine/Source/Common/MessageStream.cpp

@@ -79,7 +79,7 @@ GameMessage::~GameMessage( )
 	for( arg = m_argList; arg; arg=nextArg )
 	{
 		nextArg = arg->m_next;
-		arg->deleteInstance();
+		deleteInstance(arg);
 	}
 
 	// detach message from list
@@ -678,7 +678,7 @@ GameMessageList::~GameMessageList()
 		// set list ptr to null to avoid it trying to remove itself from the list
 		// that we are in the process of nuking...
 		msg->friend_setList(NULL);
-		msg->deleteInstance();
+		deleteInstance(msg);
 	}
 }
 
@@ -1064,7 +1064,7 @@ void MessageStream::propagateMessages( void )
 				next = msg->next();
 				if (disp == DESTROY_MESSAGE)
 				{
-					msg->deleteInstance();
+					deleteInstance(msg);
 				}
 			} 
 			else 
@@ -1151,7 +1151,7 @@ void CommandList::destroyAllMessages( void )
 	for( msg=m_firstMessage; msg; msg=next )
 	{
 		next = msg->next();
-		msg->deleteInstance();
+		deleteInstance(msg);
 	}
 
 	m_firstMessage = NULL;

Generals/Code/GameEngine/Source/Common/NameKeyGenerator.cpp

@@ -81,7 +81,7 @@ void NameKeyGenerator::freeSockets()
 		for (Bucket *b = m_sockets[i]; b; b = next)
 		{
 			next = b->m_nextInSocket;
-			b->deleteInstance();
+			deleteInstance(b);
 		}
 		m_sockets[i] = NULL;
 	}