From 61d0e0e93a819a4dde6b9d511d1724606d319948 Mon Sep 17 00:00:00 2001
From: Meep-Eep <Meep-Eep@8092fc87-c524-0410-9efc-e669fe64eaf9>
Date: Thu, 7 Aug 2008 22:02:24 +0000
Subject: [PATCH] Added dumpStrings() to help debugging incongruities between
 the source file gamestr.h and the content file gamestrings.txt.

git-svn-id: svn://svn.code.sf.net/p/sc2/code/trunk@3031 8092fc87-c524-0410-9efc-e669fe64eaf9
---
 sc2/src/sc2code/uqmdebug.c | 75 ++++++++++++++++++++++++++++++++++++++
 sc2/src/sc2code/uqmdebug.h |  5 +++
 2 files changed, 80 insertions(+)

diff --git a/sc2/src/sc2code/uqmdebug.c b/sc2/src/sc2code/uqmdebug.c
index 19b90b4d3..7e2698d48 100644
--- a/sc2/src/sc2code/uqmdebug.c
+++ b/sc2/src/sc2code/uqmdebug.c
@@ -94,6 +94,7 @@ debugKeyPressed (void)
 //	Scale_PerfTest ();
 
 	// Informational:
+//	dumpStrings (stdout);
 //	dumpEvents (stderr);
 //	dumpPlanetTypes(stderr);
 //	debugHook = dumpUniverseToFile;
@@ -1362,6 +1363,80 @@ resetEnergyBattle(void) {
 	SetContext (OldContext);
 }
 
+////////////////////////////////////////////////////////////////////////////
+
+// This function should help in making sure that gamestr.h matches
+// gamestrings.txt.
+void
+dumpStrings(FILE *out) {
+#define STRINGIZE(a) #a
+#define MAKE_STRING_CATEGORY(prefix) \
+		{ \
+			/* .name  = */ STRINGIZE(prefix ## _BASE), \
+			/* .base  = */ prefix ## _BASE, \
+			/* .count = */ prefix ## _COUNT \
+		}
+	struct {
+		const char *name;
+		size_t base;
+		size_t count;
+	} categories[] = {
+		{ "0", 0, 0 },
+		MAKE_STRING_CATEGORY(STAR_STRING),
+		MAKE_STRING_CATEGORY(DEVICE_STRING),
+		MAKE_STRING_CATEGORY(CARGO_STRING),
+		MAKE_STRING_CATEGORY(ELEMENTS_STRING),
+		MAKE_STRING_CATEGORY(SCAN_STRING),
+		MAKE_STRING_CATEGORY(STAR_NUMBER),
+		MAKE_STRING_CATEGORY(PLANET_NUMBER),
+		MAKE_STRING_CATEGORY(MONTHS_STRING),
+		MAKE_STRING_CATEGORY(FEEDBACK_STRING),
+		MAKE_STRING_CATEGORY(STARBASE_STRING),
+		MAKE_STRING_CATEGORY(ENCOUNTER_STRING),
+		MAKE_STRING_CATEGORY(NAVIGATION_STRING),
+		MAKE_STRING_CATEGORY(NAMING_STRING),
+		MAKE_STRING_CATEGORY(MELEE_STRING),
+		MAKE_STRING_CATEGORY(SAVEGAME_STRING),
+		MAKE_STRING_CATEGORY(OPTION_STRING),
+		MAKE_STRING_CATEGORY(QUITMENU_STRING),
+		MAKE_STRING_CATEGORY(STATUS_STRING),
+		MAKE_STRING_CATEGORY(FLAGSHIP_STRING),
+		MAKE_STRING_CATEGORY(ORBITSCAN_STRING),
+		MAKE_STRING_CATEGORY(MAINMENU_STRING),
+		MAKE_STRING_CATEGORY(NETMELEE_STRING),
+		MAKE_STRING_CATEGORY(RECORDING_STRING),
+		{ "GAMESTR_COUNT", GAMESTR_COUNT, (size_t) -1 }
+	};
+	size_t numCategories = sizeof categories / sizeof categories[0];
+	size_t numStrings = GetStringTableCount (GameStrings);
+	size_t stringI;
+	size_t categoryI = 0;
+
+	// Start with a sanity check to see if gamestr.h has been changed but
+	// not this file.
+	for (categoryI = 0; categoryI < numCategories - 1; categoryI++) {
+		if (categories[categoryI].base + categories[categoryI].count !=
+				categories[categoryI + 1].base) {
+			fprintf(stderr, "Error: String category list in dumpStrings() is "
+					"not up to date.\n");
+			return;
+		}
+	}
+	
+	if (GAMESTR_COUNT != numStrings) {
+		fprintf(stderr, "Warning: GAMESTR_COUNT is %d, but GameStrings "
+				"contains %d strings.\n", GAMESTR_COUNT, numStrings);
+	}
+
+	categoryI = 0;
+	for (stringI = 0; stringI < numStrings; stringI++) {
+		while (categoryI < numCategories &&
+				stringI >= categories[categoryI + 1].base)
+			categoryI++;
+		fprintf(out, "[ %s + %d ]  %s\n", categories[categoryI].name,
+				stringI - categories[categoryI].base, GAME_STRING(stringI));
+	}
+}
 
 #endif  /* DEBUG */
 
diff --git a/sc2/src/sc2code/uqmdebug.h b/sc2/src/sc2code/uqmdebug.h
index 1a70a5965..d974cbfe1 100644
--- a/sc2/src/sc2code/uqmdebug.h
+++ b/sc2/src/sc2code/uqmdebug.h
@@ -158,6 +158,11 @@ void resetEnergyBattle(void);
 // Move instantly across hyperspace/quasispace.
 extern BOOLEAN instantMove;
 
+
+// Dump all game strings.
+void dumpStrings(FILE *out);
+
+
 // To add some day:
 // - a function to fast forward the game clock to a specifiable time.