[generator] Create a v2 version of map.csv. #646
Merged
Conversation
This file contains hidden or 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
jpobst
force-pushed
the
enum-v2
branch
3 times, most recently
from
84fbd8b to
f61feda
Compare
jonpryor
pushed a commit
that referenced
this pull request
May 26, 2020
For ages, `generator --enumfields` has supported a `map.csv` format,
which was used within xamarin-android to "enumify" `Mono.Android.dll`.
This format was entirely undocumented.
Add `Documentation/EnumMappingFile.md` and document the format.
The previous `map.csv` line is 5-6 "columns", comma-delimited:
* API level the field was added in
* C# namespace and type of the C# enum to create.
* C# enum member name to create.
* C# enum member value
* JNI field to convert to the C# enum member, in the format
`{JNI type reference}.{Java field name}`.
* Flags? If (1) present, and (2) has the value `flags`, the
created C# enum has the `[Flags]` attribute.
Add support for a new 7-8 column line format, also documented in
`EnumMappingFile.md`:
* Action: `E`num, `A`dd, `R`emove, `I`gnore, `?` (decide later)
* API level
* JNI field to convert to the C# enum member, in the format
`{JNI type reference}.{Java field name}`.
* C# enum member value (which is the Java field value)
* C# namespace and type of C# enum to create
* C# enum member name to create.
* What to do with the Java field: `remove` it or `keep` it.
Replaces the previous `- ENTER TRANSIENT MODE -` "command".
* Flags? If (1) present, and (2) has the value `flags`, the
created C# enum has the `[Flags]` attribute.
Note that the column ordering for the 7-8 column format differs from
the previous 5-6 column format. This change in ordering is done for
improved "enumification workflow" support: future tooling will
generate the 7-8 column output *without* knowing what the C# enum type
and members will be. Placing the JNI information "leftmost" allows
the output to be "sensibly grouped" by tooling:
?,0,com/example/Class.FIELD,0,,,remove,
Support for parsing `map.csv` has been moved out of `generator.exe`
and into the new `Java.Interop.Tools.Generator.dll` assembly, in
`src/Java.Interop.Tools.Generator`. This new assembly will also be
used by a forthcoming `generator-utilities` app.
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.
Creates a new format for
map.csvto make enumification easier and more audit-able. Details are inDocumentation/EnumMappingFile.md.Refactors and adds tests for existing
map.csvformat.Creates a new
Java.Interop.Tools.Common.dllto allow code sharing between assemblies. For example, the enum map file support and models should be shared betweengeneratorand forthcominggenerator-utilities.