This repository has been archived by the owner on Jan 18, 2022. It is now read-only.
UTY-1970: invalid enum definition #1412
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Corresponding JIRA ticket: https://improbableio.atlassian.net/browse/UTY-1970 |
improbable-prow-robot
added
A: maintenance
|
Need to repoint this to |
improbable-prow-robot
added
size/S
BryanJY-Wong
commented
Jul 1, 2020
| @@ -60,7 +61,8 @@ public string GetDeserializationExpression(string schemaObject, uint fieldNumber | |||
| return | |||
| $"{schemaObject}.{SchemaFunctionMappings.GetSchemaFunctionFromType(PrimitiveType.Value)}({fieldNumber})"; | |||
| case ValueType.Enum: | |||
| return $"({FqnType}) {schemaObject}.GetEnum({fieldNumber})"; | |||
| var shifter = UnityEnumDetails.GetEnumMinimum(FqnType); | |||
| return $"({FqnType}) ({schemaObject}.GetEnum({fieldNumber}) - {shifter})"; | |||
There was a problem hiding this comment.
Tried a val + 0 on https://sharplab.io/. Compiler ignores +- 0.
jamiebrynes7
reviewed
Jul 2, 2020
...e.gdk.tools/.CodeGenTemplate/CodeGenerationLib/Model/Details/TypeDetails/UnityEnumDetails.cs
Show resolved
Hide resolved
...e.gdk.tools/.CodeGenTemplate/CodeGenerationLib/Model/Details/TypeDetails/UnityEnumDetails.cs
Outdated
Show resolved
Hide resolved
...e.gdk.tools/.CodeGenTemplate/CodeGenerationLib/Model/Details/TypeDetails/UnityEnumDetails.cs
Outdated
Show resolved
Hide resolved
BryanJY-Wong
force-pushed
the
bug/invalid-enum-definition
branch
from
11890ad to
1edc476
Compare
paulbalaji
reviewed
Jul 2, 2020
jamiebrynes7
approved these changes
Jul 3, 2020
CHANGELOG.md
Outdated
Comment on lines
13
to
15
| ### Breaking Changes | ||
|
|
||
| - All generated C# enums will now start from 0, being shifted to schema values on serialization and shifted back to C# values on deserialization. [#1412](https://github.com/spatialos/gdk-for-unity/pull/1412) |
There was a problem hiding this comment.
Typically we put 'Breaking Changes' at the top as that will be most important to a developer when upgrading
paulbalaji
approved these changes
Jul 3, 2020
Move breaking changes to top
|
Kudos, SonarCloud Quality Gate passed!
|
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Shifted all C# enum definition to start from 0 to ensure no invalid enums are generated by default constructors. Serialization is done by
value + min_valand Deserializationvalue - min_val. A warning is also generated to advice users to redefine the schema enums to start from 0.Tests
Change the playground schema for
Color(sorted and unsorted, sequential and non-sequential) and ran the code generator to ensure the enum definition, serialization and deserialization function inColorDatais what's expected.Documentation
Did you remember a changelog entry?
Yes
Primary reviewers
If your change will take a long time to review, you can name at most two primary reviewers who are ultimately responsible for reviewing this request. @ mention them.