Make JavaTemplate engine extensible
#3475
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
To allow the `JavaTemplate` mechanism to be used for other languages like Kotlin, the provided parser builder must provide a way to add a classpath entry. This is because the internal `__M__` and `__P__` types are required for the parameter substitution and rather than including them as source code in the compilation unit, the parser will load them from the classpath. To this end this PR introduces new `JvmParser` and `JvmParser.Builder` types and the `JavaParser.Builder#classpath()` methods are moved to `JvmParser.Builder`. In order to not increase the API surface area, no corresponding getter was added to `JvmParser.Builder`. Instead, there is a new `Internals` class providing a static `getClasspath(JvmParser.Builder)` method. Issue: openrewrite/rewrite-kotlin#218
|
Converted to draft as Kotlin support most likely will require a dedicated |
knutwannheden
commented
Aug 14, 2023
|
i worry about the impact on classloading of |
Yes, now that we have a KotlinTemplate class that should be possible. I will work that out later today. |
knutwannheden
changed the title
JvmParser as supertype to JavaParserJavaTemplate engine extensible
sambsnyd
reviewed
Aug 15, 2023
| public Builder javaParser(JavaParser.Builder<?, ?> javaParser) { | ||
| this.javaParser = javaParser; | ||
| public Builder javaParser(JavaParser.Builder<?, ?> parser) { | ||
| this.parser = parser.clone(); |
There was a problem hiding this comment.
Why is this clone() now when it wasn't before?
There was a problem hiding this comment.
I want to call clone before adding the classpath entry for the __M__ and __P__ classes. But it could also be done slightly later. Also, we call clone() later anyway before invoking the parser.
I also like to do defensive copying in builders.
rewrite-java/src/main/java/org/openrewrite/java/JavaTemplate.java
Outdated
Show resolved
Hide resolved
# Conflicts: # rewrite-java/src/main/java/org/openrewrite/java/JavaParser.java # rewrite-java/src/main/java/org/openrewrite/java/JavaTemplate.java # rewrite-java/src/main/java/org/openrewrite/java/ReplaceConstantWithAnotherConstant.java # rewrite-java/src/main/java/org/openrewrite/java/internal/template/Substitutions.java
traceyyoshima
approved these changes
Dec 29, 2023
JLLeitschuh
reviewed
Jan 25, 2024
rewrite-java/src/main/java/org/openrewrite/java/internal/template/__M__.java
Outdated
Show resolved
Hide resolved
JLLeitschuh
reviewed
Jan 25, 2024
rewrite-java/src/main/java/org/openrewrite/java/internal/template/__P__.java
Outdated
Show resolved
Hide resolved
knutwannheden
commented
Jan 25, 2024
rewrite-java/src/main/java/org/openrewrite/java/internal/template/__M__.java
Outdated
Show resolved
Hide resolved
rewrite-java/src/main/java/org/openrewrite/java/internal/template/__P__.java
Outdated
Show resolved
Hide resolved
# Conflicts: # rewrite-java/src/main/java/org/openrewrite/java/JavaTemplate.java # rewrite-java/src/main/java/org/openrewrite/java/internal/template/BlockStatementTemplateGenerator.java # rewrite-java/src/main/java/org/openrewrite/java/internal/template/Substitutions.java
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
To allow the
JavaTemplatemechanism to be used for other languages like Kotlin, theJavaTemplateParsermust accept a genericParser.Builder(i.e. not requireJavaParser.Builder). This parser is expected to be preconfigured with a classpath entry containing the internal__M__and__P__types used by the template engine, as these are required for the parameter substitution.Some of the classes and members have been declared as
protected, but this may change again in the future.Issue: openrewrite/rewrite-kotlin#218