JSFunctionNode.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.parsing.nodes;

import com.aptana.ide.io.SourceWriter;
import com.aptana.ide.lexer.Lexeme;
import com.aptana.ide.parsing.nodes.IParseNode;

/**
 * @author Robin Debreuil
 */
public class JSFunctionNode extends JSParseNode
{
	String[] params;

	/**
	 * @param startLexeme
	 */
	public JSFunctionNode(Lexeme startLexeme)
	{
		super(JSParseNodeTypes.FUNCTION, startLexeme);
	}

	/**
	 * getFunctionName
	 *
	 * @return String
	 */
	public String getFunctionName()
	{
		String result = null;

		if (this.getChildCount() == 3)
		{
			IParseNode child = this.getChild(0);

			if (child.getTypeIndex() == JSParseNodeTypes.IDENTIFIER)
			{
				result = child.getText();
			}
		}

		return result;
	}

	/**
	 * @return Returns the params.
	 */
	public String[] getParams()
	{
		String[] result = params;
		
		if (result == null && this.getChildCount() == 3)
		{
			IParseNode parametersNode = this.getChild(1);
			IParseNode[] parameters = parametersNode.getChildren();
			result = new String[parameters.length];
			
			for (int i = 0; i < parameters.length; i++)
			{
				result[i] = parameters[i].getText();
			}
			
			this.params = result;
		}
		
		return result;
	}

	/**
	 * getSignature
	 *
	 * @return This functions signature, including it's name, if defined
	 */
	public String getSignature()
	{
		SourceWriter sw = new SourceWriter();
		JSParseNode parameters = ((JSParseNode) this.getChild(0));
		
		// output name, if we have one
		if (this.hasAttribute("name")) //$NON-NLS-1$
		{
			sw.print(" "); //$NON-NLS-1$
			sw.print(this.getAttribute("name")); //$NON-NLS-1$
			sw.print(" "); //$NON-NLS-1$
		}

		// open parameter list
		sw.print("("); //$NON-NLS-1$

		// output parameters, if we have any
		if (parameters.isEmpty() == false)
		{
			parameters.getSource(sw);
		}

		// close parameter list
		sw.print(") "); //$NON-NLS-1$
		
		return sw.toString();
	}

	/**
	 * Determine if this function has a name
	 * 
	 * @return boolean
	 */
	public boolean hasFunctionName()
	{
		boolean result = false;

		if (this.getChildCount() == 3)
		{
			result = (this.getChild(0).getTypeIndex() != JSParseNodeTypes.EMPTY);
		}

		return result;
	}
	
	/*
	 * Constructors
	 */

	/**
	 * @param params
	 *            The params to set.
	 */
	public void setParams(String[] params)
	{
		this.params = params;
	}
	
	/**
	 * @see com.aptana.ide.editors.actions.ICanBeNotNavigatable#isNavigatable()
	 */
	public boolean isNavigatable()
	{
		return true;
	}
}