include/flatbuffers/idl.h

   1 /*
   2  * Copyright 2014 Google Inc. All rights reserved.
   3  *
   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
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 #ifndef FLATBUFFERS_IDL_H_
  18 #define FLATBUFFERS_IDL_H_
  19
  20 #include <map>
  21 #include <memory>
  22 #include <stack>
  23
  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"
  29
  30 #if !defined(FLATBUFFERS_CPP98_STL)
  31 #  include <functional>
  32 #endif  // !defined(FLATBUFFERS_CPP98_STL)
  33
  34 // This file defines the data types representing a parsed IDL (Interface
  35 // Definition Language) / schema file.
  36
  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
  41 #endif
  42
  43 namespace flatbuffers {
  44
  45 // The order of these matters for Is*() functions below.
  46 // Additionally, Parser::ParseType assumes bool..string is a contiguous range
  47 // of type tokens.
  48 // clang-format off
  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)
  70 // The fields are:
  71 // - enum
  72 // - FlatBuffers schema type.
  73 // - C++ type.
  74 // - Java type.
  75 // - Go type.
  76 // - C# / .Net type.
  77 // - Python type.
  78 // - Rust type.
  79 // - Kotlin type.
  80
  81 // using these macros, we can now write code dealing with types just once, e.g.
  82
  83 /*
  84 switch (type) {
  85   #define FLATBUFFERS_TD(ENUM, IDLTYPE, CTYPE, JTYPE, GTYPE, NTYPE, PTYPE, \
  86                          RTYPE, KTYPE) \
  87     case BASE_TYPE_ ## ENUM: \
  88       // do something specific to CTYPE here
  89     FLATBUFFERS_GEN_TYPES(FLATBUFFERS_TD)
  90   #undef FLATBUFFERS_TD
  91 }
  92 */
  93
  94 #define FLATBUFFERS_GEN_TYPES(TD) \
  95         FLATBUFFERS_GEN_TYPES_SCALAR(TD) \
  96         FLATBUFFERS_GEN_TYPES_POINTER(TD) \
  97         FLATBUFFERS_GEN_TYPE_ARRAY(TD)
  98
  99 // Create an enum for all the types above.
 100 #ifdef __GNUC__
 101 __extension__  // Stop GCC complaining about trailing comma with -Wpendantic.
 102 #endif
 103 enum BaseType {
 104   #define FLATBUFFERS_TD(ENUM, IDLTYPE, CTYPE, JTYPE, GTYPE, NTYPE, PTYPE, \
 105                          RTYPE, KTYPE) \
 106       BASE_TYPE_ ## ENUM,
 107     FLATBUFFERS_GEN_TYPES(FLATBUFFERS_TD)
 108   #undef FLATBUFFERS_TD
 109 };
 110
 111 #define FLATBUFFERS_TD(ENUM, IDLTYPE, CTYPE, JTYPE, GTYPE, NTYPE, PTYPE, \
 112                        RTYPE, KTYPE) \
 113     static_assert(sizeof(CTYPE) <= sizeof(largest_scalar_t), \
 114                   "define largest_scalar_t as " #CTYPE);
 115   FLATBUFFERS_GEN_TYPES(FLATBUFFERS_TD)
 116 #undef FLATBUFFERS_TD
 117
 118 inline bool IsScalar (BaseType t) { return t >= BASE_TYPE_UTYPE &&
 119                                            t <= BASE_TYPE_DOUBLE; }
 120 inline bool IsInteger(BaseType t) { return t >= BASE_TYPE_UTYPE &&
 121                                            t <= BASE_TYPE_ULONG; }
 122 inline bool IsFloat  (BaseType t) { return t == BASE_TYPE_FLOAT ||
 123                                            t == BASE_TYPE_DOUBLE; }
 124 inline bool IsLong   (BaseType t) { return t == BASE_TYPE_LONG ||
 125                                            t == BASE_TYPE_ULONG; }
 126 inline bool IsBool   (BaseType t) { return t == BASE_TYPE_BOOL; }
 127 inline bool IsOneByte(BaseType t) { return t >= BASE_TYPE_UTYPE &&
 128                                            t <= BASE_TYPE_UCHAR; }
 129
 130 inline bool IsUnsigned(BaseType t) {
 131   return (t == BASE_TYPE_UTYPE)  || (t == BASE_TYPE_UCHAR) ||
 132          (t == BASE_TYPE_USHORT) || (t == BASE_TYPE_UINT)  ||
 133          (t == BASE_TYPE_ULONG);
 134 }
 135
 136 // clang-format on
 137
 138 extern const char *const kTypeNames[];
 139 extern const char kTypeSizes[];
 140
 141 inline size_t SizeOf(BaseType t) { return kTypeSizes[t]; }
 142
 143 struct StructDef;
 144 struct EnumDef;
 145 class Parser;
 146
 147 // Represents any type in the IDL, which is a combination of the BaseType
 148 // and additional information for vectors/structs_.
 149 struct Type {
 150   explicit Type(BaseType _base_type = BASE_TYPE_NONE, StructDef *_sd = nullptr,
 151                 EnumDef *_ed = nullptr, uint16_t _fixed_length = 0)
 152       : base_type(_base_type),
 153         element(BASE_TYPE_NONE),
 154         struct_def(_sd),
 155         enum_def(_ed),
 156         fixed_length(_fixed_length) {}
 157
 158   bool operator==(const Type &o) {
 159     return base_type == o.base_type && element == o.element &&
 160            struct_def == o.struct_def && enum_def == o.enum_def;
 161   }
 162
 163   Type VectorType() const {
 164     return Type(element, struct_def, enum_def, fixed_length);
 165   }
 166
 167   Offset<reflection::Type> Serialize(FlatBufferBuilder *builder) const;
 168
 169   bool Deserialize(const Parser &parser, const reflection::Type *type);
 170
 171   BaseType base_type;
 172   BaseType element;       // only set if t == BASE_TYPE_VECTOR
 173   StructDef *struct_def;  // only set if t or element == BASE_TYPE_STRUCT
 174   EnumDef *enum_def;      // set if t == BASE_TYPE_UNION / BASE_TYPE_UTYPE,
 175                           // or for an integral type derived from an enum.
 176   uint16_t fixed_length;  // only set if t == BASE_TYPE_ARRAY
 177 };
 178
 179 // Represents a parsed scalar value, it's type, and field offset.
 180 struct Value {
 181   Value()
 182       : constant("0"),
 183         offset(static_cast<voffset_t>(~(static_cast<voffset_t>(0U)))) {}
 184   Type type;
 185   std::string constant;
 186   voffset_t offset;
 187 };
 188
 189 // Helper class that retains the original order of a set of identifiers and
 190 // also provides quick lookup.
 191 template<typename T> class SymbolTable {
 192  public:
 193   ~SymbolTable() {
 194     for (auto it = vec.begin(); it != vec.end(); ++it) { delete *it; }
 195   }
 196
 197   bool Add(const std::string &name, T *e) {
 198     vector_emplace_back(&vec, e);
 199     auto it = dict.find(name);
 200     if (it != dict.end()) return true;
 201     dict[name] = e;
 202     return false;
 203   }
 204
 205   void Move(const std::string &oldname, const std::string &newname) {
 206     auto it = dict.find(oldname);
 207     if (it != dict.end()) {
 208       auto obj = it->second;
 209       dict.erase(it);
 210       dict[newname] = obj;
 211     } else {
 212       FLATBUFFERS_ASSERT(false);
 213     }
 214   }
 215
 216   T *Lookup(const std::string &name) const {
 217     auto it = dict.find(name);
 218     return it == dict.end() ? nullptr : it->second;
 219   }
 220
 221  public:
 222   std::map<std::string, T *> dict;  // quick lookup
 223   std::vector<T *> vec;             // Used to iterate in order of insertion
 224 };
 225
 226 // A name space, as set in the schema.
 227 struct Namespace {
 228   Namespace() : from_table(0) {}
 229
 230   // Given a (potentally unqualified) name, return the "fully qualified" name
 231   // which has a full namespaced descriptor.
 232   // With max_components you can request less than the number of components
 233   // the current namespace has.
 234   std::string GetFullyQualifiedName(const std::string &name,
 235                                     size_t max_components = 1000) const;
 236
 237   std::vector<std::string> components;
 238   size_t from_table;  // Part of the namespace corresponds to a message/table.
 239 };
 240
 241 inline bool operator<(const Namespace &a, const Namespace &b) {
 242   size_t min_size = std::min(a.components.size(), b.components.size());
 243   for (size_t i = 0; i < min_size; ++i) {
 244     if (a.components[i] != b.components[i])
 245       return a.components[i] < b.components[i];
 246   }
 247   return a.components.size() < b.components.size();
 248 }
 249
 250 // Base class for all definition types (fields, structs_, enums_).
 251 struct Definition {
 252   Definition()
 253       : generated(false),
 254         defined_namespace(nullptr),
 255         serialized_location(0),
 256         index(-1),
 257         refcount(1) {}
 258
 259   flatbuffers::Offset<
 260       flatbuffers::Vector<flatbuffers::Offset<reflection::KeyValue>>>
 261   SerializeAttributes(FlatBufferBuilder *builder, const Parser &parser) const;
 262
 263   bool DeserializeAttributes(Parser &parser,
 264                              const Vector<Offset<reflection::KeyValue>> *attrs);
 265
 266   std::string name;
 267   std::string file;
 268   std::vector<std::string> doc_comment;
 269   SymbolTable<Value> attributes;
 270   bool generated;  // did we already output code for this definition?
 271   Namespace *defined_namespace;  // Where it was defined.
 272
 273   // For use with Serialize()
 274   uoffset_t serialized_location;
 275   int index;  // Inside the vector it is stored.
 276   int refcount;
 277 };
 278
 279 struct FieldDef : public Definition {
 280   FieldDef()
 281       : deprecated(false),
 282         required(false),
 283         key(false),
 284         shared(false),
 285         native_inline(false),
 286         flexbuffer(false),
 287         nested_flatbuffer(NULL),
 288         padding(0) {}
 289
 290   Offset<reflection::Field> Serialize(FlatBufferBuilder *builder, uint16_t id,
 291                                       const Parser &parser) const;
 292
 293   bool Deserialize(Parser &parser, const reflection::Field *field);
 294
 295   Value value;
 296   bool deprecated;  // Field is allowed to be present in old data, but can't be.
 297                     // written in new data nor accessed in new code.
 298   bool required;    // Field must always be present.
 299   bool key;         // Field functions as a key for creating sorted vectors.
 300   bool shared;  // Field will be using string pooling (i.e. CreateSharedString)
 301                 // as default serialization behavior if field is a string.
 302   bool native_inline;  // Field will be defined inline (instead of as a pointer)
 303                        // for native tables if field is a struct.
 304   bool flexbuffer;     // This field contains FlexBuffer data.
 305   StructDef *nested_flatbuffer;  // This field contains nested FlatBuffer data.
 306   size_t padding;                // Bytes to always pad after this field.
 307 };
 308
 309 struct StructDef : public Definition {
 310   StructDef()
 311       : fixed(false),
 312         predecl(true),
 313         sortbysize(true),
 314         has_key(false),
 315         minalign(1),
 316         bytesize(0) {}
 317
 318   void PadLastField(size_t min_align) {
 319     auto padding = PaddingBytes(bytesize, min_align);
 320     bytesize += padding;
 321     if (fields.vec.size()) fields.vec.back()->padding = padding;
 322   }
 323
 324   Offset<reflection::Object> Serialize(FlatBufferBuilder *builder,
 325                                        const Parser &parser) const;
 326
 327   bool Deserialize(Parser &parser, const reflection::Object *object);
 328
 329   SymbolTable<FieldDef> fields;
 330
 331   bool fixed;       // If it's struct, not a table.
 332   bool predecl;     // If it's used before it was defined.
 333   bool sortbysize;  // Whether fields come in the declaration or size order.
 334   bool has_key;     // It has a key field.
 335   size_t minalign;  // What the whole object needs to be aligned to.
 336   size_t bytesize;  // Size if fixed.
 337
 338   flatbuffers::unique_ptr<std::string> original_location;
 339 };
 340
 341 struct EnumDef;
 342 struct EnumValBuilder;
 343
 344 struct EnumVal {
 345   Offset<reflection::EnumVal> Serialize(FlatBufferBuilder *builder,
 346                                         const Parser &parser) const;
 347
 348   bool Deserialize(const Parser &parser, const reflection::EnumVal *val);
 349
 350   uint64_t GetAsUInt64() const { return static_cast<uint64_t>(value); }
 351   int64_t GetAsInt64() const { return value; }
 352   bool IsZero() const { return 0 == value; }
 353   bool IsNonZero() const { return !IsZero(); }
 354
 355   std::string name;
 356   std::vector<std::string> doc_comment;
 357   Type union_type;
 358
 359  private:
 360   friend EnumDef;
 361   friend EnumValBuilder;
 362   friend bool operator==(const EnumVal &lhs, const EnumVal &rhs);
 363
 364   EnumVal(const std::string &_name, int64_t _val) : name(_name), value(_val) {}
 365   EnumVal() : value(0) {}
 366
 367   int64_t value;
 368 };
 369
 370 struct EnumDef : public Definition {
 371   EnumDef() : is_union(false), uses_multiple_type_instances(false) {}
 372
 373   Offset<reflection::Enum> Serialize(FlatBufferBuilder *builder,
 374                                      const Parser &parser) const;
 375
 376   bool Deserialize(Parser &parser, const reflection::Enum *values);
 377
 378   template<typename T> void ChangeEnumValue(EnumVal *ev, T new_val);
 379   void SortByValue();
 380   void RemoveDuplicates();
 381
 382   std::string AllFlags() const;
 383   const EnumVal *MinValue() const;
 384   const EnumVal *MaxValue() const;
 385   // Returns the number of integer steps from v1 to v2.
 386   uint64_t Distance(const EnumVal *v1, const EnumVal *v2) const;
 387   // Returns the number of integer steps from Min to Max.
 388   uint64_t Distance() const { return Distance(MinValue(), MaxValue()); }
 389
 390   EnumVal *ReverseLookup(int64_t enum_idx,
 391                          bool skip_union_default = false) const;
 392   EnumVal *FindByValue(const std::string &constant) const;
 393
 394   std::string ToString(const EnumVal &ev) const {
 395     return IsUInt64() ? NumToString(ev.GetAsUInt64())
 396                       : NumToString(ev.GetAsInt64());
 397   }
 398
 399   size_t size() const { return vals.vec.size(); }
 400
 401   const std::vector<EnumVal *> &Vals() const {
 402     FLATBUFFERS_ASSERT(false == vals.vec.empty());
 403     return vals.vec;
 404   }
 405
 406   const EnumVal *Lookup(const std::string &enum_name) const {
 407     return vals.Lookup(enum_name);
 408   }
 409
 410   bool is_union;
 411   // Type is a union which uses type aliases where at least one type is
 412   // available under two different names.
 413   bool uses_multiple_type_instances;
 414   Type underlying_type;
 415
 416  private:
 417   bool IsUInt64() const {
 418     return (BASE_TYPE_ULONG == underlying_type.base_type);
 419   }
 420
 421   friend EnumValBuilder;
 422   SymbolTable<EnumVal> vals;
 423 };
 424
 425 inline bool IsStruct(const Type &type) {
 426   return type.base_type == BASE_TYPE_STRUCT && type.struct_def->fixed;
 427 }
 428
 429 inline bool IsUnion(const Type &type) {
 430   return type.enum_def != nullptr && type.enum_def->is_union;
 431 }
 432
 433 inline bool IsVector(const Type &type) {
 434   return type.base_type == BASE_TYPE_VECTOR;
 435 }
 436
 437 inline bool IsArray(const Type &type) {
 438   return type.base_type == BASE_TYPE_ARRAY;
 439 }
 440
 441 inline bool IsSeries(const Type &type) {
 442   return IsVector(type) || IsArray(type);
 443 }
 444
 445 inline bool IsEnum(const Type &type) {
 446   return type.enum_def != nullptr && IsInteger(type.base_type);
 447 }
 448
 449 inline size_t InlineSize(const Type &type) {
 450   return IsStruct(type)
 451              ? type.struct_def->bytesize
 452              : (IsArray(type)
 453                     ? InlineSize(type.VectorType()) * type.fixed_length
 454                     : SizeOf(type.base_type));
 455 }
 456
 457 inline size_t InlineAlignment(const Type &type) {
 458   if (IsStruct(type)) {
 459     return type.struct_def->minalign;
 460   } else if (IsArray(type)) {
 461     return IsStruct(type.VectorType()) ? type.struct_def->minalign
 462                                        : SizeOf(type.element);
 463   } else {
 464     return SizeOf(type.base_type);
 465   }
 466 }
 467 inline bool operator==(const EnumVal &lhs, const EnumVal &rhs) {
 468   return lhs.value == rhs.value;
 469 }
 470 inline bool operator!=(const EnumVal &lhs, const EnumVal &rhs) {
 471   return !(lhs == rhs);
 472 }
 473
 474 inline bool EqualByName(const Type &a, const Type &b) {
 475   return a.base_type == b.base_type && a.element == b.element &&
 476          (a.struct_def == b.struct_def ||
 477           a.struct_def->name == b.struct_def->name) &&
 478          (a.enum_def == b.enum_def || a.enum_def->name == b.enum_def->name);
 479 }
 480
 481 struct RPCCall : public Definition {
 482   Offset<reflection::RPCCall> Serialize(FlatBufferBuilder *builder,
 483                                         const Parser &parser) const;
 484
 485   bool Deserialize(Parser &parser, const reflection::RPCCall *call);
 486
 487   StructDef *request, *response;
 488 };
 489
 490 struct ServiceDef : public Definition {
 491   Offset<reflection::Service> Serialize(FlatBufferBuilder *builder,
 492                                         const Parser &parser) const;
 493   bool Deserialize(Parser &parser, const reflection::Service *service);
 494
 495   SymbolTable<RPCCall> calls;
 496 };
 497
 498 // Container of options that may apply to any of the source/text generators.
 499 struct IDLOptions {
 500   // Use flexbuffers instead for binary and text generation
 501   bool use_flexbuffers;
 502   bool strict_json;
 503   bool skip_js_exports;
 504   bool use_goog_js_export_format;
 505   bool use_ES6_js_export_format;
 506   bool output_default_scalars_in_json;
 507   int indent_step;
 508   bool output_enum_identifiers;
 509   bool prefixed_enums;
 510   bool scoped_enums;
 511   bool include_dependence_headers;
 512   bool mutable_buffer;
 513   bool one_file;
 514   bool proto_mode;
 515   bool proto_oneof_union;
 516   bool generate_all;
 517   bool skip_unexpected_fields_in_json;
 518   bool generate_name_strings;
 519   bool generate_object_based_api;
 520   bool gen_compare;
 521   std::string cpp_object_api_pointer_type;
 522   std::string cpp_object_api_string_type;
 523   bool cpp_object_api_string_flexible_constructor;
 524   bool gen_nullable;
 525   bool java_checkerframework;
 526   bool gen_generated;
 527   std::string object_prefix;
 528   std::string object_suffix;
 529   bool union_value_namespacing;
 530   bool allow_non_utf8;
 531   bool natural_utf8;
 532   std::string include_prefix;
 533   bool keep_include_path;
 534   bool binary_schema_comments;
 535   bool binary_schema_builtins;
 536   bool skip_flatbuffers_import;
 537   std::string go_import;
 538   std::string go_namespace;
 539   bool reexport_ts_modules;
 540   bool js_ts_short_names;
 541   bool protobuf_ascii_alike;
 542   bool size_prefixed;
 543   std::string root_type;
 544   bool force_defaults;
 545   bool java_primitive_has_method;
 546   std::vector<std::string> cpp_includes;
 547
 548   // Possible options for the more general generator below.
 549   enum Language {
 550     kJava = 1 << 0,
 551     kCSharp = 1 << 1,
 552     kGo = 1 << 2,
 553     kCpp = 1 << 3,
 554     kJs = 1 << 4,
 555     kPython = 1 << 5,
 556     kPhp = 1 << 6,
 557     kJson = 1 << 7,
 558     kBinary = 1 << 8,
 559     kTs = 1 << 9,
 560     kJsonSchema = 1 << 10,
 561     kDart = 1 << 11,
 562     kLua = 1 << 12,
 563     kLobster = 1 << 13,
 564     kRust = 1 << 14,
 565     kKotlin = 1 << 15,
 566     kMAX
 567   };
 568
 569   Language lang;
 570
 571   enum MiniReflect { kNone, kTypes, kTypesAndNames };
 572
 573   MiniReflect mini_reflect;
 574
 575   // The corresponding language bit will be set if a language is included
 576   // for code generation.
 577   unsigned long lang_to_generate;
 578
 579   // If set (default behavior), empty string and vector fields will be set to
 580   // nullptr to make the flatbuffer more compact.
 581   bool set_empty_to_null;
 582
 583   IDLOptions()
 584       : use_flexbuffers(false),
 585         strict_json(false),
 586         skip_js_exports(false),
 587         use_goog_js_export_format(false),
 588         use_ES6_js_export_format(false),
 589         output_default_scalars_in_json(false),
 590         indent_step(2),
 591         output_enum_identifiers(true),
 592         prefixed_enums(true),
 593         scoped_enums(false),
 594         include_dependence_headers(true),
 595         mutable_buffer(false),
 596         one_file(false),
 597         proto_mode(false),
 598         proto_oneof_union(false),
 599         generate_all(false),
 600         skip_unexpected_fields_in_json(false),
 601         generate_name_strings(false),
 602         generate_object_based_api(false),
 603         gen_compare(false),
 604         cpp_object_api_pointer_type("std::unique_ptr"),
 605         cpp_object_api_string_flexible_constructor(false),
 606         gen_nullable(false),
 607         java_checkerframework(false),
 608         gen_generated(false),
 609         object_suffix("T"),
 610         union_value_namespacing(true),
 611         allow_non_utf8(false),
 612         natural_utf8(false),
 613         keep_include_path(false),
 614         binary_schema_comments(false),
 615         binary_schema_builtins(false),
 616         skip_flatbuffers_import(false),
 617         reexport_ts_modules(true),
 618         js_ts_short_names(false),
 619         protobuf_ascii_alike(false),
 620         size_prefixed(false),
 621         force_defaults(false),
 622         java_primitive_has_method(false),
 623         lang(IDLOptions::kJava),
 624         mini_reflect(IDLOptions::kNone),
 625         lang_to_generate(0),
 626         set_empty_to_null(true) {}
 627 };
 628
 629 // This encapsulates where the parser is in the current source file.
 630 struct ParserState {
 631   ParserState()
 632       : cursor_(nullptr),
 633         line_start_(nullptr),
 634         line_(0),
 635         token_(-1),
 636         attr_is_trivial_ascii_string_(true) {}
 637
 638  protected:
 639   void ResetState(const char *source) {
 640     cursor_ = source;
 641     line_ = 0;
 642     MarkNewLine();
 643   }
 644
 645   void MarkNewLine() {
 646     line_start_ = cursor_;
 647     line_ += 1;
 648   }
 649
 650   int64_t CursorPosition() const {
 651     FLATBUFFERS_ASSERT(cursor_ && line_start_ && cursor_ >= line_start_);
 652     return static_cast<int64_t>(cursor_ - line_start_);
 653   }
 654
 655   const char *cursor_;
 656   const char *line_start_;
 657   int line_;  // the current line being parsed
 658   int token_;
 659
 660   // Flag: text in attribute_ is true ASCII string without escape
 661   // sequences. Only printable ASCII (without [\t\r\n]).
 662   // Used for number-in-string (and base64 string in future).
 663   bool attr_is_trivial_ascii_string_;
 664   std::string attribute_;
 665   std::vector<std::string> doc_comment_;
 666 };
 667
 668 // A way to make error propagation less error prone by requiring values to be
 669 // checked.
 670 // Once you create a value of this type you must either:
 671 // - Call Check() on it.
 672 // - Copy or assign it to another value.
 673 // Failure to do so leads to an assert.
 674 // This guarantees that this as return value cannot be ignored.
 675 class CheckedError {
 676  public:
 677   explicit CheckedError(bool error)
 678       : is_error_(error), has_been_checked_(false) {}
 679
 680   CheckedError &operator=(const CheckedError &other) {
 681     is_error_ = other.is_error_;
 682     has_been_checked_ = false;
 683     other.has_been_checked_ = true;
 684     return *this;
 685   }
 686
 687   CheckedError(const CheckedError &other) {
 688     *this = other;  // Use assignment operator.
 689   }
 690
 691   ~CheckedError() { FLATBUFFERS_ASSERT(has_been_checked_); }
 692
 693   bool Check() {
 694     has_been_checked_ = true;
 695     return is_error_;
 696   }
 697
 698  private:
 699   bool is_error_;
 700   mutable bool has_been_checked_;
 701 };
 702
 703 // Additionally, in GCC we can get these errors statically, for additional
 704 // assurance:
 705 // clang-format off
 706 #ifdef __GNUC__
 707 #define FLATBUFFERS_CHECKED_ERROR CheckedError \
 708           __attribute__((warn_unused_result))
 709 #else
 710 #define FLATBUFFERS_CHECKED_ERROR CheckedError
 711 #endif
 712 // clang-format on
 713
 714 class Parser : public ParserState {
 715  public:
 716   explicit Parser(const IDLOptions &options = IDLOptions())
 717       : current_namespace_(nullptr),
 718         empty_namespace_(nullptr),
 719         flex_builder_(256, flexbuffers::BUILDER_FLAG_SHARE_ALL),
 720         root_struct_def_(nullptr),
 721         opts(options),
 722         uses_flexbuffers_(false),
 723         source_(nullptr),
 724         anonymous_counter(0),
 725         recurse_protection_counter(0) {
 726     if (opts.force_defaults) { builder_.ForceDefaults(true); }
 727     // Start out with the empty namespace being current.
 728     empty_namespace_ = new Namespace();
 729     namespaces_.push_back(empty_namespace_);
 730     current_namespace_ = empty_namespace_;
 731     known_attributes_["deprecated"] = true;
 732     known_attributes_["required"] = true;
 733     known_attributes_["key"] = true;
 734     known_attributes_["shared"] = true;
 735     known_attributes_["hash"] = true;
 736     known_attributes_["id"] = true;
 737     known_attributes_["force_align"] = true;
 738     known_attributes_["bit_flags"] = true;
 739     known_attributes_["original_order"] = true;
 740     known_attributes_["nested_flatbuffer"] = true;
 741     known_attributes_["csharp_partial"] = true;
 742     known_attributes_["streaming"] = true;
 743     known_attributes_["idempotent"] = true;
 744     known_attributes_["cpp_type"] = true;
 745     known_attributes_["cpp_ptr_type"] = true;
 746     known_attributes_["cpp_ptr_type_get"] = true;
 747     known_attributes_["cpp_str_type"] = true;
 748     known_attributes_["cpp_str_flex_ctor"] = true;
 749     known_attributes_["native_inline"] = true;
 750     known_attributes_["native_custom_alloc"] = true;
 751     known_attributes_["native_type"] = true;
 752     known_attributes_["native_default"] = true;
 753     known_attributes_["flexbuffer"] = true;
 754     known_attributes_["private"] = true;
 755   }
 756
 757   ~Parser() {
 758     for (auto it = namespaces_.begin(); it != namespaces_.end(); ++it) {
 759       delete *it;
 760     }
 761   }
 762
 763   // Parse the string containing either schema or JSON data, which will
 764   // populate the SymbolTable's or the FlatBufferBuilder above.
 765   // include_paths is used to resolve any include statements, and typically
 766   // should at least include the project path (where you loaded source_ from).
 767   // include_paths must be nullptr terminated if specified.
 768   // If include_paths is nullptr, it will attempt to load from the current
 769   // directory.
 770   // If the source was loaded from a file and isn't an include file,
 771   // supply its name in source_filename.
 772   // All paths specified in this call must be in posix format, if you accept
 773   // paths from user input, please call PosixPath on them first.
 774   bool Parse(const char *_source, const char **include_paths = nullptr,
 775              const char *source_filename = nullptr);
 776
 777   // Set the root type. May override the one set in the schema.
 778   bool SetRootType(const char *name);
 779
 780   // Mark all definitions as already having code generated.
 781   void MarkGenerated();
 782
 783   // Get the files recursively included by the given file. The returned
 784   // container will have at least the given file.
 785   std::set<std::string> GetIncludedFilesRecursive(
 786       const std::string &file_name) const;
 787
 788   // Fills builder_ with a binary version of the schema parsed.
 789   // See reflection/reflection.fbs
 790   void Serialize();
 791
 792   // Deserialize a schema buffer
 793   bool Deserialize(const uint8_t *buf, const size_t size);
 794
 795   // Fills internal structure as if the schema passed had been loaded by parsing
 796   // with Parse except that included filenames will not be populated.
 797   bool Deserialize(const reflection::Schema *schema);
 798
 799   Type *DeserializeType(const reflection::Type *type);
 800
 801   // Checks that the schema represented by this parser is a safe evolution
 802   // of the schema provided. Returns non-empty error on any problems.
 803   std::string ConformTo(const Parser &base);
 804
 805   // Similar to Parse(), but now only accepts JSON to be parsed into a
 806   // FlexBuffer.
 807   bool ParseFlexBuffer(const char *source, const char *source_filename,
 808                        flexbuffers::Builder *builder);
 809
 810   StructDef *LookupStruct(const std::string &id) const;
 811
 812   std::string UnqualifiedName(const std::string &fullQualifiedName);
 813
 814   FLATBUFFERS_CHECKED_ERROR Error(const std::string &msg);
 815
 816  private:
 817   void Message(const std::string &msg);
 818   void Warning(const std::string &msg);
 819   FLATBUFFERS_CHECKED_ERROR ParseHexNum(int nibbles, uint64_t *val);
 820   FLATBUFFERS_CHECKED_ERROR Next();
 821   FLATBUFFERS_CHECKED_ERROR SkipByteOrderMark();
 822   bool Is(int t) const;
 823   bool IsIdent(const char *id) const;
 824   FLATBUFFERS_CHECKED_ERROR Expect(int t);
 825   std::string TokenToStringId(int t) const;
 826   EnumDef *LookupEnum(const std::string &id);
 827   FLATBUFFERS_CHECKED_ERROR ParseNamespacing(std::string *id,
 828                                              std::string *last);
 829   FLATBUFFERS_CHECKED_ERROR ParseTypeIdent(Type &type);
 830   FLATBUFFERS_CHECKED_ERROR ParseType(Type &type);
 831   FLATBUFFERS_CHECKED_ERROR AddField(StructDef &struct_def,
 832                                      const std::string &name, const Type &type,
 833                                      FieldDef **dest);
 834   FLATBUFFERS_CHECKED_ERROR ParseField(StructDef &struct_def);
 835   FLATBUFFERS_CHECKED_ERROR ParseString(Value &val);
 836   FLATBUFFERS_CHECKED_ERROR ParseComma();
 837   FLATBUFFERS_CHECKED_ERROR ParseAnyValue(Value &val, FieldDef *field,
 838                                           size_t parent_fieldn,
 839                                           const StructDef *parent_struct_def,
 840                                           uoffset_t count,
 841                                           bool inside_vector = false);
 842   template<typename F>
 843   FLATBUFFERS_CHECKED_ERROR ParseTableDelimiters(size_t &fieldn,
 844                                                  const StructDef *struct_def,
 845                                                  F body);
 846   FLATBUFFERS_CHECKED_ERROR ParseTable(const StructDef &struct_def,
 847                                        std::string *value, uoffset_t *ovalue);
 848   void SerializeStruct(const StructDef &struct_def, const Value &val);
 849   void SerializeStruct(FlatBufferBuilder &builder, const StructDef &struct_def,
 850                        const Value &val);
 851   template<typename F>
 852   FLATBUFFERS_CHECKED_ERROR ParseVectorDelimiters(uoffset_t &count, F body);
 853   FLATBUFFERS_CHECKED_ERROR ParseVector(const Type &type, uoffset_t *ovalue,
 854                                         FieldDef *field, size_t fieldn);
 855   FLATBUFFERS_CHECKED_ERROR ParseArray(Value &array);
 856   FLATBUFFERS_CHECKED_ERROR ParseNestedFlatbuffer(
 857       Value &val, FieldDef *field, size_t fieldn,
 858       const StructDef *parent_struct_def);
 859   FLATBUFFERS_CHECKED_ERROR ParseMetaData(SymbolTable<Value> *attributes);
 860   FLATBUFFERS_CHECKED_ERROR TryTypedValue(const std::string *name, int dtoken,
 861                                           bool check, Value &e, BaseType req,
 862                                           bool *destmatch);
 863   FLATBUFFERS_CHECKED_ERROR ParseHash(Value &e, FieldDef *field);
 864   FLATBUFFERS_CHECKED_ERROR TokenError();
 865   FLATBUFFERS_CHECKED_ERROR ParseSingleValue(const std::string *name, Value &e,
 866                                              bool check_now);
 867   FLATBUFFERS_CHECKED_ERROR ParseEnumFromString(const Type &type,
 868                                                 std::string *result);
 869   StructDef *LookupCreateStruct(const std::string &name,
 870                                 bool create_if_new = true,
 871                                 bool definition = false);
 872   FLATBUFFERS_CHECKED_ERROR ParseEnum(bool is_union, EnumDef **dest);
 873   FLATBUFFERS_CHECKED_ERROR ParseNamespace();
 874   FLATBUFFERS_CHECKED_ERROR StartStruct(const std::string &name,
 875                                         StructDef **dest);
 876   FLATBUFFERS_CHECKED_ERROR StartEnum(const std::string &name, bool is_union,
 877                                       EnumDef **dest);
 878   FLATBUFFERS_CHECKED_ERROR ParseDecl();
 879   FLATBUFFERS_CHECKED_ERROR ParseService();
 880   FLATBUFFERS_CHECKED_ERROR ParseProtoFields(StructDef *struct_def,
 881                                              bool isextend, bool inside_oneof);
 882   FLATBUFFERS_CHECKED_ERROR ParseProtoOption();
 883   FLATBUFFERS_CHECKED_ERROR ParseProtoKey();
 884   FLATBUFFERS_CHECKED_ERROR ParseProtoDecl();
 885   FLATBUFFERS_CHECKED_ERROR ParseProtoCurliesOrIdent();
 886   FLATBUFFERS_CHECKED_ERROR ParseTypeFromProtoType(Type *type);
 887   FLATBUFFERS_CHECKED_ERROR SkipAnyJsonValue();
 888   FLATBUFFERS_CHECKED_ERROR ParseFlexBufferValue(flexbuffers::Builder *builder);
 889   FLATBUFFERS_CHECKED_ERROR StartParseFile(const char *source,
 890                                            const char *source_filename);
 891   FLATBUFFERS_CHECKED_ERROR ParseRoot(const char *_source,
 892                                       const char **include_paths,
 893                                       const char *source_filename);
 894   FLATBUFFERS_CHECKED_ERROR DoParse(const char *_source,
 895                                     const char **include_paths,
 896                                     const char *source_filename,
 897                                     const char *include_filename);
 898   FLATBUFFERS_CHECKED_ERROR CheckClash(std::vector<FieldDef *> &fields,
 899                                        StructDef *struct_def,
 900                                        const char *suffix, BaseType baseType);
 901
 902   bool SupportsAdvancedUnionFeatures() const;
 903   bool SupportsAdvancedArrayFeatures() const;
 904   Namespace *UniqueNamespace(Namespace *ns);
 905
 906   FLATBUFFERS_CHECKED_ERROR RecurseError();
 907   template<typename F> CheckedError Recurse(F f);
 908
 909  public:
 910   SymbolTable<Type> types_;
 911   SymbolTable<StructDef> structs_;
 912   SymbolTable<EnumDef> enums_;
 913   SymbolTable<ServiceDef> services_;
 914   std::vector<Namespace *> namespaces_;
 915   Namespace *current_namespace_;
 916   Namespace *empty_namespace_;
 917   std::string error_;  // User readable error_ if Parse() == false
 918
 919   FlatBufferBuilder builder_;  // any data contained in the file
 920   flexbuffers::Builder flex_builder_;
 921   flexbuffers::Reference flex_root_;
 922   StructDef *root_struct_def_;
 923   std::string file_identifier_;
 924   std::string file_extension_;
 925
 926   std::map<std::string, std::string> included_files_;
 927   std::map<std::string, std::set<std::string>> files_included_per_file_;
 928   std::vector<std::string> native_included_files_;
 929
 930   std::map<std::string, bool> known_attributes_;
 931
 932   IDLOptions opts;
 933   bool uses_flexbuffers_;
 934
 935  private:
 936   const char *source_;
 937
 938   std::string file_being_parsed_;
 939
 940   std::vector<std::pair<Value, FieldDef *>> field_stack_;
 941
 942   int anonymous_counter;
 943   int recurse_protection_counter;
 944 };
 945
 946 // Utility functions for multiple generators:
 947
 948 extern std::string MakeCamel(const std::string &in, bool first = true);
 949
 950 extern std::string MakeScreamingCamel(const std::string &in);
 951
 952 // Generate text (JSON) from a given FlatBuffer, and a given Parser
 953 // object that has been populated with the corresponding schema.
 954 // If ident_step is 0, no indentation will be generated. Additionally,
 955 // if it is less than 0, no linefeeds will be generated either.
 956 // See idl_gen_text.cpp.
 957 // strict_json adds "quotes" around field names if true.
 958 // If the flatbuffer cannot be encoded in JSON (e.g., it contains non-UTF-8
 959 // byte arrays in String values), returns false.
 960 extern bool GenerateTextFromTable(const Parser &parser, const void *table,
 961                                   const std::string &tablename,
 962                                   std::string *text);
 963 extern bool GenerateText(const Parser &parser, const void *flatbuffer,
 964                          std::string *text);
 965 extern bool GenerateTextFile(const Parser &parser, const std::string &path,
 966                              const std::string &file_name);
 967
 968 // Generate binary files from a given FlatBuffer, and a given Parser
 969 // object that has been populated with the corresponding schema.
 970 // See idl_gen_general.cpp.
 971 extern bool GenerateBinary(const Parser &parser, const std::string &path,
 972                            const std::string &file_name);
 973
 974 // Generate a C++ header from the definitions in the Parser object.
 975 // See idl_gen_cpp.
 976 extern bool GenerateCPP(const Parser &parser, const std::string &path,
 977                         const std::string &file_name);
 978
 979 extern bool GenerateDart(const Parser &parser, const std::string &path,
 980                          const std::string &file_name);
 981
 982 // Generate JavaScript or TypeScript code from the definitions in the Parser
 983 // object. See idl_gen_js.
 984 extern bool GenerateJSTS(const Parser &parser, const std::string &path,
 985                          const std::string &file_name);
 986
 987 // Generate Go files from the definitions in the Parser object.
 988 // See idl_gen_go.cpp.
 989 extern bool GenerateGo(const Parser &parser, const std::string &path,
 990                        const std::string &file_name);
 991
 992 // Generate Php code from the definitions in the Parser object.
 993 // See idl_gen_php.
 994 extern bool GeneratePhp(const Parser &parser, const std::string &path,
 995                         const std::string &file_name);
 996
 997 // Generate Python files from the definitions in the Parser object.
 998 // See idl_gen_python.cpp.
 999 extern bool GeneratePython(const Parser &parser, const std::string &path,
1000                            const std::string &file_name);
1001
1002 // Generate Lobster files from the definitions in the Parser object.
1003 // See idl_gen_lobster.cpp.
1004 extern bool GenerateLobster(const Parser &parser, const std::string &path,
1005                             const std::string &file_name);
1006
1007 // Generate Lua files from the definitions in the Parser object.
1008 // See idl_gen_lua.cpp.
1009 extern bool GenerateLua(const Parser &parser, const std::string &path,
1010                         const std::string &file_name);
1011
1012 // Generate Rust files from the definitions in the Parser object.
1013 // See idl_gen_rust.cpp.
1014 extern bool GenerateRust(const Parser &parser, const std::string &path,
1015                          const std::string &file_name);
1016
1017 // Generate Json schema file
1018 // See idl_gen_json_schema.cpp.
1019 extern bool GenerateJsonSchema(const Parser &parser, const std::string &path,
1020                                const std::string &file_name);
1021
1022 extern bool GenerateKotlin(const Parser &parser, const std::string &path,
1023                            const std::string &file_name);
1024
1025 // Generate Java/C#/.. files from the definitions in the Parser object.
1026 // See idl_gen_general.cpp.
1027 extern bool GenerateGeneral(const Parser &parser, const std::string &path,
1028                             const std::string &file_name);
1029
1030 // Generate a schema file from the internal representation, useful after
1031 // parsing a .proto schema.
1032 extern std::string GenerateFBS(const Parser &parser,
1033                                const std::string &file_name);
1034 extern bool GenerateFBS(const Parser &parser, const std::string &path,
1035                         const std::string &file_name);
1036
1037 // Generate a make rule for the generated JavaScript or TypeScript code.
1038 // See idl_gen_js.cpp.
1039 extern std::string JSTSMakeRule(const Parser &parser, const std::string &path,
1040                                 const std::string &file_name);
1041
1042 // Generate a make rule for the generated C++ header.
1043 // See idl_gen_cpp.cpp.
1044 extern std::string CPPMakeRule(const Parser &parser, const std::string &path,
1045                                const std::string &file_name);
1046
1047 // Generate a make rule for the generated Dart code
1048 // see idl_gen_dart.cpp
1049 extern std::string DartMakeRule(const Parser &parser, const std::string &path,
1050                                 const std::string &file_name);
1051
1052 // Generate a make rule for the generated Rust code.
1053 // See idl_gen_rust.cpp.
1054 extern std::string RustMakeRule(const Parser &parser, const std::string &path,
1055                                 const std::string &file_name);
1056
1057 // Generate a make rule for the generated Java/C#/... files.
1058 // See idl_gen_general.cpp.
1059 extern std::string GeneralMakeRule(const Parser &parser,
1060                                    const std::string &path,
1061                                    const std::string &file_name);
1062
1063 // Generate a make rule for the generated text (JSON) files.
1064 // See idl_gen_text.cpp.
1065 extern std::string TextMakeRule(const Parser &parser, const std::string &path,
1066                                 const std::string &file_names);
1067
1068 // Generate a make rule for the generated binary files.
1069 // See idl_gen_general.cpp.
1070 extern std::string BinaryMakeRule(const Parser &parser, const std::string &path,
1071                                   const std::string &file_name);
1072
1073 // Generate GRPC Cpp interfaces.
1074 // See idl_gen_grpc.cpp.
1075 bool GenerateCppGRPC(const Parser &parser, const std::string &path,
1076                      const std::string &file_name);
1077
1078 // Generate GRPC Go interfaces.
1079 // See idl_gen_grpc.cpp.
1080 bool GenerateGoGRPC(const Parser &parser, const std::string &path,
1081                     const std::string &file_name);
1082
1083 // Generate GRPC Java classes.
1084 // See idl_gen_grpc.cpp
1085 bool GenerateJavaGRPC(const Parser &parser, const std::string &path,
1086                       const std::string &file_name);
1087
1088 }  // namespace flatbuffers
1089
1090 #endif  // FLATBUFFERS_IDL_H_