001    /*
002     * Sonar, open source software quality management tool.
003     * Copyright (C) 2008-2012 SonarSource
004     * mailto:contact AT sonarsource DOT com
005     *
006     * Sonar is free software; you can redistribute it and/or
007     * modify it under the terms of the GNU Lesser General Public
008     * License as published by the Free Software Foundation; either
009     * version 3 of the License, or (at your option) any later version.
010     *
011     * Sonar is distributed in the hope that it will be useful,
012     * but WITHOUT ANY WARRANTY; without even the implied warranty of
013     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014     * Lesser General Public License for more details.
015     *
016     * You should have received a copy of the GNU Lesser General Public
017     * License along with Sonar; if not, write to the Free Software
018     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
019     */
020    package org.sonar.java.ast.visitor;
021    
022    import java.util.Arrays;
023    import java.util.List;
024    
025    import org.sonar.squid.api.SourceFile;
026    import org.sonar.squid.measures.Metric;
027    
028    import com.puppycrawl.tools.checkstyle.api.DetailAST;
029    import com.puppycrawl.tools.checkstyle.api.TokenTypes;
030    
031    /**
032     * SONAR-3093: Note that this visitor saves {@link Metric#COMMENT_LINES} into {@link org.sonar.squid.api.SourceCode}
033     * as sum of {@link Metric#COMMENT_LINES} and {@link Metric#COMMENTED_OUT_CODE_LINES} from {@link org.sonar.squid.test.Source}.
034     */
035    public class CommentVisitor extends JavaAstVisitor {
036    
037      private static final List<Integer> WANTED_TOKENS = Arrays.asList(TokenTypes.RCURLY);
038    
039      @Override
040      public List<Integer> getWantedTokens() {
041        return WANTED_TOKENS;
042      }
043    
044      @Override
045      public void visitToken(DetailAST ast) {
046        int startAtLine = peekSourceCode().getStartAtLine();
047        int endAtLine = peekSourceCode().getEndAtLine();
048        int commentedOutCodeLines = getSource().getMeasure(Metric.COMMENTED_OUT_CODE_LINES, startAtLine, endAtLine);
049        int commentLines = getSource().getMeasure(Metric.COMMENT_LINES, startAtLine, endAtLine);
050        peekSourceCode().setMeasure(Metric.COMMENTED_OUT_CODE_LINES, commentedOutCodeLines);
051        peekSourceCode().setMeasure(Metric.COMMENT_LINES, commentLines + commentedOutCodeLines);
052        peekSourceCode().setMeasure(Metric.COMMENT_BLANK_LINES, getSource().getMeasure(Metric.COMMENT_BLANK_LINES, startAtLine, endAtLine));
053      }
054    
055      @Override
056      public void visitFile(DetailAST ast) {
057        SourceFile file = (SourceFile) peekSourceCode();
058        file.addNoSonarTagLines(getSource().getNoSonarTagLines());
059        file.setMeasure(Metric.HEADER_COMMENT_LINES, getSource().getMeasure(Metric.HEADER_COMMENT_LINES));
060        int commentedOutCodeLines = getSource().getMeasure(Metric.COMMENTED_OUT_CODE_LINES);
061        int commentLines = getSource().getMeasure(Metric.COMMENT_LINES);
062        file.setMeasure(Metric.COMMENTED_OUT_CODE_LINES, commentedOutCodeLines);
063        file.setMeasure(Metric.COMMENT_LINES, commentLines + commentedOutCodeLines);
064        file.setMeasure(Metric.COMMENT_BLANK_LINES, getSource().getMeasure(Metric.COMMENT_BLANK_LINES));
065      }
066    
067    }