[generator] Honor 'api-since' attribute to fill ApiAvailableSince property. #644
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
changed the title
jonpryor
pushed a commit
that referenced
this pull request
May 15, 2020
Context: 005e273 Currently, if `generator --apiversions=FILE` is used, then the `RegisterAttribute.ApiSince` field will be set to contain the API version which introduced a method, e.g. when building xamarin-android's `src/Mono.Android`: $ generator.exe --apiversions=$HOME/android-toolchain/sdk/platform-tools/api/api-versions.xml … and `$HOME/android-toolchain/sdk/platform-tools/api/api-versions.xml` contains: <class name="android/view/inspector/IntFlagMapping" since="29"> <extends name="java/lang/Object"/> then `generator` will emit: [Register ("android/view/inspector/IntFlagMapping", DoNotGenerateAcw=true, ApiSince=29)] partial class IntFlagMapping {} Unfortunately, we have found that Google's support of this file isn't guaranteed. Sometimes it is missing, other times it changes in unexpected ways, causing `ApiCompat` breakage within xamarin-android. In short, we have lost faith in `api-versions.xml`. Instead of using `api-versions.xml`, allow `RegisterAttribute.ApiSince` to be populated by a new `//@api-since` attribute, which is now honored on `package`, `class`/`interface`, `method`, and `field` elements: <field name='VERSION_CODE' api-since='7' /> This allows it to be set via `metadata` or any external tooling that modifies `api.xml`. Note that members will inherit versions from parent types and parent package definitions, but can also override them as necessary. For example a package added in API-7 containing a class added in API-9: <package name='com.example.test' jni-name='com/example/test' api-since='7'> <class name='MyClassFrom7' /> <class name='MyClassFrom9' api-since='9' /> </package> As previously, this feature is probably only useful for `Mono.Android.dll` purposes, but it is now more accessible.
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.
Today,
generatorprovides the ability to assign versions to each bound member that is exposed in itsRegisterattributeApiSincefield, a la:This is populated via the internal
apiversions=option, which reads in a Google provided file containing the api version each member for appeared in. Unfortunately we have found that Google's support of this file isn't guaranteed. Sometimes it is missing, other times it changes randomly, causingApiCompatbreakage.This PR provides an alternate way to set this
ApiSincefield in theapi.xml. The attributeapi-sincein now honored onpackage,class/interface,method, andfieldelements:This allows it to be set via
metadataor any external tooling that modifiesapi.xml.Note that members will inherit version from parent types and parent package definitions, but can also override them as necessary. For example a package added in api 7 containing a class added in api 9:
Like previously, this feature is probably only useful for
Mono.Android.dllpurposes, but it is a little more accessible now.