Add script to generate string tables.

Subversion-branch: /research
Subversion-revision: 1890

hhe/common.rb

@@ -4,6 +4,8 @@ require "v1.0/config.rb"
 require "v1.2/config.rb"
 require "v1.3/config.rb"
 
+CONFIGS = [ Heretic_1_0, Heretic_1_2, Heretic_1_3 ]
+
 # Symbolic sprite names, from info.h.
 
 SPRITE_NAMES = %w{
@@ -83,9 +85,7 @@ THING_FLAGS2 = %w{
 NUM_STRINGS=785
 
 def find_config(name)
-	configs = [ Heretic_1_0, Heretic_1_2, Heretic_1_3 ]
-
-	for config in configs
+	for config in CONFIGS
 		if name == config::NAME
 			return config
 		end

hhe/gen-string-tables

@@ -0,0 +1,111 @@
+#!/usr/bin/env ruby
+
+require "common.rb"
+
+def strings_to_lookup(strings)
+	lookup = {}
+
+	for string in strings
+		lookup[string[1]] = string[0]
+	end
+
+	lookup
+end
+
+# Generate string -> offset lookup tables for each executable.
+
+def load_string_lookups(exe_files)
+	string_lookups = []
+
+	CONFIGS.each_with_index do |config, i|
+		strings = find_strings(exe_files[i], config)
+		string_lookups.push(strings_to_lookup(strings))
+	end
+
+	string_lookups
+end
+
+# Load list of "good" strings.
+
+def load_good_strings(filename)
+	File.readlines(filename).map do |string|
+		JSON::load("["+ string.chomp + "]")[0]
+	end
+end
+
+# Find offsets for the specified string.
+
+def get_string_offsets(string, string_lookups)
+	string_lookups.map do |lookup|
+		lookup[string] or 0
+	end
+end
+
+def format_offsets(offsets)
+	formatted_offsets = offsets.map do |offset|
+		sprintf("%5i", offset)
+	end
+
+	"{ " + formatted_offsets.join(", ") + " }"
+end
+
+def print_unused_strings(name, strings, good_strings)
+	unused_offsets = []
+
+	strings.each_pair do |string, offset|
+		if not good_strings.member? string
+			unused_offsets.push(offset)
+		end
+	end
+
+	puts "static int #{name} = {"
+
+	numbers = 0
+
+	for offset in unused_offsets.sort
+		print "    " if numbers == 0
+
+		printf "%5i, ", offset
+		numbers += 1
+
+		if numbers >= 8
+			print "\n"
+			numbers = 0
+		end
+	end
+
+	if numbers > 0
+		print "\n"
+	end
+
+	puts "};"
+	puts
+end
+
+string_lookups = load_string_lookups(ARGV)
+good_strings = load_good_strings("good-strings.txt")
+
+# Output list of supported strings with their offset for each version
+
+puts "static HHEString strings[] = {"
+
+for string in good_strings
+
+	offsets = get_string_offsets(string, string_lookups)
+
+	print "    { " + format_offsets(offsets) + ", "
+#	print "\n      "
+	print string.to_json + " },\n"
+end
+
+puts "};"
+puts
+
+# Output strings that appear in HHE but are not supported (ie. in good_strings)
+
+CONFIGS.each_with_index do |config, i|
+	name = "unused_strings_#{config::SUFFIX}"
+	print_unused_strings(name, string_lookups[i], good_strings)
+end
+
+

hhe/v1.0/config.rb

@@ -2,6 +2,7 @@
 module Heretic_1_0
 
 NAME="v1.0"
+SUFFIX="1_0"
 
 NUM_STATES=1206
 NUM_MOBJS=161

hhe/v1.2/config.rb

@@ -2,6 +2,7 @@
 module Heretic_1_2
 
 NAME="v1.2"
+SUFFIX="1_2"
 
 NUM_STATES=1206
 NUM_MOBJS=160

hhe/v1.3/config.rb

@@ -2,6 +2,7 @@
 module Heretic_1_3
 
 NAME="v1.3"
+SUFFIX="1_3"
 
 NUM_STATES=1206
 NUM_MOBJS=160