org.sonar.javascript.metrics.FileLinesVisitor Maven / Gradle / Ivy
/*
* Sonar JavaScript Plugin
* Copyright (C) 2011 Eriks Nukis and SonarSource
* [email protected]
*
* 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 02
*/
package org.sonar.javascript.metrics;
import com.google.common.collect.Sets;
import com.sonar.sslr.api.*;
import com.sonar.sslr.squid.SquidAstVisitor;
import org.sonar.api.measures.CoreMetrics;
import org.sonar.api.measures.FileLinesContext;
import org.sonar.api.measures.FileLinesContextFactory;
import org.sonar.api.resources.File;
import org.sonar.api.resources.Project;
import org.sonar.javascript.api.EcmaScriptGrammar;
import org.sonar.javascript.api.EcmaScriptMetric;
import java.util.List;
import java.util.Set;
/**
* Visitor that computes {@link CoreMetrics#NCLOC_DATA_KEY} and {@link CoreMetrics#COMMENT_LINES_DATA_KEY} metrics used by the DevCockpit.
*/
public class FileLinesVisitor extends SquidAstVisitor implements AstAndTokenVisitor {
private final Project project;
private final FileLinesContextFactory fileLinesContextFactory;
private final Set linesOfCode = Sets.newHashSet();
private final Set linesOfComments = Sets.newHashSet();
public FileLinesVisitor(Project project, FileLinesContextFactory fileLinesContextFactory) {
this.project = project;
this.fileLinesContextFactory = fileLinesContextFactory;
}
public void visitToken(Token token) {
if (token.getType().equals(GenericTokenType.EOF)) {
return;
}
linesOfCode.add(token.getLine());
List trivias = token.getTrivia();
for (Trivia trivia : trivias) {
if (trivia.isComment()) {
linesOfComments.add(trivia.getToken().getLine());
}
}
}
@Override
public void leaveFile(AstNode astNode) {
File sonarFile = File.fromIOFile(getContext().getFile(), project);
FileLinesContext fileLinesContext = fileLinesContextFactory.createFor(sonarFile);
int fileLength = getContext().peekSourceCode().getInt(EcmaScriptMetric.LINES);
for (int line = 1; line <= fileLength; line++) {
fileLinesContext.setIntValue(CoreMetrics.NCLOC_DATA_KEY, line, linesOfCode.contains(line) ? 1 : 0);
fileLinesContext.setIntValue(CoreMetrics.COMMENT_LINES_DATA_KEY, line, linesOfComments.contains(line) ? 1 : 0);
}
fileLinesContext.save();
linesOfCode.clear();
linesOfComments.clear();
}
}