001 /* 002 $Id: ProcessingUnit.java,v 1.17 2005/06/27 17:34:03 fraz 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 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,v 1.17 2005/06/27 17:34:03 fraz Exp $ 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 ClassLoader classLoader; 079 080 /** 081 * a helper to share errors and report them 082 */ 083 protected ErrorCollector errorCollector; 084 085 086 /** 087 * Initialize the ProcessingUnit to the empty state. 088 */ 089 090 public ProcessingUnit(CompilerConfiguration configuration, ClassLoader classLoader, ErrorCollector er) { 091 092 this.phase = Phases.INITIALIZATION; 093 ClassLoader parent = Thread.currentThread().getContextClassLoader(); 094 if (parent == null) parent = ProcessingUnit.class.getClassLoader(); 095 this.classLoader = (classLoader == null ? new GroovyClassLoader(parent, configuration) : classLoader); 096 configure((configuration == null ? new CompilerConfiguration() : configuration)); 097 if (er==null) er = new ErrorCollector(getConfiguration()); 098 this.errorCollector = er; 099 } 100 101 102 /** 103 * Reconfigures the ProcessingUnit. 104 */ 105 public void configure(CompilerConfiguration configuration) { 106 this.configuration = configuration; 107 } 108 109 110 public CompilerConfiguration getConfiguration() { 111 return configuration; 112 } 113 114 public void setConfiguration(CompilerConfiguration configuration) { 115 this.configuration = configuration; 116 } 117 118 /** 119 * Returns the class loader in use by this ProcessingUnit. 120 */ 121 122 public ClassLoader getClassLoader() { 123 return classLoader; 124 } 125 126 127 /** 128 * Sets the class loader for use by this ProcessingUnit. 129 */ 130 131 public void setClassLoader(ClassLoader loader) { 132 this.classLoader = 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