CommonFunctionCallNode.java

package edu.udel.cis.vsl.abc.ast.node.common.expression;

import java.io.PrintStream;

import edu.udel.cis.vsl.abc.ast.IF.ASTException;
import edu.udel.cis.vsl.abc.ast.entity.IF.Entity;
import edu.udel.cis.vsl.abc.ast.entity.IF.Function;
import edu.udel.cis.vsl.abc.ast.node.IF.ASTNode;
import edu.udel.cis.vsl.abc.ast.node.IF.IdentifierNode;
import edu.udel.cis.vsl.abc.ast.node.IF.SequenceNode;
import edu.udel.cis.vsl.abc.ast.node.IF.expression.ExpressionNode;
import edu.udel.cis.vsl.abc.ast.node.IF.expression.FunctionCallNode;
import edu.udel.cis.vsl.abc.ast.node.IF.expression.IdentifierExpressionNode;
import edu.udel.cis.vsl.abc.ast.node.common.CommonASTNode;
import edu.udel.cis.vsl.abc.token.IF.Source;

public class CommonFunctionCallNode extends CommonExpressionNode
		implements
			FunctionCallNode {

	public CommonFunctionCallNode(Source source, ExpressionNode function,
			SequenceNode<ExpressionNode> contextArguments,
			SequenceNode<ExpressionNode> arguments,
			SequenceNode<ExpressionNode> scopeList) {
		super(source, function, contextArguments, arguments, scopeList);
	}

	@Override
	public ExpressionNode getFunction() {
		return (ExpressionNode) child(0);
	}

	@Override
	public void setFunction(ExpressionNode function) {
		setChild(0, function);
	}

	@Override
	public int getNumberOfContextArguments() {
		if (child(1) != null)
			return child(1).numChildren();
		return 0;
	}

	@Override
	public int getNumberOfArguments() {
		return child(2).numChildren();
	}

	@Override
	public ExpressionNode getContextArgument(int index) {
		return (ExpressionNode) child(1).child(index);
	}

	@Override
	public ExpressionNode getArgument(int index) {
		return (ExpressionNode) child(2).child(index);
	}

	@Override
	public void setContextArgument(int index, ExpressionNode value) {
		((CommonASTNode) child(1)).setChild(index, value);
	}

	@Override
	public void setArgument(int index, ExpressionNode value) {
		((CommonASTNode) child(2)).setChild(index, value);
	}

	@Override
	public void setContextArguments(SequenceNode<ExpressionNode> arguments) {
		this.setChild(1, arguments);
	}

	@Override
	public void setArguments(SequenceNode<ExpressionNode> arguments) {
		this.setChild(2, arguments);
	}

	@Override
	protected void printBody(PrintStream out) {
		out.print("FunctionCallNode");
	}

	@Override
	public boolean isConstantExpression() {
		return false;
	}

	@Override
	public FunctionCallNode copy() {
		@SuppressWarnings("unchecked")
		SequenceNode<ExpressionNode> contextArguments = (SequenceNode<ExpressionNode>) child(
				1);
		@SuppressWarnings("unchecked")
		SequenceNode<ExpressionNode> arguments = (SequenceNode<ExpressionNode>) child(
				2);
		@SuppressWarnings("unchecked")
		SequenceNode<ExpressionNode> scopeList = (SequenceNode<ExpressionNode>) child(
				3);

		return new CommonFunctionCallNode(getSource(), duplicate(getFunction()),
				duplicate(contextArguments), duplicate(arguments),
				duplicate(scopeList));
	}

	@SuppressWarnings("unchecked")
	@Override
	public SequenceNode<ExpressionNode> getScopeList() {
		return (SequenceNode<ExpressionNode>) child(3);
	}

	@Override
	public ExpressionKind expressionKind() {
		return ExpressionKind.FUNCTION_CALL;
	}

	@Override
	public boolean isSideEffectFree(boolean errorsAreSideEffects) {
		ExpressionNode functionExpr = getFunction();
		boolean result = true;

		if (functionExpr instanceof IdentifierExpressionNode) {
			IdentifierNode functionIdentifier = ((IdentifierExpressionNode) functionExpr)
					.getIdentifier();

			if (functionIdentifier.getEntity() == null) {
				// FIXME: Why do we need this? Not having this check was
				// causing a failure with ring2.cvl
				return false;
			}

			boolean isAtomicPureFunction = false;
			Entity functionEntity = functionIdentifier.getEntity();

			if (functionEntity instanceof Function) {
				Function function = (Function) functionEntity;

				isAtomicPureFunction = function.isLogic()
						|| function.isAbstract()
						|| (function.isSystemFunction() && (function.isPure()
								|| function.isStateFunction()));
			}
			if (isAtomicPureFunction) {
				for (int i = 0; i < getNumberOfContextArguments(); i++) {
					boolean argSEF = getContextArgument(i)
							.isSideEffectFree(errorsAreSideEffects);

					if (!argSEF)
						return false;
				}
				if (result) {
					for (int i = 0; i < getNumberOfArguments(); i++) {
						boolean argSEF = getArgument(i)
								.isSideEffectFree(errorsAreSideEffects);

						if (!argSEF)
							return false;
					}
				}
			} else {
				result = false;
			}
		} else {
			// Assume this isn't an abstract function.
			result = false;
		}
		return result;
	}

	@SuppressWarnings("unchecked")
	@Override
	public SequenceNode<ExpressionNode> getArguments() {
		return (SequenceNode<ExpressionNode>) child(2);
	}

	@Override
	public ASTNode setChild(int index, ASTNode child) {
		if (index >= 4)
			throw new ASTException(
					"CommonFunctionCallNode has four children, but saw index "
							+ index);
		if (index == 0 && !(child == null || child instanceof ExpressionNode))
			throw new ASTException("Child of CommonFunctionCallNode at index "
					+ index + " must be a ExpressionNode, but saw " + child
					+ " with type " + child.nodeKind());
		if (index > 0 && index < 4
				&& !(child == null || child instanceof SequenceNode))
			throw new ASTException("Child of CommonFunctionCallNode at index "
					+ index + " must be a SequenceNode, but saw " + child
					+ " with type " + child.nodeKind());
		return super.setChild(index, child);
	}
}