/*
 This file belongs to the Servoy development and deployment environment, Copyright (C) 1997-2010 Servoy BV

 This program is free software; you can redistribute it and/or modify it under
 the terms of the GNU Affero 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 Affero General Public License for more details.

 You should have received a copy of the GNU Affero General Public License along
 with this program; if not, see http://www.gnu.org/licenses or write to the Free
 Software Foundation,Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
 */
package com.servoy.j2db.persistence;

import com.servoy.base.scripting.annotations.ServoyClientSupport;
import com.servoy.j2db.documentation.ServoyDocumented;
import com.servoy.j2db.util.ScopesUtils;
import com.servoy.j2db.util.UUID;


/**
 * A script method
 *
 * @author jblok
 */
@ServoyDocumented(category = ServoyDocumented.DESIGNTIME, publicName = "Method", typeCode = IRepository.METHODS)
@ServoyClientSupport(mc = true, wc = true, sc = true)
@SuppressWarnings("nls")
public class ScriptMethod extends AbstractScriptProvider implements IPersistCloneable, ICloneable
{

	private static final long serialVersionUID = 1L;

	private transient Boolean isPrivate;
	private transient Boolean isProtected;
	private transient Boolean isConstructor;

	/**
	 * Constructor I
	 */
	ScriptMethod(ISupportChilds parent, int element_id, UUID uuid)
	{
		super(IRepository.METHODS, parent, element_id, uuid);
	}

	public void setShowInMenu(boolean arg)
	{
		setTypedProperty(StaticContentSpecLoader.PROPERTY_SHOWINMENU, arg);
	}

	/**
	 * Flag that tells if the method appears or not in the "Methods" menu of Servoy Client.
	 */
	public boolean getShowInMenu()
	{
		return getTypedProperty(StaticContentSpecLoader.PROPERTY_SHOWINMENU).booleanValue();
	}


	public String getPrefixedName()
	{
		if (getParent() instanceof Solution)
		{
			return ScopesUtils.getScopeString(this);
		}
		return getName();
	}

	// declaration, name, scopeName overrides - needed for docs mc annotation
	@Override
	public String getDeclaration()
	{
		return super.getDeclaration();
	}

	@Override
	public void setDeclaration(String declaration)
	{
		super.setDeclaration(declaration);
		isPrivate = null;
		isProtected = null;
		isConstructor = null;
	}

	@Override
	public String getName()
	{
		return super.getName();
	}

	@Override
	public void setName(String arg)
	{
		super.setName(arg);
	}

	@Override
	public String getScopeName()
	{
		return super.getScopeName();
	}

	@Override
	public void setScopeName(String scopeName)
	{
		super.setScopeName(scopeName);
	}

	/**
	 * @return
	 */
	public boolean isPrivate()
	{
		Boolean priv = isPrivate;
		if (priv == null)
		{
			String declaration = getDeclaration();
			if (declaration == null)
			{
				priv = Boolean.FALSE;
			}
			else
			{
				int index = declaration.indexOf("*/");
				priv = Boolean.valueOf(index != -1 && declaration.lastIndexOf("@private", index) != -1);
			}
			isPrivate = priv;
		}
		return priv.booleanValue();
	}

	public boolean isProtected()
	{
		if (isPrivate()) return false;
		Boolean prot = isProtected;
		if (prot == null)
		{
			String declaration = getDeclaration();
			if (declaration == null)
			{
				prot = Boolean.FALSE;
			}
			else
			{
				int index = declaration.indexOf("*/");
				prot = Boolean.valueOf(index != -1 && declaration.lastIndexOf("@protected", index) != -1);
			}
			isProtected = prot;
		}
		return prot.booleanValue();
	}

	public boolean isConstructor()
	{
		Boolean constructor = isConstructor;
		if (constructor == null)
		{
			String declaration = getDeclaration();
			if (declaration == null)
			{
				constructor = Boolean.FALSE;
			}
			else
			{
				int index = declaration.indexOf("*/");
				constructor = Boolean.valueOf(index != -1 && declaration.lastIndexOf("@constructor", index) != -1);
			}
			isConstructor = constructor;
		}
		return constructor.booleanValue();
	}


	@Override
	public String toString()
	{
		return "ScriptMethod[name:" + (getParent() instanceof Solution ? ScopesUtils.getScopeString(this) : getName()) + ", inmenu:" + getShowInMenu() + "]"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
	}
}