[Xamarin.Android.Tools.Bytecode] Relax _ApiXml check #772
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
Context: dotnet#767 Context: https://github.com/xamarin/xamarin-android/blob/a7413a2389886082c3d3422c50a7e6cc84f43d8f/src/Xamarin.Android.Build.Tasks/MSBuild/Xamarin/Android/Xamarin.Android.Bindings.ClassParse.targets#L23 Commit 69e1b80 added `java-source-utils.jar`, which can parse Java source code to extract parameter names, storing them into a "`class-parse`-like XML file". A benefit to a "`class-parse`-like XML file" is that it should be possible to use this same file with `class-parse --docspath`, overriding parameter names present in Java bytecode (which typically *isn't* present, as `javac -parameters` is rarely used). Unfortunately, this doesn't work: if you attempt to use `java-source-utils.jar` output w/ `class-parse --docspath`, it fails: System.Exception: Directory 'example.xml' does not exist at Xamarin.Android.Tools.Bytecode.AndroidDocScraper..ctor (System.String dir, System.String patternHead, System.String resetPatternHead, System.String parameterPairSplitter, System.Boolean continuousParamLines, System.String openMethod, System.String paramSep, System.String closeMethod, System.String postCloseMethodParens) [0x00093] in <e7fad12ab9c24ce08dac8732f18e1d85>:0 at Xamarin.Android.Tools.Bytecode.AndroidDocScraper..ctor (System.String dir, System.String patternHead, System.String resetPatternHead, System.String parameterPairSplitter, System.Boolean continuousParamLines) [0x00000] in <e7fad12ab9c24ce08dac8732f18e1d85>:0 at Xamarin.Android.Tools.Bytecode.DroidDocScraper..ctor (System.String dir) [0x00000] in <e7fad12ab9c24ce08dac8732f18e1d85>:0 at Xamarin.Android.Tools.Bytecode.ClassPath.CreateDocScraper (System.String src) [0x00037] in <e7fad12ab9c24ce08dac8732f18e1d85>:0 The problem is that we shouldn't be creating a `DroidDocScraper` for `java-source-utils.jar` output, it should be creating a `ApiXmlDocScraper`! We're creating the wrong `*Scraper` type because `JavaMethodParameterNameProvider.GetDocletType()` doesn't detect `java-source-utils.jar` output as being `JavaDocletType._ApiXml`; instead, it treats it as the default of `JavaDocletType.DroidDoc`. `JavaMethodParameterNameProvider.GetDocletType()` doesn't detect `java-source-utils.jar` output as being `JavaDocletType._ApiXml`, because it requires that the XML contain: <api> while `java-source-utils.jar` instead emits: <api api-source="java-source-utils"> Relax `JavaMethodParameterNameProvider.GetDocletType()` to instead check for `<api`. This allows `class-parse` to use `java-source-utils.jar` output for parameter names.
jpobst
approved these changes
Jan 6, 2021
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
Context: #767
Context: https://github.com/xamarin/xamarin-android/blob/a7413a2389886082c3d3422c50a7e6cc84f43d8f/src/Xamarin.Android.Build.Tasks/MSBuild/Xamarin/Android/Xamarin.Android.Bindings.ClassParse.targets#L23
Commit 69e1b80 added
java-source-utils.jar, which can parse Javasource code to extract parameter names, storing them into a
"
class-parse-like XML file".A benefit to a "
class-parse-like XML file" is that it should bepossible to use this same file with
class-parse --docspath,overriding parameter names present in Java bytecode (which typically
isn't present, as
javac -parametersis rarely used).Unfortunately, this doesn't work: if you attempt to use
java-source-utils.jaroutput w/class-parse --docspath, it fails:The problem is that we shouldn't be creating a
DroidDocScraperfor
java-source-utils.jaroutput, it should be creating aApiXmlDocScraper!We're creating the wrong
*Scrapertype becauseJavaMethodParameterNameProvider.GetDocletType()doesn't detectjava-source-utils.jaroutput as beingJavaDocletType._ApiXml;instead, it treats it as the default of
JavaDocletType.DroidDoc.JavaMethodParameterNameProvider.GetDocletType()doesn't detectjava-source-utils.jaroutput as beingJavaDocletType._ApiXml,because it requires that the XML contain:
while
java-source-utils.jarinstead emits:Relax
JavaMethodParameterNameProvider.GetDocletType()to insteadcheck for
<api. This allowsclass-parseto usejava-source-utils.jaroutput for parameter names.