001 /*
002 $Id: ProcessingUnit.java,v 1.15 2005/06/12 21:04:15 blackdrag Exp $
003
004 Copyright 2003 (C) James Strachan and Bob Mcwhirter. 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
047 package org.codehaus.groovy.control;
048
049 /**
050 * A base class for data structures that can collect messages and errors
051 * during processing.
052 *
053 * @author <a href="mailto:cpoirier@dreaming.org">Chris Poirier</a>
054 * @version $Id: ProcessingUnit.java,v 1.15 2005/06/12 21:04:15 blackdrag Exp $
055 */
056
057 public abstract class ProcessingUnit {
058
059 /**
060 * The current phase
061 */
062 protected int phase;
063 /**
064 * Set true if phase is finished
065 */
066 protected boolean phaseComplete;
067
068 /**
069 * Configuration and other settings that control processing
070 */
071 protected CompilerConfiguration configuration;
072
073 /**
074 * The ClassLoader to use during processing
075 */
076 protected ClassLoader classLoader;
077
078 /**
079 * a helper to share errors and report them
080 */
081 protected ErrorCollector errorCollector;
082
083
084 /**
085 * Initialize the ProcessingUnit to the empty state.
086 */
087
088 public ProcessingUnit(CompilerConfiguration configuration, ClassLoader classLoader, ErrorCollector er) {
089
090 this.phase = Phases.INITIALIZATION;
091 this.classLoader = (classLoader == null ? new CompilerClassLoader() : classLoader);
092
093 configure((configuration == null ? new CompilerConfiguration() : configuration));
094 if (er==null) er = new ErrorCollector(getConfiguration());
095 this.errorCollector = er;
096 }
097
098
099 /**
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