001: /*
002: $Id: ProcessingUnit.java 3104 2005-11-13 16:42:14Z blackdrag $
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: import groovy.lang.GroovyClassLoader;
050:
051: /**
052: * A base class for data structures that can collect messages and errors
053: * during processing.
054: *
055: * @author <a href="mailto:cpoirier@dreaming.org">Chris Poirier</a>
056: * @version $Id: ProcessingUnit.java 3104 2005-11-13 16:42:14Z blackdrag $
057: */
058:
059: public abstract class ProcessingUnit {
060:
061: /**
062: * The current phase
063: */
064: protected int phase;
065: /**
066: * Set true if phase is finished
067: */
068: protected boolean phaseComplete;
069:
070: /**
071: * Configuration and other settings that control processing
072: */
073: protected CompilerConfiguration configuration;
074:
075: /**
076: * The ClassLoader to use during processing
077: */
078: protected GroovyClassLoader classLoader;
079:
080: /**
081: * a helper to share errors and report them
082: */
083: protected ErrorCollector errorCollector;
084:
085: /**
086: * Initialize the ProcessingUnit to the empty state.
087: */
088:
089: public ProcessingUnit(CompilerConfiguration configuration,
090: GroovyClassLoader classLoader, ErrorCollector er) {
091:
092: this .phase = Phases.INITIALIZATION;
093: this .setClassLoader(classLoader);
094: configure((configuration == null ? new CompilerConfiguration()
095: : configuration));
096: if (er == null)
097: er = new ErrorCollector(getConfiguration());
098: this .errorCollector = er;
099: }
100:
101: /**
102: * Reconfigures the ProcessingUnit.
103: */
104: public void configure(CompilerConfiguration configuration) {
105: this .configuration = configuration;
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: * Sets the class loader for use by this ProcessingUnit.
126: */
127:
128: public void setClassLoader(GroovyClassLoader loader) {
129: ClassLoader parent = Thread.currentThread()
130: .getContextClassLoader();
131: if (parent == null)
132: parent = ProcessingUnit.class.getClassLoader();
133: this .classLoader = (loader == null ? new GroovyClassLoader(
134: parent, configuration) : loader);
135: }
136:
137: /**
138: * Returns the current phase.
139: */
140:
141: public int getPhase() {
142: return this .phase;
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: * Marks the current phase complete and processes any
162: * errors.
163: */
164:
165: public void completePhase() throws CompilationFailedException {
166: errorCollector.failIfErrors();
167: phaseComplete = true;
168: }
169:
170: /**
171: * A synonym for <code>gotoPhase( phase + 1 )</code>.
172: */
173: public void nextPhase() throws CompilationFailedException {
174: gotoPhase(this .phase + 1);
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: }
|