blob: ee0939120fb2feae15788dea0ba44d4b17333015 [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"
23
Austin Schuh272c6132020-11-14 16:37:52 -080024namespace 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 {
James Kuszmaul8e62b022022-03-22 09:33:25 -070038 struct FieldArrayLength {
39 std::string name;
40 int length;
41 };
42
Austin Schuh272c6132020-11-14 16:37:52 -080043 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 }
James Kuszmaul8e62b022022-03-22 09:33:25 -070067
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 }
Austin Schuh272c6132020-11-14 16:37:52 -080080 }
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;
James Kuszmaul8e62b022022-03-22 09:33:25 -070088 GenStruct(struct_def, &declcode, parser_.opts);
Austin Schuh272c6132020-11-14 16:37:52 -080089 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 }
James Kuszmaul8e62b022022-03-22 09:33:25 -070096
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 }
Austin Schuh272c6132020-11-14 16:37:52 -0800109 }
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)
James Kuszmaul8e62b022022-03-22 09:33:25 -0700261 return "(int) ";
Austin Schuh272c6132020-11-14 16:37:52 -0800262 else if (type.base_type == BASE_TYPE_USHORT)
James Kuszmaul8e62b022022-03-22 09:33:25 -0700263 return "(short) ";
Austin Schuh272c6132020-11-14 16:37:52 -0800264 else if (type.base_type == BASE_TYPE_UCHAR)
James Kuszmaul8e62b022022-03-22 09:33:25 -0700265 return "(byte) ";
Austin Schuh272c6132020-11-14 16:37:52 -0800266 }
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
James Kuszmaul8e62b022022-03-22 09:33:25 -0700334 code += "@SuppressWarnings(\"unused\")\n";
Austin Schuh272c6132020-11-14 16:37:52 -0800335 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 ";
James Kuszmaul8e62b022022-03-22 09:33:25 -0700347 code += GenTypeBasic(DestinationType(enum_def.underlying_type, false));
Austin Schuh272c6132020-11-14 16:37:52 -0800348 code += " ";
349 code += ev.name + " = ";
350 code += enum_def.ToString(ev);
351 code += ";\n";
352 }
353
James Kuszmaul8e62b022022-03-22 09:33:25 -0700354 // Generate a string table for enum values.
Austin Schuh272c6132020-11-14 16:37:52 -0800355 // 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;
James Kuszmaul8e62b022022-03-22 09:33:25 -0700362 if (range / static_cast<uint64_t>(enum_def.size()) < kMaxSparseness &&
363 GenTypeBasic(DestinationType(enum_def.underlying_type, false)) !=
364 "long") {
Austin Schuh272c6132020-11-14 16:37:52 -0800365 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";
James Kuszmaul8e62b022022-03-22 09:33:25 -0700378 code += " name";
Austin Schuh272c6132020-11-14 16:37:52 -0800379 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") {
James Kuszmaul8e62b022022-03-22 09:33:25 -0700402 getter += ConvertCase(GenTypeBasic(type), Case::kUpperCamel);
Austin Schuh272c6132020-11-14 16:37:52 -0800403 }
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") {
James Kuszmaul8e62b022022-03-22 09:33:25 -0700418 getter += ConvertCase(GenTypeBasic(type), Case::kUpperCamel);
Austin Schuh272c6132020-11-14 16:37:52 -0800419 }
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) {
James Kuszmaul8e62b022022-03-22 09:33:25 -0700431 setter += ConvertCase(GenTypeBasic(type), Case::kUpperCamel);
Austin Schuh272c6132020-11-14 16:37:52 -0800432 }
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 {
James Kuszmaul8e62b022022-03-22 09:33:25 -0700441 return IsScalar(type.base_type)
442 ? ConvertCase(GenTypeBasic(type), Case::kUpperCamel)
443 : (IsStruct(type) ? "Struct" : "Offset");
Austin Schuh272c6132020-11-14 16:37:52 -0800444 }
445
446 // Recursively generate arguments for a constructor, to deal with nested
447 // structs.
448 void GenStructArgs(const StructDef &struct_def, std::string *code_ptr,
449 const char *nameprefix, size_t array_count = 0) const {
450 std::string &code = *code_ptr;
451 for (auto it = struct_def.fields.vec.begin();
452 it != struct_def.fields.vec.end(); ++it) {
453 auto &field = **it;
454 const auto &field_type = field.value.type;
455 const auto array_field = IsArray(field_type);
456 const auto &type = array_field ? field_type.VectorType()
457 : DestinationType(field_type, false);
458 const auto array_cnt = array_field ? (array_count + 1) : array_count;
459 if (IsStruct(type)) {
460 // Generate arguments for a struct inside a struct. To ensure names
461 // don't clash, and to make it obvious these arguments are constructing
462 // a nested struct, prefix the name with the field name.
463 GenStructArgs(*field_type.struct_def, code_ptr,
464 (nameprefix + (field.name + "_")).c_str(), array_cnt);
465 } else {
466 code += ", ";
James Kuszmaul8e62b022022-03-22 09:33:25 -0700467 code += GenTypeNameDest(field.value.type);
Austin Schuh272c6132020-11-14 16:37:52 -0800468 for (size_t i = 0; i < array_cnt; i++) code += "[]";
469 code += " ";
470 code += nameprefix;
James Kuszmaul8e62b022022-03-22 09:33:25 -0700471 code += ConvertCase(field.name, Case::kLowerCamel);
Austin Schuh272c6132020-11-14 16:37:52 -0800472 }
473 }
474 }
475
476 // Recusively generate struct construction statements of the form:
477 // builder.putType(name);
478 // and insert manual padding.
479 void GenStructBody(const StructDef &struct_def, std::string *code_ptr,
480 const char *nameprefix, size_t index = 0,
481 bool in_array = false) const {
482 std::string &code = *code_ptr;
483 std::string indent((index + 1) * 2, ' ');
484 code += indent + " builder.prep(";
485 code += NumToString(struct_def.minalign) + ", ";
486 code += NumToString(struct_def.bytesize) + ");\n";
487 for (auto it = struct_def.fields.vec.rbegin();
488 it != struct_def.fields.vec.rend(); ++it) {
489 auto &field = **it;
490 const auto &field_type = field.value.type;
491 if (field.padding) {
492 code += indent + " builder.pad(";
493 code += NumToString(field.padding) + ");\n";
494 }
495 if (IsStruct(field_type)) {
496 GenStructBody(*field_type.struct_def, code_ptr,
497 (nameprefix + (field.name + "_")).c_str(), index,
498 in_array);
499 } else {
500 const auto &type =
501 IsArray(field_type) ? field_type.VectorType() : field_type;
502 const auto index_var = "_idx" + NumToString(index);
503 if (IsArray(field_type)) {
504 code += indent + " for (int " + index_var + " = ";
505 code += NumToString(field_type.fixed_length);
506 code += "; " + index_var + " > 0; " + index_var + "--) {\n";
507 in_array = true;
508 }
509 if (IsStruct(type)) {
510 GenStructBody(*field_type.struct_def, code_ptr,
511 (nameprefix + (field.name + "_")).c_str(), index + 1,
512 in_array);
513 } else {
514 code += IsArray(field_type) ? " " : "";
515 code += indent + " builder.put";
516 code += GenMethod(type) + "(";
517 code += SourceCast(type);
James Kuszmaul8e62b022022-03-22 09:33:25 -0700518 auto argname =
519 nameprefix + ConvertCase(field.name, Case::kLowerCamel);
Austin Schuh272c6132020-11-14 16:37:52 -0800520 code += argname;
521 size_t array_cnt = index + (IsArray(field_type) ? 1 : 0);
522 for (size_t i = 0; in_array && i < array_cnt; i++) {
523 code += "[_idx" + NumToString(i) + "-1]";
524 }
525 code += ");\n";
526 }
527 if (IsArray(field_type)) { code += indent + " }\n"; }
528 }
529 }
530 }
531
532 std::string GenByteBufferLength(const char *bb_name) const {
533 std::string bb_len = bb_name;
534 bb_len += ".capacity()";
535 return bb_len;
536 }
537
538 std::string GenOffsetGetter(flatbuffers::FieldDef *key_field,
539 const char *num = nullptr) const {
540 std::string key_offset = "";
541 key_offset += "__offset(" + NumToString(key_field->value.offset) + ", ";
542 if (num) {
543 key_offset += num;
544 key_offset += ", _bb)";
545 } else {
546 key_offset += GenByteBufferLength("bb");
547 key_offset += " - tableOffset, bb)";
548 }
549 return key_offset;
550 }
551
552 std::string GenLookupKeyGetter(flatbuffers::FieldDef *key_field) const {
553 std::string key_getter = " ";
554 key_getter += "int tableOffset = ";
555 key_getter += "__indirect(vectorLocation + 4 * (start + middle)";
556 key_getter += ", bb);\n ";
557 if (IsString(key_field->value.type)) {
558 key_getter += "int comp = ";
559 key_getter += "compareStrings(";
560 key_getter += GenOffsetGetter(key_field);
561 key_getter += ", byteKey, bb);\n";
562 } else {
563 auto get_val = GenGetterForLookupByKey(key_field, "bb");
564 key_getter += GenTypeNameDest(key_field->value.type) + " val = ";
565 key_getter += get_val + ";\n";
566 key_getter += " int comp = val > key ? 1 : val < key ? -1 : 0;\n";
567 }
568 return key_getter;
569 }
570
571 std::string GenKeyGetter(flatbuffers::FieldDef *key_field) const {
572 std::string key_getter = "";
573 auto data_buffer = "_bb";
574 if (IsString(key_field->value.type)) {
575 key_getter += " return ";
576 key_getter += "";
577 key_getter += "compareStrings(";
578 key_getter += GenOffsetGetter(key_field, "o1") + ", ";
579 key_getter += GenOffsetGetter(key_field, "o2") + ", " + data_buffer + ")";
580 key_getter += ";";
581 } else {
582 auto field_getter = GenGetterForLookupByKey(key_field, data_buffer, "o1");
583 key_getter +=
584 "\n " + GenTypeNameDest(key_field->value.type) + " val_1 = ";
585 key_getter +=
586 field_getter + ";\n " + GenTypeNameDest(key_field->value.type);
587 key_getter += " val_2 = ";
588 field_getter = GenGetterForLookupByKey(key_field, data_buffer, "o2");
589 key_getter += field_getter + ";\n";
590 key_getter += " return val_1 > val_2 ? 1 : val_1 < val_2 ? -1 : 0;\n ";
591 }
592 return key_getter;
593 }
594
James Kuszmaul8e62b022022-03-22 09:33:25 -0700595 void GenStruct(StructDef &struct_def, std::string *code_ptr,
596 const IDLOptions &opts) const {
Austin Schuh272c6132020-11-14 16:37:52 -0800597 if (struct_def.generated) return;
598 std::string &code = *code_ptr;
599
600 // Generate a struct accessor class, with methods of the form:
601 // public type name() { return bb.getType(i + offset); }
602 // or for tables of the form:
603 // public type name() {
604 // int o = __offset(offset); return o != 0 ? bb.getType(o + i) : default;
605 // }
606 GenComment(struct_def.doc_comment, code_ptr, &comment_config);
607
608 if (parser_.opts.gen_generated) {
609 code += "@javax.annotation.Generated(value=\"flatc\")\n";
610 }
611 code += "@SuppressWarnings(\"unused\")\n";
612 if (struct_def.attributes.Lookup("private")) {
613 // For Java, we leave the struct unmarked to indicate package-private
614 } else {
615 code += "public ";
616 }
617 code += "final class " + struct_def.name;
618 code += " extends ";
619 code += struct_def.fixed ? "Struct" : "Table";
620 code += " {\n";
621
622 if (!struct_def.fixed) {
623 // Generate verson check method.
624 // Force compile time error if not using the same version runtime.
625 code += " public static void ValidateVersion() {";
626 code += " Constants.";
James Kuszmaul8e62b022022-03-22 09:33:25 -0700627 code += "FLATBUFFERS_2_0_0(); ";
Austin Schuh272c6132020-11-14 16:37:52 -0800628 code += "}\n";
629
630 // Generate a special accessor for the table that when used as the root
631 // of a FlatBuffer
632 std::string method_name = "getRootAs" + struct_def.name;
633 std::string method_signature =
634 " public static " + struct_def.name + " " + method_name;
635
636 // create convenience method that doesn't require an existing object
637 code += method_signature + "(ByteBuffer _bb) ";
638 code += "{ return " + method_name + "(_bb, new " + struct_def.name +
639 "()); }\n";
640
641 // create method that allows object reuse
642 code +=
643 method_signature + "(ByteBuffer _bb, " + struct_def.name + " obj) { ";
644 code += "_bb.order(ByteOrder.LITTLE_ENDIAN); ";
645 code += "return (obj.__assign(_bb.getInt(_bb.";
646 code += "position()";
647 code += ") + _bb.";
648 code += "position()";
649 code += ", _bb)); }\n";
650 if (parser_.root_struct_def_ == &struct_def) {
651 if (parser_.file_identifier_.length()) {
652 // Check if a buffer has the identifier.
653 code += " public static ";
654 code += "boolean " + struct_def.name;
655 code += "BufferHasIdentifier(ByteBuffer _bb) { return ";
656 code += "__has_identifier(_bb, \"";
657 code += parser_.file_identifier_;
658 code += "\"); }\n";
659 }
660 }
661 }
662 // Generate the __init method that sets the field in a pre-existing
663 // accessor object. This is to allow object reuse.
664 code += " public void __init(int _i, ByteBuffer _bb) ";
665 code += "{ ";
666 code += "__reset(_i, _bb); ";
667 code += "}\n";
668 code +=
669 " public " + struct_def.name + " __assign(int _i, ByteBuffer _bb) ";
670 code += "{ __init(_i, _bb); return this; }\n\n";
671 for (auto it = struct_def.fields.vec.begin();
672 it != struct_def.fields.vec.end(); ++it) {
673 auto &field = **it;
674 if (field.deprecated) continue;
675 GenComment(field.doc_comment, code_ptr, &comment_config, " ");
676 std::string type_name = GenTypeGet(field.value.type);
677 std::string type_name_dest = GenTypeNameDest(field.value.type);
678 std::string conditional_cast = "";
679 std::string optional = "";
680 std::string dest_mask = DestinationMask(field.value.type, true);
681 std::string dest_cast = DestinationCast(field.value.type);
682 std::string src_cast = SourceCast(field.value.type);
683 std::string method_start =
684 " public " +
James Kuszmaul8e62b022022-03-22 09:33:25 -0700685 (field.IsRequired() ? "" : GenNullableAnnotation(field.value.type)) +
Austin Schuh272c6132020-11-14 16:37:52 -0800686 GenPureAnnotation(field.value.type) + type_name_dest + optional +
James Kuszmaul8e62b022022-03-22 09:33:25 -0700687 " " + ConvertCase(field.name, Case::kLowerCamel);
Austin Schuh272c6132020-11-14 16:37:52 -0800688 std::string obj = "obj";
689
690 // Most field accessors need to retrieve and test the field offset first,
691 // this is the prefix code for that:
692 auto offset_prefix =
693 IsArray(field.value.type)
694 ? " { return "
695 : (" { int o = __offset(" + NumToString(field.value.offset) +
696 "); return o != 0 ? ");
697 // Generate the accessors that don't do object reuse.
698 if (field.value.type.base_type == BASE_TYPE_STRUCT) {
699 // Calls the accessor that takes an accessor object with a new object.
700 code += method_start + "() { return ";
James Kuszmaul8e62b022022-03-22 09:33:25 -0700701 code += ConvertCase(field.name, Case::kLowerCamel);
Austin Schuh272c6132020-11-14 16:37:52 -0800702 code += "(new ";
703 code += type_name + "()); }\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -0700704 } else if (IsSeries(field.value.type) &&
Austin Schuh272c6132020-11-14 16:37:52 -0800705 field.value.type.element == BASE_TYPE_STRUCT) {
706 // Accessors for vectors of structs also take accessor objects, this
707 // generates a variant without that argument.
708 code += method_start + "(int j) { return ";
James Kuszmaul8e62b022022-03-22 09:33:25 -0700709 code += ConvertCase(field.name, Case::kLowerCamel);
Austin Schuh272c6132020-11-14 16:37:52 -0800710 code += "(new " + type_name + "(), j); }\n";
711 }
712
713 if (field.IsScalarOptional()) { code += GenOptionalScalarCheck(field); }
714 std::string getter = dest_cast + GenGetter(field.value.type);
715 code += method_start;
716 std::string default_cast = "";
717 std::string member_suffix = "; ";
718 if (IsScalar(field.value.type.base_type)) {
719 code += "()";
720 member_suffix += "";
721 if (struct_def.fixed) {
722 code += " { return " + getter;
723 code += "(bb_pos + ";
724 code += NumToString(field.value.offset) + ")";
725 code += dest_mask;
726 } else {
727 code += offset_prefix + getter;
728 code += "(o + bb_pos)" + dest_mask;
729 code += " : " + default_cast;
730 code += GenDefaultValue(field);
731 }
732 } else {
733 switch (field.value.type.base_type) {
734 case BASE_TYPE_STRUCT:
735 code += "(" + type_name + " obj)";
736 if (struct_def.fixed) {
737 code += " { return " + obj + ".__assign(";
738 code += "bb_pos + " + NumToString(field.value.offset) + ", ";
739 code += "bb)";
740 } else {
741 code += offset_prefix + conditional_cast;
742 code += obj + ".__assign(";
743 code += field.value.type.struct_def->fixed
744 ? "o + bb_pos"
745 : "__indirect(o + bb_pos)";
746 code += ", bb) : null";
747 }
748 break;
749 case BASE_TYPE_STRING:
750 code += "()";
751 member_suffix += "";
752 code += offset_prefix + getter + "(o + ";
753 code += "bb_pos) : null";
754 break;
755 case BASE_TYPE_ARRAY: FLATBUFFERS_FALLTHROUGH(); // fall thru
756 case BASE_TYPE_VECTOR: {
757 auto vectortype = field.value.type.VectorType();
758 code += "(";
759 if (vectortype.base_type == BASE_TYPE_STRUCT) {
760 code += type_name + " obj, ";
761 getter = obj + ".__assign";
762 } else if (vectortype.base_type == BASE_TYPE_UNION) {
763 code += type_name + " obj, ";
764 }
765 code += "int j)";
766 const auto body = offset_prefix + conditional_cast + getter + "(";
767 if (vectortype.base_type == BASE_TYPE_UNION) {
768 code += body + "obj, ";
769 } else {
770 code += body;
771 }
772 std::string index;
773 if (IsArray(field.value.type)) {
774 index += "bb_pos + " + NumToString(field.value.offset) + " + ";
775 } else {
776 index += "__vector(o) + ";
777 }
778 index += "j * " + NumToString(InlineSize(vectortype));
779 if (vectortype.base_type == BASE_TYPE_STRUCT) {
780 code += vectortype.struct_def->fixed
781 ? index
782 : "__indirect(" + index + ")";
783 code += ", bb";
784 } else {
785 code += index;
786 }
787 code += ")" + dest_mask;
788 if (!IsArray(field.value.type)) {
789 code += " : ";
790 code +=
791 field.value.type.element == BASE_TYPE_BOOL
792 ? "false"
793 : (IsScalar(field.value.type.element) ? default_cast + "0"
794 : "null");
795 }
796
797 break;
798 }
799 case BASE_TYPE_UNION:
800 code += "(" + type_name + " obj)" + offset_prefix + getter;
801 code += "(obj, o + bb_pos) : null";
802 break;
803 default: FLATBUFFERS_ASSERT(0);
804 }
805 }
806 code += member_suffix;
807 code += "}\n";
808 if (IsVector(field.value.type)) {
James Kuszmaul8e62b022022-03-22 09:33:25 -0700809 code += " public int " + ConvertCase(field.name, Case::kLowerCamel);
Austin Schuh272c6132020-11-14 16:37:52 -0800810 code += "Length";
811 code += "()";
812 code += offset_prefix;
813 code += "__vector_len(o) : 0; ";
814 code += "";
815 code += "}\n";
816 // See if we should generate a by-key accessor.
817 if (field.value.type.element == BASE_TYPE_STRUCT &&
818 !field.value.type.struct_def->fixed) {
819 auto &sd = *field.value.type.struct_def;
820 auto &fields = sd.fields.vec;
821 for (auto kit = fields.begin(); kit != fields.end(); ++kit) {
822 auto &key_field = **kit;
823 if (key_field.key) {
824 auto qualified_name = WrapInNameSpace(sd);
825 code += " public " + qualified_name + " ";
James Kuszmaul8e62b022022-03-22 09:33:25 -0700826 code += ConvertCase(field.name, Case::kLowerCamel) + "ByKey(";
Austin Schuh272c6132020-11-14 16:37:52 -0800827 code += GenTypeNameDest(key_field.value.type) + " key)";
828 code += offset_prefix;
829 code += qualified_name + ".__lookup_by_key(";
830 code += "null, ";
831 code += "__vector(o), key, ";
832 code += "bb) : null; ";
833 code += "}\n";
834 code += " public " + qualified_name + " ";
James Kuszmaul8e62b022022-03-22 09:33:25 -0700835 code += ConvertCase(field.name, Case::kLowerCamel) + "ByKey(";
Austin Schuh272c6132020-11-14 16:37:52 -0800836 code += qualified_name + " obj, ";
837 code += GenTypeNameDest(key_field.value.type) + " key)";
838 code += offset_prefix;
839 code += qualified_name + ".__lookup_by_key(obj, ";
840 code += "__vector(o), key, ";
841 code += "bb) : null; ";
842 code += "}\n";
843 break;
844 }
845 }
846 }
847 }
848 // Generate the accessors for vector of structs with vector access object
849 if (IsVector(field.value.type)) {
850 std::string vector_type_name;
851 const auto &element_base_type = field.value.type.VectorType().base_type;
852 if (IsScalar(element_base_type)) {
James Kuszmaul8e62b022022-03-22 09:33:25 -0700853 vector_type_name =
854 ConvertCase(type_name, Case::kUpperCamel) + "Vector";
Austin Schuh272c6132020-11-14 16:37:52 -0800855 } else if (element_base_type == BASE_TYPE_STRING) {
856 vector_type_name = "StringVector";
857 } else if (element_base_type == BASE_TYPE_UNION) {
858 vector_type_name = "UnionVector";
859 } else {
860 vector_type_name = type_name + ".Vector";
861 }
James Kuszmaul8e62b022022-03-22 09:33:25 -0700862 auto vector_method_start =
863 GenNullableAnnotation(field.value.type) + " public " +
864 vector_type_name + optional + " " +
865 ConvertCase(field.name, Case::kLowerCamel) + "Vector";
Austin Schuh272c6132020-11-14 16:37:52 -0800866 code += vector_method_start + "() { return ";
James Kuszmaul8e62b022022-03-22 09:33:25 -0700867 code += ConvertCase(field.name, Case::kLowerCamel) + "Vector";
Austin Schuh272c6132020-11-14 16:37:52 -0800868 code += "(new " + vector_type_name + "()); }\n";
869 code += vector_method_start + "(" + vector_type_name + " obj)";
870 code += offset_prefix + conditional_cast + obj + ".__assign(";
871 code += "__vector(o), ";
872 if (!IsScalar(element_base_type)) {
873 auto vectortype = field.value.type.VectorType();
874 code += NumToString(InlineSize(vectortype)) + ", ";
875 }
876 code += "bb) : null" + member_suffix + "}\n";
877 }
878 // Generate a ByteBuffer accessor for strings & vectors of scalars.
879 if ((IsVector(field.value.type) &&
880 IsScalar(field.value.type.VectorType().base_type)) ||
881 IsString(field.value.type)) {
882 code += " public ByteBuffer ";
James Kuszmaul8e62b022022-03-22 09:33:25 -0700883 code += ConvertCase(field.name, Case::kLowerCamel);
Austin Schuh272c6132020-11-14 16:37:52 -0800884 code += "AsByteBuffer() { return ";
885 code += "__vector_as_bytebuffer(";
886 code += NumToString(field.value.offset) + ", ";
887 code += NumToString(IsString(field.value.type)
888 ? 1
889 : InlineSize(field.value.type.VectorType()));
890 code += "); }\n";
891 code += " public ByteBuffer ";
James Kuszmaul8e62b022022-03-22 09:33:25 -0700892 code += ConvertCase(field.name, Case::kLowerCamel);
Austin Schuh272c6132020-11-14 16:37:52 -0800893 code += "InByteBuffer(ByteBuffer _bb) { return ";
894 code += "__vector_in_bytebuffer(_bb, ";
895 code += NumToString(field.value.offset) + ", ";
896 code += NumToString(IsString(field.value.type)
897 ? 1
898 : InlineSize(field.value.type.VectorType()));
899 code += "); }\n";
900 }
901 // generate object accessors if is nested_flatbuffer
902 if (field.nested_flatbuffer) {
903 auto nested_type_name = WrapInNameSpace(*field.nested_flatbuffer);
James Kuszmaul8e62b022022-03-22 09:33:25 -0700904 auto nested_method_name = ConvertCase(field.name, Case::kLowerCamel) +
905 "As" + field.nested_flatbuffer->name;
Austin Schuh272c6132020-11-14 16:37:52 -0800906 auto get_nested_method_name = nested_method_name;
907 code += " public " + nested_type_name + " ";
908 code += nested_method_name + "() { return ";
909 code +=
910 get_nested_method_name + "(new " + nested_type_name + "()); }\n";
911 code += " public " + nested_type_name + " ";
912 code += get_nested_method_name + "(";
913 code += nested_type_name + " obj";
914 code += ") { int o = __offset(";
915 code += NumToString(field.value.offset) + "); ";
916 code += "return o != 0 ? " + conditional_cast + obj + ".__assign(";
917 code += "";
918 code += "__indirect(__vector(o)), ";
919 code += "bb) : null; }\n";
920 }
921 // Generate mutators for scalar fields or vectors of scalars.
922 if (parser_.opts.mutable_buffer) {
923 auto is_series = (IsSeries(field.value.type));
924 const auto &underlying_type =
925 is_series ? field.value.type.VectorType() : field.value.type;
926 // Boolean parameters have to be explicitly converted to byte
927 // representation.
928 auto setter_parameter = underlying_type.base_type == BASE_TYPE_BOOL
929 ? "(byte)(" + field.name + " ? 1 : 0)"
930 : field.name;
James Kuszmaul8e62b022022-03-22 09:33:25 -0700931 auto mutator_prefix = "mutate";
Austin Schuh272c6132020-11-14 16:37:52 -0800932 // A vector mutator also needs the index of the vector element it should
933 // mutate.
934 auto mutator_params = (is_series ? "(int j, " : "(") +
935 GenTypeNameDest(underlying_type) + " " +
936 field.name + ") { ";
937 auto setter_index =
938 is_series
939 ? (IsArray(field.value.type)
940 ? "bb_pos + " + NumToString(field.value.offset)
941 : "__vector(o)") +
942 +" + j * " + NumToString(InlineSize(underlying_type))
943 : (struct_def.fixed
944 ? "bb_pos + " + NumToString(field.value.offset)
945 : "o + bb_pos");
946 if (IsScalar(underlying_type.base_type) && !IsUnion(field.value.type)) {
947 code += " public ";
948 code += struct_def.fixed ? "void " : "boolean ";
James Kuszmaul8e62b022022-03-22 09:33:25 -0700949 code += mutator_prefix + ConvertCase(field.name, Case::kUpperCamel);
Austin Schuh272c6132020-11-14 16:37:52 -0800950 code += mutator_params;
951 if (struct_def.fixed) {
952 code += GenSetter(underlying_type) + "(" + setter_index + ", ";
953 code += src_cast + setter_parameter + "); }\n";
954 } else {
955 code += "int o = __offset(";
956 code += NumToString(field.value.offset) + ");";
957 code += " if (o != 0) { " + GenSetter(underlying_type);
958 code += "(" + setter_index + ", " + src_cast + setter_parameter +
959 "); return true; } else { return false; } }\n";
960 }
961 }
962 }
963 if (parser_.opts.java_primitive_has_method &&
964 IsScalar(field.value.type.base_type) && !struct_def.fixed) {
James Kuszmaul8e62b022022-03-22 09:33:25 -0700965 auto vt_offset_constant =
966 " public static final int VT_" +
967 ConvertCase(field.name, Case::kScreamingSnake) + " = " +
968 NumToString(field.value.offset) + ";";
Austin Schuh272c6132020-11-14 16:37:52 -0800969
970 code += vt_offset_constant;
971 code += "\n";
972 }
973 }
974 code += "\n";
James Kuszmaul8e62b022022-03-22 09:33:25 -0700975 auto struct_has_create = false;
976 std::set<flatbuffers::FieldDef *> field_has_create_set;
Austin Schuh272c6132020-11-14 16:37:52 -0800977 flatbuffers::FieldDef *key_field = nullptr;
978 if (struct_def.fixed) {
James Kuszmaul8e62b022022-03-22 09:33:25 -0700979 struct_has_create = true;
Austin Schuh272c6132020-11-14 16:37:52 -0800980 // create a struct constructor function
981 code += " public static " + GenOffsetType() + " ";
982 code += "create";
983 code += struct_def.name + "(FlatBufferBuilder builder";
984 GenStructArgs(struct_def, code_ptr, "");
985 code += ") {\n";
986 GenStructBody(struct_def, code_ptr, "");
987 code += " return ";
988 code += GenOffsetConstruct("builder." + std::string("offset()"));
989 code += ";\n }\n";
990 } else {
991 // Generate a method that creates a table in one go. This is only possible
992 // when the table has no struct fields, since those have to be created
993 // inline, and there's no way to do so in Java.
994 bool has_no_struct_fields = true;
995 int num_fields = 0;
996 for (auto it = struct_def.fields.vec.begin();
997 it != struct_def.fields.vec.end(); ++it) {
998 auto &field = **it;
999 if (field.deprecated) continue;
1000 if (IsStruct(field.value.type)) {
1001 has_no_struct_fields = false;
1002 } else {
1003 num_fields++;
1004 }
1005 }
1006 // JVM specifications restrict default constructor params to be < 255.
1007 // Longs and doubles take up 2 units, so we set the limit to be < 127.
1008 if (has_no_struct_fields && num_fields && num_fields < 127) {
James Kuszmaul8e62b022022-03-22 09:33:25 -07001009 struct_has_create = true;
Austin Schuh272c6132020-11-14 16:37:52 -08001010 // Generate a table constructor of the form:
1011 // public static int createName(FlatBufferBuilder builder, args...)
1012 code += " public static " + GenOffsetType() + " ";
1013 code += "create" + struct_def.name;
1014 code += "(FlatBufferBuilder builder";
1015 for (auto it = struct_def.fields.vec.begin();
1016 it != struct_def.fields.vec.end(); ++it) {
1017 auto &field = **it;
James Kuszmaul8e62b022022-03-22 09:33:25 -07001018 auto field_name = ConvertCase(field.name, Case::kLowerCamel);
Austin Schuh272c6132020-11-14 16:37:52 -08001019 if (field.deprecated) continue;
1020 code += ",\n ";
1021 code += GenTypeBasic(DestinationType(field.value.type, false));
1022 code += " ";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001023 code += field_name;
Austin Schuh272c6132020-11-14 16:37:52 -08001024 if (!IsScalar(field.value.type.base_type)) code += "Offset";
1025 }
1026 code += ") {\n builder.";
1027 code += "startTable(";
1028 code += NumToString(struct_def.fields.vec.size()) + ");\n";
1029 for (size_t size = struct_def.sortbysize ? sizeof(largest_scalar_t) : 1;
1030 size; size /= 2) {
1031 for (auto it = struct_def.fields.vec.rbegin();
1032 it != struct_def.fields.vec.rend(); ++it) {
1033 auto &field = **it;
James Kuszmaul8e62b022022-03-22 09:33:25 -07001034 auto field_name = ConvertCase(field.name, Case::kLowerCamel);
1035 auto method_name = ConvertCase(field.name, Case::kUpperCamel);
Austin Schuh272c6132020-11-14 16:37:52 -08001036 if (!field.deprecated &&
1037 (!struct_def.sortbysize ||
1038 size == SizeOf(field.value.type.base_type))) {
1039 code += " " + struct_def.name + ".";
1040 code += "add";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001041 code += method_name + "(builder, " + field_name;
Austin Schuh272c6132020-11-14 16:37:52 -08001042 if (!IsScalar(field.value.type.base_type)) code += "Offset";
1043 code += ");\n";
1044 }
1045 }
1046 }
1047 code += " return " + struct_def.name + ".";
1048 code += "end" + struct_def.name;
1049 code += "(builder);\n }\n\n";
1050 }
1051 // Generate a set of static methods that allow table construction,
1052 // of the form:
1053 // public static void addName(FlatBufferBuilder builder, short name)
1054 // { builder.addShort(id, name, default); }
1055 // Unlike the Create function, these always work.
1056 code += " public static void start";
1057 code += struct_def.name;
1058 code += "(FlatBufferBuilder builder) { builder.";
1059 code += "startTable(";
1060 code += NumToString(struct_def.fields.vec.size()) + "); }\n";
1061 for (auto it = struct_def.fields.vec.begin();
1062 it != struct_def.fields.vec.end(); ++it) {
1063 auto &field = **it;
1064 if (field.deprecated) continue;
1065 if (field.key) key_field = &field;
1066 code += " public static void add";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001067 code += ConvertCase(field.name, Case::kUpperCamel);
Austin Schuh272c6132020-11-14 16:37:52 -08001068 code += "(FlatBufferBuilder builder, ";
1069 code += GenTypeBasic(DestinationType(field.value.type, false));
James Kuszmaul8e62b022022-03-22 09:33:25 -07001070 auto argname = ConvertCase(field.name, Case::kLowerCamel);
Austin Schuh272c6132020-11-14 16:37:52 -08001071 if (!IsScalar(field.value.type.base_type)) argname += "Offset";
1072 code += " " + argname + ") { builder.add";
1073 code += GenMethod(field.value.type) + "(";
1074 code += NumToString(it - struct_def.fields.vec.begin()) + ", ";
1075 code += SourceCastBasic(field.value.type);
1076 code += argname;
1077 code += ", ";
1078 code += SourceCastBasic(field.value.type);
1079 code += GenDefaultValue(field);
1080 code += "); }\n";
1081 if (IsVector(field.value.type)) {
1082 auto vector_type = field.value.type.VectorType();
1083 auto alignment = InlineAlignment(vector_type);
1084 auto elem_size = InlineSize(vector_type);
1085 if (!IsStruct(vector_type)) {
James Kuszmaul8e62b022022-03-22 09:33:25 -07001086 field_has_create_set.insert(&field);
Austin Schuh272c6132020-11-14 16:37:52 -08001087 // generate a method to create a vector from a java array.
1088 if ((vector_type.base_type == BASE_TYPE_CHAR ||
1089 vector_type.base_type == BASE_TYPE_UCHAR)) {
1090 // Handle byte[] and ByteBuffers separately for Java
1091 code += " public static " + GenVectorOffsetType() + " ";
1092 code += "create";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001093 code += ConvertCase(field.name, Case::kUpperCamel);
Austin Schuh272c6132020-11-14 16:37:52 -08001094 code += "Vector(FlatBufferBuilder builder, byte[] data) ";
1095 code += "{ return builder.createByteVector(data); }\n";
1096
1097 code += " public static " + GenVectorOffsetType() + " ";
1098 code += "create";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001099 code += ConvertCase(field.name, Case::kUpperCamel);
Austin Schuh272c6132020-11-14 16:37:52 -08001100 code += "Vector(FlatBufferBuilder builder, ByteBuffer data) ";
1101 code += "{ return builder.createByteVector(data); }\n";
1102 } else {
1103 code += " public static " + GenVectorOffsetType() + " ";
1104 code += "create";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001105 code += ConvertCase(field.name, Case::kUpperCamel);
Austin Schuh272c6132020-11-14 16:37:52 -08001106 code += "Vector(FlatBufferBuilder builder, ";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001107 code += GenTypeBasic(DestinationType(vector_type, false)) +
1108 "[] data) ";
Austin Schuh272c6132020-11-14 16:37:52 -08001109 code += "{ builder.startVector(";
1110 code += NumToString(elem_size);
1111 code += ", data.length, ";
1112 code += NumToString(alignment);
1113 code += "); for (int i = data.";
1114 code += "length - 1; i >= 0; i--) builder.";
1115 code += "add";
1116 code += GenMethod(vector_type);
1117 code += "(";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001118 code += SourceCastBasic(vector_type);
Austin Schuh272c6132020-11-14 16:37:52 -08001119 code += "data[i]";
1120 code += "); return ";
1121 code += "builder.endVector(); }\n";
1122 }
1123 }
1124 // Generate a method to start a vector, data to be added manually
1125 // after.
1126 code += " public static void start";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001127 code += ConvertCase(field.name, Case::kUpperCamel);
Austin Schuh272c6132020-11-14 16:37:52 -08001128 code += "Vector(FlatBufferBuilder builder, int numElems) ";
1129 code += "{ builder.startVector(";
1130 code += NumToString(elem_size);
1131 code += ", numElems, " + NumToString(alignment);
1132 code += "); }\n";
1133 }
1134 }
1135 code += " public static " + GenOffsetType() + " ";
1136 code += "end" + struct_def.name;
1137 code += "(FlatBufferBuilder builder) {\n int o = builder.";
1138 code += "endTable();\n";
1139 for (auto it = struct_def.fields.vec.begin();
1140 it != struct_def.fields.vec.end(); ++it) {
1141 auto &field = **it;
James Kuszmaul8e62b022022-03-22 09:33:25 -07001142 if (!field.deprecated && field.IsRequired()) {
Austin Schuh272c6132020-11-14 16:37:52 -08001143 code += " builder.required(o, ";
1144 code += NumToString(field.value.offset);
1145 code += "); // " + field.name + "\n";
1146 }
1147 }
1148 code += " return " + GenOffsetConstruct("o") + ";\n }\n";
1149 if (parser_.root_struct_def_ == &struct_def) {
1150 std::string size_prefix[] = { "", "SizePrefixed" };
1151 for (int i = 0; i < 2; ++i) {
1152 code += " public static void ";
1153 code += "finish" + size_prefix[i] + struct_def.name;
1154 code += "Buffer(FlatBufferBuilder builder, " + GenOffsetType();
1155 code += " offset) {";
1156 code += " builder.finish" + size_prefix[i] + "(offset";
1157
1158 if (parser_.file_identifier_.length())
1159 code += ", \"" + parser_.file_identifier_ + "\"";
1160 code += "); }\n";
1161 }
1162 }
1163 }
1164 // Only generate key compare function for table,
1165 // because `key_field` is not set for struct
1166 if (struct_def.has_key && !struct_def.fixed) {
1167 FLATBUFFERS_ASSERT(key_field);
1168 code += "\n @Override\n protected int keysCompare(";
1169 code += "Integer o1, Integer o2, ByteBuffer _bb) {";
1170 code += GenKeyGetter(key_field);
1171 code += " }\n";
1172
1173 code += "\n public static " + struct_def.name;
1174 code += " __lookup_by_key(";
1175 code += struct_def.name + " obj, ";
1176 code += "int vectorLocation, ";
1177 code += GenTypeNameDest(key_field->value.type);
1178 code += " key, ByteBuffer bb) {\n";
1179 if (IsString(key_field->value.type)) {
1180 code += " byte[] byteKey = ";
1181 code += "key.getBytes(java.nio.charset.StandardCharsets.UTF_8);\n";
1182 }
1183 code += " int span = ";
1184 code += "bb.getInt(vectorLocation - 4);\n";
1185 code += " int start = 0;\n";
1186 code += " while (span != 0) {\n";
1187 code += " int middle = span / 2;\n";
1188 code += GenLookupKeyGetter(key_field);
1189 code += " if (comp > 0) {\n";
1190 code += " span = middle;\n";
1191 code += " } else if (comp < 0) {\n";
1192 code += " middle++;\n";
1193 code += " start += middle;\n";
1194 code += " span -= middle;\n";
1195 code += " } else {\n";
1196 code += " return ";
1197 code += "(obj == null ? new " + struct_def.name + "() : obj)";
1198 code += ".__assign(tableOffset, bb);\n";
1199 code += " }\n }\n";
1200 code += " return null;\n";
1201 code += " }\n";
1202 }
1203 GenVectorAccessObject(struct_def, code_ptr);
James Kuszmaul8e62b022022-03-22 09:33:25 -07001204 if (opts.generate_object_based_api) {
1205 GenPackUnPack_ObjectAPI(struct_def, code_ptr, opts, struct_has_create,
1206 field_has_create_set);
1207 }
1208 code += "}\n\n";
Austin Schuh272c6132020-11-14 16:37:52 -08001209 }
1210
1211 std::string GenOptionalScalarCheck(FieldDef &field) const {
1212 if (!field.IsScalarOptional()) return "";
James Kuszmaul8e62b022022-03-22 09:33:25 -07001213 return " public boolean has" + ConvertCase(field.name, Case::kUpperCamel) +
Austin Schuh272c6132020-11-14 16:37:52 -08001214 "() { return 0 != __offset(" + NumToString(field.value.offset) +
1215 "); }\n";
1216 }
1217
1218 void GenVectorAccessObject(StructDef &struct_def,
1219 std::string *code_ptr) const {
1220 auto &code = *code_ptr;
1221 // Generate a vector of structs accessor class.
1222 code += "\n";
1223 code += " ";
1224 if (!struct_def.attributes.Lookup("private")) code += "public ";
1225 code += "static ";
1226 code += "final ";
1227 code += "class Vector extends ";
1228 code += "BaseVector {\n";
1229
1230 // Generate the __assign method that sets the field in a pre-existing
1231 // accessor object. This is to allow object reuse.
1232 std::string method_indent = " ";
1233 code += method_indent + "public Vector ";
1234 code += "__assign(int _vector, int _element_size, ByteBuffer _bb) { ";
1235 code += "__reset(_vector, _element_size, _bb); return this; }\n\n";
1236
1237 auto type_name = struct_def.name;
1238 auto method_start = method_indent + "public " + type_name + " get";
1239 // Generate the accessors that don't do object reuse.
1240 code += method_start + "(int j) { return get";
1241 code += "(new " + type_name + "(), j); }\n";
1242 code += method_start + "(" + type_name + " obj, int j) { ";
1243 code += " return obj.__assign(";
1244 std::string index = "__element(j)";
1245 code += struct_def.fixed ? index : "__indirect(" + index + ", bb)";
1246 code += ", bb); }\n";
1247 // See if we should generate a by-key accessor.
1248 if (!struct_def.fixed) {
1249 auto &fields = struct_def.fields.vec;
1250 for (auto kit = fields.begin(); kit != fields.end(); ++kit) {
1251 auto &key_field = **kit;
1252 if (key_field.key) {
1253 auto nullable_annotation =
1254 parser_.opts.gen_nullable ? "@Nullable " : "";
1255 code += method_indent + nullable_annotation;
1256 code += "public " + type_name + " ";
1257 code += "getByKey(";
1258 code += GenTypeNameDest(key_field.value.type) + " key) { ";
1259 code += " return __lookup_by_key(null, ";
1260 code += "__vector(), key, ";
1261 code += "bb); ";
1262 code += "}\n";
1263 code += method_indent + nullable_annotation;
1264 code += "public " + type_name + " ";
1265 code += "getByKey(";
1266 code += type_name + " obj, ";
1267 code += GenTypeNameDest(key_field.value.type) + " key) { ";
1268 code += " return __lookup_by_key(obj, ";
1269 code += "__vector(), key, ";
1270 code += "bb); ";
1271 code += "}\n";
1272 break;
1273 }
1274 }
1275 }
1276 code += " }\n";
1277 }
1278
James Kuszmaul8e62b022022-03-22 09:33:25 -07001279 std::string GenGetterFuncName_ObjectAPI(const std::string &field_name) const {
1280 return "get" + ConvertCase(field_name, Case::kUpperCamel);
1281 }
1282
1283 void GenEnum_ObjectAPI(EnumDef &enum_def, std::string *code_ptr,
1284 const IDLOptions &opts) const {
1285 auto &code = *code_ptr;
1286 if (enum_def.generated) return;
1287 code += "import com.google.flatbuffers.FlatBufferBuilder;\n\n";
1288
1289 if (!enum_def.attributes.Lookup("private")) { code += "public "; }
1290 auto union_name = enum_def.name + "Union";
1291 auto union_type =
1292 GenTypeBasic(DestinationType(enum_def.underlying_type, false));
1293 code += "class " + union_name + " {\n";
1294 // Type
1295 code += " private " + union_type + " type;\n";
1296 // Value
1297 code += " private Object value;\n";
1298 code += "\n";
1299 // getters and setters
1300 code += " public " + union_type + " getType() { return type; }\n\n";
1301 code += " public void setType(" + union_type +
1302 " type) { this.type = type; }\n\n";
1303 code += " public Object getValue() { return value; }\n\n";
1304 code += " public void setValue(Object value) { this.value = value; }\n\n";
1305 // Constructor
1306 code += " public " + union_name + "() {\n";
1307 code += " this.type = " + enum_def.name + "." +
1308 enum_def.Vals()[0]->name + ";\n";
1309 code += " this.value = null;\n";
1310 code += " }\n\n";
1311 // As
1312 for (auto it = enum_def.Vals().begin(); it != enum_def.Vals().end(); ++it) {
1313 auto &ev = **it;
1314 if (ev.union_type.base_type == BASE_TYPE_NONE) continue;
1315 auto type_name = GenTypeGet_ObjectAPI(ev.union_type, opts, false, true);
1316 if (ev.union_type.base_type == BASE_TYPE_STRUCT &&
1317 ev.union_type.struct_def->attributes.Lookup("private")) {
1318 code += " ";
1319 } else {
1320 code += " public ";
1321 }
1322 code += type_name + " as" + ev.name + "() { return (" + type_name +
1323 ") value; }\n";
1324 }
1325 code += "\n";
1326 // pack()
1327 code += " public static int pack(FlatBufferBuilder builder, " +
1328 union_name + " _o) {\n";
1329 code += " switch (_o.type) {\n";
1330 for (auto it = enum_def.Vals().begin(); it != enum_def.Vals().end(); ++it) {
1331 auto &ev = **it;
1332 if (ev.union_type.base_type == BASE_TYPE_NONE) {
1333 continue;
1334 } else {
1335 code += " case " + enum_def.name + "." + ev.name + ": return ";
1336 if (IsString(ev.union_type)) {
1337 code += "builder.createString(_o.as" + ev.name + "());\n";
1338 } else {
1339 code += GenTypeGet(ev.union_type) + ".pack(builder, _o.as" + ev.name +
1340 "());\n";
1341 }
1342 }
1343 }
1344 code += " default: return 0;\n";
1345 code += " }\n";
1346 code += " }\n";
1347 code += "}\n\n";
1348 }
1349
1350 std::string GenSetterFuncName_ObjectAPI(const std::string &field_name) const {
1351 return "set" + ConvertCase(field_name, Case::kUpperCamel);
1352 }
1353
1354 std::string GenTypeName_ObjectAPI(const std::string &name,
1355 const IDLOptions &opts) const {
1356 return opts.object_prefix + name + opts.object_suffix;
1357 }
1358
1359 void GenUnionUnPack_ObjectAPI(const EnumDef &enum_def, std::string *code_ptr,
1360 const std::string &type_name,
1361 const std::string &camel_name,
1362 bool is_vector) const {
1363 auto &code = *code_ptr;
1364
1365 std::string variable_type = type_name;
1366 std::string variable_name =
1367 "_o" + ConvertCase(camel_name, Case::kUpperCamel);
1368 std::string type_params = "";
1369 std::string value_params = "";
1370 std::string func_suffix = "()";
1371 std::string indent = " ";
1372 if (is_vector) {
1373 variable_type = type_name.substr(0, type_name.length() - 2);
1374 variable_name += "Element";
1375 type_params = "_j";
1376 value_params = ", _j";
1377 func_suffix = "(_j)";
1378 indent = " ";
1379 }
1380 code += indent + variable_type + " " + variable_name + " = new " +
1381 variable_type + "();\n";
1382 code += indent +
1383 GenTypeBasic(DestinationType(enum_def.underlying_type, false)) +
1384 " " + variable_name + "Type = " + camel_name + "Type(" +
1385 type_params + ");\n";
1386 code += indent + variable_name + ".setType(" + variable_name + "Type);\n";
1387 code += indent + "Table " + variable_name + "Value;\n";
1388 code += indent + "switch (" + variable_name + "Type) {\n";
1389 for (auto eit = enum_def.Vals().begin(); eit != enum_def.Vals().end();
1390 ++eit) {
1391 auto &ev = **eit;
1392 if (ev.union_type.base_type == BASE_TYPE_NONE) {
1393 continue;
1394 } else {
1395 if (ev.union_type.base_type == BASE_TYPE_STRING ||
1396 (ev.union_type.base_type == BASE_TYPE_STRUCT &&
1397 ev.union_type.struct_def->fixed)) {
1398 continue; // This branch is due to bad implemantation of Unions in
1399 // Java which doesn't handle non Table types. Should be
1400 // deleted when issue #6561 is fixed.
1401 }
1402 code += indent + " case " + WrapInNameSpace(enum_def) + "." + ev.name +
1403 ":\n";
1404 auto actual_type = GenTypeGet(ev.union_type);
1405 code += indent + " " + variable_name + "Value = " + camel_name +
1406 "(new " + actual_type + "()" + value_params + ");\n";
1407 code += indent + " " + variable_name + ".setValue(" + variable_name +
1408 "Value != null ? ((" + actual_type + ") " + variable_name +
1409 "Value).unpack() : null);\n";
1410 code += indent + " break;\n";
1411 }
1412 }
1413 code += indent + " default: break;\n";
1414 code += indent + "}\n";
1415 if (is_vector) {
1416 code += indent + "_o" + ConvertCase(camel_name, Case::kUpperCamel) +
1417 "[_j] = " + variable_name + ";\n";
1418 }
1419 }
1420
1421 void GenPackUnPack_ObjectAPI(
1422 StructDef &struct_def, std::string *code_ptr, const IDLOptions &opts,
1423 bool struct_has_create,
1424 const std::set<FieldDef *> &field_has_create) const {
1425 auto &code = *code_ptr;
1426 auto struct_name = GenTypeName_ObjectAPI(struct_def.name, opts);
1427 // unpack()
1428 code += " public " + struct_name + " unpack() {\n";
1429 code += " " + struct_name + " _o = new " + struct_name + "();\n";
1430 code += " unpackTo(_o);\n";
1431 code += " return _o;\n";
1432 code += " }\n";
1433 // unpackTo()
1434 code += " public void unpackTo(" + struct_name + " _o) {\n";
1435 for (auto it = struct_def.fields.vec.begin();
1436 it != struct_def.fields.vec.end(); ++it) {
1437 auto &field = **it;
1438 if (field.deprecated) continue;
1439 if (field.value.type.base_type == BASE_TYPE_UTYPE) continue;
1440 if (field.value.type.element == BASE_TYPE_UTYPE) continue;
1441 auto camel_name = ConvertCase(field.name, Case::kLowerCamel);
1442 auto camel_name_with_first = ConvertCase(field.name, Case::kUpperCamel);
1443 auto type_name =
1444 GenTypeGet_ObjectAPI(field.value.type, opts, false, true);
1445 if (field.IsScalarOptional())
1446 type_name = ConvertPrimitiveTypeToObjectWrapper_ObjectAPI(type_name);
1447 auto start = " " + type_name + " _o" + camel_name_with_first + " = ";
1448 auto call_setter = true;
1449 switch (field.value.type.base_type) {
1450 case BASE_TYPE_STRUCT: {
1451 auto fixed = struct_def.fixed && field.value.type.struct_def->fixed;
1452 if (fixed) {
1453 code += " " + camel_name + "().unpackTo(_o.get" +
1454 camel_name_with_first + "());\n";
1455 } else {
1456 code += " if (" + camel_name + "() != null) ";
1457 if (field.value.type.struct_def->fixed) {
1458 code += camel_name + "().unpackTo(_o.get" +
1459 camel_name_with_first + "());\n";
1460 } else {
1461 code += "_o." + GenSetterFuncName_ObjectAPI(field.name) + "(" +
1462 camel_name + "().unpack());\n";
1463 }
1464 code += " else _o." + GenSetterFuncName_ObjectAPI(field.name) +
1465 "(null);\n";
1466 }
1467 call_setter = false;
1468 break;
1469 }
1470 case BASE_TYPE_ARRAY: {
1471 auto length_str = NumToString(field.value.type.fixed_length);
1472 auto unpack_method =
1473 field.value.type.struct_def == nullptr ? "" : ".unpack()";
1474 code +=
1475 start + "_o." + GenGetterFuncName_ObjectAPI(field.name) + "();\n";
1476 code += " for (int _j = 0; _j < " + length_str + "; ++_j) { _o" +
1477 camel_name_with_first + "[_j] = " + camel_name + "(_j)" +
1478 unpack_method + "; }\n";
1479 call_setter = false;
1480 break;
1481 }
1482 case BASE_TYPE_VECTOR:
1483 if (field.value.type.element == BASE_TYPE_UNION) {
1484 code += start + "new " +
1485 GenConcreteTypeGet_ObjectAPI(field.value.type, opts)
1486 .substr(0, type_name.length() - 1) +
1487 camel_name + "Length()];\n";
1488 code += " for (int _j = 0; _j < " + camel_name +
1489 "Length(); ++_j) {\n";
1490 GenUnionUnPack_ObjectAPI(*field.value.type.enum_def, code_ptr,
1491 type_name, camel_name, true);
1492 code += " }\n";
1493 } else if (field.value.type.element != BASE_TYPE_UTYPE) {
1494 auto fixed = field.value.type.struct_def == nullptr;
1495 code += start + "new " +
1496 GenConcreteTypeGet_ObjectAPI(field.value.type, opts)
1497 .substr(0, type_name.length() - 1) +
1498 camel_name + "Length()];\n";
1499 code +=
1500 " for (int _j = 0; _j < " + camel_name + "Length(); ++_j) {";
1501 code += "_o" + camel_name_with_first + "[_j] = ";
1502 if (fixed) {
1503 code += camel_name + "(_j)";
1504 } else {
1505 code += "(" + camel_name + "(_j) != null ? " + camel_name +
1506 "(_j).unpack() : null)";
1507 }
1508 code += ";}\n";
1509 }
1510 break;
1511 case BASE_TYPE_UTYPE: break;
1512 case BASE_TYPE_UNION: {
1513 GenUnionUnPack_ObjectAPI(*field.value.type.enum_def, code_ptr,
1514 type_name, camel_name, false);
1515 break;
1516 }
1517 default: {
1518 if (field.IsScalarOptional()) {
1519 code += start + "has" + camel_name_with_first + "() ? " +
1520 camel_name + "() : null;\n";
1521 } else {
1522 code += start + camel_name + "();\n";
1523 }
1524 break;
1525 }
1526 }
1527 if (call_setter) {
1528 code += " _o." + GenSetterFuncName_ObjectAPI(field.name) + "(_o" +
1529 camel_name_with_first + ");\n";
1530 }
1531 }
1532 code += " }\n";
1533 // pack()
1534 code += " public static " + GenOffsetType() +
1535 " pack(FlatBufferBuilder builder, " + struct_name + " _o) {\n";
1536 code += " if (_o == null) return 0;\n";
1537 for (auto it = struct_def.fields.vec.begin();
1538 it != struct_def.fields.vec.end(); ++it) {
1539 auto &field = **it;
1540 if (field.deprecated) continue;
1541 auto camel_name = ConvertCase(field.name, Case::kLowerCamel);
1542 auto camel_name_with_first = ConvertCase(field.name, Case::kUpperCamel);
1543 // pre
1544 switch (field.value.type.base_type) {
1545 case BASE_TYPE_STRUCT: {
1546 if (!field.value.type.struct_def->fixed) {
1547 code += " " + GenOffsetType() + " _" + field.name + " = _o." +
1548 GenGetterFuncName_ObjectAPI(field.name) +
1549 "() == null ? 0 : " + GenTypeGet(field.value.type) +
1550 ".pack(builder, _o." +
1551 GenGetterFuncName_ObjectAPI(field.name) + "());\n";
1552 } else if (struct_def.fixed && struct_has_create) {
1553 std::vector<FieldArrayLength> array_lengths;
1554 FieldArrayLength tmp_array_length = {
1555 field.name,
1556 field.value.type.fixed_length,
1557 };
1558 array_lengths.push_back(tmp_array_length);
1559 GenStructPackDecl_ObjectAPI(*field.value.type.struct_def, code_ptr,
1560 array_lengths);
1561 }
1562 break;
1563 }
1564 case BASE_TYPE_STRING: {
1565 std::string create_string = "createString";
1566 code += " int _" + camel_name + " = _o." +
1567 GenGetterFuncName_ObjectAPI(field.name) +
1568 "() == null ? 0 : "
1569 "builder." +
1570 create_string + "(_o." +
1571 GenGetterFuncName_ObjectAPI(field.name) + "());\n";
1572 break;
1573 }
1574 case BASE_TYPE_VECTOR: {
1575 if (field_has_create.find(&field) != field_has_create.end()) {
1576 auto property_name = camel_name;
1577 auto gen_for_loop = true;
1578 std::string array_name = "__" + camel_name;
1579 std::string array_type = "";
1580 std::string element_type = "";
1581 std::string to_array = "";
1582 switch (field.value.type.element) {
1583 case BASE_TYPE_STRING: {
1584 std::string create_string = "createString";
1585 array_type = "int";
1586 element_type = "String";
1587 to_array += "builder." + create_string + "(_e)";
1588 break;
1589 }
1590 case BASE_TYPE_STRUCT:
1591 array_type = "int";
1592 element_type =
1593 GenTypeGet_ObjectAPI(field.value.type, opts, true, true);
1594 ;
1595 to_array = GenTypeGet(field.value.type) + ".pack(builder, _e)";
1596 break;
1597 case BASE_TYPE_UTYPE:
1598 property_name = camel_name.substr(0, camel_name.size() - 4);
1599 array_type = GenTypeBasic(DestinationType(
1600 field.value.type.enum_def->underlying_type, false));
1601 element_type = field.value.type.enum_def->name + "Union";
1602 to_array = "_o." + GenGetterFuncName_ObjectAPI(property_name) +
1603 "()[_j].getType()";
1604 break;
1605 case BASE_TYPE_UNION:
1606 array_type = "int";
1607 element_type =
1608 WrapInNameSpace(*field.value.type.enum_def) + "Union";
1609 to_array = WrapInNameSpace(*field.value.type.enum_def) +
1610 "Union.pack(builder, _o." +
1611 GenGetterFuncName_ObjectAPI(property_name) +
1612 "()[_j])";
1613 break;
1614 case BASE_TYPE_UCHAR: // TODO this branch of the switch is due to
1615 // inconsistent behavior in unsigned byte.
1616 // Read further at Issue #6574.
1617 array_type = "byte";
1618 element_type = "int";
1619 to_array = "(byte) _e";
1620 break;
1621 default:
1622 gen_for_loop = false;
1623 array_name =
1624 "_o." + GenGetterFuncName_ObjectAPI(property_name) + "()";
1625 array_type = GenTypeNameDest(field.value.type);
1626 element_type = array_type;
1627 to_array = "_e";
1628 break;
1629 }
1630 code += " int _" + camel_name + " = 0;\n";
1631 code += " if (_o." + GenGetterFuncName_ObjectAPI(property_name) +
1632 "() != null) {\n";
1633 if (gen_for_loop) {
1634 code += " " + array_type + "[] " + array_name + " = new " +
1635 array_type + "[_o." +
1636 GenGetterFuncName_ObjectAPI(property_name) +
1637 "().length];\n";
1638 code += " int _j = 0;\n";
1639 code += " for (" + element_type + " _e : _o." +
1640 GenGetterFuncName_ObjectAPI(property_name) + "()) { ";
1641 code += array_name + "[_j] = " + to_array + "; _j++;}\n";
1642 }
1643 code += " _" + camel_name + " = create" +
1644 camel_name_with_first + "Vector(builder, " + array_name +
1645 ");\n";
1646 code += " }\n";
1647 } else {
1648 auto type_name = GenTypeGet(field.value.type);
1649 auto element_type_name =
1650 GenTypeGet_ObjectAPI(field.value.type, opts, true, true);
1651 auto pack_method =
1652 field.value.type.struct_def == nullptr
1653 ? "builder.add" + GenMethod(field.value.type.VectorType()) +
1654 "(_o" + camel_name_with_first + "[_j]);"
1655 : type_name + ".pack(builder, _o" + camel_name_with_first +
1656 "[_j]);";
1657 code += " int _" + camel_name + " = 0;\n";
1658 code += " " + element_type_name + "[] _o" +
1659 camel_name_with_first + " = _o." +
1660 GenGetterFuncName_ObjectAPI(field.name) + "();\n";
1661 code += " if (_o" + camel_name_with_first + " != null) {\n";
1662 code += " start" + camel_name_with_first +
1663 "Vector(builder, _o" + camel_name_with_first +
1664 ".length);\n";
1665 code += " for (int _j = _o" + camel_name_with_first +
1666 ".length - 1; _j >=0; _j--) { ";
1667 code += pack_method + "}\n";
1668 code += " _" + camel_name + " = builder.endVector();\n";
1669 code += " }\n";
1670 }
1671 break;
1672 }
1673 case BASE_TYPE_ARRAY: {
1674 if (field.value.type.struct_def != nullptr) {
1675 std::vector<FieldArrayLength> array_lengths;
1676 FieldArrayLength tmp_array_length = {
1677 field.name,
1678 field.value.type.fixed_length,
1679 };
1680 array_lengths.push_back(tmp_array_length);
1681 GenStructPackDecl_ObjectAPI(*field.value.type.struct_def, code_ptr,
1682 array_lengths);
1683 } else {
1684 code += " " +
1685 GenTypeGet_ObjectAPI(field.value.type, opts, false, true) +
1686 " _" + camel_name + " = _o." +
1687 GenGetterFuncName_ObjectAPI(field.name) + "();\n";
1688 }
1689 break;
1690 }
1691 case BASE_TYPE_UNION: {
1692 code +=
1693 " " +
1694 GenTypeBasic(DestinationType(
1695 field.value.type.enum_def->underlying_type, false)) +
1696 " _" + camel_name + "Type = _o.get" + camel_name_with_first +
1697 "() == null ? " + WrapInNameSpace(*field.value.type.enum_def) +
1698 ".NONE : " + "_o.get" + camel_name_with_first + "().getType();\n";
1699 code += " " + GenOffsetType() + " _" + camel_name + " = _o.get" +
1700 camel_name_with_first + "() == null ? 0 : " +
1701 WrapInNameSpace(*field.value.type.enum_def) +
1702 "Union.pack(builder, _o.get" + camel_name_with_first +
1703 "());\n";
1704 break;
1705 }
1706 default: break;
1707 }
1708 }
1709 if (struct_has_create) {
1710 // Create
1711 code += " return create" + struct_def.name + "(\n";
1712 code += " builder";
1713 for (auto it = struct_def.fields.vec.begin();
1714 it != struct_def.fields.vec.end(); ++it) {
1715 auto &field = **it;
1716 if (field.deprecated) continue;
1717 auto camel_name = ConvertCase(field.name, Case::kLowerCamel);
1718 switch (field.value.type.base_type) {
1719 case BASE_TYPE_STRUCT: {
1720 if (struct_def.fixed) {
1721 GenStructPackCall_ObjectAPI(*field.value.type.struct_def,
1722 code_ptr,
1723 " _" + camel_name + "_");
1724 } else {
1725 code += ",\n";
1726 if (field.value.type.struct_def->fixed) {
1727 if (opts.generate_object_based_api)
1728 code += " _o." + camel_name;
1729 else
1730 // Seems like unreachable code
1731 code += " " + GenTypeGet(field.value.type) +
1732 ".Pack(builder, _o." + camel_name + ")";
1733 } else {
1734 code += " _" + field.name;
1735 }
1736 }
1737 break;
1738 }
1739 case BASE_TYPE_ARRAY: {
1740 if (field.value.type.struct_def != nullptr) {
1741 GenStructPackCall_ObjectAPI(*field.value.type.struct_def,
1742 code_ptr,
1743 " _" + camel_name + "_");
1744 } else {
1745 code += ",\n";
1746 code += " _" + camel_name;
1747 }
1748 break;
1749 }
1750 case BASE_TYPE_UNION: FLATBUFFERS_FALLTHROUGH(); // fall thru
1751 case BASE_TYPE_UTYPE: FLATBUFFERS_FALLTHROUGH(); // fall thru
1752 case BASE_TYPE_STRING: FLATBUFFERS_FALLTHROUGH(); // fall thru
1753 case BASE_TYPE_VECTOR: {
1754 code += ",\n";
1755 code += " _" + camel_name;
1756 break;
1757 }
1758 default: // scalar
1759 code += ",\n";
1760 code +=
1761 " _o." + GenGetterFuncName_ObjectAPI(field.name) + "()";
1762 break;
1763 }
1764 }
1765 code += ");\n";
1766 } else {
1767 // Start, End
1768 code += " start" + struct_def.name + "(builder);\n";
1769 for (auto it = struct_def.fields.vec.begin();
1770 it != struct_def.fields.vec.end(); ++it) {
1771 auto &field = **it;
1772 if (field.deprecated) continue;
1773 auto camel_name = ConvertCase(field.name, Case::kLowerCamel);
1774 auto camel_name_with_first = ConvertCase(field.name, Case::kUpperCamel);
1775 switch (field.value.type.base_type) {
1776 case BASE_TYPE_STRUCT: {
1777 if (field.value.type.struct_def->fixed) {
1778 code += " add" + camel_name_with_first + "(builder, " +
1779 GenTypeGet(field.value.type) + ".pack(builder, _o." +
1780 GenGetterFuncName_ObjectAPI(field.name) + "()));\n";
1781 } else {
1782 code += " add" + camel_name_with_first + "(builder, _" +
1783 field.name + ");\n";
1784 }
1785 break;
1786 }
1787 case BASE_TYPE_STRING: FLATBUFFERS_FALLTHROUGH(); // fall thru
1788 case BASE_TYPE_ARRAY: FLATBUFFERS_FALLTHROUGH(); // fall thru
1789 case BASE_TYPE_VECTOR: {
1790 code += " add" + camel_name_with_first + "(builder, _" +
1791 camel_name + ");\n";
1792 break;
1793 }
1794 case BASE_TYPE_UTYPE: break;
1795 case BASE_TYPE_UNION: {
1796 code += " add" + camel_name_with_first + "Type(builder, _" +
1797 camel_name + "Type);\n";
1798 code += " add" + camel_name_with_first + "(builder, _" +
1799 camel_name + ");\n";
1800 break;
1801 }
1802 // scalar
1803 default: {
1804 if (field.IsScalarOptional()) {
1805 code += " if (_o." + GenGetterFuncName_ObjectAPI(field.name) +
1806 "() != null) { add" + camel_name_with_first +
1807 "(builder, _o." +
1808 GenGetterFuncName_ObjectAPI(field.name) + "()); }\n";
1809 } else {
1810 code += " add" + camel_name_with_first + "(builder, _o." +
1811 GenGetterFuncName_ObjectAPI(field.name) + "());\n";
1812 }
1813 break;
1814 }
1815 }
1816 }
1817 code += " return end" + struct_def.name + "(builder);\n";
1818 }
1819 code += " }\n";
1820 }
1821
1822 void GenStructPackDecl_ObjectAPI(
1823 const StructDef &struct_def, std::string *code_ptr,
1824 std::vector<FieldArrayLength> &array_lengths) const {
1825 auto &code = *code_ptr;
1826 for (auto it = struct_def.fields.vec.begin();
1827 it != struct_def.fields.vec.end(); ++it) {
1828 auto &field = **it;
1829 auto is_array = IsArray(field.value.type);
1830 const auto &field_type =
1831 is_array ? field.value.type.VectorType() : field.value.type;
1832 FieldArrayLength tmp_array_length = {
1833 field.name,
1834 field_type.fixed_length,
1835 };
1836 array_lengths.push_back(tmp_array_length);
1837 if (field_type.struct_def != nullptr) {
1838 GenStructPackDecl_ObjectAPI(*field_type.struct_def, code_ptr,
1839 array_lengths);
1840 } else {
1841 std::vector<FieldArrayLength> array_only_lengths;
1842 for (size_t i = 0; i < array_lengths.size(); ++i) {
1843 if (array_lengths[i].length > 0) {
1844 array_only_lengths.push_back(array_lengths[i]);
1845 }
1846 }
1847 std::string name;
1848 for (size_t i = 0; i < array_lengths.size(); ++i) {
1849 name += "_" + ConvertCase(array_lengths[i].name, Case::kLowerCamel);
1850 }
1851 code += " " + GenTypeBasic(field_type);
1852 if (array_only_lengths.size() > 0) {
1853 for (size_t i = 0; i < array_only_lengths.size(); ++i) {
1854 code += "[]";
1855 }
1856 code += " " + name + " = ";
1857 code += "new " + GenTypeBasic(field_type) + "[";
1858 for (size_t i = 0; i < array_only_lengths.size(); ++i) {
1859 if (i != 0) { code += "]["; }
1860 code += NumToString(array_only_lengths[i].length);
1861 }
1862 code += "];\n";
1863 code += " ";
1864 // initialize array
1865 for (size_t i = 0; i < array_only_lengths.size(); ++i) {
1866 auto idx = "idx" + NumToString(i);
1867 code += "for (int " + idx + " = 0; " + idx + " < " +
1868 NumToString(array_only_lengths[i].length) + "; ++" + idx +
1869 ") {";
1870 }
1871 for (size_t i = 0; i < array_only_lengths.size(); ++i) {
1872 auto idx = "idx" + NumToString(i);
1873 if (i == 0) {
1874 code += name + "[" + idx;
1875 } else {
1876 code += "][" + idx;
1877 }
1878 }
1879 code += "] = _o";
1880 for (size_t i = 0, j = 0; i < array_lengths.size(); ++i) {
1881 code +=
1882 "." + GenGetterFuncName_ObjectAPI(array_lengths[i].name) + "()";
1883 if (array_lengths[i].length <= 0) continue;
1884 code += "[idx" + NumToString(j++) + "]";
1885 }
1886 code += ";";
1887 for (size_t i = 0; i < array_only_lengths.size(); ++i) {
1888 code += "}";
1889 }
1890 } else {
1891 code += " " + name + " = ";
1892 code += "_o";
1893 for (size_t i = 0; i < array_lengths.size(); ++i) {
1894 code +=
1895 "." + GenGetterFuncName_ObjectAPI(array_lengths[i].name) + "()";
1896 }
1897 code += ";";
1898 }
1899 code += "\n";
1900 }
1901 array_lengths.pop_back();
1902 }
1903 }
1904
1905 void GenStructPackCall_ObjectAPI(const StructDef &struct_def,
1906 std::string *code_ptr,
1907 std::string prefix) const {
1908 auto &code = *code_ptr;
1909 for (auto it = struct_def.fields.vec.begin();
1910 it != struct_def.fields.vec.end(); ++it) {
1911 auto &field = **it;
1912 const auto &field_type = field.value.type;
1913 if (field_type.struct_def != nullptr) {
1914 GenStructPackCall_ObjectAPI(
1915 *field_type.struct_def, code_ptr,
1916 prefix + ConvertCase(field.name, Case::kLowerCamel) + "_");
1917 } else {
1918 code += ",\n";
1919 code += prefix + ConvertCase(field.name, Case::kLowerCamel);
1920 }
1921 }
1922 }
1923
1924 std::string ConvertPrimitiveTypeToObjectWrapper_ObjectAPI(
1925 std::string type_name) const {
1926 if (type_name == "boolean")
1927 return "Boolean";
1928 else if (type_name == "byte")
1929 return "Byte";
1930 else if (type_name == "char")
1931 return "Character";
1932 else if (type_name == "short")
1933 return "Short";
1934 else if (type_name == "int")
1935 return "Integer";
1936 else if (type_name == "long")
1937 return "Long";
1938 else if (type_name == "float")
1939 return "Float";
1940 else if (type_name == "double")
1941 return "Double";
1942 return type_name;
1943 }
1944
1945 std::string GenTypeGet_ObjectAPI(flatbuffers::Type type,
1946 const IDLOptions &opts, bool vectorelem,
1947 bool wrap_in_namespace) const {
1948 auto type_name = GenTypeNameDest(type);
1949 // Replace to ObjectBaseAPI Type Name
1950 switch (type.base_type) {
1951 case BASE_TYPE_STRUCT: FLATBUFFERS_FALLTHROUGH(); // fall thru
1952 case BASE_TYPE_ARRAY: FLATBUFFERS_FALLTHROUGH(); // fall thru
1953 case BASE_TYPE_VECTOR: {
1954 if (type.struct_def != nullptr) {
1955 auto type_name_length = type.struct_def->name.length();
1956 auto new_type_name =
1957 GenTypeName_ObjectAPI(type.struct_def->name, opts);
1958 type_name.replace(type_name.length() - type_name_length,
1959 type_name_length, new_type_name);
1960 } else if (type.element == BASE_TYPE_UNION) {
1961 if (wrap_in_namespace) {
1962 type_name = WrapInNameSpace(*type.enum_def) + "Union";
1963 } else {
1964 type_name = type.enum_def->name + "Union";
1965 }
1966 }
1967 break;
1968 }
1969
1970 case BASE_TYPE_UNION: {
1971 if (wrap_in_namespace) {
1972 type_name = WrapInNameSpace(*type.enum_def) + "Union";
1973 } else {
1974 type_name = type.enum_def->name + "Union";
1975 }
1976 break;
1977 }
1978 default: break;
1979 }
1980 if (vectorelem) { return type_name; }
1981 switch (type.base_type) {
1982 case BASE_TYPE_ARRAY: FLATBUFFERS_FALLTHROUGH(); // fall thru
1983 case BASE_TYPE_VECTOR: {
1984 type_name = type_name + "[]";
1985 break;
1986 }
1987 default: break;
1988 }
1989 return type_name;
1990 }
1991
1992 std::string GenConcreteTypeGet_ObjectAPI(flatbuffers::Type type,
1993 const IDLOptions &opts) const {
1994 auto type_name = GenTypeNameDest(type);
1995 // Replace to ObjectBaseAPI Type Name
1996 switch (type.base_type) {
1997 case BASE_TYPE_STRUCT: FLATBUFFERS_FALLTHROUGH(); // fall thru
1998 case BASE_TYPE_ARRAY: FLATBUFFERS_FALLTHROUGH(); // fall thru
1999 case BASE_TYPE_VECTOR: {
2000 if (type.struct_def != nullptr) {
2001 auto type_name_length = type.struct_def->name.length();
2002 auto new_type_name =
2003 GenTypeName_ObjectAPI(type.struct_def->name, opts);
2004 type_name.replace(type_name.length() - type_name_length,
2005 type_name_length, new_type_name);
2006 } else if (type.element == BASE_TYPE_UNION) {
2007 type_name = WrapInNameSpace(*type.enum_def) + "Union";
2008 }
2009 break;
2010 }
2011
2012 case BASE_TYPE_UNION: {
2013 type_name = WrapInNameSpace(*type.enum_def) + "Union";
2014 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
2030 void GenStruct_ObjectAPI(StructDef &struct_def, std::string *code_ptr,
2031 const IDLOptions &opts) const {
2032 if (struct_def.generated) return;
2033 auto &code = *code_ptr;
2034 if (struct_def.attributes.Lookup("private")) {
2035 // For Java, we leave the enum unmarked to indicate package-private
2036 } else {
2037 code += "public ";
2038 }
2039
2040 auto class_name = GenTypeName_ObjectAPI(struct_def.name, opts);
2041 code += "class " + class_name;
2042 code += " {\n";
2043 // Generate Properties
2044 for (auto it = struct_def.fields.vec.begin();
2045 it != struct_def.fields.vec.end(); ++it) {
2046 auto &field = **it;
2047 if (field.deprecated) continue;
2048 if (field.value.type.base_type == BASE_TYPE_UTYPE) continue;
2049 if (field.value.type.element == BASE_TYPE_UTYPE) continue;
2050 auto type_name =
2051 GenTypeGet_ObjectAPI(field.value.type, opts, false, true);
2052 if (field.IsScalarOptional())
2053 type_name = ConvertPrimitiveTypeToObjectWrapper_ObjectAPI(type_name);
2054 auto camel_name = ConvertCase(field.name, Case::kLowerCamel);
2055 code += " private " + type_name + " " + camel_name + ";\n";
2056 }
2057 // Generate Java getters and setters
2058 code += "\n";
2059 for (auto it = struct_def.fields.vec.begin();
2060 it != struct_def.fields.vec.end(); ++it) {
2061 auto &field = **it;
2062 if (field.deprecated) continue;
2063 if (field.value.type.base_type == BASE_TYPE_UTYPE) continue;
2064 if (field.value.type.element == BASE_TYPE_UTYPE) continue;
2065 auto type_name =
2066 GenTypeGet_ObjectAPI(field.value.type, opts, false, true);
2067 if (field.IsScalarOptional())
2068 type_name = ConvertPrimitiveTypeToObjectWrapper_ObjectAPI(type_name);
2069 auto camel_name = ConvertCase(field.name, Case::kLowerCamel);
2070 code += " public " + type_name + " " +
2071 GenGetterFuncName_ObjectAPI(field.name) + "() { return " +
2072 camel_name + "; }\n\n";
2073 std::string array_validation = "";
2074 if (field.value.type.base_type == BASE_TYPE_ARRAY) {
2075 array_validation =
2076 "if (" + camel_name + " != null && " + camel_name +
2077 ".length == " + NumToString(field.value.type.fixed_length) + ") ";
2078 }
2079 code += " public void " + GenSetterFuncName_ObjectAPI(field.name) + "(" +
2080 type_name + " " + camel_name + ") { " + array_validation +
2081 "this." + camel_name + " = " + camel_name + "; }\n\n";
2082 }
2083 // Generate Constructor
2084 code += "\n";
2085 code += " public " + class_name + "() {\n";
2086 for (auto it = struct_def.fields.vec.begin();
2087 it != struct_def.fields.vec.end(); ++it) {
2088 auto &field = **it;
2089 if (field.deprecated) continue;
2090 if (field.value.type.base_type == BASE_TYPE_UTYPE) continue;
2091 if (field.value.type.element == BASE_TYPE_UTYPE) continue;
2092 code += " this." + ConvertCase(field.name, Case::kLowerCamel) + " = ";
2093 auto type_name =
2094 GenTypeGet_ObjectAPI(field.value.type, opts, false, true);
2095 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) {
2125 code += " public static " + class_name +
2126 " deserializeFromBinary(byte[] fbBuffer) {\n";
2127 code += " return " + struct_def.name + ".getRootAs" + struct_def.name +
2128 "(ByteBuffer.wrap(fbBuffer)).unpack();\n";
2129 code += " }\n";
2130 code += " public byte[] serializeToBinary() {\n";
2131 code += " FlatBufferBuilder fbb = new FlatBufferBuilder();\n";
2132 code += " " + struct_def.name + ".finish" + struct_def.name +
2133 "Buffer(fbb, " + struct_def.name + ".pack(fbb, this));\n";
2134 code += " return fbb.sizedByteArray();\n";
2135 code += " }\n";
2136 }
2137 code += "}\n\n";
2138 }
2139
Austin Schuh272c6132020-11-14 16:37:52 -08002140 // This tracks the current namespace used to determine if a type need to be
2141 // prefixed by its namespace
2142 const Namespace *cur_name_space_;
2143};
2144} // namespace java
2145
2146bool GenerateJava(const Parser &parser, const std::string &path,
2147 const std::string &file_name) {
2148 java::JavaGenerator generator(parser, path, file_name);
2149 return generator.generate();
2150}
2151
2152} // namespace flatbuffers