FunctionBase.java

/**
 * This file Copyright (c) 2005-2008 Aptana, Inc. This program is
 * dual-licensed under both the Aptana Public License and the GNU General
 * Public license. You may elect to use one or the other of these licenses.
 * 
 * This program is distributed in the hope that it will be useful, but
 * AS-IS and WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, TITLE, or
 * NONINFRINGEMENT. Redistribution, except as permitted by whichever of
 * the GPL or APL you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or modify this
 * program under the terms of the GNU General Public License,
 * Version 3, as published by the Free Software Foundation.  You should
 * have received a copy of the GNU General Public License, Version 3 along
 * with this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 * 
 * Aptana provides a special exception to allow redistribution of this file
 * with certain other free and open source software ("FOSS") code and certain additional terms
 * pursuant to Section 7 of the GPL. You may view the exception and these
 * terms on the web at http://www.aptana.com/legal/gpl/.
 * 
 * 2. For the Aptana Public License (APL), this program and the
 * accompanying materials are made available under the terms of the APL
 * v1.0 which accompanies this distribution, and is available at
 * http://www.aptana.com/legal/apl/.
 * 
 * You may view the GPL, Aptana's exception and additional terms, and the
 * APL in the file titled license.html at the root of the corresponding
 * plugin containing this source file.
 * 
 * Any modifications to this file must keep this entire header intact.
 */
package com.aptana.ide.editor.js.runtime;

import com.aptana.ide.lexer.IRange;

/**
 * @author Kevin Lindsey
 * @author Robin Debreuil
 */
public abstract class FunctionBase extends ObjectBase implements IFunction
{
	/*
	 * Fields
	 */

	/**
	 * Empty arguments
	 */
	public static final IObject[] EmptyArgs = new IObject[0];
	private IInvokeTypeProvider _typeProvider;

	/*
	 * Properties
	 */

	/**
	 * @see com.aptana.ide.editor.js.runtime.ObjectBase#getClassName()
	 */
	public String getClassName()
	{
		return "Function"; //$NON-NLS-1$
	}

	/**
	 * @see com.aptana.ide.editor.js.runtime.IFunction#getInvokeTypeProvider()
	 */
	public IInvokeTypeProvider getInvokeTypeProvider()
	{
		return this._typeProvider;
	}

	/**
	 * @see com.aptana.ide.editor.js.runtime.IFunction#setInvokeTypeProvider(com.aptana.ide.editor.js.runtime.IInvokeTypeProvider)
	 */
	public void setInvokeTypeProvider(IInvokeTypeProvider typeProvider)
	{
		this._typeProvider = typeProvider;
	}

	/*
	 * Constructors
	 */

	/**
	 * Create a new instance of FunctionBase
	 */
	public FunctionBase()
	{
		this(null);
	}

	/**
	 * Create a new instance of FunctionBase
	 * 
	 * @param sourceRegion
	 *            The region within the source that defines this object instance
	 */
	public FunctionBase(IRange sourceRegion)
	{
		super(sourceRegion);
	}

	/*
	 * IFunction implementation
	 */

	/**
	 * @see com.aptana.ide.editor.js.runtime.IFunction#getParameterNames()
	 */
	public String[] getParameterNames()
	{
		return new String[0];
	}

	/**
	 * @see com.aptana.ide.editor.js.runtime.IFunction#construct(com.aptana.ide.editor.js.runtime.Environment, com.aptana.ide.editor.js.runtime.IObject[], int,
	 *      IRange)
	 */
	public abstract IObject construct(Environment environment, IObject[] arguments, int fileIndex, IRange sourceRegion);

	/**
	 * @see com.aptana.ide.editor.js.runtime.IFunction#invoke(com.aptana.ide.editor.js.runtime.Environment, com.aptana.ide.editor.js.runtime.IObject[], int, IRange)
	 */
	public abstract IObject invoke(Environment environment, IObject[] arguments, int fileIndex, IRange sourceRegion);
}