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 com.puppycrawl.tools.checkstyle.api.DetailAST;
023    import org.sonar.api.measures.CoreMetrics;
024    import org.sonar.api.measures.FileLinesContext;
025    import org.sonar.plugins.squid.SonarAccessor;
026    import org.sonar.squid.api.SourceFile;
027    import org.sonar.squid.measures.Metric;
028    import org.sonar.squid.text.Source;
029    
030    /**
031     * Saves information about lines directly into Sonar index by using {@link FileLinesContext}.
032     */
033    public class FileLinesVisitor extends JavaAstVisitor {
034    
035      private final SonarAccessor sonarAccessor;
036    
037      /**
038       * Default constructor for case when {@link SonarAccessor} not available.
039       */
040      public FileLinesVisitor() {
041        this.sonarAccessor = null;
042      }
043    
044      public FileLinesVisitor(SonarAccessor sonarAccessor) {
045        this.sonarAccessor = sonarAccessor;
046      }
047    
048      @Override
049      public void visitFile(DetailAST ast) {
050        if (sonarAccessor != null) {
051          processFile();
052        }
053      }
054    
055      private void processFile() {
056        SourceFile file = (SourceFile) peekSourceCode();
057        FileLinesContext measures = sonarAccessor.createFileLinesContext(file);
058    
059        Source source = getSource();
060        for (int line = 1; line <= source.getNumberOfLines(); line++) {
061          int lineOfCode = source.getMeasure(Metric.LINES_OF_CODE, line, line);
062          measures.setIntValue(CoreMetrics.NCLOC_DATA_KEY, line, lineOfCode);
063    
064          int comment = source.getMeasure(Metric.COMMENT_LINES, line, line);
065          measures.setIntValue(CoreMetrics.COMMENT_LINES_DATA_KEY, line, comment);
066        }
067        measures.save();
068      }
069    
070    }