ObjectContext.java

/*******************************************************************************
 *
 *	Copyright (C) 2008 Fujitsu Services Ltd.
 *
 *	Author: Nick Battle
 *
 *	This file is part of VDMJ.
 *
 *	VDMJ 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 3 of the License, or
 *	(at your option) any later version.
 *
 *	VDMJ 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 Public License for more details.
 *
 *	You should have received a copy of the GNU General Public License
 *	along with VDMJ.  If not, see <http://www.gnu.org/licenses/>.
 *
 ******************************************************************************/

package org.overture.interpreter.runtime;

import java.io.PrintWriter;

import org.overture.ast.intf.lex.ILexLocation;
import org.overture.ast.intf.lex.ILexNameToken;
import org.overture.interpreter.assistant.IInterpreterAssistantFactory;
import org.overture.interpreter.values.ObjectValue;
import org.overture.interpreter.values.Value;

/**
 * A root context for object method invocations.
 */

@SuppressWarnings("serial")
public class ObjectContext extends RootContext
{
	public final ObjectValue self;

	/**
	 * Create an ObjectContext from the values passed.
	 * 
	 * @param af
	 * @param location
	 *            The location of the context.
	 * @param title
	 *            The name of the location.
	 * @param freeVariables
	 * @param outer
	 *            The context chain (not searched).
	 * @param self
	 *            The object context.
	 */

	public ObjectContext(IInterpreterAssistantFactory af,
			ILexLocation location, String title, Context freeVariables,
			Context outer, ObjectValue self)
	{
		super(af, location, title, freeVariables, outer);
		this.self = self;
	}

	public ObjectContext(IInterpreterAssistantFactory af,
			ILexLocation location, String title, Context outer, ObjectValue self)
	{
		this(af, location, title, null, outer, self);
	}

	@Override
	public Context deepCopy()
	{
		Context below = null;

		if (outer != null)
		{
			below = outer.deepCopy();
		}

		Context result = new ObjectContext(assistantFactory, location, title, freeVariables, below, self.deepCopy());

		for (ILexNameToken var : keySet())
		{
			Value v = get(var);
			result.put(var, v.deepCopy());
		}

		return result;
	}

	/**
	 * Check for the name in the current context and self, and if not present search the global context. Note that the
	 * context chain is not followed.
	 * 
	 * @see Context#check(ILexNameToken)
	 */

	@Override
	public Value check(ILexNameToken name)
	{
		// A RootContext stops the name search from continuing down the
		// context chain. It first checks any local context, then it
		// checks the "self" context, then it goes down to the global level.

		Value v = get(name); // Local variables

		if (v != null)
		{
			return v;
		}

		if (freeVariables != null)
		{
			v = freeVariables.get(name);

			if (v != null)
			{
				return v;
			}
		}

		v = self.get(name, name.getExplicit());

		if (v != null)
		{
			return v;
		}

		Context g = getGlobal();

		if (g != this)
		{
			return g.check(name);
		}

		return v;
	}

	@Override
	public String toString()
	{
		// return super.toString(); // Self there anyway ...+ self.toString();
		return (DEBUG ? "#" + id + " " : "") + format("", this)
				+ self.toString().replace(", ", "\n\t")
				+ "\n-------------------\n" + outer;
	}

	@Override
	public void printStackTrace(PrintWriter out, boolean variables)
	{
		if (outer == null) // Don't expand initial context
		{
			out.println("In object context of " + title);
		} else
		{
			if (variables)
			{
				out.print(this.format("\t", this));
			}

			out.println("In object context of " + title + " " + location);
			outer.printStackTrace(out, false);
		}
	}

	@Override
	public ObjectValue getSelf()
	{
		return self;
	}
}