| /* |
| * Copyright 2018 Dan Field |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| // independent from idl_parser, since this code is not needed for most clients |
| #include <cassert> |
| |
| #include "flatbuffers/code_generators.h" |
| #include "flatbuffers/flatbuffers.h" |
| #include "flatbuffers/idl.h" |
| #include "flatbuffers/util.h" |
| |
| namespace flatbuffers { |
| |
| namespace dart { |
| |
| const std::string _kFb = "fb"; |
| // see https://www.dartlang.org/guides/language/language-tour#keywords |
| // yeild*, async*, and sync* shouldn't be problems anyway but keeping them in |
| static const char *keywords[] = { |
| "abstract", "deferred", "if", "super", "as", "do", |
| "implements", "switch", "assert", "dynamic", "import", "sync*", |
| "async", "else", "in", "this", "async*", "enum", |
| "is", "throw", "await", "export", "library", "true", |
| "break", "external", "new", "try", "case", "extends", |
| "null", "typedef", "catch", "factory", "operator", "var", |
| "class", "false", "part", "void", "const", "final", |
| "rethrow", "while", "continue", "finally", "return", "with", |
| "covariant", "for", "set", "yield", "default", "get", |
| "static", "yield*" |
| }; |
| |
| // Iterate through all definitions we haven't generate code for (enums, structs, |
| // and tables) and output them to a single file. |
| class DartGenerator : public BaseGenerator { |
| public: |
| typedef std::map<std::string, std::string> namespace_code_map; |
| |
| DartGenerator(const Parser &parser, const std::string &path, |
| const std::string &file_name) |
| : BaseGenerator(parser, path, file_name, "", ".", "dart") {} |
| // Iterate through all definitions we haven't generate code for (enums, |
| // structs, and tables) and output them to a single file. |
| bool generate() { |
| std::string code; |
| namespace_code_map namespace_code; |
| GenerateEnums(&namespace_code); |
| GenerateStructs(&namespace_code); |
| |
| for (auto kv = namespace_code.begin(); kv != namespace_code.end(); ++kv) { |
| code.clear(); |
| code = code + "// " + FlatBuffersGeneratedWarning() + "\n"; |
| code = code + |
| "// ignore_for_file: unused_import, unused_field, unused_element, " |
| "unused_local_variable\n\n"; |
| |
| if (!kv->first.empty()) { code += "library " + kv->first + ";\n\n"; } |
| |
| code += "import 'dart:typed_data' show Uint8List;\n"; |
| code += "import 'package:flat_buffers/flat_buffers.dart' as " + _kFb + |
| ";\n\n"; |
| |
| for (auto kv2 = namespace_code.begin(); kv2 != namespace_code.end(); |
| ++kv2) { |
| if (kv2->first != kv->first) { |
| code += |
| "import '" + |
| GeneratedFileName( |
| "./", |
| file_name_ + (!kv2->first.empty() ? "_" + kv2->first : ""), |
| parser_.opts) + |
| "' as " + ImportAliasName(kv2->first) + ";\n"; |
| } |
| } |
| code += "\n"; |
| code += kv->second; |
| |
| if (!SaveFile( |
| GeneratedFileName( |
| path_, |
| file_name_ + (!kv->first.empty() ? "_" + kv->first : ""), |
| parser_.opts) |
| .c_str(), |
| code, false)) { |
| return false; |
| } |
| } |
| return true; |
| } |
| |
| private: |
| static std::string ImportAliasName(const std::string &ns) { |
| std::string ret; |
| ret.assign(ns); |
| size_t pos = ret.find('.'); |
| while (pos != std::string::npos) { |
| ret.replace(pos, 1, "_"); |
| pos = ret.find('.', pos + 1); |
| } |
| |
| return ret; |
| } |
| |
| static std::string BuildNamespaceName(const Namespace &ns) { |
| if (ns.components.empty()) { return ""; } |
| std::stringstream sstream; |
| std::copy(ns.components.begin(), ns.components.end() - 1, |
| std::ostream_iterator<std::string>(sstream, ".")); |
| |
| auto ret = sstream.str() + ns.components.back(); |
| for (size_t i = 0; i < ret.size(); i++) { |
| auto lower = CharToLower(ret[i]); |
| if (lower != ret[i]) { |
| ret[i] = lower; |
| if (i != 0 && ret[i - 1] != '.') { |
| ret.insert(i, "_"); |
| i++; |
| } |
| } |
| } |
| // std::transform(ret.begin(), ret.end(), ret.begin(), CharToLower); |
| return ret; |
| } |
| |
| void GenIncludeDependencies(std::string *code, |
| const std::string &the_namespace) { |
| for (auto it = parser_.included_files_.begin(); |
| it != parser_.included_files_.end(); ++it) { |
| if (it->second.empty()) continue; |
| |
| auto noext = flatbuffers::StripExtension(it->second); |
| auto basename = flatbuffers::StripPath(noext); |
| |
| *code += |
| "import '" + |
| GeneratedFileName( |
| "", basename + (the_namespace == "" ? "" : "_" + the_namespace), |
| parser_.opts) + |
| "';\n"; |
| } |
| } |
| |
| static std::string EscapeKeyword(const std::string &name) { |
| for (size_t i = 0; i < sizeof(keywords) / sizeof(keywords[0]); i++) { |
| if (name == keywords[i]) { |
| return ConvertCase(name + "_", Case::kLowerCamel); |
| } |
| } |
| |
| return ConvertCase(name, Case::kLowerCamel); |
| } |
| |
| void GenerateEnums(namespace_code_map *namespace_code) { |
| for (auto it = parser_.enums_.vec.begin(); it != parser_.enums_.vec.end(); |
| ++it) { |
| auto &enum_def = **it; |
| GenEnum(enum_def, namespace_code); // enum_code_ptr); |
| } |
| } |
| |
| void GenerateStructs(namespace_code_map *namespace_code) { |
| for (auto it = parser_.structs_.vec.begin(); |
| it != parser_.structs_.vec.end(); ++it) { |
| auto &struct_def = **it; |
| GenStruct(struct_def, namespace_code); |
| } |
| } |
| |
| // Generate a documentation comment, if available. |
| static void GenDocComment(const std::vector<std::string> &dc, |
| std::string *code_ptr, |
| const std::string &extra_lines, |
| const char *indent = nullptr) { |
| if (dc.empty() && extra_lines.empty()) { |
| // Don't output empty comment blocks with 0 lines of comment content. |
| return; |
| } |
| |
| auto &code = *code_ptr; |
| |
| for (auto it = dc.begin(); it != dc.end(); ++it) { |
| if (indent) code += indent; |
| code += "/// " + *it + "\n"; |
| } |
| if (!extra_lines.empty()) { |
| if (!dc.empty()) { |
| if (indent) code += indent; |
| code += "///\n"; |
| } |
| if (indent) code += indent; |
| std::string::size_type start = 0; |
| for (;;) { |
| auto end = extra_lines.find('\n', start); |
| if (end != std::string::npos) { |
| code += "/// " + extra_lines.substr(start, end - start) + "\n"; |
| start = end + 1; |
| } else { |
| code += "/// " + extra_lines.substr(start) + "\n"; |
| break; |
| } |
| } |
| } |
| } |
| |
| static void GenDocComment(std::string *code_ptr, |
| const std::string &extra_lines) { |
| GenDocComment(std::vector<std::string>(), code_ptr, extra_lines); |
| } |
| |
| // Generate an enum declaration and an enum string lookup table. |
| void GenEnum(EnumDef &enum_def, namespace_code_map *namespace_code) { |
| if (enum_def.generated) return; |
| auto ns = BuildNamespaceName(*enum_def.defined_namespace); |
| std::string code; |
| GenDocComment(enum_def.doc_comment, &code, ""); |
| |
| auto name = enum_def.is_union ? enum_def.name + "TypeId" : enum_def.name; |
| const bool is_bit_flags = |
| enum_def.attributes.Lookup("bit_flags") != nullptr; |
| // The flatbuffer schema language allows bit flag enums to potentially have |
| // a default value of zero, even if it's not a valid enum value... |
| const bool permit_zero = is_bit_flags; |
| |
| code += "class " + name + " {\n"; |
| code += " final int value;\n"; |
| code += " const " + name + "._(this.value);\n\n"; |
| code += " factory " + name + ".fromValue(int value) {\n"; |
| code += " final result = values[value];\n"; |
| code += " if (result == null) {\n"; |
| if (permit_zero) { |
| code += " if (value == 0) {\n"; |
| code += " return " + name + "._(0);\n"; |
| code += " } else {\n"; |
| } |
| code += " throw StateError('Invalid value $value for bit flag enum "; |
| code += name + "');\n"; |
| if (permit_zero) { code += " }\n"; } |
| code += " }\n"; |
| |
| code += " return result;\n"; |
| code += " }\n\n"; |
| |
| code += " static " + name + "? _createOrNull(int? value) => \n"; |
| code += " value == null ? null : " + name + ".fromValue(value);\n\n"; |
| |
| // this is meaningless for bit_flags |
| // however, note that unlike "regular" dart enums this enum can still have |
| // holes. |
| if (!is_bit_flags) { |
| code += " static const int minValue = " + |
| enum_def.ToString(*enum_def.MinValue()) + ";\n"; |
| code += " static const int maxValue = " + |
| enum_def.ToString(*enum_def.MaxValue()) + ";\n"; |
| } |
| |
| code += |
| " static bool containsValue(int value) =>" |
| " values.containsKey(value);\n\n"; |
| |
| for (auto it = enum_def.Vals().begin(); it != enum_def.Vals().end(); ++it) { |
| auto &ev = **it; |
| |
| if (!ev.doc_comment.empty()) { |
| if (it != enum_def.Vals().begin()) { code += '\n'; } |
| GenDocComment(ev.doc_comment, &code, "", " "); |
| } |
| code += " static const " + name + " " + ev.name + " = " + name + "._(" + |
| enum_def.ToString(ev) + ");\n"; |
| } |
| |
| code += " static const Map<int, " + name + "> values = {\n"; |
| for (auto it = enum_def.Vals().begin(); it != enum_def.Vals().end(); ++it) { |
| auto &ev = **it; |
| if (it != enum_def.Vals().begin()) code += ",\n"; |
| code += " " + enum_def.ToString(ev) + ": " + ev.name; |
| } |
| code += "};\n\n"; |
| |
| code += " static const " + _kFb + ".Reader<" + name + "> reader = _" + |
| name + "Reader();\n\n"; |
| code += " @override\n"; |
| code += " String toString() {\n"; |
| code += " return '" + name + "{value: $value}';\n"; |
| code += " }\n"; |
| code += "}\n\n"; |
| |
| GenEnumReader(enum_def, name, &code); |
| (*namespace_code)[ns] += code; |
| } |
| |
| void GenEnumReader(EnumDef &enum_def, const std::string &name, |
| std::string *code_ptr) { |
| auto &code = *code_ptr; |
| |
| code += "class _" + name + "Reader extends " + _kFb + ".Reader<" + name + |
| "> {\n"; |
| code += " const _" + name + "Reader();\n\n"; |
| code += " @override\n"; |
| code += " int get size => 1;\n\n"; |
| code += " @override\n"; |
| code += |
| " " + name + " read(" + _kFb + ".BufferContext bc, int offset) =>\n"; |
| code += " " + name + ".fromValue(const " + _kFb + "." + |
| GenType(enum_def.underlying_type) + "Reader().read(bc, offset));\n"; |
| code += "}\n\n"; |
| } |
| |
| static std::string GenType(const Type &type) { |
| switch (type.base_type) { |
| case BASE_TYPE_BOOL: return "Bool"; |
| case BASE_TYPE_CHAR: return "Int8"; |
| case BASE_TYPE_UTYPE: |
| case BASE_TYPE_UCHAR: return "Uint8"; |
| case BASE_TYPE_SHORT: return "Int16"; |
| case BASE_TYPE_USHORT: return "Uint16"; |
| case BASE_TYPE_INT: return "Int32"; |
| case BASE_TYPE_UINT: return "Uint32"; |
| case BASE_TYPE_LONG: return "Int64"; |
| case BASE_TYPE_ULONG: return "Uint64"; |
| case BASE_TYPE_FLOAT: return "Float32"; |
| case BASE_TYPE_DOUBLE: return "Float64"; |
| case BASE_TYPE_STRING: return "String"; |
| case BASE_TYPE_VECTOR: return GenType(type.VectorType()); |
| case BASE_TYPE_STRUCT: return type.struct_def->name; |
| case BASE_TYPE_UNION: return type.enum_def->name + "TypeId"; |
| default: return "Table"; |
| } |
| } |
| |
| std::string GenReaderTypeName(const Type &type, Namespace *current_namespace, |
| const FieldDef &def, |
| bool parent_is_vector = false, bool lazy = true, |
| bool constConstruct = true) { |
| std::string prefix = (constConstruct ? "const " : "") + _kFb; |
| if (type.base_type == BASE_TYPE_BOOL) { |
| return prefix + ".BoolReader()"; |
| } else if (IsVector(type)) { |
| if (!type.VectorType().enum_def) { |
| if (type.VectorType().base_type == BASE_TYPE_CHAR) { |
| return prefix + ".Int8ListReader(" + (lazy ? ")" : "lazy: false)"); |
| } |
| if (type.VectorType().base_type == BASE_TYPE_UCHAR) { |
| return prefix + ".Uint8ListReader(" + (lazy ? ")" : "lazy: false)"); |
| } |
| } |
| return prefix + ".ListReader<" + |
| GenDartTypeName(type.VectorType(), current_namespace, def) + ">(" + |
| GenReaderTypeName(type.VectorType(), current_namespace, def, true, |
| true, false) + |
| (lazy ? ")" : ", lazy: false)"); |
| } else if (IsString(type)) { |
| return prefix + ".StringReader()"; |
| } |
| if (IsScalar(type.base_type)) { |
| if (type.enum_def && parent_is_vector) { |
| return GenDartTypeName(type, current_namespace, def) + ".reader"; |
| } |
| return prefix + "." + GenType(type) + "Reader()"; |
| } else { |
| return GenDartTypeName(type, current_namespace, def) + ".reader"; |
| } |
| } |
| |
| std::string GenDartTypeName(const Type &type, Namespace *current_namespace, |
| const FieldDef &def, |
| std::string struct_type_suffix = "") { |
| if (type.enum_def) { |
| if (type.enum_def->is_union && type.base_type != BASE_TYPE_UNION) { |
| return type.enum_def->name + "TypeId"; |
| } else if (type.enum_def->is_union) { |
| return "dynamic"; |
| } else if (type.base_type != BASE_TYPE_VECTOR) { |
| return type.enum_def->name; |
| } |
| } |
| |
| switch (type.base_type) { |
| case BASE_TYPE_BOOL: return "bool"; |
| case BASE_TYPE_LONG: |
| case BASE_TYPE_ULONG: |
| case BASE_TYPE_INT: |
| case BASE_TYPE_UINT: |
| case BASE_TYPE_SHORT: |
| case BASE_TYPE_USHORT: |
| case BASE_TYPE_CHAR: |
| case BASE_TYPE_UCHAR: return "int"; |
| case BASE_TYPE_FLOAT: |
| case BASE_TYPE_DOUBLE: return "double"; |
| case BASE_TYPE_STRING: return "String"; |
| case BASE_TYPE_STRUCT: |
| return MaybeWrapNamespace(type.struct_def->name + struct_type_suffix, |
| current_namespace, def); |
| case BASE_TYPE_VECTOR: |
| return "List<" + |
| GenDartTypeName(type.VectorType(), current_namespace, def, |
| struct_type_suffix) + |
| ">"; |
| default: assert(0); return "dynamic"; |
| } |
| } |
| |
| std::string GenDartTypeName(const Type &type, Namespace *current_namespace, |
| const FieldDef &def, bool nullable, |
| std::string struct_type_suffix) { |
| std::string typeName = |
| GenDartTypeName(type, current_namespace, def, struct_type_suffix); |
| if (nullable && typeName != "dynamic") typeName += "?"; |
| return typeName; |
| } |
| |
| static const std::string MaybeWrapNamespace(const std::string &type_name, |
| Namespace *current_ns, |
| const FieldDef &field) { |
| auto curr_ns_str = BuildNamespaceName(*current_ns); |
| std::string field_ns_str = ""; |
| if (field.value.type.struct_def) { |
| field_ns_str += |
| BuildNamespaceName(*field.value.type.struct_def->defined_namespace); |
| } else if (field.value.type.enum_def) { |
| field_ns_str += |
| BuildNamespaceName(*field.value.type.enum_def->defined_namespace); |
| } |
| |
| if (field_ns_str != "" && field_ns_str != curr_ns_str) { |
| return ImportAliasName(field_ns_str) + "." + type_name; |
| } else { |
| return type_name; |
| } |
| } |
| |
| // Generate an accessor struct with constructor for a flatbuffers struct. |
| void GenStruct(const StructDef &struct_def, |
| namespace_code_map *namespace_code) { |
| if (struct_def.generated) return; |
| |
| auto object_namespace = BuildNamespaceName(*struct_def.defined_namespace); |
| std::string code; |
| |
| const auto &object_name = struct_def.name; |
| |
| // Emit constructor |
| |
| GenDocComment(struct_def.doc_comment, &code, ""); |
| |
| auto reader_name = "_" + object_name + "Reader"; |
| auto builder_name = object_name + "Builder"; |
| auto object_builder_name = object_name + "ObjectBuilder"; |
| |
| std::string reader_code, builder_code; |
| |
| code += "class " + object_name + " {\n"; |
| |
| code += " " + object_name + "._(this._bc, this._bcOffset);\n"; |
| if (!struct_def.fixed) { |
| code += " factory " + object_name + "(List<int> bytes) {\n"; |
| code += |
| " final rootRef = " + _kFb + ".BufferContext.fromBytes(bytes);\n"; |
| code += " return reader.read(rootRef, 0);\n"; |
| code += " }\n"; |
| } |
| |
| code += "\n"; |
| code += " static const " + _kFb + ".Reader<" + object_name + |
| "> reader = " + reader_name + "();\n\n"; |
| |
| code += " final " + _kFb + ".BufferContext _bc;\n"; |
| code += " final int _bcOffset;\n\n"; |
| |
| std::vector<std::pair<int, FieldDef *>> non_deprecated_fields; |
| for (auto it = struct_def.fields.vec.begin(); |
| it != struct_def.fields.vec.end(); ++it) { |
| auto &field = **it; |
| if (field.deprecated) continue; |
| auto offset = static_cast<int>(it - struct_def.fields.vec.begin()); |
| non_deprecated_fields.push_back(std::make_pair(offset, &field)); |
| } |
| |
| GenImplementationGetters(struct_def, non_deprecated_fields, &code); |
| |
| if (parser_.opts.generate_object_based_api) { |
| code += |
| "\n" + GenStructObjectAPIUnpack(struct_def, non_deprecated_fields); |
| |
| code += "\n static int pack(fb.Builder fbBuilder, " + struct_def.name + |
| "T? object) {\n"; |
| code += " if (object == null) return 0;\n"; |
| code += " return object.pack(fbBuilder);\n"; |
| code += " }\n"; |
| } |
| |
| code += "}\n\n"; |
| |
| if (parser_.opts.generate_object_based_api) { |
| code += GenStructObjectAPI(struct_def, non_deprecated_fields); |
| } |
| |
| GenReader(struct_def, &reader_name, &reader_code); |
| GenBuilder(struct_def, non_deprecated_fields, &builder_name, &builder_code); |
| GenObjectBuilder(struct_def, non_deprecated_fields, &object_builder_name, |
| &builder_code); |
| |
| code += reader_code; |
| code += builder_code; |
| |
| (*namespace_code)[object_namespace] += code; |
| } |
| |
| // Generate an accessor struct with constructor for a flatbuffers struct. |
| std::string GenStructObjectAPI( |
| const StructDef &struct_def, |
| const std::vector<std::pair<int, FieldDef *>> &non_deprecated_fields) { |
| std::string code; |
| GenDocComment(struct_def.doc_comment, &code, ""); |
| |
| std::string class_name = struct_def.name + "T"; |
| code += "class " + class_name + " implements " + _kFb + ".Packable {\n"; |
| |
| std::string constructor_args; |
| for (auto it = non_deprecated_fields.begin(); |
| it != non_deprecated_fields.end(); ++it) { |
| const FieldDef &field = *it->second; |
| |
| std::string field_name = ConvertCase(field.name, Case::kLowerCamel); |
| std::string defaultValue = getDefaultValue(field.value); |
| std::string type_name = |
| GenDartTypeName(field.value.type, struct_def.defined_namespace, field, |
| defaultValue.empty() && !struct_def.fixed, "T"); |
| |
| GenDocComment(field.doc_comment, &code, "", " "); |
| code += " " + type_name + " " + field_name + ";\n"; |
| |
| if (!constructor_args.empty()) constructor_args += ",\n"; |
| constructor_args += " "; |
| constructor_args += (struct_def.fixed ? "required " : ""); |
| constructor_args += "this." + field_name; |
| if (!struct_def.fixed && !defaultValue.empty()) { |
| if (IsEnum(field.value.type)) { |
| auto &enum_def = *field.value.type.enum_def; |
| if (auto val = enum_def.FindByValue(defaultValue)) { |
| constructor_args += " = " + enum_def.name + "." + val->name; |
| } else { |
| constructor_args += |
| " = const " + enum_def.name + "._(" + defaultValue + ")"; |
| } |
| } else { |
| constructor_args += " = " + defaultValue; |
| } |
| } |
| } |
| |
| if (!constructor_args.empty()) { |
| code += "\n " + class_name + "({\n" + constructor_args + "});\n\n"; |
| } |
| |
| code += GenStructObjectAPIPack(struct_def, non_deprecated_fields); |
| code += "\n"; |
| code += GenToString(class_name, non_deprecated_fields); |
| |
| code += "}\n\n"; |
| return code; |
| } |
| |
| // Generate function `StructNameT unpack()` |
| std::string GenStructObjectAPIUnpack( |
| const StructDef &struct_def, |
| const std::vector<std::pair<int, FieldDef *>> &non_deprecated_fields) { |
| std::string constructor_args; |
| for (auto it = non_deprecated_fields.begin(); |
| it != non_deprecated_fields.end(); ++it) { |
| const FieldDef &field = *it->second; |
| |
| std::string field_name = ConvertCase(field.name, Case::kLowerCamel); |
| if (!constructor_args.empty()) constructor_args += ",\n"; |
| constructor_args += " " + field_name + ": "; |
| |
| const Type &type = field.value.type; |
| std::string defaultValue = getDefaultValue(field.value); |
| bool isNullable = defaultValue.empty() && !struct_def.fixed; |
| std::string nullableValueAccessOperator = isNullable ? "?" : ""; |
| if (type.base_type == BASE_TYPE_STRUCT) { |
| constructor_args += |
| field_name + nullableValueAccessOperator + ".unpack()"; |
| } else if (type.base_type == BASE_TYPE_VECTOR) { |
| if (type.VectorType().base_type == BASE_TYPE_STRUCT) { |
| constructor_args += field_name + nullableValueAccessOperator + |
| ".map((e) => e.unpack()).toList()"; |
| } else { |
| constructor_args += |
| GenReaderTypeName(field.value.type, struct_def.defined_namespace, |
| field, false, false); |
| constructor_args += ".vTableGet"; |
| std::string offset = NumToString(field.value.offset); |
| constructor_args += |
| isNullable |
| ? "Nullable(_bc, _bcOffset, " + offset + ")" |
| : "(_bc, _bcOffset, " + offset + ", " + defaultValue + ")"; |
| } |
| } else { |
| constructor_args += field_name; |
| } |
| } |
| |
| std::string class_name = struct_def.name + "T"; |
| std::string code = " " + class_name + " unpack() => " + class_name + "("; |
| if (!constructor_args.empty()) code += "\n" + constructor_args; |
| code += ");\n"; |
| return code; |
| } |
| |
| // Generate function `StructNameT pack()` |
| std::string GenStructObjectAPIPack( |
| const StructDef &struct_def, |
| const std::vector<std::pair<int, FieldDef *>> &non_deprecated_fields) { |
| std::string code; |
| |
| code += " @override\n"; |
| code += " int pack(fb.Builder fbBuilder) {\n"; |
| code += GenObjectBuilderImplementation(struct_def, non_deprecated_fields, |
| false, true); |
| code += " }\n"; |
| return code; |
| } |
| |
| std::string NamespaceAliasFromUnionType(Namespace *root_namespace, |
| const Type &type) { |
| const std::vector<std::string> qualified_name_parts = |
| type.struct_def->defined_namespace->components; |
| if (std::equal(root_namespace->components.begin(), |
| root_namespace->components.end(), |
| qualified_name_parts.begin())) { |
| return type.struct_def->name; |
| } |
| |
| std::string ns; |
| |
| for (auto it = qualified_name_parts.begin(); |
| it != qualified_name_parts.end(); ++it) { |
| auto &part = *it; |
| |
| for (size_t i = 0; i < part.length(); i++) { |
| if (i && !isdigit(part[i]) && part[i] == CharToUpper(part[i])) { |
| ns += "_"; |
| ns += CharToLower(part[i]); |
| } else { |
| ns += CharToLower(part[i]); |
| } |
| } |
| if (it != qualified_name_parts.end() - 1) { ns += "_"; } |
| } |
| |
| return ns + "." + type.struct_def->name; |
| } |
| |
| void GenImplementationGetters( |
| const StructDef &struct_def, |
| std::vector<std::pair<int, FieldDef *>> non_deprecated_fields, |
| std::string *code_ptr) { |
| auto &code = *code_ptr; |
| |
| for (auto it = non_deprecated_fields.begin(); |
| it != non_deprecated_fields.end(); ++it) { |
| auto pair = *it; |
| auto &field = *pair.second; |
| |
| std::string field_name = ConvertCase(field.name, Case::kLowerCamel); |
| std::string defaultValue = getDefaultValue(field.value); |
| bool isNullable = defaultValue.empty() && !struct_def.fixed; |
| std::string type_name = |
| GenDartTypeName(field.value.type, struct_def.defined_namespace, field, |
| isNullable, ""); |
| |
| GenDocComment(field.doc_comment, &code, "", " "); |
| |
| code += " " + type_name + " get " + field_name; |
| if (field.value.type.base_type == BASE_TYPE_UNION) { |
| code += " {\n"; |
| code += " switch (" + field_name + "Type?.value) {\n"; |
| auto &enum_def = *field.value.type.enum_def; |
| for (auto en_it = enum_def.Vals().begin() + 1; |
| en_it != enum_def.Vals().end(); ++en_it) { |
| auto &ev = **en_it; |
| |
| auto enum_name = NamespaceAliasFromUnionType( |
| enum_def.defined_namespace, ev.union_type); |
| code += " case " + enum_def.ToString(ev) + ": return " + |
| enum_name + ".reader.vTableGetNullable(_bc, _bcOffset, " + |
| NumToString(field.value.offset) + ");\n"; |
| } |
| code += " default: return null;\n"; |
| code += " }\n"; |
| code += " }\n"; |
| } else { |
| code += " => "; |
| if (field.value.type.enum_def && |
| field.value.type.base_type != BASE_TYPE_VECTOR) { |
| code += GenDartTypeName(field.value.type, |
| struct_def.defined_namespace, field) + |
| (isNullable ? "._createOrNull(" : ".fromValue("); |
| } |
| |
| code += GenReaderTypeName(field.value.type, |
| struct_def.defined_namespace, field); |
| if (struct_def.fixed) { |
| code += |
| ".read(_bc, _bcOffset + " + NumToString(field.value.offset) + ")"; |
| } else { |
| code += ".vTableGet"; |
| std::string offset = NumToString(field.value.offset); |
| if (isNullable) { |
| code += "Nullable(_bc, _bcOffset, " + offset + ")"; |
| } else { |
| code += "(_bc, _bcOffset, " + offset + ", " + defaultValue + ")"; |
| } |
| } |
| if (field.value.type.enum_def && |
| field.value.type.base_type != BASE_TYPE_VECTOR) { |
| code += ")"; |
| } |
| code += ";\n"; |
| } |
| } |
| |
| code += "\n"; |
| code += GenToString(struct_def.name, non_deprecated_fields); |
| } |
| |
| std::string GenToString( |
| const std::string &object_name, |
| const std::vector<std::pair<int, FieldDef *>> &non_deprecated_fields) { |
| std::string code; |
| code += " @override\n"; |
| code += " String toString() {\n"; |
| code += " return '" + object_name + "{"; |
| for (auto it = non_deprecated_fields.begin(); |
| it != non_deprecated_fields.end(); ++it) { |
| auto pair = *it; |
| auto &field = *pair.second; |
| code += ConvertCase(field.name, Case::kLowerCamel) + ": $" + |
| ConvertCase(field.name, Case::kLowerCamel); |
| if (it != non_deprecated_fields.end() - 1) { code += ", "; } |
| } |
| code += "}';\n"; |
| code += " }\n"; |
| return code; |
| } |
| |
| std::string getDefaultValue(const Value &value) const { |
| if (!value.constant.empty() && value.constant != "0") { |
| if (IsBool(value.type.base_type)) { |
| return "true"; |
| } else if (value.constant == "nan" || value.constant == "+nan" || |
| value.constant == "-nan") { |
| return "double.nan"; |
| } else if (value.constant == "inf" || value.constant == "+inf") { |
| return "double.infinity"; |
| } else if (value.constant == "-inf") { |
| return "double.negativeInfinity"; |
| } else { |
| return value.constant; |
| } |
| } else if (IsBool(value.type.base_type)) { |
| return "false"; |
| } else if (IsScalar(value.type.base_type) && !IsUnion(value.type)) { |
| return "0"; |
| } else { |
| return ""; |
| } |
| } |
| |
| void GenReader(const StructDef &struct_def, std::string *reader_name_ptr, |
| std::string *code_ptr) { |
| auto &code = *code_ptr; |
| auto &reader_name = *reader_name_ptr; |
| auto &impl_name = struct_def.name; |
| |
| code += "class " + reader_name + " extends " + _kFb; |
| if (struct_def.fixed) { |
| code += ".StructReader<"; |
| } else { |
| code += ".TableReader<"; |
| } |
| code += impl_name + "> {\n"; |
| code += " const " + reader_name + "();\n\n"; |
| |
| if (struct_def.fixed) { |
| code += " @override\n"; |
| code += " int get size => " + NumToString(struct_def.bytesize) + ";\n\n"; |
| } |
| code += " @override\n"; |
| code += " " + impl_name + |
| " createObject(fb.BufferContext bc, int offset) => \n " + |
| impl_name + "._(bc, offset);\n"; |
| code += "}\n\n"; |
| } |
| |
| void GenBuilder(const StructDef &struct_def, |
| std::vector<std::pair<int, FieldDef *>> non_deprecated_fields, |
| std::string *builder_name_ptr, std::string *code_ptr) { |
| if (non_deprecated_fields.size() == 0) { return; } |
| auto &code = *code_ptr; |
| auto &builder_name = *builder_name_ptr; |
| |
| code += "class " + builder_name + " {\n"; |
| code += " " + builder_name + "(this.fbBuilder);\n\n"; |
| code += " final " + _kFb + ".Builder fbBuilder;\n\n"; |
| |
| if (struct_def.fixed) { |
| StructBuilderBody(struct_def, non_deprecated_fields, code_ptr); |
| } else { |
| TableBuilderBody(struct_def, non_deprecated_fields, code_ptr); |
| } |
| |
| code += "}\n\n"; |
| } |
| |
| void StructBuilderBody( |
| const StructDef &struct_def, |
| std::vector<std::pair<int, FieldDef *>> non_deprecated_fields, |
| std::string *code_ptr) { |
| auto &code = *code_ptr; |
| |
| code += " int finish("; |
| for (auto it = non_deprecated_fields.begin(); |
| it != non_deprecated_fields.end(); ++it) { |
| auto pair = *it; |
| auto &field = *pair.second; |
| |
| if (IsStruct(field.value.type)) { |
| code += "fb.StructBuilder"; |
| } else { |
| code += GenDartTypeName(field.value.type, struct_def.defined_namespace, |
| field); |
| } |
| code += " " + field.name; |
| if (it != non_deprecated_fields.end() - 1) { code += ", "; } |
| } |
| code += ") {\n"; |
| |
| for (auto it = non_deprecated_fields.rbegin(); |
| it != non_deprecated_fields.rend(); ++it) { |
| auto pair = *it; |
| auto &field = *pair.second; |
| |
| if (field.padding) { |
| code += " fbBuilder.pad(" + NumToString(field.padding) + ");\n"; |
| } |
| |
| if (IsStruct(field.value.type)) { |
| code += " " + field.name + "();\n"; |
| } else { |
| code += " fbBuilder.put" + GenType(field.value.type) + "("; |
| code += field.name; |
| if (field.value.type.enum_def) { code += ".value"; } |
| code += ");\n"; |
| } |
| } |
| code += " return fbBuilder.offset;\n"; |
| code += " }\n\n"; |
| } |
| |
| void TableBuilderBody( |
| const StructDef &struct_def, |
| std::vector<std::pair<int, FieldDef *>> non_deprecated_fields, |
| std::string *code_ptr) { |
| auto &code = *code_ptr; |
| |
| code += " void begin() {\n"; |
| code += " fbBuilder.startTable(" + |
| NumToString(struct_def.fields.vec.size()) + ");\n"; |
| code += " }\n\n"; |
| |
| for (auto it = non_deprecated_fields.begin(); |
| it != non_deprecated_fields.end(); ++it) { |
| auto pair = *it; |
| auto &field = *pair.second; |
| auto offset = pair.first; |
| |
| if (IsScalar(field.value.type.base_type)) { |
| code += " int add" + ConvertCase(field.name, Case::kUpperCamel) + "("; |
| code += GenDartTypeName(field.value.type, struct_def.defined_namespace, |
| field); |
| code += "? " + ConvertCase(field.name, Case::kLowerCamel) + ") {\n"; |
| code += " fbBuilder.add" + GenType(field.value.type) + "(" + |
| NumToString(offset) + ", "; |
| code += ConvertCase(field.name, Case::kLowerCamel); |
| if (field.value.type.enum_def) { code += "?.value"; } |
| code += ");\n"; |
| } else if (IsStruct(field.value.type)) { |
| code += " int add" + ConvertCase(field.name, Case::kUpperCamel) + |
| "(int offset) {\n"; |
| code += |
| " fbBuilder.addStruct(" + NumToString(offset) + ", offset);\n"; |
| } else { |
| code += " int add" + ConvertCase(field.name, Case::kUpperCamel) + |
| "Offset(int? offset) {\n"; |
| code += |
| " fbBuilder.addOffset(" + NumToString(offset) + ", offset);\n"; |
| } |
| code += " return fbBuilder.offset;\n"; |
| code += " }\n"; |
| } |
| |
| code += "\n"; |
| code += " int finish() {\n"; |
| code += " return fbBuilder.endTable();\n"; |
| code += " }\n"; |
| } |
| |
| void GenObjectBuilder( |
| const StructDef &struct_def, |
| std::vector<std::pair<int, FieldDef *>> non_deprecated_fields, |
| std::string *builder_name_ptr, std::string *code_ptr) { |
| auto &code = *code_ptr; |
| auto &builder_name = *builder_name_ptr; |
| |
| code += "class " + builder_name + " extends " + _kFb + ".ObjectBuilder {\n"; |
| for (auto it = non_deprecated_fields.begin(); |
| it != non_deprecated_fields.end(); ++it) { |
| auto pair = *it; |
| auto &field = *pair.second; |
| |
| code += " final " + |
| GenDartTypeName(field.value.type, struct_def.defined_namespace, |
| field, !struct_def.fixed, "ObjectBuilder") + |
| " _" + ConvertCase(field.name, Case::kLowerCamel) + ";\n"; |
| } |
| code += "\n"; |
| code += " " + builder_name + "("; |
| |
| if (non_deprecated_fields.size() != 0) { |
| code += "{\n"; |
| for (auto it = non_deprecated_fields.begin(); |
| it != non_deprecated_fields.end(); ++it) { |
| auto pair = *it; |
| auto &field = *pair.second; |
| |
| code += " "; |
| code += (struct_def.fixed ? "required " : "") + |
| GenDartTypeName(field.value.type, struct_def.defined_namespace, |
| field, !struct_def.fixed, "ObjectBuilder") + |
| " " + ConvertCase(field.name, Case::kLowerCamel) + ",\n"; |
| } |
| code += " })\n"; |
| code += " : "; |
| for (auto it = non_deprecated_fields.begin(); |
| it != non_deprecated_fields.end(); ++it) { |
| auto pair = *it; |
| auto &field = *pair.second; |
| |
| code += "_" + ConvertCase(field.name, Case::kLowerCamel) + " = " + |
| ConvertCase(field.name, Case::kLowerCamel); |
| if (it == non_deprecated_fields.end() - 1) { |
| code += ";\n\n"; |
| } else { |
| code += ",\n "; |
| } |
| } |
| } else { |
| code += ");\n\n"; |
| } |
| |
| code += " /// Finish building, and store into the [fbBuilder].\n"; |
| code += " @override\n"; |
| code += " int finish(" + _kFb + ".Builder fbBuilder) {\n"; |
| code += GenObjectBuilderImplementation(struct_def, non_deprecated_fields); |
| code += " }\n\n"; |
| |
| code += " /// Convenience method to serialize to byte list.\n"; |
| code += " @override\n"; |
| code += " Uint8List toBytes([String? fileIdentifier]) {\n"; |
| code += " final fbBuilder = " + _kFb + |
| ".Builder(deduplicateTables: false);\n"; |
| code += " fbBuilder.finish(finish(fbBuilder), fileIdentifier);\n"; |
| code += " return fbBuilder.buffer;\n"; |
| code += " }\n"; |
| code += "}\n"; |
| } |
| |
| std::string GenObjectBuilderImplementation( |
| const StructDef &struct_def, |
| const std::vector<std::pair<int, FieldDef *>> &non_deprecated_fields, |
| bool prependUnderscore = true, bool pack = false) { |
| std::string code; |
| for (auto it = non_deprecated_fields.begin(); |
| it != non_deprecated_fields.end(); ++it) { |
| const FieldDef &field = *it->second; |
| |
| if (IsScalar(field.value.type.base_type) || IsStruct(field.value.type)) |
| continue; |
| |
| std::string offset_name = |
| ConvertCase(field.name, Case::kLowerCamel) + "Offset"; |
| std::string field_name = (prependUnderscore ? "_" : "") + |
| ConvertCase(field.name, Case::kLowerCamel); |
| |
| // custom handling for fixed-sized struct in pack() |
| if (pack && IsVector(field.value.type) && |
| field.value.type.VectorType().base_type == BASE_TYPE_STRUCT && |
| field.value.type.struct_def->fixed) { |
| code += " int? " + offset_name + ";\n"; |
| code += " if (" + field_name + " != null) {\n"; |
| code += |
| " for (var e in " + field_name + "!) { e.pack(fbBuilder); }\n"; |
| code += " " + ConvertCase(field.name, Case::kLowerCamel) + |
| "Offset = fbBuilder.endStructVector(" + field_name + |
| "!.length);\n"; |
| code += " }\n"; |
| continue; |
| } |
| |
| code += " final int? " + offset_name; |
| if (IsVector(field.value.type)) { |
| code += " = " + field_name + " == null ? null\n"; |
| code += " : fbBuilder.writeList"; |
| switch (field.value.type.VectorType().base_type) { |
| case BASE_TYPE_STRING: |
| code += |
| "(" + field_name + "!.map(fbBuilder.writeString).toList());\n"; |
| break; |
| case BASE_TYPE_STRUCT: |
| if (field.value.type.struct_def->fixed) { |
| code += "OfStructs(" + field_name + "!);\n"; |
| } else { |
| code += "(" + field_name + "!.map((b) => b." + |
| (pack ? "pack" : "getOrCreateOffset") + |
| "(fbBuilder)).toList());\n"; |
| } |
| break; |
| default: |
| code += |
| GenType(field.value.type.VectorType()) + "(" + field_name + "!"; |
| if (field.value.type.enum_def) { |
| code += ".map((f) => f.value).toList()"; |
| } |
| code += ");\n"; |
| } |
| } else if (IsString(field.value.type)) { |
| code += " = " + field_name + " == null ? null\n"; |
| code += " : fbBuilder.writeString(" + field_name + "!);\n"; |
| } else { |
| code += " = " + field_name + "?." + |
| (pack ? "pack" : "getOrCreateOffset") + "(fbBuilder);\n"; |
| } |
| } |
| |
| if (struct_def.fixed) { |
| code += StructObjectBuilderBody(non_deprecated_fields, prependUnderscore, |
| pack); |
| } else { |
| code += TableObjectBuilderBody(struct_def, non_deprecated_fields, |
| prependUnderscore, pack); |
| } |
| return code; |
| } |
| |
| std::string StructObjectBuilderBody( |
| const std::vector<std::pair<int, FieldDef *>> &non_deprecated_fields, |
| bool prependUnderscore = true, bool pack = false) { |
| std::string code; |
| |
| for (auto it = non_deprecated_fields.rbegin(); |
| it != non_deprecated_fields.rend(); ++it) { |
| auto pair = *it; |
| auto &field = *pair.second; |
| |
| if (field.padding) { |
| code += " fbBuilder.pad(" + NumToString(field.padding) + ");\n"; |
| } |
| |
| if (IsStruct(field.value.type)) { |
| code += " "; |
| if (prependUnderscore) { code += "_"; } |
| code += field.name + (pack ? ".pack" : ".finish") + "(fbBuilder);\n"; |
| } else { |
| code += " fbBuilder.put" + GenType(field.value.type) + "("; |
| if (prependUnderscore) { code += "_"; } |
| code += field.name; |
| if (field.value.type.enum_def) { code += ".value"; } |
| code += ");\n"; |
| } |
| } |
| |
| code += " return fbBuilder.offset;\n"; |
| return code; |
| } |
| |
| std::string TableObjectBuilderBody( |
| const StructDef &struct_def, |
| const std::vector<std::pair<int, FieldDef *>> &non_deprecated_fields, |
| bool prependUnderscore = true, bool pack = false) { |
| std::string code; |
| code += " fbBuilder.startTable(" + |
| NumToString(struct_def.fields.vec.size()) + ");\n"; |
| |
| for (auto it = non_deprecated_fields.begin(); |
| it != non_deprecated_fields.end(); ++it) { |
| auto pair = *it; |
| auto &field = *pair.second; |
| auto offset = pair.first; |
| |
| std::string field_name = (prependUnderscore ? "_" : "") + |
| ConvertCase(field.name, Case::kLowerCamel); |
| |
| if (IsScalar(field.value.type.base_type)) { |
| code += " fbBuilder.add" + GenType(field.value.type) + "(" + |
| NumToString(offset) + ", " + field_name; |
| if (field.value.type.enum_def) { |
| bool isNullable = getDefaultValue(field.value).empty(); |
| code += (isNullable || !pack) ? "?.value" : ".value"; |
| } |
| code += ");\n"; |
| } else if (IsStruct(field.value.type)) { |
| code += " if (" + field_name + " != null) {\n"; |
| code += " fbBuilder.addStruct(" + NumToString(offset) + ", " + |
| field_name + (pack ? "!.pack" : "!.finish") + "(fbBuilder));\n"; |
| code += " }\n"; |
| } else { |
| code += " fbBuilder.addOffset(" + NumToString(offset) + ", " + |
| ConvertCase(field.name, Case::kLowerCamel) + "Offset);\n"; |
| } |
| } |
| code += " return fbBuilder.endTable();\n"; |
| return code; |
| } |
| }; |
| } // namespace dart |
| |
| bool GenerateDart(const Parser &parser, const std::string &path, |
| const std::string &file_name) { |
| dart::DartGenerator generator(parser, path, file_name); |
| return generator.generate(); |
| } |
| |
| std::string DartMakeRule(const Parser &parser, const std::string &path, |
| const std::string &file_name) { |
| auto filebase = |
| flatbuffers::StripPath(flatbuffers::StripExtension(file_name)); |
| dart::DartGenerator generator(parser, path, file_name); |
| auto make_rule = |
| generator.GeneratedFileName(path, file_name, parser.opts) + ": "; |
| |
| auto included_files = parser.GetIncludedFilesRecursive(file_name); |
| for (auto it = included_files.begin(); it != included_files.end(); ++it) { |
| make_rule += " " + *it; |
| } |
| return make_rule; |
| } |
| |
| } // namespace flatbuffers |