Warning
The product is in closed beta and not open to the public.
flatcc¶
vb flatcc [OPTIONS] FILE1 [FILE2 ...]
Description¶
Run the embedded flatcc FlatBuffers schema compiler. FILE1 may be omitted when generating only common headers.
Options¶
- --reader¶
Generate reader code. Default option.
- -c, --common¶
Generate common include headers.
- -w, --builder¶
Generate builder code for creating FlatBuffers.
- -v, --verifier¶
Generate verifier code for validating FlatBuffers.
- -r, --recursive¶
Recursively process included schema files.
- -a¶
Generate all common outputs, similar to -c -w -v -r.
- -g¶
Generate only _get-suffixed reader accessors.
- -I INPATHS¶
Comma-separated schema include search paths.
- -o OUTPATH¶
Write generated files to output directory.
- --stdout¶
Concatenate all generated output to stdout.
- --outfile FILE¶
Concatenate all generated output to a file.
- --schema¶
Generate binary schema (.bfbs).
- --json-parser¶
Generate JSON parser for schema.
- --json-printer¶
Generate JSON printer for schema.
- --json¶
Generate both JSON parser and printer.
- -d¶
Generate dependency file, like gcc -MMD.
- --depfile FILE¶
Generate dependency file, like gcc -MF.
- --deptarget FILE¶
Override dependency target, like gcc -MT.
- --prefix PREFIX¶
Add prefix to all generated names.
- --common-prefix PREFIX¶
Replace flatbuffers prefix in common files.
Examples¶
Generate the default reader header for a schema.
$ vb sys mkdir schema gen
$ vb sys echo -e "namespace Example.Basic;\n\ntable Monster {\n hp:int = 100;\n name:string;\n}\n\nroot_type Monster;" > schema/monster.fbs
$ vb flatcc -o gen schema/monster.fbs
$ vb sys ls gen
monster_reader.h
Generate common headers, a builder, and a verifier together.
$ vb flatcc -c -w -v -o gen schema/monster.fbs
$ vb sys ls gen
flatbuffers_common_builder.h monster_builder.h monster_verifier.h
flatbuffers_common_reader.h monster_reader.h
Resolve included schemas with a single comma-separated include path list.
$ vb sys mkdir -p vendor/schema schema/include
$ vb sys echo -e "namespace Example.Include;\n\ntable Weapon {\n damage:int;\n}" > schema/include/weapon.fbs
$ vb sys echo -e "include \"weapon.fbs\";\n\nnamespace Example.Include;\n\ntable Monster {\n weapon:Weapon;\n}\n\nroot_type Monster;" > schema/monster_with_include.fbs
$ vb flatcc -r -I "vendor/schema,schema/include" -o gen schema/monster_with_include.fbs
$ vb sys ls gen
flatbuffers_common_builder.h monster_reader.h weapon_reader.h
flatbuffers_common_reader.h monster_verifier.h
monster_builder.h monster_with_include_reader.h
Generate JSON parser and printer headers.
$ vb flatcc --json -o gen schema/monster.fbs
$ vb sys ls gen
flatbuffers_common_builder.h monster_reader.h
flatbuffers_common_reader.h monster_verifier.h
monster_builder.h monster_with_include_reader.h
monster_json_parser.h weapon_reader.h
monster_json_printer.h
Concatenate generated text output into one file.
$ vb flatcc -c --reader --outfile gen/all_flatcc.h schema/monster.fbs
$ vb sys ls gen
all_flatcc.h monster_json_printer.h
flatbuffers_common_builder.h monster_reader.h
flatbuffers_common_reader.h monster_verifier.h
monster_builder.h monster_with_include_reader.h
monster_json_parser.h weapon_reader.h
Generate a binary schema file.
$ vb flatcc --schema -o gen schema/monster.fbs
$ vb sys ls gen
all_flatcc.h monster_json_printer.h
flatbuffers_common_builder.h monster_reader.h
flatbuffers_common_reader.h monster_verifier.h
monster.bfbs monster_with_include_reader.h
monster_builder.h weapon_reader.h
monster_json_parser.h