[pull] master from EasyRPG:master #30

pull · 2025-03-17T20:08:18Z

See Commits and Changes for more details.

Created by pull[bot] (v2.0.0-alpha.1)

Can you help keep this open source service alive? 💖 Please sponsor : )

Summary by Sourcery

This pull request introduces a new system for handling flags in the liblcf library. It introduces new templates and generated files to manage flags more efficiently, and updates the build system to include these new files.

Enhancements:

Implements a new flag handling system to improve the management of flags within the liblcf library. This includes the introduction of new templates for flag generation and updates to the build system to incorporate these changes.
Updates the code generation process to create separate header files for each flag field, improving modularity and organization.
Adds new Jinja2 filters and tests to enhance the code generation process, including filters for flag types, sizes, and sets, as well as tests for monotonic enums and scoped enums.
Updates the build system (CMakeLists.txt and Makefile.am) to include the new generated flag files.
Removes unused includes and template instantiations from reader_flags.cpp and reader_struct.h, streamlining the codebase and reducing dependencies.
Moves flag-related code from the main structure headers to separate flag-specific headers, improving code organization and reducing header file size.
Updates the code generation process to create separate header files for each flag field, improving modularity and organization.
Adds new Jinja2 filters and tests to enhance the code generation process, including filters for flag types, sizes, and sets, as well as tests for monotonic enums and scoped enums.
Updates the build system (CMakeLists.txt and Makefile.am) to include the new generated flag files.
Removes unused includes and template instantiations from reader_flags.cpp and reader_struct.h, streamlining the codebase and reducing dependencies.
Moves flag-related code from the main structure headers to separate flag-specific headers, improving code organization and reducing header file size.

This was hardcoded to one Flag per struct. The generator is now smarter and you can specify multiple flags which are resolved by their flag name.

…ify which enum names are considered to be "scoped" ('class' enums in C++)

… code generator

… determine if an event has been created by EasyRPGs new "CloneMapEvent" command

…ct length

…inder event

…preter related SaveState structures (SaveEventExecState, SaveEventExecFrame & SaveMapEventBase) Co-Authored-By: florianessl <[email protected]>

@florianessl

…than the struct oversight from the refactor Thanks @florianessl

Use only "Flags" when struct = flagname as we originally did.

Flags: Do not hardcode one Flag field per class

sourcery-ai · 2025-03-17T20:08:23Z

Reviewer's Guide by Sourcery

This pull request introduces a new flag system that generates separate header files for each flag type, along with forward declarations and instantiations. This change aims to improve code organization and maintainability. The build system files have been updated to include the new flag-related files, and the flag generation logic has been modified to handle cases where the struct name is the same as the flag name. Manual instantiations of Flags templates have been removed.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Introduces a new system for handling flags in the liblcf library. This involves generating separate header files for each flag type, along with forward declarations and instantiation.	Added `flag_type` filter to generator to handle flag naming. Modified the generator to create separate header files for flags. Created new templates for flag forward declarations and instantiations. Modified CMakeLists.txt and Makefile.am to include the new flag-related files. Removed manual flag instantiations in `reader_flags.cpp` and `reader_struct.h`. Added includes for generated flag headers in `reader_flags.cpp` and `reader_struct.h`.	`generator/generate.py` `src/reader_flags.cpp` `src/reader_struct.h` `CMakeLists.txt` `Makefile.am` `builds/sources2buildsystem.pl` `generator/templates/flag_reader.tmpl` `generator/templates/flag_fwd.tmpl` `generator/templates/flag_instance.tmpl` `src/generated/fwd_flags_impl.h` `src/generated/fwd_flags_instance.h`
Updates the build system files (CMakeLists.txt and Makefile.am) to include the newly generated flag files.	Added new generated flag files to the LCF_SOURCES variable in CMakeLists.txt. Added new generated flag files to the liblcf_la_SOURCES variable in Makefile.am. Modified the regex in `builds/sources2buildsystem.pl` to include `fwd_.*.h` files.	`CMakeLists.txt` `Makefile.am` `builds/sources2buildsystem.pl`
Modifies the flag generation logic to handle cases where the struct name is the same as the flag name.	The `flag_type` filter in `generator/generate.py` now handles cases where the struct name is the same as the flag name, emitting only "Flags" in such cases.	`generator/generate.py`
Removes manual instantiations of `Flags` templates for specific types.	Removed explicit template instantiations for various flag types in `src/reader_flags.cpp`. Removed explicit template specializations for various flag types in `src/reader_struct.h`.	`src/reader_flags.cpp` `src/reader_struct.h`

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai review to trigger a new review!
Generate a plan of action for an issue: Comment @sourcery-ai plan on
an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

Ghabry and others added 16 commits February 12, 2025 12:41

Flags: Allow multiple Flags per class

6e214b3

This was hardcoded to one Flag per struct. The generator is now smarter and you can specify multiple flags which are resolved by their flag name.

Add generated files

60fd5f1

Feature: Updated generator.py & templates to make it possible to spec…

30b63f8

…ify which enum names are considered to be "scoped" ('class' enums in C++)

Fix: Using hexadecimal representation for enum fields would break the…

2d90a93

… code generator

Add new fields "easyrpg_clone_map_id" and "easyrpg_clone_event_id" to…

61889b9

… determine if an event has been created by EasyRPGs new "CloneMapEvent" command

CloneEvent: Add generated code

d60a074

Bugfixes: Use correct class name for flags and flag array had incorre…

01b0b8f

…ct length

clang: Fix Flags template

0aa3ff1

Events: Remove SmartMoveRoute/StepToward event and replace with Pathf…

4f46454

…inder event

Update sources2buildsystem script to handle fwd_headers and inireader

7c66efe

Specified new field 0xCC "easyrpg_runtime_flags for each of the Inter…

82efaf8

…preter related SaveState structures (SaveEventExecState, SaveEventExecFrame & SaveMapEventBase) Co-Authored-By: florianessl <[email protected]>

Flags: Add generated code

df49a63

Flags: Initialise flags correctly when the Flag has a different name …

685580b

…than the struct oversight from the refactor Thanks @florianessl

Flags: Make flag generation backward compatible

2999705

Use only "Flags" when struct = flagname as we originally did.

Add generated files

b0e6b13

Merge pull request #492 from Ghabry/flags

d182256

Flags: Do not hardcode one Flag field per class

pull bot added the ⤵️ pull label Mar 17, 2025

pull bot merged commit d182256 into CartoonFan:master Mar 17, 2025
1 of 2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[pull] master from EasyRPG:master #30

[pull] master from EasyRPG:master #30

Uh oh!

pull bot commented Mar 17, 2025 •

edited by sourcery-ai bot

Loading

Uh oh!

sourcery-ai bot commented Mar 17, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

[pull] master from EasyRPG:master #30

[pull] master from EasyRPG:master #30

Uh oh!

Conversation

pull bot commented Mar 17, 2025 • edited by sourcery-ai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by Sourcery

Uh oh!

sourcery-ai bot commented Mar 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide by Sourcery

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

pull bot commented Mar 17, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Mar 17, 2025 •

edited

Loading