1
2
3
4
5 package com.qulice.checkstyle;
6
7 import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
8 import com.puppycrawl.tools.checkstyle.api.DetailAST;
9 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
10 import java.util.regex.Matcher;
11 import java.util.regex.Pattern;
12
13
14
15
16
17
18 public final class SingleLineCommentCheck extends AbstractCheck {
19
20
21
22
23
24 private Pattern format = Pattern.compile("^$");
25
26
27
28
29
30 private String message = "";
31
32
33
34
35
36
37 @SuppressWarnings("PMD.AvoidStringBufferField")
38 private StringBuilder line;
39
40
41
42
43 private int begin;
44
45 @Override
46 public boolean isCommentNodesRequired() {
47 return true;
48 }
49
50 @Override
51 public int[] getDefaultTokens() {
52 return new int[]{
53 TokenTypes.BLOCK_COMMENT_BEGIN,
54 TokenTypes.COMMENT_CONTENT,
55 TokenTypes.BLOCK_COMMENT_END,
56 };
57 }
58
59 @Override
60 public int[] getAcceptableTokens() {
61 return this.getDefaultTokens();
62 }
63
64 @Override
65 public int[] getRequiredTokens() {
66 return this.getDefaultTokens();
67 }
68
69 @Override
70 public void visitToken(final DetailAST ast) {
71 if (ast.getType() == TokenTypes.BLOCK_COMMENT_BEGIN) {
72 this.line = new StringBuilder(ast.getText());
73 this.begin = ast.getLineNo();
74 } else if (ast.getType() == TokenTypes.COMMENT_CONTENT) {
75 this.line.append(ast.getText());
76 } else {
77 this.line.append(ast.getText());
78 final Matcher matcher = this.format.matcher(this.line.toString());
79 if (matcher.matches() && this.singleLineCStyleComment(ast)) {
80 this.log(ast, this.message);
81 }
82 }
83 }
84
85
86
87
88
89
90
91
92
93 public void setFormat(final String fmt) {
94 this.format = Pattern.compile(fmt);
95 }
96
97
98
99
100
101
102
103
104
105
106 public void setMessage(final String msg) {
107 this.message = msg;
108 }
109
110
111
112
113
114
115
116 private boolean singleLineCStyleComment(final DetailAST ast) {
117 return ast.getType() == TokenTypes.BLOCK_COMMENT_END && this.begin == ast.getLineNo();
118 }
119 }