aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-squid/src/main/java/org/sonar/squid/text/MultiLinesCommentHandler.java
blob: 7f5e026e4cec2f4a4ff013104f01f6b1d97d8861 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2014 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * SonarQube is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

package org.sonar.squid.text;

public class MultiLinesCommentHandler extends LineContextHandler {

  private StringBuilder currentLineComment;
  private boolean isFirstLineOfComment = false;

  private boolean isJavadoc = false;
  private boolean isLicenseHeader = false;

  private boolean commentStarted = false;

  private static final String START_COMMENT_TAG = "/*";
  private static final String START_JAVADOC_TAG = "/**";
  private static final String START_GWT_NATIVE_CODE_TAG = "/*-{";
  private static final String END_COMMENT_TAG = "*/";

  @Override
  boolean matchToEnd(Line line, StringBuilder pendingLine) {
    if ( !commentStarted) {
      throw new IllegalStateException("Method doContextBegin(StringBuilder pendingLine) has not been called first (line = '" + pendingLine
          + "').");
    }
    currentLineComment.append(getLastCharacter(pendingLine));
    if (isJavaDoc()) {
      isJavadoc = true;
    }
    if (isGwtNativeCode()) {
      initProperties();
      return true;
    }
    boolean match = matchEndOfString(pendingLine, END_COMMENT_TAG);
    if (match && !(isFirstLineOfComment && pendingLine.indexOf(START_COMMENT_TAG) + 1 == pendingLine.indexOf(END_COMMENT_TAG))) {
      endOfCommentLine(line);
      initProperties();
      return true;
    }
    return false;
  }

  private boolean isGwtNativeCode() {
    return isFirstLineOfComment && currentLineComment.length() == START_GWT_NATIVE_CODE_TAG.length()
        && currentLineComment.toString().equals(START_GWT_NATIVE_CODE_TAG);
  }

  private boolean isJavaDoc() {
    return isFirstLineOfComment && currentLineComment.length() == START_JAVADOC_TAG.length()
        && currentLineComment.toString().equals(START_JAVADOC_TAG);
  }

  @Override
  boolean matchToBegin(Line line, StringBuilder pendingLine) {
    boolean match = matchEndOfString(pendingLine, START_COMMENT_TAG);
    if (match) {
      isFirstLineOfComment = true;
      commentStarted = true;
      currentLineComment = new StringBuilder(START_COMMENT_TAG);
      isLicenseHeader = (line.getLineIndex() == 1);
    }
    return match;
  }

  @Override
  boolean matchWithEndOfLine(Line line, StringBuilder pendingLine) {
    endOfCommentLine(line);
    return false;
  }

  private void endOfCommentLine(Line line) {
    line.setComment(currentLineComment.toString(), isJavadoc, isLicenseHeader);
    currentLineComment = new StringBuilder();
    isFirstLineOfComment = false;
  }

  private void initProperties() {
    commentStarted = false;
    isJavadoc = false;
    isLicenseHeader = false;
    currentLineComment = new StringBuilder();
    isFirstLineOfComment = false;
  }
}