org.openrewrite.java.JavaTemplateSemanticallyEqual Maven / Gradle / Ivy
Show all versions of rewrite-java Show documentation
/*
* Copyright 2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.openrewrite.java;
import lombok.Value;
import org.antlr.v4.runtime.*;
import org.jspecify.annotations.Nullable;
import org.openrewrite.Cursor;
import org.openrewrite.internal.PropertyPlaceholderHelper;
import org.openrewrite.java.internal.grammar.TemplateParameterLexer;
import org.openrewrite.java.internal.grammar.TemplateParameterParser;
import org.openrewrite.java.internal.grammar.TemplateParameterParser.TypedPatternContext;
import org.openrewrite.java.internal.template.TemplateParameter;
import org.openrewrite.java.internal.template.TypeParameter;
import org.openrewrite.java.search.SemanticallyEqual;
import org.openrewrite.java.tree.*;
import org.openrewrite.marker.Markers;
import java.util.*;
import static org.openrewrite.Tree.randomId;
class JavaTemplateSemanticallyEqual extends SemanticallyEqual {
@Value
static class TemplateMatchResult {
boolean match;
List matchedParameters;
}
static TemplateMatchResult matchesTemplate(JavaTemplate template, Cursor input) {
JavaCoordinates coordinates;
if (input.getValue() instanceof Expression) {
coordinates = ((Expression) input.getValue()).getCoordinates().replace();
} else if (input.getValue() instanceof Statement) {
coordinates = ((Statement) input.getValue()).getCoordinates().replace();
} else {
throw new IllegalArgumentException("Only expressions and statements can be matched against a template: " + input.getClass());
}
J[] parameters = createTemplateParameters(template.getCode());
try {
J templateTree = template.apply(input, coordinates, (Object[]) parameters);
return matchTemplate(templateTree, input);
} catch (RuntimeException e) {
// FIXME this is just a workaround, as template matching finds many new corner cases in `JavaTemplate` which we need to fix
return new TemplateMatchResult(false, Collections.emptyList());
}
}
private static J[] createTemplateParameters(String code) {
PropertyPlaceholderHelper propertyPlaceholderHelper = new PropertyPlaceholderHelper(
"#{", "}", null);
List parameters = new ArrayList<>();
String substituted = code;
Map typedPatternByName = new HashMap<>();
while (true) {
String previous = substituted;
substituted = propertyPlaceholderHelper.replacePlaceholders(substituted, key -> {
String s;
if (!key.isEmpty()) {
TemplateParameterParser parser = new TemplateParameterParser(new CommonTokenStream(new TemplateParameterLexer(
CharStreams.fromString(key))));
parser.removeErrorListeners();
parser.addErrorListener(new BaseErrorListener() {
@Override
public void syntaxError(Recognizer recognizer, Object offendingSymbol,
int line, int charPositionInLine, String msg, RecognitionException e) {
throw new IllegalArgumentException(
String.format("Syntax error at line %d:%d %s.", line, charPositionInLine, msg), e);
}
});
TemplateParameterParser.MatcherPatternContext ctx = parser.matcherPattern();
if (ctx.typedPattern() == null) {
String paramName = ctx.parameterName().Identifier().getText();
s = typedPatternByName.get(paramName);
if (s == null) {
throw new IllegalArgumentException("The parameter " + paramName + " must be defined before it is referenced.");
}
} else {
TypedPatternContext typedPattern = ctx.typedPattern();
JavaType type = typedParameter(key, typedPattern);
s = TypeUtils.toString(type);
String name = null;
if (typedPattern.parameterName() != null) {
name = typedPattern.parameterName().Identifier().getText();
typedPatternByName.put(name, s);
}
Markers markers = Markers.build(Collections.singleton(new TemplateParameter(randomId(), type, name)));
parameters.add(new J.Empty(randomId(), Space.EMPTY, markers));
}
} else {
throw new IllegalArgumentException("Only typed placeholders are allowed.");
}
return s;
});
if (previous.equals(substituted)) {
break;
}
}
return parameters.toArray(new J[0]);
}
private static JavaType typedParameter(String key, TypedPatternContext typedPattern) {
String matcherName = typedPattern.patternType().matcherName().Identifier().getText();
if ("any".equals(matcherName)) {
return TypeParameter.toFullyQualifiedName(typedPattern.patternType().type());
} else if ("anyArray".equals(matcherName)) {
return new JavaType.Array(null, TypeParameter.toFullyQualifiedName(typedPattern.patternType().type()), null);
} else {
throw new IllegalArgumentException("Unsupported template matcher '" + key + "'");
}
}
private static TemplateMatchResult matchTemplate(J templateTree, Cursor cursor) {
if (templateTree == cursor.getValue()) {
// When `JavaTemplate#apply()` returns the input itself, it could not be matched
return new TemplateMatchResult(false, Collections.emptyList());
}
JavaTemplateSemanticallyEqualVisitor semanticallyEqualVisitor = new JavaTemplateSemanticallyEqualVisitor();
semanticallyEqualVisitor.visit(templateTree, cursor.getValue(), cursor.getParentOrThrow());
return new TemplateMatchResult(semanticallyEqualVisitor.isEqual(), new ArrayList<>(
semanticallyEqualVisitor.matchedParameters.keySet()));
}
@SuppressWarnings("ConstantConditions")
private static class JavaTemplateSemanticallyEqualVisitor extends SemanticallyEqualVisitor {
final Map matchedParameters = new LinkedHashMap<>();
public JavaTemplateSemanticallyEqualVisitor() {
super(true);
}
private boolean matchTemplateParameterPlaceholder(J.Empty empty, J j) {
if (j instanceof TypedTree) {
if (j instanceof J.Primitive || j instanceof J.Identifier && ((J.Identifier) j).getFieldType() == null) {
// don't match types, only expressions
return false;
}
TemplateParameter marker = (TemplateParameter) empty.getMarkers().getMarkers().get(0);
if (marker.getName() != null) {
for (Map.Entry matchedParameter : matchedParameters.entrySet()) {
if (matchedParameter.getValue().equals(marker.getName())) {
return SemanticallyEqual.areEqual(matchedParameter.getKey(), j);
}
}
}
if (TypeUtils.isObject(marker.getType()) ||
TypeUtils.isAssignableTo(marker.getType(), ((TypedTree) j).getType())) {
registerMatch(j, marker.getName());
return true;
}
}
return false;
}
private void registerMatch(J j, @Nullable String name) {
matchedParameters.put(j, name);
}
@Override
public J.Empty visitEmpty(J.Empty empty, J j) {
if (isEqual.get()) {
if (isTemplateParameterPlaceholder(empty)) {
isEqual.set(matchTemplateParameterPlaceholder(empty, j));
return empty;
}
if (!(j instanceof J.Empty)) {
isEqual.set(false);
return empty;
}
J.Empty compareTo = (J.Empty) j;
if (nullMissMatch(empty.getType(), compareTo.getType())) {
isEqual.set(false);
return empty;
}
}
return empty;
}
private static boolean isTemplateParameterPlaceholder(J.Empty empty) {
Markers markers = empty.getMarkers();
return markers.getMarkers().size() == 1 && markers.getMarkers().get(0) instanceof TemplateParameter;
}
}
}