Add comprehensive template-based code generation exploration #2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This document explores how Thrift could adopt a template-based code generation approach similar to protobuf compiler plugins, including: - Analysis of current programmatic code generation architecture - Comparison of template-based vs programmatic approaches - Proposed template-based architecture with examples - Migration strategy and implementation recommendations - Hybrid approach combining templates and programmatic generation The exploration includes concrete examples showing how generators like t_java_generator.cc could be reimplemented using templates (Jinja2/Mustache) while maintaining the same output quality.
This commit introduces a working proof-of-concept for template-based
code generation in Thrift, demonstrating significant benefits over the
traditional programmatic approach.
Key Components:
- Base template generator class (t_template_generator.h/cc)
- JSON template generator (t_json_template_generator.cc)
- Jinja2 template for JSON output (templates/json/program.json.j2)
- Integrated inja template engine (header-only)
- Integrated nlohmann/json library (header-only)
Benefits Demonstrated:
- 61% code reduction (314 lines vs 811 lines for JSON generator)
- Improved maintainability and readability
- Output structure immediately visible in templates
- Separation of logic and presentation
- Only ~8% performance overhead
Results:
- Output is functionally identical to original generator
- Successfully tested with test/TemplateTest.thrift
- Build system updated to support template generators
- Comprehensive documentation of findings and recommendations
Files Added:
- compiler/cpp/src/thrift/generate/t_template_generator.{h,cc}
- compiler/cpp/src/thrift/generate/t_json_template_generator.cc
- compiler/cpp/templates/json/program.json.j2
- compiler/cpp/third_party/inja.hpp (95KB)
- compiler/cpp/third_party/nlohmann/json.hpp (940KB)
- test/TemplateTest.thrift
- TEMPLATE_GENERATOR_POC_RESULTS.md
See TEMPLATE_GENERATOR_POC_RESULTS.md for detailed comparison,
metrics, and recommendations for future adoption.
Build artifacts directory should not be tracked in version control.
The inja template library requires C++17 for std::string_view. This fixes the compilation errors in CI builds that were using C++11. Changes: - Set CMAKE_CXX_STANDARD to 17 - Set CMAKE_CXX_STANDARD_REQUIRED to ON Verified that the template generator compiles and works correctly with C++17.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This document explores how Thrift could adopt a template-based code
generation approach similar to protobuf compiler plugins, including:
The exploration includes concrete examples showing how generators like
t_java_generator.cc could be reimplemented using templates (Jinja2/Mustache)
while maintaining the same output quality.