gen-strtab.awk: Add options to tweak the output.

[dxcommon.git] / scripts / gen-strtab.awk

diff --git a/scripts/gen-strtab.awk b/scripts/gen-strtab.awk
index f844d4f0bfd6481c9a5102f6b13864bd5c4ea601..118cf54430015cabcf15fab7b1c7db090e73618f 100755 (executable)
--- a/scripts/gen-strtab.awk
+++ b/scripts/gen-strtab.awk
@@ -1,6 +1,6 @@
 #!/bin/awk -f
 #
-# Copyright © 2021 Nick Bowler
+# Copyright © 2021, 2023 Nick Bowler
 #
 # Generate a C string table based on an input string specification file.
 #
@@ -16,6 +16,13 @@
 # processing immediately moves on to the next line and the result is as if
 # the comment line were omitted from the input.
 #
+# Options may be used to alter the normal behaviour.  An option is placed
+# on a line by itself beginning with an @ character, and may appear anywhere
+# in the input file.  The following options are defined:
+#
+#   @nozero
+#     All strings will have a non-zero offset in the strtab.
+#
 # A string is defined by beginning a line with an & character, which must
 # be immediately followed by a C identifier.  A nonempty sequence of
 # whitespace (with at most one newline) separates the identifier from the
@@ -41,6 +48,10 @@
 #
 # The object-like macro STRTAB_MAX_OFFSET is defined and expands to the
 # greatest string offset, suitable for use in #if preprocessing directives.
+#
+# License WTFPL2: Do What The Fuck You Want To Public License, version 2.
+# This is free software: you are free to do what the fuck you want to.
+# There is NO WARRANTY, to the extent permitted by law.
 
 END {
   print "/*"
@@ -54,12 +65,30 @@ END {
 }
 
 BEGIN {
+  opts["zero"] = 1
   collected = ident = ""
   startline = endline = 0
   num_vars = 0
 }
 
-$0 ~ /^[#]/ { next }
+# Comments
+NF == 0 || $0 ~ /^[#]/ { next }
+
+# Options
+sub(/^@/, "", $0) {
+  if (NF == 1) {
+    orig=$1
+    gsub(/-/, "_", $1);
+    val = !sub(/^no_?/, "", $1);
+    if ($1 in opts) {
+      opts[$1] = val;
+    } else {
+      print "error: unrecognized option: @" orig | "cat 1>&2"
+      exit 1
+    }
+  }
+  next
+}
 
 $0 ~ /^[&]/ {
   if (ident) {
@@ -105,6 +134,9 @@ END {
   print "#endif"
   print "\nstatic const char strtab[] ="
 
+  if (!opts["zero"])
+    print "\t\"\\0\"";
+
   for (i = 0; i < count; i++) {
     s = sorted_strings[i]
     gsub(/\\\\/, "\2", s)
@@ -131,7 +163,7 @@ END {
   for (i = 0; i < num_vars; i++) {
     sep = (i+1) != num_vars ? "," : ""
     s = vars[i]
-    o = offsets[strings[s]]
+    o = offsets[strings[s]] + !opts["zero"]
     print "\t" s " = " o sep
     if (o > max) {
       max = o