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.squid.ast.visitor;
021    
022    import java.util.Arrays;
023    import java.util.List;
024    
025    import org.sonar.squid.api.SourceCode;
026    import org.sonar.squid.measures.Metric;
027    
028    import com.puppycrawl.tools.checkstyle.api.DetailAST;
029    import com.puppycrawl.tools.checkstyle.api.Scope;
030    import com.puppycrawl.tools.checkstyle.api.TokenTypes;
031    
032    public class PublicApiVisitor extends AstVisitor {
033    
034      private static final List<Integer> wantedTokens = Arrays.asList(TokenTypes.CLASS_DEF, TokenTypes.INTERFACE_DEF, TokenTypes.METHOD_DEF,
035                                                          TokenTypes.CTOR_DEF, TokenTypes.ANNOTATION_DEF, TokenTypes.ANNOTATION_FIELD_DEF,
036                                                          TokenTypes.VARIABLE_DEF);
037    
038      public PublicApiVisitor() {
039      }
040    
041      @Override
042      public List<Integer> getWantedTokens() {
043        return wantedTokens;
044      }
045    
046      @Override
047      public void visitToken(DetailAST ast) {
048        SourceCode currentResource = peekResource();
049        if (AstUtils.isScope(AstUtils.getScope(ast), Scope.PUBLIC) || AstUtils.isType(ast, TokenTypes.ANNOTATION_FIELD_DEF)) {
050          // final static vars are not part of public API
051          // to avoid noise on public constants class or interfaces
052          if ((AstUtils.isClassVariable(ast) || AstUtils.isInterfaceVariable(ast)) && AstUtils.isFinal(ast) && AstUtils.isStatic(ast)) {
053            return;
054          }
055          currentResource.add(Metric.PUBLIC_API, 1);
056          boolean isDocumented = getFileContents().getJavadocBefore(ast.getLineNo()) != null;
057          if (isDocumented) {
058            currentResource.add(Metric.PUBLIC_DOC_API, 1);
059          }
060        }
061      }
062    }