ForEachLoop.java

// Copyright (C) 2005 Google Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.caja.parser.js;

import com.google.caja.lexer.FilePosition;
import com.google.caja.parser.ParseTreeNode;

import java.util.List;

/**
 * <code>for (key in container) body</code>
 *
 * @author mikesamuel@gmail.com
 */
public final class ForEachLoop extends LabeledStatement implements NestedScope {
  private static final long serialVersionUID = 5611785542136135478L;

  // Local member variables are only changed in childrenChanged(),
  // so this class satisfies the immutability contract of the superclass.
  private Statement keyReceiver;
  private Expression container;
  private Statement body;

  @ReflectiveCtor
  public ForEachLoop(
      FilePosition pos, String value, List<? extends ParseTreeNode> children) {
    super(pos, value, ParseTreeNode.class);
    createMutation().appendChildren(children).execute();
  }

  public ForEachLoop(
      FilePosition pos, String label, Declaration var, Expression container,
      Statement body) {
    super(pos, label, ParseTreeNode.class);
    createMutation()
        .appendChild(var)
        .appendChild(container)
        .appendChild(body)
        .execute();
  }

  public ForEachLoop(
      FilePosition pos, String label, Expression lvalue, Expression container,
      Statement body) {
    super(pos, label, ParseTreeNode.class);
    ExpressionStmt varStmt = new ExpressionStmt(
        lvalue.getFilePosition(), lvalue);
    createMutation()
        .appendChild(varStmt)
        .appendChild(container)
        .appendChild(body)
        .execute();
  }

  public Statement getKeyReceiver() { return keyReceiver; }

  public Expression getContainer() { return container; }

  public Statement getBody() { return body; }

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

  @Override
  protected void childrenChanged() {
    super.childrenChanged();
    List<? extends ParseTreeNode> children = children();
    this.keyReceiver = (Statement) children.get(0);
    if (keyReceiver instanceof ExpressionStmt) {
      Expression e = ((ExpressionStmt) keyReceiver).getExpression();
      if (!e.isLeftHandSide()) {
        throw new IllegalArgumentException("Not an lvalue: " + e);
      }
    }
    this.container = (Expression) children.get(1);
    this.body = (Statement) children.get(2);
  }


  public boolean hasHangingConditional() {
    return body.hasHangingConditional();
  }


}