Merge pull request #575 from elbeno/dont-reuse-old-ids

✨ Allow old string IDs to be remembered by default

Author: lukevalenty

cmake/string_catalog.cmake

@@ -1,5 +1,5 @@
 function(gen_str_catalog)
-    set(options "")
+    set(options FORGET_OLD_IDS)
     set(oneValueArgs OUTPUT_CPP OUTPUT_XML OUTPUT_JSON GEN_STR_CATALOG
                      OUTPUT_LIB)
     set(multiValueArgs INPUT_JSON INPUT_LIBS INPUT_HEADERS STABLE_JSON)
@@ -31,13 +31,18 @@ function(gen_str_catalog)
     list(TRANSFORM SC_STABLE_JSON PREPEND "${CMAKE_CURRENT_SOURCE_DIR}/")
     list(TRANSFORM SC_INPUT_HEADERS PREPEND "${CMAKE_CURRENT_SOURCE_DIR}/")
 
+    if(SC_FORGET_OLD_IDS)
+        set(FORGET_ARG "--forget_old_ids")
+    endif()
+
     add_custom_command(
         OUTPUT ${SC_OUTPUT_CPP} ${SC_OUTPUT_JSON} ${SC_OUTPUT_XML}
         COMMAND
             ${Python3_EXECUTABLE} ${SC_GEN_STR_CATALOG} --input ${UNDEFS}
             --json_input ${SC_INPUT_JSON} --cpp_headers ${SC_INPUT_HEADERS}
             --cpp_output ${SC_OUTPUT_CPP} --json_output ${SC_OUTPUT_JSON}
             --xml_output ${SC_OUTPUT_XML} --stable_json ${SC_STABLE_JSON}
+            ${FORGET_ARG}
         DEPENDS ${UNDEFS} ${INPUT_JSON} ${SC_GEN_STR_CATALOG} ${SC_STABLE_JSON}
         COMMAND_EXPAND_LISTS)
     if(SC_OUTPUT_LIB)

test/log/catalog_app.cpp

@@ -34,6 +34,8 @@ TEST_CASE("log one compile-time argument", "[catalog]") {
     log_one_ct_arg();
     CHECK(test_critical_section::count == 2);
     CHECK(log_calls == 1);
+    // ID 0 is reserved by stable input
+    CHECK(last_header >> 4u != 0);
 }
 
 TEST_CASE("log one runtime argument", "[catalog]") {

test/log/stable_strings.json

@@ -1,5 +1,13 @@
 {
     "messages": [
+        {
+            "level": "TRACE",
+            "msg": "An old string that can't be reused",
+            "type": "msg",
+            "arg_types": [],
+            "arg_count": 0,
+            "id": 0
+        },
         {
             "level": "TRACE",
             "msg": "A string with no placeholders",
@@ -10,6 +18,10 @@
         }
     ],
     "modules": [
+        {
+            "string": "old_stable",
+            "id": 42
+        },
         {
             "string": "fixed",
             "id": 17

tools/gen_str_catalog.py

@@ -199,8 +199,14 @@ def fq_name(node):
     return enums
 
 
-def write_json(messages, modules, extra_inputs: list[str], filename: str):
+def write_json(messages, modules, extra_inputs: list[str], filename: str, stable_ids):
     str_catalog = dict(messages=list(messages.values()), modules=list(modules.values()))
+    for msg in stable_ids.get("messages"):
+        if not msg in str_catalog["messages"]:
+            str_catalog["messages"].append(msg)
+    for mod in stable_ids.get("modules"):
+        if not mod in str_catalog["modules"]:
+            str_catalog["modules"].append(mod)
     for extra in extra_inputs:
         with open(extra, "r") as f:
             str_catalog.update(json.load(f))
@@ -213,10 +219,7 @@ def read_stable(stable_filenames: list[str]):
     for filename in stable_filenames:
         with open(filename, "r") as f:
             stable_catalog.update(json.load(f))
-    return (
-        {stable_msg_key(msg): msg["id"] for msg in stable_catalog["messages"]},
-        {m["string"]: m["id"] for m in stable_catalog["modules"]},
-    )
+    return stable_catalog
 
 
 def serialize_guids(client_node: et.Element, guid_id: str, guid_mask: str):
@@ -371,6 +374,11 @@ def parse_cmdline():
         default=[],
         help="Input filename(s) for previously generated JSON; this is used to fix stable IDs.",
     )
+    parser.add_argument(
+        "--forget_old_ids",
+        action="store_true",
+        help="When on, stable IDs from a previous run are forgotten. By default, those strings are remembered in the output so that they will not be reused in future.",
+    )
     return parser.parse_args()
 
 
@@ -388,17 +396,27 @@ def main():
     et._escape_cdata = _escape_cdata
     args = parse_cmdline()
 
-    stable_ids = read_stable(args.stable_json)
+    stable_catalog = read_stable(args.stable_json)
     try:
+        stable_ids = (
+            {stable_msg_key(msg): msg["id"] for msg in stable_catalog["messages"]},
+            {m["string"]: m["id"] for m in stable_catalog["modules"]},
+        )
         modules, messages = read_input(args.input, stable_ids)
     except Exception as e:
         raise Exception(f"{str(e)} from file {args.input}")
 
     if args.cpp_output is not None:
         write_cpp(messages, modules, args.cpp_headers, args.cpp_output)
 
+    stable_output = dict(messages=[], modules=[])
+    if not args.forget_old_ids:
+        stable_output = dict(
+            messages=stable_catalog["messages"], modules=stable_catalog["modules"]
+        )
+
     if args.json_output is not None:
-        write_json(messages, modules, args.json_input, args.json_output)
+        write_json(messages, modules, args.json_input, args.json_output, stable_output)
 
     if args.xml_output is not None:
         enums = {}