unify(maputil): Merge MapUtil code (#1771)

xezon · xezon · commit e7ee57bd01e2 · 2025-11-01T16:04:17.000+01:00
diff --git a/Generals/Code/GameEngine/Include/GameClient/MapUtil.h b/Generals/Code/GameEngine/Include/GameClient/MapUtil.h
@@ -72,6 +72,7 @@ class MapMetaData
 {
 public:
 	UnicodeString m_displayName;
+	AsciiString m_nameLookupTag;
 	Region3D m_extent;
 	Int m_numPlayers;
 	Bool m_isMultiplayer;
@@ -125,6 +126,8 @@ Int populateMapListboxNoReset( GameWindow *listbox, Bool useSystemMaps, Bool isM
 Bool isValidMap( AsciiString mapName, Bool isMultiplayer );						/// Validate a map
 Image *getMapPreviewImage( AsciiString mapName );
 AsciiString getDefaultMap( Bool isMultiplayer );											/// Find a valid map
+AsciiString getDefaultOfficialMap();
+Bool isOfficialMap( AsciiString mapName );
 Bool parseMapPreviewChunk(DataChunkInput &file, DataChunkInfo *info, void *userData);
 void findDrawPositions( Int startX, Int startY, Int width, Int height, Region3D extent,
 															 ICoord2D *ul, ICoord2D *lr );
diff --git a/Generals/Code/GameEngine/Source/Common/INI/INIMapCache.cpp b/Generals/Code/GameEngine/Source/Common/INI/INIMapCache.cpp
@@ -33,6 +33,7 @@
 #include "Lib/BaseType.h"
 #include "Common/INI.h"
 #include "GameClient/MapUtil.h"
+#include "GameClient/GameText.h"
 #include "GameNetwork/NetworkDefs.h"
 #include "Common/NameKeyGenerator.h"
 #include "Common/WellKnownKeys.h"
@@ -46,6 +47,7 @@ class MapMetaDataReader
 	Int m_numPlayers;
 	Bool m_isMultiplayer;
 	AsciiString m_asciiDisplayName;
+	AsciiString m_asciiNameLookupTag;
 
 	Bool m_isOfficial;
 	WinTimeStamp m_timestamp;
@@ -92,6 +94,7 @@ const FieldParse MapMetaDataReader::m_mapFieldParseTable[] =
 	{ "timestampLo",						INI::parseInt,			NULL,	offsetof( MapMetaDataReader, m_timestamp.m_lowTimeStamp ) },
 	{ "timestampHi",						INI::parseInt,			NULL,	offsetof( MapMetaDataReader, m_timestamp.m_highTimeStamp ) },
 	{ "displayName",						INI::parseAsciiString,	NULL,	offsetof( MapMetaDataReader, m_asciiDisplayName ) },
+	{ "nameLookupTag",					INI::parseAsciiString,	NULL,	offsetof( MapMetaDataReader, m_asciiNameLookupTag ) },
 
 	{ "supplyPosition",					parseSupplyPositionCoord3D,	NULL, NULL },
 	{ "techPosition",						parseTechPositionsCoord3D,	NULL, NULL },
@@ -136,7 +139,36 @@ void INI::parseMapCacheDefinition( INI* ini )
 
 	md.m_waypoints[TheNameKeyGenerator->keyToName(TheKey_InitialCameraPosition)] = mdr.m_initialCameraPosition;
 
+#if RTS_GENERALS
 	md.m_displayName = QuotedPrintableToUnicodeString(mdr.m_asciiDisplayName);
+#else
+	md.m_nameLookupTag = QuotedPrintableToAsciiString(mdr.m_asciiNameLookupTag);
+
+	if (md.m_nameLookupTag.isEmpty())
+	{
+		// maps without localized name tags
+		AsciiString tempdisplayname;
+		tempdisplayname = name.reverseFind('\\') + 1;
+		md.m_displayName.translate(tempdisplayname);
+		if (md.m_numPlayers >= 2)
+		{
+			UnicodeString extension;
+			extension.format(L" (%d)", md.m_numPlayers);
+			md.m_displayName.concat(extension);
+		}
+	}
+	else
+	{
+		// official maps with name tags
+		md.m_displayName = TheGameText->fetch(md.m_nameLookupTag);
+		if (md.m_numPlayers >= 2)
+		{
+			UnicodeString extension;
+			extension.format(L" (%d)", md.m_numPlayers);
+			md.m_displayName.concat(extension);
+		}
+	}
+#endif
 
 	AsciiString startingCamName;
 	for (Int i=0; i<md.m_numPlayers; ++i)
diff --git a/Generals/Code/GameEngine/Source/GameClient/MapUtil.cpp b/Generals/Code/GameEngine/Source/GameClient/MapUtil.cpp
@@ -405,7 +405,12 @@ void MapCache::writeCacheINI( Bool userDir )
 			fprintf(fp, "  extentMin = X:%2.2f Y:%2.2f Z:%2.2f\n", md.m_extent.lo.x, md.m_extent.lo.y, md.m_extent.lo.z);
 			fprintf(fp, "  extentMax = X:%2.2f Y:%2.2f Z:%2.2f\n", md.m_extent.hi.x, md.m_extent.hi.y, md.m_extent.hi.z);
 
+// BAD AND NOW UNUSED:  the mapcache.ini should not contain localized data... using the lookup tag instead
+#if RTS_GENERALS
 			fprintf(fp, "  displayName = %s\n", UnicodeStringToQuotedPrintable(md.m_displayName).str());
+#else
+			fprintf(fp, "  nameLookupTag = %s\n", md.m_nameLookupTag.str());
+#endif
 
 			Coord3D pos;
 			WaypointMap::iterator itw = md.m_waypoints.begin();
@@ -645,6 +650,31 @@ Bool MapCache::addMap( AsciiString dirName, AsciiString fname, FileInfo *fileInf
 		if ((md.m_filesize == filesize) &&
 				(md.m_CRC != 0))
 		{
+			// Force a lookup so that we don't display the English localization in all builds.
+			if (md.m_nameLookupTag.isEmpty())
+			{
+				// unofficial maps or maps without names
+				AsciiString tempdisplayname;
+				tempdisplayname = fname.reverseFind('\\') + 1;
+				(*this)[lowerFname].m_displayName.translate(tempdisplayname);
+				if (md.m_numPlayers >= 2)
+				{
+					UnicodeString extension;
+					extension.format(L" (%d)", md.m_numPlayers);
+					(*this)[lowerFname].m_displayName.concat(extension);
+				}
+			}
+			else
+			{
+				// official maps with name tags
+				(*this)[lowerFname].m_displayName = TheGameText->fetch(md.m_nameLookupTag);
+				if (md.m_numPlayers >= 2)
+				{
+					UnicodeString extension;
+					extension.format(L" (%d)", md.m_numPlayers);
+					(*this)[lowerFname].m_displayName.concat(extension);
+				}
+			}
 //			DEBUG_LOG(("MapCache::addMap - found match for map %s", lowerFname.str()));
 			return FALSE;	// OK, it checks out.
 		}
@@ -676,6 +706,7 @@ Bool MapCache::addMap( AsciiString dirName, AsciiString fname, FileInfo *fileInf
 
 	Bool exists = false;
 	AsciiString munkee = worldDict.getAsciiString(TheKey_mapName, &exists);
+	md.m_nameLookupTag = munkee;
 	if (!exists || munkee.isEmpty())
 	{
 		DEBUG_LOG(("Missing TheKey_mapName!"));
@@ -766,13 +797,15 @@ Int populateMapListboxNoReset( GameWindow *listbox, Bool useSystemMaps, Bool isM
 	const Image *easyImage = NULL;
 	const Image *mediumImage = NULL;
 	const Image *brutalImage = NULL;
+	const Image *maxBrutalImage = NULL;
 	SkirmishBattleHonors *battleHonors = NULL;
 	Int w = 10, h = 10;
 	if (numColumns > 1)
 	{
 		easyImage = TheMappedImageCollection->findImageByName("Star-Bronze");
 		mediumImage = TheMappedImageCollection->findImageByName("Star-Silver");
 		brutalImage = TheMappedImageCollection->findImageByName("Star-Gold");
+		maxBrutalImage = TheMappedImageCollection->findImageByName("RedYell_Star");
 		battleHonors = new SkirmishBattleHonors;
 
 		w = (brutalImage)?brutalImage->getImageWidth():10;
@@ -843,6 +876,16 @@ typedef MapDisplayToFileNameList::iterator MapDisplayToFileNameListIter;
 			}
 			*/
 
+#if RTS_ZEROHOUR
+			//Patch 1.03 -- Purposely filter out these broken maps that exist in Generals.
+			if( !asciiMapName.compare( "maps\\armored fury\\armored fury.map" ) ||
+				!asciiMapName.compare( "maps\\scorched earth\\scorched earth.map" ) )
+			{
+				++tempit;
+				continue;
+			}
+#endif
+
 			DEBUG_ASSERTCRASH(it != TheMapCache->end(), ("Map %s not found in map cache.", tempit->str()));
 			if (it->first.startsWithNoCase(mapDir.str()) && isMultiplayer == it->second.m_isMultiplayer && !it->second.m_displayName.isEmpty())
 			{
@@ -857,8 +900,17 @@ typedef MapDisplayToFileNameList::iterator MapDisplayToFileNameListIter;
 					Int numBrutal = battleHonors->getEnduranceMedal(it->first.str(), SLOT_BRUTAL_AI);
 					if (numBrutal)
 					{
-						imageItemData = 3;
-						index = GadgetListBoxAddEntryImage( listbox, brutalImage, index, 0, w, h, TRUE);
+						int maxBrutalSlots = it->second.m_numPlayers - 1;
+						if (maxBrutalImage != NULL && numBrutal == maxBrutalSlots)
+						{
+							index = GadgetListBoxAddEntryImage( listbox, maxBrutalImage, index, 0, w, h, TRUE);
+							imageItemData = 4;
+						}
+						else
+						{
+							index = GadgetListBoxAddEntryImage( listbox, brutalImage, index, 0, w, h, TRUE);
+							imageItemData = 3;
+						}
 					}
 					else if (numMedium)
 					{
@@ -984,6 +1036,39 @@ AsciiString getDefaultMap( Bool isMultiplayer )
 	return AsciiString::TheEmptyString;
 }
 
+
+AsciiString getDefaultOfficialMap()
+{
+	if(!TheMapCache)
+		return AsciiString::TheEmptyString;
+	TheMapCache->updateCache();
+
+	MapCache::iterator it = TheMapCache->begin();
+	while (it != TheMapCache->end())
+	{
+		if (it->second.m_isMultiplayer && it->second.m_isOfficial)
+		{
+			return it->first;
+		}
+		++it;
+	}
+	return AsciiString::TheEmptyString;
+}
+
+
+Bool isOfficialMap( AsciiString mapName )
+{
+	if(!TheMapCache || mapName.isEmpty())
+		return FALSE;
+	TheMapCache->updateCache();
+	mapName.toLower();
+	MapCache::iterator it = TheMapCache->find(mapName);
+	if (it != TheMapCache->end())
+		return it->second.m_isOfficial;
+	return FALSE;
+}
+
+
 const MapMetaData *MapCache::findMap(AsciiString mapName)
 {
 	mapName.toLower();
diff --git a/GeneralsMD/Code/GameEngine/Source/Common/INI/INIMapCache.cpp b/GeneralsMD/Code/GameEngine/Source/Common/INI/INIMapCache.cpp
@@ -139,8 +139,9 @@ void INI::parseMapCacheDefinition( INI* ini )
 
 	md.m_waypoints[TheNameKeyGenerator->keyToName(TheKey_InitialCameraPosition)] = mdr.m_initialCameraPosition;
 
-//	md.m_displayName = QuotedPrintableToUnicodeString(mdr.m_asciiDisplayName);
-// this string is never to be used, but we'll leave it in to allow people with an old mapcache.ini to parse it
+#if RTS_GENERALS
+	md.m_displayName = QuotedPrintableToUnicodeString(mdr.m_asciiDisplayName);
+#else
 	md.m_nameLookupTag = QuotedPrintableToAsciiString(mdr.m_asciiNameLookupTag);
 
 	if (md.m_nameLookupTag.isEmpty())
@@ -167,6 +168,7 @@ void INI::parseMapCacheDefinition( INI* ini )
 			md.m_displayName.concat(extension);
 		}
 	}
+#endif
 
 	AsciiString startingCamName;
 	for (Int i=0; i<md.m_numPlayers; ++i)
diff --git a/GeneralsMD/Code/GameEngine/Source/GameClient/MapUtil.cpp b/GeneralsMD/Code/GameEngine/Source/GameClient/MapUtil.cpp
@@ -406,8 +406,11 @@ void MapCache::writeCacheINI( Bool userDir )
 			fprintf(fp, "  extentMax = X:%2.2f Y:%2.2f Z:%2.2f\n", md.m_extent.hi.x, md.m_extent.hi.y, md.m_extent.hi.z);
 
 // BAD AND NOW UNUSED:  the mapcache.ini should not contain localized data... using the lookup tag instead
-//			fprintf(fp, "  displayName = %s\n", UnicodeStringToQuotedPrintable(md.m_displayName).str());
+#if RTS_GENERALS
+			fprintf(fp, "  displayName = %s\n", UnicodeStringToQuotedPrintable(md.m_displayName).str());
+#else
 			fprintf(fp, "  nameLookupTag = %s\n", md.m_nameLookupTag.str());
+#endif
 
 			Coord3D pos;
 			WaypointMap::iterator itw = md.m_waypoints.begin();
@@ -873,13 +876,15 @@ typedef MapDisplayToFileNameList::iterator MapDisplayToFileNameListIter;
 			}
 			*/
 
+#if RTS_ZEROHOUR
 			//Patch 1.03 -- Purposely filter out these broken maps that exist in Generals.
 			if( !asciiMapName.compare( "maps\\armored fury\\armored fury.map" ) ||
 				!asciiMapName.compare( "maps\\scorched earth\\scorched earth.map" ) )
 			{
 				++tempit;
 				continue;
 			}
+#endif
 
 			DEBUG_ASSERTCRASH(it != TheMapCache->end(), ("Map %s not found in map cache.", tempit->str()));
 			if (it->first.startsWithNoCase(mapDir.str()) && isMultiplayer == it->second.m_isMultiplayer && !it->second.m_displayName.isEmpty())
@@ -896,7 +901,7 @@ typedef MapDisplayToFileNameList::iterator MapDisplayToFileNameListIter;
 					if (numBrutal)
 					{
 						int maxBrutalSlots = it->second.m_numPlayers - 1;
-						if (numBrutal == maxBrutalSlots)
+						if (maxBrutalImage != NULL && numBrutal == maxBrutalSlots)
 						{
 							index = GadgetListBoxAddEntryImage( listbox, maxBrutalImage, index, 0, w, h, TRUE);
 							imageItemData = 4;
@@ -1223,7 +1228,7 @@ Image *getMapPreviewImage( AsciiString mapName )
 	mapPreviewImage->setStatus(IMAGE_STATUS_RAW_TEXTURE);
 // allocate our terrain texture
 	TextureClass * texture = new TextureClass( size.x, size.y,
-																			 WW3D_FORMAT_X8R8G8B8, TextureClass::MIP_LEVELS_1 );
+																			 WW3D_FORMAT_X8R8G8B8, MIP_LEVELS_1 );
 	uv.lo.x = 0.0f;
 	uv.lo.y = 1.0f;
 	uv.hi.x = 1.0f;
