Skip to content

[Dart] Code generation and formatting fixes #8738

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

Closed
wants to merge 4 commits into from
Closed

[Dart] Code generation and formatting fixes #8738

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
2b44f17
Fix unpack function for union
jakobkordez Oct 23, 2025
904c180
Fix struct vector ordering on pack
jakobkordez Oct 23, 2025
6b2d45b
Add missing newline after object builder
jakobkordez Oct 24, 2025
c74e349
Fix dart tests, regenerate test code
jakobkordez Oct 27, 2025
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
32 changes: 15 additions & 17 deletions dart/test/flat_buffers_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -868,15 +868,14 @@ class ObjectAPITest {
..name = 'Monstrous'
..inventory = [24, 42]
..color = example.Color.Green
// TODO be smarter for unions and automatically set the `type` field?
..testType = example.AnyTypeId.MyGame_Example2_Monster
..test = example2.MonsterT()
..test4 = [example.TestT(a: 3, b: 4), example.TestT(a: 5, b: 6)]
..testarrayofstring = ["foo", "bar"]
..testarrayoftables = [example.MonsterT(name: 'Oof')]
..enemy = example.MonsterT(name: 'Enemy')
..testarrayoftables = [example.MonsterT(name: 'Oof', testf: 42.5)]
..enemy = example.MonsterT(name: 'Enemy', testf: 32.75)
..testarrayofbools = [false, true, false]
..testf = 42.24
..testf = 42.25
..testarrayofsortedstruct = [
example.AbilityT(id: 1, distance: 5),
example.AbilityT(id: 3, distance: 7),
Expand All @@ -894,16 +893,16 @@ class ObjectAPITest {
fbBuilder.finish(offset);
final data = fbBuilder.buffer;

// TODO currently broken because of struct builder issue, see #6688
// final monster2 = example.Monster(data); // Monster (reader)
// expect(
// // map Monster => MonsterT, Vec3 => Vec3T, ...
// monster2.toString().replaceAllMapped(
// RegExp('([a-zA-z0-9]+){'), (match) => match.group(1) + 'T{'),
// monster.toString());
//
// final monster3 = monster2.unpack(); // MonsterT
// expect(monster3.toString(), monster.toString());
final monster2 = example.Monster(data); // Monster (reader)
expect(
// map Monster => MonsterT, Vec3 => Vec3T, ...
monster2.toString().replaceAllMapped(
RegExp('([a-zA-Z0-9]+){'), (match) => match.group(1)! + 'T{'),
monster.toString(),
);

final monster3 = monster2.unpack(); // MonsterT
expect(monster3.toString(), monster.toString());
}

void test_Lists() {
Expand Down Expand Up @@ -942,9 +941,8 @@ class StringListWrapperImpl {

StringListWrapperImpl(this.bp, this.offset);

List<String>? get items => const ListReader<String>(
StringReader(),
).vTableGetNullable(bp, offset, indexToField(0));
List<String>? get items => const ListReader<String>(StringReader())
.vTableGetNullable(bp, offset, indexToField(0));
}

class StringListWrapperReader extends TableReader<StringListWrapperImpl> {
Expand Down
26 changes: 14 additions & 12 deletions dart/test/include_test1_generated.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,10 @@
// ignore_for_file: unused_import, unused_field, unused_element, unused_local_variable, constant_identifier_names

import 'dart:typed_data' show Uint8List;

import 'package:flat_buffers/flat_buffers.dart' as fb;

import './include_test2_my_game.other_name_space_generated.dart'
as my_game_other_name_space;

import './include_test2_my_game.other_name_space_generated.dart' as my_game_other_name_space;

class TableA {
TableA._(this._bc, this._bcOffset);
Expand All @@ -20,17 +19,15 @@ class TableA {
final fb.BufferContext _bc;
final int _bcOffset;

my_game_other_name_space.TableB? get b => my_game_other_name_space
.TableB
.reader
.vTableGetNullable(_bc, _bcOffset, 4);
my_game_other_name_space.TableB? get b => my_game_other_name_space.TableB.reader.vTableGetNullable(_bc, _bcOffset, 4);

@override
String toString() {
return 'TableA{b: ${b}}';
}

TableAT unpack() => TableAT(b: b?.unpack());
TableAT unpack() => TableAT(
b: b?.unpack());

static int pack(fb.Builder fbBuilder, TableAT? object) {
if (object == null) return 0;
Expand All @@ -41,7 +38,8 @@ class TableA {
class TableAT implements fb.Packable {
my_game_other_name_space.TableBT? b;

TableAT({this.b});
TableAT({
this.b});

@override
int pack(fb.Builder fbBuilder) {
Expand All @@ -61,7 +59,8 @@ class _TableAReader extends fb.TableReader<TableA> {
const _TableAReader();

@override
TableA createObject(fb.BufferContext bc, int offset) => TableA._(bc, offset);
TableA createObject(fb.BufferContext bc, int offset) =>
TableA._(bc, offset);
}

class TableABuilder {
Expand All @@ -86,8 +85,10 @@ class TableABuilder {
class TableAObjectBuilder extends fb.ObjectBuilder {
final my_game_other_name_space.TableBObjectBuilder? _b;

TableAObjectBuilder({my_game_other_name_space.TableBObjectBuilder? b})
: _b = b;
TableAObjectBuilder({
my_game_other_name_space.TableBObjectBuilder? b,
})
: _b = b;

/// Finish building, and store into the [fbBuilder].
@override
Expand All @@ -106,3 +107,4 @@ class TableAObjectBuilder extends fb.ObjectBuilder {
return fbBuilder.buffer;
}
}

38 changes: 25 additions & 13 deletions dart/test/include_test2_my_game.other_name_space_generated.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
library my_game.other_name_space;

import 'dart:typed_data' show Uint8List;

import 'package:flat_buffers/flat_buffers.dart' as fb;


import './include_test1_generated.dart';

enum FromInclude {
Expand All @@ -17,10 +17,8 @@ enum FromInclude {

factory FromInclude.fromValue(int value) {
switch (value) {
case 0:
return FromInclude.IncludeVal;
default:
throw StateError('Invalid value $value for bit flag enum');
case 0: return FromInclude.IncludeVal;
default: throw StateError('Invalid value $value for bit flag enum');
}
}

Expand Down Expand Up @@ -58,7 +56,8 @@ class Unused {
return 'Unused{a: ${a}}';
}

UnusedT unpack() => UnusedT(a: a);
UnusedT unpack() => UnusedT(
a: a);

static int pack(fb.Builder fbBuilder, UnusedT? object) {
if (object == null) return 0;
Expand All @@ -69,7 +68,8 @@ class Unused {
class UnusedT implements fb.Packable {
int a;

UnusedT({required this.a});
UnusedT({
required this.a});

@override
int pack(fb.Builder fbBuilder) {
Expand All @@ -90,7 +90,8 @@ class _UnusedReader extends fb.StructReader<Unused> {
int get size => 4;

@override
Unused createObject(fb.BufferContext bc, int offset) => Unused._(bc, offset);
Unused createObject(fb.BufferContext bc, int offset) =>
Unused._(bc, offset);
}

class UnusedBuilder {
Expand All @@ -102,12 +103,16 @@ class UnusedBuilder {
fbBuilder.putInt32(a);
return fbBuilder.offset;
}

}

class UnusedObjectBuilder extends fb.ObjectBuilder {
final int _a;

UnusedObjectBuilder({required int a}) : _a = a;
UnusedObjectBuilder({
required int a,
})
: _a = a;

/// Finish building, and store into the [fbBuilder].
@override
Expand Down Expand Up @@ -144,7 +149,8 @@ class TableB {
return 'TableB{a: ${a}}';
}

TableBT unpack() => TableBT(a: a?.unpack());
TableBT unpack() => TableBT(
a: a?.unpack());

static int pack(fb.Builder fbBuilder, TableBT? object) {
if (object == null) return 0;
Expand All @@ -155,7 +161,8 @@ class TableB {
class TableBT implements fb.Packable {
TableAT? a;

TableBT({this.a});
TableBT({
this.a});

@override
int pack(fb.Builder fbBuilder) {
Expand All @@ -175,7 +182,8 @@ class _TableBReader extends fb.TableReader<TableB> {
const _TableBReader();

@override
TableB createObject(fb.BufferContext bc, int offset) => TableB._(bc, offset);
TableB createObject(fb.BufferContext bc, int offset) =>
TableB._(bc, offset);
}

class TableBBuilder {
Expand All @@ -200,7 +208,10 @@ class TableBBuilder {
class TableBObjectBuilder extends fb.ObjectBuilder {
final TableAObjectBuilder? _a;

TableBObjectBuilder({TableAObjectBuilder? a}) : _a = a;
TableBObjectBuilder({
TableAObjectBuilder? a,
})
: _a = a;

/// Finish building, and store into the [fbBuilder].
@override
Expand All @@ -219,3 +230,4 @@ class TableBObjectBuilder extends fb.ObjectBuilder {
return fbBuilder.buffer;
}
}

4 changes: 3 additions & 1 deletion dart/test/keyword_test_keyword_test_generated.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,7 @@ class KeywordsInTableObjectBuilder extends fb.ObjectBuilder {
return fbBuilder.buffer;
}
}

class Table2 {
Table2._(this._bc, this._bcOffset);
factory Table2(List<int> bytes) {
Expand Down Expand Up @@ -276,7 +277,7 @@ class Table2 {

Table2T unpack() => Table2T(
typeType: typeType,
type: type);
type: type?.unpack());

static int pack(fb.Builder fbBuilder, Table2T? object) {
if (object == null) return 0;
Expand Down Expand Up @@ -367,3 +368,4 @@ class Table2ObjectBuilder extends fb.ObjectBuilder {
return fbBuilder.buffer;
}
}

13 changes: 8 additions & 5 deletions dart/test/monster_test_my_game.example2_generated.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
library my_game.example2;

import 'dart:typed_data' show Uint8List;

import 'package:flat_buffers/flat_buffers.dart' as fb;

import './include_test1_generated.dart';
import './monster_test_my_game.example_generated.dart' as my_game_example;
import './monster_test_my_game_generated.dart' as my_game;
import './monster_test_my_game.example_generated.dart' as my_game_example;

import './include_test1_generated.dart';

class Monster {
Monster._(this._bc, this._bcOffset);
Expand All @@ -23,6 +23,7 @@ class Monster {
final fb.BufferContext _bc;
final int _bcOffset;


@override
String toString() {
return 'Monster{}';
Expand Down Expand Up @@ -53,11 +54,12 @@ class _MonsterReader extends fb.TableReader<Monster> {
const _MonsterReader();

@override
Monster createObject(fb.BufferContext bc, int offset) =>
Monster._(bc, offset);
Monster createObject(fb.BufferContext bc, int offset) =>
Monster._(bc, offset);
}

class MonsterObjectBuilder extends fb.ObjectBuilder {

MonsterObjectBuilder();

/// Finish building, and store into the [fbBuilder].
Expand All @@ -75,3 +77,4 @@ class MonsterObjectBuilder extends fb.ObjectBuilder {
return fbBuilder.buffer;
}
}

Loading