Attachment #212588 for bug #350991

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.




<?xml version='1.0' encoding='UTF-8'?>
<!-- Schema file written by PDE -->
<schema targetNamespace="org.eclipse.jdt.ui" xmlns="http://www.w3.org/2001/XMLSchema">
<annotation>
      <appInfo>
         <meta.schema plugin="org.eclipse.jdt.ui" id="javaCompletionProposalComputer" name="Java Completion Proposal Computer"/>

               </appInfo>
            </annotation>
         </attribute>
         <attribute name="needsSortingAfterFiltering" type="boolean" use="default" value="false">
            <annotation>
               <documentation>
                  if the attribute is set to &quot;true&quot; it forces the content assist processor to resort the list of proposals every time a new token is entered or removed to the completion prefix.

@since 3.8
               </documentation>
            </annotation>
         </attribute>
      </complexType>
   </element>


Lines 8-13 Link Here

(-)a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/java/CompletionProposalCategory.java (-1 / +24 lines)
8	* Contributors:	8	* Contributors:
9	* IBM Corporation - initial API and implementation	9	* IBM Corporation - initial API and implementation
10	* Paul Fullbright <paul.fullbright@oracle.com> - content assist category enablement - http://bugs.eclipse.org/345213	10	* Paul Fullbright <paul.fullbright@oracle.com> - content assist category enablement - http://bugs.eclipse.org/345213
		11	* Marcel Bruch <bruch@cs.tu-darmstadt.de> - [content assist] Allow to re-sort proposals - https://bugs.eclipse.org/bugs/show_bug.cgi?id=350991
11	*******************************************************************************/	12	*******************************************************************************/
12	package org.eclipse.jdt.internal.ui.text.java;	13	package org.eclipse.jdt.internal.ui.text.java;
13		14
Lines 75-80 Link Here
75		76
76	private int fSortOrder= 0xffff - 1;	77	private int fSortOrder= 0xffff - 1;
77	private String fLastError= null;	78	private String fLastError= null;
		79
		80	/**
		81	* Flag indicating whether any completion engine associated with this category requests
		82	* resorting of its proposals after filtering is triggered. Filtering is, e.g., triggered when a
		83	* user continues typing with an open completion window.
		84	*
		85	* @since 3.8
		86	*/
		87	private boolean fNeedsSortingAfterFiltering;
78		88
79	CompletionProposalCategory(IConfigurationElement element, CompletionProposalComputerRegistry registry) throws CoreException {	89	CompletionProposalCategory(IConfigurationElement element, CompletionProposalComputerRegistry registry) throws CoreException {
80	fElement= element;	90	fElement= element;
Lines 365-372 Link Here
365	List<CompletionProposalComputerDescriptor> descriptors= new ArrayList<CompletionProposalComputerDescriptor>(fRegistry.getProposalComputerDescriptors());	375	List<CompletionProposalComputerDescriptor> descriptors= new ArrayList<CompletionProposalComputerDescriptor>(fRegistry.getProposalComputerDescriptors());
366	for (Iterator<CompletionProposalComputerDescriptor> it= descriptors.iterator(); it.hasNext();) {	376	for (Iterator<CompletionProposalComputerDescriptor> it= descriptors.iterator(); it.hasNext();) {
367	CompletionProposalComputerDescriptor desc= it.next();	377	CompletionProposalComputerDescriptor desc= it.next();
368	if (desc.getCategory() == this)	378	if (desc.getCategory() == this){
369	desc.sessionStarted();	379	desc.sessionStarted();
		380	fNeedsSortingAfterFiltering= fNeedsSortingAfterFiltering \|\| desc.isSortingAfterFilteringNeeded();
		381	}
370	if (fLastError == null)	382	if (fLastError == null)
371	fLastError= desc.getErrorMessage();	383	fLastError= desc.getErrorMessage();
372	}	384	}
Lines 376-381 Link Here
376	* Notifies the computers in this category of a proposal computation session end.	388	* Notifies the computers in this category of a proposal computation session end.
377	*/	389	*/
378	public void sessionEnded() {	390	public void sessionEnded() {
		391	fNeedsSortingAfterFiltering= false;
379	List<CompletionProposalComputerDescriptor> descriptors= new ArrayList<CompletionProposalComputerDescriptor>(fRegistry.getProposalComputerDescriptors());	392	List<CompletionProposalComputerDescriptor> descriptors= new ArrayList<CompletionProposalComputerDescriptor>(fRegistry.getProposalComputerDescriptors());
380	for (Iterator<CompletionProposalComputerDescriptor> it= descriptors.iterator(); it.hasNext();) {	393	for (Iterator<CompletionProposalComputerDescriptor> it= descriptors.iterator(); it.hasNext();) {
381	CompletionProposalComputerDescriptor desc= it.next();	394	CompletionProposalComputerDescriptor desc= it.next();
Lines 386-389 Link Here
386	}	399	}
387	}	400	}
388		401
		402	/**
		403	* Returns whether any completion proposal computer associated with this category requires
		404	* proposals to be sorted again after filtering.
		405	*
		406	* @return <code>true</code> if any completion proposal computer in this category requires
		407	* proposals to be sorted.
		408	*/
		409	public boolean isSortingAfterFilteringNeeded() {
		410	return fNeedsSortingAfterFiltering;
		411	}
389	}	412	}

Lines 1-5 Link Here

(-)a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/java/CompletionProposalComputerDescriptor.java (-1 / +25 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2005, 2011 IBM Corporation and others.	2	* Copyright (c) 2005, 2012 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials	3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0	4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at	5	* which accompanies this distribution, and is available at
Lines 7-12 Link Here
7	*	7	*
8	* Contributors:	8	* Contributors:
9	* IBM Corporation - initial API and implementation	9	* IBM Corporation - initial API and implementation
		10	* Marcel Bruch <bruch@cs.tu-darmstadt.de> - [content assist] Allow to re-sort proposals - https://bugs.eclipse.org/bugs/show_bug.cgi?id=350991
10	*******************************************************************************/	11	*******************************************************************************/
11	package org.eclipse.jdt.internal.ui.text.java;	12	package org.eclipse.jdt.internal.ui.text.java;
12		13
Lines 61-66 Link Here
61	private static final String CLASS= "class"; //$NON-NLS-1$	62	private static final String CLASS= "class"; //$NON-NLS-1$
62	/** The extension schema name of the activate attribute. */	63	/** The extension schema name of the activate attribute. */
63	private static final String ACTIVATE= "activate"; //$NON-NLS-1$	64	private static final String ACTIVATE= "activate"; //$NON-NLS-1$
		65	/** The extension schema name of the needsSortingAfterFiltering attribute. */
		66	private static final String NEEDS_SORTING_AFTER_FILTERING= "needsSortingAfterFiltering"; //$NON-NLS-1$
64	/** The extension schema name of the partition child elements. */	67	/** The extension schema name of the partition child elements. */
65	private static final String PARTITION= "partition"; //$NON-NLS-1$	68	private static final String PARTITION= "partition"; //$NON-NLS-1$
66	/** Set of Java partition types. */	69	/** Set of Java partition types. */
Lines 131-136 Link Here
131	* @since 3.4	134	* @since 3.4
132	*/	135	*/
133	boolean fTriedLoadingComputer= false;	136	boolean fTriedLoadingComputer= false;
		137
		138	/**
		139	* Tells whether this proposal engine provides dynamic content that needs to be sorted after its
		140	* proposal have been filtered. Filtering happens, e.g., when a user continues typing with an
		141	* open completion window.
		142	*
		143	* @since 3.8
		144	*/
		145	private boolean fNeedsSortingAfterFiltering;
134		146
135		147
136	/**	148	/**
Lines 173-178 Link Here
173		185
174	String activateAttribute= element.getAttribute(ACTIVATE);	186	String activateAttribute= element.getAttribute(ACTIVATE);
175	fActivate= Boolean.valueOf(activateAttribute).booleanValue();	187	fActivate= Boolean.valueOf(activateAttribute).booleanValue();
		188
		189	String needsSortingAfterFilteringAttribute= element.getAttribute(NEEDS_SORTING_AFTER_FILTERING);
		190	fNeedsSortingAfterFiltering= Boolean.valueOf(needsSortingAfterFilteringAttribute).booleanValue();
176		191
177	fClass= element.getAttribute(CLASS);	192	fClass= element.getAttribute(CLASS);
178	checkNotNull(fClass, CLASS);	193	checkNotNull(fClass, CLASS);
Lines 564-567 Link Here
564	}	579	}
565	}	580	}
566		581
		582	/**
		583	* Returns the <code>needsSortingAfterFiltering</code> flag of the described extension.
		584	*
		585	* @return the needsSortingAfterFiltering flag of the described extension
		586	* @since 3.8
		587	*/
		588	public boolean isSortingAfterFilteringNeeded() {
		589	return fNeedsSortingAfterFiltering;
		590	}
567	}	591	}




 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     Paul Fullbright <paul.fullbright@oracle.com> - content assist category enablement - http://bugs.eclipse.org/345213
 *     Marcel Bruch <bruch@cs.tu-darmstadt.de> - [content assist] Allow to re-sort proposals - https://bugs.eclipse.org/bugs/show_bug.cgi?id=350991
 *******************************************************************************/
package org.eclipse.jdt.internal.ui.text.java;


import org.eclipse.swt.widgets.Shell;

import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.InvalidRegistryObjectException;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.SubProgressMonitor;

import org.eclipse.jdt.internal.corext.util.Messages;

import org.eclipse.jdt.ui.PreferenceConstants;
import org.eclipse.jdt.ui.text.java.AbstractProposalSorter;
import org.eclipse.jdt.ui.text.java.ContentAssistInvocationContext;

import org.eclipse.jdt.internal.ui.JavaPlugin;

	 * @return the list of proposals
	 */
	private List<ICompletionProposal> collectProposals(ITextViewer viewer, int offset, IProgressMonitor monitor, ContentAssistInvocationContext context) {
		boolean needsSortingAfterFiltering= false;
		List<ICompletionProposal> proposals= new ArrayList<ICompletionProposal>();
		List<CompletionProposalCategory> providers= getCategories();
		for (Iterator<CompletionProposalCategory> it= providers.iterator(); it.hasNext();) {
			CompletionProposalCategory cat= it.next();
			List<ICompletionProposal> computed= cat.computeCompletionProposals(context, fPartition, new SubProgressMonitor(monitor, 1));
			proposals.addAll(computed);
			needsSortingAfterFiltering= needsSortingAfterFiltering || (cat.isSortingAfterFilteringNeeded() && !computed.isEmpty());
			if (fErrorMessage == null)
				fErrorMessage= cat.getErrorMessage();
		}
		installProposalSorter(needsSortingAfterFiltering);
		return proposals;
	}


			return (KeySequence) binding;
		return null;
    }

	/**
	 * Installs the proposal sorter to be used by the content assistant for resorting proposals
	 * after filtering. Sets the sorter to the system's default sorter if
	 * <code>needsSortingAfterFiltering</code> is <code>true</code>, <code>null</code> otherwise.
	 * 
	 * @param needsSortingAfterFiltering the flag indicating whether a sorter should be passed to
	 *            the content assistant
	 * @since 3.8
	 * @see ProposalSorterRegistry#getCurrentSorter() the sorter used if <code>true</code>
	 */
	private void installProposalSorter(boolean needsSortingAfterFiltering) {
		if (!needsSortingAfterFiltering) {
			fAssistant.setSorter(null);
			return;
		}

		AbstractProposalSorter sorter= null;
		ProposalSorterHandle currentSorter= ProposalSorterRegistry.getDefault().getCurrentSorter();
		try {
			sorter= currentSorter.getSorter();
		} catch (InvalidRegistryObjectException x) {
			JavaPlugin.log(currentSorter.createExceptionStatus(x));
		} catch (CoreException x) {
			JavaPlugin.log(currentSorter.createExceptionStatus(x));
		} catch (RuntimeException x) {
			JavaPlugin.log(currentSorter.createExceptionStatus(x));
		}
		fAssistant.setSorter(sorter);
	}

}




/*******************************************************************************
 * Copyright (c) 2005, 2012 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

 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     Marcel Bruch <bruch@cs.tu-darmstadt.de> - [content assist] Allow to re-sort proposals - https://bugs.eclipse.org/bugs/show_bug.cgi?id=350991
 *******************************************************************************/
package org.eclipse.jdt.internal.ui.text.java;


	 * @throws InvalidRegistryObjectException if the extension is not valid any longer (e.g. due to
	 *         plug-in unloading)
	 */
	synchronized AbstractProposalSorter getSorter() throws CoreException, InvalidRegistryObjectException {
		if (fSorter == null)
			fSorter= createSorter();
		return fSorter;

		return stats;
	}

	Status createExceptionStatus(InvalidRegistryObjectException x) {
		// extension has become invalid - log & disable
		String disable= createBlameMessage();
		String reason= JavaTextMessages.CompletionProposalComputerDescriptor_reason_invalid;
		return new Status(IStatus.INFO, JavaPlugin.getPluginId(), IStatus.OK, disable + " " + reason, x); //$NON-NLS-1$
	}

	Status createExceptionStatus(CoreException x) {
		// unable to instantiate the extension - log & disable
		String disable= createBlameMessage();
		String reason= JavaTextMessages.CompletionProposalComputerDescriptor_reason_instantiation;
		return new Status(IStatus.ERROR, JavaPlugin.getPluginId(), IStatus.OK, disable + " " + reason, x); //$NON-NLS-1$
	}

	Status createExceptionStatus(RuntimeException x) {
		// misbehaving extension - log & disable
		String disable= createBlameMessage();
		String reason= JavaTextMessages.CompletionProposalComputerDescriptor_reason_runtime_ex;




/*******************************************************************************
 * Copyright (c) 2006, 2012 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

 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     Marcel Bruch <bruch@cs.tu-darmstadt.de> - [content assist] Allow to re-sort proposals - https://bugs.eclipse.org/bugs/show_bug.cgi?id=350991
 *******************************************************************************/
package org.eclipse.jdt.ui.text.java;


import org.eclipse.core.runtime.IConfigurationElement;

import org.eclipse.jface.text.contentassist.ICompletionProposal;
import org.eclipse.jface.text.contentassist.ICompletionProposalSorter;

/**
 * Abstract base class for sorters contributed to the

 *
 * @since 3.2
 */
public abstract class AbstractProposalSorter implements Comparator<ICompletionProposal>, ICompletionProposalSorter {

	/**
	 * Creates a new sorter. Note that subclasses must provide a zero-argument constructor to be

	}

	/**
	 * Called once before initial sorting starts the first time. Note that if a completion engine
	 * needs subsequent sorting of its proposals (e.g., after some proposals get filtered due to
	 * changes in the completion prefix), this method is <i>not</i> called again.
	 * <p>
	 * Clients may override, the default implementation does nothing.
	 * </p>

	public abstract int compare(ICompletionProposal p1, ICompletionProposal p2);

	/**
	 * Called once after the initial sorting finished. Note that even if a completion engine causes
	 * a subsequent sorting of its proposals, this method is <i>not</i> called again.
	 * <p>
	 * Clients may override, the default implementation does nothing.
	 * </p>

Return to bug 350991

Lines 1-6 Link Here

(-)a/org.eclipse.jdt.ui/schema/javaCompletionProposalComputer.exsd (-1 / +10 lines)
1	<?xml version='1.0' encoding='UTF-8'?>	1	<?xml version='1.0' encoding='UTF-8'?>
2	<!-- Schema file written by PDE -->	2	<!-- Schema file written by PDE -->
3	<schema targetNamespace="org.eclipse.jdt.ui">	3	<schema targetNamespace="org.eclipse.jdt.ui" xmlns="http://www.w3.org/2001/XMLSchema">
4	<annotation>	4	<annotation>
5	<appInfo>	5	<appInfo>
6	<meta.schema plugin="org.eclipse.jdt.ui" id="javaCompletionProposalComputer" name="Java Completion Proposal Computer"/>	6	<meta.schema plugin="org.eclipse.jdt.ui" id="javaCompletionProposalComputer" name="Java Completion Proposal Computer"/>
Lines 95-100 Link Here
95	</appInfo>	95	</appInfo>
96	</annotation>	96	</annotation>
97	</attribute>	97	</attribute>
		98	<attribute name="needsSortingAfterFiltering" type="boolean" use="default" value="false">
		99	<annotation>
		100	<documentation>
		101	if the attribute is set to "true" it forces the content assist processor to resort the list of proposals every time a new token is entered or removed to the completion prefix.
		102
		103	@since 3.8
		104	</documentation>
		105	</annotation>
		106	</attribute>
98	</complexType>	107	</complexType>
99	</element>	108	</element>
100		109