/*
 ***** BEGIN LICENSE BLOCK *****
 * Version: EPL 2.0/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Eclipse Public
 * 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.eclipse.org/legal/epl-v20.html
 *
 * Software distributed under the License is distributed on an "AS
 * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * rights and limitations under the License.
 *
 * Copyright (C) 2001-2002 Jan Arne Petersen <jpetersen@uni-bonn.de>
 * Copyright (C) 2001-2002 Benoit Cerrina <b.cerrina@wanadoo.fr>
 * Copyright (C) 2002-2004 Anders Bengtsson <ndrsbngtssn@yahoo.se>
 * Copyright (C) 2004-2006 Thomas E Enebo <enebo@acm.org>
 * 
 * Alternatively, the contents of this file may be used under the terms of
 * either of the GNU General Public License Version 2 or later (the "GPL"),
 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the EPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the EPL, the GPL or the LGPL.
 ***** END LICENSE BLOCK *****/

package org.jruby.ast;

import java.util.List;

import org.jruby.ast.visitor.NodeVisitor;
import org.jruby.lexer.yacc.ISourcePosition;
import org.jruby.parser.StaticScope;

Represents a block.  
/**
 * Represents a block.  
 */
public class IterNode extends Node implements DefNode {
    private final Node varNode;
    private final Node bodyNode;
    
    // What static scoping relationship exists when it comes into being.
    private StaticScope scope;
    private int endLine;

    
 Used by ForNode only.
This is to support 1.8-style assignments which only 'for' expressions use.
/**
     *  Used by ForNode only.
     * This is to support 1.8-style assignments which only 'for' expressions use.
     */
    public IterNode(ISourcePosition position, Node args, StaticScope scope, Node body, int endLine) {
        super(position, args != null && args.containsVariableAssignment || body != null && body.containsVariableAssignment);

        this.varNode = args;
        this.scope = scope;
        this.bodyNode = body;
        this.endLine = endLine;
    }

    
Used for all non-for types of blocks.
/**
     * Used for all non-for types of blocks.
     */
    public IterNode(ISourcePosition position, ArgsNode args, Node body, StaticScope scope, int endLine) {
        super(position, args != null && args.containsVariableAssignment || body != null && body.containsVariableAssignment);

        this.varNode = args;
        this.bodyNode = body == null ? NilImplicitNode.NIL : body;
        this.scope = scope;
        this.endLine = endLine;
    }

    public NodeType getNodeType() {
        return NodeType.ITERNODE;
    }

    
Accept for the visitor pattern.
Params:
iVisitor – the visitor/**
     * Accept for the visitor pattern.
     * @param iVisitor the visitor
     **/
    public <T> T accept(NodeVisitor<T> iVisitor) {
        return iVisitor.visitIterNode(this);
    }

    @Override
    public ArgsNode getArgsNode() {
        return (ArgsNode) varNode;
    }

    public StaticScope getScope() {
        return scope;
    }

    
Gets the bodyNode.
Returns:
Returns a Node/**
     * Gets the bodyNode.
     * @return Returns a Node
     */
    public Node getBodyNode() {
        return bodyNode;
    }

    
Gets the varNode.
Returns:
Returns a Node/**
     * Gets the varNode.
     * @return Returns a Node
     */
    public Node getVarNode() {
        return varNode;
    }
    
    public List<Node> childNodes() {
        return Node.createList(varNode, bodyNode);
    }

    public int getEndLine() {
        return endLine;
    }
}