Skip to content

Generate actual enums #931

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

Open
fischerscode wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Generate actual enums #931

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
64850a2
generator
fischerscode May 11, 2024
96d7cad
regenerate
fischerscode May 11, 2024
2689dd1
also test protobuf.omit_enum_names=true
fischerscode May 11, 2024
382993b
tests
fischerscode May 11, 2024
2b145be
fix omit_enum_names test
fischerscode May 11, 2024
d660015
add `tests_omit_enum_names` test tag
fischerscode May 11, 2024
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
2 changes: 1 addition & 1 deletion protoc_plugin/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ update-pregenerated: $(PLUGIN_PATH) $(PREGENERATED_SRCS)
protos: $(PLUGIN_PATH) $(TEST_PROTO_LIBS)

run-tests: protos
dart test
dart test && dart -Dprotobuf.omit_enum_names=true test

@fischerscode fischerscode May 11, 2024

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are tests that require testing both options.

@fischerscode fischerscode May 11, 2024

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Turns out this has to be dart -Dprotobuf.omit_enum_names=true test --use-data-isolate-strategy (changed it in 2b145be)
See dart-lang/test#1794 (comment)

Unfortunately this is much slower. It might be best to change the tests that depend on this.

@fischerscode fischerscode May 11, 2024

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update: I've introduced the test tag tests_omit_enum_names. (d660015)


update-goldens: protos
rm -rf test/goldens
Expand Down
46 changes: 23 additions & 23 deletions protoc_plugin/lib/src/enum_generator.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,10 +110,10 @@ class EnumGenerator extends ProtobufContainer {
out.println('@$coreImportPrefix.Deprecated(\'This enum is deprecated\')');
}
out.addAnnotatedBlock(
'class $classname extends $protobufImportPrefix.ProtobufEnum {',
'enum $classname implements $protobufImportPrefix.ProtobufEnum {',
'}\n', [
NamedLocation(
name: classname, fieldPathSegment: fieldPath, start: 'class '.length)
name: classname, fieldPathSegment: fieldPath, start: 'enum '.length)
], () {
// -----------------------------------------------------------------
// Define enum types.
Expand All @@ -137,16 +137,14 @@ class EnumGenerator extends ProtobufContainer {
'@$coreImportPrefix.Deprecated(\'This enum value is deprecated\')');
}

out.printlnAnnotated(
'static const $classname $name = '
'$classname._(${val.number}, $conditionalValName);',
[
NamedLocation(
name: name,
fieldPathSegment: fieldPathSegment,
start: 'static const $classname '.length)
]);
out.printlnAnnotated('$name(${val.number}, $conditionalValName),', [
NamedLocation(
name: name, fieldPathSegment: fieldPathSegment, start: 0)
]);
out.println();
}
out.println(';');

if (_aliases.isNotEmpty) {
out.println();
for (var i = 0; i < _aliases.length; i++) {
Expand All @@ -164,27 +162,29 @@ class EnumGenerator extends ProtobufContainer {
]);
}
}
out.println();

out.println('static const $coreImportPrefix.List<$classname> values ='
' <$classname> [');
for (final val in _canonicalValues) {
final name = dartNames[val.name];
out.println(' $name,');
}
out.println('];');
out.println();

out.println(
'static final $coreImportPrefix.Map<$coreImportPrefix.int, $classname> _byValue ='
' $protobufImportPrefix.ProtobufEnum.initByValue(values);');
out.println('static $classname? valueOf($coreImportPrefix.int value) =>'
' _byValue[value];');
out.println();

out.println();
out.println('@$coreImportPrefix.override');
out.println('final $coreImportPrefix.int value;');
out.println();
out.println('@$coreImportPrefix.override');
out.println('final $coreImportPrefix.String name;');
out.println();
out.println('const $classname(this.value, this.name);');
out.println();
out.println(
'const $classname._($coreImportPrefix.int v, $coreImportPrefix.String n) '
': super(v, n);');
"/// Returns this enum's [name] or the [value] if names are not"
' represented.');
out.println('@$coreImportPrefix.override');
out.println("$coreImportPrefix.String toString() => name == '' ? "
'value.toString() : name;');

@fischerscode fischerscode May 11, 2024

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to generate a "custom" toString method for each enum, since the default enum toString takes priority over the one from ProtobufEnum.

This method is designed to be 100% compatible, but it might be better to return Enum.name (super.toString()) instead of name.

});
}

Expand Down
1 change: 0 additions & 1 deletion protoc_plugin/lib/src/file_generator.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -644,7 +644,6 @@ class FileGenerator extends ProtobufContainer {
// Generated code. Do not modify.
// source: ${descriptor.name}
//
// @dart = 2.12

@fischerscode fischerscode May 11, 2024

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've removed all of them, since they would mess up the enum files and I don't think they serve any purpose.

''');
ignorelines.forEach(out.println);
out.println('');
Expand Down
5 changes: 3 additions & 2 deletions protoc_plugin/lib/src/generated/dart_options.pb.dart
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading