dart: use enhanced enums (#8313)

* dart: rename enums.fbs

* feat: use dart enhanced enums

* generate code

---------

Co-authored-by: Wouter van Oortmerssen <aardappel@gmail.com>

tests/DartTest.sh

@@ -1,4 +1,5 @@
 #!/bin/sh
+set -euo pipefail
 #
 # Copyright 2016 Google Inc. All rights reserved.
 #
@@ -16,7 +17,10 @@
 
 pushd "$(dirname $0)" >/dev/null
 
-command -v dart >/dev/null 2>&1 || { echo >&2 "Dart tests require dart to be in path but it's not installed.  Aborting."; exit 1; }
+command -v dart >/dev/null 2>&1 || {
+    echo >&2 "Dart tests require dart to be in path but it's not installed.  Aborting."
+    exit 1
+}
 # output required files to the dart folder so that pub will be able to
 # distribute them and more people can more easily run the dart tests
 ../flatc --dart --gen-object-api -I include_test -o ../dart/test monster_test.fbs
@@ -28,7 +32,7 @@ cp monster_test.fbs ../dart/test
 
 cd ../dart
 
-../flatc --dart --gen-object-api -o ./test ./test/list_of_enums.fbs
+../flatc --dart --gen-object-api -o ./test ./test/enums.fbs
 ../flatc --dart --gen-object-api -o ./test ./test/bool_structs.fbs
 
 # update packages

tests/include_test1_generated.dart

@@ -1,5 +1,5 @@
 // automatically generated by the FlatBuffers compiler, do not modify
-// ignore_for_file: unused_import, unused_field, unused_element, unused_local_variable
+// 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;

tests/include_test2_my_game.other_name_space_generated.dart

@@ -1,5 +1,5 @@
 // automatically generated by the FlatBuffers compiler, do not modify
-// ignore_for_file: unused_import, unused_field, unused_element, unused_local_variable
+// ignore_for_file: unused_import, unused_field, unused_element, unused_local_variable, constant_identifier_names
 
 library my_game.other_name_space;
 
@@ -9,35 +9,25 @@ import 'package:flat_buffers/flat_buffers.dart' as fb;
 
 import './include_test1_generated.dart';
 
-class FromInclude {
+enum FromInclude {
+  IncludeVal(0);
+
   final int value;
-  const FromInclude._(this.value);
+  const FromInclude(this.value);
 
   factory FromInclude.fromValue(int value) {
-    final result = values[value];
-    if (result == null) {
-        throw StateError('Invalid value $value for bit flag enum FromInclude');
+    switch (value) {
+      case 0: return FromInclude.IncludeVal;
+      default: throw StateError('Invalid value $value for bit flag enum');
     }
-    return result;
   }
 
-  static FromInclude? _createOrNull(int? value) => 
+  static FromInclude? _createOrNull(int? value) =>
       value == null ? null : FromInclude.fromValue(value);
 
   static const int minValue = 0;
   static const int maxValue = 0;
-  static bool containsValue(int value) => values.containsKey(value);
-
-  static const FromInclude IncludeVal = FromInclude._(0);
-  static const Map<int, FromInclude> values = {
-    0: IncludeVal};
-
   static const fb.Reader<FromInclude> reader = _FromIncludeReader();
-
-  @override
-  String toString() {
-    return 'FromInclude{value: $value}';
-  }
 }
 
 class _FromIncludeReader extends fb.Reader<FromInclude> {

tests/monster_extra_my_game_generated.dart

@@ -1,5 +1,5 @@
 // automatically generated by the FlatBuffers compiler, do not modify
-// ignore_for_file: unused_import, unused_field, unused_element, unused_local_variable
+// ignore_for_file: unused_import, unused_field, unused_element, unused_local_variable, constant_identifier_names
 
 library my_game;
 

tests/monster_test_my_game.example2_generated.dart

@@ -1,5 +1,5 @@
 // automatically generated by the FlatBuffers compiler, do not modify
-// ignore_for_file: unused_import, unused_field, unused_element, unused_local_variable
+// ignore_for_file: unused_import, unused_field, unused_element, unused_local_variable, constant_identifier_names
 
 library my_game.example2;
 

tests/monster_test_my_game.example_generated.dart

@@ -1,5 +1,5 @@
 // automatically generated by the FlatBuffers compiler, do not modify
-// ignore_for_file: unused_import, unused_field, unused_element, unused_local_variable
+// ignore_for_file: unused_import, unused_field, unused_element, unused_local_variable, constant_identifier_names
 
 library my_game.example;
 
@@ -12,46 +12,29 @@ import './monster_test_my_game.example2_generated.dart' as my_game_example2;
 import './include_test1_generated.dart';
 
 ///  Composite components of Monster color.
-class Color {
+enum Color {
+  Red(1),
+  Green(2),
+  Blue(8),
+  _default(0);
+
   final int value;
-  const Color._(this.value);
+  const Color(this.value);
 
   factory Color.fromValue(int value) {
-    final result = values[value];
-    if (result == null) {
-      if (value == 0) {
-        return Color._(0);
-      } else {
-        throw StateError('Invalid value $value for bit flag enum Color');
-      }
+    switch (value) {
+      case 1: return Color.Red;
+      case 2: return Color.Green;
+      case 8: return Color.Blue;
+      case 0: return Color._default;
+      default: throw StateError('Invalid value $value for bit flag enum');
     }
-    return result;
   }
 
-  static Color? _createOrNull(int? value) => 
+  static Color? _createOrNull(int? value) =>
       value == null ? null : Color.fromValue(value);
 
-  static bool containsValue(int value) => values.containsKey(value);
-
-  static const Color Red = Color._(1);
-
-  ///  \brief color Green
-  ///  Green is bit_flag with value (1u << 1)
-  static const Color Green = Color._(2);
-
-  ///  \brief color Blue (1u << 3)
-  static const Color Blue = Color._(8);
-  static const Map<int, Color> values = {
-    1: Red,
-    2: Green,
-    8: Blue};
-
   static const fb.Reader<Color> reader = _ColorReader();
-
-  @override
-  String toString() {
-    return 'Color{value: $value}';
-  }
 }
 
 class _ColorReader extends fb.Reader<Color> {
@@ -65,41 +48,31 @@ class _ColorReader extends fb.Reader<Color> {
       Color.fromValue(const fb.Uint8Reader().read(bc, offset));
 }
 
-class Race {
+enum Race {
+  None(-1),
+  Human(0),
+  Dwarf(1),
+  Elf(2);
+
   final int value;
-  const Race._(this.value);
+  const Race(this.value);
 
   factory Race.fromValue(int value) {
-    final result = values[value];
-    if (result == null) {
-        throw StateError('Invalid value $value for bit flag enum Race');
+    switch (value) {
+      case -1: return Race.None;
+      case 0: return Race.Human;
+      case 1: return Race.Dwarf;
+      case 2: return Race.Elf;
+      default: throw StateError('Invalid value $value for bit flag enum');
     }
-    return result;
   }
 
-  static Race? _createOrNull(int? value) => 
+  static Race? _createOrNull(int? value) =>
       value == null ? null : Race.fromValue(value);
 
   static const int minValue = -1;
   static const int maxValue = 2;
-  static bool containsValue(int value) => values.containsKey(value);
-
-  static const Race None = Race._(-1);
-  static const Race Human = Race._(0);
-  static const Race Dwarf = Race._(1);
-  static const Race Elf = Race._(2);
-  static const Map<int, Race> values = {
-    -1: None,
-    0: Human,
-    1: Dwarf,
-    2: Elf};
-
   static const fb.Reader<Race> reader = _RaceReader();
-
-  @override
-  String toString() {
-    return 'Race{value: $value}';
-  }
 }
 
 class _RaceReader extends fb.Reader<Race> {
@@ -113,41 +86,29 @@ class _RaceReader extends fb.Reader<Race> {
       Race.fromValue(const fb.Int8Reader().read(bc, offset));
 }
 
-class LongEnum {
+enum LongEnum {
+  LongOne(2),
+  LongTwo(4),
+  LongBig(1099511627776),
+  _default(0);
+
   final int value;
-  const LongEnum._(this.value);
+  const LongEnum(this.value);
 
   factory LongEnum.fromValue(int value) {
-    final result = values[value];
-    if (result == null) {
-      if (value == 0) {
-        return LongEnum._(0);
-      } else {
-        throw StateError('Invalid value $value for bit flag enum LongEnum');
-      }
+    switch (value) {
+      case 2: return LongEnum.LongOne;
+      case 4: return LongEnum.LongTwo;
+      case 1099511627776: return LongEnum.LongBig;
+      case 0: return LongEnum._default;
+      default: throw StateError('Invalid value $value for bit flag enum');
     }
-    return result;
   }
 
-  static LongEnum? _createOrNull(int? value) => 
+  static LongEnum? _createOrNull(int? value) =>
       value == null ? null : LongEnum.fromValue(value);
 
-  static bool containsValue(int value) => values.containsKey(value);
-
-  static const LongEnum LongOne = LongEnum._(2);
-  static const LongEnum LongTwo = LongEnum._(4);
-  static const LongEnum LongBig = LongEnum._(1099511627776);
-  static const Map<int, LongEnum> values = {
-    2: LongOne,
-    4: LongTwo,
-    1099511627776: LongBig};
-
   static const fb.Reader<LongEnum> reader = _LongEnumReader();
-
-  @override
-  String toString() {
-    return 'LongEnum{value: $value}';
-  }
 }
 
 class _LongEnumReader extends fb.Reader<LongEnum> {
@@ -161,41 +122,31 @@ class _LongEnumReader extends fb.Reader<LongEnum> {
       LongEnum.fromValue(const fb.Uint64Reader().read(bc, offset));
 }
 
-class AnyTypeId {
+enum AnyTypeId {
+  NONE(0),
+  Monster(1),
+  TestSimpleTableWithEnum(2),
+  MyGame_Example2_Monster(3);
+
   final int value;
-  const AnyTypeId._(this.value);
+  const AnyTypeId(this.value);
 
   factory AnyTypeId.fromValue(int value) {
-    final result = values[value];
-    if (result == null) {
-        throw StateError('Invalid value $value for bit flag enum AnyTypeId');
+    switch (value) {
+      case 0: return AnyTypeId.NONE;
+      case 1: return AnyTypeId.Monster;
+      case 2: return AnyTypeId.TestSimpleTableWithEnum;
+      case 3: return AnyTypeId.MyGame_Example2_Monster;
+      default: throw StateError('Invalid value $value for bit flag enum');
     }
-    return result;
   }
 
-  static AnyTypeId? _createOrNull(int? value) => 
+  static AnyTypeId? _createOrNull(int? value) =>
       value == null ? null : AnyTypeId.fromValue(value);
 
   static const int minValue = 0;
   static const int maxValue = 3;
-  static bool containsValue(int value) => values.containsKey(value);
-
-  static const AnyTypeId NONE = AnyTypeId._(0);
-  static const AnyTypeId Monster = AnyTypeId._(1);
-  static const AnyTypeId TestSimpleTableWithEnum = AnyTypeId._(2);
-  static const AnyTypeId MyGame_Example2_Monster = AnyTypeId._(3);
-  static const Map<int, AnyTypeId> values = {
-    0: NONE,
-    1: Monster,
-    2: TestSimpleTableWithEnum,
-    3: MyGame_Example2_Monster};
-
   static const fb.Reader<AnyTypeId> reader = _AnyTypeIdReader();
-
-  @override
-  String toString() {
-    return 'AnyTypeId{value: $value}';
-  }
 }
 
 class _AnyTypeIdReader extends fb.Reader<AnyTypeId> {
@@ -209,41 +160,31 @@ class _AnyTypeIdReader extends fb.Reader<AnyTypeId> {
       AnyTypeId.fromValue(const fb.Uint8Reader().read(bc, offset));
 }
 
-class AnyUniqueAliasesTypeId {
+enum AnyUniqueAliasesTypeId {
+  NONE(0),
+  M(1),
+  TS(2),
+  M2(3);
+
   final int value;
-  const AnyUniqueAliasesTypeId._(this.value);
+  const AnyUniqueAliasesTypeId(this.value);
 
   factory AnyUniqueAliasesTypeId.fromValue(int value) {
-    final result = values[value];
-    if (result == null) {
-        throw StateError('Invalid value $value for bit flag enum AnyUniqueAliasesTypeId');
+    switch (value) {
+      case 0: return AnyUniqueAliasesTypeId.NONE;
+      case 1: return AnyUniqueAliasesTypeId.M;
+      case 2: return AnyUniqueAliasesTypeId.TS;
+      case 3: return AnyUniqueAliasesTypeId.M2;
+      default: throw StateError('Invalid value $value for bit flag enum');
     }
-    return result;
   }
 
-  static AnyUniqueAliasesTypeId? _createOrNull(int? value) => 
+  static AnyUniqueAliasesTypeId? _createOrNull(int? value) =>
       value == null ? null : AnyUniqueAliasesTypeId.fromValue(value);
 
   static const int minValue = 0;
   static const int maxValue = 3;
-  static bool containsValue(int value) => values.containsKey(value);
-
-  static const AnyUniqueAliasesTypeId NONE = AnyUniqueAliasesTypeId._(0);
-  static const AnyUniqueAliasesTypeId M = AnyUniqueAliasesTypeId._(1);
-  static const AnyUniqueAliasesTypeId TS = AnyUniqueAliasesTypeId._(2);
-  static const AnyUniqueAliasesTypeId M2 = AnyUniqueAliasesTypeId._(3);
-  static const Map<int, AnyUniqueAliasesTypeId> values = {
-    0: NONE,
-    1: M,
-    2: TS,
-    3: M2};
-
   static const fb.Reader<AnyUniqueAliasesTypeId> reader = _AnyUniqueAliasesTypeIdReader();
-
-  @override
-  String toString() {
-    return 'AnyUniqueAliasesTypeId{value: $value}';
-  }
 }
 
 class _AnyUniqueAliasesTypeIdReader extends fb.Reader<AnyUniqueAliasesTypeId> {
@@ -257,41 +198,31 @@ class _AnyUniqueAliasesTypeIdReader extends fb.Reader<AnyUniqueAliasesTypeId> {
       AnyUniqueAliasesTypeId.fromValue(const fb.Uint8Reader().read(bc, offset));
 }
 
-class AnyAmbiguousAliasesTypeId {
+enum AnyAmbiguousAliasesTypeId {
+  NONE(0),
+  M1(1),
+  M2(2),
+  M3(3);
+
   final int value;
-  const AnyAmbiguousAliasesTypeId._(this.value);
+  const AnyAmbiguousAliasesTypeId(this.value);
 
   factory AnyAmbiguousAliasesTypeId.fromValue(int value) {
-    final result = values[value];
-    if (result == null) {
-        throw StateError('Invalid value $value for bit flag enum AnyAmbiguousAliasesTypeId');
+    switch (value) {
+      case 0: return AnyAmbiguousAliasesTypeId.NONE;
+      case 1: return AnyAmbiguousAliasesTypeId.M1;
+      case 2: return AnyAmbiguousAliasesTypeId.M2;
+      case 3: return AnyAmbiguousAliasesTypeId.M3;
+      default: throw StateError('Invalid value $value for bit flag enum');
     }
-    return result;
   }
 
-  static AnyAmbiguousAliasesTypeId? _createOrNull(int? value) => 
+  static AnyAmbiguousAliasesTypeId? _createOrNull(int? value) =>
       value == null ? null : AnyAmbiguousAliasesTypeId.fromValue(value);
 
   static const int minValue = 0;
   static const int maxValue = 3;
-  static bool containsValue(int value) => values.containsKey(value);
-
-  static const AnyAmbiguousAliasesTypeId NONE = AnyAmbiguousAliasesTypeId._(0);
-  static const AnyAmbiguousAliasesTypeId M1 = AnyAmbiguousAliasesTypeId._(1);
-  static const AnyAmbiguousAliasesTypeId M2 = AnyAmbiguousAliasesTypeId._(2);
-  static const AnyAmbiguousAliasesTypeId M3 = AnyAmbiguousAliasesTypeId._(3);
-  static const Map<int, AnyAmbiguousAliasesTypeId> values = {
-    0: NONE,
-    1: M1,
-    2: M2,
-    3: M3};
-
   static const fb.Reader<AnyAmbiguousAliasesTypeId> reader = _AnyAmbiguousAliasesTypeIdReader();
-
-  @override
-  String toString() {
-    return 'AnyAmbiguousAliasesTypeId{value: $value}';
-  }
 }
 
 class _AnyAmbiguousAliasesTypeIdReader extends fb.Reader<AnyAmbiguousAliasesTypeId> {
@@ -1461,7 +1392,7 @@ class MonsterT implements fb.Packable {
       this.testrequirednestedflatbuffer,
       this.scalarKeySortedTables,
       this.nativeInline,
-      this.longEnumNonEnumDefault = const LongEnum._(0),
+      this.longEnumNonEnumDefault = LongEnum._default,
       this.longEnumNormalDefault = LongEnum.LongOne,
       this.nanDefault = double.nan,
       this.infDefault = double.infinity,

tests/monster_test_my_game_generated.dart

@@ -1,5 +1,5 @@
 // automatically generated by the FlatBuffers compiler, do not modify
-// ignore_for_file: unused_import, unused_field, unused_element, unused_local_variable
+// ignore_for_file: unused_import, unused_field, unused_element, unused_local_variable, constant_identifier_names
 
 library my_game;