plugins/org.eclipse.ldt.ui/src/org/eclipse/ldt/ui/internal/editor/completion/LuaCompletionProposalLabelProvide.java

/*******************************************************************************
 * Copyright (c) 2013 Sierra Wireless and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Sierra Wireless - initial API and implementation
 *******************************************************************************/
package org.eclipse.ldt.ui.internal.editor.completion;

import org.eclipse.dltk.core.CompletionProposal;
import org.eclipse.dltk.core.IField;
import org.eclipse.dltk.core.ILocalVariable;
import org.eclipse.dltk.core.IMember;
import org.eclipse.dltk.core.IMethod;
import org.eclipse.dltk.core.IModelElement;
import org.eclipse.dltk.core.IType;
import org.eclipse.dltk.core.ModelException;
import org.eclipse.dltk.ui.text.completion.CompletionProposalLabelProvider;
import org.eclipse.dltk.ui.text.completion.ICompletionProposalLabelProviderExtension;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.viewers.StyledString;
import org.eclipse.ldt.core.internal.ast.models.LuaDLTKModelUtils;
import org.eclipse.ldt.ui.internal.Activator;
import org.eclipse.ldt.ui.internal.ImageConstants;
import org.eclipse.ldt.ui.internal.editor.navigation.Messages;

//TODO factorize some code with LuaLabelProvider
public class LuaCompletionProposalLabelProvide extends CompletionProposalLabelProvider implements ICompletionProposalLabelProviderExtension {

	public LuaCompletionProposalLabelProvide() {
	}

	// TODO BUG_ECLIPSE 403751
	protected String createMethodProposalLabel(CompletionProposal methodProposal) {
		StringBuffer buffer = new StringBuffer();

		// method name
		buffer.append(methodProposal.getName());

		// parameters
		buffer.append('(');
		appendParameterList(buffer, methodProposal);
		buffer.append(')');
		IModelElement element = methodProposal.getModelElement();
		if (element != null && element.getElementType() == IModelElement.METHOD && element.exists()) {
			final IMethod method = (IMethod) element;
			try {
				if (!method.isConstructor()) {
					String type = method.getType();
					if (type != null) {
						buffer.append(" : ").append(type); //$NON-NLS-1$
					}
					IType declaringType = method.getDeclaringType();
					if (declaringType != null) {
						buffer.append(" - ").append(declaringType.getElementName()); //$NON-NLS-1$
					}
				}
				// CHECKSTYLE:OFF
			} catch (ModelException e) {
				// ignore
				// CHECKSTYLE:ON
			}
		}

		return buffer.toString();
	}

	// TODO BUG_ECLIPSE 403751
	protected String createSimpleLabelWithType(CompletionProposal proposal) {
		IModelElement element = proposal.getModelElement();

		if (element != null && element.getElementType() == IModelElement.LOCAL_VARIABLE && element.exists()) {
			final ILocalVariable var = (ILocalVariable) element;
			String type = var.getType();
			if (type != null) {
				return proposal.getName() + " : " + type; //$NON-NLS-1$
			}
		}
		return proposal.getName();
	}

	// TODO BUG_ECLIPSE 403751
	protected String createFieldProposalLabel(CompletionProposal proposal) {
		StyledString string = createStyledFieldProposalLabel(proposal);
		return string.toString();
	}

	/**
	 * @see org.eclipse.dltk.ui.text.completion.CompletionProposalLabelProvider#createFieldImageDescriptor(org.eclipse.dltk.core.CompletionProposal)
	 */
	@Override
	protected ImageDescriptor createFieldImageDescriptor(CompletionProposal proposal) {
		if (proposal.getModelElement() instanceof IMember) {
			IMember member = (IMember) proposal.getModelElement();
			try {
				// Special icon for field type
				if (member.exists()) {
					if (LuaDLTKModelUtils.isModuleFunction(member)) {
						return Activator.getDefault().getImageRegistry().getDescriptor(ImageConstants.MODULE_FUNCTION_OBJ16);
					} else if (LuaDLTKModelUtils.isModuleField(member)) {
						return Activator.getDefault().getImageRegistry().getDescriptor(ImageConstants.MODULE_FIELD_OBJ16);
					} else if (LuaDLTKModelUtils.isModuleTable(member)) {
						return Activator.getDefault().getImageRegistry().getDescriptor(ImageConstants.MODULE_TABLE_OBJ16);
					} else if (LuaDLTKModelUtils.isPrivateFunction(member)) {
						return Activator.getDefault().getImageRegistry().getDescriptor(ImageConstants.PRIVATE_FUNCTION_OBJ16);
					} else if (LuaDLTKModelUtils.isPrivateField(member)) {
						return Activator.getDefault().getImageRegistry().getDescriptor(ImageConstants.PRIVATE_FIELD_OBJ16);
					} else if (LuaDLTKModelUtils.isPrivateTable(member)) {
						return Activator.getDefault().getImageRegistry().getDescriptor(ImageConstants.PRIVATE_TABLE_OBJ16);
					} else if (LuaDLTKModelUtils.isPublicFunction(member)) {
						return Activator.getDefault().getImageRegistry().getDescriptor(ImageConstants.PUBLIC_FUNCTION_OBJ16);
					} else if (LuaDLTKModelUtils.isPublicField(member)) {
						return Activator.getDefault().getImageRegistry().getDescriptor(ImageConstants.PUBLIC_FIELD_OBJ16);
					} else if (LuaDLTKModelUtils.isPublicTable(member)) {
						return Activator.getDefault().getImageRegistry().getDescriptor(ImageConstants.PUBLIC_TABLE_OBJ16);
					}
				}
			} catch (ModelException e) {
				Activator.logError(Messages.LuaCompletionProvidersFlags, e);
				return super.createImageDescriptor(proposal);
			}
		}
		return super.createImageDescriptor(proposal);
	}

	/**
	 * @see org.eclipse.dltk.ui.text.completion.CompletionProposalLabelProvider#createTypeImageDescriptor(org.eclipse.dltk.core.CompletionProposal)
	 */
	@Override
	public ImageDescriptor createTypeImageDescriptor(CompletionProposal proposal) {
		if (proposal.getModelElement() instanceof IMember) {
			IMember member = (IMember) proposal.getModelElement();
			try {
				// Special icon for private type
				if (member.exists()) {
					if (LuaDLTKModelUtils.isModule(member)) {
						return Activator.getDefault().getImageRegistry().getDescriptor(ImageConstants.MODULE_OBJ16);
					} else if (LuaDLTKModelUtils.isType(member)) {
						return Activator.getDefault().getImageRegistry().getDescriptor(ImageConstants.TYPE_OBJ16);
					}
				}
			} catch (ModelException e) {
				Activator.logError(Messages.LuaCompletionProvidersFlags, e);
				return super.createImageDescriptor(proposal);
			}
		}
		return super.createImageDescriptor(proposal);
	}

	public StyledString createStyledFieldProposalLabel(CompletionProposal proposal) {
		StyledString result = new StyledString(proposal.getName());
		IModelElement element = proposal.getModelElement();
		if (element != null && element.getElementType() == IModelElement.FIELD && element.exists()) {
			final IField field = (IField) element;
			try {
				String type = field.getType();
				if (type != null) {
					return result.append(new StyledString(" : " + type, StyledString.DECORATIONS_STYLER)); //$NON-NLS-1$
				}
				// CHECKSTYLE:OFF
			} catch (ModelException e) {
				// ignore
				// CHECKSTYLE:ON
			}
		}
		return result;
	}

	@Override
	public StyledString createStyledLabel(CompletionProposal fProposal) {
		return new StyledString(createLabel(fProposal));
	}

	@Override
	public StyledString createStyledKeywordLabel(CompletionProposal proposal) {
		return new StyledString(createKeywordLabel(proposal));
	}

	@Override
	public StyledString createStyledSimpleLabel(CompletionProposal proposal) {
		return new StyledString(createSimpleLabel(proposal));
	}

	@Override
	public StyledString createStyledTypeProposalLabel(CompletionProposal proposal) {
		return new StyledString(createTypeProposalLabel(proposal));
	}

	@Override
	public StyledString createStyledSimpleLabelWithType(CompletionProposal proposal) {
		return new StyledString(createSimpleLabelWithType(proposal));
	}
}