View Javadoc

1   /*
2    * $Id: CompileUnit.java,v 1.17 2005/11/21 00:40:00 blackdrag Exp $
3    * 
4    * Copyright 2003 (C) James Strachan and Bob Mcwhirter. All Rights Reserved.
5    * 
6    * Redistribution and use of this software and associated documentation
7    * ("Software"), with or without modification, are permitted provided that the
8    * following conditions are met:
9    *  1. Redistributions of source code must retain copyright statements and
10   * notices. Redistributions must also contain a copy of this document.
11   *  2. Redistributions in binary form must reproduce the above copyright
12   * notice, this list of conditions and the following disclaimer in the
13   * documentation and/or other materials provided with the distribution.
14   *  3. The name "groovy" must not be used to endorse or promote products
15   * derived from this Software without prior written permission of The Codehaus.
16   * For written permission, please contact info@codehaus.org.
17   *  4. Products derived from this Software may not be called "groovy" nor may
18   * "groovy" appear in their names without prior written permission of The
19   * Codehaus. "groovy" is a registered trademark of The Codehaus.
20   *  5. Due credit should be given to The Codehaus - http://groovy.codehaus.org/
21   * 
22   * THIS SOFTWARE IS PROVIDED BY THE CODEHAUS AND CONTRIBUTORS ``AS IS'' AND ANY
23   * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
24   * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25   * DISCLAIMED. IN NO EVENT SHALL THE CODEHAUS OR ITS CONTRIBUTORS BE LIABLE FOR
26   * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30   * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31   * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
32   * DAMAGE.
33   *  
34   */
35  package org.codehaus.groovy.ast;
36  
37  import groovy.lang.GroovyClassLoader;
38  
39  import java.security.CodeSource;
40  import java.util.ArrayList;
41  import java.util.HashMap;
42  import java.util.Iterator;
43  import java.util.List;
44  import java.util.Map;
45  
46  import org.codehaus.groovy.control.CompilerConfiguration;
47  
48  /***
49   * Represents the entire contents of a compilation step which consists of one
50   * or more {@link ModuleNode}instances
51   * 
52   * @author <a href="mailto:james@coredevelopers.net">James Strachan </a>
53   * @version $Revision: 1.17 $
54   */
55  public class CompileUnit {
56  
57      private List modules = new ArrayList();
58      private Map classes = new HashMap();
59      private CompilerConfiguration config;
60      private GroovyClassLoader classLoader;
61      private CodeSource codeSource;
62      private Map classesToCompile = new HashMap();
63      
64      public CompileUnit(GroovyClassLoader classLoader, CompilerConfiguration config) {
65      	this(classLoader, null, config);
66      }
67      
68      public CompileUnit(GroovyClassLoader classLoader, CodeSource codeSource, CompilerConfiguration config) {
69          this.classLoader = classLoader;
70          this.config = config;
71          this.codeSource = codeSource;
72      }
73  
74      public List getModules() {
75          return modules;
76      }
77  
78      public void addModule(ModuleNode node) {
79          // node==null means a compilation error prevented
80          // groovy from building an ast
81          if (node==null) return;
82          modules.add(node);
83          node.setUnit(this);
84          addClasses(node.getClasses());
85      }
86  
87      /***
88       * @return the ClassNode for the given qualified name or returns null if
89       *         the name does not exist in the current compilation unit
90       *         (ignoring the .class files on the classpath)
91       */
92      public ClassNode getClass(String name) {
93          ClassNode cn = (ClassNode) classes.get(name);
94          if (cn!=null) return cn;
95          return (ClassNode) classesToCompile.get(name);
96      }
97  
98      /***
99       * @return a list of all the classes in each module in the compilation unit
100      */
101     public List getClasses() {
102         List answer = new ArrayList();
103         for (Iterator iter = modules.iterator(); iter.hasNext();) {
104             ModuleNode module = (ModuleNode) iter.next();
105             answer.addAll(module.getClasses());
106         }
107         return answer;
108     }
109 
110     public CompilerConfiguration getConfig() {
111         return config;
112     }
113 
114     public GroovyClassLoader getClassLoader() {
115         return classLoader;
116     }
117     
118     public CodeSource getCodeSource() {
119     	return codeSource;
120     }
121 
122     /***
123      * Appends all of the fully qualified class names in this
124      * module into the given map
125      */
126     void addClasses(List classList) {
127         for (Iterator iter = classList.iterator(); iter.hasNext();) {
128             addClass((ClassNode) iter.next());
129         }
130     }
131     
132     /***
133      *  Adds a class to the unit.
134      */
135     public void addClass(ClassNode node) {
136     	node = node.redirect();
137         String name = node.getName();
138         Object stored = classes.get(name);
139         if (stored != null && stored != node) {
140             throw new RuntimeException(
141                 "Error: duplicate class declaration for name: " + name + " and class: " + node);
142         }
143         classes.put(name, node);
144         
145         if (classesToCompile.containsKey(name)) {
146             ClassNode cn = (ClassNode) classesToCompile.get(name);
147             cn.setRedirect(node);
148             classesToCompile.remove(name);
149         }        
150     }
151      
152     /***
153      * this emthod actually does not compile a class. It's only
154      * a marker that this type has to be compiled by the CompilationUnit
155      * at the end of a parse step no node should be be left.
156      */
157     public void addClassNodeToCompile(ClassNode node) {
158         classesToCompile.put(node.getName(),node);
159     }
160 
161     public boolean hasClassNodeToCompile(){
162         return classesToCompile.size()!=0;
163     }
164 }