Skip to content

Replace FlatBuffers fork with upstream 2.0.5 #349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 29, 2021
Merged

Replace FlatBuffers fork with upstream 2.0.5 #349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
04baf38
refactor: replace flatbuffers fork with 2.0.5
vaind Dec 11, 2021
5bc9c78
perf: use the new optimized FB binary-list readers
vaind Dec 12, 2021
12fa0d9
fix: perf regression after fb 2.0.5 update
vaind Dec 18, 2021
2bc9c0d
fix: generate code for non-null-safe apps
vaind Dec 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 44 additions & 39 deletions generator/lib/src/code_chunks.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,37 +10,37 @@ class CodeChunks {
ModelInfo model, List<String> imports, Pubspec? pubspec) =>
"""
// GENERATED CODE - DO NOT MODIFY BY HAND

// ignore_for_file: camel_case_types

import 'dart:typed_data';
import 'package:objectbox/flatbuffers/flat_buffers.dart' as fb;

import 'package:flat_buffers/flat_buffers.dart' as fb;
import 'package:objectbox/internal.dart'; // generated code can access "internal" functionality
import 'package:objectbox/objectbox.dart';${pubspec?.obxFlutterImport}

import '${sorted(imports).join("';\n import '")}';

export 'package:objectbox/objectbox.dart'; // so that callers only have to import this file

final _entities = <ModelEntity>[
${model.entities.map(createModelEntity).join(',')}
];

/// Open an ObjectBox store with the model declared in this file.
${openStore(model, pubspec)}
/// ObjectBox model definition, pass it to [Store] - Store(getObjectBoxModel())

/// ObjectBox model definition, pass it to [Store] - Store(getObjectBoxModel())
ModelDefinition getObjectBoxModel() {
${defineModel(model)}

final bindings = <Type, EntityDefinition>{
${model.entities.mapIndexed((i, entity) => "${entity.name}: ${entityBinding(i, entity)}").join(",\n")}
};

return ModelDefinition(model, bindings);
}

${model.entities.mapIndexed(_metaClass).join("\n")}
""";

Expand Down Expand Up @@ -94,16 +94,16 @@ class CodeChunks {
static String createModelEntity(ModelEntity entity) {
return '''
ModelEntity(
id: ${createIdUid(entity.id)},
name: '${entity.name}',
lastPropertyId: ${createIdUid(entity.lastPropertyId)},
flags: ${entity.flags},
id: ${createIdUid(entity.id)},
name: '${entity.name}',
lastPropertyId: ${createIdUid(entity.lastPropertyId)},
flags: ${entity.flags},
properties: <ModelProperty>[
${entity.properties.map(createModelProperty).join(',')}
],
],
relations: <ModelRelation>[
${entity.relations.map(createModelRelation).join(',')}
],
],
backlinks: <ModelBacklink>[
${entity.backlinks.map(createModelBacklink).join(',')}
]
Expand All @@ -122,9 +122,9 @@ class CodeChunks {
}
return '''
ModelProperty(
id: ${createIdUid(property.id)},
name: '${property.name}',
type: ${property.type},
id: ${createIdUid(property.id)},
name: '${property.name}',
type: ${property.type},
flags: ${property.flags}
$additionalArgs
)
Expand All @@ -134,8 +134,8 @@ class CodeChunks {
static String createModelRelation(ModelRelation relation) {
return '''
ModelRelation(
id: ${createIdUid(relation.id)},
name: '${relation.name}',
id: ${createIdUid(relation.id)},
name: '${relation.name}',
targetId: ${createIdUid(relation.targetId)}
)
''';
Expand All @@ -144,8 +144,8 @@ class CodeChunks {
static String createModelBacklink(ModelBacklink backlink) {
return '''
ModelBacklink(
name: '${backlink.name}',
srcEntity: '${backlink.srcEntity}',
name: '${backlink.name}',
srcEntity: '${backlink.srcEntity}',
srcField: '${backlink.srcField}'
)
''';
Expand Down Expand Up @@ -187,9 +187,9 @@ class CodeChunks {
// Such ID must already be set, i.e. it could not have been assigned.
return '''{
if (object.${propertyFieldName(entity.idProperty)} != id) {
throw ArgumentError('Field ${entity.name}.${propertyFieldName(entity.idProperty)} is read-only '
throw ArgumentError('Field ${entity.name}.${propertyFieldName(entity.idProperty)} is read-only '
'(final or getter-only) and it was declared to be self-assigned. '
'However, the currently inserted object (.${propertyFieldName(entity.idProperty)}=\${object.${propertyFieldName(entity.idProperty)}}) '
'However, the currently inserted object (.${propertyFieldName(entity.idProperty)}=\${object.${propertyFieldName(entity.idProperty)}}) '
"doesn't match the inserted ID (ID \$id). "
'You must assign an ID before calling [box.put()].');
}
Expand All @@ -207,6 +207,10 @@ class CodeChunks {
return "''";
case 'List':
return '[]';
case 'Int8List':
return 'Int8List(0)';
case 'Uint8List':
return 'Uint8List(0)';
default:
throw InvalidGenerationSourceError(
'Cannot figure out default value for field: ${p.fieldType} ${p.name}');
Expand Down Expand Up @@ -331,24 +335,25 @@ class CodeChunks {
switch (p.type) {
case OBXPropertyType.ByteVector:
if (['Int8List', 'Uint8List'].contains(p.fieldType)) {
// No need for the eager reader here. We need to call fromList()
// constructor anyway - there's no Int8List.generate() factory.
fbReader = 'fb.ListReader<int>(fb.Int8Reader())';
if (p.fieldIsNullable) {
preLines.add('final $valueVar = ${readFieldOrNull()};');
return '$valueVar == null ? null : ${p.fieldType}.fromList($valueVar)';
} else {
return '${p.fieldType}.fromList(${readFieldNonNull('[]')})';
}
fbReader = 'fb.${p.fieldType}Reader(lazy: false)';
return '${readField()} as ${p.fieldType}${p.fieldIsNullable && p.entity!.nullSafetyEnabled ? "?" : ""}';
} else {
fbReader = 'fb.ListReader<int>(fb.Int8Reader(), lazy: false)';
}
break;
case OBXPropertyType.Relation:
fbReader = 'fb.${_propertyFlatBuffersType[p.type]}Reader()';
return readFieldNonNull('0');
case OBXPropertyType.String:
// TODO `asciiOptimization: true` is for keeping the same behavior as the previous FB fork.
// Check if it still makes sense with the latest Dart/Flutter.
fbReader = 'fb.StringReader(asciiOptimization: true)';
break;
case OBXPropertyType.StringVector:
fbReader = 'fb.ListReader<String>(fb.StringReader(), lazy: false)';
// TODO `asciiOptimization: true` is for keeping the same behavior as the previous FB fork.
// Check if it still makes sense with the latest Dart/Flutter.
fbReader =
'fb.ListReader<String>(fb.StringReader(asciiOptimization: true), lazy: false)';
break;
default:
fbReader = 'fb.${_propertyFlatBuffersType[p.type]}Reader()';
Expand Down Expand Up @@ -607,7 +612,7 @@ class CodeChunks {
}

return '''
/// [${entity.name}] entity fields to define ObjectBox queries.
/// [${entity.name}] entity fields to define ObjectBox queries.
class ${entity.name}_ {${fields.join()}}
''';
}
Expand Down
Loading