View Javadoc

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