EnsureNode.java

/***** BEGIN LICENSE BLOCK *****
 * Version: CPL 1.0/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Common Public
 * License Version 1.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/cpl-v10.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 Anders Bengtsson <ndrsbngtssn@yahoo.se>
 * Copyright (C) 2004 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 CPL, 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 CPL, 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.evaluator.Instruction;
import org.jruby.lexer.yacc.ISourcePosition;
import org.jruby.lexer.yacc.ISourcePositionHolder;
import org.jruby.lexer.yacc.SourcePosition;

/**
 * an ensure statement.
 * 
 * @author jpetersen
 */
public class EnsureNode extends Node {
	static final long serialVersionUID = -409805241533215981L;

	private final Node bodyNode;
	private final EnsureNode.Keyword ensureNode;

	public EnsureNode(ISourcePosition position, Node bodyNode,
			EnsureNode.Keyword ensureNode) {
		super(position, NodeTypes.ENSURENODE);
		this.bodyNode = bodyNode;
		this.ensureNode = ensureNode;
	}

	/**
	 * Accept for the visitor pattern.
	 * 
	 * @param iVisitor
	 *            the visitor
	 **/
	public Instruction accept(NodeVisitor iVisitor) {
		return iVisitor.visitEnsureNode(this);
	}

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

	/**
	 * Gets the ensureNode.
	 * 
	 * @return Returns a Node
	 */
	public EnsureNode.Keyword getEnsureNode() {
		return ensureNode;
	}

	public List childNodes() {
		return Node.createList(bodyNode, ensureNode);
	}

	public static class Keyword extends Node {
		private final ISourcePositionHolder keyword;

		private final Node statement;

		/**
		 * @param position
		 * @param id
		 */
		public Keyword(ISourcePositionHolder keyword, Node statement) {
			super(SourcePosition.combinePosition(keyword.getPosition(),
					statement.getPosition()), NodeTypes.EXT_ENSURE_KEYWORD);
			this.keyword = keyword;
			this.statement = statement;
		}

		/*
		 * @see org.jruby.ast.Node#accept(org.jruby.ast.visitor.NodeVisitor)
		 */
		public Instruction accept(NodeVisitor visitor) {
			throw new RuntimeException(getNodeName()
					+ " should never be evaluated");
		}

		/*
		 * @see org.jruby.ast.Node#childNodes()
		 */
		public List childNodes() {
			return createList(statement);
		}

		/**
		 * @return the keyword
		 */
		public ISourcePositionHolder getKeyword() {
			return keyword;
		}

		/**
		 * @return the statement
		 */
		public Node getStatement() {
			return statement;
		}

	}

}