Flags: Do not hardcode one Flag field per class

CMakeLists.txt

@@ -41,8 +41,8 @@ set(LCF_SOURCES
 	src/lmu_movecommand.cpp
 	src/lmu_reader.cpp
 	src/log.h
-	src/lsd_reader.cpp
 	src/log_handler.cpp
+	src/lsd_reader.cpp
 	src/reader_flags.cpp
 	src/reader_lcf.cpp
 	src/reader_struct.h
@@ -54,6 +54,8 @@ set(LCF_SOURCES
 	src/saveopt.cpp
 	src/writer_lcf.cpp
 	src/writer_xml.cpp
+	src/generated/fwd_flags_impl.h
+	src/generated/fwd_flags_instance.h
 	src/generated/fwd_struct_impl.h
 	src/generated/ldb_actor.cpp
 	src/generated/ldb_animation.cpp
@@ -83,7 +85,7 @@ set(LCF_SOURCES
 	src/generated/ldb_system.cpp
 	src/generated/ldb_terms.cpp
 	src/generated/ldb_terrain.cpp
-	src/generated/ldb_terrain_flags.h
+	src/generated/ldb_terrain_special_flags.h
 	src/generated/ldb_testbattler.cpp
 	src/generated/ldb_troop.cpp
 	src/generated/ldb_troopmember.cpp
@@ -109,10 +111,13 @@ set(LCF_SOURCES
 	src/generated/lsd_saveeasyrpgwindow.cpp
 	src/generated/lsd_saveeasyrpgwindow_flags.h
 	src/generated/lsd_saveeventexecframe.cpp
+	src/generated/lsd_saveeventexecframe_easyrpg_runtime_flags.h
 	src/generated/lsd_saveeventexecstate.cpp
+	src/generated/lsd_saveeventexecstate_easyrpg_runtime_flags.h
 	src/generated/lsd_saveinventory.cpp
 	src/generated/lsd_savemapevent.cpp
 	src/generated/lsd_savemapeventbase.cpp
+	src/generated/lsd_savemapeventbase_easyrpg_runtime_flags.h
 	src/generated/lsd_savemapinfo.cpp
 	src/generated/lsd_savepanorama.cpp
 	src/generated/lsd_savepartylocation.cpp
@@ -205,8 +210,8 @@ set(LCF_HEADERS
 	src/lcf/ldb/reader.h
 	src/lcf/lmt/reader.h
 	src/lcf/lmu/reader.h
-	src/lcf/lsd/reader.h
 	src/lcf/log_handler.h
+	src/lcf/lsd/reader.h
 	src/lcf/reader_lcf.h
 	src/lcf/reader_util.h
 	src/lcf/reader_xml.h

Makefile.am

@@ -58,8 +58,8 @@ liblcf_la_SOURCES = \
 	src/lmu_movecommand.cpp \
 	src/lmu_reader.cpp \
 	src/log.h \
-	src/lsd_reader.cpp \
 	src/log_handler.cpp \
+	src/lsd_reader.cpp \
 	src/reader_flags.cpp \
 	src/reader_lcf.cpp \
 	src/reader_struct.h \
@@ -71,6 +71,8 @@ liblcf_la_SOURCES = \
 	src/saveopt.cpp \
 	src/writer_lcf.cpp \
 	src/writer_xml.cpp \
+	src/generated/fwd_flags_impl.h \
+	src/generated/fwd_flags_instance.h \
 	src/generated/fwd_struct_impl.h \
 	src/generated/ldb_actor.cpp \
 	src/generated/ldb_animation.cpp \
@@ -100,7 +102,7 @@ liblcf_la_SOURCES = \
 	src/generated/ldb_system.cpp \
 	src/generated/ldb_terms.cpp \
 	src/generated/ldb_terrain.cpp \
-	src/generated/ldb_terrain_flags.h \
+	src/generated/ldb_terrain_special_flags.h \
 	src/generated/ldb_testbattler.cpp \
 	src/generated/ldb_troop.cpp \
 	src/generated/ldb_troopmember.cpp \
@@ -126,10 +128,13 @@ liblcf_la_SOURCES = \
 	src/generated/lsd_saveeasyrpgwindow.cpp \
 	src/generated/lsd_saveeasyrpgwindow_flags.h \
 	src/generated/lsd_saveeventexecframe.cpp \
+	src/generated/lsd_saveeventexecframe_easyrpg_runtime_flags.h \
 	src/generated/lsd_saveeventexecstate.cpp \
+	src/generated/lsd_saveeventexecstate_easyrpg_runtime_flags.h \
 	src/generated/lsd_saveinventory.cpp \
 	src/generated/lsd_savemapevent.cpp \
 	src/generated/lsd_savemapeventbase.cpp \
+	src/generated/lsd_savemapeventbase_easyrpg_runtime_flags.h \
 	src/generated/lsd_savemapinfo.cpp \
 	src/generated/lsd_savepanorama.cpp \
 	src/generated/lsd_savepartylocation.cpp \

builds/sources2buildsystem.pl

@@ -2,7 +2,7 @@
 
 # sources2buildsystem.pl - maintainer utility script to keep the
 # source/header file list for our build systems organized and up-to-date.
-# by carstene1ns 2018-2021, released under the MIT license
+# by carstene1ns 2018-2025, released under the MIT license
 
 use strict;
 use warnings;
@@ -22,7 +22,7 @@
 @files = (@others, @generated, @third_party);
 
 # split source and headers
-my $regex = '(\.cpp|_flags\.h|_impl\.h|src\/[^\/]*\.h)$';
+my $regex = '(\.cpp|_flags\.h|fwd_.*\.h|src\/[^\/]*\.h)$';
 my @sources = grep( /$regex/, @files);
 my @headers = grep(!/$regex/, @files);
 
@@ -57,6 +57,7 @@
 sub wanted {
 	return unless -f;
 	return unless /\.(cpp|h)$/;
+	return if /inireader/;
 
 	push @files, $File::Find::name;
 }

generator/csv/enums_easyrpg.csv

@@ -1,7 +1,6 @@
 Structure,Entry,Value,Index
 EventCommand,Code,EasyRpg_TriggerEventAt,2002
-EventCommand,Code,EasyRpg_SmartMoveRoute,2003
-EventCommand,Code,EasyRpg_SmartStepToward,2004
+EventCommand,Code,EasyRpg_Pathfinder,2003
 EventCommand,Code,EasyRpg_CallMovementAction,2050
 EventCommand,Code,EasyRpg_WaitForSingleMovement,2051
 EventCommand,Code,EasyRpg_AnimateVariable,2052

generator/csv/fields_easyrpg.csv

@@ -8,9 +8,11 @@ SaveEventExecFrame,maniac_event_id,f,Int32,0x0F,0,0,0,Event ID
 SaveEventExecFrame,maniac_event_page_id,f,Int32,0x10,0,0,0,Page ID when it is a map event
 SaveEventExecFrame,maniac_loop_info_size,f,Int32,0x11,0,0,0,Amount of loop info groups
 SaveEventExecFrame,maniac_loop_info,f,Vector<Int32>,0x12,,0,0,"One group of (Current loop count, end loop value) for each identation"
+SaveEventExecFrame,easyrpg_runtime_flags,f,EasyRpgFrameRuntime_Flags,0xCC,0,0,0,Runtime changes to the engine config
 SaveEventExecState,easyrpg_active,f,Boolean,0xC9,False,0,0,When true state of an event is preserved in easyrpg_string and easyrpg_parameters
 SaveEventExecState,easyrpg_string,f,DBString,0xCA,,0,0,Preserved string data of an event
 SaveEventExecState,easyrpg_parameters,f,Vector<Int32>,0xCB,,0,0,Preserved int parameter of an event
+SaveEventExecState,easyrpg_runtime_flags,f,EasyRpgStateRuntime_Flags,0xCC,0,0,0,Runtime changes to the engine config
 SavePicture,easyrpg_flip,f,Enum<EasyRpgFlip>,0xC8,0,0,1,How to flip the picture
 SavePicture,easyrpg_blend_mode,f,Int32,0xC9,0,0,1,Blend mode to use for blit. See Bitmap::BlendMode
 SavePicture,easyrpg_type,f,Enum<EasyRpgPictureType>,0xCA,0,0,1,Type of this picture
@@ -31,6 +33,9 @@ SaveEasyRpgText,letter_spacing,f,Int32,0x06,0,0,0,Additional spacing between let
 SaveEasyRpgText,line_spacing,f,Int32,0x07,4,0,0,Additional spacing between lines
 SaveEasyRpgText,flags,f,SaveEasyRpgText_Flags,0x08,3,0,0,Various text settings
 SaveMapEventBase,easyrpg_move_failure_count,f,Int32,0xC9,0,0,0,Tracks how often the current move operation in a move route failed
+SaveMapEventBase,easyrpg_clone_map_id,f,UInt32,0xCA,0,0,0,The original map id of a cloned event
+SaveMapEventBase,easyrpg_clone_event_id,f,UInt32,0xCB,0,0,0,The original event id of a cloned event
+SaveMapEventBase,easyrpg_runtime_flags,f,EasyRpgEventRuntime_Flags,0xCC,0,0,0,Runtime changes to the engine config
 SavePartyLocation,maniac_horizontal_pan_speed,f,Double,0x8D,0,0,0,horizontal speed in the scrolls of the screen
 SavePartyLocation,maniac_vertical_pan_speed,f,Double,0x8E,0,0,0,vertical speed in the scrolls of the screen
 SaveSystem,maniac_strings,f,Vector<DBString>,0x24,,0,0,rpg::Strings

generator/csv/flags_easyrpg.csv

@@ -5,3 +5,25 @@ SaveEasyRpgText,draw_gradient,0
 SaveEasyRpgText,draw_shadow,0
 SaveEasyRpgText,bold,0
 SaveEasyRpgText,italic,0
+EasyRpgFrameRuntime,reserved_1,0
+EasyRpgEventRuntime,reserved_1,0
+EasyRpgStateRuntime,conf_override_active,0
+EasyRpgStateRuntime,reserved_1,0
+EasyRpgStateRuntime,reserved_2,0
+EasyRpgStateRuntime,reserved_3,0
+EasyRpgStateRuntime,patch_destiny_on,0
+EasyRpgStateRuntime,patch_destiny_off,0
+EasyRpgStateRuntime,patch_dynrpg_on,0
+EasyRpgStateRuntime,patch_dynrpg_off,0
+EasyRpgStateRuntime,patch_maniac_on,0
+EasyRpgStateRuntime,patch_maniac_off,0
+EasyRpgStateRuntime,patch_common_this_event_on,0
+EasyRpgStateRuntime,patch_common_this_event_off,0
+EasyRpgStateRuntime,patch_unlock_pics_on,0
+EasyRpgStateRuntime,patch_unlock_pics_off,0
+EasyRpgStateRuntime,patch_keypatch_on,0
+EasyRpgStateRuntime,patch_keypatch_off,0
+EasyRpgStateRuntime,patch_rpg2k3_cmds_on,0
+EasyRpgStateRuntime,patch_rpg2k3_cmds_off,0
+EasyRpgStateRuntime,use_rpg2k_battle_system_on,0
+EasyRpgStateRuntime,use_rpg2k_battle_system_off,0

generator/generate.py

@@ -90,16 +90,20 @@ def cpp_type(ty, prefix=True):
 
     m = re.match(r'(.*)_Flags$', ty)
     if m:
-        ty = m.expand(r'\1::Flags')
-        if prefix:
-            ty = 'rpg::' + ty
-        return ty
+        raise ValueError("use flag_type for flags")
 
     if prefix:
         ty = 'rpg::' + ty
 
     return ty
 
+def flag_type(field, struct_name):
+    field_type = field.type
+    # Backward compatibility: When Struct Name = Flag Name only emit "Flags"
+    if struct_name == field.type[:-6]:
+        field_type = "Flags"
+    return field_type
+
 def pod_default(field):
     dfl = field.default
     ftype = field.type
@@ -133,9 +137,6 @@ def pod_default(field):
 
     return " = " + str(dfl)
 
-def num_flags(flag):
-    return len(flag)
-
 def flag_size(flag):
     return (len(flag) + 7) // 8
 
@@ -149,6 +150,9 @@ def flag_set(field, bit):
 
     return str(res).lower()
 
+def flags_for(field):
+    return flags[field.type[:-6]]
+
 def filter_structs_without_codes(structs):
     for struct in structs:
         if all(f.code for f in sfields[struct.name]):
@@ -392,11 +396,14 @@ def type_is_array_of_struct(ty):
 def is_monotonic_from_0(enum):
     expected = 0
     for (val, idx) in enum:
-        if int(idx) != expected:
+        if int(idx, 0) != expected:
             return False
         expected += 1
     return True
 
+def is_scoped_enum(enum_name):
+    return enum_name == "Code"
+
 def openToRender(path):
     subdir = os.path.dirname(path)
     if not os.path.exists(subdir):
@@ -426,6 +433,8 @@ def generate():
             structs=sorted([x.name for x in structs_flat])
         ))
 
+    flag_fields = []
+
     for filetype, structlist in structs.items():
         for struct in structlist:
             filename = struct.name.lower()
@@ -442,8 +451,8 @@ def generate():
                         type=filetype
                     ))
 
-
-            filepath = os.path.join(tmp_dir, 'lcf', 'rpg', '%s.h' % filename)
+            struct_header = os.path.join('lcf', 'rpg', '%s.h' % filename)
+            filepath = os.path.join(tmp_dir, struct_header)
             with openToRender(filepath) as f:
                 f.write(rpg_header_tmpl.render(
                     struct_name=struct.name,
@@ -459,14 +468,33 @@ def generate():
                     filename=filename
                 ))
 
-            if struct.name in flags:
-                filepath = os.path.join(tmp_dir, '%s_%s_flags.h' % (filetype, filename))
+            struct_flag_fields = [s for s in sfields[struct.name] if s.type.endswith("_Flags")]
+            for flag_field in struct_flag_fields:
+                header_file = '%s_%s_%s.h' % (filetype, filename, flag_field.name)
+                filepath = os.path.join(tmp_dir, header_file)
+                field_name = flag_type(flag_field, struct.name)
+                flag_fields.append(dict(struct_name=struct.name, struct_header=struct_header, field_name=field_name, flag_header=header_file))
+
                 with openToRender(filepath) as f:
                     f.write(flags_tmpl.render(
-                        struct_name=struct.name,
-                        type=filetype
+                        struct_name=flag_fields[-1]["struct_name"],
+                        type=filetype,
+                        flag_name=flag_fields[-1]["field_name"],
+                        flag_item=flags[flag_field.type[:-6]]
                     ))
 
+    filepath = os.path.join(tmp_dir, 'fwd_flags_impl.h')
+    with openToRender(filepath) as f:
+        f.write(flags_fwd_tmpl.render(
+            flags=flag_fields
+        ))
+
+    filepath = os.path.join(tmp_dir, 'fwd_flags_instance.h')
+    with openToRender(filepath) as f:
+        f.write(flags_instance_tmpl.render(
+            flags=flag_fields
+        ))
+
     for dirname, subdirlist, filelist in os.walk(tmp_dir, topdown=False):
         subdir = os.path.relpath(dirname, tmp_dir)
 
@@ -486,7 +514,7 @@ def main(argv):
         os.mkdir(dest_dir)
 
     global structs, structs_flat, sfields, enums, flags, functions, constants, headers
-    global chunk_tmpl, lcf_struct_tmpl, rpg_header_tmpl, rpg_source_tmpl, flags_tmpl, enums_tmpl, fwd_tmpl, fwd_struct_tmpl
+    global chunk_tmpl, lcf_struct_tmpl, rpg_header_tmpl, rpg_source_tmpl, flags_tmpl, flags_fwd_tmpl, flags_instance_tmpl, enums_tmpl, fwd_tmpl, fwd_struct_tmpl
 
     structs, structs_flat = get_structs('structs.csv', 'structs_easyrpg.csv')
     sfields = get_fields('fields.csv', 'fields_easyrpg.csv')
@@ -499,15 +527,17 @@ def main(argv):
     # Setup Jinja
     env.filters["lcf_type"] = lcf_type
     env.filters["cpp_type"] = cpp_type
+    env.filters["flag_type"] = flag_type
     env.filters["pod_default"] = pod_default
     env.filters["struct_has_code"] = filter_structs_without_codes
     env.filters["field_is_used"] = filter_unused_fields
     env.filters["field_is_written"] = filter_unwritten_fields
     env.filters["field_is_not_size"] = filter_size_fields
-    env.filters["num_flags"] = num_flags
     env.filters["flag_size"] = flag_size
     env.filters["flag_set"] = flag_set
+    env.filters["flags_for"] = flags_for
     env.tests['monotonic_from_0'] = is_monotonic_from_0
+    env.tests['scoped_enum'] = is_scoped_enum
     env.tests['is_db_string'] = type_is_db_string
     env.tests['is_array'] = type_is_array
     env.tests['is_array_of_struct'] = type_is_array_of_struct
@@ -529,6 +559,8 @@ def main(argv):
     rpg_header_tmpl = env.get_template('rpg_header.tmpl', globals=globals)
     rpg_source_tmpl = env.get_template('rpg_source.tmpl', globals=globals)
     flags_tmpl = env.get_template('flag_reader.tmpl', globals=globals)
+    flags_fwd_tmpl = env.get_template('flag_fwd.tmpl', globals=globals)
+    flags_instance_tmpl = env.get_template('flag_instance.tmpl', globals=globals)
     fwd_tmpl = env.get_template('fwd.tmpl', globals=globals)
     fwd_struct_tmpl = env.get_template('fwd_struct.tmpl', globals=globals)
 

generator/templates/chunks.tmpl

@@ -1,3 +1,6 @@
+{#
+This template is used for the chunks.h files
+-#}
 {% include "copyright.tmpl" %}
 #ifndef LCF_{{ type|upper }}_CHUNKS_H
 #define LCF_{{ type|upper }}_CHUNKS_H

generator/templates/flag_fwd.tmpl

@@ -0,0 +1,13 @@
+{#
+This template generates "fwd_flags_impl.h" which is included by "reader_struct.h"
+and is used to declare the templates used by "Flags"
+-#}
+{% include "copyright.tmpl" %}
+
+{%- for flag in flags %}
+#include "{{ flag.struct_header }}"
+{%- endfor %}
+
+{%- for flag in flags %}
+template <> struct lcf::TypeCategory<lcf::rpg::{{ flag.struct_name }}::{{ flag.field_name }}> { static const lcf::Category::Index value = lcf::Category::Flags; };
+{%- endfor %}

generator/templates/flag_instance.tmpl

@@ -0,0 +1,15 @@
+{#
+This template generates "fwd_flags_instance.h" which is included by "reader_flags.cpp"
+to instantiate the templates used by "Flags"
+-#}
+{% include "copyright.tmpl" %}
+
+{%- for flag in flags %}
+#include "{{ flag.flag_header }}"
+{%- endfor %}
+
+namespace lcf {
+{%- for flag in flags %}
+template class Flags<rpg::{{ flag.struct_name }}::{{ flag.field_name }}>;
+{%- endfor %}
+}