content: /*******************************************************************************
   * Copyright (c) 2009 IBM Corporation and others.
   *
   * This program and the accompanying materials are made
   * available under the terms of the Eclipse Public License 2.0
   * which is available at https://www.eclipse.org/legal/epl-2.0/
   *
   * SPDX-License-Identifier: EPL-2.0
   * 
   * Contributors:
   *     IBM Corporation - initial API and implementation
   *     Zend Technologies
   *******************************************************************************/
  package org.eclipse.php.core.ast.nodes;
  
  import java.util.ArrayList;
  import java.util.Collections;
  import java.util.List;
  
  import org.eclipse.php.core.PHPVersion;
  import org.eclipse.php.core.ast.match.ASTMatcher;
  import org.eclipse.php.core.ast.visitor.Visitor;
  
  /**
   * Represents a class instantiation. This class holds the class name as an
   * expression and array of constructor parameters
   * 
   * e.g.
   * 
   * <pre>
   * new MyClass(),
   * new $a('start'),
   * new foo()(1, $a)
   * </pre>
   */
  public class ClassInstanceCreation extends VariableBase {
  
  	private ClassName className;
  	private ASTNode.NodeList<Expression> ctorParams = new ASTNode.NodeList<>(CTOR_PARAMS_PROPERTY);
  	private AnonymousClassDeclaration anonymousClassDeclaration;
  	/**
  	 * The structural property of this node type.
  	 */
  	public static final ChildPropertyDescriptor CLASSNAME_PROPERTY = new ChildPropertyDescriptor(
  			ClassInstanceCreation.class, "className", ClassName.class, //$NON-NLS-1$
  			MANDATORY, CYCLE_RISK);
  	public static final ChildListPropertyDescriptor CTOR_PARAMS_PROPERTY = new ChildListPropertyDescriptor(
  			ClassInstanceCreation.class, "ctorParams", Expression.class, //$NON-NLS-1$
  			CYCLE_RISK);
  	public static final ChildPropertyDescriptor ANONYMOUS_CLASS_PROPERTY = new ChildPropertyDescriptor(
  			ClassInstanceCreation.class, "anonymousClass", //$NON-NLS-1$
  			AnonymousClassDeclaration.class, OPTIONAL, CYCLE_RISK);
  
  	/**
  	 * 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<>(3);
  		propertyList.add(CLASSNAME_PROPERTY);
  		propertyList.add(CTOR_PARAMS_PROPERTY);
  		propertyList.add(ANONYMOUS_CLASS_PROPERTY);
  		PROPERTY_DESCRIPTORS = Collections.unmodifiableList(propertyList);
  	}
  
  	public ClassInstanceCreation(AST ast) {
  		super(ast);
  	}
  
  	@Override
  	public void accept0(Visitor visitor) {
  		final boolean visit = visitor.visit(this);
  		if (visit) {
  			childrenAccept(visitor);
  		}
  		visitor.endVisit(this);
  	}
  
  	public ClassInstanceCreation(int start, int end, AST ast, ClassName className, List<Expression> ctorParams) {
  		super(start, end, ast);
  		if (className == null || ctorParams == null) {
  			throw new IllegalArgumentException();
  		}
  
  		setClassName(className);
  		this.ctorParams.addAll(ctorParams);
  	}
  
  	public ClassInstanceCreation(int start, int end, AST ast, ClassName className, List<Expression> ctorParams,
  			AnonymousClassDeclaration anonymousClassDeclaration) {
  		super(start, end, ast);
  		if (className == null || anonymousClassDeclaration == null || ctorParams == null) {
  			throw new IllegalArgumentException();
  		}
  		setClassName(className);
  		setAnonymousClassDeclaration(anonymousClassDeclaration);
  		this.ctorParams.addAll(ctorParams);
  	}
  
  	@Override
  	public void childrenAccept(Visitor visitor) {
  		if (className != null) {
  			className.accept(visitor);
  		}
  		for (ASTNode node : this.ctorParams) {
  			node.accept(visitor);
  		}
  		if (anonymousClassDeclaration != null) {
  			anonymousClassDeclaration.childrenAccept(visitor);
  		}
  	}
  
  	@Override
  	public void traverseTopDown(Visitor visitor) {
  		accept(visitor);
  		if (className != null) {
  			className.traverseTopDown(visitor);
  		}
  		for (ASTNode node : this.ctorParams) {
  			node.traverseTopDown(visitor);
  		}
  		if (anonymousClassDeclaration != null) {
  			anonymousClassDeclaration.traverseTopDown(visitor);
  		}
  	}
  
  	@Override
  	public void traverseBottomUp(Visitor visitor) {
  		if (className != null) {
  			className.traverseBottomUp(visitor);
  		}
  		for (ASTNode node : this.ctorParams) {
  			node.traverseBottomUp(visitor);
  		}
  		if (anonymousClassDeclaration != null) {
  			anonymousClassDeclaration.traverseBottomUp(visitor);
  		}
  		accept(visitor);
  	}
  
  	@Override
  	public void toString(StringBuilder buffer, String tab) {
  		buffer.append(tab).append("<ClassInstanceCreation"); //$NON-NLS-1$
  		appendInterval(buffer);
  		buffer.append(">\n"); //$NON-NLS-1$
  		if (className != null) {
  			className.toString(buffer, TAB + tab);
  		}
  		buffer.append("\n").append(TAB).append(tab) //$NON-NLS-1$
  				.append("<ConstructorParameters>\n"); //$NON-NLS-1$
  		for (ASTNode node : this.ctorParams) {
  			node.toString(buffer, TAB + TAB + tab);
  			buffer.append("\n"); //$NON-NLS-1$
  		}
  		buffer.append(TAB).append(tab).append("</ConstructorParameters>\n"); //$NON-NLS-1$
  		if (getAnonymousClassDeclaration() != null) {
  			getAnonymousClassDeclaration().toString(buffer, TAB + tab);
  			buffer.append("\n"); //$NON-NLS-1$
  		}
  		buffer.append(tab).append("</ClassInstanceCreation>"); //$NON-NLS-1$
  	}
  
  	@Override
  	public int getType() {
  		return ASTNode.CLASS_INSTANCE_CREATION;
  	}
  
  	/**
  	 * Class name of this instance creation node
  	 * 
  	 * @return class name
  	 */
  	public ClassName getClassName() {
  		return className;
  	}
  
  	/**
  	 * Sets the class name of this instansiation.
  	 * 
  	 * @param classname
  	 *            the new class name
  	 * @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 setClassName(ClassName classname) {
  		if (classname == null) {
  			throw new IllegalArgumentException();
  		}
  		ASTNode oldChild = this.className;
  		preReplaceChild(oldChild, classname, CLASSNAME_PROPERTY);
  		this.className = classname;
  		postReplaceChild(oldChild, classname, CLASSNAME_PROPERTY);
  	}
  
  	public AnonymousClassDeclaration getAnonymousClassDeclaration() {
  		return anonymousClassDeclaration;
  	}
  
  	public void setAnonymousClassDeclaration(AnonymousClassDeclaration anonymousClassDeclaration) {
  		if (anonymousClassDeclaration == null) {
  			throw new IllegalArgumentException();
  		}
  		ASTNode oldChild = this.anonymousClassDeclaration;
  		preReplaceChild(oldChild, anonymousClassDeclaration, ANONYMOUS_CLASS_PROPERTY);
  		this.anonymousClassDeclaration = anonymousClassDeclaration;
  		postReplaceChild(oldChild, anonymousClassDeclaration, ANONYMOUS_CLASS_PROPERTY);
  	}
  
  	@Override
  	final ASTNode internalGetSetChildProperty(ChildPropertyDescriptor property, boolean get, ASTNode child) {
  		if (property == CLASSNAME_PROPERTY) {
  			if (get) {
  				return getClassName();
  			} else {
  				setClassName((ClassName) child);
  				return null;
  			}
  		}
  		if (property == ANONYMOUS_CLASS_PROPERTY) {
  			if (get) {
  				return getAnonymousClassDeclaration();
  			} else {
  				setAnonymousClassDeclaration((AnonymousClassDeclaration) child);
  				return null;
  			}
  		}
  		// allow default implementation to flag the error
  		return super.internalGetSetChildProperty(property, get, child);
  	}
  
  	@Override
  	public List<? extends ASTNode> internalGetChildListProperty(ChildListPropertyDescriptor property) {
  		if (property == CTOR_PARAMS_PROPERTY) {
  			return ctorParams();
  		}
  		return super.internalGetChildListProperty(property);
  	}
  
  	/**
  	 * List of expressions that were given to the the constructor. <b>Since PHP
  	 * 7.2 the last element can be an EmptyExpression object (whose length is 0)
  	 * to handle the new php trailing comma feature.</b>
  	 * 
  	 * @return list of expressions that were given to the the constructor
  	 */
  	public List<Expression> ctorParams() {
  		return this.ctorParams;
  	}
  
  	/*
  	 * Method declared on ASTNode.
  	 */
  	@Override
  	public boolean subtreeMatch(ASTMatcher matcher, Object other) {
  		// dispatch to correct overloaded match method
  		return matcher.match(this, other);
  	}
  
  	@Override
  	ASTNode clone0(AST target) {
  		final List<Expression> params = ASTNode.copySubtrees(target, ctorParams());
  		AnonymousClassDeclaration acd = ASTNode.copySubtree(target, getAnonymousClassDeclaration());
  		final ClassName cn = ASTNode.copySubtree(target, getClassName());
  		return new ClassInstanceCreation(this.getStart(), this.getEnd(), target, cn, params, acd);
  	}
  
  	public ClassInstanceCreation cloneWithNewStart(int offset) {
  		AST target = getAST();
  		final List<Expression> params = ASTNode.copySubtrees(target, ctorParams());
  		final ClassName cn = ASTNode.copySubtree(target, getClassName());
  		final ClassInstanceCreation result = new ClassInstanceCreation(offset, this.getEnd(), target, cn, params);
  		return result;
  	}
  
  	@Override
  	List<StructuralPropertyDescriptor> internalStructuralPropertiesForType(PHPVersion apiLevel) {
  		return PROPERTY_DESCRIPTORS;
  	}
  
  	/**
  	 * Resolves and returns the binding for the constructor invoked by this
  	 * expression.
  	 * 
  	 * @return the binding, or <code>null</code> if the binding cannot be resolved
  	 */
  	public IMethodBinding resolveConstructorBinding() {
  		return this.ast.getBindingResolver().resolveConstructor(this);
  	}
  
  }
  