View Javadoc

1   /*
2    $Id: ProcessingUnit.java,v 1.15 2005/06/12 21:04:15 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
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  
47  package org.codehaus.groovy.control;
48  
49  /***
50   * A base class for data structures that can collect messages and errors
51   * during processing.
52   *
53   * @author <a href="mailto:cpoirier@dreaming.org">Chris Poirier</a>
54   * @version $Id: ProcessingUnit.java,v 1.15 2005/06/12 21:04:15 blackdrag Exp $
55   */
56  
57  public abstract class ProcessingUnit {
58  
59      /***
60       * The current phase
61       */
62      protected int phase;
63      /***
64       * Set true if phase is finished
65       */
66      protected boolean phaseComplete;
67  
68      /***
69       * Configuration and other settings that control processing
70       */
71      protected CompilerConfiguration configuration;
72    
73      /***
74       * The ClassLoader to use during processing
75       */
76      protected ClassLoader classLoader;
77      
78      /***
79       * a helper to share errors and report them
80       */
81      protected ErrorCollector errorCollector;
82  
83  
84      /***
85       * Initialize the ProcessingUnit to the empty state.
86       */
87  
88      public ProcessingUnit(CompilerConfiguration configuration, ClassLoader classLoader, ErrorCollector er) {
89  
90          this.phase = Phases.INITIALIZATION;
91          this.classLoader = (classLoader == null ? new CompilerClassLoader() : classLoader);
92  
93          configure((configuration == null ? new CompilerConfiguration() : configuration));
94          if (er==null) er = new ErrorCollector(getConfiguration());
95          this.errorCollector = er;
96      }
97  
98  
99      /***
100      * Reconfigures the ProcessingUnit.
101      */
102     public void configure(CompilerConfiguration configuration) {
103         this.configuration = configuration;
104     }
105 
106 
107     public CompilerConfiguration getConfiguration() {
108         return configuration;
109     }
110 
111     public void setConfiguration(CompilerConfiguration configuration) {
112         this.configuration = configuration;
113     }
114 
115     /***
116      * Returns the class loader in use by this ProcessingUnit.
117      */
118 
119     public ClassLoader getClassLoader() {
120         return classLoader;
121     }
122 
123 
124     /***
125      * Sets the class loader for use by this ProcessingUnit.
126      */
127 
128     public void setClassLoader(ClassLoader loader) {
129         this.classLoader = loader;
130     }
131 
132 
133     /***
134      * Returns the current phase.
135      */
136 
137     public int getPhase() {
138         return this.phase;
139     }
140 
141 
142     /***
143      * Returns the description for the current phase.
144      */
145 
146     public String getPhaseDescription() {
147         return Phases.getDescription(this.phase);
148     }
149 
150     public ErrorCollector getErrorCollector() {
151         return errorCollector;
152     }
153     
154     //---------------------------------------------------------------------------
155     // PROCESSING
156 
157 
158     /***
159      * Marks the current phase complete and processes any
160      * errors.
161      */
162 
163     public void completePhase() throws CompilationFailedException {       
164         errorCollector.failIfErrors();
165         phaseComplete = true;
166     }
167 
168 
169     /***
170      * A synonym for <code>gotoPhase( phase + 1 )</code>.
171      */
172     public void nextPhase() throws CompilationFailedException {
173         gotoPhase(this.phase + 1);
174     }
175 
176 
177     /***
178      * Wraps up any pending operations for the current phase
179      * and switches to the next phase.
180      */
181     public void gotoPhase(int phase) throws CompilationFailedException {
182         if (!this.phaseComplete) {
183             completePhase();
184         }
185 
186         this.phase = phase;
187         this.phaseComplete = false;
188     }
189 
190 }
191 
192 
193 
194