2 * Copyright 2014 Google Inc. All rights reserved.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #ifndef FLATBUFFERS_IDL_H_
18 #define FLATBUFFERS_IDL_H_
24 #include "flatbuffers/base.h"
25 #include "flatbuffers/flatbuffers.h"
26 #include "flatbuffers/flexbuffers.h"
27 #include "flatbuffers/hash.h"
28 #include "flatbuffers/reflection.h"
30 #if !defined(FLATBUFFERS_CPP98_STL)
31 # include <functional>
32 #endif // !defined(FLATBUFFERS_CPP98_STL)
34 // This file defines the data types representing a parsed IDL (Interface
35 // Definition Language) / schema file.
37 // Limits maximum depth of nested objects.
38 // Prevents stack overflow while parse flatbuffers or json.
39 #if !defined(FLATBUFFERS_MAX_PARSING_DEPTH)
40 # define FLATBUFFERS_MAX_PARSING_DEPTH 64
43 namespace flatbuffers {
45 // The order of these matters for Is*() functions below.
46 // Additionally, Parser::ParseType assumes bool..string is a contiguous range
49 #define FLATBUFFERS_GEN_TYPES_SCALAR(TD) \
50 TD(NONE, "", uint8_t, byte, byte, byte, uint8, u8, UByte) \
51 TD(UTYPE, "", uint8_t, byte, byte, byte, uint8, u8, UByte) /* begin scalar/int */ \
52 TD(BOOL, "bool", uint8_t, boolean,bool, bool, bool, bool, Boolean) \
53 TD(CHAR, "byte", int8_t, byte, int8, sbyte, int8, i8, Byte) \
54 TD(UCHAR, "ubyte", uint8_t, byte, byte, byte, uint8, u8, UByte) \
55 TD(SHORT, "short", int16_t, short, int16, short, int16, i16, Short) \
56 TD(USHORT, "ushort", uint16_t, short, uint16, ushort, uint16, u16, UShort) \
57 TD(INT, "int", int32_t, int, int32, int, int32, i32, Int) \
58 TD(UINT, "uint", uint32_t, int, uint32, uint, uint32, u32, UInt) \
59 TD(LONG, "long", int64_t, long, int64, long, int64, i64, Long) \
60 TD(ULONG, "ulong", uint64_t, long, uint64, ulong, uint64, u64, ULong) /* end int */ \
61 TD(FLOAT, "float", float, float, float32, float, float32, f32, Float) /* begin float */ \
62 TD(DOUBLE, "double", double, double, float64, double, float64, f64, Double) /* end float/scalar */
63 #define FLATBUFFERS_GEN_TYPES_POINTER(TD) \
64 TD(STRING, "string", Offset<void>, int, int, StringOffset, int, unused, Int) \
65 TD(VECTOR, "", Offset<void>, int, int, VectorOffset, int, unused, Int) \
66 TD(STRUCT, "", Offset<void>, int, int, int, int, unused, Int) \
67 TD(UNION, "", Offset<void>, int, int, int, int, unused, Int)
68 #define FLATBUFFERS_GEN_TYPE_ARRAY(TD) \
69 TD(ARRAY, "", int, int, int, int, int, unused, Int)
72 // - FlatBuffers schema type.
81 // using these macros, we can now write code dealing with types just once, e.g.
85 #define FLATBUFFERS_TD(ENUM, IDLTYPE, CTYPE, JTYPE, GTYPE, NTYPE, PTYPE, \
87 case BASE_TYPE_ ## ENUM: \
88 // do something specific to CTYPE here
89 FLATBUFFERS_GEN_TYPES(FLATBUFFERS_TD)
94 // If not all FLATBUFFERS_GEN_() arguments are necessary for implementation
95 // of FLATBUFFERS_TD, you can use a variadic macro (with __VA_ARGS__ if needed).
96 // In the above example, only CTYPE is used to generate the code, it can be rewritten:
100 #define FLATBUFFERS_TD(ENUM, IDLTYPE, CTYPE, ...) \
101 case BASE_TYPE_ ## ENUM: \
102 // do something specific to CTYPE here
103 FLATBUFFERS_GEN_TYPES(FLATBUFFERS_TD)
104 #undef FLATBUFFERS_TD
108 #define FLATBUFFERS_GEN_TYPES(TD) \
109 FLATBUFFERS_GEN_TYPES_SCALAR(TD) \
110 FLATBUFFERS_GEN_TYPES_POINTER(TD) \
111 FLATBUFFERS_GEN_TYPE_ARRAY(TD)
113 // Create an enum for all the types above.
115 __extension__ // Stop GCC complaining about trailing comma with -Wpendantic.
118 #define FLATBUFFERS_TD(ENUM, ...) \
120 FLATBUFFERS_GEN_TYPES(FLATBUFFERS_TD)
121 #undef FLATBUFFERS_TD
124 #define FLATBUFFERS_TD(ENUM, IDLTYPE, CTYPE, ...) \
125 static_assert(sizeof(CTYPE) <= sizeof(largest_scalar_t), \
126 "define largest_scalar_t as " #CTYPE);
127 FLATBUFFERS_GEN_TYPES(FLATBUFFERS_TD)
128 #undef FLATBUFFERS_TD
130 inline bool IsScalar (BaseType t) { return t >= BASE_TYPE_UTYPE &&
131 t <= BASE_TYPE_DOUBLE; }
132 inline bool IsInteger(BaseType t) { return t >= BASE_TYPE_UTYPE &&
133 t <= BASE_TYPE_ULONG; }
134 inline bool IsFloat (BaseType t) { return t == BASE_TYPE_FLOAT ||
135 t == BASE_TYPE_DOUBLE; }
136 inline bool IsLong (BaseType t) { return t == BASE_TYPE_LONG ||
137 t == BASE_TYPE_ULONG; }
138 inline bool IsBool (BaseType t) { return t == BASE_TYPE_BOOL; }
139 inline bool IsOneByte(BaseType t) { return t >= BASE_TYPE_UTYPE &&
140 t <= BASE_TYPE_UCHAR; }
142 inline bool IsUnsigned(BaseType t) {
143 return (t == BASE_TYPE_UTYPE) || (t == BASE_TYPE_UCHAR) ||
144 (t == BASE_TYPE_USHORT) || (t == BASE_TYPE_UINT) ||
145 (t == BASE_TYPE_ULONG);
150 extern const char *const kTypeNames[];
151 extern const char kTypeSizes[];
153 inline size_t SizeOf(BaseType t) { return kTypeSizes[t]; }
159 // Represents any type in the IDL, which is a combination of the BaseType
160 // and additional information for vectors/structs_.
162 explicit Type(BaseType _base_type = BASE_TYPE_NONE, StructDef *_sd = nullptr,
163 EnumDef *_ed = nullptr, uint16_t _fixed_length = 0)
164 : base_type(_base_type),
165 element(BASE_TYPE_NONE),
168 fixed_length(_fixed_length) {}
170 bool operator==(const Type &o) {
171 return base_type == o.base_type && element == o.element &&
172 struct_def == o.struct_def && enum_def == o.enum_def;
175 Type VectorType() const {
176 return Type(element, struct_def, enum_def, fixed_length);
179 Offset<reflection::Type> Serialize(FlatBufferBuilder *builder) const;
181 bool Deserialize(const Parser &parser, const reflection::Type *type);
184 BaseType element; // only set if t == BASE_TYPE_VECTOR
185 StructDef *struct_def; // only set if t or element == BASE_TYPE_STRUCT
186 EnumDef *enum_def; // set if t == BASE_TYPE_UNION / BASE_TYPE_UTYPE,
187 // or for an integral type derived from an enum.
188 uint16_t fixed_length; // only set if t == BASE_TYPE_ARRAY
191 // Represents a parsed scalar value, it's type, and field offset.
195 offset(static_cast<voffset_t>(~(static_cast<voffset_t>(0U)))) {}
197 std::string constant;
201 // Helper class that retains the original order of a set of identifiers and
202 // also provides quick lookup.
203 template<typename T> class SymbolTable {
206 for (auto it = vec.begin(); it != vec.end(); ++it) { delete *it; }
209 bool Add(const std::string &name, T *e) {
210 vector_emplace_back(&vec, e);
211 auto it = dict.find(name);
212 if (it != dict.end()) return true;
217 void Move(const std::string &oldname, const std::string &newname) {
218 auto it = dict.find(oldname);
219 if (it != dict.end()) {
220 auto obj = it->second;
224 FLATBUFFERS_ASSERT(false);
228 T *Lookup(const std::string &name) const {
229 auto it = dict.find(name);
230 return it == dict.end() ? nullptr : it->second;
234 std::map<std::string, T *> dict; // quick lookup
235 std::vector<T *> vec; // Used to iterate in order of insertion
238 // A name space, as set in the schema.
240 Namespace() : from_table(0) {}
242 // Given a (potentally unqualified) name, return the "fully qualified" name
243 // which has a full namespaced descriptor.
244 // With max_components you can request less than the number of components
245 // the current namespace has.
246 std::string GetFullyQualifiedName(const std::string &name,
247 size_t max_components = 1000) const;
249 std::vector<std::string> components;
250 size_t from_table; // Part of the namespace corresponds to a message/table.
253 inline bool operator<(const Namespace &a, const Namespace &b) {
254 size_t min_size = std::min(a.components.size(), b.components.size());
255 for (size_t i = 0; i < min_size; ++i) {
256 if (a.components[i] != b.components[i])
257 return a.components[i] < b.components[i];
259 return a.components.size() < b.components.size();
262 // Base class for all definition types (fields, structs_, enums_).
266 defined_namespace(nullptr),
267 serialized_location(0),
272 flatbuffers::Vector<flatbuffers::Offset<reflection::KeyValue>>>
273 SerializeAttributes(FlatBufferBuilder *builder, const Parser &parser) const;
275 bool DeserializeAttributes(Parser &parser,
276 const Vector<Offset<reflection::KeyValue>> *attrs);
280 std::vector<std::string> doc_comment;
281 SymbolTable<Value> attributes;
282 bool generated; // did we already output code for this definition?
283 Namespace *defined_namespace; // Where it was defined.
285 // For use with Serialize()
286 uoffset_t serialized_location;
287 int index; // Inside the vector it is stored.
291 struct FieldDef : public Definition {
297 native_inline(false),
299 nested_flatbuffer(NULL),
302 Offset<reflection::Field> Serialize(FlatBufferBuilder *builder, uint16_t id,
303 const Parser &parser) const;
305 bool Deserialize(Parser &parser, const reflection::Field *field);
308 bool deprecated; // Field is allowed to be present in old data, but can't be.
309 // written in new data nor accessed in new code.
310 bool required; // Field must always be present.
311 bool key; // Field functions as a key for creating sorted vectors.
312 bool shared; // Field will be using string pooling (i.e. CreateSharedString)
313 // as default serialization behavior if field is a string.
314 bool native_inline; // Field will be defined inline (instead of as a pointer)
315 // for native tables if field is a struct.
316 bool flexbuffer; // This field contains FlexBuffer data.
317 StructDef *nested_flatbuffer; // This field contains nested FlatBuffer data.
318 size_t padding; // Bytes to always pad after this field.
321 struct StructDef : public Definition {
330 void PadLastField(size_t min_align) {
331 auto padding = PaddingBytes(bytesize, min_align);
333 if (fields.vec.size()) fields.vec.back()->padding = padding;
336 Offset<reflection::Object> Serialize(FlatBufferBuilder *builder,
337 const Parser &parser) const;
339 bool Deserialize(Parser &parser, const reflection::Object *object);
341 SymbolTable<FieldDef> fields;
343 bool fixed; // If it's struct, not a table.
344 bool predecl; // If it's used before it was defined.
345 bool sortbysize; // Whether fields come in the declaration or size order.
346 bool has_key; // It has a key field.
347 size_t minalign; // What the whole object needs to be aligned to.
348 size_t bytesize; // Size if fixed.
350 flatbuffers::unique_ptr<std::string> original_location;
354 struct EnumValBuilder;
357 Offset<reflection::EnumVal> Serialize(FlatBufferBuilder *builder,
358 const Parser &parser) const;
360 bool Deserialize(const Parser &parser, const reflection::EnumVal *val);
362 uint64_t GetAsUInt64() const { return static_cast<uint64_t>(value); }
363 int64_t GetAsInt64() const { return value; }
364 bool IsZero() const { return 0 == value; }
365 bool IsNonZero() const { return !IsZero(); }
368 std::vector<std::string> doc_comment;
373 friend EnumValBuilder;
374 friend bool operator==(const EnumVal &lhs, const EnumVal &rhs);
376 EnumVal(const std::string &_name, int64_t _val) : name(_name), value(_val) {}
377 EnumVal() : value(0) {}
382 struct EnumDef : public Definition {
383 EnumDef() : is_union(false), uses_multiple_type_instances(false) {}
385 Offset<reflection::Enum> Serialize(FlatBufferBuilder *builder,
386 const Parser &parser) const;
388 bool Deserialize(Parser &parser, const reflection::Enum *values);
390 template<typename T> void ChangeEnumValue(EnumVal *ev, T new_val);
392 void RemoveDuplicates();
394 std::string AllFlags() const;
395 const EnumVal *MinValue() const;
396 const EnumVal *MaxValue() const;
397 // Returns the number of integer steps from v1 to v2.
398 uint64_t Distance(const EnumVal *v1, const EnumVal *v2) const;
399 // Returns the number of integer steps from Min to Max.
400 uint64_t Distance() const { return Distance(MinValue(), MaxValue()); }
402 EnumVal *ReverseLookup(int64_t enum_idx,
403 bool skip_union_default = false) const;
404 EnumVal *FindByValue(const std::string &constant) const;
406 std::string ToString(const EnumVal &ev) const {
407 return IsUInt64() ? NumToString(ev.GetAsUInt64())
408 : NumToString(ev.GetAsInt64());
411 size_t size() const { return vals.vec.size(); }
413 const std::vector<EnumVal *> &Vals() const {
414 FLATBUFFERS_ASSERT(false == vals.vec.empty());
418 const EnumVal *Lookup(const std::string &enum_name) const {
419 return vals.Lookup(enum_name);
423 // Type is a union which uses type aliases where at least one type is
424 // available under two different names.
425 bool uses_multiple_type_instances;
426 Type underlying_type;
429 bool IsUInt64() const {
430 return (BASE_TYPE_ULONG == underlying_type.base_type);
433 friend EnumValBuilder;
434 SymbolTable<EnumVal> vals;
437 inline bool IsStruct(const Type &type) {
438 return type.base_type == BASE_TYPE_STRUCT && type.struct_def->fixed;
441 inline bool IsUnion(const Type &type) {
442 return type.enum_def != nullptr && type.enum_def->is_union;
445 inline bool IsVector(const Type &type) {
446 return type.base_type == BASE_TYPE_VECTOR;
449 inline bool IsArray(const Type &type) {
450 return type.base_type == BASE_TYPE_ARRAY;
453 inline bool IsSeries(const Type &type) {
454 return IsVector(type) || IsArray(type);
457 inline bool IsEnum(const Type &type) {
458 return type.enum_def != nullptr && IsInteger(type.base_type);
461 inline size_t InlineSize(const Type &type) {
462 return IsStruct(type)
463 ? type.struct_def->bytesize
465 ? InlineSize(type.VectorType()) * type.fixed_length
466 : SizeOf(type.base_type));
469 inline size_t InlineAlignment(const Type &type) {
470 if (IsStruct(type)) {
471 return type.struct_def->minalign;
472 } else if (IsArray(type)) {
473 return IsStruct(type.VectorType()) ? type.struct_def->minalign
474 : SizeOf(type.element);
476 return SizeOf(type.base_type);
479 inline bool operator==(const EnumVal &lhs, const EnumVal &rhs) {
480 return lhs.value == rhs.value;
482 inline bool operator!=(const EnumVal &lhs, const EnumVal &rhs) {
483 return !(lhs == rhs);
486 inline bool EqualByName(const Type &a, const Type &b) {
487 return a.base_type == b.base_type && a.element == b.element &&
488 (a.struct_def == b.struct_def ||
489 a.struct_def->name == b.struct_def->name) &&
490 (a.enum_def == b.enum_def || a.enum_def->name == b.enum_def->name);
493 struct RPCCall : public Definition {
494 Offset<reflection::RPCCall> Serialize(FlatBufferBuilder *builder,
495 const Parser &parser) const;
497 bool Deserialize(Parser &parser, const reflection::RPCCall *call);
499 StructDef *request, *response;
502 struct ServiceDef : public Definition {
503 Offset<reflection::Service> Serialize(FlatBufferBuilder *builder,
504 const Parser &parser) const;
505 bool Deserialize(Parser &parser, const reflection::Service *service);
507 SymbolTable<RPCCall> calls;
510 // Container of options that may apply to any of the source/text generators.
512 // Use flexbuffers instead for binary and text generation
513 bool use_flexbuffers;
515 bool skip_js_exports;
516 bool use_goog_js_export_format;
517 bool use_ES6_js_export_format;
518 bool output_default_scalars_in_json;
520 bool output_enum_identifiers;
523 bool include_dependence_headers;
527 bool proto_oneof_union;
529 bool skip_unexpected_fields_in_json;
530 bool generate_name_strings;
531 bool generate_object_based_api;
533 std::string cpp_object_api_pointer_type;
534 std::string cpp_object_api_string_type;
535 bool cpp_object_api_string_flexible_constructor;
537 bool java_checkerframework;
539 std::string object_prefix;
540 std::string object_suffix;
541 bool union_value_namespacing;
544 std::string include_prefix;
545 bool keep_include_path;
546 bool binary_schema_comments;
547 bool binary_schema_builtins;
548 bool skip_flatbuffers_import;
549 std::string go_import;
550 std::string go_namespace;
551 bool reexport_ts_modules;
552 bool js_ts_short_names;
553 bool protobuf_ascii_alike;
555 std::string root_type;
557 bool java_primitive_has_method;
558 std::vector<std::string> cpp_includes;
561 // Possible options for the more general generator below.
573 kJsonSchema = 1 << 10,
584 enum MiniReflect { kNone, kTypes, kTypesAndNames };
586 MiniReflect mini_reflect;
588 // The corresponding language bit will be set if a language is included
589 // for code generation.
590 unsigned long lang_to_generate;
592 // If set (default behavior), empty string fields will be set to nullptr to make
593 // the flatbuffer more compact.
594 bool set_empty_strings_to_null;
596 // If set (default behavior), empty vector fields will be set to nullptr to make
597 // the flatbuffer more compact.
598 bool set_empty_vectors_to_null;
601 : use_flexbuffers(false),
603 skip_js_exports(false),
604 use_goog_js_export_format(false),
605 use_ES6_js_export_format(false),
606 output_default_scalars_in_json(false),
608 output_enum_identifiers(true),
609 prefixed_enums(true),
611 include_dependence_headers(true),
612 mutable_buffer(false),
615 proto_oneof_union(false),
617 skip_unexpected_fields_in_json(false),
618 generate_name_strings(false),
619 generate_object_based_api(false),
621 cpp_object_api_pointer_type("std::unique_ptr"),
622 cpp_object_api_string_flexible_constructor(false),
624 java_checkerframework(false),
625 gen_generated(false),
627 union_value_namespacing(true),
628 allow_non_utf8(false),
630 keep_include_path(false),
631 binary_schema_comments(false),
632 binary_schema_builtins(false),
633 skip_flatbuffers_import(false),
634 reexport_ts_modules(true),
635 js_ts_short_names(false),
636 protobuf_ascii_alike(false),
637 size_prefixed(false),
638 force_defaults(false),
639 java_primitive_has_method(false),
640 lang(IDLOptions::kJava),
641 mini_reflect(IDLOptions::kNone),
643 set_empty_strings_to_null(true),
644 set_empty_vectors_to_null(true) {}
647 // This encapsulates where the parser is in the current source file.
651 line_start_(nullptr),
654 attr_is_trivial_ascii_string_(true) {}
657 void ResetState(const char *source) {
664 line_start_ = cursor_;
668 int64_t CursorPosition() const {
669 FLATBUFFERS_ASSERT(cursor_ && line_start_ && cursor_ >= line_start_);
670 return static_cast<int64_t>(cursor_ - line_start_);
674 const char *line_start_;
675 int line_; // the current line being parsed
678 // Flag: text in attribute_ is true ASCII string without escape
679 // sequences. Only printable ASCII (without [\t\r\n]).
680 // Used for number-in-string (and base64 string in future).
681 bool attr_is_trivial_ascii_string_;
682 std::string attribute_;
683 std::vector<std::string> doc_comment_;
686 // A way to make error propagation less error prone by requiring values to be
688 // Once you create a value of this type you must either:
689 // - Call Check() on it.
690 // - Copy or assign it to another value.
691 // Failure to do so leads to an assert.
692 // This guarantees that this as return value cannot be ignored.
695 explicit CheckedError(bool error)
696 : is_error_(error), has_been_checked_(false) {}
698 CheckedError &operator=(const CheckedError &other) {
699 is_error_ = other.is_error_;
700 has_been_checked_ = false;
701 other.has_been_checked_ = true;
705 CheckedError(const CheckedError &other) {
706 *this = other; // Use assignment operator.
709 ~CheckedError() { FLATBUFFERS_ASSERT(has_been_checked_); }
712 has_been_checked_ = true;
718 mutable bool has_been_checked_;
721 // Additionally, in GCC we can get these errors statically, for additional
725 #define FLATBUFFERS_CHECKED_ERROR CheckedError \
726 __attribute__((warn_unused_result))
728 #define FLATBUFFERS_CHECKED_ERROR CheckedError
732 class Parser : public ParserState {
734 explicit Parser(const IDLOptions &options = IDLOptions())
735 : current_namespace_(nullptr),
736 empty_namespace_(nullptr),
737 flex_builder_(256, flexbuffers::BUILDER_FLAG_SHARE_ALL),
738 root_struct_def_(nullptr),
740 uses_flexbuffers_(false),
742 anonymous_counter(0),
743 recurse_protection_counter(0) {
744 if (opts.force_defaults) { builder_.ForceDefaults(true); }
745 // Start out with the empty namespace being current.
746 empty_namespace_ = new Namespace();
747 namespaces_.push_back(empty_namespace_);
748 current_namespace_ = empty_namespace_;
749 known_attributes_["deprecated"] = true;
750 known_attributes_["required"] = true;
751 known_attributes_["key"] = true;
752 known_attributes_["shared"] = true;
753 known_attributes_["hash"] = true;
754 known_attributes_["id"] = true;
755 known_attributes_["force_align"] = true;
756 known_attributes_["bit_flags"] = true;
757 known_attributes_["original_order"] = true;
758 known_attributes_["nested_flatbuffer"] = true;
759 known_attributes_["csharp_partial"] = true;
760 known_attributes_["streaming"] = true;
761 known_attributes_["idempotent"] = true;
762 known_attributes_["cpp_type"] = true;
763 known_attributes_["cpp_ptr_type"] = true;
764 known_attributes_["cpp_ptr_type_get"] = true;
765 known_attributes_["cpp_str_type"] = true;
766 known_attributes_["cpp_str_flex_ctor"] = true;
767 known_attributes_["native_inline"] = true;
768 known_attributes_["native_custom_alloc"] = true;
769 known_attributes_["native_type"] = true;
770 known_attributes_["native_default"] = true;
771 known_attributes_["flexbuffer"] = true;
772 known_attributes_["private"] = true;
776 for (auto it = namespaces_.begin(); it != namespaces_.end(); ++it) {
781 // Parse the string containing either schema or JSON data, which will
782 // populate the SymbolTable's or the FlatBufferBuilder above.
783 // include_paths is used to resolve any include statements, and typically
784 // should at least include the project path (where you loaded source_ from).
785 // include_paths must be nullptr terminated if specified.
786 // If include_paths is nullptr, it will attempt to load from the current
788 // If the source was loaded from a file and isn't an include file,
789 // supply its name in source_filename.
790 // All paths specified in this call must be in posix format, if you accept
791 // paths from user input, please call PosixPath on them first.
792 bool Parse(const char *_source, const char **include_paths = nullptr,
793 const char *source_filename = nullptr);
795 // Set the root type. May override the one set in the schema.
796 bool SetRootType(const char *name);
798 // Mark all definitions as already having code generated.
799 void MarkGenerated();
801 // Get the files recursively included by the given file. The returned
802 // container will have at least the given file.
803 std::set<std::string> GetIncludedFilesRecursive(
804 const std::string &file_name) const;
806 // Fills builder_ with a binary version of the schema parsed.
807 // See reflection/reflection.fbs
810 // Deserialize a schema buffer
811 bool Deserialize(const uint8_t *buf, const size_t size);
813 // Fills internal structure as if the schema passed had been loaded by parsing
814 // with Parse except that included filenames will not be populated.
815 bool Deserialize(const reflection::Schema *schema);
817 Type *DeserializeType(const reflection::Type *type);
819 // Checks that the schema represented by this parser is a safe evolution
820 // of the schema provided. Returns non-empty error on any problems.
821 std::string ConformTo(const Parser &base);
823 // Similar to Parse(), but now only accepts JSON to be parsed into a
825 bool ParseFlexBuffer(const char *source, const char *source_filename,
826 flexbuffers::Builder *builder);
828 StructDef *LookupStruct(const std::string &id) const;
830 std::string UnqualifiedName(const std::string &fullQualifiedName);
832 FLATBUFFERS_CHECKED_ERROR Error(const std::string &msg);
835 void Message(const std::string &msg);
836 void Warning(const std::string &msg);
837 FLATBUFFERS_CHECKED_ERROR ParseHexNum(int nibbles, uint64_t *val);
838 FLATBUFFERS_CHECKED_ERROR Next();
839 FLATBUFFERS_CHECKED_ERROR SkipByteOrderMark();
840 bool Is(int t) const;
841 bool IsIdent(const char *id) const;
842 FLATBUFFERS_CHECKED_ERROR Expect(int t);
843 std::string TokenToStringId(int t) const;
844 EnumDef *LookupEnum(const std::string &id);
845 FLATBUFFERS_CHECKED_ERROR ParseNamespacing(std::string *id,
847 FLATBUFFERS_CHECKED_ERROR ParseTypeIdent(Type &type);
848 FLATBUFFERS_CHECKED_ERROR ParseType(Type &type);
849 FLATBUFFERS_CHECKED_ERROR AddField(StructDef &struct_def,
850 const std::string &name, const Type &type,
852 FLATBUFFERS_CHECKED_ERROR ParseField(StructDef &struct_def);
853 FLATBUFFERS_CHECKED_ERROR ParseString(Value &val);
854 FLATBUFFERS_CHECKED_ERROR ParseComma();
855 FLATBUFFERS_CHECKED_ERROR ParseAnyValue(Value &val, FieldDef *field,
856 size_t parent_fieldn,
857 const StructDef *parent_struct_def,
859 bool inside_vector = false);
861 FLATBUFFERS_CHECKED_ERROR ParseTableDelimiters(size_t &fieldn,
862 const StructDef *struct_def,
864 FLATBUFFERS_CHECKED_ERROR ParseTable(const StructDef &struct_def,
865 std::string *value, uoffset_t *ovalue);
866 void SerializeStruct(const StructDef &struct_def, const Value &val);
867 void SerializeStruct(FlatBufferBuilder &builder, const StructDef &struct_def,
870 FLATBUFFERS_CHECKED_ERROR ParseVectorDelimiters(uoffset_t &count, F body);
871 FLATBUFFERS_CHECKED_ERROR ParseVector(const Type &type, uoffset_t *ovalue,
872 FieldDef *field, size_t fieldn);
873 FLATBUFFERS_CHECKED_ERROR ParseArray(Value &array);
874 FLATBUFFERS_CHECKED_ERROR ParseNestedFlatbuffer(
875 Value &val, FieldDef *field, size_t fieldn,
876 const StructDef *parent_struct_def);
877 FLATBUFFERS_CHECKED_ERROR ParseMetaData(SymbolTable<Value> *attributes);
878 FLATBUFFERS_CHECKED_ERROR TryTypedValue(const std::string *name, int dtoken,
879 bool check, Value &e, BaseType req,
881 FLATBUFFERS_CHECKED_ERROR ParseHash(Value &e, FieldDef *field);
882 FLATBUFFERS_CHECKED_ERROR TokenError();
883 FLATBUFFERS_CHECKED_ERROR ParseSingleValue(const std::string *name, Value &e,
885 FLATBUFFERS_CHECKED_ERROR ParseEnumFromString(const Type &type,
886 std::string *result);
887 StructDef *LookupCreateStruct(const std::string &name,
888 bool create_if_new = true,
889 bool definition = false);
890 FLATBUFFERS_CHECKED_ERROR ParseEnum(bool is_union, EnumDef **dest);
891 FLATBUFFERS_CHECKED_ERROR ParseNamespace();
892 FLATBUFFERS_CHECKED_ERROR StartStruct(const std::string &name,
894 FLATBUFFERS_CHECKED_ERROR StartEnum(const std::string &name, bool is_union,
896 FLATBUFFERS_CHECKED_ERROR ParseDecl();
897 FLATBUFFERS_CHECKED_ERROR ParseService();
898 FLATBUFFERS_CHECKED_ERROR ParseProtoFields(StructDef *struct_def,
899 bool isextend, bool inside_oneof);
900 FLATBUFFERS_CHECKED_ERROR ParseProtoOption();
901 FLATBUFFERS_CHECKED_ERROR ParseProtoKey();
902 FLATBUFFERS_CHECKED_ERROR ParseProtoDecl();
903 FLATBUFFERS_CHECKED_ERROR ParseProtoCurliesOrIdent();
904 FLATBUFFERS_CHECKED_ERROR ParseTypeFromProtoType(Type *type);
905 FLATBUFFERS_CHECKED_ERROR SkipAnyJsonValue();
906 FLATBUFFERS_CHECKED_ERROR ParseFlexBufferValue(flexbuffers::Builder *builder);
907 FLATBUFFERS_CHECKED_ERROR StartParseFile(const char *source,
908 const char *source_filename);
909 FLATBUFFERS_CHECKED_ERROR ParseRoot(const char *_source,
910 const char **include_paths,
911 const char *source_filename);
912 FLATBUFFERS_CHECKED_ERROR DoParse(const char *_source,
913 const char **include_paths,
914 const char *source_filename,
915 const char *include_filename);
916 FLATBUFFERS_CHECKED_ERROR CheckClash(std::vector<FieldDef *> &fields,
917 StructDef *struct_def,
918 const char *suffix, BaseType baseType);
920 bool SupportsAdvancedUnionFeatures() const;
921 bool SupportsAdvancedArrayFeatures() const;
922 Namespace *UniqueNamespace(Namespace *ns);
924 FLATBUFFERS_CHECKED_ERROR RecurseError();
925 template<typename F> CheckedError Recurse(F f);
928 SymbolTable<Type> types_;
929 SymbolTable<StructDef> structs_;
930 SymbolTable<EnumDef> enums_;
931 SymbolTable<ServiceDef> services_;
932 std::vector<Namespace *> namespaces_;
933 Namespace *current_namespace_;
934 Namespace *empty_namespace_;
935 std::string error_; // User readable error_ if Parse() == false
937 FlatBufferBuilder builder_; // any data contained in the file
938 flexbuffers::Builder flex_builder_;
939 flexbuffers::Reference flex_root_;
940 StructDef *root_struct_def_;
941 std::string file_identifier_;
942 std::string file_extension_;
944 std::map<std::string, std::string> included_files_;
945 std::map<std::string, std::set<std::string>> files_included_per_file_;
946 std::vector<std::string> native_included_files_;
948 std::map<std::string, bool> known_attributes_;
951 bool uses_flexbuffers_;
956 std::string file_being_parsed_;
958 std::vector<std::pair<Value, FieldDef *>> field_stack_;
960 int anonymous_counter;
961 int recurse_protection_counter;
964 // Utility functions for multiple generators:
966 extern std::string MakeCamel(const std::string &in, bool first = true);
968 extern std::string MakeScreamingCamel(const std::string &in);
970 // Generate text (JSON) from a given FlatBuffer, and a given Parser
971 // object that has been populated with the corresponding schema.
972 // If ident_step is 0, no indentation will be generated. Additionally,
973 // if it is less than 0, no linefeeds will be generated either.
974 // See idl_gen_text.cpp.
975 // strict_json adds "quotes" around field names if true.
976 // If the flatbuffer cannot be encoded in JSON (e.g., it contains non-UTF-8
977 // byte arrays in String values), returns false.
978 extern bool GenerateTextFromTable(const Parser &parser, const void *table,
979 const std::string &tablename,
981 extern bool GenerateText(const Parser &parser, const void *flatbuffer,
983 extern bool GenerateTextFile(const Parser &parser, const std::string &path,
984 const std::string &file_name);
986 // Generate binary files from a given FlatBuffer, and a given Parser
987 // object that has been populated with the corresponding schema.
988 // See code_generators.cpp.
989 extern bool GenerateBinary(const Parser &parser, const std::string &path,
990 const std::string &file_name);
992 // Generate a C++ header from the definitions in the Parser object.
994 extern bool GenerateCPP(const Parser &parser, const std::string &path,
995 const std::string &file_name);
997 // Generate C# files from the definitions in the Parser object.
998 // See idl_gen_csharp.cpp.
999 extern bool GenerateCSharp(const Parser &parser, const std::string &path,
1000 const std::string &file_name);
1002 extern bool GenerateDart(const Parser &parser, const std::string &path,
1003 const std::string &file_name);
1005 // Generate Java files from the definitions in the Parser object.
1006 // See idl_gen_java.cpp.
1007 extern bool GenerateJava(const Parser &parser, const std::string &path,
1008 const std::string &file_name);
1010 // Generate JavaScript or TypeScript code from the definitions in the Parser
1011 // object. See idl_gen_js.
1012 extern bool GenerateJSTS(const Parser &parser, const std::string &path,
1013 const std::string &file_name);
1015 // Generate Go files from the definitions in the Parser object.
1016 // See idl_gen_go.cpp.
1017 extern bool GenerateGo(const Parser &parser, const std::string &path,
1018 const std::string &file_name);
1020 // Generate Php code from the definitions in the Parser object.
1022 extern bool GeneratePhp(const Parser &parser, const std::string &path,
1023 const std::string &file_name);
1025 // Generate Python files from the definitions in the Parser object.
1026 // See idl_gen_python.cpp.
1027 extern bool GeneratePython(const Parser &parser, const std::string &path,
1028 const std::string &file_name);
1030 // Generate Lobster files from the definitions in the Parser object.
1031 // See idl_gen_lobster.cpp.
1032 extern bool GenerateLobster(const Parser &parser, const std::string &path,
1033 const std::string &file_name);
1035 // Generate Lua files from the definitions in the Parser object.
1036 // See idl_gen_lua.cpp.
1037 extern bool GenerateLua(const Parser &parser, const std::string &path,
1038 const std::string &file_name);
1040 // Generate Rust files from the definitions in the Parser object.
1041 // See idl_gen_rust.cpp.
1042 extern bool GenerateRust(const Parser &parser, const std::string &path,
1043 const std::string &file_name);
1045 // Generate Json schema file
1046 // See idl_gen_json_schema.cpp.
1047 extern bool GenerateJsonSchema(const Parser &parser, const std::string &path,
1048 const std::string &file_name);
1050 extern bool GenerateKotlin(const Parser &parser, const std::string &path,
1051 const std::string &file_name);
1053 // Generate a schema file from the internal representation, useful after
1054 // parsing a .proto schema.
1055 extern std::string GenerateFBS(const Parser &parser,
1056 const std::string &file_name);
1057 extern bool GenerateFBS(const Parser &parser, const std::string &path,
1058 const std::string &file_name);
1060 // Generate a make rule for the generated JavaScript or TypeScript code.
1061 // See idl_gen_js.cpp.
1062 extern std::string JSTSMakeRule(const Parser &parser, const std::string &path,
1063 const std::string &file_name);
1065 // Generate a make rule for the generated C++ header.
1066 // See idl_gen_cpp.cpp.
1067 extern std::string CPPMakeRule(const Parser &parser, const std::string &path,
1068 const std::string &file_name);
1070 // Generate a make rule for the generated Dart code
1071 // see idl_gen_dart.cpp
1072 extern std::string DartMakeRule(const Parser &parser, const std::string &path,
1073 const std::string &file_name);
1075 // Generate a make rule for the generated Rust code.
1076 // See idl_gen_rust.cpp.
1077 extern std::string RustMakeRule(const Parser &parser, const std::string &path,
1078 const std::string &file_name);
1080 // Generate a make rule for generated Java or C# files.
1081 // See code_generators.cpp.
1082 extern std::string JavaCSharpMakeRule(const Parser &parser,
1083 const std::string &path,
1084 const std::string &file_name);
1086 // Generate a make rule for the generated text (JSON) files.
1087 // See idl_gen_text.cpp.
1088 extern std::string TextMakeRule(const Parser &parser, const std::string &path,
1089 const std::string &file_names);
1091 // Generate a make rule for the generated binary files.
1092 // See code_generators.cpp.
1093 extern std::string BinaryMakeRule(const Parser &parser, const std::string &path,
1094 const std::string &file_name);
1096 // Generate GRPC Cpp interfaces.
1097 // See idl_gen_grpc.cpp.
1098 bool GenerateCppGRPC(const Parser &parser, const std::string &path,
1099 const std::string &file_name);
1101 // Generate GRPC Go interfaces.
1102 // See idl_gen_grpc.cpp.
1103 bool GenerateGoGRPC(const Parser &parser, const std::string &path,
1104 const std::string &file_name);
1106 // Generate GRPC Java classes.
1107 // See idl_gen_grpc.cpp
1108 bool GenerateJavaGRPC(const Parser &parser, const std::string &path,
1109 const std::string &file_name);
1111 // Generate GRPC Python interfaces.
1112 // See idl_gen_grpc.cpp.
1113 bool GeneratePythonGRPC(const Parser &parser,
1114 const std::string &path,
1115 const std::string &file_name);
1117 } // namespace flatbuffers
1119 #endif // FLATBUFFERS_IDL_H_