src/jdk/nashorn/internal/ir/ReturnNode.java

Sat, 23 Mar 2013 00:58:39 +0100

author
attila
date
Sat, 23 Mar 2013 00:58:39 +0100
changeset 144
4be452026847
parent 96
e478708faa22
child 211
3a209cbd1d8f
permissions
-rw-r--r--

8010652: Eliminate non-child references in Block/FunctionNode, and make few node types immutable
Reviewed-by: jlaskey, lagergren

jlaskey@3 1 /*
jlaskey@7 2 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
jlaskey@3 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
jlaskey@3 4 *
jlaskey@3 5 * This code is free software; you can redistribute it and/or modify it
jlaskey@3 6 * under the terms of the GNU General Public License version 2 only, as
jlaskey@3 7 * published by the Free Software Foundation. Oracle designates this
jlaskey@3 8 * particular file as subject to the "Classpath" exception as provided
jlaskey@3 9 * by Oracle in the LICENSE file that accompanied this code.
jlaskey@3 10 *
jlaskey@3 11 * This code is distributed in the hope that it will be useful, but WITHOUT
jlaskey@3 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
jlaskey@3 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
jlaskey@3 14 * version 2 for more details (a copy is included in the LICENSE file that
jlaskey@3 15 * accompanied this code).
jlaskey@3 16 *
jlaskey@3 17 * You should have received a copy of the GNU General Public License version
jlaskey@3 18 * 2 along with this work; if not, write to the Free Software Foundation,
jlaskey@3 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
jlaskey@3 20 *
jlaskey@3 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
jlaskey@3 22 * or visit www.oracle.com if you need additional information or have any
jlaskey@3 23 * questions.
jlaskey@3 24 */
jlaskey@3 25
jlaskey@3 26 package jdk.nashorn.internal.ir;
jlaskey@3 27
jlaskey@3 28 import static jdk.nashorn.internal.parser.TokenType.RETURN;
jlaskey@3 29 import static jdk.nashorn.internal.parser.TokenType.YIELD;
jlaskey@3 30
jlaskey@3 31 import jdk.nashorn.internal.ir.annotations.Ignore;
jlaskey@3 32 import jdk.nashorn.internal.ir.visitor.NodeVisitor;
jlaskey@3 33 import jdk.nashorn.internal.runtime.Source;
jlaskey@3 34
jlaskey@3 35 /**
jlaskey@3 36 * IR representation for RETURN or YIELD statements.
jlaskey@3 37 *
jlaskey@3 38 */
jlaskey@3 39 public class ReturnNode extends Node {
jlaskey@3 40 /** Optional expression. */
jlaskey@3 41 private Node expression;
jlaskey@3 42
jlaskey@3 43 /** Try chain. */
lagergren@16 44 @Ignore
jlaskey@3 45 private final TryNode tryChain;
jlaskey@3 46
jlaskey@3 47 /**
jlaskey@3 48 * Constructor
jlaskey@3 49 *
jlaskey@3 50 * @param source the source
jlaskey@3 51 * @param token token
jlaskey@3 52 * @param finish finish
jlaskey@3 53 * @param expression expression to return
jlaskey@3 54 * @param tryChain surrounding try chain.
jlaskey@3 55 */
jlaskey@3 56 public ReturnNode(final Source source, final long token, final int finish, final Node expression, final TryNode tryChain) {
jlaskey@3 57 super(source, token, finish);
jlaskey@3 58
jlaskey@3 59 this.expression = expression;
jlaskey@3 60 this.tryChain = tryChain;
jlaskey@3 61
jlaskey@3 62 setIsTerminal(true);
jlaskey@3 63 }
jlaskey@3 64
jlaskey@3 65 private ReturnNode(final ReturnNode returnNode, final CopyState cs) {
jlaskey@3 66 super(returnNode);
jlaskey@3 67
lagergren@96 68 this.expression = cs.existingOrCopy(returnNode.expression);
lagergren@96 69 this.tryChain = (TryNode)cs.existingOrSame(returnNode.tryChain);
jlaskey@3 70 }
jlaskey@3 71
jlaskey@3 72 @Override
jlaskey@3 73 protected Node copy(final CopyState cs) {
jlaskey@3 74 return new ReturnNode(this, cs);
jlaskey@3 75 }
jlaskey@3 76
jlaskey@3 77 /**
jlaskey@3 78 * Return true if is a RETURN node.
jlaskey@3 79 * @return true if is RETURN node.
jlaskey@3 80 */
jlaskey@3 81 public boolean isReturn() {
jlaskey@3 82 return isTokenType(RETURN);
jlaskey@3 83 }
jlaskey@3 84
jlaskey@3 85 /**
jlaskey@3 86 * Check if this return node has an expression
jlaskey@3 87 * @return true if not a void return
jlaskey@3 88 */
jlaskey@3 89 public boolean hasExpression() {
jlaskey@3 90 return expression != null;
jlaskey@3 91 }
jlaskey@3 92
jlaskey@3 93 /**
jlaskey@3 94 * Return true if is a YIELD node.
jlaskey@3 95 * @return TRUE if is YIELD node.
jlaskey@3 96 */
jlaskey@3 97 public boolean isYield() {
jlaskey@3 98 return isTokenType(YIELD);
jlaskey@3 99 }
jlaskey@3 100
jlaskey@3 101 @Override
jlaskey@3 102 public Node accept(final NodeVisitor visitor) {
attila@144 103 if (visitor.enterReturnNode(this) != null) {
jlaskey@3 104 if (expression != null) {
jlaskey@3 105 expression = expression.accept(visitor);
jlaskey@3 106 }
jlaskey@3 107
attila@144 108 return visitor.leaveReturnNode(this);
jlaskey@3 109 }
jlaskey@3 110
jlaskey@3 111 return this;
jlaskey@3 112 }
jlaskey@3 113
jlaskey@3 114
jlaskey@3 115 @Override
jlaskey@3 116 public void toString(final StringBuilder sb) {
jlaskey@3 117 sb.append(isYield() ? "yield" : "return ");
jlaskey@3 118
jlaskey@3 119 if (expression != null) {
jlaskey@3 120 expression.toString(sb);
jlaskey@3 121 }
jlaskey@3 122 }
jlaskey@3 123
jlaskey@3 124 @Override
jlaskey@3 125 public boolean equals(final Object other) {
jlaskey@3 126 if (other instanceof ReturnNode) {
jlaskey@3 127 final ReturnNode otherReturn = (ReturnNode)other;
jlaskey@3 128 if (hasExpression() != otherReturn.hasExpression()) {
jlaskey@3 129 return false;
jlaskey@3 130 } else if (hasExpression()) {
jlaskey@3 131 return otherReturn.getExpression().equals(getExpression());
jlaskey@3 132 }
jlaskey@3 133 return true;
jlaskey@3 134 }
jlaskey@3 135 return false;
jlaskey@3 136 }
jlaskey@3 137
jlaskey@3 138 @Override
jlaskey@3 139 public int hashCode() {
jlaskey@3 140 return 0x4711_17 ^ (expression == null ? 0 : expression.hashCode());
jlaskey@3 141 }
jlaskey@3 142
jlaskey@3 143 /**
jlaskey@3 144 * Get the expression this node returns
jlaskey@3 145 * @return return expression, or null if void return
jlaskey@3 146 */
jlaskey@3 147 public Node getExpression() {
jlaskey@3 148 return expression;
jlaskey@3 149 }
jlaskey@3 150
jlaskey@3 151 /**
jlaskey@3 152 * Reset the expression this node returns
jlaskey@3 153 * @param expression new expression, or null if void return
jlaskey@3 154 */
jlaskey@3 155 public void setExpression(final Node expression) {
jlaskey@3 156 this.expression = expression;
jlaskey@3 157 }
jlaskey@3 158
jlaskey@3 159 /**
jlaskey@3 160 * Get the surrounding try chain for this return node
jlaskey@3 161 * @return try chain
jlaskey@3 162 */
jlaskey@3 163 public TryNode getTryChain() {
jlaskey@3 164 return tryChain;
jlaskey@3 165 }
jlaskey@3 166 }

mercurial