refactor: modernize NULL to nullptr

Core/GameEngine/Include/Common/ArchiveFileSystem.h

@@ -156,8 +156,8 @@ class ArchiveFileSystem : public SubsystemInterface
 protected:
 	struct ArchivedDirectoryInfoResult
 	{
-		ArchivedDirectoryInfoResult() : dirInfo(NULL) {}
-		Bool valid() const { return dirInfo != NULL; }
+		ArchivedDirectoryInfoResult() : dirInfo(nullptr) {}
+		Bool valid() const { return dirInfo != nullptr; }
 
 		ArchivedDirectoryInfo* dirInfo;
 		AsciiString lastToken; ///< Synonymous for file name if the search directory was a file path

Core/GameEngine/Include/Common/AsciiString.h

@@ -353,7 +353,7 @@ class AsciiString
 		token was found. (note that this modifies 'this' as well, stripping
 		the token off!)
 	*/
-	Bool nextToken(AsciiString* token, const char* seps = NULL);
+	Bool nextToken(AsciiString* token, const char* seps = nullptr);
 
 	/**
 		return true iff the string is "NONE" (case-insensitive).
@@ -420,7 +420,7 @@ inline int AsciiString::getByteCount() const
 inline Bool AsciiString::isEmpty() const
 {
 	validate();
-	return m_data == NULL || peek()[0] == 0;
+	return m_data == nullptr || peek()[0] == 0;
 }
 
 // -----------------------------------------------------

Core/GameEngine/Include/Common/AudioEventInfo.h

@@ -123,8 +123,8 @@ struct AudioEventInfo : public MemoryPoolObject
 
   // DynamicAudioEventInfo interfacing functions
   virtual Bool isLevelSpecific() const { return false; } ///< If true, this sound is only defined on the current level and can be deleted when that level ends
-  virtual DynamicAudioEventInfo * getDynamicAudioEventInfo() { return NULL; }  ///< If this object is REALLY a DynamicAudioEventInfo, return a pointer to the derived class
-  virtual const DynamicAudioEventInfo * getDynamicAudioEventInfo() const { return NULL; } ///< If this object is REALLY a DynamicAudioEventInfo, return a pointer to the derived class
+  virtual DynamicAudioEventInfo * getDynamicAudioEventInfo() { return nullptr; }  ///< If this object is REALLY a DynamicAudioEventInfo, return a pointer to the derived class
+  virtual const DynamicAudioEventInfo * getDynamicAudioEventInfo() const { return nullptr; } ///< If this object is REALLY a DynamicAudioEventInfo, return a pointer to the derived class
 
   /// Is this a permenant sound? That is, if I start this sound up, will it ever end
   /// "on its own" or only if I explicitly kill it?

Core/GameEngine/Include/Common/GameAudio.h

@@ -134,7 +134,7 @@ class AudioManager : public SubsystemInterface
 		AudioManager();
 		virtual ~AudioManager();
 #if defined(RTS_DEBUG)
-		virtual void audioDebugDisplay(DebugDisplayInterface *dd, void *userData, FILE *fp = NULL ) = 0;
+		virtual void audioDebugDisplay(DebugDisplayInterface *dd, void *userData, FILE *fp = nullptr ) = 0;
 #endif
 
 		// From SubsystemInterface
@@ -395,7 +395,7 @@ class AudioManagerDummy : public AudioManager
 	virtual AsciiString getMusicTrackName() const { return ""; }
 	virtual void openDevice() {}
 	virtual void closeDevice() {}
-	virtual void* getDevice() { return NULL; }
+	virtual void* getDevice() { return nullptr; }
 	virtual void notifyOfAudioCompletion(UnsignedInt audioCompleted, UnsignedInt flags) {}
 	virtual UnsignedInt getProviderCount(void) const { return 0; };
 	virtual AsciiString getProviderName(UnsignedInt providerNum) const { return ""; }
@@ -416,7 +416,7 @@ class AudioManagerDummy : public AudioManager
 	virtual void removePlayingAudio(AsciiString eventName) {}
 	virtual void removeAllDisabledAudio() {}
 	virtual Bool has3DSensitiveStreamsPlaying(void) const { return false; }
-	virtual void* getHandleForBink(void) { return NULL; }
+	virtual void* getHandleForBink(void) { return nullptr; }
 	virtual void releaseHandleForBink(void) {}
 	virtual void friend_forcePlayAudioEventRTS(const AudioEventRTS* eventToPlay) {}
 	virtual void setPreferredProvider(AsciiString providerNdx) {}

Core/GameEngine/Include/Common/GameMemory.h

@@ -321,7 +321,7 @@ class MemoryPool
 	void addToList(MemoryPool **pHead);				///< add this pool to head of the linked list
 	void removeFromList(MemoryPool **pHead);	///< remove this pool from the linked list
 	#ifdef MEMORYPOOL_DEBUG
-		static void debugPoolInfoReport( MemoryPool *pool, FILE *fp = NULL );	///< dump a report about this pool to the logfile
+		static void debugPoolInfoReport( MemoryPool *pool, FILE *fp = nullptr );	///< dump a report about this pool to the logfile
 		const char *debugGetBlockTagString(void *pBlock);		///< return the tagstring for the given block (assumed to belong to this pool)
 		void debugMemoryVerifyPool();												///< perform internal consistency check on this pool.
 		Int debugPoolReportLeaks( const char* owner );
@@ -421,7 +421,7 @@ class DynamicMemoryAllocator
 		Int debugCalcRawBlockBytes(Int *numBlocks);												///< calculate the number of bytes in "raw" (non-subpool) blocks
 		void debugMemoryVerifyDma();												///< perform internal consistency check
 		const char *debugGetBlockTagString(void *pBlock);		///< return the tagstring for the given block (assumed to belong to this dma)
-		void debugDmaInfoReport( FILE *fp = NULL );					///< dump a report about this pool to the logfile
+		void debugDmaInfoReport( FILE *fp = nullptr );					///< dump a report about this pool to the logfile
 		Int debugDmaReportLeaks();
 	#endif
 	#ifdef MEMORYPOOL_CHECKPOINTING
@@ -545,7 +545,7 @@ class MemoryPoolFactory
 	/// destroy the contents of all pools and dmas. (the pools and dma's are not destroyed, just reset)
 	void reset();
 
-	void memoryPoolUsageReport( const char* filename, FILE *appendToFileInstead = NULL );
+	void memoryPoolUsageReport( const char* filename, FILE *appendToFileInstead = nullptr );
 
 	#ifdef MEMORYPOOL_DEBUG
 
@@ -559,7 +559,7 @@ class MemoryPoolFactory
 		const char *debugGetBlockTagString(void *pBlock);
 
 		/// dump a report with the given options to the logfile.
-		void debugMemoryReport(Int flags, Int startCheckpoint, Int endCheckpoint, FILE *fp = NULL );
+		void debugMemoryReport(Int flags, Int startCheckpoint, Int endCheckpoint, FILE *fp = nullptr );
 
 		void debugSetInitFillerIndex(Int index);
 
@@ -589,7 +589,7 @@ private: \
 			order-of-execution problem for static variables, ensuring this is not executed \
 			prior to the initialization of TheMemoryPoolFactory. \
 		*/ \
-		DEBUG_ASSERTCRASH(TheMemoryPoolFactory, ("TheMemoryPoolFactory is NULL")); \
+		DEBUG_ASSERTCRASH(TheMemoryPoolFactory, ("TheMemoryPoolFactory is nullptr")); \
 		static MemoryPool *The##ARGCLASS##Pool = TheMemoryPoolFactory->findMemoryPool(ARGPOOLNAME); \
 		DEBUG_ASSERTCRASH(The##ARGCLASS##Pool, ("Pool \"%s\" not found (did you set it up in initMemoryPools?)", ARGPOOLNAME)); \
 		DEBUG_ASSERTCRASH(The##ARGCLASS##Pool->getAllocationSize() >= sizeof(ARGCLASS), ("Pool \"%s\" is too small for this class (currently %d, need %d)", ARGPOOLNAME, The##ARGCLASS##Pool->getAllocationSize(), sizeof(ARGCLASS))); \
@@ -608,7 +608,7 @@ private: \
 			order-of-execution problem for static variables, ensuring this is not executed \
 			prior to the initialization of TheMemoryPoolFactory. \
 		*/ \
-		DEBUG_ASSERTCRASH(TheMemoryPoolFactory, ("TheMemoryPoolFactory is NULL")); \
+		DEBUG_ASSERTCRASH(TheMemoryPoolFactory, ("TheMemoryPoolFactory is nullptr")); \
 		static MemoryPool *The##ARGCLASS##Pool = TheMemoryPoolFactory->createMemoryPool(ARGPOOLNAME, sizeof(ARGCLASS), ARGINITIAL, ARGOVERFLOW); \
 		DEBUG_ASSERTCRASH(The##ARGCLASS##Pool, ("Pool \"%s\" not found (did you set it up in initMemoryPools?)", ARGPOOLNAME)); \
 		DEBUG_ASSERTCRASH(The##ARGCLASS##Pool->getAllocationSize() >= sizeof(ARGCLASS), ("Pool \"%s\" is too small for this class (currently %d, need %d)", ARGPOOLNAME, The##ARGCLASS##Pool->getAllocationSize(), sizeof(ARGCLASS))); \
@@ -902,9 +902,9 @@ class MemoryPoolObjectHolder
 private:
 	MemoryPoolObject *m_mpo;
 public:
-	MemoryPoolObjectHolder(MemoryPoolObject *mpo = NULL) : m_mpo(mpo) { }
+	MemoryPoolObjectHolder(MemoryPoolObject *mpo = nullptr) : m_mpo(mpo) { }
 	void hold(MemoryPoolObject *mpo) { DEBUG_ASSERTCRASH(!m_mpo, ("already holding")); m_mpo = mpo; }
-	void release() { m_mpo = NULL; }
+	void release() { m_mpo = nullptr; }
 	~MemoryPoolObjectHolder() { deleteInstance(m_mpo); }
 };
 

Core/GameEngine/Include/Common/GameMemoryNull.h

@@ -17,6 +17,7 @@
 */
 
 #pragma once
+#include <Utility/CppMacros.h>
 
 #define allocateBytes(ARGCOUNT,ARGLITERAL)          allocateBytesImplementation(ARGCOUNT)
 #define allocateBytesDoNotZero(ARGCOUNT,ARGLITERAL) allocateBytesDoNotZeroImplementation(ARGCOUNT)
@@ -64,11 +65,11 @@ class MemoryPoolFactory
 {
 public:
 
-	void memoryPoolUsageReport( const char* filename, FILE *appendToFileInstead = NULL );
+	void memoryPoolUsageReport( const char* filename, FILE *appendToFileInstead = nullptr );
 
 #ifdef MEMORYPOOL_DEBUG
 
-	void debugMemoryReport(Int flags, Int startCheckpoint, Int endCheckpoint, FILE *fp = NULL );
+	void debugMemoryReport(Int flags, Int startCheckpoint, Int endCheckpoint, FILE *fp = nullptr );
 	void debugSetInitFillerIndex(Int index);
 
 #endif

Core/GameEngine/Include/Common/LocalFile.h

@@ -103,7 +103,7 @@ class LocalFile : public File
 		virtual Int		writeChar( const WideChar* character );							///< Write a wide character to the file
 		virtual Int		seek( Int new_pos, seekMode mode = CURRENT );				///< Set file position: See File::seek
 		virtual Bool	flush();													///< flush data to disk
-		virtual void	nextLine(Char *buf = NULL, Int bufSize = 0);				///< moves file position to after the next new-line
+		virtual void	nextLine(Char *buf = nullptr, Int bufSize = 0);				///< moves file position to after the next new-line
 		virtual Bool	scanInt(Int &newInt);																///< return what gets read in as an integer at the current file position.
 		virtual Bool	scanReal(Real &newReal);														///< return what gets read in as a float at the current file position.
 		virtual	Bool	scanString(AsciiString &newString);									///< return what gets read in as a string at the current file position.

Core/GameEngine/Include/Common/RAMFile.h

@@ -94,7 +94,7 @@ class RAMFile : public File
 		virtual Int		writeChar( const WideChar* character );							///< Write a wide character to the file
 		virtual Int		seek( Int new_pos, seekMode mode = CURRENT );				///< Set file position: See File::seek
 		virtual Bool	flush();													///< flush data to disk
-		virtual void	nextLine(Char *buf = NULL, Int bufSize = 0);				///< moves current position to after the next new-line
+		virtual void	nextLine(Char *buf = nullptr, Int bufSize = 0);				///< moves current position to after the next new-line
 
 		virtual Bool	scanInt(Int &newInt);																///< return what gets read as an integer from the current memory position.
 		virtual Bool	scanReal(Real &newReal);														///< return what gets read as a float from the current memory position.

Core/GameEngine/Include/Common/Radar.h

@@ -143,7 +143,7 @@ static const char *const RadarPriorityNames[] =
 	"UNIT",													// unit level drawing priority
 	"LOCAL_UNIT_ONLY",							// unit priority, but only on the radar if controlled by the local player
 
-	NULL
+	nullptr
 };
 static_assert(ARRAY_SIZE(RadarPriorityNames) == RADAR_PRIORITY_NUM_PRIORITIES + 1, "Incorrect array size");
 #endif  // DEFINE_RADAR_PRIOTITY_NAMES
@@ -165,7 +165,7 @@ class Radar : public Snapshot,
 	virtual void update( void );														///< subsystem per frame update
 
 	// is the game window parameter the radar window
-	Bool isRadarWindow( GameWindow *window ) { return (m_radarWindow == window) && (m_radarWindow != NULL); }
+	Bool isRadarWindow( GameWindow *window ) { return (m_radarWindow == window) && (m_radarWindow != nullptr); }
 
 	Bool radarToWorld( const ICoord2D *radar, Coord3D *world );		///< radar point to world point on terrain
 	Bool radarToWorld2D( const ICoord2D *radar, Coord3D *world );		///< radar point to world point (x,y only!)

Core/GameEngine/Include/Common/StreamingArchiveFile.h

@@ -90,7 +90,7 @@ class StreamingArchiveFile : public RAMFile
 		virtual Int		seek( Int new_pos, seekMode mode = CURRENT );				///< Set file position: See File::seek
 
 		// Ini's should not be parsed with streaming files, that's just dumb.
-		virtual void	nextLine(Char *buf = NULL, Int bufSize = 0) { DEBUG_CRASH(("Should not call nextLine on a streaming file.")); }
+		virtual void	nextLine(Char *buf = nullptr, Int bufSize = 0) { DEBUG_CRASH(("Should not call nextLine on a streaming file.")); }
 		virtual Bool	scanInt(Int &newInt) { DEBUG_CRASH(("Should not call scanInt on a streaming file."));  return FALSE; }
 		virtual Bool	scanReal(Real &newReal) { DEBUG_CRASH(("Should not call scanReal on a streaming file.")); return FALSE; }
 		virtual Bool	scanString(AsciiString &newString) { DEBUG_CRASH(("Should not call scanString on a streaming file.")); return FALSE; }
@@ -99,7 +99,7 @@ class StreamingArchiveFile : public RAMFile
 		virtual Bool	openFromArchive(File *archiveFile, const AsciiString& filename, Int offset, Int size); ///< copy file data from the given file at the given offset for the given size.
 		virtual Bool	copyDataToFile(File *localFile) { DEBUG_CRASH(("Are you sure you meant to copyDataToFile on a streaming file?")); return FALSE; }
 
-		virtual char* readEntireAndClose() { DEBUG_CRASH(("Are you sure you meant to readEntireAndClose on a streaming file?")); return NULL; }
+		virtual char* readEntireAndClose() { DEBUG_CRASH(("Are you sure you meant to readEntireAndClose on a streaming file?")); return nullptr; }
 		virtual File* convertToRAMFile() { DEBUG_CRASH(("Are you sure you meant to readEntireAndClose on a streaming file?")); return this; }
 };
 

Core/GameEngine/Include/Common/UnicodeString.h

@@ -394,7 +394,7 @@ inline int UnicodeString::getByteCount() const
 inline Bool UnicodeString::isEmpty() const
 {
 	validate();
-	return m_data == NULL || peek()[0] == 0;
+	return m_data == nullptr || peek()[0] == 0;
 }
 
 // -----------------------------------------------------

Core/GameEngine/Include/Common/file.h

@@ -183,7 +183,7 @@ class File : public MemoryPoolObject
 																																				*  END: means seek the specified number of bytes back from the end of the file
 																																				*/
 		virtual Bool	flush() = 0;											///< flush data to disk
-		virtual void	nextLine(Char *buf = NULL, Int bufSize = 0) = 0;		///< reads until it reaches a new-line character
+		virtual void	nextLine(Char *buf = nullptr, Int bufSize = 0) = 0;		///< reads until it reaches a new-line character
 
 		virtual Bool	scanInt(Int &newInt) = 0;														///< read an integer from the current file position.
 		virtual Bool	scanReal(Real &newReal) = 0;												///< read a real number from the current file position.

Core/GameEngine/Include/GameClient/TerrainVisual.h

@@ -75,7 +75,7 @@ struct SeismicSimulationNode
     m_region.hi.x = 0;
     m_region.hi.y = 0;
     m_clean = FALSE;
-    callbackFilter = NULL;
+    callbackFilter = nullptr;
     m_life = 0;
     m_magnitude = DEFAULT_SEISMIC_SIMULATION_MAGNITUDE;
 
@@ -95,7 +95,7 @@ struct SeismicSimulationNode
     m_magnitude   = ssn.m_magnitude;
 
   }
-  SeismicSimulationNode( const Coord3D* ctr, Real rad, Real mag, SeismicSimulationFilterBase *cbf = NULL )
+  SeismicSimulationNode( const Coord3D* ctr, Real rad, Real mag, SeismicSimulationFilterBase *cbf = nullptr )
   {
     m_center.x    = REAL_TO_INT_FLOOR(ctr->x/MAP_XY_FACTOR);
     m_center.y    = REAL_TO_INT_FLOOR(ctr->y/MAP_XY_FACTOR);
@@ -114,7 +114,7 @@ struct SeismicSimulationNode
 
   SeismicSimulationFilterBase::SeismicSimStatusCode handleFilterCallback( WorldHeightMapInterfaceClass *heightMap )
   {
-    if ( callbackFilter == NULL )
+    if ( callbackFilter == nullptr )
       return SeismicSimulationFilterBase::SEISMIC_STATUS_INVALID;
 
     ++m_life;
@@ -126,7 +126,7 @@ struct SeismicSimulationNode
   {
     DEBUG_ASSERTCRASH( callbackFilter, ("SeismicSimulationNode::applyGravity() has no callback filter!") );
 
-    if ( callbackFilter == NULL )
+    if ( callbackFilter == nullptr )
       return velocityIn;//oops, we have no callback!
 
     return callbackFilter->applyGravityCallback( velocityIn );
@@ -186,7 +186,7 @@ static const char *const TerrainLODNames[] =
 	"AUTOMATIC",
 	"DISABLE",
 
-	NULL
+	nullptr
 };
 static_assert(ARRAY_SIZE(TerrainLODNames) == TERRAIN_LOD_NUM_TYPES + 1, "Incorrect array size");
 #endif  // end DEFINE_TERRAIN_LOD_NAMES
@@ -285,8 +285,8 @@ class TerrainVisual : public Snapshot,
   virtual void updateSeismicSimulations( void ) = 0; /// walk the SeismicSimulationList and, well, do it.
   virtual void addSeismicSimulation( const SeismicSimulationNode& sim ) = 0;
 #endif
-  virtual WorldHeightMap* getLogicHeightMap( void ) {return NULL;};
-  virtual WorldHeightMap* getClientHeightMap( void ) {return NULL;};
+  virtual WorldHeightMap* getLogicHeightMap( void ) {return nullptr;};
+  virtual WorldHeightMap* getClientHeightMap( void ) {return nullptr;};
   ////////////////////////////////////////////////////
   ////////////////////////////////////////////////////
   ////////////////////////////////////////////////////

Core/GameEngine/Include/GameNetwork/ConnectionManager.h

@@ -176,8 +176,8 @@ class ConnectionManager
 	void requestFrameDataResend(Int playerID, UnsignedInt frame); ///< request of this player that he send the specified frame's data.
 
 	// The connections are set up like the slot list. The connection corresponding to the local
-	// player's position in the slot list will be NULL.  Connections corresponding to slots that
-	// do not have a player will also be NULL.
+	// player's position in the slot list will be nullptr.  Connections corresponding to slots that
+	// do not have a player will also be nullptr.
 	Connection *m_connections[MAX_SLOTS];
 
 	Transport *m_transport;

Core/GameEngine/Include/GameNetwork/GameSpy/PeerThread.h

@@ -147,7 +147,7 @@ class PeerRequest
 			UnsignedInt ladderPassCRC;
 			Int maxPing;
 			Int maxDiscons, discons;
-			char pings[17]; // 8 servers (0-ff), 1 NULL
+			char pings[17]; // 8 servers (0-ff), 1 null terminator
 			Int numPlayers;
 			Int botID;
 			Int roomID;

Core/GameEngine/Include/GameNetwork/GameSpyOverlay.h

@@ -36,7 +36,7 @@
 #include "GameClient/GameWindowManager.h"
 
 void ClearGSMessageBoxes( void );	///< Tear down any GS message boxes (e.g. in case we have a new one to put up)
-void GSMessageBoxOk(UnicodeString titleString,UnicodeString bodyString, GameWinMsgBoxFunc okFunc = NULL);	///< Display a Message box with Ok button and track it
+void GSMessageBoxOk(UnicodeString titleString,UnicodeString bodyString, GameWinMsgBoxFunc okFunc = nullptr);	///< Display a Message box with Ok button and track it
 void GSMessageBoxOkCancel(UnicodeString title, UnicodeString message, GameWinMsgBoxFunc okFunc, GameWinMsgBoxFunc cancelFunc);	///< Display a Message box with Ok/Cancel buttons and track it
 void GSMessageBoxYesNo(UnicodeString title, UnicodeString message, GameWinMsgBoxFunc yesFunc, GameWinMsgBoxFunc noFunc);	///< Display a Message box with Yes/No buttons and track it
 void RaiseGSMessageBox( void );		///< Bring GS message box to the foreground (if we transition screens while a message box is up)

Core/GameEngine/Include/GameNetwork/IPEnumeration.h

@@ -37,7 +37,7 @@ class EnumeratedIP : public MemoryPoolObject
 {
 	MEMORY_POOL_GLUE_WITH_USERLOOKUP_CREATE(EnumeratedIP, "EnumeratedIP")
 public:
-	EnumeratedIP() { m_IPstring = ""; m_next = NULL; m_IP = 0; }
+	EnumeratedIP() { m_IPstring = ""; m_next = nullptr; m_IP = 0; }
 
 	// Access functions
 	AsciiString getIPstring( void ) { return m_IPstring; }

Core/GameEngine/Include/GameNetwork/LANAPI.h

@@ -238,7 +238,7 @@ class LANAPI : public LANAPIInterface
 
 	Bool								m_isInLANMenu;		///< true while we are in a LAN menu (lobby, game options, direct connect)
 	Bool								m_inLobby;											///< Are we in the lobby (not in a game)?
-	LANGameInfo *				m_currentGame;							///< Pointer to game (setup screen) we are currently in (NULL for lobby)
+	LANGameInfo *				m_currentGame;							///< Pointer to game (setup screen) we are currently in (nullptr for lobby)
 	//LANGameInfo *m_currentGameInfo;			///< Pointer to game setup info we are currently in.
 
 	UnsignedInt					m_localIP;

Core/GameEngine/Include/GameNetwork/LANGameInfo.h

@@ -42,7 +42,7 @@ class LANGameSlot : public GameSlot
 public:
 	LANGameSlot();
 
-	LANPlayer *getUser( void );																	///< Get the User structure associated with the slot (NULL for non-humans)
+	LANPlayer *getUser( void );																	///< Get the User structure associated with the slot (nullptr for non-humans)
 
 	// Various tests
 	Bool isUser( LANPlayer *user );															///< Does this slot contain the given user?  Based off user->name

Core/GameEngine/Include/GameNetwork/LANPlayer.h

@@ -27,6 +27,7 @@
 // Author: Matthew D. Campbell, October 2001 (Pulled out of LANAPI.h by CLH on 12/21/01
 
 #pragma once
+#include <Utility/CppMacros.h>
 
 /**
  * LAN player class.  This is for players sitting in the lobby.  Players are
@@ -35,7 +36,7 @@
 class LANPlayer
 {
 public:
-	LANPlayer() { m_name = m_login = m_host = L""; m_lastHeard = 0; m_next = NULL; m_IP = 0; }
+	LANPlayer() { m_name = m_login = m_host = L""; m_lastHeard = 0; m_next = nullptr; m_IP = 0; }
 
 	// Access functions
 	UnicodeString getName( void ) { return m_name; }