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.parsetree;
054:
055: import com.go.tea.compiler.SourceInfo;
056:
057: /******************************************************************************
058: * The superclass of all parse tree nodes. Every Node contains source
059: * information and can accept a NodeVisitor.
060: *
061: * @author Brian S O'Neill
062: * @version
063: * <!--$$Revision:--> 25 <!-- $-->, <!--$$JustDate:--> 9/07/00 <!-- $-->
064: * @see NodeVisitor
065: */
066: public abstract class Node implements Cloneable, java.io.Serializable {
067: private static final String cPackage;
068: private static final int cPackageLength;
069:
070: static {
071: String className = Node.class.getName();
072: int index = className.lastIndexOf('.');
073: if (index >= 0) {
074: cPackage = className.substring(0, index + 1);
075: } else {
076: cPackage = "";
077: }
078:
079: cPackageLength = cPackage.length();
080: }
081:
082: private SourceInfo mInfo;
083:
084: protected Node(SourceInfo info) {
085: mInfo = info;
086: }
087:
088: public final SourceInfo getSourceInfo() {
089: return mInfo;
090: }
091:
092: /**
093: * Every subclass of Node must override this method with the following:
094: * <code>return visitor.visit(this)</code>.
095: *
096: * @param visitor A visitor of this Node
097: * @return Node The Node returned by the visitor
098: * @see NodeVisitor
099: */
100: public abstract Object accept(NodeVisitor visitor);
101:
102: /**
103: * Returns a clone of this Node and all its children. Immutable child
104: * objects are not necessarily cloned
105: */
106: public Object clone() {
107: try {
108: return (Node) super .clone();
109: } catch (CloneNotSupportedException e) {
110: // Should never happen, since all Nodes are Cloneable.
111: throw new RuntimeException(e.toString());
112: }
113: }
114:
115: /**
116: * Returns a String that contains the type of this Node and source
117: * information.
118: */
119: public String toString() {
120: String name = getClass().getName();
121: int index = name.indexOf(cPackage);
122: if (index >= 0) {
123: name = name.substring(cPackageLength);
124: }
125:
126: String identityCode = Integer.toHexString(System
127: .identityHashCode(this ));
128:
129: if (mInfo == null) {
130: return name + '@' + identityCode;
131: } else {
132: return name + '(' + mInfo.getLine() + ',' + ' '
133: + mInfo.getStartPosition() + ',' + ' '
134: + mInfo.getEndPosition() + ')' + '@' + identityCode;
135: }
136: }
137: }
|