/*******************************************************************************
* Copyright (c) 2000, 2010 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.jdt.ui.actions;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.text.ITextSelection;
import org.eclipse.ui.IWorkbenchSite;
import org.eclipse.ui.PlatformUI;
import org.eclipse.jdt.core.IJavaElement;
import org.eclipse.jdt.core.IMethod;
import org.eclipse.jdt.core.JavaModelException;
import org.eclipse.jdt.core.refactoring.IJavaRefactorings;
import org.eclipse.jdt.internal.corext.refactoring.RefactoringAvailabilityTester;
import org.eclipse.jdt.internal.corext.refactoring.RefactoringExecutionStarter;
import org.eclipse.jdt.internal.corext.refactoring.codingspectator.RefactoringGlobalStore;
import org.eclipse.jdt.internal.corext.util.JavaModelUtil;
import org.eclipse.jdt.ui.actions.codingspectator.UnavailableRefactoringLogger;
import org.eclipse.jdt.internal.ui.IJavaHelpContextIds;
import org.eclipse.jdt.internal.ui.JavaPlugin;
import org.eclipse.jdt.internal.ui.actions.ActionUtil;
import org.eclipse.jdt.internal.ui.actions.SelectionConverter;
import org.eclipse.jdt.internal.ui.javaeditor.EditorUtility;
import org.eclipse.jdt.internal.ui.javaeditor.JavaEditor;
import org.eclipse.jdt.internal.ui.javaeditor.JavaTextSelection;
import org.eclipse.jdt.internal.ui.refactoring.RefactoringMessages;
import org.eclipse.jdt.internal.ui.util.ExceptionHandler;
/**
* Action to start the modify parameters refactoring. The refactoring supports swapping and renaming
* of arguments.
* <p>
* This action is applicable to selections containing a method with one or more arguments.
*
* <p>
* This class may be instantiated; it is not intended to be subclassed.
* </p>
*
* @since 2.0
*
* @noextend This class is not intended to be subclassed by clients.
*
* @author Mohsen Vakilian, nchen: Logged refactoring unavailability
*/
public class ModifyParametersAction extends SelectionDispatchAction {
private JavaEditor fEditor;
/**
* Note: This constructor is for internal use only. Clients should not call this constructor.
*
* @param editor the java editor
*
* @noreference This constructor is not intended to be referenced by clients.
*/
public ModifyParametersAction(JavaEditor editor) {
this(editor.getEditorSite());
fEditor= editor;
setEnabled(SelectionConverter.canOperateOn(fEditor));
}
/**
* Creates a new <code>ModifyParametersAction</code>. The action requires that the selection
* provided by the site's selection provider is of type <code>
* org.eclipse.jface.viewers.IStructuredSelection</code>.
*
* @param site the site providing context information for this action
*/
public ModifyParametersAction(IWorkbenchSite site) {
super(site);
setText(RefactoringMessages.RefactoringGroup_modify_Parameters_label);
PlatformUI.getWorkbench().getHelpSystem().setHelp(this, IJavaHelpContextIds.MODIFY_PARAMETERS_ACTION);
}
/*
* @see SelectionDispatchAction#selectionChanged(IStructuredSelection)
*/
public void selectionChanged(IStructuredSelection selection) {
try {
setEnabled(RefactoringAvailabilityTester.isChangeSignatureAvailable(selection));
} catch (JavaModelException e) {
// http://bugs.eclipse.org/bugs/show_bug.cgi?id=19253
if (JavaModelUtil.isExceptionToBeLogged(e))
JavaPlugin.log(e);
setEnabled(false);//no UI here - happens on selection changes
}
}
/*
* @see SelectionDispatchAction#selectionChanged(ITextSelection)
*/
public void selectionChanged(ITextSelection selection) {
setEnabled(true);
}
/**
* Note: This method is for internal use only. Clients should not call this method.
*
* @param selection the Java text selection
* @noreference This method is not intended to be referenced by clients.
*/
public void selectionChanged(JavaTextSelection selection) {
try {
setEnabled(RefactoringAvailabilityTester.isChangeSignatureAvailable(selection));
} catch (JavaModelException e) {
setEnabled(false);
}
}
/*
* @see SelectionDispatchAction#run(IStructuredSelection)
*/
public void run(IStructuredSelection selection) {
try {
//CODINGSPECTATOR
RefactoringGlobalStore.getNewInstance().setStructuredSelection(selection);
// we have to call this here - no selection changed event is sent after a refactoring but it may still invalidate enablement
if (RefactoringAvailabilityTester.isChangeSignatureAvailable(selection)) {
IMethod method= getSingleSelectedMethod(selection);
if (!ActionUtil.isEditable(getShell(), method))
return;
RefactoringExecutionStarter.startChangeSignatureRefactoring(method, this, getShell());
}
} catch (JavaModelException e) {
ExceptionHandler.handle(e, RefactoringMessages.OpenRefactoringWizardAction_refactoring, RefactoringMessages.OpenRefactoringWizardAction_exception);
}
}
/*
* @see SelectionDispatchAction#run(ITextSelection)
*/
public void run(ITextSelection selection) {
try {
// CODINGSPECTATOR: Capture precise selection information
RefactoringGlobalStore.getNewInstance().setEditorSelectionInfo(EditorUtility.getEditorInputJavaElement(fEditor, false), selection);
if (!ActionUtil.isEditable(fEditor))
return;
IMethod method= getSingleSelectedMethod(selection);
if (RefactoringAvailabilityTester.isChangeSignatureAvailable(method)) {
RefactoringExecutionStarter.startChangeSignatureRefactoring(method, this, getShell());
} else {
//CODINGSPECTATOR
UnavailableRefactoringLogger.logUnavailableRefactoringEvent(IJavaRefactorings.CHANGE_METHOD_SIGNATURE, RefactoringMessages.ModifyParametersAction_unavailable);
MessageDialog.openInformation(getShell(), RefactoringMessages.OpenRefactoringWizardAction_unavailable, RefactoringMessages.ModifyParametersAction_unavailable);
}
} catch (JavaModelException e) {
ExceptionHandler.handle(e, RefactoringMessages.OpenRefactoringWizardAction_refactoring, RefactoringMessages.OpenRefactoringWizardAction_exception);
}
}
private static IMethod getSingleSelectedMethod(IStructuredSelection selection) {
if (selection.isEmpty() || selection.size() != 1)
return null;
if (selection.getFirstElement() instanceof IMethod)
return (IMethod)selection.getFirstElement();
return null;
}
private IMethod getSingleSelectedMethod(ITextSelection selection) throws JavaModelException {
//- when caret/selection on method name (call or declaration) -> that method
//- otherwise: caret position's enclosing method declaration
// - when caret inside argument list of method declaration -> enclosing method declaration
// - when caret inside argument list of method call -> enclosing method declaration (and NOT method call)
IJavaElement[] elements= SelectionConverter.codeResolve(fEditor);
if (elements.length > 1)
return null;
if (elements.length == 1 && elements[0] instanceof IMethod)
return (IMethod)elements[0];
IJavaElement elementAt= SelectionConverter.getInputAsCompilationUnit(fEditor).getElementAt(selection.getOffset());
if (elementAt instanceof IMethod)
return (IMethod)elementAt;
return null;
}
}