/*
 * 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 java.util.Collections;
import java.util.List;
import jdk.nashorn.internal.codegen.Label;
import jdk.nashorn.internal.ir.annotations.Immutable;
import jdk.nashorn.internal.ir.visitor.NodeVisitor;

IR representation of CASE clause.
Case nodes are not BreakableNodes, but the SwitchNode is
/**
 * IR representation of CASE clause.
 * Case nodes are not BreakableNodes, but the SwitchNode is
 */
@Immutable
public final class CaseNode extends Node implements JoinPredecessor, Labels, Terminal {
    private static final long serialVersionUID = 1L;

    
Test expression. /** Test expression. */
    private final Expression test;

    
Statements. /** Statements. */
    private final Block body;

    
Case entry label. /** Case entry label. */
    private final Label entry;

    
See Also:
JoinPredecessor/**
     * @see JoinPredecessor
     */
    private final LocalVariableConversion conversion;

    
Constructors
Params:
token –    token
finish –   finish
test –     case test node, can be any node in JavaScript
body –     case body/**
     * Constructors
     *
     * @param token    token
     * @param finish   finish
     * @param test     case test node, can be any node in JavaScript
     * @param body     case body
     */
    public CaseNode(final long token, final int finish, final Expression test, final Block body) {
        super(token, finish);

        this.test  = test;
        this.body  = body;
        this.entry = new Label("entry");
        this.conversion = null;
    }

    CaseNode(final CaseNode caseNode, final Expression test, final Block body, final LocalVariableConversion conversion) {
        super(caseNode);

        this.test  = test;
        this.body  = body;
        this.entry = new Label(caseNode.entry);
        this.conversion = conversion;
    }

    
Is this a terminal case node, i.e. does it end control flow like having a throw or return?
Returns:
true if this node statement is terminal/**
     * Is this a terminal case node, i.e. does it end control flow like having a throw or return?
     *
     * @return true if this node statement is terminal
     */
    @Override
    public boolean isTerminal() {
        return body.isTerminal();
    }

    
Assist in IR navigation.
Params:
visitor – IR navigating visitor./**
     * Assist in IR navigation.
     * @param visitor IR navigating visitor.
     */
    @Override
    public Node accept(final NodeVisitor<? extends LexicalContext> visitor) {
        if (visitor.enterCaseNode(this)) {
            final Expression newTest = test == null ? null : (Expression)test.accept(visitor);
            final Block newBody = body == null ? null : (Block)body.accept(visitor);

            return visitor.leaveCaseNode(setTest(newTest).setBody(newBody));
        }

        return this;
    }

    @Override
    public void toString(final StringBuilder sb, final boolean printTypes) {
        if (test != null) {
            sb.append("case ");
            test.toString(sb, printTypes);
            sb.append(':');
        } else {
            sb.append("default:");
        }
    }

    
Get the body for this case node
Returns:
the body/**
     * Get the body for this case node
     * @return the body
     */
    public Block getBody() {
        return body;
    }

    
Get the entry label for this case node
Returns:
the entry label/**
     * Get the entry label for this case node
     * @return the entry label
     */
    public Label getEntry() {
        return entry;
    }

    
Get the test expression for this case node
Returns:
the test/**
     * Get the test expression for this case node
     * @return the test
     */
    public Expression getTest() {
        return test;
    }

    
Reset the test expression for this case node
Params:
test – new test expression
Returns:
new or same CaseNode/**
     * Reset the test expression for this case node
     * @param test new test expression
     * @return new or same CaseNode
     */
    public CaseNode setTest(final Expression test) {
        if (this.test == test) {
            return this;
        }
        return new CaseNode(this, test, body, conversion);
    }

    @Override
    public JoinPredecessor setLocalVariableConversion(final LexicalContext lc, final LocalVariableConversion conversion) {
        if(this.conversion == conversion) {
            return this;
        }
        return new CaseNode(this, test, body, conversion);
    }

    @Override
    public LocalVariableConversion getLocalVariableConversion() {
        return conversion;
    }

    private CaseNode setBody(final Block body) {
        if (this.body == body) {
            return this;
        }
        return new CaseNode(this, test, body, conversion);
    }

    @Override
    public List<Label> getLabels() {
        return Collections.unmodifiableList(Collections.singletonList(entry));
    }
}