/*******************************************************************************
* Copyright (c) 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
* Zend Technologies
*******************************************************************************/
package org.eclipse.php.ui.text.correction;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.dltk.ui.text.completion.IScriptCompletionProposal;
/**
* Interface to be implemented by contributors to the extension point
* <code>org.eclipse.php.ui.quickAssistProcessors</code>.
*
* @since 3.0
*/
public interface IQuickAssistProcessor {
/**
* Evaluates if quick assists can be created for the given context. This
* evaluation must be precise.
*
* @param context
* The invocation context
* @return Returns <code>true</code> if quick assists can be created
* @throws CoreException
* CoreException can be thrown if the operation fails
*/
boolean hasAssists(IInvocationContext context) throws CoreException;
/**
* Collects quick assists for the given context.
*
* @param context
* Defines current compilation unit, position and a shared AST
* @param locations
* The locations of problems at the invocation offset. The
* processor can decide to only add assists when there are no
* errors at the selection offset.
* @return Returns the assists applicable at the location or
* <code>null</code> if no proposals can be offered.
* @throws CoreException
* CoreException can be thrown if the operation fails
*/
IScriptCompletionProposal[] getAssists(IInvocationContext context, IProblemLocation[] locations)
throws CoreException;
}