blob: a35950f5b01c136b1a4155ec9002bd4cde77aa52 [file] [log] [blame]
Austin Schuh272c6132020-11-14 16:37:52 -08001/*
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// independent from idl_parser, since this code is not needed for most clients
18
19#include "flatbuffers/code_generators.h"
20#include "flatbuffers/flatbuffers.h"
21#include "flatbuffers/idl.h"
22#include "flatbuffers/util.h"
Austin Schuh2dd86a92022-09-14 21:19:23 -070023#include "idl_namer.h"
Austin Schuh272c6132020-11-14 16:37:52 -080024
Austin Schuh272c6132020-11-14 16:37:52 -080025namespace flatbuffers {
26namespace java {
27
Austin Schuh2dd86a92022-09-14 21:19:23 -070028namespace {
29
30static Namer::Config JavaDefaultConfig() {
31 return {
32 /*types=*/Case::kKeep,
33 /*constants=*/Case::kScreamingSnake,
34 /*methods=*/Case::kLowerCamel,
35 /*functions=*/Case::kLowerCamel,
36 /*fields=*/Case::kLowerCamel,
37 /*variables=*/Case::kLowerCamel,
38 /*variants=*/Case::kKeep,
39 /*enum_variant_seperator=*/".",
40 /*escape_keywords=*/Namer::Config::Escape::AfterConvertingCase,
41 /*namespaces=*/Case::kKeep,
42 /*namespace_seperator=*/".",
43 /*object_prefix=*/"",
44 /*object_suffix=*/"T",
45 /*keyword_prefix=*/"",
46 /*keyword_suffix=*/"_",
47 /*filenames=*/Case::kKeep,
48 /*directories=*/Case::kKeep,
49 /*output_path=*/"",
50 /*filename_suffix=*/"_generated",
51 /*filename_extension=*/".java",
52 };
53}
54
55static std::set<std::string> JavaKeywords() {
56 return {
57 "abstract", "continue", "for", "new", "switch",
58 "assert", "default", "goto", "package", "synchronized",
59 "boolean", "do", "if", "private", "this",
60 "break", "double", "implements", "protected", "throw",
61 "byte", "else", "import", "public", "throws",
62 "case", "enum", "instanceof", "return", "transient",
63 "catch", "extends", "int", "short", "try",
64 "char", "final", "interface", "static", "void",
65 "class", "finally", "long", "strictfp", "volatile",
66 "const", "float", "native", "super", "while",
67 };
68}
69
70static const TypedFloatConstantGenerator JavaFloatGen("Double.", "Float.", "NaN",
Austin Schuh272c6132020-11-14 16:37:52 -080071 "POSITIVE_INFINITY",
72 "NEGATIVE_INFINITY");
73
Austin Schuh2dd86a92022-09-14 21:19:23 -070074static const CommentConfig comment_config = {
Austin Schuh272c6132020-11-14 16:37:52 -080075 "/**",
76 " *",
77 " */",
78};
79
Austin Schuh2dd86a92022-09-14 21:19:23 -070080} // namespace
81
Austin Schuh272c6132020-11-14 16:37:52 -080082class JavaGenerator : public BaseGenerator {
James Kuszmaul8e62b022022-03-22 09:33:25 -070083 struct FieldArrayLength {
84 std::string name;
85 int length;
86 };
87
Austin Schuh272c6132020-11-14 16:37:52 -080088 public:
89 JavaGenerator(const Parser &parser, const std::string &path,
90 const std::string &file_name)
91 : BaseGenerator(parser, path, file_name, "", ".", "java"),
Austin Schuh2dd86a92022-09-14 21:19:23 -070092 cur_name_space_(nullptr),
93 namer_(WithFlagOptions(JavaDefaultConfig(), parser.opts, path),
94 JavaKeywords()) {}
Austin Schuh272c6132020-11-14 16:37:52 -080095
96 JavaGenerator &operator=(const JavaGenerator &);
97 bool generate() {
98 std::string one_file_code;
99 cur_name_space_ = parser_.current_namespace_;
100
101 for (auto it = parser_.enums_.vec.begin(); it != parser_.enums_.vec.end();
102 ++it) {
103 std::string enumcode;
104 auto &enum_def = **it;
105 if (!parser_.opts.one_file) cur_name_space_ = enum_def.defined_namespace;
Austin Schuh2dd86a92022-09-14 21:19:23 -0700106 GenEnum(enum_def, enumcode);
Austin Schuh272c6132020-11-14 16:37:52 -0800107 if (parser_.opts.one_file) {
108 one_file_code += enumcode;
109 } else {
110 if (!SaveType(enum_def.name, *enum_def.defined_namespace, enumcode,
111 /* needs_includes= */ false))
112 return false;
113 }
James Kuszmaul8e62b022022-03-22 09:33:25 -0700114
115 if (parser_.opts.generate_object_based_api && enum_def.is_union) {
116 enumcode = "";
Austin Schuh2dd86a92022-09-14 21:19:23 -0700117 GenEnum_ObjectAPI(enum_def, enumcode);
118 auto class_name = namer_.Type(enum_def) + "Union";
James Kuszmaul8e62b022022-03-22 09:33:25 -0700119 if (parser_.opts.one_file) {
120 one_file_code += enumcode;
121 } else {
122 if (!SaveType(class_name, *enum_def.defined_namespace, enumcode,
123 /* needs_includes= */ false))
124 return false;
125 }
126 }
Austin Schuh272c6132020-11-14 16:37:52 -0800127 }
128
129 for (auto it = parser_.structs_.vec.begin();
130 it != parser_.structs_.vec.end(); ++it) {
131 std::string declcode;
132 auto &struct_def = **it;
133 if (!parser_.opts.one_file)
134 cur_name_space_ = struct_def.defined_namespace;
Austin Schuh2dd86a92022-09-14 21:19:23 -0700135 GenStruct(struct_def, declcode, parser_.opts);
Austin Schuh272c6132020-11-14 16:37:52 -0800136 if (parser_.opts.one_file) {
137 one_file_code += declcode;
138 } else {
139 if (!SaveType(struct_def.name, *struct_def.defined_namespace, declcode,
140 /* needs_includes= */ true))
141 return false;
142 }
James Kuszmaul8e62b022022-03-22 09:33:25 -0700143
144 if (parser_.opts.generate_object_based_api) {
145 declcode = "";
Austin Schuh2dd86a92022-09-14 21:19:23 -0700146 GenStruct_ObjectAPI(struct_def, declcode);
147 auto class_name = namer_.ObjectType(struct_def);
James Kuszmaul8e62b022022-03-22 09:33:25 -0700148 if (parser_.opts.one_file) {
149 one_file_code += declcode;
150 } else {
151 if (!SaveType(class_name, *struct_def.defined_namespace, declcode,
152 /* needs_includes= */ true))
153 return false;
154 }
155 }
Austin Schuh272c6132020-11-14 16:37:52 -0800156 }
157
158 if (parser_.opts.one_file) {
159 return SaveType(file_name_, *parser_.current_namespace_, one_file_code,
160 /* needs_includes= */ true);
161 }
162 return true;
163 }
164
165 // Save out the generated code for a single class while adding
166 // declaration boilerplate.
167 bool SaveType(const std::string &defname, const Namespace &ns,
168 const std::string &classcode, bool needs_includes) const {
169 if (!classcode.length()) return true;
170
171 std::string code;
172 code = "// " + std::string(FlatBuffersGeneratedWarning()) + "\n\n";
173
Austin Schuh2dd86a92022-09-14 21:19:23 -0700174 const std::string namespace_name = FullNamespace(".", ns);
Austin Schuh272c6132020-11-14 16:37:52 -0800175 if (!namespace_name.empty()) {
176 code += "package " + namespace_name + ";";
177 code += "\n\n";
178 }
179 if (needs_includes) {
180 code +=
181 "import java.nio.*;\nimport java.lang.*;\nimport "
182 "java.util.*;\nimport com.google.flatbuffers.*;\n";
183 if (parser_.opts.gen_nullable) {
184 code += "\nimport javax.annotation.Nullable;\n";
185 }
186 if (parser_.opts.java_checkerframework) {
187 code += "\nimport org.checkerframework.dataflow.qual.Pure;\n";
188 }
189 code += "\n";
190 }
191
192 code += classcode;
193 if (!namespace_name.empty()) code += "";
Austin Schuh2dd86a92022-09-14 21:19:23 -0700194 const std::string dirs = namer_.Directories(ns);
195 EnsureDirExists(dirs);
196 const std::string filename =
197 dirs + namer_.File(defname, /*skips=*/SkipFile::Suffix);
Austin Schuh272c6132020-11-14 16:37:52 -0800198 return SaveFile(filename.c_str(), code, false);
199 }
200
201 const Namespace *CurrentNameSpace() const { return cur_name_space_; }
202
203 std::string GenNullableAnnotation(const Type &t) const {
204 return parser_.opts.gen_nullable &&
205 !IsScalar(DestinationType(t, true).base_type) &&
206 t.base_type != BASE_TYPE_VECTOR
207 ? " @Nullable "
208 : "";
209 }
210
211 std::string GenPureAnnotation(const Type &t) const {
212 return parser_.opts.java_checkerframework &&
213 !IsScalar(DestinationType(t, true).base_type)
214 ? " @Pure "
215 : "";
216 }
217
218 std::string GenTypeBasic(const Type &type) const {
219 // clang-format off
220 static const char * const java_typename[] = {
221 #define FLATBUFFERS_TD(ENUM, IDLTYPE, CTYPE, JTYPE, ...) \
222 #JTYPE,
223 FLATBUFFERS_GEN_TYPES(FLATBUFFERS_TD)
224 #undef FLATBUFFERS_TD
225 };
226 // clang-format on
227 return java_typename[type.base_type];
228 }
229
230 std::string GenTypePointer(const Type &type) const {
231 switch (type.base_type) {
232 case BASE_TYPE_STRING: return "String";
233 case BASE_TYPE_VECTOR: return GenTypeGet(type.VectorType());
Austin Schuh2dd86a92022-09-14 21:19:23 -0700234 case BASE_TYPE_STRUCT: return namer_.NamespacedType(*type.struct_def);
Austin Schuh272c6132020-11-14 16:37:52 -0800235 case BASE_TYPE_UNION: FLATBUFFERS_FALLTHROUGH(); // else fall thru
236 default: return "Table";
237 }
238 }
239
240 std::string GenTypeGet(const Type &type) const {
241 return IsScalar(type.base_type)
242 ? GenTypeBasic(type)
243 : (IsArray(type) ? GenTypeGet(type.VectorType())
244 : GenTypePointer(type));
245 }
246
247 // Find the destination type the user wants to receive the value in (e.g.
248 // one size higher signed types for unsigned serialized values in Java).
249 Type DestinationType(const Type &type, bool vectorelem) const {
250 switch (type.base_type) {
251 // We use int for both uchar/ushort, since that generally means less
252 // casting than using short for uchar.
253 case BASE_TYPE_UCHAR: return Type(BASE_TYPE_INT);
254 case BASE_TYPE_USHORT: return Type(BASE_TYPE_INT);
255 case BASE_TYPE_UINT: return Type(BASE_TYPE_LONG);
256 case BASE_TYPE_ARRAY:
257 case BASE_TYPE_VECTOR:
258 if (vectorelem) return DestinationType(type.VectorType(), vectorelem);
259 FLATBUFFERS_FALLTHROUGH(); // else fall thru
260 default: return type;
261 }
262 }
263
264 std::string GenOffsetType() const { return "int"; }
265
266 std::string GenOffsetConstruct(const std::string &variable_name) const {
267 return variable_name;
268 }
269
270 std::string GenVectorOffsetType() const { return "int"; }
271
272 // Generate destination type name
273 std::string GenTypeNameDest(const Type &type) const {
274 return GenTypeGet(DestinationType(type, true));
275 }
276
277 // Mask to turn serialized value into destination type value.
278 std::string DestinationMask(const Type &type, bool vectorelem) const {
279 switch (type.base_type) {
280 case BASE_TYPE_UCHAR: return " & 0xFF";
281 case BASE_TYPE_USHORT: return " & 0xFFFF";
282 case BASE_TYPE_UINT: return " & 0xFFFFFFFFL";
283 case BASE_TYPE_VECTOR:
284 if (vectorelem) return DestinationMask(type.VectorType(), vectorelem);
285 FLATBUFFERS_FALLTHROUGH(); // else fall thru
286 default: return "";
287 }
288 }
289
290 // Casts necessary to correctly read serialized data
291 std::string DestinationCast(const Type &type) const {
292 if (IsSeries(type)) {
293 return DestinationCast(type.VectorType());
294 } else {
295 // Cast necessary to correctly read serialized unsigned values.
296 if (type.base_type == BASE_TYPE_UINT) return "(long)";
297 }
298 return "";
299 }
300
301 // Cast statements for mutator method parameters.
302 // In Java, parameters representing unsigned numbers need to be cast down to
303 // their respective type. For example, a long holding an unsigned int value
304 // would be cast down to int before being put onto the buffer.
305 std::string SourceCast(const Type &type, bool castFromDest) const {
306 if (IsSeries(type)) {
307 return SourceCast(type.VectorType(), castFromDest);
308 } else {
309 if (castFromDest) {
310 if (type.base_type == BASE_TYPE_UINT)
James Kuszmaul8e62b022022-03-22 09:33:25 -0700311 return "(int) ";
Austin Schuh272c6132020-11-14 16:37:52 -0800312 else if (type.base_type == BASE_TYPE_USHORT)
James Kuszmaul8e62b022022-03-22 09:33:25 -0700313 return "(short) ";
Austin Schuh272c6132020-11-14 16:37:52 -0800314 else if (type.base_type == BASE_TYPE_UCHAR)
James Kuszmaul8e62b022022-03-22 09:33:25 -0700315 return "(byte) ";
Austin Schuh272c6132020-11-14 16:37:52 -0800316 }
317 }
318 return "";
319 }
320
321 std::string SourceCast(const Type &type) const {
322 return SourceCast(type, true);
323 }
324
325 std::string SourceCastBasic(const Type &type, bool castFromDest) const {
326 return IsScalar(type.base_type) ? SourceCast(type, castFromDest) : "";
327 }
328
329 std::string SourceCastBasic(const Type &type) const {
330 return SourceCastBasic(type, true);
331 }
332
333 std::string GenEnumDefaultValue(const FieldDef &field) const {
334 auto &value = field.value;
335 FLATBUFFERS_ASSERT(value.type.enum_def);
336 auto &enum_def = *value.type.enum_def;
337 auto enum_val = enum_def.FindByValue(value.constant);
Austin Schuh2dd86a92022-09-14 21:19:23 -0700338 return enum_val ? namer_.NamespacedEnumVariant(enum_def, *enum_val)
Austin Schuh272c6132020-11-14 16:37:52 -0800339 : value.constant;
340 }
341
342 std::string GenDefaultValue(const FieldDef &field) const {
343 auto &value = field.value;
344 auto constant = field.IsScalarOptional() ? "0" : value.constant;
345 auto longSuffix = "L";
346 switch (value.type.base_type) {
347 case BASE_TYPE_BOOL: return constant == "0" ? "false" : "true";
348 case BASE_TYPE_ULONG: {
349 // Converts the ulong into its bits signed equivalent
350 uint64_t defaultValue = StringToUInt(constant.c_str());
351 return NumToString(static_cast<int64_t>(defaultValue)) + longSuffix;
352 }
353 case BASE_TYPE_UINT:
354 case BASE_TYPE_LONG: return constant + longSuffix;
355 default:
356 if (IsFloat(value.type.base_type)) {
357 if (field.IsScalarOptional()) {
358 return value.type.base_type == BASE_TYPE_DOUBLE ? "0.0" : "0f";
359 }
360 return JavaFloatGen.GenFloatConstant(field);
361 } else {
362 return constant;
363 }
364 }
365 }
366
367 std::string GenDefaultValueBasic(const FieldDef &field) const {
368 auto &value = field.value;
369 if (!IsScalar(value.type.base_type)) { return "0"; }
370 return GenDefaultValue(field);
371 }
372
Austin Schuh2dd86a92022-09-14 21:19:23 -0700373 void GenEnum(EnumDef &enum_def, std::string &code) const {
Austin Schuh272c6132020-11-14 16:37:52 -0800374 if (enum_def.generated) return;
375
376 // Generate enum definitions of the form:
377 // public static (final) int name = value;
378 // In Java, we use ints rather than the Enum feature, because we want them
379 // to map directly to how they're used in C/C++ and file formats.
380 // That, and Java Enums are expensive, and not universally liked.
Austin Schuh2dd86a92022-09-14 21:19:23 -0700381 GenComment(enum_def.doc_comment, &code, &comment_config);
Austin Schuh272c6132020-11-14 16:37:52 -0800382
James Kuszmaul8e62b022022-03-22 09:33:25 -0700383 code += "@SuppressWarnings(\"unused\")\n";
Austin Schuh272c6132020-11-14 16:37:52 -0800384 if (enum_def.attributes.Lookup("private")) {
385 // For Java, we leave the enum unmarked to indicate package-private
386 } else {
387 code += "public ";
388 }
Austin Schuh2dd86a92022-09-14 21:19:23 -0700389 code += "final class " + namer_.Type(enum_def);
Austin Schuh272c6132020-11-14 16:37:52 -0800390 code += " {\n";
Austin Schuh2dd86a92022-09-14 21:19:23 -0700391 code += " private " + namer_.Type(enum_def) + "() { }\n";
Austin Schuh272c6132020-11-14 16:37:52 -0800392 for (auto it = enum_def.Vals().begin(); it != enum_def.Vals().end(); ++it) {
393 auto &ev = **it;
Austin Schuh2dd86a92022-09-14 21:19:23 -0700394 GenComment(ev.doc_comment, &code, &comment_config, " ");
Austin Schuh272c6132020-11-14 16:37:52 -0800395 code += " public static final ";
James Kuszmaul8e62b022022-03-22 09:33:25 -0700396 code += GenTypeBasic(DestinationType(enum_def.underlying_type, false));
Austin Schuh272c6132020-11-14 16:37:52 -0800397 code += " ";
Austin Schuh2dd86a92022-09-14 21:19:23 -0700398 code += namer_.Variant(ev) + " = ";
Austin Schuh272c6132020-11-14 16:37:52 -0800399 code += enum_def.ToString(ev);
James Kuszmaul3b15b0c2022-11-08 14:03:16 -0800400 if (enum_def.underlying_type.base_type == BASE_TYPE_LONG ||
401 enum_def.underlying_type.base_type == BASE_TYPE_ULONG) {
402 code += "L";
403 }
Austin Schuh272c6132020-11-14 16:37:52 -0800404 code += ";\n";
405 }
406
James Kuszmaul8e62b022022-03-22 09:33:25 -0700407 // Generate a string table for enum values.
Austin Schuh272c6132020-11-14 16:37:52 -0800408 // Problem is, if values are very sparse that could generate really big
409 // tables. Ideally in that case we generate a map lookup instead, but for
410 // the moment we simply don't output a table at all.
411 auto range = enum_def.Distance();
412 // Average distance between values above which we consider a table
413 // "too sparse". Change at will.
414 static const uint64_t kMaxSparseness = 5;
James Kuszmaul8e62b022022-03-22 09:33:25 -0700415 if (range / static_cast<uint64_t>(enum_def.size()) < kMaxSparseness &&
416 GenTypeBasic(DestinationType(enum_def.underlying_type, false)) !=
417 "long") {
Austin Schuh272c6132020-11-14 16:37:52 -0800418 code += "\n public static final String";
419 code += "[] names = { ";
Austin Schuh2dd86a92022-09-14 21:19:23 -0700420 const EnumVal *prev = enum_def.Vals().front();
Austin Schuh272c6132020-11-14 16:37:52 -0800421 for (auto it = enum_def.Vals().begin(); it != enum_def.Vals().end();
422 ++it) {
Austin Schuh2dd86a92022-09-14 21:19:23 -0700423 const EnumVal &ev = **it;
424 for (auto k = enum_def.Distance(prev, &ev); k > 1; --k)
425 code += "\"\", ";
426 prev = &ev;
427 code += "\"" + namer_.Variant(ev) + "\", ";
Austin Schuh272c6132020-11-14 16:37:52 -0800428 }
429 code += "};\n\n";
430 code += " public static ";
431 code += "String";
James Kuszmaul8e62b022022-03-22 09:33:25 -0700432 code += " name";
Austin Schuh272c6132020-11-14 16:37:52 -0800433 code += "(int e) { return names[e";
434 if (enum_def.MinValue()->IsNonZero())
Austin Schuh2dd86a92022-09-14 21:19:23 -0700435 code += " - " + namer_.Variant(enum_def.MinValue()->name);
Austin Schuh272c6132020-11-14 16:37:52 -0800436 code += "]; }\n";
437 }
438
439 // Close the class
440 code += "}\n\n";
441 }
442
443 // Returns the function name that is able to read a value of the given type.
444 std::string GenGetter(const Type &type) const {
445 switch (type.base_type) {
446 case BASE_TYPE_STRING: return "__string";
447 case BASE_TYPE_STRUCT: return "__struct";
448 case BASE_TYPE_UNION: return "__union";
449 case BASE_TYPE_VECTOR: return GenGetter(type.VectorType());
450 case BASE_TYPE_ARRAY: return GenGetter(type.VectorType());
451 default: {
452 std::string getter = "bb.get";
453 if (type.base_type == BASE_TYPE_BOOL) {
454 getter = "0!=" + getter;
455 } else if (GenTypeBasic(type) != "byte") {
James Kuszmaul8e62b022022-03-22 09:33:25 -0700456 getter += ConvertCase(GenTypeBasic(type), Case::kUpperCamel);
Austin Schuh272c6132020-11-14 16:37:52 -0800457 }
458 return getter;
459 }
460 }
461 }
462
463 // Returns the function name that is able to read a value of the given type.
464 std::string GenGetterForLookupByKey(flatbuffers::FieldDef *key_field,
465 const std::string &data_buffer,
466 const char *num = nullptr) const {
467 auto type = key_field->value.type;
468 auto dest_mask = DestinationMask(type, true);
469 auto dest_cast = DestinationCast(type);
470 auto getter = data_buffer + ".get";
471 if (GenTypeBasic(type) != "byte") {
James Kuszmaul8e62b022022-03-22 09:33:25 -0700472 getter += ConvertCase(GenTypeBasic(type), Case::kUpperCamel);
Austin Schuh272c6132020-11-14 16:37:52 -0800473 }
474 getter = dest_cast + getter + "(" + GenOffsetGetter(key_field, num) + ")" +
475 dest_mask;
476 return getter;
477 }
478
479 // Direct mutation is only allowed for scalar fields.
480 // Hence a setter method will only be generated for such fields.
481 std::string GenSetter(const Type &type) const {
482 if (IsScalar(type.base_type)) {
483 std::string setter = "bb.put";
484 if (GenTypeBasic(type) != "byte" && type.base_type != BASE_TYPE_BOOL) {
James Kuszmaul8e62b022022-03-22 09:33:25 -0700485 setter += ConvertCase(GenTypeBasic(type), Case::kUpperCamel);
Austin Schuh272c6132020-11-14 16:37:52 -0800486 }
487 return setter;
488 } else {
489 return "";
490 }
491 }
492
493 // Returns the method name for use with add/put calls.
494 std::string GenMethod(const Type &type) const {
James Kuszmaul8e62b022022-03-22 09:33:25 -0700495 return IsScalar(type.base_type)
496 ? ConvertCase(GenTypeBasic(type), Case::kUpperCamel)
497 : (IsStruct(type) ? "Struct" : "Offset");
Austin Schuh272c6132020-11-14 16:37:52 -0800498 }
499
500 // Recursively generate arguments for a constructor, to deal with nested
501 // structs.
Austin Schuh2dd86a92022-09-14 21:19:23 -0700502 void GenStructArgs(const StructDef &struct_def, std::string &code,
Austin Schuh272c6132020-11-14 16:37:52 -0800503 const char *nameprefix, size_t array_count = 0) const {
Austin Schuh272c6132020-11-14 16:37:52 -0800504 for (auto it = struct_def.fields.vec.begin();
505 it != struct_def.fields.vec.end(); ++it) {
506 auto &field = **it;
507 const auto &field_type = field.value.type;
508 const auto array_field = IsArray(field_type);
509 const auto &type = array_field ? field_type.VectorType()
510 : DestinationType(field_type, false);
511 const auto array_cnt = array_field ? (array_count + 1) : array_count;
512 if (IsStruct(type)) {
513 // Generate arguments for a struct inside a struct. To ensure names
514 // don't clash, and to make it obvious these arguments are constructing
515 // a nested struct, prefix the name with the field name.
Austin Schuh2dd86a92022-09-14 21:19:23 -0700516 GenStructArgs(*field_type.struct_def, code,
Austin Schuh272c6132020-11-14 16:37:52 -0800517 (nameprefix + (field.name + "_")).c_str(), array_cnt);
518 } else {
519 code += ", ";
James Kuszmaul8e62b022022-03-22 09:33:25 -0700520 code += GenTypeNameDest(field.value.type);
Austin Schuh272c6132020-11-14 16:37:52 -0800521 for (size_t i = 0; i < array_cnt; i++) code += "[]";
522 code += " ";
523 code += nameprefix;
Austin Schuh2dd86a92022-09-14 21:19:23 -0700524 code += namer_.Field(field);
Austin Schuh272c6132020-11-14 16:37:52 -0800525 }
526 }
527 }
528
529 // Recusively generate struct construction statements of the form:
530 // builder.putType(name);
531 // and insert manual padding.
Austin Schuh2dd86a92022-09-14 21:19:23 -0700532 void GenStructBody(const StructDef &struct_def, std::string &code,
Austin Schuh272c6132020-11-14 16:37:52 -0800533 const char *nameprefix, size_t index = 0,
534 bool in_array = false) const {
Austin Schuh272c6132020-11-14 16:37:52 -0800535 std::string indent((index + 1) * 2, ' ');
536 code += indent + " builder.prep(";
537 code += NumToString(struct_def.minalign) + ", ";
538 code += NumToString(struct_def.bytesize) + ");\n";
539 for (auto it = struct_def.fields.vec.rbegin();
540 it != struct_def.fields.vec.rend(); ++it) {
541 auto &field = **it;
542 const auto &field_type = field.value.type;
543 if (field.padding) {
544 code += indent + " builder.pad(";
545 code += NumToString(field.padding) + ");\n";
546 }
547 if (IsStruct(field_type)) {
Austin Schuh2dd86a92022-09-14 21:19:23 -0700548 GenStructBody(*field_type.struct_def, code,
Austin Schuh272c6132020-11-14 16:37:52 -0800549 (nameprefix + (field.name + "_")).c_str(), index,
550 in_array);
551 } else {
552 const auto &type =
553 IsArray(field_type) ? field_type.VectorType() : field_type;
554 const auto index_var = "_idx" + NumToString(index);
555 if (IsArray(field_type)) {
556 code += indent + " for (int " + index_var + " = ";
557 code += NumToString(field_type.fixed_length);
558 code += "; " + index_var + " > 0; " + index_var + "--) {\n";
559 in_array = true;
560 }
561 if (IsStruct(type)) {
Austin Schuh2dd86a92022-09-14 21:19:23 -0700562 GenStructBody(*field_type.struct_def, code,
Austin Schuh272c6132020-11-14 16:37:52 -0800563 (nameprefix + (field.name + "_")).c_str(), index + 1,
564 in_array);
565 } else {
566 code += IsArray(field_type) ? " " : "";
567 code += indent + " builder.put";
568 code += GenMethod(type) + "(";
569 code += SourceCast(type);
Austin Schuh2dd86a92022-09-14 21:19:23 -0700570 auto argname = nameprefix + namer_.Variable(field);
Austin Schuh272c6132020-11-14 16:37:52 -0800571 code += argname;
572 size_t array_cnt = index + (IsArray(field_type) ? 1 : 0);
573 for (size_t i = 0; in_array && i < array_cnt; i++) {
574 code += "[_idx" + NumToString(i) + "-1]";
575 }
576 code += ");\n";
577 }
578 if (IsArray(field_type)) { code += indent + " }\n"; }
579 }
580 }
581 }
582
Austin Schuh272c6132020-11-14 16:37:52 -0800583 std::string GenOffsetGetter(flatbuffers::FieldDef *key_field,
584 const char *num = nullptr) const {
585 std::string key_offset = "";
586 key_offset += "__offset(" + NumToString(key_field->value.offset) + ", ";
587 if (num) {
588 key_offset += num;
589 key_offset += ", _bb)";
590 } else {
Austin Schuh2dd86a92022-09-14 21:19:23 -0700591 key_offset += "bb.capacity()";
Austin Schuh272c6132020-11-14 16:37:52 -0800592 key_offset += " - tableOffset, bb)";
593 }
594 return key_offset;
595 }
596
597 std::string GenLookupKeyGetter(flatbuffers::FieldDef *key_field) const {
598 std::string key_getter = " ";
599 key_getter += "int tableOffset = ";
600 key_getter += "__indirect(vectorLocation + 4 * (start + middle)";
601 key_getter += ", bb);\n ";
602 if (IsString(key_field->value.type)) {
603 key_getter += "int comp = ";
604 key_getter += "compareStrings(";
605 key_getter += GenOffsetGetter(key_field);
606 key_getter += ", byteKey, bb);\n";
607 } else {
608 auto get_val = GenGetterForLookupByKey(key_field, "bb");
609 key_getter += GenTypeNameDest(key_field->value.type) + " val = ";
610 key_getter += get_val + ";\n";
611 key_getter += " int comp = val > key ? 1 : val < key ? -1 : 0;\n";
612 }
613 return key_getter;
614 }
615
616 std::string GenKeyGetter(flatbuffers::FieldDef *key_field) const {
617 std::string key_getter = "";
618 auto data_buffer = "_bb";
619 if (IsString(key_field->value.type)) {
620 key_getter += " return ";
621 key_getter += "";
622 key_getter += "compareStrings(";
623 key_getter += GenOffsetGetter(key_field, "o1") + ", ";
624 key_getter += GenOffsetGetter(key_field, "o2") + ", " + data_buffer + ")";
625 key_getter += ";";
626 } else {
627 auto field_getter = GenGetterForLookupByKey(key_field, data_buffer, "o1");
628 key_getter +=
629 "\n " + GenTypeNameDest(key_field->value.type) + " val_1 = ";
630 key_getter +=
631 field_getter + ";\n " + GenTypeNameDest(key_field->value.type);
632 key_getter += " val_2 = ";
633 field_getter = GenGetterForLookupByKey(key_field, data_buffer, "o2");
634 key_getter += field_getter + ";\n";
635 key_getter += " return val_1 > val_2 ? 1 : val_1 < val_2 ? -1 : 0;\n ";
636 }
637 return key_getter;
638 }
639
Austin Schuh2dd86a92022-09-14 21:19:23 -0700640 void GenStruct(StructDef &struct_def, std::string &code,
James Kuszmaul8e62b022022-03-22 09:33:25 -0700641 const IDLOptions &opts) const {
Austin Schuh272c6132020-11-14 16:37:52 -0800642 if (struct_def.generated) return;
Austin Schuh272c6132020-11-14 16:37:52 -0800643
644 // Generate a struct accessor class, with methods of the form:
645 // public type name() { return bb.getType(i + offset); }
646 // or for tables of the form:
647 // public type name() {
648 // int o = __offset(offset); return o != 0 ? bb.getType(o + i) : default;
649 // }
Austin Schuh2dd86a92022-09-14 21:19:23 -0700650 GenComment(struct_def.doc_comment, &code, &comment_config);
Austin Schuh272c6132020-11-14 16:37:52 -0800651
652 if (parser_.opts.gen_generated) {
653 code += "@javax.annotation.Generated(value=\"flatc\")\n";
654 }
655 code += "@SuppressWarnings(\"unused\")\n";
656 if (struct_def.attributes.Lookup("private")) {
657 // For Java, we leave the struct unmarked to indicate package-private
658 } else {
659 code += "public ";
660 }
Austin Schuh2dd86a92022-09-14 21:19:23 -0700661 const auto struct_class = namer_.Type(struct_def);
662 code += "final class " + struct_class;
Austin Schuh272c6132020-11-14 16:37:52 -0800663 code += " extends ";
664 code += struct_def.fixed ? "Struct" : "Table";
665 code += " {\n";
666
667 if (!struct_def.fixed) {
Austin Schuh2dd86a92022-09-14 21:19:23 -0700668 // Generate version check method.
Austin Schuh272c6132020-11-14 16:37:52 -0800669 // Force compile time error if not using the same version runtime.
670 code += " public static void ValidateVersion() {";
671 code += " Constants.";
James Kuszmaul3b15b0c2022-11-08 14:03:16 -0800672 code += "FLATBUFFERS_22_10_26(); ";
Austin Schuh272c6132020-11-14 16:37:52 -0800673 code += "}\n";
674
675 // Generate a special accessor for the table that when used as the root
676 // of a FlatBuffer
Austin Schuh2dd86a92022-09-14 21:19:23 -0700677 const std::string method_name =
678 namer_.LegacyJavaMethod2("getRootAs", struct_def, "");
679 const std::string method_signature =
680 " public static " + struct_class + " " + method_name;
Austin Schuh272c6132020-11-14 16:37:52 -0800681
682 // create convenience method that doesn't require an existing object
683 code += method_signature + "(ByteBuffer _bb) ";
Austin Schuh2dd86a92022-09-14 21:19:23 -0700684 code +=
685 "{ return " + method_name + "(_bb, new " + struct_class + "()); }\n";
Austin Schuh272c6132020-11-14 16:37:52 -0800686
687 // create method that allows object reuse
688 code +=
Austin Schuh2dd86a92022-09-14 21:19:23 -0700689 method_signature + "(ByteBuffer _bb, " + struct_class + " obj) { ";
Austin Schuh272c6132020-11-14 16:37:52 -0800690 code += "_bb.order(ByteOrder.LITTLE_ENDIAN); ";
691 code += "return (obj.__assign(_bb.getInt(_bb.";
692 code += "position()";
693 code += ") + _bb.";
694 code += "position()";
695 code += ", _bb)); }\n";
696 if (parser_.root_struct_def_ == &struct_def) {
697 if (parser_.file_identifier_.length()) {
698 // Check if a buffer has the identifier.
699 code += " public static ";
Austin Schuh2dd86a92022-09-14 21:19:23 -0700700 code += "boolean " +
701 namer_.LegacyJavaMethod2(
702 "", struct_def, "BufferHasIdentifier(ByteBuffer _bb)") +
703 " { return ";
Austin Schuh272c6132020-11-14 16:37:52 -0800704 code += "__has_identifier(_bb, \"";
705 code += parser_.file_identifier_;
706 code += "\"); }\n";
707 }
708 }
709 }
710 // Generate the __init method that sets the field in a pre-existing
711 // accessor object. This is to allow object reuse.
712 code += " public void __init(int _i, ByteBuffer _bb) ";
713 code += "{ ";
714 code += "__reset(_i, _bb); ";
715 code += "}\n";
Austin Schuh2dd86a92022-09-14 21:19:23 -0700716 code += " public " + struct_class + " __assign(int _i, ByteBuffer _bb) ";
Austin Schuh272c6132020-11-14 16:37:52 -0800717 code += "{ __init(_i, _bb); return this; }\n\n";
718 for (auto it = struct_def.fields.vec.begin();
719 it != struct_def.fields.vec.end(); ++it) {
720 auto &field = **it;
721 if (field.deprecated) continue;
Austin Schuh2dd86a92022-09-14 21:19:23 -0700722 GenComment(field.doc_comment, &code, &comment_config, " ");
723 const std::string type_name = GenTypeGet(field.value.type);
724 const std::string type_name_dest = GenTypeNameDest(field.value.type);
725 const std::string dest_mask = DestinationMask(field.value.type, true);
726 const std::string dest_cast = DestinationCast(field.value.type);
727 const std::string src_cast = SourceCast(field.value.type);
728 const std::string method_start =
Austin Schuh272c6132020-11-14 16:37:52 -0800729 " public " +
James Kuszmaul8e62b022022-03-22 09:33:25 -0700730 (field.IsRequired() ? "" : GenNullableAnnotation(field.value.type)) +
Austin Schuh2dd86a92022-09-14 21:19:23 -0700731 GenPureAnnotation(field.value.type) + type_name_dest + " " +
732 namer_.Field(field);
733 const std::string obj = "obj";
Austin Schuh272c6132020-11-14 16:37:52 -0800734
735 // Most field accessors need to retrieve and test the field offset first,
736 // this is the prefix code for that:
737 auto offset_prefix =
738 IsArray(field.value.type)
739 ? " { return "
740 : (" { int o = __offset(" + NumToString(field.value.offset) +
741 "); return o != 0 ? ");
742 // Generate the accessors that don't do object reuse.
743 if (field.value.type.base_type == BASE_TYPE_STRUCT) {
744 // Calls the accessor that takes an accessor object with a new object.
745 code += method_start + "() { return ";
Austin Schuh2dd86a92022-09-14 21:19:23 -0700746 code += namer_.Field(field);
Austin Schuh272c6132020-11-14 16:37:52 -0800747 code += "(new ";
748 code += type_name + "()); }\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -0700749 } else if (IsSeries(field.value.type) &&
Austin Schuh272c6132020-11-14 16:37:52 -0800750 field.value.type.element == BASE_TYPE_STRUCT) {
751 // Accessors for vectors of structs also take accessor objects, this
752 // generates a variant without that argument.
753 code += method_start + "(int j) { return ";
Austin Schuh2dd86a92022-09-14 21:19:23 -0700754 code += namer_.Field(field);
Austin Schuh272c6132020-11-14 16:37:52 -0800755 code += "(new " + type_name + "(), j); }\n";
756 }
757
758 if (field.IsScalarOptional()) { code += GenOptionalScalarCheck(field); }
759 std::string getter = dest_cast + GenGetter(field.value.type);
760 code += method_start;
Austin Schuh272c6132020-11-14 16:37:52 -0800761 std::string member_suffix = "; ";
762 if (IsScalar(field.value.type.base_type)) {
763 code += "()";
764 member_suffix += "";
765 if (struct_def.fixed) {
766 code += " { return " + getter;
767 code += "(bb_pos + ";
768 code += NumToString(field.value.offset) + ")";
769 code += dest_mask;
770 } else {
771 code += offset_prefix + getter;
772 code += "(o + bb_pos)" + dest_mask;
Austin Schuh2dd86a92022-09-14 21:19:23 -0700773 code += " : ";
Austin Schuh272c6132020-11-14 16:37:52 -0800774 code += GenDefaultValue(field);
775 }
776 } else {
777 switch (field.value.type.base_type) {
778 case BASE_TYPE_STRUCT:
779 code += "(" + type_name + " obj)";
780 if (struct_def.fixed) {
781 code += " { return " + obj + ".__assign(";
782 code += "bb_pos + " + NumToString(field.value.offset) + ", ";
783 code += "bb)";
784 } else {
Austin Schuh2dd86a92022-09-14 21:19:23 -0700785 code += offset_prefix;
Austin Schuh272c6132020-11-14 16:37:52 -0800786 code += obj + ".__assign(";
787 code += field.value.type.struct_def->fixed
788 ? "o + bb_pos"
789 : "__indirect(o + bb_pos)";
790 code += ", bb) : null";
791 }
792 break;
793 case BASE_TYPE_STRING:
794 code += "()";
795 member_suffix += "";
796 code += offset_prefix + getter + "(o + ";
797 code += "bb_pos) : null";
798 break;
799 case BASE_TYPE_ARRAY: FLATBUFFERS_FALLTHROUGH(); // fall thru
800 case BASE_TYPE_VECTOR: {
801 auto vectortype = field.value.type.VectorType();
802 code += "(";
803 if (vectortype.base_type == BASE_TYPE_STRUCT) {
804 code += type_name + " obj, ";
805 getter = obj + ".__assign";
806 } else if (vectortype.base_type == BASE_TYPE_UNION) {
807 code += type_name + " obj, ";
808 }
809 code += "int j)";
Austin Schuh2dd86a92022-09-14 21:19:23 -0700810 const auto body = offset_prefix + getter + "(";
Austin Schuh272c6132020-11-14 16:37:52 -0800811 if (vectortype.base_type == BASE_TYPE_UNION) {
812 code += body + "obj, ";
813 } else {
814 code += body;
815 }
816 std::string index;
817 if (IsArray(field.value.type)) {
818 index += "bb_pos + " + NumToString(field.value.offset) + " + ";
819 } else {
820 index += "__vector(o) + ";
821 }
822 index += "j * " + NumToString(InlineSize(vectortype));
823 if (vectortype.base_type == BASE_TYPE_STRUCT) {
824 code += vectortype.struct_def->fixed
825 ? index
826 : "__indirect(" + index + ")";
827 code += ", bb";
828 } else {
829 code += index;
830 }
831 code += ")" + dest_mask;
832 if (!IsArray(field.value.type)) {
833 code += " : ";
Austin Schuh2dd86a92022-09-14 21:19:23 -0700834 code += field.value.type.element == BASE_TYPE_BOOL
835 ? "false"
836 : (IsScalar(field.value.type.element) ? "0" : "null");
Austin Schuh272c6132020-11-14 16:37:52 -0800837 }
838
839 break;
840 }
841 case BASE_TYPE_UNION:
842 code += "(" + type_name + " obj)" + offset_prefix + getter;
843 code += "(obj, o + bb_pos) : null";
844 break;
845 default: FLATBUFFERS_ASSERT(0);
846 }
847 }
848 code += member_suffix;
849 code += "}\n";
850 if (IsVector(field.value.type)) {
Austin Schuh2dd86a92022-09-14 21:19:23 -0700851 code += " public int " + namer_.Field(field);
Austin Schuh272c6132020-11-14 16:37:52 -0800852 code += "Length";
853 code += "()";
854 code += offset_prefix;
855 code += "__vector_len(o) : 0; ";
856 code += "";
857 code += "}\n";
858 // See if we should generate a by-key accessor.
859 if (field.value.type.element == BASE_TYPE_STRUCT &&
860 !field.value.type.struct_def->fixed) {
861 auto &sd = *field.value.type.struct_def;
862 auto &fields = sd.fields.vec;
863 for (auto kit = fields.begin(); kit != fields.end(); ++kit) {
864 auto &key_field = **kit;
865 if (key_field.key) {
Austin Schuh2dd86a92022-09-14 21:19:23 -0700866 auto qualified_name = namer_.NamespacedType(sd);
Austin Schuh272c6132020-11-14 16:37:52 -0800867 code += " public " + qualified_name + " ";
Austin Schuh2dd86a92022-09-14 21:19:23 -0700868 code += namer_.Method(field) + "ByKey(";
Austin Schuh272c6132020-11-14 16:37:52 -0800869 code += GenTypeNameDest(key_field.value.type) + " key)";
870 code += offset_prefix;
871 code += qualified_name + ".__lookup_by_key(";
872 code += "null, ";
873 code += "__vector(o), key, ";
874 code += "bb) : null; ";
875 code += "}\n";
876 code += " public " + qualified_name + " ";
Austin Schuh2dd86a92022-09-14 21:19:23 -0700877 code += namer_.Method(field) + "ByKey(";
Austin Schuh272c6132020-11-14 16:37:52 -0800878 code += qualified_name + " obj, ";
879 code += GenTypeNameDest(key_field.value.type) + " key)";
880 code += offset_prefix;
881 code += qualified_name + ".__lookup_by_key(obj, ";
882 code += "__vector(o), key, ";
883 code += "bb) : null; ";
884 code += "}\n";
885 break;
886 }
887 }
888 }
889 }
890 // Generate the accessors for vector of structs with vector access object
891 if (IsVector(field.value.type)) {
892 std::string vector_type_name;
893 const auto &element_base_type = field.value.type.VectorType().base_type;
894 if (IsScalar(element_base_type)) {
James Kuszmaul8e62b022022-03-22 09:33:25 -0700895 vector_type_name =
896 ConvertCase(type_name, Case::kUpperCamel) + "Vector";
Austin Schuh272c6132020-11-14 16:37:52 -0800897 } else if (element_base_type == BASE_TYPE_STRING) {
898 vector_type_name = "StringVector";
899 } else if (element_base_type == BASE_TYPE_UNION) {
900 vector_type_name = "UnionVector";
901 } else {
902 vector_type_name = type_name + ".Vector";
903 }
Austin Schuh2dd86a92022-09-14 21:19:23 -0700904 auto vector_method_start = GenNullableAnnotation(field.value.type) +
905 " public " + vector_type_name + " " +
906 namer_.Field(field, "vector");
Austin Schuh272c6132020-11-14 16:37:52 -0800907 code += vector_method_start + "() { return ";
Austin Schuh2dd86a92022-09-14 21:19:23 -0700908 code += namer_.Field(field, "vector");
Austin Schuh272c6132020-11-14 16:37:52 -0800909 code += "(new " + vector_type_name + "()); }\n";
910 code += vector_method_start + "(" + vector_type_name + " obj)";
Austin Schuh2dd86a92022-09-14 21:19:23 -0700911 code += offset_prefix + obj + ".__assign(";
Austin Schuh272c6132020-11-14 16:37:52 -0800912 code += "__vector(o), ";
913 if (!IsScalar(element_base_type)) {
914 auto vectortype = field.value.type.VectorType();
915 code += NumToString(InlineSize(vectortype)) + ", ";
916 }
917 code += "bb) : null" + member_suffix + "}\n";
918 }
919 // Generate a ByteBuffer accessor for strings & vectors of scalars.
920 if ((IsVector(field.value.type) &&
921 IsScalar(field.value.type.VectorType().base_type)) ||
922 IsString(field.value.type)) {
923 code += " public ByteBuffer ";
Austin Schuh2dd86a92022-09-14 21:19:23 -0700924 code += namer_.Field(field);
Austin Schuh272c6132020-11-14 16:37:52 -0800925 code += "AsByteBuffer() { return ";
926 code += "__vector_as_bytebuffer(";
927 code += NumToString(field.value.offset) + ", ";
928 code += NumToString(IsString(field.value.type)
929 ? 1
930 : InlineSize(field.value.type.VectorType()));
931 code += "); }\n";
932 code += " public ByteBuffer ";
Austin Schuh2dd86a92022-09-14 21:19:23 -0700933 code += namer_.Field(field);
Austin Schuh272c6132020-11-14 16:37:52 -0800934 code += "InByteBuffer(ByteBuffer _bb) { return ";
935 code += "__vector_in_bytebuffer(_bb, ";
936 code += NumToString(field.value.offset) + ", ";
937 code += NumToString(IsString(field.value.type)
938 ? 1
939 : InlineSize(field.value.type.VectorType()));
940 code += "); }\n";
941 }
942 // generate object accessors if is nested_flatbuffer
943 if (field.nested_flatbuffer) {
Austin Schuh2dd86a92022-09-14 21:19:23 -0700944 auto nested_type_name = namer_.NamespacedType(*field.nested_flatbuffer);
945 auto nested_method_name =
946 namer_.Field(field) + "As" + field.nested_flatbuffer->name;
Austin Schuh272c6132020-11-14 16:37:52 -0800947 auto get_nested_method_name = nested_method_name;
948 code += " public " + nested_type_name + " ";
949 code += nested_method_name + "() { return ";
950 code +=
951 get_nested_method_name + "(new " + nested_type_name + "()); }\n";
952 code += " public " + nested_type_name + " ";
953 code += get_nested_method_name + "(";
954 code += nested_type_name + " obj";
955 code += ") { int o = __offset(";
956 code += NumToString(field.value.offset) + "); ";
Austin Schuh2dd86a92022-09-14 21:19:23 -0700957 code += "return o != 0 ? " + obj + ".__assign(";
Austin Schuh272c6132020-11-14 16:37:52 -0800958 code += "";
959 code += "__indirect(__vector(o)), ";
960 code += "bb) : null; }\n";
961 }
962 // Generate mutators for scalar fields or vectors of scalars.
963 if (parser_.opts.mutable_buffer) {
964 auto is_series = (IsSeries(field.value.type));
965 const auto &underlying_type =
966 is_series ? field.value.type.VectorType() : field.value.type;
967 // Boolean parameters have to be explicitly converted to byte
968 // representation.
969 auto setter_parameter = underlying_type.base_type == BASE_TYPE_BOOL
970 ? "(byte)(" + field.name + " ? 1 : 0)"
971 : field.name;
Austin Schuh272c6132020-11-14 16:37:52 -0800972 // A vector mutator also needs the index of the vector element it should
973 // mutate.
974 auto mutator_params = (is_series ? "(int j, " : "(") +
975 GenTypeNameDest(underlying_type) + " " +
976 field.name + ") { ";
977 auto setter_index =
978 is_series
979 ? (IsArray(field.value.type)
980 ? "bb_pos + " + NumToString(field.value.offset)
981 : "__vector(o)") +
982 +" + j * " + NumToString(InlineSize(underlying_type))
983 : (struct_def.fixed
984 ? "bb_pos + " + NumToString(field.value.offset)
985 : "o + bb_pos");
986 if (IsScalar(underlying_type.base_type) && !IsUnion(field.value.type)) {
987 code += " public ";
988 code += struct_def.fixed ? "void " : "boolean ";
Austin Schuh2dd86a92022-09-14 21:19:23 -0700989 code += namer_.Method("mutate", field);
Austin Schuh272c6132020-11-14 16:37:52 -0800990 code += mutator_params;
991 if (struct_def.fixed) {
992 code += GenSetter(underlying_type) + "(" + setter_index + ", ";
993 code += src_cast + setter_parameter + "); }\n";
994 } else {
995 code += "int o = __offset(";
996 code += NumToString(field.value.offset) + ");";
997 code += " if (o != 0) { " + GenSetter(underlying_type);
998 code += "(" + setter_index + ", " + src_cast + setter_parameter +
999 "); return true; } else { return false; } }\n";
1000 }
1001 }
1002 }
1003 if (parser_.opts.java_primitive_has_method &&
1004 IsScalar(field.value.type.base_type) && !struct_def.fixed) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001005 auto vt_offset_constant = " public static final int VT_" +
1006 namer_.Constant(field) + " = " +
1007 NumToString(field.value.offset) + ";";
Austin Schuh272c6132020-11-14 16:37:52 -08001008
1009 code += vt_offset_constant;
1010 code += "\n";
1011 }
1012 }
1013 code += "\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001014 auto struct_has_create = false;
1015 std::set<flatbuffers::FieldDef *> field_has_create_set;
Austin Schuh272c6132020-11-14 16:37:52 -08001016 flatbuffers::FieldDef *key_field = nullptr;
1017 if (struct_def.fixed) {
James Kuszmaul8e62b022022-03-22 09:33:25 -07001018 struct_has_create = true;
Austin Schuh272c6132020-11-14 16:37:52 -08001019 // create a struct constructor function
1020 code += " public static " + GenOffsetType() + " ";
1021 code += "create";
Austin Schuh2dd86a92022-09-14 21:19:23 -07001022 code += struct_class + "(FlatBufferBuilder builder";
1023 GenStructArgs(struct_def, code, "");
Austin Schuh272c6132020-11-14 16:37:52 -08001024 code += ") {\n";
Austin Schuh2dd86a92022-09-14 21:19:23 -07001025 GenStructBody(struct_def, code, "");
Austin Schuh272c6132020-11-14 16:37:52 -08001026 code += " return ";
1027 code += GenOffsetConstruct("builder." + std::string("offset()"));
1028 code += ";\n }\n";
1029 } else {
1030 // Generate a method that creates a table in one go. This is only possible
1031 // when the table has no struct fields, since those have to be created
1032 // inline, and there's no way to do so in Java.
1033 bool has_no_struct_fields = true;
1034 int num_fields = 0;
1035 for (auto it = struct_def.fields.vec.begin();
1036 it != struct_def.fields.vec.end(); ++it) {
1037 auto &field = **it;
1038 if (field.deprecated) continue;
1039 if (IsStruct(field.value.type)) {
1040 has_no_struct_fields = false;
1041 } else {
1042 num_fields++;
1043 }
1044 }
1045 // JVM specifications restrict default constructor params to be < 255.
1046 // Longs and doubles take up 2 units, so we set the limit to be < 127.
1047 if (has_no_struct_fields && num_fields && num_fields < 127) {
James Kuszmaul8e62b022022-03-22 09:33:25 -07001048 struct_has_create = true;
Austin Schuh272c6132020-11-14 16:37:52 -08001049 // Generate a table constructor of the form:
1050 // public static int createName(FlatBufferBuilder builder, args...)
1051 code += " public static " + GenOffsetType() + " ";
Austin Schuh2dd86a92022-09-14 21:19:23 -07001052 code += namer_.LegacyJavaMethod2("create", struct_def, "");
Austin Schuh272c6132020-11-14 16:37:52 -08001053 code += "(FlatBufferBuilder builder";
1054 for (auto it = struct_def.fields.vec.begin();
1055 it != struct_def.fields.vec.end(); ++it) {
1056 auto &field = **it;
Austin Schuh2dd86a92022-09-14 21:19:23 -07001057 auto field_name = namer_.Field(field);
Austin Schuh272c6132020-11-14 16:37:52 -08001058 if (field.deprecated) continue;
1059 code += ",\n ";
1060 code += GenTypeBasic(DestinationType(field.value.type, false));
1061 code += " ";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001062 code += field_name;
Austin Schuh272c6132020-11-14 16:37:52 -08001063 if (!IsScalar(field.value.type.base_type)) code += "Offset";
1064 }
1065 code += ") {\n builder.";
1066 code += "startTable(";
1067 code += NumToString(struct_def.fields.vec.size()) + ");\n";
1068 for (size_t size = struct_def.sortbysize ? sizeof(largest_scalar_t) : 1;
1069 size; size /= 2) {
1070 for (auto it = struct_def.fields.vec.rbegin();
1071 it != struct_def.fields.vec.rend(); ++it) {
1072 auto &field = **it;
Austin Schuh2dd86a92022-09-14 21:19:23 -07001073 auto field_name = namer_.Field(field);
Austin Schuh272c6132020-11-14 16:37:52 -08001074 if (!field.deprecated &&
1075 (!struct_def.sortbysize ||
1076 size == SizeOf(field.value.type.base_type))) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001077 code += " " + struct_class + ".";
1078 code += namer_.Method("add", field) + "(builder, " + field_name;
Austin Schuh272c6132020-11-14 16:37:52 -08001079 if (!IsScalar(field.value.type.base_type)) code += "Offset";
1080 code += ");\n";
1081 }
1082 }
1083 }
Austin Schuh2dd86a92022-09-14 21:19:23 -07001084 code += " return " + struct_class + ".";
1085 code += namer_.LegacyJavaMethod2("end", struct_def, "");
Austin Schuh272c6132020-11-14 16:37:52 -08001086 code += "(builder);\n }\n\n";
1087 }
1088 // Generate a set of static methods that allow table construction,
1089 // of the form:
1090 // public static void addName(FlatBufferBuilder builder, short name)
1091 // { builder.addShort(id, name, default); }
1092 // Unlike the Create function, these always work.
1093 code += " public static void start";
Austin Schuh2dd86a92022-09-14 21:19:23 -07001094 code += struct_class;
Austin Schuh272c6132020-11-14 16:37:52 -08001095 code += "(FlatBufferBuilder builder) { builder.";
1096 code += "startTable(";
1097 code += NumToString(struct_def.fields.vec.size()) + "); }\n";
1098 for (auto it = struct_def.fields.vec.begin();
1099 it != struct_def.fields.vec.end(); ++it) {
1100 auto &field = **it;
1101 if (field.deprecated) continue;
Austin Schuh2dd86a92022-09-14 21:19:23 -07001102
1103 code += " public static void " + namer_.Method("add", field);
Austin Schuh272c6132020-11-14 16:37:52 -08001104 code += "(FlatBufferBuilder builder, ";
1105 code += GenTypeBasic(DestinationType(field.value.type, false));
Austin Schuh2dd86a92022-09-14 21:19:23 -07001106 auto argname = namer_.Field(field);
Austin Schuh272c6132020-11-14 16:37:52 -08001107 if (!IsScalar(field.value.type.base_type)) argname += "Offset";
1108 code += " " + argname + ") { builder.add";
1109 code += GenMethod(field.value.type) + "(";
Austin Schuh2dd86a92022-09-14 21:19:23 -07001110
1111 if (field.key) {
1112 // field has key attribute, so always need to exist
1113 // even if its value is equal to default.
1114 // Generated code will bypass default checking
1115 // resulting in { builder.addShort(name); slot(id); }
1116 key_field = &field;
1117 code += SourceCastBasic(field.value.type);
1118 code += argname;
1119 code += "); builder.slot(" +
1120 NumToString(it - struct_def.fields.vec.begin()) + "); }\n";
1121 } else {
1122 code += NumToString(it - struct_def.fields.vec.begin()) + ", ";
1123 code += SourceCastBasic(field.value.type);
1124 code += argname;
1125 code += ", ";
1126 code += SourceCastBasic(field.value.type);
1127 code += GenDefaultValue(field);
1128 code += "); }\n";
1129 }
Austin Schuh272c6132020-11-14 16:37:52 -08001130 if (IsVector(field.value.type)) {
1131 auto vector_type = field.value.type.VectorType();
1132 auto alignment = InlineAlignment(vector_type);
1133 auto elem_size = InlineSize(vector_type);
1134 if (!IsStruct(vector_type)) {
James Kuszmaul8e62b022022-03-22 09:33:25 -07001135 field_has_create_set.insert(&field);
Austin Schuh272c6132020-11-14 16:37:52 -08001136 // generate a method to create a vector from a java array.
1137 if ((vector_type.base_type == BASE_TYPE_CHAR ||
1138 vector_type.base_type == BASE_TYPE_UCHAR)) {
1139 // Handle byte[] and ByteBuffers separately for Java
1140 code += " public static " + GenVectorOffsetType() + " ";
Austin Schuh2dd86a92022-09-14 21:19:23 -07001141 code += namer_.Method("create", field);
Austin Schuh272c6132020-11-14 16:37:52 -08001142 code += "Vector(FlatBufferBuilder builder, byte[] data) ";
1143 code += "{ return builder.createByteVector(data); }\n";
1144
1145 code += " public static " + GenVectorOffsetType() + " ";
Austin Schuh2dd86a92022-09-14 21:19:23 -07001146 code += namer_.Method("create", field);
Austin Schuh272c6132020-11-14 16:37:52 -08001147 code += "Vector(FlatBufferBuilder builder, ByteBuffer data) ";
1148 code += "{ return builder.createByteVector(data); }\n";
1149 } else {
1150 code += " public static " + GenVectorOffsetType() + " ";
Austin Schuh2dd86a92022-09-14 21:19:23 -07001151 code += namer_.Method("create", field);
Austin Schuh272c6132020-11-14 16:37:52 -08001152 code += "Vector(FlatBufferBuilder builder, ";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001153 code += GenTypeBasic(DestinationType(vector_type, false)) +
1154 "[] data) ";
Austin Schuh272c6132020-11-14 16:37:52 -08001155 code += "{ builder.startVector(";
1156 code += NumToString(elem_size);
1157 code += ", data.length, ";
1158 code += NumToString(alignment);
1159 code += "); for (int i = data.";
1160 code += "length - 1; i >= 0; i--) builder.";
1161 code += "add";
1162 code += GenMethod(vector_type);
1163 code += "(";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001164 code += SourceCastBasic(vector_type);
Austin Schuh272c6132020-11-14 16:37:52 -08001165 code += "data[i]";
1166 code += "); return ";
1167 code += "builder.endVector(); }\n";
1168 }
1169 }
1170 // Generate a method to start a vector, data to be added manually
1171 // after.
Austin Schuh2dd86a92022-09-14 21:19:23 -07001172 code += " public static void " + namer_.Method("start", field);
Austin Schuh272c6132020-11-14 16:37:52 -08001173 code += "Vector(FlatBufferBuilder builder, int numElems) ";
1174 code += "{ builder.startVector(";
1175 code += NumToString(elem_size);
1176 code += ", numElems, " + NumToString(alignment);
1177 code += "); }\n";
1178 }
1179 }
1180 code += " public static " + GenOffsetType() + " ";
Austin Schuh2dd86a92022-09-14 21:19:23 -07001181 code += namer_.LegacyJavaMethod2("end", struct_def, "");
Austin Schuh272c6132020-11-14 16:37:52 -08001182 code += "(FlatBufferBuilder builder) {\n int o = builder.";
1183 code += "endTable();\n";
1184 for (auto it = struct_def.fields.vec.begin();
1185 it != struct_def.fields.vec.end(); ++it) {
1186 auto &field = **it;
James Kuszmaul8e62b022022-03-22 09:33:25 -07001187 if (!field.deprecated && field.IsRequired()) {
Austin Schuh272c6132020-11-14 16:37:52 -08001188 code += " builder.required(o, ";
1189 code += NumToString(field.value.offset);
1190 code += "); // " + field.name + "\n";
1191 }
1192 }
1193 code += " return " + GenOffsetConstruct("o") + ";\n }\n";
1194 if (parser_.root_struct_def_ == &struct_def) {
1195 std::string size_prefix[] = { "", "SizePrefixed" };
1196 for (int i = 0; i < 2; ++i) {
1197 code += " public static void ";
Austin Schuh2dd86a92022-09-14 21:19:23 -07001198 code += namer_.LegacyJavaMethod2("finish" + size_prefix[i],
1199 struct_def, "Buffer");
1200 code += "(FlatBufferBuilder builder, " + GenOffsetType();
Austin Schuh272c6132020-11-14 16:37:52 -08001201 code += " offset) {";
1202 code += " builder.finish" + size_prefix[i] + "(offset";
1203
1204 if (parser_.file_identifier_.length())
1205 code += ", \"" + parser_.file_identifier_ + "\"";
1206 code += "); }\n";
1207 }
1208 }
1209 }
1210 // Only generate key compare function for table,
1211 // because `key_field` is not set for struct
1212 if (struct_def.has_key && !struct_def.fixed) {
1213 FLATBUFFERS_ASSERT(key_field);
1214 code += "\n @Override\n protected int keysCompare(";
1215 code += "Integer o1, Integer o2, ByteBuffer _bb) {";
1216 code += GenKeyGetter(key_field);
1217 code += " }\n";
1218
Austin Schuh2dd86a92022-09-14 21:19:23 -07001219 code += "\n public static " + struct_class;
Austin Schuh272c6132020-11-14 16:37:52 -08001220 code += " __lookup_by_key(";
Austin Schuh2dd86a92022-09-14 21:19:23 -07001221 code += struct_class + " obj, ";
Austin Schuh272c6132020-11-14 16:37:52 -08001222 code += "int vectorLocation, ";
1223 code += GenTypeNameDest(key_field->value.type);
1224 code += " key, ByteBuffer bb) {\n";
1225 if (IsString(key_field->value.type)) {
1226 code += " byte[] byteKey = ";
1227 code += "key.getBytes(java.nio.charset.StandardCharsets.UTF_8);\n";
1228 }
1229 code += " int span = ";
1230 code += "bb.getInt(vectorLocation - 4);\n";
1231 code += " int start = 0;\n";
1232 code += " while (span != 0) {\n";
1233 code += " int middle = span / 2;\n";
1234 code += GenLookupKeyGetter(key_field);
1235 code += " if (comp > 0) {\n";
1236 code += " span = middle;\n";
1237 code += " } else if (comp < 0) {\n";
1238 code += " middle++;\n";
1239 code += " start += middle;\n";
1240 code += " span -= middle;\n";
1241 code += " } else {\n";
1242 code += " return ";
Austin Schuh2dd86a92022-09-14 21:19:23 -07001243 code += "(obj == null ? new " + struct_class + "() : obj)";
Austin Schuh272c6132020-11-14 16:37:52 -08001244 code += ".__assign(tableOffset, bb);\n";
1245 code += " }\n }\n";
1246 code += " return null;\n";
1247 code += " }\n";
1248 }
Austin Schuh2dd86a92022-09-14 21:19:23 -07001249 GenVectorAccessObject(struct_def, code);
James Kuszmaul8e62b022022-03-22 09:33:25 -07001250 if (opts.generate_object_based_api) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001251 GenPackUnPack_ObjectAPI(struct_def, code, opts, struct_has_create,
James Kuszmaul8e62b022022-03-22 09:33:25 -07001252 field_has_create_set);
1253 }
1254 code += "}\n\n";
Austin Schuh272c6132020-11-14 16:37:52 -08001255 }
1256
1257 std::string GenOptionalScalarCheck(FieldDef &field) const {
1258 if (!field.IsScalarOptional()) return "";
Austin Schuh2dd86a92022-09-14 21:19:23 -07001259 return " public boolean " + namer_.Method("has", field) +
Austin Schuh272c6132020-11-14 16:37:52 -08001260 "() { return 0 != __offset(" + NumToString(field.value.offset) +
1261 "); }\n";
1262 }
1263
Austin Schuh2dd86a92022-09-14 21:19:23 -07001264 void GenVectorAccessObject(StructDef &struct_def, std::string &code) const {
Austin Schuh272c6132020-11-14 16:37:52 -08001265 // Generate a vector of structs accessor class.
1266 code += "\n";
1267 code += " ";
1268 if (!struct_def.attributes.Lookup("private")) code += "public ";
1269 code += "static ";
1270 code += "final ";
1271 code += "class Vector extends ";
1272 code += "BaseVector {\n";
1273
1274 // Generate the __assign method that sets the field in a pre-existing
1275 // accessor object. This is to allow object reuse.
1276 std::string method_indent = " ";
1277 code += method_indent + "public Vector ";
1278 code += "__assign(int _vector, int _element_size, ByteBuffer _bb) { ";
1279 code += "__reset(_vector, _element_size, _bb); return this; }\n\n";
1280
Austin Schuh2dd86a92022-09-14 21:19:23 -07001281 auto type_name = namer_.Type(struct_def);
Austin Schuh272c6132020-11-14 16:37:52 -08001282 auto method_start = method_indent + "public " + type_name + " get";
1283 // Generate the accessors that don't do object reuse.
1284 code += method_start + "(int j) { return get";
1285 code += "(new " + type_name + "(), j); }\n";
1286 code += method_start + "(" + type_name + " obj, int j) { ";
1287 code += " return obj.__assign(";
1288 std::string index = "__element(j)";
1289 code += struct_def.fixed ? index : "__indirect(" + index + ", bb)";
1290 code += ", bb); }\n";
1291 // See if we should generate a by-key accessor.
1292 if (!struct_def.fixed) {
1293 auto &fields = struct_def.fields.vec;
1294 for (auto kit = fields.begin(); kit != fields.end(); ++kit) {
1295 auto &key_field = **kit;
1296 if (key_field.key) {
1297 auto nullable_annotation =
1298 parser_.opts.gen_nullable ? "@Nullable " : "";
1299 code += method_indent + nullable_annotation;
1300 code += "public " + type_name + " ";
1301 code += "getByKey(";
1302 code += GenTypeNameDest(key_field.value.type) + " key) { ";
1303 code += " return __lookup_by_key(null, ";
1304 code += "__vector(), key, ";
1305 code += "bb); ";
1306 code += "}\n";
1307 code += method_indent + nullable_annotation;
1308 code += "public " + type_name + " ";
1309 code += "getByKey(";
1310 code += type_name + " obj, ";
1311 code += GenTypeNameDest(key_field.value.type) + " key) { ";
1312 code += " return __lookup_by_key(obj, ";
1313 code += "__vector(), key, ";
1314 code += "bb); ";
1315 code += "}\n";
1316 break;
1317 }
1318 }
1319 }
1320 code += " }\n";
1321 }
1322
Austin Schuh2dd86a92022-09-14 21:19:23 -07001323 void GenEnum_ObjectAPI(EnumDef &enum_def, std::string &code) const {
James Kuszmaul8e62b022022-03-22 09:33:25 -07001324 if (enum_def.generated) return;
1325 code += "import com.google.flatbuffers.FlatBufferBuilder;\n\n";
1326
1327 if (!enum_def.attributes.Lookup("private")) { code += "public "; }
Austin Schuh2dd86a92022-09-14 21:19:23 -07001328 auto union_name = namer_.Type(enum_def) + "Union";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001329 auto union_type =
1330 GenTypeBasic(DestinationType(enum_def.underlying_type, false));
1331 code += "class " + union_name + " {\n";
1332 // Type
1333 code += " private " + union_type + " type;\n";
1334 // Value
1335 code += " private Object value;\n";
1336 code += "\n";
1337 // getters and setters
1338 code += " public " + union_type + " getType() { return type; }\n\n";
1339 code += " public void setType(" + union_type +
1340 " type) { this.type = type; }\n\n";
1341 code += " public Object getValue() { return value; }\n\n";
1342 code += " public void setValue(Object value) { this.value = value; }\n\n";
1343 // Constructor
1344 code += " public " + union_name + "() {\n";
Austin Schuh2dd86a92022-09-14 21:19:23 -07001345 code +=
1346 " this.type = " + namer_.EnumVariant(enum_def, *enum_def.Vals()[0]) +
1347 ";\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001348 code += " this.value = null;\n";
1349 code += " }\n\n";
1350 // As
1351 for (auto it = enum_def.Vals().begin(); it != enum_def.Vals().end(); ++it) {
1352 auto &ev = **it;
1353 if (ev.union_type.base_type == BASE_TYPE_NONE) continue;
Austin Schuh2dd86a92022-09-14 21:19:23 -07001354 auto type_name = GenTypeGet_ObjectAPI(ev.union_type, false, true);
James Kuszmaul8e62b022022-03-22 09:33:25 -07001355 if (ev.union_type.base_type == BASE_TYPE_STRUCT &&
1356 ev.union_type.struct_def->attributes.Lookup("private")) {
1357 code += " ";
1358 } else {
1359 code += " public ";
1360 }
1361 code += type_name + " as" + ev.name + "() { return (" + type_name +
1362 ") value; }\n";
1363 }
1364 code += "\n";
1365 // pack()
1366 code += " public static int pack(FlatBufferBuilder builder, " +
1367 union_name + " _o) {\n";
1368 code += " switch (_o.type) {\n";
1369 for (auto it = enum_def.Vals().begin(); it != enum_def.Vals().end(); ++it) {
1370 auto &ev = **it;
1371 if (ev.union_type.base_type == BASE_TYPE_NONE) {
1372 continue;
1373 } else {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001374 code += " case " + namer_.EnumVariant(enum_def, ev) + ": return ";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001375 if (IsString(ev.union_type)) {
1376 code += "builder.createString(_o.as" + ev.name + "());\n";
1377 } else {
1378 code += GenTypeGet(ev.union_type) + ".pack(builder, _o.as" + ev.name +
1379 "());\n";
1380 }
1381 }
1382 }
1383 code += " default: return 0;\n";
1384 code += " }\n";
1385 code += " }\n";
1386 code += "}\n\n";
1387 }
1388
Austin Schuh2dd86a92022-09-14 21:19:23 -07001389 void GenUnionUnPack_ObjectAPI(const EnumDef &enum_def, std::string &code,
James Kuszmaul8e62b022022-03-22 09:33:25 -07001390 const std::string &type_name,
Austin Schuh2dd86a92022-09-14 21:19:23 -07001391 const std::string &field_name,
James Kuszmaul8e62b022022-03-22 09:33:25 -07001392 bool is_vector) const {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001393 const std::string variable_type =
1394 is_vector ? type_name.substr(0, type_name.length() - 2) : type_name;
1395 const std::string variable_name =
1396 "_" + namer_.Variable("o", field_name) + (is_vector ? "Element" : "");
1397 const std::string type_params = is_vector ? "_j" : "";
1398 const std::string value_params = is_vector ? ", _j" : "";
1399 const std::string indent = (is_vector ? " " : " ");
James Kuszmaul8e62b022022-03-22 09:33:25 -07001400
James Kuszmaul8e62b022022-03-22 09:33:25 -07001401 code += indent + variable_type + " " + variable_name + " = new " +
1402 variable_type + "();\n";
1403 code += indent +
1404 GenTypeBasic(DestinationType(enum_def.underlying_type, false)) +
Austin Schuh2dd86a92022-09-14 21:19:23 -07001405 " " + variable_name + "Type = " + field_name + "Type(" +
James Kuszmaul8e62b022022-03-22 09:33:25 -07001406 type_params + ");\n";
1407 code += indent + variable_name + ".setType(" + variable_name + "Type);\n";
1408 code += indent + "Table " + variable_name + "Value;\n";
1409 code += indent + "switch (" + variable_name + "Type) {\n";
1410 for (auto eit = enum_def.Vals().begin(); eit != enum_def.Vals().end();
1411 ++eit) {
1412 auto &ev = **eit;
1413 if (ev.union_type.base_type == BASE_TYPE_NONE) {
1414 continue;
1415 } else {
1416 if (ev.union_type.base_type == BASE_TYPE_STRING ||
1417 (ev.union_type.base_type == BASE_TYPE_STRUCT &&
1418 ev.union_type.struct_def->fixed)) {
1419 continue; // This branch is due to bad implemantation of Unions in
1420 // Java which doesn't handle non Table types. Should be
1421 // deleted when issue #6561 is fixed.
1422 }
Austin Schuh2dd86a92022-09-14 21:19:23 -07001423 code += indent + " case " +
1424 namer_.NamespacedEnumVariant(enum_def, ev) + ":\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001425 auto actual_type = GenTypeGet(ev.union_type);
Austin Schuh2dd86a92022-09-14 21:19:23 -07001426 code += indent + " " + variable_name + "Value = " + field_name +
James Kuszmaul8e62b022022-03-22 09:33:25 -07001427 "(new " + actual_type + "()" + value_params + ");\n";
1428 code += indent + " " + variable_name + ".setValue(" + variable_name +
1429 "Value != null ? ((" + actual_type + ") " + variable_name +
1430 "Value).unpack() : null);\n";
1431 code += indent + " break;\n";
1432 }
1433 }
1434 code += indent + " default: break;\n";
1435 code += indent + "}\n";
1436 if (is_vector) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001437 code += indent + "_" + namer_.Variable("o", field_name) +
James Kuszmaul8e62b022022-03-22 09:33:25 -07001438 "[_j] = " + variable_name + ";\n";
1439 }
1440 }
1441
1442 void GenPackUnPack_ObjectAPI(
Austin Schuh2dd86a92022-09-14 21:19:23 -07001443 StructDef &struct_def, std::string &code, const IDLOptions &opts,
James Kuszmaul8e62b022022-03-22 09:33:25 -07001444 bool struct_has_create,
1445 const std::set<FieldDef *> &field_has_create) const {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001446 auto struct_name = namer_.ObjectType(struct_def);
James Kuszmaul8e62b022022-03-22 09:33:25 -07001447 // unpack()
1448 code += " public " + struct_name + " unpack() {\n";
1449 code += " " + struct_name + " _o = new " + struct_name + "();\n";
1450 code += " unpackTo(_o);\n";
1451 code += " return _o;\n";
1452 code += " }\n";
1453 // unpackTo()
1454 code += " public void unpackTo(" + struct_name + " _o) {\n";
1455 for (auto it = struct_def.fields.vec.begin();
1456 it != struct_def.fields.vec.end(); ++it) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001457 const auto &field = **it;
James Kuszmaul8e62b022022-03-22 09:33:25 -07001458 if (field.deprecated) continue;
1459 if (field.value.type.base_type == BASE_TYPE_UTYPE) continue;
1460 if (field.value.type.element == BASE_TYPE_UTYPE) continue;
Austin Schuh2dd86a92022-09-14 21:19:23 -07001461 const auto accessor = namer_.Method(field);
1462 const auto variable = "_" + namer_.Variable("o", field);
1463 const auto get_field = namer_.Method("get", field);
1464 const auto set_field = namer_.Method("set", field);
1465
1466 auto type_name = GenTypeGet_ObjectAPI(field.value.type, false, true);
James Kuszmaul8e62b022022-03-22 09:33:25 -07001467 if (field.IsScalarOptional())
1468 type_name = ConvertPrimitiveTypeToObjectWrapper_ObjectAPI(type_name);
Austin Schuh2dd86a92022-09-14 21:19:23 -07001469 auto start = " " + type_name + " " + variable + " = ";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001470 auto call_setter = true;
1471 switch (field.value.type.base_type) {
1472 case BASE_TYPE_STRUCT: {
1473 auto fixed = struct_def.fixed && field.value.type.struct_def->fixed;
1474 if (fixed) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001475 code +=
1476 " " + accessor + "().unpackTo(_o." + get_field + "());\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001477 } else {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001478 code += " if (" + accessor + "() != null) ";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001479 if (field.value.type.struct_def->fixed) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001480 code += accessor + "().unpackTo(_o." + get_field + "());\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001481 } else {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001482 code += "_o." + set_field + "(" + accessor + "().unpack());\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001483 }
Austin Schuh2dd86a92022-09-14 21:19:23 -07001484 code += " else _o." + set_field + "(null);\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001485 }
1486 call_setter = false;
1487 break;
1488 }
1489 case BASE_TYPE_ARRAY: {
1490 auto length_str = NumToString(field.value.type.fixed_length);
1491 auto unpack_method =
1492 field.value.type.struct_def == nullptr ? "" : ".unpack()";
Austin Schuh2dd86a92022-09-14 21:19:23 -07001493 code += start + "_o." + get_field + "();\n";
1494 code += " for (int _j = 0; _j < " + length_str + "; ++_j) { " +
1495 variable + "[_j] = " + accessor + "(_j)" + unpack_method +
1496 "; }\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001497 call_setter = false;
1498 break;
1499 }
1500 case BASE_TYPE_VECTOR:
1501 if (field.value.type.element == BASE_TYPE_UNION) {
1502 code += start + "new " +
Austin Schuh2dd86a92022-09-14 21:19:23 -07001503 GenConcreteTypeGet_ObjectAPI(field.value.type)
James Kuszmaul8e62b022022-03-22 09:33:25 -07001504 .substr(0, type_name.length() - 1) +
Austin Schuh2dd86a92022-09-14 21:19:23 -07001505 accessor + "Length()];\n";
1506 code +=
1507 " for (int _j = 0; _j < " + accessor + "Length(); ++_j) {\n";
1508 GenUnionUnPack_ObjectAPI(*field.value.type.enum_def, code,
1509 type_name, accessor, true);
James Kuszmaul8e62b022022-03-22 09:33:25 -07001510 code += " }\n";
1511 } else if (field.value.type.element != BASE_TYPE_UTYPE) {
1512 auto fixed = field.value.type.struct_def == nullptr;
Austin Schuh2dd86a92022-09-14 21:19:23 -07001513 const auto length_accessor = namer_.Method(field, "length");
James Kuszmaul8e62b022022-03-22 09:33:25 -07001514 code += start + "new " +
Austin Schuh2dd86a92022-09-14 21:19:23 -07001515 GenConcreteTypeGet_ObjectAPI(field.value.type)
James Kuszmaul8e62b022022-03-22 09:33:25 -07001516 .substr(0, type_name.length() - 1) +
Austin Schuh2dd86a92022-09-14 21:19:23 -07001517 length_accessor + "()];\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001518 code +=
Austin Schuh2dd86a92022-09-14 21:19:23 -07001519 " for (int _j = 0; _j < " + length_accessor + "(); ++_j) {";
1520 code += variable + "[_j] = ";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001521 if (fixed) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001522 code += accessor + "(_j)";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001523 } else {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001524 code += "(" + accessor + "(_j) != null ? " + accessor +
James Kuszmaul8e62b022022-03-22 09:33:25 -07001525 "(_j).unpack() : null)";
1526 }
1527 code += ";}\n";
1528 }
1529 break;
1530 case BASE_TYPE_UTYPE: break;
1531 case BASE_TYPE_UNION: {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001532 GenUnionUnPack_ObjectAPI(*field.value.type.enum_def, code, type_name,
1533 accessor, false);
James Kuszmaul8e62b022022-03-22 09:33:25 -07001534 break;
1535 }
1536 default: {
1537 if (field.IsScalarOptional()) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001538 code += start + namer_.Method("has", field) + "() ? " + accessor +
1539 "() : null;\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001540 } else {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001541 code += start + accessor + "();\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001542 }
1543 break;
1544 }
1545 }
1546 if (call_setter) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001547 code += " _o." + set_field + "(" + variable + ");\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001548 }
1549 }
1550 code += " }\n";
1551 // pack()
1552 code += " public static " + GenOffsetType() +
1553 " pack(FlatBufferBuilder builder, " + struct_name + " _o) {\n";
1554 code += " if (_o == null) return 0;\n";
1555 for (auto it = struct_def.fields.vec.begin();
1556 it != struct_def.fields.vec.end(); ++it) {
1557 auto &field = **it;
1558 if (field.deprecated) continue;
Austin Schuh2dd86a92022-09-14 21:19:23 -07001559 const auto field_name = namer_.Field(field);
1560 const auto variable = "_" + namer_.Variable("o", field);
1561 const auto get_field = namer_.Method("get", field);
James Kuszmaul8e62b022022-03-22 09:33:25 -07001562 // pre
1563 switch (field.value.type.base_type) {
1564 case BASE_TYPE_STRUCT: {
1565 if (!field.value.type.struct_def->fixed) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001566 code += " " + GenOffsetType() + " _" + namer_.Variable(field) +
1567 " = _o." + get_field +
James Kuszmaul8e62b022022-03-22 09:33:25 -07001568 "() == null ? 0 : " + GenTypeGet(field.value.type) +
Austin Schuh2dd86a92022-09-14 21:19:23 -07001569 ".pack(builder, _o." + get_field + "());\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001570 } else if (struct_def.fixed && struct_has_create) {
1571 std::vector<FieldArrayLength> array_lengths;
1572 FieldArrayLength tmp_array_length = {
1573 field.name,
1574 field.value.type.fixed_length,
1575 };
1576 array_lengths.push_back(tmp_array_length);
Austin Schuh2dd86a92022-09-14 21:19:23 -07001577 GenStructPackDecl_ObjectAPI(*field.value.type.struct_def,
1578 array_lengths, code);
James Kuszmaul8e62b022022-03-22 09:33:25 -07001579 }
1580 break;
1581 }
1582 case BASE_TYPE_STRING: {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001583 code += " int _" + field_name + " = _o." + get_field +
James Kuszmaul8e62b022022-03-22 09:33:25 -07001584 "() == null ? 0 : "
Austin Schuh2dd86a92022-09-14 21:19:23 -07001585 "builder.createString(_o." +
1586 get_field + "());\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001587 break;
1588 }
1589 case BASE_TYPE_VECTOR: {
1590 if (field_has_create.find(&field) != field_has_create.end()) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001591 auto property_name = field_name;
James Kuszmaul8e62b022022-03-22 09:33:25 -07001592 auto gen_for_loop = true;
Austin Schuh2dd86a92022-09-14 21:19:23 -07001593 std::string array_name = "__" + field_name;
James Kuszmaul8e62b022022-03-22 09:33:25 -07001594 std::string array_type = "";
1595 std::string element_type = "";
1596 std::string to_array = "";
1597 switch (field.value.type.element) {
1598 case BASE_TYPE_STRING: {
James Kuszmaul8e62b022022-03-22 09:33:25 -07001599 array_type = "int";
1600 element_type = "String";
Austin Schuh2dd86a92022-09-14 21:19:23 -07001601 to_array = "builder.createString(_e)";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001602 break;
1603 }
1604 case BASE_TYPE_STRUCT:
1605 array_type = "int";
1606 element_type =
Austin Schuh2dd86a92022-09-14 21:19:23 -07001607 GenTypeGet_ObjectAPI(field.value.type, true, true);
James Kuszmaul8e62b022022-03-22 09:33:25 -07001608 ;
1609 to_array = GenTypeGet(field.value.type) + ".pack(builder, _e)";
1610 break;
1611 case BASE_TYPE_UTYPE:
Austin Schuh2dd86a92022-09-14 21:19:23 -07001612 property_name = field_name.substr(0, field_name.size() - 4);
James Kuszmaul8e62b022022-03-22 09:33:25 -07001613 array_type = GenTypeBasic(DestinationType(
1614 field.value.type.enum_def->underlying_type, false));
1615 element_type = field.value.type.enum_def->name + "Union";
Austin Schuh2dd86a92022-09-14 21:19:23 -07001616 to_array = "_o." + namer_.Method("get", property_name) +
James Kuszmaul8e62b022022-03-22 09:33:25 -07001617 "()[_j].getType()";
1618 break;
1619 case BASE_TYPE_UNION:
1620 array_type = "int";
1621 element_type =
Austin Schuh2dd86a92022-09-14 21:19:23 -07001622 namer_.NamespacedType(*field.value.type.enum_def) + "Union";
1623 to_array = element_type + ".pack(builder, _o." +
1624 namer_.Method("get", property_name) + "()[_j])";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001625 break;
1626 case BASE_TYPE_UCHAR: // TODO this branch of the switch is due to
1627 // inconsistent behavior in unsigned byte.
1628 // Read further at Issue #6574.
1629 array_type = "byte";
1630 element_type = "int";
1631 to_array = "(byte) _e";
1632 break;
1633 default:
1634 gen_for_loop = false;
Austin Schuh2dd86a92022-09-14 21:19:23 -07001635 array_name = "_o." + namer_.Method("get", property_name) + "()";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001636 array_type = GenTypeNameDest(field.value.type);
1637 element_type = array_type;
1638 to_array = "_e";
1639 break;
1640 }
Austin Schuh2dd86a92022-09-14 21:19:23 -07001641 code += " int _" + field_name + " = 0;\n";
1642 code += " if (_o." + namer_.Method("get", property_name) +
James Kuszmaul8e62b022022-03-22 09:33:25 -07001643 "() != null) {\n";
1644 if (gen_for_loop) {
1645 code += " " + array_type + "[] " + array_name + " = new " +
1646 array_type + "[_o." +
Austin Schuh2dd86a92022-09-14 21:19:23 -07001647 namer_.Method("get", property_name) + "().length];\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001648 code += " int _j = 0;\n";
1649 code += " for (" + element_type + " _e : _o." +
Austin Schuh2dd86a92022-09-14 21:19:23 -07001650 namer_.Method("get", property_name) + "()) { ";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001651 code += array_name + "[_j] = " + to_array + "; _j++;}\n";
1652 }
Austin Schuh2dd86a92022-09-14 21:19:23 -07001653 code += " _" + field_name + " = " +
1654 namer_.Method("create", field) + "Vector(builder, " +
1655 array_name + ");\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001656 code += " }\n";
1657 } else {
1658 auto type_name = GenTypeGet(field.value.type);
1659 auto element_type_name =
Austin Schuh2dd86a92022-09-14 21:19:23 -07001660 GenTypeGet_ObjectAPI(field.value.type, true, true);
James Kuszmaul8e62b022022-03-22 09:33:25 -07001661 auto pack_method =
1662 field.value.type.struct_def == nullptr
1663 ? "builder.add" + GenMethod(field.value.type.VectorType()) +
Austin Schuh2dd86a92022-09-14 21:19:23 -07001664 "(" + variable + "[_j]);"
1665 : "_unused_offset = " + type_name + ".pack(builder, " +
1666 variable + "[_j]);";
1667 code += " int _" + field_name + " = 0;\n";
1668 code += " " + element_type_name + "[] " + variable + " = _o." +
1669 get_field + "();\n";
1670 code += " if (" + variable + " != null) {\n";
1671 if (field.value.type.struct_def != nullptr) {
1672 code += " int _unused_offset = 0;\n";
1673 }
1674 code += " " + namer_.Method("start", field) +
1675 "Vector(builder, " + variable + ".length);\n";
1676 code += " for (int _j = " + variable +
James Kuszmaul8e62b022022-03-22 09:33:25 -07001677 ".length - 1; _j >=0; _j--) { ";
1678 code += pack_method + "}\n";
Austin Schuh2dd86a92022-09-14 21:19:23 -07001679 code += " _" + field_name + " = builder.endVector();\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001680 code += " }\n";
1681 }
1682 break;
1683 }
1684 case BASE_TYPE_ARRAY: {
1685 if (field.value.type.struct_def != nullptr) {
1686 std::vector<FieldArrayLength> array_lengths;
1687 FieldArrayLength tmp_array_length = {
1688 field.name,
1689 field.value.type.fixed_length,
1690 };
1691 array_lengths.push_back(tmp_array_length);
Austin Schuh2dd86a92022-09-14 21:19:23 -07001692 GenStructPackDecl_ObjectAPI(*field.value.type.struct_def,
1693 array_lengths, code);
James Kuszmaul8e62b022022-03-22 09:33:25 -07001694 } else {
1695 code += " " +
Austin Schuh2dd86a92022-09-14 21:19:23 -07001696 GenTypeGet_ObjectAPI(field.value.type, false, true) + " _" +
1697 field_name + " = _o." + get_field + "();\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001698 }
1699 break;
1700 }
1701 case BASE_TYPE_UNION: {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001702 code += " " +
1703 GenTypeBasic(DestinationType(
1704 field.value.type.enum_def->underlying_type, false)) +
1705 " _" + field_name + "Type = _o." + get_field +
1706 "() == null ? " +
1707 namer_.NamespacedType(*field.value.type.enum_def) +
1708 ".NONE : " + "_o." + get_field + "().getType();\n";
1709 code += " " + GenOffsetType() + " _" + field_name + " = _o." +
1710 get_field + "() == null ? 0 : " +
1711 namer_.NamespacedType(*field.value.type.enum_def) +
1712 "Union.pack(builder, _o." + get_field + "());\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001713 break;
1714 }
1715 default: break;
1716 }
1717 }
1718 if (struct_has_create) {
1719 // Create
Austin Schuh2dd86a92022-09-14 21:19:23 -07001720 code += " return " +
1721 namer_.LegacyJavaMethod2("create", struct_def, "") + "(\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001722 code += " builder";
1723 for (auto it = struct_def.fields.vec.begin();
1724 it != struct_def.fields.vec.end(); ++it) {
1725 auto &field = **it;
1726 if (field.deprecated) continue;
Austin Schuh2dd86a92022-09-14 21:19:23 -07001727 const auto field_name = namer_.Field(field);
1728 const auto get_field = namer_.Method("get", field);
James Kuszmaul8e62b022022-03-22 09:33:25 -07001729 switch (field.value.type.base_type) {
1730 case BASE_TYPE_STRUCT: {
1731 if (struct_def.fixed) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001732 GenStructPackCall_ObjectAPI(*field.value.type.struct_def, code,
1733 " _" + field_name + "_");
James Kuszmaul8e62b022022-03-22 09:33:25 -07001734 } else {
1735 code += ",\n";
1736 if (field.value.type.struct_def->fixed) {
1737 if (opts.generate_object_based_api)
Austin Schuh2dd86a92022-09-14 21:19:23 -07001738 code += " _o." + field_name;
James Kuszmaul8e62b022022-03-22 09:33:25 -07001739 else
1740 // Seems like unreachable code
1741 code += " " + GenTypeGet(field.value.type) +
Austin Schuh2dd86a92022-09-14 21:19:23 -07001742 ".Pack(builder, _o." + field_name + ")";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001743 } else {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001744 code += " _" + field_name;
James Kuszmaul8e62b022022-03-22 09:33:25 -07001745 }
1746 }
1747 break;
1748 }
1749 case BASE_TYPE_ARRAY: {
1750 if (field.value.type.struct_def != nullptr) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001751 GenStructPackCall_ObjectAPI(*field.value.type.struct_def, code,
1752 " _" + field_name + "_");
James Kuszmaul8e62b022022-03-22 09:33:25 -07001753 } else {
1754 code += ",\n";
Austin Schuh2dd86a92022-09-14 21:19:23 -07001755 code += " _" + field_name;
James Kuszmaul8e62b022022-03-22 09:33:25 -07001756 }
1757 break;
1758 }
1759 case BASE_TYPE_UNION: FLATBUFFERS_FALLTHROUGH(); // fall thru
1760 case BASE_TYPE_UTYPE: FLATBUFFERS_FALLTHROUGH(); // fall thru
1761 case BASE_TYPE_STRING: FLATBUFFERS_FALLTHROUGH(); // fall thru
1762 case BASE_TYPE_VECTOR: {
1763 code += ",\n";
Austin Schuh2dd86a92022-09-14 21:19:23 -07001764 code += " _" + field_name;
James Kuszmaul8e62b022022-03-22 09:33:25 -07001765 break;
1766 }
1767 default: // scalar
1768 code += ",\n";
Austin Schuh2dd86a92022-09-14 21:19:23 -07001769 code += " _o." + get_field + "()";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001770 break;
1771 }
1772 }
1773 code += ");\n";
1774 } else {
1775 // Start, End
Austin Schuh2dd86a92022-09-14 21:19:23 -07001776 code += " " + namer_.LegacyJavaMethod2("start", struct_def, "") +
1777 "(builder);\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001778 for (auto it = struct_def.fields.vec.begin();
1779 it != struct_def.fields.vec.end(); ++it) {
1780 auto &field = **it;
1781 if (field.deprecated) continue;
Austin Schuh2dd86a92022-09-14 21:19:23 -07001782 const auto arg = "_" + namer_.Variable(field);
1783 const auto get_field = namer_.Method("get", field);
1784 const auto add_field = namer_.Method("add", field);
1785
James Kuszmaul8e62b022022-03-22 09:33:25 -07001786 switch (field.value.type.base_type) {
1787 case BASE_TYPE_STRUCT: {
1788 if (field.value.type.struct_def->fixed) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001789 code += " " + add_field + "(builder, " +
James Kuszmaul8e62b022022-03-22 09:33:25 -07001790 GenTypeGet(field.value.type) + ".pack(builder, _o." +
Austin Schuh2dd86a92022-09-14 21:19:23 -07001791 get_field + "()));\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001792 } else {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001793 code += " " + add_field + "(builder, " + arg + ");\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001794 }
1795 break;
1796 }
1797 case BASE_TYPE_STRING: FLATBUFFERS_FALLTHROUGH(); // fall thru
1798 case BASE_TYPE_ARRAY: FLATBUFFERS_FALLTHROUGH(); // fall thru
1799 case BASE_TYPE_VECTOR: {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001800 code += " " + add_field + "(builder, " + arg + ");\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001801 break;
1802 }
1803 case BASE_TYPE_UTYPE: break;
1804 case BASE_TYPE_UNION: {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001805 code += " " + add_field + "Type(builder, " + arg + "Type);\n";
1806 code += " " + add_field + "(builder, " + arg + ");\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001807 break;
1808 }
1809 // scalar
1810 default: {
1811 if (field.IsScalarOptional()) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001812 code += " if (_o." + get_field + "() != null) { " + add_field +
1813 "(builder, _o." + get_field + "()); }\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001814 } else {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001815 code +=
1816 " " + add_field + "(builder, _o." + get_field + "());\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001817 }
1818 break;
1819 }
1820 }
1821 }
Austin Schuh2dd86a92022-09-14 21:19:23 -07001822 code += " return " + namer_.LegacyJavaMethod2("end", struct_def, "") +
1823 "(builder);\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001824 }
1825 code += " }\n";
1826 }
1827
Austin Schuh2dd86a92022-09-14 21:19:23 -07001828 void GenStructPackDecl_ObjectAPI(const StructDef &struct_def,
1829 std::vector<FieldArrayLength> &array_lengths,
1830 std::string &code) const {
James Kuszmaul8e62b022022-03-22 09:33:25 -07001831 for (auto it = struct_def.fields.vec.begin();
1832 it != struct_def.fields.vec.end(); ++it) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001833 const FieldDef &field = **it;
1834 const bool is_array = IsArray(field.value.type);
1835 const Type &field_type =
James Kuszmaul8e62b022022-03-22 09:33:25 -07001836 is_array ? field.value.type.VectorType() : field.value.type;
1837 FieldArrayLength tmp_array_length = {
1838 field.name,
1839 field_type.fixed_length,
1840 };
1841 array_lengths.push_back(tmp_array_length);
1842 if (field_type.struct_def != nullptr) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001843 GenStructPackDecl_ObjectAPI(*field_type.struct_def, array_lengths,
1844 code);
James Kuszmaul8e62b022022-03-22 09:33:25 -07001845 } else {
1846 std::vector<FieldArrayLength> array_only_lengths;
1847 for (size_t i = 0; i < array_lengths.size(); ++i) {
1848 if (array_lengths[i].length > 0) {
1849 array_only_lengths.push_back(array_lengths[i]);
1850 }
1851 }
1852 std::string name;
1853 for (size_t i = 0; i < array_lengths.size(); ++i) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001854 name += "_" + namer_.Variable(array_lengths[i].name);
James Kuszmaul8e62b022022-03-22 09:33:25 -07001855 }
1856 code += " " + GenTypeBasic(field_type);
1857 if (array_only_lengths.size() > 0) {
1858 for (size_t i = 0; i < array_only_lengths.size(); ++i) {
1859 code += "[]";
1860 }
1861 code += " " + name + " = ";
1862 code += "new " + GenTypeBasic(field_type) + "[";
1863 for (size_t i = 0; i < array_only_lengths.size(); ++i) {
1864 if (i != 0) { code += "]["; }
1865 code += NumToString(array_only_lengths[i].length);
1866 }
1867 code += "];\n";
1868 code += " ";
1869 // initialize array
1870 for (size_t i = 0; i < array_only_lengths.size(); ++i) {
1871 auto idx = "idx" + NumToString(i);
1872 code += "for (int " + idx + " = 0; " + idx + " < " +
1873 NumToString(array_only_lengths[i].length) + "; ++" + idx +
1874 ") {";
1875 }
1876 for (size_t i = 0; i < array_only_lengths.size(); ++i) {
1877 auto idx = "idx" + NumToString(i);
1878 if (i == 0) {
1879 code += name + "[" + idx;
1880 } else {
1881 code += "][" + idx;
1882 }
1883 }
1884 code += "] = _o";
1885 for (size_t i = 0, j = 0; i < array_lengths.size(); ++i) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001886 code += "." + namer_.Method("get", array_lengths[i].name) + "()";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001887 if (array_lengths[i].length <= 0) continue;
1888 code += "[idx" + NumToString(j++) + "]";
1889 }
1890 code += ";";
1891 for (size_t i = 0; i < array_only_lengths.size(); ++i) {
1892 code += "}";
1893 }
1894 } else {
1895 code += " " + name + " = ";
James Kuszmaul3b15b0c2022-11-08 14:03:16 -08001896 code += SourceCast(field_type);
James Kuszmaul8e62b022022-03-22 09:33:25 -07001897 code += "_o";
1898 for (size_t i = 0; i < array_lengths.size(); ++i) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001899 code += "." + namer_.Method("get", array_lengths[i].name) + "()";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001900 }
1901 code += ";";
1902 }
1903 code += "\n";
1904 }
1905 array_lengths.pop_back();
1906 }
1907 }
1908
1909 void GenStructPackCall_ObjectAPI(const StructDef &struct_def,
Austin Schuh2dd86a92022-09-14 21:19:23 -07001910 std::string &code,
James Kuszmaul8e62b022022-03-22 09:33:25 -07001911 std::string prefix) const {
James Kuszmaul8e62b022022-03-22 09:33:25 -07001912 for (auto it = struct_def.fields.vec.begin();
1913 it != struct_def.fields.vec.end(); ++it) {
1914 auto &field = **it;
1915 const auto &field_type = field.value.type;
1916 if (field_type.struct_def != nullptr) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001917 GenStructPackCall_ObjectAPI(*field_type.struct_def, code,
1918 prefix + namer_.Field(field) + "_");
James Kuszmaul8e62b022022-03-22 09:33:25 -07001919 } else {
1920 code += ",\n";
Austin Schuh2dd86a92022-09-14 21:19:23 -07001921 code += prefix + namer_.Field(field);
James Kuszmaul8e62b022022-03-22 09:33:25 -07001922 }
1923 }
1924 }
1925
1926 std::string ConvertPrimitiveTypeToObjectWrapper_ObjectAPI(
Austin Schuh2dd86a92022-09-14 21:19:23 -07001927 const std::string &type_name) const {
James Kuszmaul8e62b022022-03-22 09:33:25 -07001928 if (type_name == "boolean")
1929 return "Boolean";
1930 else if (type_name == "byte")
1931 return "Byte";
1932 else if (type_name == "char")
1933 return "Character";
1934 else if (type_name == "short")
1935 return "Short";
1936 else if (type_name == "int")
1937 return "Integer";
1938 else if (type_name == "long")
1939 return "Long";
1940 else if (type_name == "float")
1941 return "Float";
1942 else if (type_name == "double")
1943 return "Double";
1944 return type_name;
1945 }
1946
Austin Schuh2dd86a92022-09-14 21:19:23 -07001947 std::string GenTypeGet_ObjectAPI(const flatbuffers::Type &type,
1948 bool vectorelem,
James Kuszmaul8e62b022022-03-22 09:33:25 -07001949 bool wrap_in_namespace) const {
1950 auto type_name = GenTypeNameDest(type);
1951 // Replace to ObjectBaseAPI Type Name
1952 switch (type.base_type) {
1953 case BASE_TYPE_STRUCT: FLATBUFFERS_FALLTHROUGH(); // fall thru
1954 case BASE_TYPE_ARRAY: FLATBUFFERS_FALLTHROUGH(); // fall thru
1955 case BASE_TYPE_VECTOR: {
1956 if (type.struct_def != nullptr) {
1957 auto type_name_length = type.struct_def->name.length();
Austin Schuh2dd86a92022-09-14 21:19:23 -07001958 auto new_type_name = namer_.ObjectType(*type.struct_def);
James Kuszmaul8e62b022022-03-22 09:33:25 -07001959 type_name.replace(type_name.length() - type_name_length,
1960 type_name_length, new_type_name);
1961 } else if (type.element == BASE_TYPE_UNION) {
1962 if (wrap_in_namespace) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001963 type_name = namer_.NamespacedType(*type.enum_def) + "Union";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001964 } else {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001965 type_name = namer_.Type(*type.enum_def) + "Union";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001966 }
1967 }
1968 break;
1969 }
1970
1971 case BASE_TYPE_UNION: {
1972 if (wrap_in_namespace) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001973 type_name = namer_.NamespacedType(*type.enum_def) + "Union";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001974 } else {
Austin Schuh2dd86a92022-09-14 21:19:23 -07001975 type_name = namer_.Type(*type.enum_def) + "Union";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001976 }
1977 break;
1978 }
1979 default: break;
1980 }
1981 if (vectorelem) { return type_name; }
1982 switch (type.base_type) {
1983 case BASE_TYPE_ARRAY: FLATBUFFERS_FALLTHROUGH(); // fall thru
1984 case BASE_TYPE_VECTOR: {
1985 type_name = type_name + "[]";
1986 break;
1987 }
1988 default: break;
1989 }
1990 return type_name;
1991 }
1992
Austin Schuh2dd86a92022-09-14 21:19:23 -07001993 std::string GenConcreteTypeGet_ObjectAPI(
1994 const flatbuffers::Type &type) const {
James Kuszmaul8e62b022022-03-22 09:33:25 -07001995 auto type_name = GenTypeNameDest(type);
1996 // Replace to ObjectBaseAPI Type Name
1997 switch (type.base_type) {
1998 case BASE_TYPE_STRUCT: FLATBUFFERS_FALLTHROUGH(); // fall thru
1999 case BASE_TYPE_ARRAY: FLATBUFFERS_FALLTHROUGH(); // fall thru
2000 case BASE_TYPE_VECTOR: {
2001 if (type.struct_def != nullptr) {
2002 auto type_name_length = type.struct_def->name.length();
Austin Schuh2dd86a92022-09-14 21:19:23 -07002003 auto new_type_name = namer_.ObjectType(*type.struct_def);
James Kuszmaul8e62b022022-03-22 09:33:25 -07002004 type_name.replace(type_name.length() - type_name_length,
2005 type_name_length, new_type_name);
2006 } else if (type.element == BASE_TYPE_UNION) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07002007 type_name = namer_.NamespacedType(*type.enum_def) + "Union";
James Kuszmaul8e62b022022-03-22 09:33:25 -07002008 }
2009 break;
2010 }
2011
2012 case BASE_TYPE_UNION: {
Austin Schuh2dd86a92022-09-14 21:19:23 -07002013 type_name = namer_.NamespacedType(*type.enum_def) + "Union";
James Kuszmaul8e62b022022-03-22 09:33:25 -07002014 break;
2015 }
2016 default: break;
2017 }
2018
2019 switch (type.base_type) {
2020 case BASE_TYPE_ARRAY: FLATBUFFERS_FALLTHROUGH(); // fall thru
2021 case BASE_TYPE_VECTOR: {
2022 type_name = type_name + "[]";
2023 break;
2024 }
2025 default: break;
2026 }
2027 return type_name;
2028 }
2029
Austin Schuh2dd86a92022-09-14 21:19:23 -07002030 void GenStruct_ObjectAPI(const StructDef &struct_def,
2031 std::string &code) const {
James Kuszmaul8e62b022022-03-22 09:33:25 -07002032 if (struct_def.generated) return;
James Kuszmaul8e62b022022-03-22 09:33:25 -07002033 if (struct_def.attributes.Lookup("private")) {
2034 // For Java, we leave the enum unmarked to indicate package-private
2035 } else {
2036 code += "public ";
2037 }
2038
Austin Schuh2dd86a92022-09-14 21:19:23 -07002039 const auto class_name = namer_.ObjectType(struct_def);
James Kuszmaul8e62b022022-03-22 09:33:25 -07002040 code += "class " + class_name;
2041 code += " {\n";
2042 // Generate Properties
2043 for (auto it = struct_def.fields.vec.begin();
2044 it != struct_def.fields.vec.end(); ++it) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07002045 const auto &field = **it;
James Kuszmaul8e62b022022-03-22 09:33:25 -07002046 if (field.deprecated) continue;
2047 if (field.value.type.base_type == BASE_TYPE_UTYPE) continue;
2048 if (field.value.type.element == BASE_TYPE_UTYPE) continue;
Austin Schuh2dd86a92022-09-14 21:19:23 -07002049 auto type_name = GenTypeGet_ObjectAPI(field.value.type, false, true);
James Kuszmaul8e62b022022-03-22 09:33:25 -07002050 if (field.IsScalarOptional())
2051 type_name = ConvertPrimitiveTypeToObjectWrapper_ObjectAPI(type_name);
Austin Schuh2dd86a92022-09-14 21:19:23 -07002052 const auto field_name = namer_.Field(field);
2053 code += " private " + type_name + " " + field_name + ";\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07002054 }
2055 // Generate Java getters and setters
2056 code += "\n";
2057 for (auto it = struct_def.fields.vec.begin();
2058 it != struct_def.fields.vec.end(); ++it) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07002059 const auto &field = **it;
James Kuszmaul8e62b022022-03-22 09:33:25 -07002060 if (field.deprecated) continue;
2061 if (field.value.type.base_type == BASE_TYPE_UTYPE) continue;
2062 if (field.value.type.element == BASE_TYPE_UTYPE) continue;
Austin Schuh2dd86a92022-09-14 21:19:23 -07002063 const auto field_name = namer_.Field(field);
2064 const auto get_field = namer_.Method("get", field);
2065 auto type_name = GenTypeGet_ObjectAPI(field.value.type, false, true);
James Kuszmaul8e62b022022-03-22 09:33:25 -07002066 if (field.IsScalarOptional())
2067 type_name = ConvertPrimitiveTypeToObjectWrapper_ObjectAPI(type_name);
Austin Schuh2dd86a92022-09-14 21:19:23 -07002068
2069 code += " public " + type_name + " " + get_field + "() { return " +
2070 field_name + "; }\n\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07002071 std::string array_validation = "";
2072 if (field.value.type.base_type == BASE_TYPE_ARRAY) {
2073 array_validation =
Austin Schuh2dd86a92022-09-14 21:19:23 -07002074 "if (" + field_name + " != null && " + field_name +
James Kuszmaul8e62b022022-03-22 09:33:25 -07002075 ".length == " + NumToString(field.value.type.fixed_length) + ") ";
2076 }
Austin Schuh2dd86a92022-09-14 21:19:23 -07002077 code += " public void " + namer_.Method("set", field) + "(" + type_name +
2078 " " + field_name + ") { " + array_validation + "this." +
2079 field_name + " = " + field_name + "; }\n\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07002080 }
2081 // Generate Constructor
2082 code += "\n";
2083 code += " public " + class_name + "() {\n";
2084 for (auto it = struct_def.fields.vec.begin();
2085 it != struct_def.fields.vec.end(); ++it) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07002086 const auto &field = **it;
James Kuszmaul8e62b022022-03-22 09:33:25 -07002087 if (field.deprecated) continue;
2088 if (field.value.type.base_type == BASE_TYPE_UTYPE) continue;
2089 if (field.value.type.element == BASE_TYPE_UTYPE) continue;
Austin Schuh2dd86a92022-09-14 21:19:23 -07002090 const auto get_field = namer_.Method("get", field);
2091
2092 code += " this." + namer_.Field(field) + " = ";
2093 const auto type_name =
2094 GenTypeGet_ObjectAPI(field.value.type, false, true);
James Kuszmaul8e62b022022-03-22 09:33:25 -07002095 if (IsScalar(field.value.type.base_type)) {
2096 if (field.IsScalarOptional()) {
2097 code += "null;\n";
2098 } else {
2099 code += GenDefaultValue(field) + ";\n";
2100 }
2101 } else {
2102 switch (field.value.type.base_type) {
2103 case BASE_TYPE_STRUCT: {
2104 if (IsStruct(field.value.type)) {
2105 code += "new " + type_name + "();\n";
2106 } else {
2107 code += "null;\n";
2108 }
2109 break;
2110 }
2111 case BASE_TYPE_ARRAY: {
2112 code += "new " + type_name.substr(0, type_name.length() - 1) +
2113 NumToString(field.value.type.fixed_length) + "];\n";
2114 break;
2115 }
2116 default: {
2117 code += "null;\n";
2118 break;
2119 }
2120 }
2121 }
2122 }
2123 code += " }\n";
2124 if (parser_.root_struct_def_ == &struct_def) {
Austin Schuh2dd86a92022-09-14 21:19:23 -07002125 const std::string struct_type = namer_.Type(struct_def);
James Kuszmaul8e62b022022-03-22 09:33:25 -07002126 code += " public static " + class_name +
2127 " deserializeFromBinary(byte[] fbBuffer) {\n";
Austin Schuh2dd86a92022-09-14 21:19:23 -07002128 code += " return " + struct_type + "." +
2129 namer_.LegacyJavaMethod2("getRootAs", struct_def, "") +
James Kuszmaul8e62b022022-03-22 09:33:25 -07002130 "(ByteBuffer.wrap(fbBuffer)).unpack();\n";
2131 code += " }\n";
2132 code += " public byte[] serializeToBinary() {\n";
2133 code += " FlatBufferBuilder fbb = new FlatBufferBuilder();\n";
Austin Schuh2dd86a92022-09-14 21:19:23 -07002134 code += " " + struct_type + "." +
2135 namer_.LegacyJavaMethod2("finish", struct_def, "Buffer") +
2136 "(fbb, " + struct_type + ".pack(fbb, this));\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -07002137 code += " return fbb.sizedByteArray();\n";
2138 code += " }\n";
2139 }
2140 code += "}\n\n";
2141 }
2142
Austin Schuh272c6132020-11-14 16:37:52 -08002143 // This tracks the current namespace used to determine if a type need to be
2144 // prefixed by its namespace
2145 const Namespace *cur_name_space_;
Austin Schuh2dd86a92022-09-14 21:19:23 -07002146 const IdlNamer namer_;
Austin Schuh272c6132020-11-14 16:37:52 -08002147};
2148} // namespace java
2149
2150bool GenerateJava(const Parser &parser, const std::string &path,
2151 const std::string &file_name) {
2152 java::JavaGenerator generator(parser, path, file_name);
2153 return generator.generate();
2154}
2155
2156} // namespace flatbuffers