aboutsummaryrefslogtreecommitdiff
path: root/src/jdk/nashorn/internal/ir/WhileNode.java
blob: 8db31c088ff93f78013eac5a15d43ae5abbe46a8 (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
/*
 * 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.codegen.Label;
import jdk.nashorn.internal.ir.visitor.NodeVisitor;
import jdk.nashorn.internal.runtime.Source;

/**
 * IR representation for a WHILE statement. This is the superclass of all
 * loop nodes
 */
public class WhileNode extends BreakableNode {
    /** Test expression. */
    protected Node test;

    /** For body. */
    protected Block body;

    /** loop continue label. */
    protected Label continueLabel;

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

        this.breakLabel    = new Label("while_break");
        this.continueLabel = new Label("while_continue");
    }

    /**
     * Copy constructor
     *
     * @param whileNode source node
     * @param cs        copy state
     */
    protected WhileNode(final WhileNode whileNode, final CopyState cs) {
        super(whileNode);

        this.test          = cs.existingOrCopy(whileNode.test);
        this.body          = (Block)cs.existingOrCopy(whileNode.body);
        this.breakLabel    = new Label(whileNode.breakLabel);
        this.continueLabel = new Label(whileNode.continueLabel);
    }

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

    @Override
    public boolean isLoop() {
        return true;
    }

    /**
     * Assist in IR navigation.
     * @param visitor IR navigating visitor.
     */
    @Override
    public Node accept(final NodeVisitor visitor) {
        if (visitor.enterWhileNode(this) != null) {
            test = test.accept(visitor);
            body = (Block)body.accept(visitor);

            return visitor.leaveWhileNode(this);
        }
        return this;
    }

    @Override
    public void toString(final StringBuilder sb) {
        sb.append("while (");
        test.toString(sb);
        sb.append(')');
    }

    /**
     * Get the loop body
     * @return body
     */
    public Block getBody() {
        return body;
    }

    /**
     * Reset the loop body
     * @param body new body
     */
    public void setBody(final Block body) {
        this.body = body;
    }

    /**
     * Set the break label (described in {@link WhileNode#getBreakLabel()} for this while node
     * @param breakLabel break label
     */
    public void setBreakLabel(final Label breakLabel) {
        this.breakLabel = breakLabel;
    }

    /**
     * Get the continue label for this while node, i.e. location to go to on continue
     * @return continue label
     */
    public Label getContinueLabel() {
        return continueLabel;
    }

    /**
     * Set the continue label (described in {@link WhileNode#getContinueLabel()} for this while node
     * @param continueLabel continue label
     */
    public void setContinueLabel(final Label continueLabel) {
        this.continueLabel = continueLabel;
    }

    /**
     * Get the test expression for this loop, that upon evaluation to true does another iteration
     * @return test expression
     */
    public Node getTest() {
        return test;
    }

    /**
     * Set the test expression for this loop
     * @param test test expression, null if infinite loop
     */
    public void setTest(final Node test) {
        this.test = test;
    }
}