CATestUtil.java

/*******************************************************************************
 * Copyright (c) 2007-2011 Red Hat, Inc.
 * Distributed under license by Red Hat, Inc. All rights reserved.
 * This program is 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
 *
 * Contributor:
 *     Red Hat, Inc. - initial API and implementation
 ******************************************************************************/

package org.jboss.tools.common.base.test.contentassist;

import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;

import org.eclipse.core.runtime.jobs.Job;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.ITextViewer;
import org.eclipse.jface.text.TextUtilities;
import org.eclipse.jface.text.contentassist.ICompletionProposal;
import org.eclipse.jface.text.contentassist.IContentAssistProcessor;
import org.eclipse.jface.text.contentassist.IContentAssistant;
import org.eclipse.jface.text.contentassist.IContentAssistantExtension;
import org.eclipse.jface.text.source.SourceViewerConfiguration;
import org.eclipse.swt.widgets.Display;
import org.eclipse.ui.IWorkbenchPage;
import org.eclipse.ui.IWorkbenchPart;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.texteditor.ITextEditor;
import org.jboss.tools.common.text.xml.contentassist.ProposalSorter;
import org.jboss.tools.test.util.JobUtils;

public class CATestUtil {

	/** The Constant MAX_IDLE. */
	public static final long MAX_IDLE = 5*60*1000L;

	/**
     * Returns the CA Processor from content assistant for the given offset in the document.
     * 
     * 
     * @param viewer
     * @param offset
     * @param ca
     */

	public static IContentAssistProcessor getProcessor(ITextViewer viewer, int offset, IContentAssistant ca) {
		try {
			IDocument document= viewer.getDocument();
			String type= TextUtilities.getContentType(document, ((IContentAssistantExtension)ca).getDocumentPartitioning(), offset, true);
			return ca.getContentAssistProcessor(type);
		} catch (BadLocationException x) {
		}

		return null;
	}

	/**
     * Process UI input but do not return for the specified time interval.
     * 
     * @param waitTimeMillis
     *                the number of milliseconds
     */
    public static void delay(long waitTimeMillis) {
    	JobUtils.delay(waitTimeMillis);
    }
    
	/**
	 * Wait for idle.
	 */
	public static void waitForIdle(long maxIdle) {
		JobUtils.waitForIdle(500, maxIdle);
	}

	public static SourceViewerConfiguration getSourceViewerConfiguration(ITextEditor editor) {
		Class editorClass = editor.getClass();
		while (editorClass != null) {
			try {
				Method m = editorClass.getDeclaredMethod("getSourceViewerConfiguration", new Class[] {});
				
				if(m != null) {  
					m.setAccessible(true);
					Object result = m.invoke(editor, new Object[]{});
					return (result instanceof SourceViewerConfiguration ? (SourceViewerConfiguration)result : null);
				}
			} catch (NoSuchMethodException ne) {
			} catch (Exception e) {
			}
			editorClass = editorClass.getSuperclass();
		}
		return null;
		
	}	

	public static void prepareCAInvokation(IContentAssistant ca, ITextViewer viewer, int offset) {
		if (ca == null || viewer == null)
			return;
		
		// sets cursor position
		viewer.getTextWidget().setCaretOffset(offset);
		
		CATestUtil.waitForIdle(CATestUtil.MAX_IDLE);
		CATestUtil.delay(1000);

		ca.showPossibleCompletions();
	}	
	
	public static int MAX_CATEGORIES_COUNT = 10;
	public static List<ICompletionProposal> collectProposals(IContentAssistant ca, ITextViewer viewer, int offset) {
		prepareCAInvokation(ca, viewer, offset);

		final IContentAssistProcessor p= CATestUtil.getProcessor(viewer, offset, ca);
		List<ICompletionProposal> res= new ArrayList<ICompletionProposal>();
		// Try to acquire all the proposal categories assuming that there are less than 10 or equal
		for (int i = 0; i < MAX_CATEGORIES_COUNT && p != null; i++) { 
			ICompletionProposal[] result= p.computeCompletionProposals(viewer, offset);
			for (int j = 0; result != null && j < result.length; j++) {
				res.add(result[j]);
			}
		}
		return ProposalSorter.filterAndSortProposals(res, null, null);
	}
	/**
	 * Close all opened editors
	 * @author mareshkau
	 */
	public static final void closeAllEditors(){
		IWorkbenchPage page = PlatformUI.getWorkbench()
		.getActiveWorkbenchWindow().getActivePage();
		IWorkbenchPart part = page.getViewReferences()[0].getPart(false);
		page.activate(part);
		// close
		page.closeAllEditors(false);
	}
}