chore(controlbar): Add asserts to verify special power templates and buttons (TheSuperHackers#2657)

Author: xezon

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

@@ -74,9 +74,24 @@ void ControlBar::parseCommandButtonDefinition( INI *ini )
 	// parse the ini definition
 	ini->initFromINI( button, button->getFieldParse() );
 
+	const SpecialPowerTemplate *spTemplate = button->getSpecialPowerTemplate();
+
+	// TheSuperHackers @tweak Make sure Special Power buttons have a Special Power template.
+	switch (button->getCommandType())
+	{
+	case GUI_COMMAND_SPECIAL_POWER:
+	case GUI_COMMAND_SPECIAL_POWER_FROM_SHORTCUT:
+	case GUI_COMMAND_SPECIAL_POWER_CONSTRUCT:
+	case GUI_COMMAND_SPECIAL_POWER_CONSTRUCT_FROM_SHORTCUT:
+	{
+		DEBUG_ASSERTCRASH(spTemplate != nullptr,
+			("[LINE: %d in '%s'] CommandButton %s is a SPECIAL_POWER but is missing a SpecialPower field",
+				ini->getLineNum(), ini->getFilename().str(), name.str()));
+		break;
+	}
+	}
 
 	//Make sure buttons with special power templates also have the appropriate option set.
-	const SpecialPowerTemplate *spTemplate = button->getSpecialPowerTemplate();
 	Bool needsTemplate = BitIsSet( button->getOptions(), NEED_SPECIAL_POWER_SCIENCE );
 	if( spTemplate && !needsTemplate )
 	{

Generals/Code/GameEngine/Source/GameClient/GUI/ControlBar/ControlBar.cpp

@@ -3502,6 +3502,9 @@ void ControlBar::populateSpecialPowerShortcut( Player *player)
 				}
 			}
 
+			DEBUG_ASSERTCRASH(m_specialPowerShortcutButtons[ currentButton ] != nullptr, ("m_specialPowerShortcutButtons[%d] is null", currentButton));
+			DEBUG_ASSERTCRASH(m_specialPowerShortcutButtonParents[ currentButton ] != nullptr, ("m_specialPowerShortcutButtonParents[%d] is null", currentButton));
+
 			// make sure the window is not hidden
 			m_specialPowerShortcutButtons[ currentButton ]->winHide( FALSE );
 			m_specialPowerShortcutButtonParents[ currentButton ]->winHide( FALSE );

Generals/Code/GameEngine/Source/GameClient/GUI/ControlBar/ControlBarCommandProcessing.cpp

@@ -68,7 +68,7 @@ struct SelectObjectsInfo
 
 //-------------------------------------------------------------------------------------------------
 
-void selectObjectOfType( Object* obj, void* selectObjectsInfo )
+static void selectObjectOfType( Object* obj, void* selectObjectsInfo )
 {
 	SelectObjectsInfo *soInfo = (SelectObjectsInfo*)selectObjectsInfo;
 	if( !obj || !soInfo )
@@ -277,6 +277,8 @@ CBCommandStatus ControlBar::processCommandUI( GameWindow *control,
 		{
 			//Determine the object that would construct it.
 			const SpecialPowerTemplate *spTemplate = commandButton->getSpecialPowerTemplate();
+			DEBUG_ASSERTCRASH(spTemplate != nullptr, ("Special Power Button is missing Special Power template"));
+
 			SpecialPowerType spType = spTemplate->getSpecialPowerType();
 			Object* obj = ThePlayerList->getLocalPlayer()->findMostReadyShortcutSpecialPowerOfType( spType );
 			if( !obj )

GeneralsMD/Code/GameEngine/Source/Common/INI/INICommandButton.cpp

@@ -74,9 +74,24 @@ void ControlBar::parseCommandButtonDefinition( INI *ini )
 	// parse the ini definition
 	ini->initFromINI( button, button->getFieldParse() );
 
+	const SpecialPowerTemplate *spTemplate = button->getSpecialPowerTemplate();
+
+	// TheSuperHackers @tweak Make sure Special Power buttons have a Special Power template.
+	switch (button->getCommandType())
+	{
+	case GUI_COMMAND_SPECIAL_POWER:
+	case GUI_COMMAND_SPECIAL_POWER_FROM_SHORTCUT:
+	case GUI_COMMAND_SPECIAL_POWER_CONSTRUCT:
+	case GUI_COMMAND_SPECIAL_POWER_CONSTRUCT_FROM_SHORTCUT:
+	{
+		DEBUG_ASSERTCRASH(spTemplate != nullptr,
+			("[LINE: %d in '%s'] CommandButton %s is a SPECIAL_POWER but is missing a SpecialPower field",
+				ini->getLineNum(), ini->getFilename().str(), name.str()));
+		break;
+	}
+	}
 
 	//Make sure buttons with special power templates also have the appropriate option set.
-	const SpecialPowerTemplate *spTemplate = button->getSpecialPowerTemplate();
 	Bool needsTemplate = BitIsSet( button->getOptions(), NEED_SPECIAL_POWER_SCIENCE );
 	if( spTemplate && !needsTemplate )
 	{

GeneralsMD/Code/GameEngine/Source/GameClient/GUI/ControlBar/ControlBar.cpp

@@ -3502,6 +3502,9 @@ void ControlBar::populateSpecialPowerShortcut( Player *player)
 				}
 			}
 
+			DEBUG_ASSERTCRASH(m_specialPowerShortcutButtons[ currentButton ] != nullptr, ("m_specialPowerShortcutButtons[%d] is null", currentButton));
+			DEBUG_ASSERTCRASH(m_specialPowerShortcutButtonParents[ currentButton ] != nullptr, ("m_specialPowerShortcutButtonParents[%d] is null", currentButton));
+
 			// make sure the window is not hidden
 			m_specialPowerShortcutButtons[ currentButton ]->winHide( FALSE );
 			m_specialPowerShortcutButtonParents[ currentButton ]->winHide( FALSE );

GeneralsMD/Code/GameEngine/Source/GameClient/GUI/ControlBar/ControlBarCommandProcessing.cpp

@@ -68,7 +68,7 @@ struct SelectObjectsInfo
 
 //-------------------------------------------------------------------------------------------------
 
-void selectObjectOfType( Object* obj, void* selectObjectsInfo )
+static void selectObjectOfType( Object* obj, void* selectObjectsInfo )
 {
 	SelectObjectsInfo *soInfo = (SelectObjectsInfo*)selectObjectsInfo;
 	if( !obj || !soInfo )
@@ -277,6 +277,8 @@ CBCommandStatus ControlBar::processCommandUI( GameWindow *control,
 		{
 			//Determine the object that would construct it.
 			const SpecialPowerTemplate *spTemplate = commandButton->getSpecialPowerTemplate();
+			DEBUG_ASSERTCRASH(spTemplate != nullptr, ("Special Power Button is missing Special Power template"));
+
 			SpecialPowerType spType = spTemplate->getSpecialPowerType();
 			Object* obj = ThePlayerList->getLocalPlayer()->findMostReadyShortcutSpecialPowerOfType( spType );
 			if( !obj )