org.sonar.squidbridge.checks.AbstractSingleLineCommentsSyntaxCheck.java Source code

Introduction

Here is the source code for org.sonar.squidbridge.checks.AbstractSingleLineCommentsSyntaxCheck.java

Source

/*
 * SSLR Squid Bridge
 * Copyright (C) 2010-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.squidbridge.checks;

import com.sonar.sslr.api.AstAndTokenVisitor;
import com.sonar.sslr.api.Grammar;
import com.sonar.sslr.api.Token;
import com.sonar.sslr.api.Trivia;
import org.apache.commons.lang.StringUtils;

public abstract class AbstractSingleLineCommentsSyntaxCheck<G extends Grammar> extends SquidCheck<G>
        implements AstAndTokenVisitor {

    public abstract String getSingleLineCommentSyntaxPrefix();

    @Override
    public void visitToken(Token token) {
        for (Trivia trivia : token.getTrivia()) {
            if (trivia.isComment() && trivia.getToken().getLine() < token.getLine()) {
                String comment = trivia.getToken().getOriginalValue();

                if (!comment.startsWith(getSingleLineCommentSyntaxPrefix())
                        && !StringUtils.containsAny(comment, "\r\n")) {
                    getContext().createLineViolation(this,
                            "This single line comment should use the single line comment syntax \"{0}\"",
                            trivia.getToken(), getSingleLineCommentSyntaxPrefix());
                }
            }
        }
    }

}