EntryBasedType.java

/**
 * Aptana Studio
 * Copyright (c) 2005-2011 by Appcelerator, Inc. All Rights Reserved.
 * Licensed under the terms of the GNU Public License (GPL) v3 (with exceptions).
 * Please see the license.html included with this distribution for details.
 * Any modifications to this file must keep this entire header intact.
 */
package com.aptana.editor.php.internal.model.impl;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import org2.eclipse.php.core.compiler.PHPFlags;

import com.aptana.editor.php.core.model.IField;
import com.aptana.editor.php.core.model.IMethod;
import com.aptana.editor.php.core.model.IModelElement;
import com.aptana.editor.php.core.model.ISourceRange;
import com.aptana.editor.php.core.model.IType;
import com.aptana.editor.php.core.model.env.ModelElementInfo;
import com.aptana.editor.php.indexer.EntryUtils;
import com.aptana.editor.php.indexer.IElementEntry;
import com.aptana.editor.php.indexer.PHPGlobalIndexer;
import com.aptana.editor.php.internal.indexer.ClassPHPEntryValue;
import com.aptana.editor.php.internal.model.impl.env.SourceTypeElementInfo;
import com.aptana.editor.php.internal.model.utils.ModelUtils;
import com.aptana.editor.php.internal.model.utils.TypeHierarchyUtils;
import com.aptana.editor.php.internal.model.utils.TypeUtils;

/**
 * EntryBasedType
 * 
 * @author Denis Denisenko
 */
public class EntryBasedType extends AbstractMember implements IType
{
	/**
	 * Entry value.
	 */
	private ClassPHPEntryValue entryValue;

	/**
	 * EntryBasedType constructor.
	 * 
	 * @param typeEntry
	 *            - type entry.
	 */
	public EntryBasedType(IElementEntry typeEntry)
	{
		super(typeEntry);

		if (!EntryUtils.isType(typeEntry))
		{
			throw new IllegalArgumentException("type entry required"); //$NON-NLS-1$
		}

		this.entryValue = (ClassPHPEntryValue) typeEntry.getValue();
	}

	/**
	 * {@inheritDoc}
	 */
	public IField getField(String fieldName)
	{
		List<IField> fields = getFields();
		for (IField field : fields)
		{
			if (fieldName.equals(field.getElementName()))
			{
				return field;
			}
		}

		return null;
	}

	/**
	 * {@inheritDoc}
	 */
	public List<IField> getFields()
	{
		List<IElementEntry> fieldEntries = TypeUtils.getFields(getEntry());
		List<IModelElement> converted = ModelUtils.convertEntries(fieldEntries);
		List<IField> result = new ArrayList<IField>();
		for (IModelElement element : converted)
		{
			if (element instanceof IField)
			{
				result.add((IField) element);
			}
		}

		return result;
	}

	/**
	 * {@inheritDoc}
	 */
	public List<String> getInterfaceNames()
	{
		return entryValue.getInterfaces();
	}

	/**
	 * {@inheritDoc}
	 */
	public List<IType> getInterfaces()
	{
		List<String> interfaceNames = getInterfaceNames();
		if (interfaceNames == null || interfaceNames.size() == 0)
		{
			return Collections.emptyList();
		}

		List<IElementEntry> ancestors = TypeHierarchyUtils.getDirectClassAncestors(getEntry().getModule(),
				getElementName(), PHPGlobalIndexer.getInstance().getIndex());

		List<IType> result = new ArrayList<IType>();
		for (IElementEntry entry : ancestors)
		{
			if (EntryUtils.isInterface(entry))
			{
				result.add((IType) ModelUtils.convertEntry(entry));
			}
		}

		return result;
	}

	/**
	 * {@inheritDoc}
	 */
	public List<IMethod> getMethods()
	{
		List<IElementEntry> methodEntries = TypeUtils.getMethods(getEntry());
		List<IModelElement> converted = ModelUtils.convertEntries(methodEntries);
		List<IMethod> result = new ArrayList<IMethod>();
		for (IModelElement element : converted)
		{
			if (element instanceof IMethod)
			{
				result.add((IMethod) element);
			}
		}

		return result;
	}

	/**
	 * {@inheritDoc}
	 */
	public List<IMethod> getMethods(String methodName)
	{
		List<IMethod> methods = getMethods();
		List<IMethod> result = new ArrayList<IMethod>();
		for (IMethod method : methods)
		{
			if (methodName.equals(method.getElementName()))
			{
				result.add(method);
			}
		}

		return result;
	}

	/**
	 * {@inheritDoc}
	 */
	public boolean isInterface()
	{
		return PHPFlags.isInterface(entryValue.getModifiers());
	}

	/**
	 * {@inheritDoc}
	 */
	public int getFlags()
	{
		return entryValue.getModifiers();
	}

	/**
	 * {@inheritDoc}
	 */
	public ISourceRange getNameRange()
	{
		// TODO add name length
		return new SourceRange(entryValue.getStartOffset());
	}

	/**
	 * {@inheritDoc}
	 */
	public int getElementType()
	{
		return TYPE;
	}

	/**
	 * {@inheritDoc}
	 */
	public List<IType> getSuperClasses()
	{
		List<String> superClassNames = getSuperClassNames();
		if (superClassNames == null || superClassNames.size() == 0)
		{
			return null;
		}

		List<IElementEntry> ancestors = TypeHierarchyUtils.getDirectClassAncestors(getEntry().getModule(),
				getElementName(), PHPGlobalIndexer.getInstance().getIndex());

		for (IElementEntry entry : ancestors)
		{
			if (!EntryUtils.isInterface(entry))
			{
				List<IType> result = new ArrayList<IType>();
				result.add((IType) ModelUtils.convertEntry(entry));
				return result;
			}
		}

		return null;
	}

	/**
	 * {@inheritDoc}
	 */
	public List<String> getSuperClassNames()
	{
		String superClassName = entryValue.getSuperClassname();
		if (superClassName == null)
		{
			return Collections.emptyList();
		}
		List<String> result = new ArrayList<String>();
		result.add(superClassName);

		return result;
	}

	/**
	 * {@inheritDoc}
	 */
	public List<IType> getSuperTypes()
	{
		List<String> interfaceNames = getInterfaceNames();
		List<String> superClassNames = getSuperClassNames();

		if ((interfaceNames == null || interfaceNames.size() == 0)
				&& (superClassNames == null || superClassNames.size() == 0))
		{
			return Collections.emptyList();
		}

		List<IElementEntry> ancestors = TypeHierarchyUtils.getDirectClassAncestors(getEntry().getModule(),
				getElementName(), PHPGlobalIndexer.getInstance().getIndex());

		List<IType> result = new ArrayList<IType>();
		for (IElementEntry entry : ancestors)
		{
			result.add((IType) ModelUtils.convertEntry(entry));
		}

		return result;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String toString()
	{
		return getElementName();
	}

	/**
	 * {@inheritDoc}
	 */
	public ModelElementInfo getElementInfo()
	{
		SourceTypeElementInfo info = new SourceTypeElementInfo();
		info.setFlags(getFlags());
		info.setNameSourceStart(getSourceRange().getOffset());

		List<IModelElement> children = getChildren();
		if (children != null && children.size() != 0)
		{
			info.setChildren(children);
		}

		List<String> superClassNames = getSuperClassNames();
		if (superClassNames != null && superClassNames.size() != 0)
		{
			info.setSuperclassNames(superClassNames.toArray(new String[superClassNames.size()]));
		}

		return info;
	}
}