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: import com.go.tea.compiler.Type;
057:
058: /******************************************************************************
059: * A ForeachStatement iterates over the values of an array or a Collection,
060: * storing each value in a variable, allowing a statement or statements to
061: * operate on each. Reverse looping is supported for arrays and Lists.
062: *
063: * <p>Because Collections don't know the type of elements they
064: * contain (they only know that they are Objects), the only operations allowed
065: * on the loop variable are those that are defined for Object.
066: *
067: * <p>Collection class can be subclassed to contain a special
068: * field that defines the element type. The field must have the following
069: * signature: <tt>public static final Class ELEMENT_TYPE</tt>
070: *
071: * @author Brian S O'Neill
072: * @version
073: * <!--$$Revision:--> 30 <!-- $-->, <!--$$JustDate:--> 9/07/00 <!-- $-->
074: */
075: public class ForeachStatement extends Statement {
076: private VariableRef mLoopVar;
077: private Expression mRange;
078: private Expression mEndRange;
079: private boolean mReverse;
080: private Statement mInitializer;
081: private Block mBody;
082:
083: public ForeachStatement(SourceInfo info, VariableRef loopVar,
084: Expression range, Expression endRange, boolean reverse,
085: Block body) {
086: super (info);
087:
088: mLoopVar = loopVar;
089: mRange = range;
090: mEndRange = endRange;
091: mReverse = reverse;
092: mBody = body;
093: }
094:
095: public Object accept(NodeVisitor visitor) {
096: return visitor.visit(this );
097: }
098:
099: public Object clone() {
100: ForeachStatement fs = (ForeachStatement) super .clone();
101: fs.mLoopVar = (VariableRef) mLoopVar.clone();
102: fs.mRange = (Expression) mRange.clone();
103: fs.mEndRange = (Expression) mEndRange.clone();
104: if (mInitializer != null) {
105: fs.mInitializer = (Statement) mInitializer.clone();
106: }
107: fs.mBody = (Block) mBody.clone();
108: return fs;
109: }
110:
111: public VariableRef getLoopVariable() {
112: return mLoopVar;
113: }
114:
115: public Expression getRange() {
116: return mRange;
117: }
118:
119: /**
120: * Returns null if this foreach statement iterates over an array/collection
121: * instead of an integer range of values.
122: */
123: public Expression getEndRange() {
124: return mEndRange;
125: }
126:
127: public boolean isReverse() {
128: return mReverse;
129: }
130:
131: /**
132: * Initializer is a section of code that executes before the loop is
133: * entered. By default, it is null. A type checker may define an
134: * initializer.
135: */
136: public Statement getInitializer() {
137: return mInitializer;
138: }
139:
140: public Block getBody() {
141: return mBody;
142: }
143:
144: public void setRange(Expression range) {
145: mRange = range;
146: }
147:
148: public void setEndRange(Expression endRange) {
149: mEndRange = endRange;
150: }
151:
152: public void setInitializer(Statement stmt) {
153: mInitializer = stmt;
154: }
155:
156: public void setBody(Block body) {
157: mBody = body;
158: }
159: }
|