001 /*
002 * Sonar, open source software quality management tool.
003 * Copyright (C) 2009 SonarSource SA
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;
021
022 import java.util.List;
023 import java.util.SortedSet;
024 import java.util.TreeSet;
025
026 import org.slf4j.Logger;
027 import org.slf4j.LoggerFactory;
028 import org.sonar.java.ast.visitor.AstVisitor;
029 import org.sonar.java.recognizer.JavaFootprint;
030 import org.sonar.squid.api.SquidConfiguration;
031 import org.sonar.squid.recognizer.CodeRecognizer;
032 import org.sonar.squid.text.Source;
033
034 import com.puppycrawl.tools.checkstyle.api.Check;
035 import com.puppycrawl.tools.checkstyle.api.DetailAST;
036
037 public class CheckstyleSquidBridge extends Check {
038
039 private static Logger logger = LoggerFactory.getLogger(CheckstyleSquidBridge.class);
040 private static AstVisitor[] visitors;
041 private static int[] allTokens;
042 private static CodeRecognizer codeRecognizer;
043
044 static void setASTVisitors(List<AstVisitor> visitors) {
045 CheckstyleSquidBridge.visitors = visitors.toArray(new AstVisitor[visitors.size()]);
046 SortedSet<Integer> sorter = new TreeSet<Integer>();
047 for (AstVisitor visitor : visitors) {
048 sorter.addAll(visitor.getWantedTokens());
049 allTokens = new int[sorter.size()];
050 int i = 0;
051 for (Integer itSorted : sorter) {
052 allTokens[i++] = itSorted;
053 }
054 }
055 }
056
057 static void setSquidConfiguration(SquidConfiguration conf) {
058 codeRecognizer = new CodeRecognizer(conf.getCommentedCodeThreshold(), new JavaFootprint());
059 }
060
061 @Override
062 public int[] getDefaultTokens() {
063 return allTokens;
064 }
065
066 @Override
067 public void beginTree(DetailAST ast) {
068 try {
069 Source source = createSource();
070 for (AstVisitor visitor : visitors) {
071 visitor.setFileContents(getFileContents());
072 visitor.setSource(source);
073 visitor.visitFile(ast);
074 }
075 } catch (RuntimeException e) {
076 logAndThrowException(e);
077 }
078 }
079
080 private Source createSource() {
081 return new Source(getFileContents().getLines(), codeRecognizer);
082 }
083
084 @Override
085 public void visitToken(DetailAST ast) {
086 try {
087 for (AstVisitor visitor : visitors) {
088 if (visitor.getWantedTokens().contains(ast.getType())) {
089 visitor.visitToken(ast);
090 }
091 }
092 } catch (RuntimeException e) {
093 logAndThrowException(e);
094 }
095 }
096
097 @Override
098 public void leaveToken(DetailAST ast) {
099 try {
100 for (int i = visitors.length - 1; i >= 0; i--) {
101 AstVisitor visitor = visitors[i];
102 if (visitor.getWantedTokens().contains(ast.getType())) {
103 visitor.leaveToken(ast);
104 }
105 }
106 } catch (RuntimeException e) {
107 logAndThrowException(e);
108 }
109 }
110
111 @Override
112 public void finishTree(DetailAST ast) {
113 try {
114 for (int i = visitors.length - 1; i >= 0; i--) {
115 AstVisitor visitor = visitors[i];
116 visitor.leaveFile(ast);
117 }
118 } catch (RuntimeException e) {
119 logAndThrowException(e);
120 }
121 }
122
123 private void logAndThrowException(RuntimeException e) {
124 logger.error("Squid Error occurs when analysing :" + getFileContents().getFilename(), e);
125 throw e;
126 }
127
128 }