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.
/*
* Copyright 2019 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.bugpatterns.javadoc;
import static com.google.errorprone.BugPattern.SeverityLevel.WARNING;
import static com.google.errorprone.BugPattern.StandardTags.STYLE;
import static com.google.errorprone.matchers.Description.NO_MATCH;
import static com.google.errorprone.util.ASTHelpers.getStartPosition;
import static com.google.errorprone.util.ASTHelpers.getSymbol;
import static java.util.stream.Collectors.joining;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Streams;
import com.google.errorprone.BugPattern;
import com.google.errorprone.VisitorState;
import com.google.errorprone.bugpatterns.BugChecker;
import com.google.errorprone.bugpatterns.BugChecker.CompilationUnitTreeMatcher;
import com.google.errorprone.fixes.SuggestedFix;
import com.google.errorprone.matchers.Description;
import com.google.errorprone.util.ASTHelpers;
import com.google.errorprone.util.ErrorProneToken;
import com.google.errorprone.util.ErrorProneTokens;
import com.sun.source.tree.ClassTree;
import com.sun.source.tree.CompilationUnitTree;
import com.sun.source.tree.MethodTree;
import com.sun.source.tree.NewClassTree;
import com.sun.source.tree.Tree;
import com.sun.source.tree.VariableTree;
import com.sun.tools.javac.parser.Tokens.Comment;
import java.util.HashMap;
import java.util.Map;
import java.util.Optional;
import java.util.regex.Pattern;
import javax.lang.model.element.ElementKind;
/**
* Flags comments which appear to be intended to be Javadoc, but are not started with an extra
* {@code *}.
*/
@BugPattern(
name = "AlmostJavadoc",
summary =
"This comment contains Javadoc or HTML tags, but isn't started with a double asterisk"
+ " (/**); is it meant to be Javadoc?",
severity = WARNING,
tags = STYLE,
documentSuppression = false)
public final class AlmostJavadoc extends BugChecker implements CompilationUnitTreeMatcher {
private static final Pattern HAS_TAG =
Pattern.compile(
String.format(
"<\\w+>|@(%s)",
Streams.concat(
JavadocTag.VALID_CLASS_TAGS.stream(),
JavadocTag.VALID_METHOD_TAGS.stream(),
JavadocTag.VALID_VARIABLE_TAGS.stream())
.map(JavadocTag::name)
.map(Pattern::quote)
.distinct()
.collect(joining("|"))));
@Override
public Description matchCompilationUnit(CompilationUnitTree tree, VisitorState state) {
ImmutableMap javadocableTrees = getJavadocableTrees(tree, state);
for (ErrorProneToken token :
ErrorProneTokens.getTokens(state.getSourceCode().toString(), state.context)) {
for (Comment comment : token.comments()) {
if (!javadocableTrees.containsKey(token.pos())) {
continue;
}
generateFix(comment)
.ifPresent(
fix -> state.reportMatch(describeMatch(javadocableTrees.get(token.pos()), fix)));
}
}
return NO_MATCH;
}
private static Optional generateFix(Comment comment) {
String text = comment.getText();
if (text.startsWith("/*") && !text.startsWith("/**")) {
if (HAS_TAG.matcher(text).find()) {
int pos = comment.getSourcePos(1);
return Optional.of(SuggestedFix.replace(pos, pos, "*"));
}
}
if (text.startsWith("//") && text.endsWith("*/")) {
if (text.startsWith("// /**")) {
return Optional.of(
SuggestedFix.replace(comment.getSourcePos(0), comment.getSourcePos(2), ""));
}
int endReplacement = 2;
while (endReplacement < text.length()) {
char c = text.charAt(endReplacement);
if (c == '/') {
return Optional.empty();
}
if (c != '*' && c != ' ') {
break;
}
++endReplacement;
}
return Optional.of(
SuggestedFix.replace(
comment.getSourcePos(1), comment.getSourcePos(endReplacement), "**"));
}
return Optional.empty();
}
private ImmutableMap getJavadocableTrees(
CompilationUnitTree tree, VisitorState state) {
Map javadoccablePositions = new HashMap<>();
new SuppressibleTreePathScanner() {
@Override
public Void visitClass(ClassTree classTree, Void unused) {
if (!shouldMatch()) {
return null;
}
javadoccablePositions.put(startPos(classTree), classTree);
return super.visitClass(classTree, null);
}
@Override
public Void visitMethod(MethodTree methodTree, Void unused) {
if (!shouldMatch()) {
return null;
}
if (!ASTHelpers.isGeneratedConstructor(methodTree)) {
javadoccablePositions.put(startPos(methodTree), methodTree);
}
return super.visitMethod(methodTree, null);
}
@Override
public Void visitVariable(VariableTree variableTree, Void unused) {
if (!shouldMatch()) {
return null;
}
ElementKind kind = getSymbol(variableTree).getKind();
if (kind == ElementKind.FIELD) {
javadoccablePositions.put(startPos(variableTree), variableTree);
}
// For enum constants, skip past the desugared class declaration.
if (kind == ElementKind.ENUM_CONSTANT) {
javadoccablePositions.put(startPos(variableTree), variableTree);
if (variableTree.getInitializer() instanceof NewClassTree) {
ClassTree classBody = ((NewClassTree) variableTree.getInitializer()).getClassBody();
if (classBody != null) {
scan(classBody.getMembers(), null);
}
return null;
}
}
return super.visitVariable(variableTree, null);
}
private boolean shouldMatch() {
// Check there isn't already a Javadoc for the element under question, otherwise we might
// suggest double Javadoc.
return Utils.getDocTreePath(state.withPath(getCurrentPath())) == null;
}
private int startPos(Tree tree) {
return getStartPosition(tree);
}
}.scan(tree, null);
return ImmutableMap.copyOf(javadoccablePositions);
}
}
