View Javadoc
1   /*
2    * Copyright (c) 2011-2024 Qulice.com
3    *
4    * All rights reserved.
5    *
6    * Redistribution and use in source and binary forms, with or without
7    * modification, are permitted provided that the following conditions
8    * are met: 1) Redistributions of source code must retain the above
9    * copyright notice, this list of conditions and the following
10   * disclaimer. 2) Redistributions in binary form must reproduce the above
11   * copyright notice, this list of conditions and the following
12   * disclaimer in the documentation and/or other materials provided
13   * with the distribution. 3) Neither the name of the Qulice.com nor
14   * the names of its contributors may be used to endorse or promote
15   * products derived from this software without specific prior written
16   * permission.
17   *
18   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
20   * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
21   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
22   * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
23   * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26   * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
29   * OF THE POSSIBILITY OF SUCH DAMAGE.
30   */
31  package com.qulice.checkstyle;
32  
33  import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
34  import com.puppycrawl.tools.checkstyle.api.DetailAST;
35  import com.puppycrawl.tools.checkstyle.api.TokenTypes;
36  
37  /**
38   * C++ style inline comment is not allowed.
39   * Use //-style comment instead.
40   * @since 0.18
41   */
42  public final class SingleLineCommentCheck extends AbstractCheck {
43      /**
44       * When inside a block comment, holds begin line number.
45       */
46      private int begin;
47  
48      @Override
49      public boolean isCommentNodesRequired() {
50          return true;
51      }
52  
53      @Override
54      public int[] getDefaultTokens() {
55          return new int[]{
56              TokenTypes.BLOCK_COMMENT_BEGIN,
57              TokenTypes.BLOCK_COMMENT_END,
58          };
59      }
60  
61      @Override
62      public int[] getAcceptableTokens() {
63          return this.getDefaultTokens();
64      }
65  
66      @Override
67      public int[] getRequiredTokens() {
68          return this.getDefaultTokens();
69      }
70  
71      @Override
72      public void visitToken(final DetailAST ast) {
73          if (ast.getType() == TokenTypes.BLOCK_COMMENT_BEGIN) {
74              this.begin = ast.getLineNo();
75          } else if (this.begin == ast.getLineNo()) {
76              this.log(ast, "This kind of comment is not allowed.");
77          }
78      }
79  }