/*******************************************************************************
* Copyright (c) 2009 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
* Zend Technologies
*******************************************************************************/
package org2.eclipse.php.internal.core.ast.nodes;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import org2.eclipse.php.internal.core.PHPVersion;
import org2.eclipse.php.internal.core.ast.match.ASTMatcher;
import org2.eclipse.php.internal.core.ast.visitor.Visitor;
/**
* Represents a switch statement.
* <pre>e.g.<pre>
* switch ($i) {
* case 0:
* echo "i equals 0";
* break;
* case 1:
* echo "i equals 1";
* break;
* default:
* echo "i not equals 0 or 1";
* break;
* }
*/
public class SwitchStatement extends Statement {
private Expression expression;
private Block body;
/**
* The "expression" structural property of this node type.
*/
public static final ChildPropertyDescriptor EXPRESSION_PROPERTY =
new ChildPropertyDescriptor(SwitchStatement.class, "expression", Expression.class, MANDATORY, NO_CYCLE_RISK); //$NON-NLS-1$
public static final ChildPropertyDescriptor BODY_PROPERTY =
new ChildPropertyDescriptor(SwitchStatement.class, "body", Statement.class, MANDATORY, CYCLE_RISK); //$NON-NLS-1$
/**
* A list of property descriptors (element type:
* {@link StructuralPropertyDescriptor}),
* or null if uninitialized.
*/
private static final List<StructuralPropertyDescriptor> PROPERTY_DESCRIPTORS;
static {
List<StructuralPropertyDescriptor> propertyList = new ArrayList<StructuralPropertyDescriptor>(2);
propertyList.add(EXPRESSION_PROPERTY);
propertyList.add(BODY_PROPERTY);
PROPERTY_DESCRIPTORS = Collections.unmodifiableList(propertyList);
}
public SwitchStatement(AST ast) {
super(ast);
}
public SwitchStatement(int start, int end, AST ast, Expression expression, Block body) {
super(start, end, ast);
if (expression == null || body == null) {
throw new IllegalArgumentException();
}
setExpression(expression);
setBody(body);
}
public void accept0(Visitor visitor) {
final boolean visit = visitor.visit(this);
if (visit) {
childrenAccept(visitor);
}
visitor.endVisit(this);
}
public void childrenAccept(Visitor visitor) {
expression.accept(visitor);
body.accept(visitor);
}
public void traverseTopDown(Visitor visitor) {
accept(visitor);
expression.traverseTopDown(visitor);
body.traverseTopDown(visitor);
}
public void traverseBottomUp(Visitor visitor) {
expression.traverseBottomUp(visitor);
body.traverseBottomUp(visitor);
accept(visitor);
}
public void toString(StringBuffer buffer, String tab) {
buffer.append(tab).append("<SwitchStatement"); //$NON-NLS-1$
appendInterval(buffer);
buffer.append(">\n"); //$NON-NLS-1$
buffer.append(TAB).append(tab).append("<Expression>\n"); //$NON-NLS-1$
expression.toString(buffer, TAB + TAB + tab);
buffer.append("\n"); //$NON-NLS-1$
buffer.append(TAB).append(tab).append("</Expression>\n"); //$NON-NLS-1$
body.toString(buffer, TAB + tab);
buffer.append("\n").append(tab).append("</SwitchStatement>"); //$NON-NLS-1$ //$NON-NLS-2$
}
public int getType() {
return ASTNode.SWITCH_STATEMENT;
}
/**
* Returns the expression of this switch statement.
*
* @return the expression node
*/
public Expression getExpression() {
return expression;
}
/**
* @deprecated see {@link #getExpression()}
*/
public Expression getExpr() {
return expression;
}
/**
* Sets the expression of this switch statement.
*
* @param expression the new expression node
* @exception IllegalArgumentException if:
* <ul>
* <li>the node belongs to a different AST</li>
* <li>the node already has a parent</li>
* <li>a cycle in would be created</li>
* </ul>
*/
public void setExpression(Expression expression) {
if (expression == null) {
throw new IllegalArgumentException();
}
ASTNode oldChild = this.expression;
preReplaceChild(oldChild, expression, EXPRESSION_PROPERTY);
this.expression = expression;
postReplaceChild(oldChild, expression, EXPRESSION_PROPERTY);
}
/**
* @deprecated use #getBody()
*/
public Block getStatement() {
return body;
}
/**
* @return the body component of this switch statement
*/
public Block getBody() {
return this.body;
}
/**
* Sets the body part of this switch statement
* <p>
*
* @param body the "then" statement node
* @exception IllegalArgumentException if:
* <ul>
* <li>the node belongs to a different AST</li>
* <li>the node already has a parent</li>
* <li>a cycle in would be created</li>
* </ul>
*/
public void setBody(Block body) {
if (body == null) {
throw new IllegalArgumentException();
}
ASTNode oldChild = this.body;
preReplaceChild(oldChild, body, BODY_PROPERTY);
this.body = body;
postReplaceChild(oldChild, body, BODY_PROPERTY);
}
final ASTNode internalGetSetChildProperty(ChildPropertyDescriptor property, boolean get, ASTNode child) {
if (property == EXPRESSION_PROPERTY) {
if (get) {
return getExpression();
} else {
setExpression((Expression) child);
return null;
}
}
if (property == BODY_PROPERTY) {
if (get) {
return getBody();
} else {
setBody((Block) child);
return null;
}
}
// allow default implementation to flag the error
return super.internalGetSetChildProperty(property, get, child);
}
/*
* Method declared on ASTNode.
*/
public boolean subtreeMatch(ASTMatcher matcher, Object other) {
// dispatch to correct overloaded match method
return matcher.match(this, other);
}
@Override
ASTNode clone0(AST target) {
final Expression expr = ASTNode.copySubtree(target, getExpression());
final Block body = ASTNode.copySubtree(target, getBody());
final SwitchStatement result = new SwitchStatement(this.getStart(), this.getEnd(), target, expr, body);
return result;
}
@Override
List<StructuralPropertyDescriptor> internalStructuralPropertiesForType(PHPVersion apiLevel) {
return PROPERTY_DESCRIPTORS;
}
}