phoedos/pmd
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Cleanups, rename FormalComment to JavadocComment

Browse Source
This commit is contained in:
Clément Fournier
2021-12-22 20:04:03 +01:00
parent 22a6f0d577
commit 4e9d451412
8 changed files with 22 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
pmd-java/etc/grammar/Java.jjt
View File

@ -602,7 +602,7 @@ MORE :
<IN_FORMAL_COMMENT>
SPECIAL_TOKEN :
{
<FORMAL_COMMENT: "*/" > { comments.add(new FormalComment(matchedToken)); } : DEFAULT
<FORMAL_COMMENT: "*/" > { comments.add(new JavadocComment(matchedToken)); } : DEFAULT
}
<IN_MULTI_LINE_COMMENT>

3
pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/Comment.java
View File

@ -18,6 +18,9 @@ import net.sourceforge.pmd.util.document.Reportable;
* Wraps a comment token to provide some utilities.
* This is not a node, it's not part of the tree anywhere,
* just convenient.
*
* <p>This class represents any kind of comment. A specialized subclass
* provides more API for Javadoc comments, see {@link JavadocComment}.
*/
public class Comment implements Reportable {
//TODO maybe move part of this into pmd core

11
pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/CommentAssignmentPass.java
View File

@ -19,18 +19,19 @@ import net.sourceforge.pmd.util.document.FileLocation;
final class CommentAssignmentPass {
private static final SimpleDataKey<FormalComment> FORMAL_COMMENT_KEY = DataMap.simpleDataKey("java.comment");
private static final SimpleDataKey<JavadocComment> FORMAL_COMMENT_KEY = DataMap.simpleDataKey("java.comment");
private CommentAssignmentPass() {
// utility class
}
static @Nullable FormalComment getComment(JavadocCommentOwner commentOwner) {
static @Nullable JavadocComment getComment(JavadocCommentOwner commentOwner) {
return commentOwner.getUserMap().get(CommentAssignmentPass.FORMAL_COMMENT_KEY);
}
private static void setComment(JavadocCommentOwner commentableNode, FormalComment comment) {
private static void setComment(JavadocCommentOwner commentableNode, JavadocComment comment) {
commentableNode.getUserMap().set(FORMAL_COMMENT_KEY, comment);
comment.setOwner(commentableNode);
}
public static void assignCommentsToDeclarations(ASTCompilationUnit root) {
@ -45,11 +46,11 @@ final class CommentAssignmentPass {
for (JavaccToken maybeComment : GenericToken.previousSpecials(firstToken)) {
if (maybeComment.kind == JavaTokenKinds.FORMAL_COMMENT) {
FormalComment comment = new FormalComment(maybeComment);
JavadocComment comment = new JavadocComment(maybeComment);
// deduplicate the comment
int idx = Collections.binarySearch(comments, comment, Comparator.comparing(Comment::getReportLocation, FileLocation.COORDS_COMPARATOR));
assert idx >= 0 : "Formal comment not found? " + comment;
comment = (FormalComment) comments.get(idx);
comment = (JavadocComment) comments.get(idx);
setComment(commentableNode, comment);
continue outer;

10
pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/FormalComment.java → pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/JavadocComment.java
View File

@ -9,13 +9,13 @@ import org.checkerframework.checker.nullness.qual.Nullable;
import net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken;
/**
* A wrapper for Javadoc {@link Comment}s.
* A {@link Comment} that has Javadoc content.
*/
public class FormalComment extends Comment {
public final class JavadocComment extends Comment {
private JavadocCommentOwner owner;
public FormalComment(JavaccToken t) {
JavadocComment(JavaccToken t) {
super(t);
assert t.kind == JavaTokenKinds.FORMAL_COMMENT;
}
@ -24,6 +24,10 @@ public class FormalComment extends Comment {
this.owner = owner;
}
/**
* Returns the owner of this comment. Null if this comment is
* misplaced.
*/
public @Nullable JavadocCommentOwner getOwner() {
return owner;
}

2
pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/JavadocCommentOwner.java
View File

@ -16,7 +16,7 @@ public interface JavadocCommentOwner extends JavaNode {
* Returns the javadoc comment that applies to this declaration. If
* there is none, returns null.
*/
default @Nullable FormalComment getJavadocComment() {
default @Nullable JavadocComment getJavadocComment() {
return CommentAssignmentPass.getComment(this);
}

4
pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/codestyle/UnnecessaryImportRule.java
View File

@ -23,8 +23,8 @@ import net.sourceforge.pmd.lang.java.ast.ASTPrimaryExpression;
import net.sourceforge.pmd.lang.java.ast.ASTPrimaryPrefix;
import net.sourceforge.pmd.lang.java.ast.ASTPrimarySuffix;
import net.sourceforge.pmd.lang.java.ast.Comment;
import net.sourceforge.pmd.lang.java.ast.FormalComment;
import net.sourceforge.pmd.lang.java.ast.JavaNode;
import net.sourceforge.pmd.lang.java.ast.JavadocComment;
import net.sourceforge.pmd.lang.java.ast.TypeNode;
import net.sourceforge.pmd.lang.java.ast.internal.ImportWrapper;
import net.sourceforge.pmd.lang.java.ast.internal.PrettyPrintingUtil;
@ -97,7 +97,7 @@ public class UnnecessaryImportRule extends AbstractJavaRule {
return;
}
for (Comment comment : node.getComments()) {
if (!(comment instanceof FormalComment)) {
if (!(comment instanceof JavadocComment)) {
continue;
}
for (Pattern p : PATTERNS) {

2
pmd-java/src/test/java/net/sourceforge/pmd/lang/java/ast/CommentAssignmentTest.java
View File

@ -39,7 +39,7 @@ public class CommentAssignmentTest extends BaseNonParserTest {
comment = node.getComments().get(1);
assertFalse(comment.isSingleLine());
assertTrue(comment.hasJavadocContent());
assertThat(comment, instanceOf(FormalComment.class));
assertThat(comment, instanceOf(JavadocComment.class));
assertEquals("a formal comment with blank lines", StringUtils.join(comment.filteredLines(), ' '));
}

2
pmd-java/src/test/java/net/sourceforge/pmd/lang/java/ast/ParserCornersTest.java
View File

@ -40,7 +40,7 @@ public class ParserCornersTest extends BaseJavaTreeDumpTest {
@Test
public void testInvalidUnicodeEscape() {
expect.expect(MalformedSourceException.class); // previously Error
expect.expectMessage("Source format error in file x/filename.java at line 1, column 1: Invalid unicode escape");
expect.expectMessage("Source format error in file 'x/filename.java' at line 1, column 1: Invalid unicode escape");
java.parse("\\u00k0", null, "x/filename.java");
}