/*
 * #%L
 * The AIBench Shell Plugin
 * %%
 * Copyright (C) 2006 - 2017 Daniel Glez-Peña and Florentino Fdez-Riverola
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program 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.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * <http://www.gnu.org/licenses/lgpl-3.0.html>.
 * #L%
 */
/*****************************************************************************
 *                                                                           *
 *  This file is part of the BeanShell Java Scripting distribution.          *
 *  Documentation and updates may be found at http://www.beanshell.org/      *
 *                                                                           *
 *  Sun Public License Notice:                                               *
 *                                                                           *
 *  The contents of this file are subject to the Sun Public License Version  *
 *  1.0 (the "License"); you may not use this file except in compliance with *
 *  the License. A copy of the License is available at http://www.sun.com    * 
 *                                                                           *
 *  The Original Code is BeanShell. The Initial Developer of the Original    *
 *  Code is Pat Niemeyer. Portions created by Pat Niemeyer are Copyright     *
 *  (C) 2000.  All Rights Reserved.                                          *
 *                                                                           *
 *  GNU Public License Notice:                                               *
 *                                                                           *
 *  Alternatively, the contents of this file may be used under the terms of  *
 *  the GNU Lesser General Public License (the "LGPL"), in which case the    *
 *  provisions of LGPL are applicable instead of those above. If you wish to *
 *  allow use of your version of this file only under the  terms of the LGPL *
 *  and not to allow others to use your version of this file under the SPL,  *
 *  indicate your decision by deleting the provisions above and replace      *
 *  them with the notice and other provisions required by the LGPL.  If you  *
 *  do not delete the provisions above, a recipient may use your version of  *
 *  this file under either the SPL or the LGPL.                              *
 *                                                                           *
 *  Patrick Niemeyer (pat@pat.net)                                           *
 *  Author of Learning Java, O'Reilly & Associates                           *
 *  http://www.pat.net/~pat/                                                 *
 *                                                                           *
 *****************************************************************************/

package bsh;

/*
 * Note: great care (and lots of typing) were taken to insure that the namespace
 * and interpreter references are passed on the stack and not (as they were
 * erroneously before) installed in instance variables... Each of these node
 * objects must be re-entrable to allow for recursive situations.
 * 
 * The only data which should really be stored in instance vars here should be
 * parse tree data... features of the node which should never change (e.g. the
 * number of arguments, etc.)
 * 
 * Exceptions would be public fields of simple classes that just publish data
 * produced by the last eval()... data that is used immediately. We'll try to
 * remember to mark these as transient to highlight them.
 * 
 */
class SimpleNode implements Node {
	private static final long serialVersionUID = 1L;

	public static SimpleNode JAVACODE = new SimpleNode(-1) {
		private static final long serialVersionUID = 1L;

		public String getSourceFile() {
			return "<Called from Java Code>";
		}

		public int getLineNumber() {
			return -1;
		}

		public String getText() {
			return "<Compiled Java Code>";
		}
	};

	protected Node parent;

	protected Node[] children;

	protected int id;

	Token firstToken, lastToken;

	/** the source of the text from which this was parsed */
	String sourceFile;

	public SimpleNode(int i) {
		id = i;
	}

	public void jjtOpen() {}

	public void jjtClose() {}

	public void jjtSetParent(Node n) {
		parent = n;
	}

	public Node jjtGetParent() {
		return parent;
	}

	// public SimpleNode getParent() { return (SimpleNode)parent; }

	public void jjtAddChild(Node n, int i) {
		if (children == null)
			children = new Node[i + 1];
		else if (i >= children.length) {
			Node c[] = new Node[i + 1];
			System.arraycopy(children, 0, c, 0, children.length);
			children = c;
		}

		children[i] = n;
	}

	public Node jjtGetChild(int i) {
		return children[i];
	}

	public SimpleNode getChild(int i) {
		return (SimpleNode) jjtGetChild(i);
	}

	public int jjtGetNumChildren() {
		return (children == null) ? 0 : children.length;
	}

	/*
	 * You can override these two methods in subclasses of SimpleNode to
	 * customize the way the node appears when the tree is dumped. If your
	 * output uses more than one line you should override toString(String),
	 * otherwise overriding toString() is probably all you need to do.
	 */
	public String toString() {
		return ParserTreeConstants.jjtNodeName[id];
	}

	public String toString(String prefix) {
		return prefix + toString();
	}

	/*
	 * Override this method if you want to customize how the node dumps out its
	 * children.
	 */
	public void dump(String prefix) {
		System.out.println(toString(prefix));
		if (children != null) {
			for (int i = 0; i < children.length; ++i) {
				SimpleNode n = (SimpleNode) children[i];
				if (n != null) {
					n.dump(prefix + " ");
				}
			}
		}
	}

	// ---- BeanShell specific stuff hereafter ---- //

	/**
	 * Detach this node from its parent. This is primarily useful in node
	 * serialization. (see BSHMethodDeclaration)
	 */
	public void prune() {
		jjtSetParent(null);
	}

	/**
	 * This is the general signature for evaluation of a node.
	 * 
	 * @param callstack the call stack of the evaluation.
	 * @param interpreter the interpreter.
	 * @return the result of the evaluation.
	 * @throws EvalError if an error occurs while evaluating.
	 */
	public Object eval(CallStack callstack, Interpreter interpreter) throws EvalError {
		throw new InterpreterError("Unimplemented or inappropriate for " + getClass().getName());
	}

	/**
	 * Set the name of the source file (or more generally source) of the text
	 * from which this node was parsed.
	 * 
	 * @param sourceFile the name of the source file (or more generally source) of the text
	 * from which this node was parsed.
	 */
	public void setSourceFile(String sourceFile) {
		this.sourceFile = sourceFile;
	}

	/**
	 * Get the name of the source file (or more generally source) of the text
	 * from which this node was parsed. This will recursively search up the
	 * chain of parent nodes until a source is found or return a string
	 * indicating that the source is unknown.
	 * 
	 * @return the name of the source file of the text from which this node was parsed.
	 */
	public String getSourceFile() {
		if (sourceFile == null)
			if (parent != null)
				return ((SimpleNode) parent).getSourceFile();
			else
				return "<unknown file>";
		else
			return sourceFile;
	}

	/**
	 * Returns the line number of the starting token.
	 * 
	 * @return the line number of the starting token.
	 */
	public int getLineNumber() {
		return firstToken.beginLine;
	}

	/*
	 * Get the ending line number of the starting token public int
	 * getEndLineNumber() { return lastToken.endLine; }
	 */

	/**
	 * Returns the text of the tokens comprising this node.
	 * 
	 * @return the text of the tokens comprising this node.
	 */
	public String getText() {
		StringBuffer text = new StringBuffer();
		Token t = firstToken;
		while (t != null) {
			text.append(t.image);
			if (!t.image.equals("."))
				text.append(" ");
			if (t == lastToken || t.image.equals("{") || t.image.equals(";"))
				break;
			t = t.next;
		}

		return text.toString();
	}
}
