aboutsummaryrefslogtreecommitdiff
path: root/src/jdk/nashorn/internal/ir/ReturnNode.java
blob: 1400f3958682aa94926ca9155f73c42b820dc338 (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
/*
 * 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 static jdk.nashorn.internal.parser.TokenType.RETURN;
import static jdk.nashorn.internal.parser.TokenType.YIELD;

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

/**
 * IR representation for RETURN or YIELD statements.
 *
 */
public class ReturnNode extends Node {
    /** Optional expression. */
    private Node expression;

    /** Try chain. */
    @Ignore
    private final TryNode tryChain;

    /**
     * Constructor
     *
     * @param source     the source
     * @param token      token
     * @param finish     finish
     * @param expression expression to return
     * @param tryChain   surrounding try chain.
     */
    public ReturnNode(final Source source, final long token, final int finish, final Node expression, final TryNode tryChain) {
        super(source, token, finish);

        this.expression = expression;
        this.tryChain   = tryChain;

        setIsTerminal(true);
    }

    private ReturnNode(final ReturnNode returnNode, final CopyState cs) {
        super(returnNode);

        this.expression = cs.existingOrCopy(returnNode.expression);
        this.tryChain   = (TryNode)cs.existingOrSame(returnNode.tryChain);
    }

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

    /**
     * Return true if is a RETURN node.
     * @return true if is RETURN node.
     */
    public boolean isReturn() {
        return isTokenType(RETURN);
    }

    /**
     * Check if this return node has an expression
     * @return true if not a void return
     */
    public boolean hasExpression() {
        return expression != null;
    }

    /**
     * Return true if is a YIELD node.
     * @return TRUE if is YIELD node.
     */
    public boolean isYield() {
        return isTokenType(YIELD);
    }

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

            return visitor.leaveReturnNode(this);
        }

        return this;
    }


    @Override
    public void toString(final StringBuilder sb) {
        sb.append(isYield() ? "yield" : "return ");

        if (expression != null) {
            expression.toString(sb);
        }
    }

    @Override
    public boolean equals(final Object other) {
        if (other instanceof ReturnNode) {
            final ReturnNode otherReturn = (ReturnNode)other;
            if (hasExpression() != otherReturn.hasExpression()) {
                return false;
            } else if (hasExpression()) {
                return otherReturn.getExpression().equals(getExpression());
            }
            return true;
        }
        return false;
    }

    @Override
    public int hashCode() {
        return 0x4711_17 ^ (expression == null ? 0 : expression.hashCode());
    }

    /**
     * Get the expression this node returns
     * @return return expression, or null if void return
     */
    public Node getExpression() {
        return expression;
    }

    /**
     * Reset the expression this node returns
     * @param expression new expression, or null if void return
     */
    public void setExpression(final Node expression) {
        this.expression = expression;
    }

    /**
     * Get the surrounding try chain for this return node
     * @return try chain
     */
    public TryNode getTryChain() {
        return tryChain;
    }
}