/*
* SonarQube Java
* Copyright (C) 2012-2016 SonarSource SA
* mailto:contact AT sonarsource DOT com
*
* This program 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.
*
* This program 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.java.checks;
import org.apache.commons.lang.StringUtils;
import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
import org.sonar.plugins.java.api.tree.SyntaxTrivia;
public class CommentContainsPatternChecker {
private final IssuableSubscriptionVisitor newCheck;
private final String pattern;
private final String message;
public CommentContainsPatternChecker(IssuableSubscriptionVisitor check, String pattern, String message) {
this.newCheck = check;
this.pattern = pattern;
this.message = message;
}
private static boolean isLetterAround(String line, String pattern) {
int start = StringUtils.indexOfIgnoreCase(line, pattern);
int end = start + pattern.length();
boolean pre = start > 0 && Character.isLetter(line.charAt(start - 1));
boolean post = end < line.length() - 1 && Character.isLetter(line.charAt(end));
return pre || post;
}
public void checkTrivia(SyntaxTrivia syntaxTrivia) {
String comment = syntaxTrivia.comment();
if (StringUtils.containsIgnoreCase(comment, pattern)) {
String[] lines = comment.split("\r\n?|\n");
for (int i = 0; i < lines.length; i++) {
if (StringUtils.containsIgnoreCase(lines[i], pattern) && !isLetterAround(lines[i], pattern)) {
newCheck.addIssue(syntaxTrivia.startLine() + i, message);
}
}
}
}
}