aboutsummaryrefslogtreecommitdiff
path: root/src/jdk/nashorn/internal/ir/ForNode.java
blob: e55054dde1f20306bc34a8c3c95a0812d1c644f6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
/*
 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package jdk.nashorn.internal.ir;

import jdk.nashorn.internal.ir.visitor.NodeVisitor;
import jdk.nashorn.internal.runtime.Source;

/**
 * IR representing a FOR statement.
 *
 */
public class ForNode extends WhileNode {
    /** Initialize expression. */
    private Node init;

    /** Test expression. */
    private Node modify;

    /** Iterator symbol. */
    private Symbol iterator;

    /** is for in */
    private boolean isForIn;

    /** is for each */
    private boolean isForEach;

    /**
     * Constructor
     *
     * @param source     the source
     * @param token      token
     * @param finish     finish
     */
    public ForNode(final Source source, final long token, final int finish) {
        super(source, token, finish);
    }

    private ForNode(final ForNode forNode, final CopyState cs) {
        super(forNode, cs);

        this.init      = cs.existingOrCopy(forNode.init);
        this.modify    = cs.existingOrCopy(forNode.modify);
        this.iterator  = forNode.iterator;
        this.isForIn   = forNode.isForIn;
        this.isForEach = forNode.isForEach;
    }

    @Override
    protected Node copy(final CopyState cs) {
        return new ForNode(this, cs);
    }

    @Override
    public Node accept(final NodeVisitor visitor) {
        if (visitor.enterForNode(this) != null) {
            if (init != null) {
                init = init.accept(visitor);
            }

            if (test != null) {
                test = test.accept(visitor);
            }

            if (modify != null) {
                modify = modify.accept(visitor);
            }

            body = (Block)body.accept(visitor);

            return visitor.leaveForNode(this);
        }

        return this;
    }

    @Override
    public void toString(final StringBuilder sb) {
        sb.append("for (");

        if (isForIn()) {
            init.toString(sb);
            sb.append(" in ");
            modify.toString(sb);
        } else {
            if (init != null) {
                init.toString(sb);
            }
            sb.append("; ");
            if (test != null) {
                test.toString(sb);
            }
            sb.append("; ");
            if (modify != null) {
                modify.toString(sb);
            }
        }

        sb.append(')');
    }

    /**
     * Get the initialization expression for this for loop
     * @return the initialization expression
     */
    public Node getInit() {
        return init;
    }

    /**
     * Reset the initialization expression for this for loop
     * @param init new initialization expression
     */
    public void setInit(final Node init) {
        this.init = init;
    }

    /**
     * Is this a for in construct rather than a standard init;condition;modification one
     * @return true if this is a for in constructor
     */
    public boolean isForIn() {
        return isForIn;
    }

    /**
     * Flag this to be a for in construct
     */
    public void setIsForIn() {
        this.isForIn = true;
    }

    /**
     * Is this a for each construct, known from e.g. Rhino. This will be a for of construct
     * in ECMAScript 6
     * @return true if this is a for each construct
     */
    public boolean isForEach() {
        return isForEach;
    }

    /**
     * Flag this to be a for each construct
     */
    public void setIsForEach() {
        this.isForEach = true;
    }

    /**
     * If this is a for in or for each construct, there is an iterator symbol
     * @return the symbol for the iterator to be used, or null if none exists
     */
    public Symbol getIterator() {
        return iterator;
    }

    /**
     * Assign an iterator symbol to this ForNode. Used for for in and for each constructs
     * @param iterator the iterator symbol
     */
    public void setIterator(final Symbol iterator) {
        this.iterator = iterator;
    }

    /**
     * Get the modification expression for this ForNode
     * @return the modification expression
     */
    public Node getModify() {
        return modify;
    }

    /**
     * Reset the modification expression for this ForNode
     * @param modify new modification expression
     */
    public void setModify(final Node modify) {
        this.modify = modify;
    }

    @Override
    public Node getTest() {
        return test;
    }

    @Override
    public void setTest(final Node test) {
        this.test = test;
    }
}