001 /* 002 $Id: SummaryCollector.java,v 1.1 2005/09/22 14:56:07 jez Exp $ 003 004 Copyright 2005 (C) Jeremy Rayner. All Rights Reserved. 005 006 Redistribution and use of this software and associated documentation 007 ("Software"), with or without modification, are permitted provided 008 that the following conditions are met: 009 010 1. Redistributions of source code must retain copyright 011 statements and notices. Redistributions must also contain a 012 copy of this document. 013 014 2. Redistributions in binary form must reproduce the 015 above copyright notice, this list of conditions and the 016 following disclaimer in the documentation and/or other 017 materials provided with the distribution. 018 019 3. The name "groovy" must not be used to endorse or promote 020 products derived from this Software without prior written 021 permission of The Codehaus. For written permission, 022 please contact info@codehaus.org. 023 024 4. Products derived from this Software may not be called "groovy" 025 nor may "groovy" appear in their names without prior written 026 permission of The Codehaus. "groovy" is a registered 027 trademark of The Codehaus. 028 029 5. Due credit should be given to The Codehaus - 030 http://groovy.codehaus.org/ 031 032 THIS SOFTWARE IS PROVIDED BY THE CODEHAUS AND CONTRIBUTORS 033 ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT 034 NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 035 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 036 THE CODEHAUS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 037 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 038 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 039 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 040 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 041 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 042 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 043 OF THE POSSIBILITY OF SUCH DAMAGE. 044 045 */ 046 package org.codehaus.groovy.antlr.treewalker; 047 048 import org.codehaus.groovy.antlr.GroovySourceAST; 049 import org.codehaus.groovy.antlr.AntlrSourceSummary; 050 import org.codehaus.groovy.antlr.syntax.AntlrClassSource; 051 import org.codehaus.groovy.antlr.parser.GroovyTokenTypes; 052 import org.codehaus.groovy.syntax.ClassSource; 053 import org.codehaus.groovy.syntax.SourceSummary; 054 055 /** 056 * A visitor for the antlr ast that creates a summary of the parsed source unit 057 * 058 * @author Jeremy Rayner 059 */ 060 public class SummaryCollector extends VisitorAdapter { 061 private SourceSummary sourceSummary; 062 063 public SourceSummary getSourceSummary() { 064 return sourceSummary; 065 } 066 067 public SummaryCollector() { 068 sourceSummary = new AntlrSourceSummary(); 069 } 070 071 public void setUp() { 072 } 073 074 public void visitClassDef(GroovySourceAST t, int visit) { 075 if (visit == OPENING_VISIT) { 076 ClassSource classSource = new AntlrClassSource( 077 t.childOfType(GroovyTokenTypes.IDENT).getText(),t 078 ); 079 // Here we assume that the optional restrictions (JLS$7.6) 080 // on compilation units in file-based implementations apply 081 // http://java.sun.com/docs/books/jls/second_edition/html/packages.doc.html#26783 082 GroovySourceAST modifiers = t.childOfType(GroovyTokenTypes.MODIFIERS); 083 084 if (isPublic(modifiers)) { 085 sourceSummary.addPublic(classSource); 086 } 087 } 088 } 089 090 /* figue out if this modifier node represents a public entity */ 091 private boolean isPublic(GroovySourceAST modifiers) { 092 boolean isPublic = true; 093 if (modifiers != null) { 094 GroovySourceAST modprot = modifiers.childOfType(GroovyTokenTypes.LITERAL_protected); 095 GroovySourceAST modpriv = modifiers.childOfType(GroovyTokenTypes.LITERAL_private); 096 if (modpriv != null || modprot != null) { 097 isPublic = false; 098 } 099 } 100 return isPublic; 101 } 102 103 public void tearDown() { 104 } 105 106 }