perf(gui): Eliminate expensive and unnecessary processing when populating the replay and map lists after they are full (#1758)

Author: xezon

GeneralsMD/Code/GameEngine/Include/GameClient/GadgetListBox.h

@@ -69,7 +69,8 @@ extern void GadgetListboxCreateScrollbar( GameWindow *listbox );
 extern void GadgetListBoxAddMultiSelect( GameWindow *listbox );
 extern void GadgetListBoxRemoveMultiSelect( GameWindow *listbox );
 extern void GadgetListBoxSetListLength( GameWindow *listbox, Int newLength );
-extern Int  GadgetListBoxGetListLength( GameWindow *listbox );
+extern Int  GadgetListBoxGetListLength( GameWindow *listbox ); ///< Returns the maximum possible number of list entries. Length is synonymous to rows
+extern Int  GadgetListBoxGetMaxSelectedLength( GameWindow *listbox ); ///< Returns the maximum possible number of list entries that can be selected
 extern Int  GadgetListBoxGetNumEntries( GameWindow *listbox );
 extern Int  GadgetListBoxGetNumColumns( GameWindow *listbox );
 extern Int  GadgetListBoxGetColumnWidth( GameWindow *listbox, Int column );

GeneralsMD/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/Menus/ReplayMenu.cpp

@@ -240,6 +240,7 @@ void PopulateReplayFileListbox(GameWindow *listbox)
 		return;
 
 	GadgetListBoxReset(listbox);
+	const Int listboxLength = GadgetListBoxGetListLength(listbox);
 
 	// TheSuperHackers @tweak xezon 08/06/2025 Now shows missing maps in red color.
 	enum {
@@ -273,7 +274,6 @@ void PopulateReplayFileListbox(GameWindow *listbox)
 
 	TheMapCache->updateCache();
 
-
 	for (it = replayFilenames.begin(); it != replayFilenames.end(); ++it)
 	{
 		// just want the filename
@@ -355,10 +355,15 @@ void PopulateReplayFileListbox(GameWindow *listbox)
 					mapColor = colors[COLOR_MISSING_MAP_CRC_MISMATCH];
 			}
 
-			Int insertionIndex = GadgetListBoxAddEntryText(listbox, replayNameToShow, color, -1, 0);
+			const Int insertionIndex = GadgetListBoxAddEntryText(listbox, replayNameToShow, color, -1, 0);
+			DEBUG_ASSERTCRASH(insertionIndex >= 0, ("Expects valid index"));
 			GadgetListBoxAddEntryText(listbox, displayTimeBuffer, color, insertionIndex, 1);
 			GadgetListBoxAddEntryText(listbox, header.versionString, color, insertionIndex, 2);
 			GadgetListBoxAddEntryText(listbox, mapStr, mapColor, insertionIndex, 3);
+
+			// TheSuperHackers @performance Now stops processing when the list is full.
+			if (insertionIndex == listboxLength - 1)
+				break;
 		}
 	}
 	GadgetListBoxSetSelected(listbox, 0);

GeneralsMD/Code/GameEngine/Source/GameClient/GUI/Gadget/GadgetListBox.cpp

@@ -2576,21 +2576,24 @@ void GadgetListBoxSetListLength( GameWindow *listbox, Int newLength )
 
 }
 
-// GadgetListBoxGetListLength =================================================
-/** Get the list length data contained in the listboxData
-	* parameter. */
 //=============================================================================
 Int GadgetListBoxGetListLength( GameWindow *listbox )
 {
 	ListboxData *listboxData = (ListboxData *)listbox->winGetUserData();
-	if (listboxData->multiSelect)
-	{
+	if (listboxData)
 		return listboxData->listLength;
-	}
-	else
-	{
-		return 1;
-	}
+
+	return 0;
+}
+
+//=============================================================================
+Int GadgetListBoxGetMaxSelectedLength( GameWindow *listbox )
+{
+	ListboxData *listboxData = (ListboxData *)listbox->winGetUserData();
+	if (listboxData)
+		return listboxData->multiSelect ? listboxData->listLength : 1;
+
+	return 0;
 }
 
 // GadgetListBoxGetNumEntries =================================================

GeneralsMD/Code/GameEngine/Source/GameClient/MapUtil.cpp

@@ -790,7 +790,8 @@ Int populateMapListboxNoReset( GameWindow *listbox, Bool useSystemMaps, Bool isM
 	// reset the listbox content
 	//GadgetListBoxReset( listbox );
 
-	Int numColumns = GadgetListBoxGetNumColumns( listbox );
+	const Int listboxLength = GadgetListBoxGetListLength( listbox );
+	const Int numColumns = GadgetListBoxGetNumColumns( listbox );
 	const Image *easyImage = NULL;
 	const Image *mediumImage = NULL;
 	const Image *brutalImage = NULL;
@@ -923,7 +924,9 @@ typedef MapDisplayToFileNameList::iterator MapDisplayToFileNameListIter;
 						index = GadgetListBoxAddEntryImage( listbox, NULL, index, 0, w, h, TRUE);
 					}
 				}
+
 				index = GadgetListBoxAddEntryText( listbox, mapDisplayName, color, index, numColumns-1 );
+				DEBUG_ASSERTCRASH(index >= 0, ("Expects valid index"));
 
 				if (it->first == mapToSelect)
 				{
@@ -938,6 +941,12 @@ typedef MapDisplayToFileNameList::iterator MapDisplayToFileNameListIter;
 				{
 					GadgetListBoxSetItemData( listbox, (void *)imageItemData, index, 1 );
 				}
+
+				// TheSuperHackers @performance Now stops processing when the list is full.
+				if (index == listboxLength - 1)
+				{
+					goto Done;
+				}
 			}
 			++tempit;
 		}
@@ -947,6 +956,7 @@ typedef MapDisplayToFileNameList::iterator MapDisplayToFileNameListIter;
 		++curNumPlayersInMap;
 	}
 
+Done:
 	delete battleHonors;
 	battleHonors = NULL;
 

GeneralsMD/Code/GameEngine/Source/GameNetwork/GameSpy/Chat.cpp

@@ -148,7 +148,7 @@ Bool GameSpyInfo::sendChat( UnicodeString message, Bool isAction, GameWindow *pl
 		}
 
 		// Get the selections (is this a private message?)
-		Int maxSel = GadgetListBoxGetListLength(playerListbox);
+		Int maxSel = GadgetListBoxGetMaxSelectedLength(playerListbox);
 		Int *selections;
 		GadgetListBoxGetSelected(playerListbox, (Int *)&selections);