ForeachStatement.java

/*
 * Copyright (c) 1998-2011 Caucho Technology -- all rights reserved
 *
 * This file is part of Resin(R) Open Source
 *
 * Each copy or derived work must preserve the copyright notice and this
 * notice unmodified.
 *
 * Resin Open Source is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Resin Open Source 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, or any warranty
 * of NON-INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Resin Open Source; if not, write to the
 *
 *   Free Software Foundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307  USA
 *
 * @author Scott Ferguson
 */

package com.caucho.quercus.statement;

import com.caucho.quercus.Location;
import com.caucho.quercus.env.BreakValue;
import com.caucho.quercus.env.ContinueValue;
import com.caucho.quercus.env.Env;
import com.caucho.quercus.env.Value;
import com.caucho.quercus.expr.AbstractVarExpr;
import com.caucho.quercus.expr.Expr;

import java.util.Iterator;
import java.util.Map;

/**
 * Represents a foreach statement.
 */
public class ForeachStatement
  extends Statement
{
  protected final Expr _objExpr;

  protected final AbstractVarExpr _key;

  protected final AbstractVarExpr _value;
  protected final boolean _isRef;

  protected final Statement _block;

  protected final String _label;

  public ForeachStatement(Location location,
                          Expr objExpr,
                          AbstractVarExpr key,
                          AbstractVarExpr value,
                          boolean isRef,
                          Statement block,
                          String label)
  {
    super(location);

    _objExpr = objExpr;

    _key = key;
    _value = value;
    _isRef = isRef;

    _block = block;
    _label = label;

    block.setParent(this);
  }

  @Override
  public boolean isLoop()
  {
    return true;
  }

  public Value execute(Env env)
  {
    Value origObj = _objExpr.eval(env);
    Value obj = origObj.copy(); // php/0669

    if (_key == null && ! _isRef) {
      Iterator<Value> iter = obj.getValueIterator(env);

      while (iter.hasNext()) {
        Value value = iter.next();

        value = value.copy(); // php/0662

        _value.evalAssignValue(env, value);

        Value result = _block.execute(env);

        if (result == null) {
        }
        else if (result instanceof ContinueValue) {
          ContinueValue conValue = (ContinueValue) result;

          int target = conValue.getTarget();

          if (target > 1) {
            return new ContinueValue(target - 1);
          }
        }
        else if (result instanceof BreakValue) {
          BreakValue breakValue = (BreakValue) result;

          int target = breakValue.getTarget();

          if (target > 1)
            return new BreakValue(target - 1);
          else
            break;
        }
        else
          return result;
      }

      return null;
    } else if (_isRef) {
      Iterator<Value> iter = obj.getKeyIterator(env);

      while (iter.hasNext()) {
        Value key = iter.next();

        if (_key != null)
          _key.evalAssignValue(env, key);

        Value value = origObj.getVar(key);

        // php/0667
        _value.evalAssignRef(env, value);

        Value result = _block.execute(env);

        if (result == null) {
        }
        else if (result instanceof ContinueValue) {
          ContinueValue conValue = (ContinueValue) result;

          int target = conValue.getTarget();

          if (target > 1) {
            return new ContinueValue(target - 1);
          }
        }
        else if (result instanceof BreakValue) {
          BreakValue breakValue = (BreakValue) result;

          int target = breakValue.getTarget();

          if (target > 1)
            return new BreakValue(target - 1);
          else
            break;
        }
        else
          return result;
      }
    }
    else {
      Iterator<Map.Entry<Value,Value>> iter = obj.getIterator(env);

      while (iter.hasNext()) {
        Map.Entry<Value, Value> entry = iter.next();
        Value key = entry.getKey();
        Value value = entry.getValue();

        value = value.copy(); // php/066w

        _key.evalAssignValue(env, key);

        _value.evalAssignValue(env, value);

        Value result = _block.execute(env);

        if (result == null) {
        }
        else if (result instanceof ContinueValue) {
          ContinueValue conValue = (ContinueValue) result;

          int target = conValue.getTarget();

          if (target > 1) {
            return new ContinueValue(target - 1);
          }
        }
        else if (result instanceof BreakValue) {
          BreakValue breakValue = (BreakValue) result;

          int target = breakValue.getTarget();

          if (target > 1)
            return new BreakValue(target - 1);
          else
            break;
        }
        else
          return result;
      }
    }

    return null;
  }
}