content: /*******************************************************************************
   * Copyright (c) 2000, 2009 IBM Corporation 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:
   *     IBM Corporation - initial API and implementation
   *******************************************************************************/
  package org.eclipse.wst.jsdt.internal.ui.text.java;
  
  import java.util.Collection;
  import java.util.Set;
  
  import org.eclipse.core.runtime.Assert;
  import org.eclipse.core.runtime.CoreException;
  import org.eclipse.core.runtime.IStatus;
  import org.eclipse.jface.resource.ImageDescriptor;
  import org.eclipse.jface.text.BadLocationException;
  import org.eclipse.jface.text.IDocument;
  import org.eclipse.jface.text.IRegion;
  import org.eclipse.jface.text.TextUtilities;
  import org.eclipse.jface.text.contentassist.ICompletionProposalExtension4;
  import org.eclipse.wst.jsdt.core.IFunction;
  import org.eclipse.wst.jsdt.core.IType;
  import org.eclipse.wst.jsdt.core.JavaScriptConventions;
  import org.eclipse.wst.jsdt.core.Signature;
  import org.eclipse.wst.jsdt.core.dom.rewrite.ImportRewrite;
  import org.eclipse.wst.jsdt.core.formatter.CodeFormatter;
  import org.eclipse.wst.jsdt.internal.corext.codemanipulation.CodeGenerationSettings;
  import org.eclipse.wst.jsdt.internal.corext.util.CodeFormatterUtil;
  import org.eclipse.wst.jsdt.internal.corext.util.Strings;
  import org.eclipse.wst.jsdt.internal.ui.JavaScriptPlugin;
  import org.eclipse.wst.jsdt.internal.ui.JavaPluginImages;
  import org.eclipse.wst.jsdt.internal.ui.preferences.JavaPreferencesSettings;
  import org.eclipse.wst.jsdt.internal.ui.viewsupport.JavaElementImageProvider;
  import org.eclipse.wst.jsdt.ui.CodeGeneration;
  import org.eclipse.wst.jsdt.ui.JavaScriptElementImageDescriptor;
  
  /**
   * Method declaration proposal.
   */
  public class MethodDeclarationCompletionProposal extends JavaTypeCompletionProposal implements ICompletionProposalExtension4 {
  
  
  	public static void evaluateProposals(IType type, String prefix, int offset, int length, int relevance, Set suggestedMethods, Collection result) throws CoreException {
  		IFunction[] methods= type.getFunctions();
  		String constructorName= type.getElementName();
  		if (constructorName.length() > 0 && constructorName.startsWith(prefix) && !hasMethod(methods, constructorName) && suggestedMethods.add(constructorName)) {
  			result.add(new MethodDeclarationCompletionProposal(type, constructorName, null, offset, length, relevance + 500));
  		}
  		
  		if (prefix.length() > 0 && !"main".equals(prefix) && !hasMethod(methods, prefix) && suggestedMethods.add(prefix)) { //$NON-NLS-1$
  			if (!JavaScriptConventions.validateFunctionName(prefix).matches(IStatus.ERROR)) {
  				result.add(new MethodDeclarationCompletionProposal(type, prefix, Signature.SIG_VOID, offset, length, relevance));
  			}
  		}
  	}
  
  	private static boolean hasMethod(IFunction[] methods, String name) {
  		for (int i= 0; i < methods.length; i++) {
  			IFunction curr= methods[i];
  			if (curr.getElementName().equals(name) && curr.getParameterTypes().length == 0) {
  				return true;
  			}
  		}
  		return false;
  	}
  
  	private final IType fType;
  	private final String fReturnTypeSig;
  	private final String fMethodName;
  
  	public MethodDeclarationCompletionProposal(IType type, String methodName, String returnTypeSig, int start, int length, int relevance) {
  		super("", type.getJavaScriptUnit(), start, length, null, getDisplayName(methodName, returnTypeSig), relevance); //$NON-NLS-1$
  		Assert.isNotNull(type);
  		Assert.isNotNull(methodName);
  
  		fType= type;
  		fMethodName= methodName;
  		fReturnTypeSig= returnTypeSig;
  
  		if (returnTypeSig == null) {
  			setProposalInfo(new ProposalInfo(type));
  
  			ImageDescriptor desc= new JavaScriptElementImageDescriptor(JavaPluginImages.DESC_MISC_PUBLIC, JavaScriptElementImageDescriptor.CONSTRUCTOR, JavaElementImageProvider.SMALL_SIZE);
  			setImage(JavaScriptPlugin.getImageDescriptorRegistry().get(desc));
  		} else {
  			setImage(JavaPluginImages.get(JavaPluginImages.IMG_MISC_PRIVATE));
  		}
  	}
  
  	private static String getDisplayName(String methodName, String returnTypeSig) {
  		StringBuffer buf= new StringBuffer();
  		buf.append(methodName);
  		buf.append('(');
  		buf.append(')');
  		if (returnTypeSig != null) {
  			buf.append("  "); //$NON-NLS-1$
  			buf.append(Signature.toString(returnTypeSig));
  			buf.append(" - "); //$NON-NLS-1$
  			buf.append(JavaTextMessages.MethodCompletionProposal_method_label);
  		} else {
  			buf.append(" - "); //$NON-NLS-1$
  			buf.append(JavaTextMessages.MethodCompletionProposal_constructor_label);
  		}
  		return buf.toString();
  	}
  
  	/* (non-Javadoc)
  	 * @see JavaTypeCompletionProposal#updateReplacementString(IDocument, char, int, ImportRewrite)
  	 */
  	protected boolean updateReplacementString(IDocument document, char trigger, int offset, ImportRewrite impRewrite) throws CoreException, BadLocationException {
  
  		CodeGenerationSettings settings= JavaPreferencesSettings.getCodeGenerationSettings(fType.getJavaScriptProject());
  		boolean addComments= settings.createComments;
  
  		String[] empty= new String[0];
  		String lineDelim= TextUtilities.getDefaultLineDelimiter(document);
  		String declTypeName= fType.getTypeQualifiedName('.');
  
  		StringBuffer buf= new StringBuffer();
  		if (addComments) {
  			String comment= CodeGeneration.getMethodComment(fType.getJavaScriptUnit(), declTypeName, fMethodName, empty, empty, fReturnTypeSig, null, lineDelim);
  			if (comment != null) {
  				buf.append(comment);
  				buf.append(lineDelim);
  			}
  		}
  		if (fReturnTypeSig != null) {
  			buf.append("private "); //$NON-NLS-1$
  		} else {
  			buf.append("public "); //$NON-NLS-1$
  		}
  
  		if (fReturnTypeSig != null) {
  			buf.append(Signature.toString(fReturnTypeSig));
  		}
  		buf.append(' ');
  		buf.append(fMethodName);
  		
  		buf.append("() {"); //$NON-NLS-1$
  		buf.append(lineDelim);
  
  		String body= CodeGeneration.getMethodBodyContent(fType.getJavaScriptUnit(), declTypeName, fMethodName, fReturnTypeSig == null, "", lineDelim); //$NON-NLS-1$
  		if (body != null) {
  			buf.append(body);
  			buf.append(lineDelim);
  		}
  		buf.append("}"); //$NON-NLS-1$
  		buf.append(lineDelim);
  		
  		String stub=  buf.toString();
  
  		// use the code formatter
  		IRegion region= document.getLineInformationOfOffset(getReplacementOffset());
  		int lineStart= region.getOffset();
  		int indent= Strings.computeIndentUnits(document.get(lineStart, getReplacementOffset() - lineStart), settings.tabWidth, settings.indentWidth);
  
  		String replacement= CodeFormatterUtil.format(CodeFormatter.K_CLASS_BODY_DECLARATIONS, stub, indent, null, lineDelim, fType.getJavaScriptProject());
  
  		if (replacement.endsWith(lineDelim)) {
  			replacement= replacement.substring(0, replacement.length() - lineDelim.length());
  		}
  
  		setReplacementString(Strings.trimLeadingTabsAndSpaces(replacement));
  		return true;
  	}
  
  	public CharSequence getPrefixCompletionText(IDocument document, int completionOffset) {
  		return new String(); // don't let method stub proposals complete incrementally
  	}
  
  	/*
  	 * @see org.eclipse.jface.text.contentassist.ICompletionProposalExtension4#isAutoInsertable()
  	 */
  	public boolean isAutoInsertable() {
  		return false;
  	}
  }
  