package net.sourceforge.phpdt.internal.compiler.ast;

import java.util.List;
import java.util.ArrayList;

/**
 * @author Matthieu Casanova
 */
public class ForeachStatement extends Statement {

  public Expression expression;
  public Expression variable;
  public Statement  statement;

  public ForeachStatement(final Expression expression,
                          final Expression variable,
                          final Statement statement,
                          final int sourceStart,
                          final int sourceEnd) {
    super(sourceStart, sourceEnd);
    this.expression = expression;
    this.variable = variable;
    this.statement = statement;
  }

  /**
   * Return the object into String.
   * @param tab how many tabs (not used here
   * @return a String
   */
  public String toString(final int tab) {
    final StringBuffer buff = new StringBuffer(tabString(tab));
    buff.append("foreach (");
    buff.append(expression.toStringExpression());
    buff.append(" as ");
    buff.append(variable.toStringExpression());
    buff.append(" {\n");
    buff.append(statement.toString(tab+1));
    buff.append("\n}");
    return buff.toString();
  }

  /**
   * Get the variables from outside (parameters, globals ...)
   * @return the variables from outside
   */
  public List getOutsideVariable() {
    final ArrayList list = new ArrayList();
    list.addAll(expression.getOutsideVariable());
    list.addAll(variable.getOutsideVariable());
    list.addAll(statement.getOutsideVariable());
    return list;
  }

  /**
   * get the modified variables.
   * @return the variables from we change value
   */
  public List getModifiedVariable() {
    final ArrayList list = new ArrayList();
    list.addAll(expression.getModifiedVariable());
    list.addAll(variable.getModifiedVariable());
    list.addAll(statement.getModifiedVariable());
    return list;
  }

  /**
   * Get the variables used.
   * @return the variables used
   */
  public List getUsedVariable() {
    final ArrayList list = new ArrayList();
    list.addAll(expression.getUsedVariable());
    list.addAll(statement.getUsedVariable());
    return list;
  }
}