/*******************************************************************************
* Copyright (c) 2005, 2008 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.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.TextUtilities;
import org.eclipse.jface.text.templates.TemplateContextType;
import org.eclipse.wst.jsdt.core.IJavaScriptUnit;
import org.eclipse.wst.jsdt.internal.corext.template.java.JavaContextType;
import org.eclipse.wst.jsdt.internal.corext.template.java.JavaDocContextType;
import org.eclipse.wst.jsdt.internal.ui.JavaScriptPlugin;
import org.eclipse.wst.jsdt.internal.ui.text.template.contentassist.TemplateEngine;
import org.eclipse.wst.jsdt.internal.ui.text.template.contentassist.TemplateProposal;
import org.eclipse.wst.jsdt.ui.text.IJavaScriptPartitions;
import org.eclipse.wst.jsdt.ui.text.java.ContentAssistInvocationContext;
import org.eclipse.wst.jsdt.ui.text.java.IJavaCompletionProposal;
import org.eclipse.wst.jsdt.ui.text.java.IJavaCompletionProposalComputer;
import org.eclipse.wst.jsdt.ui.text.java.JavaContentAssistInvocationContext;
/**
*
*
*/
public final class TemplateCompletionProposalComputer implements IJavaCompletionProposalComputer {
private final TemplateEngine fJavaTemplateEngine;
private final TemplateEngine fJavadocTemplateEngine;
public TemplateCompletionProposalComputer() {
TemplateContextType contextType= JavaScriptPlugin.getDefault().getTemplateContextRegistry().getContextType(JavaContextType.NAME);
if (contextType == null) {
contextType= new JavaContextType();
JavaScriptPlugin.getDefault().getTemplateContextRegistry().addContextType(contextType);
}
if (contextType != null)
fJavaTemplateEngine= new TemplateEngine(contextType);
else
fJavaTemplateEngine= null;
contextType= JavaScriptPlugin.getDefault().getTemplateContextRegistry().getContextType("javadoc"); //$NON-NLS-1$
if (contextType == null) {
contextType= new JavaDocContextType();
JavaScriptPlugin.getDefault().getTemplateContextRegistry().addContextType(contextType);
}
if (contextType != null)
fJavadocTemplateEngine= new TemplateEngine(contextType);
else
fJavadocTemplateEngine= null;
}
/*
* @see org.eclipse.jface.text.contentassist.ICompletionProposalComputer#computeCompletionProposals(org.eclipse.jface.text.contentassist.TextContentAssistInvocationContext, org.eclipse.core.runtime.IProgressMonitor)
*/
public List computeCompletionProposals(ContentAssistInvocationContext context, IProgressMonitor monitor) {
TemplateEngine engine;
try {
String partition= TextUtilities.getContentType(context.getDocument(), IJavaScriptPartitions.JAVA_PARTITIONING, context.getInvocationOffset(), true);
if (partition.equals(IJavaScriptPartitions.JAVA_DOC))
engine= fJavadocTemplateEngine;
else
engine= fJavaTemplateEngine;
} catch (BadLocationException x) {
return Collections.EMPTY_LIST;
}
if (engine != null) {
if (!(context instanceof JavaContentAssistInvocationContext))
return Collections.EMPTY_LIST;
JavaContentAssistInvocationContext javaContext= (JavaContentAssistInvocationContext) context;
IJavaScriptUnit unit= javaContext.getCompilationUnit();
if (unit == null)
return Collections.EMPTY_LIST;
engine.reset();
engine.complete(javaContext.getViewer(), javaContext.getInvocationOffset(), unit);
TemplateProposal[] templateProposals= engine.getResults();
List result= new ArrayList(Arrays.asList(templateProposals));
IJavaCompletionProposal[] keyWordResults= javaContext.getKeywordProposals();
if (keyWordResults.length > 0) {
List removals= new ArrayList();
// update relevance of template proposals that match with a keyword
// give those templates slightly more relevance than the keyword to
// sort them first
// remove keyword templates that don't have an equivalent
// keyword proposal
if (keyWordResults.length > 0) {
outer: for (int k= 0; k < templateProposals.length; k++) {
TemplateProposal curr= templateProposals[k];
String name= curr.getTemplate().getName();
for (int i= 0; i < keyWordResults.length; i++) {
String keyword= keyWordResults[i].getDisplayString();
if (name.startsWith(keyword)) {
curr.setRelevance(keyWordResults[i].getRelevance() + 1);
continue outer;
}
}
if (isKeyword(name))
removals.add(curr);
}
}
result.removeAll(removals);
}
return result;
}
return Collections.EMPTY_LIST;
}
/*
* @see org.eclipse.jface.text.contentassist.ICompletionProposalComputer#computeContextInformation(org.eclipse.jface.text.contentassist.TextContentAssistInvocationContext, org.eclipse.core.runtime.IProgressMonitor)
*/
public List computeContextInformation(ContentAssistInvocationContext context, IProgressMonitor monitor) {
return Collections.EMPTY_LIST;
}
private static final Set KEYWORDS;
static {
Set keywords= new HashSet(42);
keywords.add("abstract"); //$NON-NLS-1$
keywords.add("assert"); //$NON-NLS-1$
keywords.add("break"); //$NON-NLS-1$
keywords.add("case"); //$NON-NLS-1$
keywords.add("catch"); //$NON-NLS-1$
keywords.add("class"); //$NON-NLS-1$
keywords.add("continue"); //$NON-NLS-1$
keywords.add("default"); //$NON-NLS-1$
keywords.add("do"); //$NON-NLS-1$
keywords.add("else"); //$NON-NLS-1$
keywords.add("elseif"); //$NON-NLS-1$
keywords.add("extends"); //$NON-NLS-1$
keywords.add("final"); //$NON-NLS-1$
keywords.add("finally"); //$NON-NLS-1$
keywords.add("for"); //$NON-NLS-1$
keywords.add("if"); //$NON-NLS-1$
keywords.add("implements"); //$NON-NLS-1$
keywords.add("import"); //$NON-NLS-1$
keywords.add("instanceof"); //$NON-NLS-1$
keywords.add("interface"); //$NON-NLS-1$
keywords.add("native"); //$NON-NLS-1$
keywords.add("new"); //$NON-NLS-1$
keywords.add("package"); //$NON-NLS-1$
keywords.add("private"); //$NON-NLS-1$
keywords.add("protected"); //$NON-NLS-1$
keywords.add("public"); //$NON-NLS-1$
keywords.add("return"); //$NON-NLS-1$
keywords.add("static"); //$NON-NLS-1$
keywords.add("strictfp"); //$NON-NLS-1$
keywords.add("super"); //$NON-NLS-1$
keywords.add("switch"); //$NON-NLS-1$
keywords.add("synchronized"); //$NON-NLS-1$
keywords.add("this"); //$NON-NLS-1$
keywords.add("throw"); //$NON-NLS-1$
keywords.add("throws"); //$NON-NLS-1$
keywords.add("transient"); //$NON-NLS-1$
keywords.add("try"); //$NON-NLS-1$
keywords.add("volatile"); //$NON-NLS-1$
keywords.add("while"); //$NON-NLS-1$
keywords.add("true"); //$NON-NLS-1$
keywords.add("false"); //$NON-NLS-1$
keywords.add("null"); //$NON-NLS-1$
KEYWORDS= Collections.unmodifiableSet(keywords);
}
private boolean isKeyword(String name) {
return KEYWORDS.contains(name);
}
/*
* @see org.eclipse.jface.text.contentassist.ICompletionProposalComputer#getErrorMessage()
*/
public String getErrorMessage() {
return null;
}
/*
* @see org.eclipse.wst.jsdt.ui.text.java.IJavaCompletionProposalComputer#sessionStarted()
*/
public void sessionStarted() {
}
/*
* @see org.eclipse.wst.jsdt.ui.text.java.IJavaCompletionProposalComputer#sessionEnded()
*/
public void sessionEnded() {
fJavadocTemplateEngine.reset();
fJavaTemplateEngine.reset();
}
}