View Javadoc

    1   /*
    2    $Id: SummaryCollector.java 3626 2006-02-20 15:16:17Z jez $
    3
    4    Copyright 2005 (C) Jeremy Rayner. All Rights Reserved.
    5
    6    Redistribution and use of this software and associated documentation
    7    ("Software"), with or without modification, are permitted provided
    8    that the following conditions are met:
    9
    10   1. Redistributions of source code must retain copyright
    11      statements and notices.  Redistributions must also contain a
    12      copy of this document.
    13
    14   2. Redistributions in binary form must reproduce the
    15      above copyright notice, this list of conditions and the
    16      following disclaimer in the documentation and/or other
    17      materials provided with the distribution.
    18
    19   3. The name "groovy" must not be used to endorse or promote
    20      products derived from this Software without prior written
    21      permission of The Codehaus.  For written permission,
    22      please contact info@codehaus.org.
    23
    24   4. Products derived from this Software may not be called "groovy"
    25      nor may "groovy" appear in their names without prior written
    26      permission of The Codehaus. "groovy" is a registered
    27      trademark of The Codehaus.
    28
    29   5. Due credit should be given to The Codehaus -
    30      http://groovy.codehaus.org/
    31
    32   THIS SOFTWARE IS PROVIDED BY THE CODEHAUS AND CONTRIBUTORS
    33   ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
    34   NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
    35   FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
    36   THE CODEHAUS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
    37   INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
    38   (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
    39   SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    40   HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
    41   STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    42   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
    43   OF THE POSSIBILITY OF SUCH DAMAGE.
    44
    45   */
    46  package org.codehaus.groovy.antlr.treewalker;
    47
    48  import org.codehaus.groovy.antlr.GroovySourceAST;
    49  import org.codehaus.groovy.antlr.AntlrSourceSummary;
    50  import org.codehaus.groovy.antlr.syntax.AntlrClassSource;
    51  import org.codehaus.groovy.antlr.parser.GroovyTokenTypes;
    52  import org.codehaus.groovy.syntax.ClassSource;
    53  import org.codehaus.groovy.syntax.SourceSummary;
    54
    55  import java.util.Stack;
    56
    57  /***
    58   * A visitor for the antlr ast that creates a summary of the parsed source unit
    59   *
    60   * @author Jeremy Rayner
    61   */
    62  public class SummaryCollector extends VisitorAdapter {
    63      private SourceSummary sourceSummary;
    64      private Stack stack;
    65
    66      public SourceSummary getSourceSummary() {
    67          return sourceSummary;
    68      }
    69
    70      public SummaryCollector() {
    71          sourceSummary = new AntlrSourceSummary();
    72          stack = new Stack();
    73      }
    74
    75      public void setUp() {
    76      }
    77
    78      public void visitClassDef(GroovySourceAST t, int visit) {
    79          if (visit == OPENING_VISIT) {
    80              ClassSource classSource = new AntlrClassSource(
    81                      t.childOfType(GroovyTokenTypes.IDENT).getText(),t
    82              );
    83              // Here we assume that the optional restrictions (JLS$7.6)
    84              // on compilation units in file-based implementations apply
    85              // http://java.sun.com/docs/books/jls/second_edition/html/packages.doc.html#26783
    86              GroovySourceAST modifiers = t.childOfType(GroovyTokenTypes.MODIFIERS);
    87
    88              if (isPublic(modifiers)) {
    89                  sourceSummary.addPublic(classSource);
    90              }
    91          }
    92      }
    93
    94      /* figue out if this modifier node represents a public entity */
    95      private boolean isPublic(GroovySourceAST modifiers) {
    96          boolean isPublic = true;
    97          if (modifiers != null) {
    98              GroovySourceAST modprot = modifiers.childOfType(GroovyTokenTypes.LITERAL_protected);
    99              GroovySourceAST modpriv = modifiers.childOfType(GroovyTokenTypes.LITERAL_private);
    100             if (modpriv != null || modprot != null) {
    101                 isPublic = false;
    102             }
    103         }
    104         return isPublic;
    105     }
    106
    107     public void tearDown() {
    108     }
    109
    110     public void push(GroovySourceAST t) {
    111         stack.push(t);
    112     }
    113     public GroovySourceAST pop() {
    114         if (!stack.empty()) {
    115             return (GroovySourceAST) stack.pop();
    116         }
    117         return null;
    118     }
    119
    120 }