1/*
2 * Copyright 2014 Google Inc. All rights reserved.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17// 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"
23
24namespace flatbuffers {
25namespace java {
26
27static TypedFloatConstantGenerator JavaFloatGen("Double.", "Float.", "NaN",
28 "POSITIVE_INFINITY",
29 "NEGATIVE_INFINITY");
30
31static CommentConfig comment_config = {
32 "/**",
33 " *",
34 " */",
35};
36
37class JavaGenerator : public BaseGenerator {
38 struct FieldArrayLength {
39 std::string name;
40 int length;
41 };
42
43 public:
44 JavaGenerator(const Parser &parser, const std::string &path,
45 const std::string &file_name)
46 : BaseGenerator(parser, path, file_name, "", ".", "java"),
47 cur_name_space_(nullptr) {}
48
49 JavaGenerator &operator=(const JavaGenerator &);
50 bool generate() {
51 std::string one_file_code;
52 cur_name_space_ = parser_.current_namespace_;
53
54 for (auto it = parser_.enums_.vec.begin(); it != parser_.enums_.vec.end();
55 ++it) {
56 std::string enumcode;
57 auto &enum_def = **it;
58 if (!parser_.opts.one_file) cur_name_space_ = enum_def.defined_namespace;
59 GenEnum(enum_def, &enumcode);
60 if (parser_.opts.one_file) {
61 one_file_code += enumcode;
62 } else {
63 if (!SaveType(enum_def.name, *enum_def.defined_namespace, enumcode,
64 /* needs_includes= */ false))
65 return false;
66 }
67
68 if (parser_.opts.generate_object_based_api && enum_def.is_union) {
69 enumcode = "";
70 GenEnum_ObjectAPI(enum_def, &enumcode, parser_.opts);
71 auto class_name = enum_def.name + "Union";
72 if (parser_.opts.one_file) {
73 one_file_code += enumcode;
74 } else {
75 if (!SaveType(class_name, *enum_def.defined_namespace, enumcode,
76 /* needs_includes= */ false))
77 return false;
78 }
79 }
80 }
81
82 for (auto it = parser_.structs_.vec.begin();
83 it != parser_.structs_.vec.end(); ++it) {
84 std::string declcode;
85 auto &struct_def = **it;
86 if (!parser_.opts.one_file)
87 cur_name_space_ = struct_def.defined_namespace;
88 GenStruct(struct_def, &declcode, parser_.opts);
89 if (parser_.opts.one_file) {
90 one_file_code += declcode;
91 } else {
92 if (!SaveType(struct_def.name, *struct_def.defined_namespace, declcode,
93 /* needs_includes= */ true))
94 return false;
95 }
96
97 if (parser_.opts.generate_object_based_api) {
98 declcode = "";
99 GenStruct_ObjectAPI(struct_def, &declcode, parser_.opts);
100 auto class_name = GenTypeName_ObjectAPI(struct_def.name, parser_.opts);
101 if (parser_.opts.one_file) {
102 one_file_code += declcode;
103 } else {
104 if (!SaveType(class_name, *struct_def.defined_namespace, declcode,
105 /* needs_includes= */ true))
106 return false;
107 }
108 }
109 }
110
111 if (parser_.opts.one_file) {
112 return SaveType(file_name_, *parser_.current_namespace_, one_file_code,
113 /* needs_includes= */ true);
114 }
115 return true;
116 }
117
118 // Save out the generated code for a single class while adding
119 // declaration boilerplate.
120 bool SaveType(const std::string &defname, const Namespace &ns,
121 const std::string &classcode, bool needs_includes) const {
122 if (!classcode.length()) return true;
123
124 std::string code;
125 code = "// " + std::string(FlatBuffersGeneratedWarning()) + "\n\n";
126
127 std::string namespace_name = FullNamespace(".", ns);
128 if (!namespace_name.empty()) {
129 code += "package " + namespace_name + ";";
130 code += "\n\n";
131 }
132 if (needs_includes) {
133 code +=
134 "import java.nio.*;\nimport java.lang.*;\nimport "
135 "java.util.*;\nimport com.google.flatbuffers.*;\n";
136 if (parser_.opts.gen_nullable) {
137 code += "\nimport javax.annotation.Nullable;\n";
138 }
139 if (parser_.opts.java_checkerframework) {
140 code += "\nimport org.checkerframework.dataflow.qual.Pure;\n";
141 }
142 code += "\n";
143 }
144
145 code += classcode;
146 if (!namespace_name.empty()) code += "";
147 auto filename = NamespaceDir(ns) + defname + ".java";
148 return SaveFile(filename.c_str(), code, false);
149 }
150
151 const Namespace *CurrentNameSpace() const { return cur_name_space_; }
152
153 std::string GenNullableAnnotation(const Type &t) const {
154 return parser_.opts.gen_nullable &&
155 !IsScalar(DestinationType(t, true).base_type) &&
156 t.base_type != BASE_TYPE_VECTOR
157 ? " @Nullable "
158 : "";
159 }
160
161 std::string GenPureAnnotation(const Type &t) const {
162 return parser_.opts.java_checkerframework &&
163 !IsScalar(DestinationType(t, true).base_type)
164 ? " @Pure "
165 : "";
166 }
167
168 std::string GenTypeBasic(const Type &type) const {
169 // clang-format off
170 static const char * const java_typename[] = {
171 #define FLATBUFFERS_TD(ENUM, IDLTYPE, CTYPE, JTYPE, ...) \
172 #JTYPE,
173 FLATBUFFERS_GEN_TYPES(FLATBUFFERS_TD)
174 #undef FLATBUFFERS_TD
175 };
176 // clang-format on
177 return java_typename[type.base_type];
178 }
179
180 std::string GenTypePointer(const Type &type) const {
181 switch (type.base_type) {
182 case BASE_TYPE_STRING: return "String";
183 case BASE_TYPE_VECTOR: return GenTypeGet(type.VectorType());
184 case BASE_TYPE_STRUCT: return WrapInNameSpace(*type.struct_def);
185 case BASE_TYPE_UNION: FLATBUFFERS_FALLTHROUGH(); // else fall thru
186 default: return "Table";
187 }
188 }
189
190 std::string GenTypeGet(const Type &type) const {
191 return IsScalar(type.base_type)
192 ? GenTypeBasic(type)
193 : (IsArray(type) ? GenTypeGet(type.VectorType())
194 : GenTypePointer(type));
195 }
196
197 // Find the destination type the user wants to receive the value in (e.g.
198 // one size higher signed types for unsigned serialized values in Java).
199 Type DestinationType(const Type &type, bool vectorelem) const {
200 switch (type.base_type) {
201 // We use int for both uchar/ushort, since that generally means less
202 // casting than using short for uchar.
203 case BASE_TYPE_UCHAR: return Type(BASE_TYPE_INT);
204 case BASE_TYPE_USHORT: return Type(BASE_TYPE_INT);
205 case BASE_TYPE_UINT: return Type(BASE_TYPE_LONG);
206 case BASE_TYPE_ARRAY:
207 case BASE_TYPE_VECTOR:
208 if (vectorelem) return DestinationType(type.VectorType(), vectorelem);
209 FLATBUFFERS_FALLTHROUGH(); // else fall thru
210 default: return type;
211 }
212 }
213
214 std::string GenOffsetType() const { return "int"; }
215
216 std::string GenOffsetConstruct(const std::string &variable_name) const {
217 return variable_name;
218 }
219
220 std::string GenVectorOffsetType() const { return "int"; }
221
222 // Generate destination type name
223 std::string GenTypeNameDest(const Type &type) const {
224 return GenTypeGet(DestinationType(type, true));
225 }
226
227 // Mask to turn serialized value into destination type value.
228 std::string DestinationMask(const Type &type, bool vectorelem) const {
229 switch (type.base_type) {
230 case BASE_TYPE_UCHAR: return " & 0xFF";
231 case BASE_TYPE_USHORT: return " & 0xFFFF";
232 case BASE_TYPE_UINT: return " & 0xFFFFFFFFL";
233 case BASE_TYPE_VECTOR:
234 if (vectorelem) return DestinationMask(type.VectorType(), vectorelem);
235 FLATBUFFERS_FALLTHROUGH(); // else fall thru
236 default: return "";
237 }
238 }
239
240 // Casts necessary to correctly read serialized data
241 std::string DestinationCast(const Type &type) const {
242 if (IsSeries(type)) {
243 return DestinationCast(type.VectorType());
244 } else {
245 // Cast necessary to correctly read serialized unsigned values.
246 if (type.base_type == BASE_TYPE_UINT) return "(long)";
247 }
248 return "";
249 }
250
251 // Cast statements for mutator method parameters.
252 // In Java, parameters representing unsigned numbers need to be cast down to
253 // their respective type. For example, a long holding an unsigned int value
254 // would be cast down to int before being put onto the buffer.
255 std::string SourceCast(const Type &type, bool castFromDest) const {
256 if (IsSeries(type)) {
257 return SourceCast(type.VectorType(), castFromDest);
258 } else {
259 if (castFromDest) {
260 if (type.base_type == BASE_TYPE_UINT)
261 return "(int) ";
262 else if (type.base_type == BASE_TYPE_USHORT)
263 return "(short) ";
264 else if (type.base_type == BASE_TYPE_UCHAR)
265 return "(byte) ";
266 }
267 }
268 return "";
269 }
270
271 std::string SourceCast(const Type &type) const {
272 return SourceCast(type, true);
273 }
274
275 std::string SourceCastBasic(const Type &type, bool castFromDest) const {
276 return IsScalar(type.base_type) ? SourceCast(type, castFromDest) : "";
277 }
278
279 std::string SourceCastBasic(const Type &type) const {
280 return SourceCastBasic(type, true);
281 }
282
283 std::string GenEnumDefaultValue(const FieldDef &field) const {
284 auto &value = field.value;
285 FLATBUFFERS_ASSERT(value.type.enum_def);
286 auto &enum_def = *value.type.enum_def;
287 auto enum_val = enum_def.FindByValue(value.constant);
288 return enum_val ? (WrapInNameSpace(enum_def) + "." + enum_val->name)
289 : value.constant;
290 }
291
292 std::string GenDefaultValue(const FieldDef &field) const {
293 auto &value = field.value;
294 auto constant = field.IsScalarOptional() ? "0" : value.constant;
295 auto longSuffix = "L";
296 switch (value.type.base_type) {
297 case BASE_TYPE_BOOL: return constant == "0" ? "false" : "true";
298 case BASE_TYPE_ULONG: {
299 // Converts the ulong into its bits signed equivalent
300 uint64_t defaultValue = StringToUInt(constant.c_str());
301 return NumToString(static_cast<int64_t>(defaultValue)) + longSuffix;
302 }
303 case BASE_TYPE_UINT:
304 case BASE_TYPE_LONG: return constant + longSuffix;
305 default:
306 if (IsFloat(value.type.base_type)) {
307 if (field.IsScalarOptional()) {
308 return value.type.base_type == BASE_TYPE_DOUBLE ? "0.0" : "0f";
309 }
310 return JavaFloatGen.GenFloatConstant(field);
311 } else {
312 return constant;
313 }
314 }
315 }
316
317 std::string GenDefaultValueBasic(const FieldDef &field) const {
318 auto &value = field.value;
319 if (!IsScalar(value.type.base_type)) { return "0"; }
320 return GenDefaultValue(field);
321 }
322
323 void GenEnum(EnumDef &enum_def, std::string *code_ptr) const {
324 std::string &code = *code_ptr;
325 if (enum_def.generated) return;
326
327 // Generate enum definitions of the form:
328 // public static (final) int name = value;
329 // In Java, we use ints rather than the Enum feature, because we want them
330 // to map directly to how they're used in C/C++ and file formats.
331 // That, and Java Enums are expensive, and not universally liked.
332 GenComment(enum_def.doc_comment, code_ptr, &comment_config);
333
334 code += "@SuppressWarnings(\"unused\")\n";
335 if (enum_def.attributes.Lookup("private")) {
336 // For Java, we leave the enum unmarked to indicate package-private
337 } else {
338 code += "public ";
339 }
340 code += "final class " + enum_def.name;
341 code += " {\n";
342 code += " private " + enum_def.name + "() { }\n";
343 for (auto it = enum_def.Vals().begin(); it != enum_def.Vals().end(); ++it) {
344 auto &ev = **it;
345 GenComment(ev.doc_comment, code_ptr, &comment_config, " ");
346 code += " public static final ";
347 code += GenTypeBasic(DestinationType(enum_def.underlying_type, false));
348 code += " ";
349 code += ev.name + " = ";
350 code += enum_def.ToString(ev);
351 code += ";\n";
352 }
353
354 // Generate a string table for enum values.
355 // Problem is, if values are very sparse that could generate really big
356 // tables. Ideally in that case we generate a map lookup instead, but for
357 // the moment we simply don't output a table at all.
358 auto range = enum_def.Distance();
359 // Average distance between values above which we consider a table
360 // "too sparse". Change at will.
361 static const uint64_t kMaxSparseness = 5;
362 if (range / static_cast<uint64_t>(enum_def.size()) < kMaxSparseness &&
363 GenTypeBasic(DestinationType(enum_def.underlying_type, false)) !=
364 "long") {
365 code += "\n public static final String";
366 code += "[] names = { ";
367 auto val = enum_def.Vals().front();
368 for (auto it = enum_def.Vals().begin(); it != enum_def.Vals().end();
369 ++it) {
370 auto ev = *it;
371 for (auto k = enum_def.Distance(val, ev); k > 1; --k) code += "\"\", ";
372 val = ev;
373 code += "\"" + (*it)->name + "\", ";
374 }
375 code += "};\n\n";
376 code += " public static ";
377 code += "String";
378 code += " " + MakeCamel("name", false);
379 code += "(int e) { return names[e";
380 if (enum_def.MinValue()->IsNonZero())
381 code += " - " + enum_def.MinValue()->name;
382 code += "]; }\n";
383 }
384
385 // Close the class
386 code += "}\n\n";
387 }
388
389 // Returns the function name that is able to read a value of the given type.
390 std::string GenGetter(const Type &type) const {
391 switch (type.base_type) {
392 case BASE_TYPE_STRING: return "__string";
393 case BASE_TYPE_STRUCT: return "__struct";
394 case BASE_TYPE_UNION: return "__union";
395 case BASE_TYPE_VECTOR: return GenGetter(type.VectorType());
396 case BASE_TYPE_ARRAY: return GenGetter(type.VectorType());
397 default: {
398 std::string getter = "bb.get";
399 if (type.base_type == BASE_TYPE_BOOL) {
400 getter = "0!=" + getter;
401 } else if (GenTypeBasic(type) != "byte") {
402 getter += MakeCamel(GenTypeBasic(type));
403 }
404 return getter;
405 }
406 }
407 }
408
409 // Returns the function name that is able to read a value of the given type.
410 std::string GenGetterForLookupByKey(flatbuffers::FieldDef *key_field,
411 const std::string &data_buffer,
412 const char *num = nullptr) const {
413 auto type = key_field->value.type;
414 auto dest_mask = DestinationMask(type, true);
415 auto dest_cast = DestinationCast(type);
416 auto getter = data_buffer + ".get";
417 if (GenTypeBasic(type) != "byte") {
418 getter += MakeCamel(GenTypeBasic(type));
419 }
420 getter = dest_cast + getter + "(" + GenOffsetGetter(key_field, num) + ")" +
421 dest_mask;
422 return getter;
423 }
424
425 // Direct mutation is only allowed for scalar fields.
426 // Hence a setter method will only be generated for such fields.
427 std::string GenSetter(const Type &type) const {
428 if (IsScalar(type.base_type)) {
429 std::string setter = "bb.put";
430 if (GenTypeBasic(type) != "byte" && type.base_type != BASE_TYPE_BOOL) {
431 setter += MakeCamel(GenTypeBasic(type));
432 }
433 return setter;
434 } else {
435 return "";
436 }
437 }
438
439 // Returns the method name for use with add/put calls.
440 std::string GenMethod(const Type &type) const {
441 return IsScalar(type.base_type) ? MakeCamel(GenTypeBasic(type))
442 : (IsStruct(type) ? "Struct" : "Offset");
443 }
444
445 // Recursively generate arguments for a constructor, to deal with nested
446 // structs.
447 void GenStructArgs(const StructDef &struct_def, std::string *code_ptr,
448 const char *nameprefix, size_t array_count = 0) const {
449 std::string &code = *code_ptr;
450 for (auto it = struct_def.fields.vec.begin();
451 it != struct_def.fields.vec.end(); ++it) {
452 auto &field = **it;
453 const auto &field_type = field.value.type;
454 const auto array_field = IsArray(field_type);
455 const auto &type = array_field ? field_type.VectorType()
456 : DestinationType(field_type, false);
457 const auto array_cnt = array_field ? (array_count + 1) : array_count;
458 if (IsStruct(type)) {
459 // Generate arguments for a struct inside a struct. To ensure names
460 // don't clash, and to make it obvious these arguments are constructing
461 // a nested struct, prefix the name with the field name.
462 GenStructArgs(*field_type.struct_def, code_ptr,
463 (nameprefix + (field.name + "_")).c_str(), array_cnt);
464 } else {
465 code += ", ";
466 code += GenTypeNameDest(field.value.type);
467 for (size_t i = 0; i < array_cnt; i++) code += "[]";
468 code += " ";
469 code += nameprefix;
470 code += MakeCamel(field.name, false);
471 }
472 }
473 }
474
475 // Recusively generate struct construction statements of the form:
476 // builder.putType(name);
477 // and insert manual padding.
478 void GenStructBody(const StructDef &struct_def, std::string *code_ptr,
479 const char *nameprefix, size_t index = 0,
480 bool in_array = false) const {
481 std::string &code = *code_ptr;
482 std::string indent((index + 1) * 2, ' ');
483 code += indent + " builder.prep(";
484 code += NumToString(struct_def.minalign) + ", ";
485 code += NumToString(struct_def.bytesize) + ");\n";
486 for (auto it = struct_def.fields.vec.rbegin();
487 it != struct_def.fields.vec.rend(); ++it) {
488 auto &field = **it;
489 const auto &field_type = field.value.type;
490 if (field.padding) {
491 code += indent + " builder.pad(";
492 code += NumToString(field.padding) + ");\n";
493 }
494 if (IsStruct(field_type)) {
495 GenStructBody(*field_type.struct_def, code_ptr,
496 (nameprefix + (field.name + "_")).c_str(), index,
497 in_array);
498 } else {
499 const auto &type =
500 IsArray(field_type) ? field_type.VectorType() : field_type;
501 const auto index_var = "_idx" + NumToString(index);
502 if (IsArray(field_type)) {
503 code += indent + " for (int " + index_var + " = ";
504 code += NumToString(field_type.fixed_length);
505 code += "; " + index_var + " > 0; " + index_var + "--) {\n";
506 in_array = true;
507 }
508 if (IsStruct(type)) {
509 GenStructBody(*field_type.struct_def, code_ptr,
510 (nameprefix + (field.name + "_")).c_str(), index + 1,
511 in_array);
512 } else {
513 code += IsArray(field_type) ? " " : "";
514 code += indent + " builder.put";
515 code += GenMethod(type) + "(";
516 code += SourceCast(type);
517 auto argname = nameprefix + MakeCamel(field.name, false);
518 code += argname;
519 size_t array_cnt = index + (IsArray(field_type) ? 1 : 0);
520 for (size_t i = 0; in_array && i < array_cnt; i++) {
521 code += "[_idx" + NumToString(i) + "-1]";
522 }
523 code += ");\n";
524 }
525 if (IsArray(field_type)) { code += indent + " }\n"; }
526 }
527 }
528 }
529
530 std::string GenByteBufferLength(const char *bb_name) const {
531 std::string bb_len = bb_name;
532 bb_len += ".capacity()";
533 return bb_len;
534 }
535
536 std::string GenOffsetGetter(flatbuffers::FieldDef *key_field,
537 const char *num = nullptr) const {
538 std::string key_offset = "";
539 key_offset += "__offset(" + NumToString(key_field->value.offset) + ", ";
540 if (num) {
541 key_offset += num;
542 key_offset += ", _bb)";
543 } else {
544 key_offset += GenByteBufferLength("bb");
545 key_offset += " - tableOffset, bb)";
546 }
547 return key_offset;
548 }
549
550 std::string GenLookupKeyGetter(flatbuffers::FieldDef *key_field) const {
551 std::string key_getter = " ";
552 key_getter += "int tableOffset = ";
553 key_getter += "__indirect(vectorLocation + 4 * (start + middle)";
554 key_getter += ", bb);\n ";
555 if (IsString(key_field->value.type)) {
556 key_getter += "int comp = ";
557 key_getter += "compareStrings(";
558 key_getter += GenOffsetGetter(key_field);
559 key_getter += ", byteKey, bb);\n";
560 } else {
561 auto get_val = GenGetterForLookupByKey(key_field, "bb");
562 key_getter += GenTypeNameDest(key_field->value.type) + " val = ";
563 key_getter += get_val + ";\n";
564 key_getter += " int comp = val > key ? 1 : val < key ? -1 : 0;\n";
565 }
566 return key_getter;
567 }
568
569 std::string GenKeyGetter(flatbuffers::FieldDef *key_field) const {
570 std::string key_getter = "";
571 auto data_buffer = "_bb";
572 if (IsString(key_field->value.type)) {
573 key_getter += " return ";
574 key_getter += "";
575 key_getter += "compareStrings(";
576 key_getter += GenOffsetGetter(key_field, "o1") + ", ";
577 key_getter += GenOffsetGetter(key_field, "o2") + ", " + data_buffer + ")";
578 key_getter += ";";
579 } else {
580 auto field_getter = GenGetterForLookupByKey(key_field, data_buffer, "o1");
581 key_getter +=
582 "\n " + GenTypeNameDest(key_field->value.type) + " val_1 = ";
583 key_getter +=
584 field_getter + ";\n " + GenTypeNameDest(key_field->value.type);
585 key_getter += " val_2 = ";
586 field_getter = GenGetterForLookupByKey(key_field, data_buffer, "o2");
587 key_getter += field_getter + ";\n";
588 key_getter += " return val_1 > val_2 ? 1 : val_1 < val_2 ? -1 : 0;\n ";
589 }
590 return key_getter;
591 }
592
593 void GenStruct(StructDef &struct_def, std::string *code_ptr,
594 const IDLOptions &opts) const {
595 if (struct_def.generated) return;
596 std::string &code = *code_ptr;
597
598 // Generate a struct accessor class, with methods of the form:
599 // public type name() { return bb.getType(i + offset); }
600 // or for tables of the form:
601 // public type name() {
602 // int o = __offset(offset); return o != 0 ? bb.getType(o + i) : default;
603 // }
604 GenComment(struct_def.doc_comment, code_ptr, &comment_config);
605
606 if (parser_.opts.gen_generated) {
607 code += "@javax.annotation.Generated(value=\"flatc\")\n";
608 }
609 code += "@SuppressWarnings(\"unused\")\n";
610 if (struct_def.attributes.Lookup("private")) {
611 // For Java, we leave the struct unmarked to indicate package-private
612 } else {
613 code += "public ";
614 }
615 code += "final class " + struct_def.name;
616 code += " extends ";
617 code += struct_def.fixed ? "Struct" : "Table";
618 code += " {\n";
619
620 if (!struct_def.fixed) {
621 // Generate verson check method.
622 // Force compile time error if not using the same version runtime.
623 code += " public static void ValidateVersion() {";
624 code += " Constants.";
625 code += "FLATBUFFERS_2_0_0(); ";
626 code += "}\n";
627
628 // Generate a special accessor for the table that when used as the root
629 // of a FlatBuffer
630 std::string method_name = "getRootAs" + struct_def.name;
631 std::string method_signature =
632 " public static " + struct_def.name + " " + method_name;
633
634 // create convenience method that doesn't require an existing object
635 code += method_signature + "(ByteBuffer _bb) ";
636 code += "{ return " + method_name + "(_bb, new " + struct_def.name +
637 "()); }\n";
638
639 // create method that allows object reuse
640 code +=
641 method_signature + "(ByteBuffer _bb, " + struct_def.name + " obj) { ";
642 code += "_bb.order(ByteOrder.LITTLE_ENDIAN); ";
643 code += "return (obj.__assign(_bb.getInt(_bb.";
644 code += "position()";
645 code += ") + _bb.";
646 code += "position()";
647 code += ", _bb)); }\n";
648 if (parser_.root_struct_def_ == &struct_def) {
649 if (parser_.file_identifier_.length()) {
650 // Check if a buffer has the identifier.
651 code += " public static ";
652 code += "boolean " + struct_def.name;
653 code += "BufferHasIdentifier(ByteBuffer _bb) { return ";
654 code += "__has_identifier(_bb, \"";
655 code += parser_.file_identifier_;
656 code += "\"); }\n";
657 }
658 }
659 }
660 // Generate the __init method that sets the field in a pre-existing
661 // accessor object. This is to allow object reuse.
662 code += " public void __init(int _i, ByteBuffer _bb) ";
663 code += "{ ";
664 code += "__reset(_i, _bb); ";
665 code += "}\n";
666 code +=
667 " public " + struct_def.name + " __assign(int _i, ByteBuffer _bb) ";
668 code += "{ __init(_i, _bb); return this; }\n\n";
669 for (auto it = struct_def.fields.vec.begin();
670 it != struct_def.fields.vec.end(); ++it) {
671 auto &field = **it;
672 if (field.deprecated) continue;
673 GenComment(field.doc_comment, code_ptr, &comment_config, " ");
674 std::string type_name = GenTypeGet(field.value.type);
675 std::string type_name_dest = GenTypeNameDest(field.value.type);
676 std::string conditional_cast = "";
677 std::string optional = "";
678 std::string dest_mask = DestinationMask(field.value.type, true);
679 std::string dest_cast = DestinationCast(field.value.type);
680 std::string src_cast = SourceCast(field.value.type);
681 std::string method_start =
682 " public " +
683 (field.IsRequired() ? "" : GenNullableAnnotation(field.value.type)) +
684 GenPureAnnotation(field.value.type) + type_name_dest + optional +
685 " " + MakeCamel(field.name, false);
686 std::string obj = "obj";
687
688 // Most field accessors need to retrieve and test the field offset first,
689 // this is the prefix code for that:
690 auto offset_prefix =
691 IsArray(field.value.type)
692 ? " { return "
693 : (" { int o = __offset(" + NumToString(field.value.offset) +
694 "); return o != 0 ? ");
695 // Generate the accessors that don't do object reuse.
696 if (field.value.type.base_type == BASE_TYPE_STRUCT) {
697 // Calls the accessor that takes an accessor object with a new object.
698 code += method_start + "() { return ";
699 code += MakeCamel(field.name, false);
700 code += "(new ";
701 code += type_name + "()); }\n";
702 } else if (IsSeries(field.value.type) &&
703 field.value.type.element == BASE_TYPE_STRUCT) {
704 // Accessors for vectors of structs also take accessor objects, this
705 // generates a variant without that argument.
706 code += method_start + "(int j) { return ";
707 code += MakeCamel(field.name, false);
708 code += "(new " + type_name + "(), j); }\n";
709 }
710
711 if (field.IsScalarOptional()) { code += GenOptionalScalarCheck(field); }
712 std::string getter = dest_cast + GenGetter(field.value.type);
713 code += method_start;
714 std::string default_cast = "";
715 std::string member_suffix = "; ";
716 if (IsScalar(field.value.type.base_type)) {
717 code += "()";
718 member_suffix += "";
719 if (struct_def.fixed) {
720 code += " { return " + getter;
721 code += "(bb_pos + ";
722 code += NumToString(field.value.offset) + ")";
723 code += dest_mask;
724 } else {
725 code += offset_prefix + getter;
726 code += "(o + bb_pos)" + dest_mask;
727 code += " : " + default_cast;
728 code += GenDefaultValue(field);
729 }
730 } else {
731 switch (field.value.type.base_type) {
732 case BASE_TYPE_STRUCT:
733 code += "(" + type_name + " obj)";
734 if (struct_def.fixed) {
735 code += " { return " + obj + ".__assign(";
736 code += "bb_pos + " + NumToString(field.value.offset) + ", ";
737 code += "bb)";
738 } else {
739 code += offset_prefix + conditional_cast;
740 code += obj + ".__assign(";
741 code += field.value.type.struct_def->fixed
742 ? "o + bb_pos"
743 : "__indirect(o + bb_pos)";
744 code += ", bb) : null";
745 }
746 break;
747 case BASE_TYPE_STRING:
748 code += "()";
749 member_suffix += "";
750 code += offset_prefix + getter + "(o + ";
751 code += "bb_pos) : null";
752 break;
753 case BASE_TYPE_ARRAY: FLATBUFFERS_FALLTHROUGH(); // fall thru
754 case BASE_TYPE_VECTOR: {
755 auto vectortype = field.value.type.VectorType();
756 code += "(";
757 if (vectortype.base_type == BASE_TYPE_STRUCT) {
758 code += type_name + " obj, ";
759 getter = obj + ".__assign";
760 } else if (vectortype.base_type == BASE_TYPE_UNION) {
761 code += type_name + " obj, ";
762 }
763 code += "int j)";
764 const auto body = offset_prefix + conditional_cast + getter + "(";
765 if (vectortype.base_type == BASE_TYPE_UNION) {
766 code += body + "obj, ";
767 } else {
768 code += body;
769 }
770 std::string index;
771 if (IsArray(field.value.type)) {
772 index += "bb_pos + " + NumToString(field.value.offset) + " + ";
773 } else {
774 index += "__vector(o) + ";
775 }
776 index += "j * " + NumToString(InlineSize(vectortype));
777 if (vectortype.base_type == BASE_TYPE_STRUCT) {
778 code += vectortype.struct_def->fixed
779 ? index
780 : "__indirect(" + index + ")";
781 code += ", bb";
782 } else {
783 code += index;
784 }
785 code += ")" + dest_mask;
786 if (!IsArray(field.value.type)) {
787 code += " : ";
788 code +=
789 field.value.type.element == BASE_TYPE_BOOL
790 ? "false"
791 : (IsScalar(field.value.type.element) ? default_cast + "0"
792 : "null");
793 }
794
795 break;
796 }
797 case BASE_TYPE_UNION:
798 code += "(" + type_name + " obj)" + offset_prefix + getter;
799 code += "(obj, o + bb_pos) : null";
800 break;
801 default: FLATBUFFERS_ASSERT(0);
802 }
803 }
804 code += member_suffix;
805 code += "}\n";
806 if (IsVector(field.value.type)) {
807 code += " public int " + MakeCamel(field.name, false);
808 code += "Length";
809 code += "()";
810 code += offset_prefix;
811 code += "__vector_len(o) : 0; ";
812 code += "";
813 code += "}\n";
814 // See if we should generate a by-key accessor.
815 if (field.value.type.element == BASE_TYPE_STRUCT &&
816 !field.value.type.struct_def->fixed) {
817 auto &sd = *field.value.type.struct_def;
818 auto &fields = sd.fields.vec;
819 for (auto kit = fields.begin(); kit != fields.end(); ++kit) {
820 auto &key_field = **kit;
821 if (key_field.key) {
822 auto qualified_name = WrapInNameSpace(sd);
823 code += " public " + qualified_name + " ";
824 code += MakeCamel(field.name, false) + "ByKey(";
825 code += GenTypeNameDest(key_field.value.type) + " key)";
826 code += offset_prefix;
827 code += qualified_name + ".__lookup_by_key(";
828 code += "null, ";
829 code += "__vector(o), key, ";
830 code += "bb) : null; ";
831 code += "}\n";
832 code += " public " + qualified_name + " ";
833 code += MakeCamel(field.name, false) + "ByKey(";
834 code += qualified_name + " obj, ";
835 code += GenTypeNameDest(key_field.value.type) + " key)";
836 code += offset_prefix;
837 code += qualified_name + ".__lookup_by_key(obj, ";
838 code += "__vector(o), key, ";
839 code += "bb) : null; ";
840 code += "}\n";
841 break;
842 }
843 }
844 }
845 }
846 // Generate the accessors for vector of structs with vector access object
847 if (IsVector(field.value.type)) {
848 std::string vector_type_name;
849 const auto &element_base_type = field.value.type.VectorType().base_type;
850 if (IsScalar(element_base_type)) {
851 vector_type_name = MakeCamel(type_name, true) + "Vector";
852 } else if (element_base_type == BASE_TYPE_STRING) {
853 vector_type_name = "StringVector";
854 } else if (element_base_type == BASE_TYPE_UNION) {
855 vector_type_name = "UnionVector";
856 } else {
857 vector_type_name = type_name + ".Vector";
858 }
859 auto vector_method_start = GenNullableAnnotation(field.value.type) +
860 " public " + vector_type_name + optional +
861 " " + MakeCamel(field.name, false) +
862 "Vector";
863 code += vector_method_start + "() { return ";
864 code += MakeCamel(field.name, false) + "Vector";
865 code += "(new " + vector_type_name + "()); }\n";
866 code += vector_method_start + "(" + vector_type_name + " obj)";
867 code += offset_prefix + conditional_cast + obj + ".__assign(";
868 code += "__vector(o), ";
869 if (!IsScalar(element_base_type)) {
870 auto vectortype = field.value.type.VectorType();
871 code += NumToString(InlineSize(vectortype)) + ", ";
872 }
873 code += "bb) : null" + member_suffix + "}\n";
874 }
875 // Generate a ByteBuffer accessor for strings & vectors of scalars.
876 if ((IsVector(field.value.type) &&
877 IsScalar(field.value.type.VectorType().base_type)) ||
878 IsString(field.value.type)) {
879 code += " public ByteBuffer ";
880 code += MakeCamel(field.name, false);
881 code += "AsByteBuffer() { return ";
882 code += "__vector_as_bytebuffer(";
883 code += NumToString(field.value.offset) + ", ";
884 code += NumToString(IsString(field.value.type)
885 ? 1
886 : InlineSize(field.value.type.VectorType()));
887 code += "); }\n";
888 code += " public ByteBuffer ";
889 code += MakeCamel(field.name, false);
890 code += "InByteBuffer(ByteBuffer _bb) { return ";
891 code += "__vector_in_bytebuffer(_bb, ";
892 code += NumToString(field.value.offset) + ", ";
893 code += NumToString(IsString(field.value.type)
894 ? 1
895 : InlineSize(field.value.type.VectorType()));
896 code += "); }\n";
897 }
898 // generate object accessors if is nested_flatbuffer
899 if (field.nested_flatbuffer) {
900 auto nested_type_name = WrapInNameSpace(*field.nested_flatbuffer);
901 auto nested_method_name =
902 MakeCamel(field.name, false) + "As" + field.nested_flatbuffer->name;
903 auto get_nested_method_name = nested_method_name;
904 code += " public " + nested_type_name + " ";
905 code += nested_method_name + "() { return ";
906 code +=
907 get_nested_method_name + "(new " + nested_type_name + "()); }\n";
908 code += " public " + nested_type_name + " ";
909 code += get_nested_method_name + "(";
910 code += nested_type_name + " obj";
911 code += ") { int o = __offset(";
912 code += NumToString(field.value.offset) + "); ";
913 code += "return o != 0 ? " + conditional_cast + obj + ".__assign(";
914 code += "";
915 code += "__indirect(__vector(o)), ";
916 code += "bb) : null; }\n";
917 }
918 // Generate mutators for scalar fields or vectors of scalars.
919 if (parser_.opts.mutable_buffer) {
920 auto is_series = (IsSeries(field.value.type));
921 const auto &underlying_type =
922 is_series ? field.value.type.VectorType() : field.value.type;
923 // Boolean parameters have to be explicitly converted to byte
924 // representation.
925 auto setter_parameter = underlying_type.base_type == BASE_TYPE_BOOL
926 ? "(byte)(" + field.name + " ? 1 : 0)"
927 : field.name;
928 auto mutator_prefix = MakeCamel("mutate", false);
929 // A vector mutator also needs the index of the vector element it should
930 // mutate.
931 auto mutator_params = (is_series ? "(int j, " : "(") +
932 GenTypeNameDest(underlying_type) + " " +
933 field.name + ") { ";
934 auto setter_index =
935 is_series
936 ? (IsArray(field.value.type)
937 ? "bb_pos + " + NumToString(field.value.offset)
938 : "__vector(o)") +
939 +" + j * " + NumToString(InlineSize(underlying_type))
940 : (struct_def.fixed
941 ? "bb_pos + " + NumToString(field.value.offset)
942 : "o + bb_pos");
943 if (IsScalar(underlying_type.base_type) && !IsUnion(field.value.type)) {
944 code += " public ";
945 code += struct_def.fixed ? "void " : "boolean ";
946 code += mutator_prefix + MakeCamel(field.name, true);
947 code += mutator_params;
948 if (struct_def.fixed) {
949 code += GenSetter(underlying_type) + "(" + setter_index + ", ";
950 code += src_cast + setter_parameter + "); }\n";
951 } else {
952 code += "int o = __offset(";
953 code += NumToString(field.value.offset) + ");";
954 code += " if (o != 0) { " + GenSetter(underlying_type);
955 code += "(" + setter_index + ", " + src_cast + setter_parameter +
956 "); return true; } else { return false; } }\n";
957 }
958 }
959 }
960 if (parser_.opts.java_primitive_has_method &&
961 IsScalar(field.value.type.base_type) && !struct_def.fixed) {
962 auto vt_offset_constant = " public static final int VT_" +
963 MakeScreamingCamel(field.name) + " = " +
964 NumToString(field.value.offset) + ";";
965
966 code += vt_offset_constant;
967 code += "\n";
968 }
969 }
970 code += "\n";
971 auto struct_has_create = false;
972 std::set<flatbuffers::FieldDef *> field_has_create_set;
973 flatbuffers::FieldDef *key_field = nullptr;
974 if (struct_def.fixed) {
975 struct_has_create = true;
976 // create a struct constructor function
977 code += " public static " + GenOffsetType() + " ";
978 code += "create";
979 code += struct_def.name + "(FlatBufferBuilder builder";
980 GenStructArgs(struct_def, code_ptr, "");
981 code += ") {\n";
982 GenStructBody(struct_def, code_ptr, "");
983 code += " return ";
984 code += GenOffsetConstruct("builder." + std::string("offset()"));
985 code += ";\n }\n";
986 } else {
987 // Generate a method that creates a table in one go. This is only possible
988 // when the table has no struct fields, since those have to be created
989 // inline, and there's no way to do so in Java.
990 bool has_no_struct_fields = true;
991 int num_fields = 0;
992 for (auto it = struct_def.fields.vec.begin();
993 it != struct_def.fields.vec.end(); ++it) {
994 auto &field = **it;
995 if (field.deprecated) continue;
996 if (IsStruct(field.value.type)) {
997 has_no_struct_fields = false;
998 } else {
999 num_fields++;
1000 }
1001 }
1002 // JVM specifications restrict default constructor params to be < 255.
1003 // Longs and doubles take up 2 units, so we set the limit to be < 127.
1004 if (has_no_struct_fields && num_fields && num_fields < 127) {
1005 struct_has_create = true;
1006 // Generate a table constructor of the form:
1007 // public static int createName(FlatBufferBuilder builder, args...)
1008 code += " public static " + GenOffsetType() + " ";
1009 code += "create" + struct_def.name;
1010 code += "(FlatBufferBuilder builder";
1011 for (auto it = struct_def.fields.vec.begin();
1012 it != struct_def.fields.vec.end(); ++it) {
1013 auto &field = **it;
1014 auto field_name = MakeCamel(field.name, false);
1015 if (field.deprecated) continue;
1016 code += ",\n ";
1017 code += GenTypeBasic(DestinationType(field.value.type, false));
1018 code += " ";
1019 code += field_name;
1020 if (!IsScalar(field.value.type.base_type)) code += "Offset";
1021 }
1022 code += ") {\n builder.";
1023 code += "startTable(";
1024 code += NumToString(struct_def.fields.vec.size()) + ");\n";
1025 for (size_t size = struct_def.sortbysize ? sizeof(largest_scalar_t) : 1;
1026 size; size /= 2) {
1027 for (auto it = struct_def.fields.vec.rbegin();
1028 it != struct_def.fields.vec.rend(); ++it) {
1029 auto &field = **it;
1030 auto field_name = MakeCamel(field.name, false);
1031 auto method_name = MakeCamel(field.name, true);
1032 if (!field.deprecated &&
1033 (!struct_def.sortbysize ||
1034 size == SizeOf(field.value.type.base_type))) {
1035 code += " " + struct_def.name + ".";
1036 code += "add";
1037 code += method_name + "(builder, " + field_name;
1038 if (!IsScalar(field.value.type.base_type)) code += "Offset";
1039 code += ");\n";
1040 }
1041 }
1042 }
1043 code += " return " + struct_def.name + ".";
1044 code += "end" + struct_def.name;
1045 code += "(builder);\n }\n\n";
1046 }
1047 // Generate a set of static methods that allow table construction,
1048 // of the form:
1049 // public static void addName(FlatBufferBuilder builder, short name)
1050 // { builder.addShort(id, name, default); }
1051 // Unlike the Create function, these always work.
1052 code += " public static void start";
1053 code += struct_def.name;
1054 code += "(FlatBufferBuilder builder) { builder.";
1055 code += "startTable(";
1056 code += NumToString(struct_def.fields.vec.size()) + "); }\n";
1057 for (auto it = struct_def.fields.vec.begin();
1058 it != struct_def.fields.vec.end(); ++it) {
1059 auto &field = **it;
1060 if (field.deprecated) continue;
1061 if (field.key) key_field = &field;
1062 code += " public static void add";
1063 code += MakeCamel(field.name);
1064 code += "(FlatBufferBuilder builder, ";
1065 code += GenTypeBasic(DestinationType(field.value.type, false));
1066 auto argname = MakeCamel(field.name, false);
1067 if (!IsScalar(field.value.type.base_type)) argname += "Offset";
1068 code += " " + argname + ") { builder.add";
1069 code += GenMethod(field.value.type) + "(";
1070 code += NumToString(it - struct_def.fields.vec.begin()) + ", ";
1071 code += SourceCastBasic(field.value.type);
1072 code += argname;
1073 code += ", ";
1074 code += SourceCastBasic(field.value.type);
1075 code += GenDefaultValue(field);
1076 code += "); }\n";
1077 if (IsVector(field.value.type)) {
1078 auto vector_type = field.value.type.VectorType();
1079 auto alignment = InlineAlignment(vector_type);
1080 auto elem_size = InlineSize(vector_type);
1081 if (!IsStruct(vector_type)) {
1082 field_has_create_set.insert(&field);
1083 // generate a method to create a vector from a java array.
1084 if ((vector_type.base_type == BASE_TYPE_CHAR ||
1085 vector_type.base_type == BASE_TYPE_UCHAR)) {
1086 // Handle byte[] and ByteBuffers separately for Java
1087 code += " public static " + GenVectorOffsetType() + " ";
1088 code += "create";
1089 code += MakeCamel(field.name);
1090 code += "Vector(FlatBufferBuilder builder, byte[] data) ";
1091 code += "{ return builder.createByteVector(data); }\n";
1092
1093 code += " public static " + GenVectorOffsetType() + " ";
1094 code += "create";
1095 code += MakeCamel(field.name);
1096 code += "Vector(FlatBufferBuilder builder, ByteBuffer data) ";
1097 code += "{ return builder.createByteVector(data); }\n";
1098 } else {
1099 code += " public static " + GenVectorOffsetType() + " ";
1100 code += "create";
1101 code += MakeCamel(field.name);
1102 code += "Vector(FlatBufferBuilder builder, ";
1103 code += GenTypeBasic(DestinationType(vector_type, false)) +
1104 "[] data) ";
1105 code += "{ builder.startVector(";
1106 code += NumToString(elem_size);
1107 code += ", data.length, ";
1108 code += NumToString(alignment);
1109 code += "); for (int i = data.";
1110 code += "length - 1; i >= 0; i--) builder.";
1111 code += "add";
1112 code += GenMethod(vector_type);
1113 code += "(";
1114 code += SourceCastBasic(vector_type);
1115 code += "data[i]";
1116 code += "); return ";
1117 code += "builder.endVector(); }\n";
1118 }
1119 }
1120 // Generate a method to start a vector, data to be added manually
1121 // after.
1122 code += " public static void start";
1123 code += MakeCamel(field.name);
1124 code += "Vector(FlatBufferBuilder builder, int numElems) ";
1125 code += "{ builder.startVector(";
1126 code += NumToString(elem_size);
1127 code += ", numElems, " + NumToString(alignment);
1128 code += "); }\n";
1129 }
1130 }
1131 code += " public static " + GenOffsetType() + " ";
1132 code += "end" + struct_def.name;
1133 code += "(FlatBufferBuilder builder) {\n int o = builder.";
1134 code += "endTable();\n";
1135 for (auto it = struct_def.fields.vec.begin();
1136 it != struct_def.fields.vec.end(); ++it) {
1137 auto &field = **it;
1138 if (!field.deprecated && field.IsRequired()) {
1139 code += " builder.required(o, ";
1140 code += NumToString(field.value.offset);
1141 code += "); // " + field.name + "\n";
1142 }
1143 }
1144 code += " return " + GenOffsetConstruct("o") + ";\n }\n";
1145 if (parser_.root_struct_def_ == &struct_def) {
1146 std::string size_prefix[] = { "", "SizePrefixed" };
1147 for (int i = 0; i < 2; ++i) {
1148 code += " public static void ";
1149 code += "finish" + size_prefix[i] + struct_def.name;
1150 code += "Buffer(FlatBufferBuilder builder, " + GenOffsetType();
1151 code += " offset) {";
1152 code += " builder.finish" + size_prefix[i] + "(offset";
1153
1154 if (parser_.file_identifier_.length())
1155 code += ", \"" + parser_.file_identifier_ + "\"";
1156 code += "); }\n";
1157 }
1158 }
1159 }
1160 // Only generate key compare function for table,
1161 // because `key_field` is not set for struct
1162 if (struct_def.has_key && !struct_def.fixed) {
1163 FLATBUFFERS_ASSERT(key_field);
1164 code += "\n @Override\n protected int keysCompare(";
1165 code += "Integer o1, Integer o2, ByteBuffer _bb) {";
1166 code += GenKeyGetter(key_field);
1167 code += " }\n";
1168
1169 code += "\n public static " + struct_def.name;
1170 code += " __lookup_by_key(";
1171 code += struct_def.name + " obj, ";
1172 code += "int vectorLocation, ";
1173 code += GenTypeNameDest(key_field->value.type);
1174 code += " key, ByteBuffer bb) {\n";
1175 if (IsString(key_field->value.type)) {
1176 code += " byte[] byteKey = ";
1177 code += "key.getBytes(java.nio.charset.StandardCharsets.UTF_8);\n";
1178 }
1179 code += " int span = ";
1180 code += "bb.getInt(vectorLocation - 4);\n";
1181 code += " int start = 0;\n";
1182 code += " while (span != 0) {\n";
1183 code += " int middle = span / 2;\n";
1184 code += GenLookupKeyGetter(key_field);
1185 code += " if (comp > 0) {\n";
1186 code += " span = middle;\n";
1187 code += " } else if (comp < 0) {\n";
1188 code += " middle++;\n";
1189 code += " start += middle;\n";
1190 code += " span -= middle;\n";
1191 code += " } else {\n";
1192 code += " return ";
1193 code += "(obj == null ? new " + struct_def.name + "() : obj)";
1194 code += ".__assign(tableOffset, bb);\n";
1195 code += " }\n }\n";
1196 code += " return null;\n";
1197 code += " }\n";
1198 }
1199 GenVectorAccessObject(struct_def, code_ptr);
1200 if (opts.generate_object_based_api) {
1201 GenPackUnPack_ObjectAPI(struct_def, code_ptr, opts, struct_has_create,
1202 field_has_create_set);
1203 }
1204 code += "}\n\n";
1205 }
1206
1207 std::string GenOptionalScalarCheck(FieldDef &field) const {
1208 if (!field.IsScalarOptional()) return "";
1209 return " public boolean has" + MakeCamel(field.name, true) +
1210 "() { return 0 != __offset(" + NumToString(field.value.offset) +
1211 "); }\n";
1212 }
1213
1214 void GenVectorAccessObject(StructDef &struct_def,
1215 std::string *code_ptr) const {
1216 auto &code = *code_ptr;
1217 // Generate a vector of structs accessor class.
1218 code += "\n";
1219 code += " ";
1220 if (!struct_def.attributes.Lookup("private")) code += "public ";
1221 code += "static ";
1222 code += "final ";
1223 code += "class Vector extends ";
1224 code += "BaseVector {\n";
1225
1226 // Generate the __assign method that sets the field in a pre-existing
1227 // accessor object. This is to allow object reuse.
1228 std::string method_indent = " ";
1229 code += method_indent + "public Vector ";
1230 code += "__assign(int _vector, int _element_size, ByteBuffer _bb) { ";
1231 code += "__reset(_vector, _element_size, _bb); return this; }\n\n";
1232
1233 auto type_name = struct_def.name;
1234 auto method_start = method_indent + "public " + type_name + " get";
1235 // Generate the accessors that don't do object reuse.
1236 code += method_start + "(int j) { return get";
1237 code += "(new " + type_name + "(), j); }\n";
1238 code += method_start + "(" + type_name + " obj, int j) { ";
1239 code += " return obj.__assign(";
1240 std::string index = "__element(j)";
1241 code += struct_def.fixed ? index : "__indirect(" + index + ", bb)";
1242 code += ", bb); }\n";
1243 // See if we should generate a by-key accessor.
1244 if (!struct_def.fixed) {
1245 auto &fields = struct_def.fields.vec;
1246 for (auto kit = fields.begin(); kit != fields.end(); ++kit) {
1247 auto &key_field = **kit;
1248 if (key_field.key) {
1249 auto nullable_annotation =
1250 parser_.opts.gen_nullable ? "@Nullable " : "";
1251 code += method_indent + nullable_annotation;
1252 code += "public " + type_name + " ";
1253 code += "getByKey(";
1254 code += GenTypeNameDest(key_field.value.type) + " key) { ";
1255 code += " return __lookup_by_key(null, ";
1256 code += "__vector(), key, ";
1257 code += "bb); ";
1258 code += "}\n";
1259 code += method_indent + nullable_annotation;
1260 code += "public " + type_name + " ";
1261 code += "getByKey(";
1262 code += type_name + " obj, ";
1263 code += GenTypeNameDest(key_field.value.type) + " key) { ";
1264 code += " return __lookup_by_key(obj, ";
1265 code += "__vector(), key, ";
1266 code += "bb); ";
1267 code += "}\n";
1268 break;
1269 }
1270 }
1271 }
1272 code += " }\n";
1273 }
1274
1275 std::string GenGetterFuncName_ObjectAPI(const std::string &field_name) const {
1276 return "get" + MakeCamel(field_name, true);
1277 }
1278
1279 void GenEnum_ObjectAPI(EnumDef &enum_def, std::string *code_ptr,
1280 const IDLOptions &opts) const {
1281 auto &code = *code_ptr;
1282 if (enum_def.generated) return;
1283 code += "import com.google.flatbuffers.FlatBufferBuilder;\n\n";
1284
1285 if (!enum_def.attributes.Lookup("private")) { code += "public "; }
1286 auto union_name = enum_def.name + "Union";
1287 auto union_type =
1288 GenTypeBasic(DestinationType(enum_def.underlying_type, false));
1289 code += "class " + union_name + " {\n";
1290 // Type
1291 code += " private " + union_type + " type;\n";
1292 // Value
1293 code += " private Object value;\n";
1294 code += "\n";
1295 // getters and setters
1296 code += " public " + union_type + " getType() { return type; }\n\n";
1297 code += " public void setType(" + union_type +
1298 " type) { this.type = type; }\n\n";
1299 code += " public Object getValue() { return value; }\n\n";
1300 code += " public void setValue(Object value) { this.value = value; }\n\n";
1301 // Constructor
1302 code += " public " + union_name + "() {\n";
1303 code += " this.type = " + enum_def.name + "." +
1304 enum_def.Vals()[0]->name + ";\n";
1305 code += " this.value = null;\n";
1306 code += " }\n\n";
1307 // As
1308 for (auto it = enum_def.Vals().begin(); it != enum_def.Vals().end(); ++it) {
1309 auto &ev = **it;
1310 if (ev.union_type.base_type == BASE_TYPE_NONE) continue;
1311 auto type_name = GenTypeGet_ObjectAPI(ev.union_type, opts, false, true);
1312 if (ev.union_type.base_type == BASE_TYPE_STRUCT &&
1313 ev.union_type.struct_def->attributes.Lookup("private")) {
1314 code += " ";
1315 } else {
1316 code += " public ";
1317 }
1318 code += type_name + " as" + ev.name + "() { return (" + type_name +
1319 ") value; }\n";
1320 }
1321 code += "\n";
1322 // pack()
1323 code += " public static int pack(FlatBufferBuilder builder, " +
1324 union_name + " _o) {\n";
1325 code += " switch (_o.type) {\n";
1326 for (auto it = enum_def.Vals().begin(); it != enum_def.Vals().end(); ++it) {
1327 auto &ev = **it;
1328 if (ev.union_type.base_type == BASE_TYPE_NONE) {
1329 continue;
1330 } else {
1331 code += " case " + enum_def.name + "." + ev.name + ": return ";
1332 if (IsString(ev.union_type)) {
1333 code += "builder.createString(_o.as" + ev.name + "());\n";
1334 } else {
1335 code += GenTypeGet(ev.union_type) + ".pack(builder, _o.as" + ev.name +
1336 "());\n";
1337 }
1338 }
1339 }
1340 code += " default: return 0;\n";
1341 code += " }\n";
1342 code += " }\n";
1343 code += "}\n\n";
1344 }
1345
1346 std::string GenSetterFuncName_ObjectAPI(const std::string &field_name) const {
1347 return "set" + MakeCamel(field_name, true);
1348 }
1349
1350 std::string GenTypeName_ObjectAPI(const std::string &name,
1351 const IDLOptions &opts) const {
1352 return opts.object_prefix + name + opts.object_suffix;
1353 }
1354
1355 void GenUnionUnPack_ObjectAPI(const EnumDef &enum_def, std::string *code_ptr,
1356 const std::string &type_name,
1357 const std::string &camel_name,
1358 bool is_vector) const {
1359 auto &code = *code_ptr;
1360
1361 std::string variable_type = type_name;
1362 std::string variable_name = "_o" + MakeCamel(camel_name, true);
1363 std::string type_params = "";
1364 std::string value_params = "";
1365 std::string func_suffix = "()";
1366 std::string indent = " ";
1367 if (is_vector) {
1368 variable_type = type_name.substr(0, type_name.length() - 2);
1369 variable_name += "Element";
1370 type_params = "_j";
1371 value_params = ", _j";
1372 func_suffix = "(_j)";
1373 indent = " ";
1374 }
1375 code += indent + variable_type + " " + variable_name + " = new " +
1376 variable_type + "();\n";
1377 code += indent +
1378 GenTypeBasic(DestinationType(enum_def.underlying_type, false)) +
1379 " " + variable_name + "Type = " + camel_name + "Type(" +
1380 type_params + ");\n";
1381 code += indent + variable_name + ".setType(" + variable_name + "Type);\n";
1382 code += indent + "Table " + variable_name + "Value;\n";
1383 code += indent + "switch (" + variable_name + "Type) {\n";
1384 for (auto eit = enum_def.Vals().begin(); eit != enum_def.Vals().end();
1385 ++eit) {
1386 auto &ev = **eit;
1387 if (ev.union_type.base_type == BASE_TYPE_NONE) {
1388 continue;
1389 } else {
1390 if (ev.union_type.base_type == BASE_TYPE_STRING ||
1391 (ev.union_type.base_type == BASE_TYPE_STRUCT &&
1392 ev.union_type.struct_def->fixed)) {
1393 continue; // This branch is due to bad implemantation of Unions in
1394 // Java which doesn't handle non Table types. Should be
1395 // deleted when issue #6561 is fixed.
1396 }
1397 code += indent + " case " + WrapInNameSpace(enum_def) + "." + ev.name +
1398 ":\n";
1399 auto actual_type = GenTypeGet(ev.union_type);
1400 code += indent + " " + variable_name + "Value = " + camel_name +
1401 "(new " + actual_type + "()" + value_params + ");\n";
1402 code += indent + " " + variable_name + ".setValue(" + variable_name +
1403 "Value != null ? ((" + actual_type + ") " + variable_name +
1404 "Value).unpack() : null);\n";
1405 code += indent + " break;\n";
1406 }
1407 }
1408 code += indent + " default: break;\n";
1409 code += indent + "}\n";
1410 if (is_vector) {
1411 code += indent + "_o" + MakeCamel(camel_name, true) +
1412 "[_j] = " + variable_name + ";\n";
1413 }
1414 }
1415
1416 void GenPackUnPack_ObjectAPI(
1417 StructDef &struct_def, std::string *code_ptr, const IDLOptions &opts,
1418 bool struct_has_create,
1419 const std::set<FieldDef *> &field_has_create) const {
1420 auto &code = *code_ptr;
1421 auto struct_name = GenTypeName_ObjectAPI(struct_def.name, opts);
1422 // unpack()
1423 code += " public " + struct_name + " unpack() {\n";
1424 code += " " + struct_name + " _o = new " + struct_name + "();\n";
1425 code += " unpackTo(_o);\n";
1426 code += " return _o;\n";
1427 code += " }\n";
1428 // unpackTo()
1429 code += " public void unpackTo(" + struct_name + " _o) {\n";
1430 for (auto it = struct_def.fields.vec.begin();
1431 it != struct_def.fields.vec.end(); ++it) {
1432 auto &field = **it;
1433 if (field.deprecated) continue;
1434 if (field.value.type.base_type == BASE_TYPE_UTYPE) continue;
1435 if (field.value.type.element == BASE_TYPE_UTYPE) continue;
1436 auto camel_name = MakeCamel(field.name, false);
1437 auto camel_name_with_first = MakeCamel(field.name, true);
1438 auto type_name =
1439 GenTypeGet_ObjectAPI(field.value.type, opts, false, true);
1440 if (field.IsScalarOptional())
1441 type_name = ConvertPrimitiveTypeToObjectWrapper_ObjectAPI(type_name);
1442 auto start = " " + type_name + " _o" + camel_name_with_first + " = ";
1443 auto call_setter = true;
1444 switch (field.value.type.base_type) {
1445 case BASE_TYPE_STRUCT: {
1446 auto fixed = struct_def.fixed && field.value.type.struct_def->fixed;
1447 if (fixed) {
1448 code += " " + camel_name + "().unpackTo(_o.get" +
1449 camel_name_with_first + "());\n";
1450 } else {
1451 code += " if (" + camel_name + "() != null) ";
1452 if (field.value.type.struct_def->fixed) {
1453 code += camel_name + "().unpackTo(_o.get" +
1454 camel_name_with_first + "());\n";
1455 } else {
1456 code += "_o." + GenSetterFuncName_ObjectAPI(field.name) + "(" +
1457 camel_name + "().unpack());\n";
1458 }
1459 code += " else _o." + GenSetterFuncName_ObjectAPI(field.name) +
1460 "(null);\n";
1461 }
1462 call_setter = false;
1463 break;
1464 }
1465 case BASE_TYPE_ARRAY: {
1466 auto length_str = NumToString(field.value.type.fixed_length);
1467 auto unpack_method =
1468 field.value.type.struct_def == nullptr ? "" : ".unpack()";
1469 code +=
1470 start + "_o." + GenGetterFuncName_ObjectAPI(field.name) + "();\n";
1471 code += " for (int _j = 0; _j < " + length_str + "; ++_j) { _o" +
1472 camel_name_with_first + "[_j] = " + camel_name + "(_j)" +
1473 unpack_method + "; }\n";
1474 call_setter = false;
1475 break;
1476 }
1477 case BASE_TYPE_VECTOR:
1478 if (field.value.type.element == BASE_TYPE_UNION) {
1479 code += start + "new " +
1480 GenConcreteTypeGet_ObjectAPI(field.value.type, opts)
1481 .substr(0, type_name.length() - 1) +
1482 camel_name + "Length()];\n";
1483 code += " for (int _j = 0; _j < " + camel_name +
1484 "Length(); ++_j) {\n";
1485 GenUnionUnPack_ObjectAPI(*field.value.type.enum_def, code_ptr,
1486 type_name, camel_name, true);
1487 code += " }\n";
1488 } else if (field.value.type.element != BASE_TYPE_UTYPE) {
1489 auto fixed = field.value.type.struct_def == nullptr;
1490 code += start + "new " +
1491 GenConcreteTypeGet_ObjectAPI(field.value.type, opts)
1492 .substr(0, type_name.length() - 1) +
1493 camel_name + "Length()];\n";
1494 code +=
1495 " for (int _j = 0; _j < " + camel_name + "Length(); ++_j) {";
1496 code += "_o" + camel_name_with_first + "[_j] = ";
1497 if (fixed) {
1498 code += camel_name + "(_j)";
1499 } else {
1500 code += "(" + camel_name + "(_j) != null ? " + camel_name +
1501 "(_j).unpack() : null)";
1502 }
1503 code += ";}\n";
1504 }
1505 break;
1506 case BASE_TYPE_UTYPE: break;
1507 case BASE_TYPE_UNION: {
1508 GenUnionUnPack_ObjectAPI(*field.value.type.enum_def, code_ptr,
1509 type_name, camel_name, false);
1510 break;
1511 }
1512 default: {
1513 if (field.IsScalarOptional()) {
1514 code += start + "has" + camel_name_with_first + "() ? " +
1515 camel_name + "() : null;\n";
1516 } else {
1517 code += start + camel_name + "();\n";
1518 }
1519 break;
1520 }
1521 }
1522 if (call_setter) {
1523 code += " _o." + GenSetterFuncName_ObjectAPI(field.name) + "(_o" +
1524 camel_name_with_first + ");\n";
1525 }
1526 }
1527 code += " }\n";
1528 // pack()
1529 code += " public static " + GenOffsetType() +
1530 " pack(FlatBufferBuilder builder, " + struct_name + " _o) {\n";
1531 code += " if (_o == null) return 0;\n";
1532 for (auto it = struct_def.fields.vec.begin();
1533 it != struct_def.fields.vec.end(); ++it) {
1534 auto &field = **it;
1535 if (field.deprecated) continue;
1536 auto camel_name = MakeCamel(field.name, false);
1537 auto camel_name_with_first = MakeCamel(field.name, true);
1538 // pre
1539 switch (field.value.type.base_type) {
1540 case BASE_TYPE_STRUCT: {
1541 if (!field.value.type.struct_def->fixed) {
1542 code += " " + GenOffsetType() + " _" + field.name + " = _o." +
1543 GenGetterFuncName_ObjectAPI(field.name) +
1544 "() == null ? 0 : " + GenTypeGet(field.value.type) +
1545 ".pack(builder, _o." +
1546 GenGetterFuncName_ObjectAPI(field.name) + "());\n";
1547 } else if (struct_def.fixed && struct_has_create) {
1548 std::vector<FieldArrayLength> array_lengths;
1549 FieldArrayLength tmp_array_length = {
1550 field.name,
1551 field.value.type.fixed_length,
1552 };
1553 array_lengths.push_back(tmp_array_length);
1554 GenStructPackDecl_ObjectAPI(*field.value.type.struct_def, code_ptr,
1555 array_lengths);
1556 }
1557 break;
1558 }
1559 case BASE_TYPE_STRING: {
1560 std::string create_string = "createString";
1561 code += " int _" + camel_name + " = _o." +
1562 GenGetterFuncName_ObjectAPI(field.name) +
1563 "() == null ? 0 : "
1564 "builder." +
1565 create_string + "(_o." +
1566 GenGetterFuncName_ObjectAPI(field.name) + "());\n";
1567 break;
1568 }
1569 case BASE_TYPE_VECTOR: {
1570 if (field_has_create.find(&field) != field_has_create.end()) {
1571 auto property_name = camel_name;
1572 auto gen_for_loop = true;
1573 std::string array_name = "__" + camel_name;
1574 std::string array_type = "";
1575 std::string element_type = "";
1576 std::string to_array = "";
1577 switch (field.value.type.element) {
1578 case BASE_TYPE_STRING: {
1579 std::string create_string = "createString";
1580 array_type = "int";
1581 element_type = "String";
1582 to_array += "builder." + create_string + "(_e)";
1583 break;
1584 }
1585 case BASE_TYPE_STRUCT:
1586 array_type = "int";
1587 element_type =
1588 GenTypeGet_ObjectAPI(field.value.type, opts, true, true);
1589 ;
1590 to_array = GenTypeGet(field.value.type) + ".pack(builder, _e)";
1591 break;
1592 case BASE_TYPE_UTYPE:
1593 property_name = camel_name.substr(0, camel_name.size() - 4);
1594 array_type = GenTypeBasic(DestinationType(
1595 field.value.type.enum_def->underlying_type, false));
1596 element_type = field.value.type.enum_def->name + "Union";
1597 to_array = "_o." + GenGetterFuncName_ObjectAPI(property_name) +
1598 "()[_j].getType()";
1599 break;
1600 case BASE_TYPE_UNION:
1601 array_type = "int";
1602 element_type =
1603 WrapInNameSpace(*field.value.type.enum_def) + "Union";
1604 to_array = WrapInNameSpace(*field.value.type.enum_def) +
1605 "Union.pack(builder, _o." +
1606 GenGetterFuncName_ObjectAPI(property_name) +
1607 "()[_j])";
1608 break;
1609 case BASE_TYPE_UCHAR: // TODO this branch of the switch is due to
1610 // inconsistent behavior in unsigned byte.
1611 // Read further at Issue #6574.
1612 array_type = "byte";
1613 element_type = "int";
1614 to_array = "(byte) _e";
1615 break;
1616 default:
1617 gen_for_loop = false;
1618 array_name =
1619 "_o." + GenGetterFuncName_ObjectAPI(property_name) + "()";
1620 array_type = GenTypeNameDest(field.value.type);
1621 element_type = array_type;
1622 to_array = "_e";
1623 break;
1624 }
1625 code += " int _" + camel_name + " = 0;\n";
1626 code += " if (_o." + GenGetterFuncName_ObjectAPI(property_name) +
1627 "() != null) {\n";
1628 if (gen_for_loop) {
1629 code += " " + array_type + "[] " + array_name + " = new " +
1630 array_type + "[_o." +
1631 GenGetterFuncName_ObjectAPI(property_name) +
1632 "().length];\n";
1633 code += " int _j = 0;\n";
1634 code += " for (" + element_type + " _e : _o." +
1635 GenGetterFuncName_ObjectAPI(property_name) + "()) { ";
1636 code += array_name + "[_j] = " + to_array + "; _j++;}\n";
1637 }
1638 code += " _" + camel_name + " = create" +
1639 camel_name_with_first + "Vector(builder, " + array_name +
1640 ");\n";
1641 code += " }\n";
1642 } else {
1643 auto type_name = GenTypeGet(field.value.type);
1644 auto element_type_name =
1645 GenTypeGet_ObjectAPI(field.value.type, opts, true, true);
1646 auto pack_method =
1647 field.value.type.struct_def == nullptr
1648 ? "builder.add" + GenMethod(field.value.type.VectorType()) +
1649 "(_o" + camel_name_with_first + "[_j]);"
1650 : type_name + ".pack(builder, _o" + camel_name_with_first +
1651 "[_j]);";
1652 code += " int _" + camel_name + " = 0;\n";
1653 code += " " + element_type_name + "[] _o" +
1654 camel_name_with_first + " = _o." +
1655 GenGetterFuncName_ObjectAPI(field.name) + "();\n";
1656 code += " if (_o" + camel_name_with_first + " != null) {\n";
1657 code += " start" + camel_name_with_first +
1658 "Vector(builder, _o" + camel_name_with_first +
1659 ".length);\n";
1660 code += " for (int _j = _o" + camel_name_with_first +
1661 ".length - 1; _j >=0; _j--) { ";
1662 code += pack_method + "}\n";
1663 code += " _" + camel_name + " = builder.endVector();\n";
1664 code += " }\n";
1665 }
1666 break;
1667 }
1668 case BASE_TYPE_ARRAY: {
1669 if (field.value.type.struct_def != nullptr) {
1670 std::vector<FieldArrayLength> array_lengths;
1671 FieldArrayLength tmp_array_length = {
1672 field.name,
1673 field.value.type.fixed_length,
1674 };
1675 array_lengths.push_back(tmp_array_length);
1676 GenStructPackDecl_ObjectAPI(*field.value.type.struct_def, code_ptr,
1677 array_lengths);
1678 } else {
1679 code += " " +
1680 GenTypeGet_ObjectAPI(field.value.type, opts, false, true) +
1681 " _" + camel_name + " = _o." +
1682 GenGetterFuncName_ObjectAPI(field.name) + "();\n";
1683 }
1684 break;
1685 }
1686 case BASE_TYPE_UNION: {
1687 code +=
1688 " " +
1689 GenTypeBasic(DestinationType(
1690 field.value.type.enum_def->underlying_type, false)) +
1691 " _" + camel_name + "Type = _o.get" + camel_name_with_first +
1692 "() == null ? " + WrapInNameSpace(*field.value.type.enum_def) +
1693 ".NONE : " + "_o.get" + camel_name_with_first + "().getType();\n";
1694 code += " " + GenOffsetType() + " _" + camel_name + " = _o.get" +
1695 camel_name_with_first + "() == null ? 0 : " +
1696 WrapInNameSpace(*field.value.type.enum_def) +
1697 "Union.pack(builder, _o.get" + camel_name_with_first +
1698 "());\n";
1699 break;
1700 }
1701 default: break;
1702 }
1703 }
1704 if (struct_has_create) {
1705 // Create
1706 code += " return create" + struct_def.name + "(\n";
1707 code += " builder";
1708 for (auto it = struct_def.fields.vec.begin();
1709 it != struct_def.fields.vec.end(); ++it) {
1710 auto &field = **it;
1711 if (field.deprecated) continue;
1712 auto camel_name = MakeCamel(field.name, false);
1713 switch (field.value.type.base_type) {
1714 case BASE_TYPE_STRUCT: {
1715 if (struct_def.fixed) {
1716 GenStructPackCall_ObjectAPI(*field.value.type.struct_def,
1717 code_ptr,
1718 " _" + camel_name + "_");
1719 } else {
1720 code += ",\n";
1721 if (field.value.type.struct_def->fixed) {
1722 if (opts.generate_object_based_api)
1723 code += " _o." + camel_name;
1724 else
1725 // Seems like unreachable code
1726 code += " " + GenTypeGet(field.value.type) +
1727 ".Pack(builder, _o." + camel_name + ")";
1728 } else {
1729 code += " _" + field.name;
1730 }
1731 }
1732 break;
1733 }
1734 case BASE_TYPE_ARRAY: {
1735 if (field.value.type.struct_def != nullptr) {
1736 GenStructPackCall_ObjectAPI(*field.value.type.struct_def,
1737 code_ptr,
1738 " _" + camel_name + "_");
1739 } else {
1740 code += ",\n";
1741 code += " _" + camel_name;
1742 }
1743 break;
1744 }
1745 case BASE_TYPE_UNION: FLATBUFFERS_FALLTHROUGH(); // fall thru
1746 case BASE_TYPE_UTYPE: FLATBUFFERS_FALLTHROUGH(); // fall thru
1747 case BASE_TYPE_STRING: FLATBUFFERS_FALLTHROUGH(); // fall thru
1748 case BASE_TYPE_VECTOR: {
1749 code += ",\n";
1750 code += " _" + camel_name;
1751 break;
1752 }
1753 default: // scalar
1754 code += ",\n";
1755 code +=
1756 " _o." + GenGetterFuncName_ObjectAPI(field.name) + "()";
1757 break;
1758 }
1759 }
1760 code += ");\n";
1761 } else {
1762 // Start, End
1763 code += " start" + struct_def.name + "(builder);\n";
1764 for (auto it = struct_def.fields.vec.begin();
1765 it != struct_def.fields.vec.end(); ++it) {
1766 auto &field = **it;
1767 if (field.deprecated) continue;
1768 auto camel_name = MakeCamel(field.name, false);
1769 auto camel_name_with_first = MakeCamel(field.name, true);
1770 switch (field.value.type.base_type) {
1771 case BASE_TYPE_STRUCT: {
1772 if (field.value.type.struct_def->fixed) {
1773 code += " add" + camel_name_with_first + "(builder, " +
1774 GenTypeGet(field.value.type) + ".pack(builder, _o." +
1775 GenGetterFuncName_ObjectAPI(field.name) + "()));\n";
1776 } else {
1777 code += " add" + camel_name_with_first + "(builder, _" +
1778 field.name + ");\n";
1779 }
1780 break;
1781 }
1782 case BASE_TYPE_STRING: FLATBUFFERS_FALLTHROUGH(); // fall thru
1783 case BASE_TYPE_ARRAY: FLATBUFFERS_FALLTHROUGH(); // fall thru
1784 case BASE_TYPE_VECTOR: {
1785 code += " add" + camel_name_with_first + "(builder, _" +
1786 camel_name + ");\n";
1787 break;
1788 }
1789 case BASE_TYPE_UTYPE: break;
1790 case BASE_TYPE_UNION: {
1791 code += " add" + camel_name_with_first + "Type(builder, _" +
1792 camel_name + "Type);\n";
1793 code += " add" + camel_name_with_first + "(builder, _" +
1794 camel_name + ");\n";
1795 break;
1796 }
1797 // scalar
1798 default: {
1799 if (field.IsScalarOptional()) {
1800 code += " if (_o." + GenGetterFuncName_ObjectAPI(field.name) +
1801 "() != null) { add" + camel_name_with_first +
1802 "(builder, _o." +
1803 GenGetterFuncName_ObjectAPI(field.name) + "()); }\n";
1804 } else {
1805 code += " add" + camel_name_with_first + "(builder, _o." +
1806 GenGetterFuncName_ObjectAPI(field.name) + "());\n";
1807 }
1808 break;
1809 }
1810 }
1811 }
1812 code += " return end" + struct_def.name + "(builder);\n";
1813 }
1814 code += " }\n";
1815 }
1816
1817 void GenStructPackDecl_ObjectAPI(
1818 const StructDef &struct_def, std::string *code_ptr,
1819 std::vector<FieldArrayLength> &array_lengths) const {
1820 auto &code = *code_ptr;
1821 for (auto it = struct_def.fields.vec.begin();
1822 it != struct_def.fields.vec.end(); ++it) {
1823 auto &field = **it;
1824 auto is_array = IsArray(field.value.type);
1825 const auto &field_type =
1826 is_array ? field.value.type.VectorType() : field.value.type;
1827 FieldArrayLength tmp_array_length = {
1828 field.name,
1829 field_type.fixed_length,
1830 };
1831 array_lengths.push_back(tmp_array_length);
1832 if (field_type.struct_def != nullptr) {
1833 GenStructPackDecl_ObjectAPI(*field_type.struct_def, code_ptr,
1834 array_lengths);
1835 } else {
1836 std::vector<FieldArrayLength> array_only_lengths;
1837 for (size_t i = 0; i < array_lengths.size(); ++i) {
1838 if (array_lengths[i].length > 0) {
1839 array_only_lengths.push_back(array_lengths[i]);
1840 }
1841 }
1842 std::string name;
1843 for (size_t i = 0; i < array_lengths.size(); ++i) {
1844 name += "_" + MakeCamel(array_lengths[i].name, false);
1845 }
1846 code += " " + GenTypeBasic(field_type);
1847 if (array_only_lengths.size() > 0) {
1848 for (size_t i = 0; i < array_only_lengths.size(); ++i) {
1849 code += "[]";
1850 }
1851 code += " " + name + " = ";
1852 code += "new " + GenTypeBasic(field_type) + "[";
1853 for (size_t i = 0; i < array_only_lengths.size(); ++i) {
1854 if (i != 0) { code += "]["; }
1855 code += NumToString(array_only_lengths[i].length);
1856 }
1857 code += "];\n";
1858 code += " ";
1859 // initialize array
1860 for (size_t i = 0; i < array_only_lengths.size(); ++i) {
1861 auto idx = "idx" + NumToString(i);
1862 code += "for (int " + idx + " = 0; " + idx + " < " +
1863 NumToString(array_only_lengths[i].length) + "; ++" + idx +
1864 ") {";
1865 }
1866 for (size_t i = 0; i < array_only_lengths.size(); ++i) {
1867 auto idx = "idx" + NumToString(i);
1868 if (i == 0) {
1869 code += name + "[" + idx;
1870 } else {
1871 code += "][" + idx;
1872 }
1873 }
1874 code += "] = _o";
1875 for (size_t i = 0, j = 0; i < array_lengths.size(); ++i) {
1876 code +=
1877 "." + GenGetterFuncName_ObjectAPI(array_lengths[i].name) + "()";
1878 if (array_lengths[i].length <= 0) continue;
1879 code += "[idx" + NumToString(j++) + "]";
1880 }
1881 code += ";";
1882 for (size_t i = 0; i < array_only_lengths.size(); ++i) {
1883 code += "}";
1884 }
1885 } else {
1886 code += " " + name + " = ";
1887 code += "_o";
1888 for (size_t i = 0; i < array_lengths.size(); ++i) {
1889 code += "." + GenGetterFuncName_ObjectAPI(array_lengths[i].name) +
1890 "()"; // + MakeCamel(array_lengths[i].name);
1891 }
1892 code += ";";
1893 }
1894 code += "\n";
1895 }
1896 array_lengths.pop_back();
1897 }
1898 }
1899
1900 void GenStructPackCall_ObjectAPI(const StructDef &struct_def,
1901 std::string *code_ptr,
1902 std::string prefix) const {
1903 auto &code = *code_ptr;
1904 for (auto it = struct_def.fields.vec.begin();
1905 it != struct_def.fields.vec.end(); ++it) {
1906 auto &field = **it;
1907 const auto &field_type = field.value.type;
1908 if (field_type.struct_def != nullptr) {
1909 GenStructPackCall_ObjectAPI(
1910 *field_type.struct_def, code_ptr,
1911 prefix + MakeCamel(field.name, false) + "_");
1912 } else {
1913 code += ",\n";
1914 code += prefix + MakeCamel(field.name, false);
1915 }
1916 }
1917 }
1918
1919 std::string ConvertPrimitiveTypeToObjectWrapper_ObjectAPI(
1920 std::string type_name) const {
1921 if (type_name == "boolean")
1922 return "Boolean";
1923 else if (type_name == "byte")
1924 return "Byte";
1925 else if (type_name == "char")
1926 return "Character";
1927 else if (type_name == "short")
1928 return "Short";
1929 else if (type_name == "int")
1930 return "Integer";
1931 else if (type_name == "long")
1932 return "Long";
1933 else if (type_name == "float")
1934 return "Float";
1935 else if (type_name == "double")
1936 return "Double";
1937 return type_name;
1938 }
1939
1940 std::string GenTypeGet_ObjectAPI(flatbuffers::Type type,
1941 const IDLOptions &opts, bool vectorelem,
1942 bool wrap_in_namespace) const {
1943 auto type_name = GenTypeNameDest(type);
1944 // Replace to ObjectBaseAPI Type Name
1945 switch (type.base_type) {
1946 case BASE_TYPE_STRUCT: FLATBUFFERS_FALLTHROUGH(); // fall thru
1947 case BASE_TYPE_ARRAY: FLATBUFFERS_FALLTHROUGH(); // fall thru
1948 case BASE_TYPE_VECTOR: {
1949 if (type.struct_def != nullptr) {
1950 auto type_name_length = type.struct_def->name.length();
1951 auto new_type_name =
1952 GenTypeName_ObjectAPI(type.struct_def->name, opts);
1953 type_name.replace(type_name.length() - type_name_length,
1954 type_name_length, new_type_name);
1955 } else if (type.element == BASE_TYPE_UNION) {
1956 if (wrap_in_namespace) {
1957 type_name = WrapInNameSpace(*type.enum_def) + "Union";
1958 } else {
1959 type_name = type.enum_def->name + "Union";
1960 }
1961 }
1962 break;
1963 }
1964
1965 case BASE_TYPE_UNION: {
1966 if (wrap_in_namespace) {
1967 type_name = WrapInNameSpace(*type.enum_def) + "Union";
1968 } else {
1969 type_name = type.enum_def->name + "Union";
1970 }
1971 break;
1972 }
1973 default: break;
1974 }
1975 if (vectorelem) { return type_name; }
1976 switch (type.base_type) {
1977 case BASE_TYPE_ARRAY: FLATBUFFERS_FALLTHROUGH(); // fall thru
1978 case BASE_TYPE_VECTOR: {
1979 type_name = type_name + "[]";
1980 break;
1981 }
1982 default: break;
1983 }
1984 return type_name;
1985 }
1986
1987 std::string GenConcreteTypeGet_ObjectAPI(flatbuffers::Type type,
1988 const IDLOptions &opts) const {
1989 auto type_name = GenTypeNameDest(type);
1990 // Replace to ObjectBaseAPI Type Name
1991 switch (type.base_type) {
1992 case BASE_TYPE_STRUCT: FLATBUFFERS_FALLTHROUGH(); // fall thru
1993 case BASE_TYPE_ARRAY: FLATBUFFERS_FALLTHROUGH(); // fall thru
1994 case BASE_TYPE_VECTOR: {
1995 if (type.struct_def != nullptr) {
1996 auto type_name_length = type.struct_def->name.length();
1997 auto new_type_name =
1998 GenTypeName_ObjectAPI(type.struct_def->name, opts);
1999 type_name.replace(type_name.length() - type_name_length,
2000 type_name_length, new_type_name);
2001 } else if (type.element == BASE_TYPE_UNION) {
2002 type_name = WrapInNameSpace(*type.enum_def) + "Union";
2003 }
2004 break;
2005 }
2006
2007 case BASE_TYPE_UNION: {
2008 type_name = WrapInNameSpace(*type.enum_def) + "Union";
2009 break;
2010 }
2011 default: break;
2012 }
2013
2014 switch (type.base_type) {
2015 case BASE_TYPE_ARRAY: FLATBUFFERS_FALLTHROUGH(); // fall thru
2016 case BASE_TYPE_VECTOR: {
2017 type_name = type_name + "[]";
2018 break;
2019 }
2020 default: break;
2021 }
2022 return type_name;
2023 }
2024
2025 void GenStruct_ObjectAPI(StructDef &struct_def, std::string *code_ptr,
2026 const IDLOptions &opts) const {
2027 if (struct_def.generated) return;
2028 auto &code = *code_ptr;
2029 if (struct_def.attributes.Lookup("private")) {
2030 // For Java, we leave the enum unmarked to indicate package-private
2031 } else {
2032 code += "public ";
2033 }
2034
2035 auto class_name = GenTypeName_ObjectAPI(struct_def.name, opts);
2036 code += "class " + class_name;
2037 code += " {\n";
2038 // Generate Properties
2039 for (auto it = struct_def.fields.vec.begin();
2040 it != struct_def.fields.vec.end(); ++it) {
2041 auto &field = **it;
2042 if (field.deprecated) continue;
2043 if (field.value.type.base_type == BASE_TYPE_UTYPE) continue;
2044 if (field.value.type.element == BASE_TYPE_UTYPE) continue;
2045 auto type_name =
2046 GenTypeGet_ObjectAPI(field.value.type, opts, false, true);
2047 if (field.IsScalarOptional())
2048 type_name = ConvertPrimitiveTypeToObjectWrapper_ObjectAPI(type_name);
2049 auto camel_name = MakeCamel(field.name, false);
2050 code += " private " + type_name + " " + camel_name + ";\n";
2051 }
2052 // Generate Java getters and setters
2053 code += "\n";
2054 for (auto it = struct_def.fields.vec.begin();
2055 it != struct_def.fields.vec.end(); ++it) {
2056 auto &field = **it;
2057 if (field.deprecated) continue;
2058 if (field.value.type.base_type == BASE_TYPE_UTYPE) continue;
2059 if (field.value.type.element == BASE_TYPE_UTYPE) continue;
2060 auto type_name =
2061 GenTypeGet_ObjectAPI(field.value.type, opts, false, true);
2062 if (field.IsScalarOptional())
2063 type_name = ConvertPrimitiveTypeToObjectWrapper_ObjectAPI(type_name);
2064 auto camel_name = MakeCamel(field.name, false);
2065 code += " public " + type_name + " " +
2066 GenGetterFuncName_ObjectAPI(field.name) + "() { return " +
2067 camel_name + "; }\n\n";
2068 std::string array_validation = "";
2069 if (field.value.type.base_type == BASE_TYPE_ARRAY) {
2070 array_validation =
2071 "if (" + camel_name + " != null && " + camel_name +
2072 ".length == " + NumToString(field.value.type.fixed_length) + ") ";
2073 }
2074 code += " public void " + GenSetterFuncName_ObjectAPI(field.name) + "(" +
2075 type_name + " " + camel_name + ") { " + array_validation +
2076 "this." + camel_name + " = " + camel_name + "; }\n\n";
2077 }
2078 // Generate Constructor
2079 code += "\n";
2080 code += " public " + class_name + "() {\n";
2081 for (auto it = struct_def.fields.vec.begin();
2082 it != struct_def.fields.vec.end(); ++it) {
2083 auto &field = **it;
2084 if (field.deprecated) continue;
2085 if (field.value.type.base_type == BASE_TYPE_UTYPE) continue;
2086 if (field.value.type.element == BASE_TYPE_UTYPE) continue;
2087 code += " this." + MakeCamel(field.name, false) + " = ";
2088 auto type_name =
2089 GenTypeGet_ObjectAPI(field.value.type, opts, false, true);
2090 if (IsScalar(field.value.type.base_type)) {
2091 if (field.IsScalarOptional()) {
2092 code += "null;\n";
2093 } else {
2094 code += GenDefaultValue(field) + ";\n";
2095 }
2096 } else {
2097 switch (field.value.type.base_type) {
2098 case BASE_TYPE_STRUCT: {
2099 if (IsStruct(field.value.type)) {
2100 code += "new " + type_name + "();\n";
2101 } else {
2102 code += "null;\n";
2103 }
2104 break;
2105 }
2106 case BASE_TYPE_ARRAY: {
2107 code += "new " + type_name.substr(0, type_name.length() - 1) +
2108 NumToString(field.value.type.fixed_length) + "];\n";
2109 break;
2110 }
2111 default: {
2112 code += "null;\n";
2113 break;
2114 }
2115 }
2116 }
2117 }
2118 code += " }\n";
2119 if (parser_.root_struct_def_ == &struct_def) {
2120 code += " public static " + class_name +
2121 " deserializeFromBinary(byte[] fbBuffer) {\n";
2122 code += " return " + struct_def.name + ".getRootAs" + struct_def.name +
2123 "(ByteBuffer.wrap(fbBuffer)).unpack();\n";
2124 code += " }\n";
2125 code += " public byte[] serializeToBinary() {\n";
2126 code += " FlatBufferBuilder fbb = new FlatBufferBuilder();\n";
2127 code += " " + struct_def.name + ".finish" + struct_def.name +
2128 "Buffer(fbb, " + struct_def.name + ".pack(fbb, this));\n";
2129 code += " return fbb.sizedByteArray();\n";
2130 code += " }\n";
2131 }
2132 code += "}\n\n";
2133 }
2134
2135 // This tracks the current namespace used to determine if a type need to be
2136 // prefixed by its namespace
2137 const Namespace *cur_name_space_;
2138};
2139} // namespace java
2140
2141bool GenerateJava(const Parser &parser, const std::string &path,
2142 const std::string &file_name) {
2143 java::JavaGenerator generator(parser, path, file_name);
2144 return generator.generate();
2145}
2146
2147} // namespace flatbuffers
2148