001: /* ====================================================================
002: * Tea - Copyright (c) 1997-2000 Walt Disney Internet Group
003: * ====================================================================
004: * The Tea Software License, Version 1.1
005: *
006: * Copyright (c) 2000 Walt Disney Internet Group. All rights reserved.
007: *
008: * Redistribution and use in source and binary forms, with or without
009: * modification, are permitted provided that the following conditions
010: * are met:
011: *
012: * 1. Redistributions of source code must retain the above copyright
013: * notice, this list of conditions and the following disclaimer.
014: *
015: * 2. Redistributions in binary form must reproduce the above copyright
016: * notice, this list of conditions and the following disclaimer in
017: * the documentation and/or other materials provided with the
018: * distribution.
019: *
020: * 3. The end-user documentation included with the redistribution,
021: * if any, must include the following acknowledgment:
022: * "This product includes software developed by the
023: * Walt Disney Internet Group (http://opensource.go.com/)."
024: * Alternately, this acknowledgment may appear in the software itself,
025: * if and wherever such third-party acknowledgments normally appear.
026: *
027: * 4. The names "Tea", "TeaServlet", "Kettle", "Trove" and "BeanDoc" must
028: * not be used to endorse or promote products derived from this
029: * software without prior written permission. For written
030: * permission, please contact opensource@dig.com.
031: *
032: * 5. Products derived from this software may not be called "Tea",
033: * "TeaServlet", "Kettle" or "Trove", nor may "Tea", "TeaServlet",
034: * "Kettle", "Trove" or "BeanDoc" appear in their name, without prior
035: * written permission of the Walt Disney Internet Group.
036: *
037: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
038: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
039: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
040: * DISCLAIMED. IN NO EVENT SHALL THE WALT DISNEY INTERNET GROUP OR ITS
041: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
042: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
043: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
044: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
045: * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
046: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
047: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
048: * ====================================================================
049: *
050: * For more information about Tea, please see http://opensource.go.com/.
051: */
052:
053: package com.go.tea.compiler;
054:
055: import com.go.tea.parsetree.Template;
056: import java.io.Reader;
057: import java.io.OutputStream;
058: import java.io.IOException;
059:
060: /******************************************************************************
061: *
062: * @author Brian S O'Neill
063: * @version
064: * <!--$$Revision:--> 21 <!-- $-->, <!--$$JustDate:--> 01/02/06 <!-- $-->
065: */
066: public abstract class CompilationUnit implements ErrorListener {
067: private String mName;
068: private Compiler mCompiler;
069: private Template mTree;
070:
071: private int mErrorCount;
072:
073: public CompilationUnit(String name, Compiler compiler) {
074: mName = name;
075: mCompiler = compiler;
076: }
077:
078: public String getName() {
079: return mName;
080: }
081:
082: public String getShortName() {
083: String name = getName();
084: int index = name.lastIndexOf('.');
085: if (index >= 0) {
086: return name.substring(index + 1);
087: }
088:
089: return name;
090: }
091:
092: public Compiler getCompiler() {
093: return mCompiler;
094: }
095:
096: /**
097: * Called when there is an error when compiling this CompilationUnit.
098: */
099: public void compileError(ErrorEvent e) {
100: mErrorCount++;
101: }
102:
103: /**
104: * Returns the number of errors generated while compiling this
105: * CompilationUnit.
106: */
107: public int getErrorCount() {
108: return mErrorCount;
109: }
110:
111: public Template getParseTree() {
112: if (mTree == null && mCompiler != null) {
113: return mCompiler.getParseTree(this );
114: }
115: return mTree;
116: }
117:
118: public void setParseTree(Template tree) {
119: mTree = tree;
120: }
121:
122: /**
123: * Current implementation returns only the same packages as the compiler.
124: *
125: * @see Compiler#getImportedPackages()
126: */
127: public final String[] getImportedPackages() {
128: return mCompiler.getImportedPackages();
129: }
130:
131: /**
132: * Return the package name that this CompilationUnit should be compiled
133: * into. Default implementation returns null, or no package.
134: */
135: public String getTargetPackage() {
136: return null;
137: }
138:
139: public abstract String getSourceFileName();
140:
141: /**
142: * @return A new source file reader.
143: */
144: public abstract Reader getReader() throws IOException;
145:
146: /**
147: * @return true if the CompilationUnit should be compiled. Default is true.
148: */
149: public boolean shouldCompile() throws IOException {
150: return true;
151: }
152:
153: /**
154: * @return An OutputStream to write compiled code to. Returning null is
155: * disables code generation for this CompilationUnit.
156: */
157: public abstract OutputStream getOutputStream() throws IOException;
158: }
|