filament/tools/codegen-options

codegen-options

Description

This is a small Go program that consumes a C++ header file and generates Java bindings, JavaScript bindings, and C++ code that performs JSON serialization.

Instructions

To install the Go compiler, just do:

brew install go

To build and invoke the code generator, do:

cd tools/codegen-options ; go run .

Input Description

This utility consumes Options.h, which must have very simple C++ syntax. Some of the limitations include:

• Only enum class is supported; no old-style enums.
• Opening braces for enum and struct must live at the end of a codeline.
• Enum values must be sequential and cannot have custom values.
• There are no namespaces other than the top-level namespace.
• Every struct field must supply a default value on a single codeline using the = operator.
• If the default value of a field is a vector, it must be in the form: { x, y, z }.
• The type of every struct field must be specified without any whitespace (e.g. Texture*).
• There must be no string literals that contain keywords.
• Enum names must be disambiguated when they appear in a struct field default value.

If the comment for a struct field contains the string %codegen_skip_json%, then the field is skipped when generating JSON serialization code.

If the comment for a struct field contains the string %codegen_skip_javascript%, then the field is skipped when generating JavaScript bindings.

Output Description

The following files are created:

• libs/viewer/src/Settings_generated.h
• libs/viewer/src/Settings_generated.cpp
• web/filament-js/jsbindings_generated.cpp
• web/filament-js/jsenums_generated.cpp
• web/filament-js/extensions_generated.js
• android/filament-android/src/main/cpp/View_generated.cpp (TBD)

Additionally, in-place edits are made to the following files:

• web/filament-js/filament.d.ts (TBD)
• android/filament-android/src/main/java/.../View.java (TBD)