Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.google.errorprone.refaster.BlockTemplate Maven / Gradle / Ivy
/*
* Copyright 2013 The Error Prone 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
*
* http://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 com.google.errorprone.refaster;
import static com.google.common.base.Preconditions.checkNotNull;
import static java.util.logging.Level.SEVERE;
import com.google.auto.value.AutoValue;
import com.google.common.base.CharMatcher;
import com.google.common.base.Optional;
import com.google.common.collect.ImmutableClassToInstanceMap;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.errorprone.fixes.Fix;
import com.google.errorprone.fixes.SuggestedFix;
import com.google.errorprone.refaster.UStatement.UnifierWithUnconsumedStatements;
import com.google.errorprone.refaster.annotation.UseImportPolicy;
import com.sun.source.tree.StatementTree;
import com.sun.tools.javac.tree.JCTree;
import com.sun.tools.javac.tree.JCTree.JCBlock;
import com.sun.tools.javac.tree.JCTree.JCStatement;
import com.sun.tools.javac.util.Context;
import com.sun.tools.javac.util.List;
import com.sun.tools.javac.util.Warner;
import java.io.IOException;
import java.io.StringWriter;
import java.lang.annotation.Annotation;
import java.util.Map;
import java.util.logging.Logger;
/**
* Template representing a sequence of consecutive statements.
*
* @author [email protected] (Louis Wasserman)
*/
@AutoValue
public abstract class BlockTemplate extends Template {
private static final Logger logger = Logger.getLogger(BlockTemplate.class.toString());
public static BlockTemplate create(UStatement... templateStatements) {
return create(ImmutableMap.of(), templateStatements);
}
public static BlockTemplate create(
Map expressionArgumentTypes, UStatement... templateStatements) {
return create(ImmutableList.of(), expressionArgumentTypes, templateStatements);
}
public static BlockTemplate create(
Iterable typeVariables,
Map expressionArgumentTypes,
UStatement... templateStatements) {
return create(
ImmutableClassToInstanceMap.of(),
typeVariables,
expressionArgumentTypes,
ImmutableList.copyOf(templateStatements));
}
public static BlockTemplate create(
ImmutableClassToInstanceMap annotations,
Iterable typeVariables,
Map expressionArgumentTypes,
Iterable templateStatements) {
return new AutoValue_BlockTemplate(
annotations,
ImmutableList.copyOf(typeVariables),
ImmutableMap.copyOf(expressionArgumentTypes),
ImmutableList.copyOf(templateStatements));
}
public BlockTemplate withStatements(Iterable templateStatements) {
return create(
annotations(), templateTypeVariables(), expressionArgumentTypes(), templateStatements);
}
abstract ImmutableList templateStatements();
/**
* If the tree is a {@link JCBlock}, returns a list of disjoint matches corresponding to the exact
* list of template statements found consecutively; otherwise, returns an empty list.
*/
@Override
public Iterable match(JCTree tree, Context context) {
// TODO(lowasser): consider nonconsecutive matches?
if (tree instanceof JCBlock) {
JCBlock block = (JCBlock) tree;
ImmutableList targetStatements = ImmutableList.copyOf(block.getStatements());
return matchesStartingAnywhere(block, 0, targetStatements, context)
.first()
.or(List.nil());
}
return ImmutableList.of();
}
private Choice> matchesStartingAtBeginning(
final JCBlock block,
final int offset,
final ImmutableList statements,
final Context context) {
if (statements.isEmpty()) {
return Choice.none();
}
final JCStatement firstStatement = (JCStatement) statements.get(0);
Choice choice =
Choice.of(UnifierWithUnconsumedStatements.create(new Unifier(context), statements));
for (UStatement templateStatement : templateStatements()) {
choice = choice.thenChoose(templateStatement);
}
return choice.thenChoose(
(UnifierWithUnconsumedStatements state) -> {
Unifier unifier = state.unifier();
Inliner inliner = unifier.createInliner();
try {
Optional checkedUnifier =
typecheck(
unifier,
inliner,
new Warner(firstStatement),
expectedTypes(inliner),
actualTypes(inliner));
if (checkedUnifier.isPresent()) {
int consumedStatements = statements.size() - state.unconsumedStatements().size();
BlockTemplateMatch match =
new BlockTemplateMatch(
block, checkedUnifier.get(), offset, offset + consumedStatements);
boolean verified =
ExpressionTemplate.trueOrNull(
ExpressionTemplate.PLACEHOLDER_VERIFIER.scan(
templateStatements(), checkedUnifier.get()));
if (!verified) {
return Choice.none();
}
return matchesStartingAnywhere(
block,
offset + consumedStatements,
statements.subList(consumedStatements, statements.size()),
context)
.transform(list -> list.prepend(match));
}
} catch (CouldNotResolveImportException e) {
// fall through
}
return Choice.none();
});
}
private Choice> matchesStartingAnywhere(
JCBlock block,
int offset,
final ImmutableList statements,
final Context context) {
Choice> choice = Choice.none();
for (int i = 0; i < statements.size(); i++) {
choice =
choice.or(
matchesStartingAtBeginning(
block, offset + i, statements.subList(i, statements.size()), context));
}
return choice.or(Choice.of(List.nil()));
}
/** Returns a {@code String} representation of a statement, including semicolon. */
private static String printStatement(Context context, JCStatement statement) {
StringWriter writer = new StringWriter();
try {
pretty(context, writer).printStat(statement);
} catch (IOException e) {
throw new AssertionError("StringWriter cannot throw IOExceptions", e);
}
return writer.toString();
}
/**
* Returns a {@code String} representation of a sequence of statements, with semicolons and
* newlines.
*/
private static String printStatements(Context context, Iterable statements) {
StringWriter writer = new StringWriter();
try {
pretty(context, writer).printStats(com.sun.tools.javac.util.List.from(statements));
} catch (IOException e) {
throw new AssertionError("StringWriter cannot throw IOExceptions", e);
}
return writer.toString();
}
@Override
public Fix replace(BlockTemplateMatch match) {
checkNotNull(match);
SuggestedFix.Builder fix = SuggestedFix.builder();
Inliner inliner = match.createInliner();
Context context = inliner.getContext();
if (annotations().containsKey(UseImportPolicy.class)) {
ImportPolicy.bind(context, annotations().getInstance(UseImportPolicy.class).value());
} else {
ImportPolicy.bind(context, ImportPolicy.IMPORT_TOP_LEVEL);
}
ImmutableList targetStatements = match.getStatements();
try {
ImmutableList.Builder inlinedStatementsBuilder = ImmutableList.builder();
for (UStatement statement : templateStatements()) {
inlinedStatementsBuilder.addAll(statement.inlineStatements(inliner));
}
ImmutableList inlinedStatements = inlinedStatementsBuilder.build();
int nInlined = inlinedStatements.size();
int nTargets = targetStatements.size();
if (nInlined <= nTargets) {
for (int i = 0; i < nInlined; i++) {
fix.replace(targetStatements.get(i), printStatement(context, inlinedStatements.get(i)));
}
for (int i = nInlined; i < nTargets; i++) {
fix.delete(targetStatements.get(i));
}
} else {
for (int i = 0; i < nTargets - 1; i++) {
fix.replace(targetStatements.get(i), printStatement(context, inlinedStatements.get(i)));
}
int last = nTargets - 1;
ImmutableList remainingInlined = inlinedStatements.subList(last, nInlined);
fix.replace(
targetStatements.get(last),
CharMatcher.whitespace().trimTrailingFrom(printStatements(context, remainingInlined)));
}
} catch (CouldNotResolveImportException e) {
logger.log(SEVERE, "Failure to resolve import in replacement", e);
}
return addImports(inliner, fix);
}
}
