Bug 525400 - [rename] improve rename support with ltk UI

Change-Id: I4d4168293051fe88dfb7f112dc923564e55277e8
Signed-off-by: angelozerr <angelo.zerr@gmail.com>

7 files changed, 299 insertions, 47 deletions

diff --git a/org.eclipse.lsp4e/META-INF/MANIFEST.MF b/org.eclipse.lsp4e/META-INF/MANIFEST.MF
index f5516d2a..922012b9 100644
--- a/org.eclipse.lsp4e/META-INF/MANIFEST.MF
+++ b/org.eclipse.lsp4e/META-INF/MANIFEST.MF
@@ -36,7 +36,8 @@ Require-Bundle: org.eclipse.core.runtime;bundle-version="3.12.0",
  org.eclipse.ui.console,
  org.eclipse.ltk.core.refactoring,
  org.eclipse.core.expressions;bundle-version="3.5.0",
- org.eclipse.e4.ui.css.swt.theme
+ org.eclipse.e4.ui.css.swt.theme,
+ org.eclipse.ltk.ui.refactoring
 Bundle-ClassPath: .
 Bundle-Localization: plugin
 Bundle-ActivationPolicy: lazy
diff --git a/org.eclipse.lsp4e/src/org/eclipse/lsp4e/LSPEclipseUtils.java b/org.eclipse.lsp4e/src/org/eclipse/lsp4e/LSPEclipseUtils.java
index 1ad02db1..a14de5a6 100644
--- a/org.eclipse.lsp4e/src/org/eclipse/lsp4e/LSPEclipseUtils.java
+++ b/org.eclipse.lsp4e/src/org/eclipse/lsp4e/LSPEclipseUtils.java
@@ -9,6 +9,7 @@
  *  Mickael Istria (Red Hat Inc.) - initial implementation
  *  Michał Niewrzał (Rogue Wave Software Inc.)
  *  Lucas Bullen (Red Hat Inc.) - Get IDocument from IEditorInput
+ *  Angelo Zerr <angelo.zerr@gmail.com> - Bug 525400 - [rename] improve rename support with ltk UI
  *******************************************************************************/
 package org.eclipse.lsp4e;
 
@@ -302,11 +303,27 @@ public class LSPEclipseUtils {
 	}
 
 	/**
-	 * Applies a worksapce edit. It does simply change the underlying documents.
+	 * Applies a workspace edit. It does simply change the underlying documents.
 	 *
 	 * @param wsEdit
 	 */
 	public static void applyWorkspaceEdit(WorkspaceEdit wsEdit) {
+		CompositeChange change = toCompositeChange(wsEdit);
+		PerformChangeOperation changeOperation = new PerformChangeOperation(change);
+		try {
+			ResourcesPlugin.getWorkspace().run(changeOperation, new NullProgressMonitor());
+		} catch (CoreException e) {
+			LanguageServerPlugin.logError(e);
+		}
+	}
+
+	/**
+	 * Returns a ltk {@link CompositeChange} from a lsp {@link WorkspaceEdit}.
+	 *
+	 * @param wsEdit
+	 * @return a ltk {@link CompositeChange} from a lsp {@link WorkspaceEdit}.
+	 */
+	public static CompositeChange toCompositeChange(WorkspaceEdit wsEdit) {
 		CompositeChange change = new CompositeChange("LSP Workspace Edit"); //$NON-NLS-1$
 		for (java.util.Map.Entry<String, List<TextEdit>> edit : wsEdit.getChanges().entrySet()) {
 			String uri = edit.getKey();
@@ -324,12 +341,7 @@ public class LSPEclipseUtils {
 				}
 			}
 		}
-		PerformChangeOperation changeOperation = new PerformChangeOperation(change);
-		try {
-			ResourcesPlugin.getWorkspace().run(changeOperation, new NullProgressMonitor());
-		} catch (CoreException e) {
-			LanguageServerPlugin.logError(e);
-		}
+		return change;
 	}
 
 	public static URI toUri(IPath absolutePath) {
diff --git a/org.eclipse.lsp4e/src/org/eclipse/lsp4e/operations/rename/LSPRenameHandler.java b/org.eclipse.lsp4e/src/org/eclipse/lsp4e/operations/rename/LSPRenameHandler.java
index 19a90002..48381104 100644
--- a/org.eclipse.lsp4e/src/org/eclipse/lsp4e/operations/rename/LSPRenameHandler.java
+++ b/org.eclipse.lsp4e/src/org/eclipse/lsp4e/operations/rename/LSPRenameHandler.java
@@ -7,19 +7,16 @@
  *
  * Contributors:
  *  Mickael Istria (Red Hat Inc.) - initial implementation
+ *  Angelo Zerr <angelo.zerr@gmail.com> - Bug 525400 - [rename] improve rename support with ltk UI
  *******************************************************************************/
 package org.eclipse.lsp4e.operations.rename;
 
 import java.util.Collection;
-import java.util.concurrent.CompletableFuture;
 
 import org.eclipse.core.commands.AbstractHandler;
 import org.eclipse.core.commands.ExecutionEvent;
 import org.eclipse.core.commands.ExecutionException;
 import org.eclipse.core.commands.IHandler;
-import org.eclipse.jface.dialogs.Dialog;
-import org.eclipse.jface.dialogs.InputDialog;
-import org.eclipse.jface.text.BadLocationException;
 import org.eclipse.jface.text.ITextSelection;
 import org.eclipse.jface.text.TextSelection;
 import org.eclipse.jface.viewers.ISelection;
@@ -28,10 +25,9 @@ import org.eclipse.lsp4e.LanguageServerPlugin;
 import org.eclipse.lsp4e.LanguageServiceAccessor;
 import org.eclipse.lsp4e.LanguageServiceAccessor.LSPDocumentInfo;
 import org.eclipse.lsp4e.ui.Messages;
-import org.eclipse.lsp4j.RenameParams;
-import org.eclipse.lsp4j.TextDocumentIdentifier;
-import org.eclipse.lsp4j.WorkspaceEdit;
-import org.eclipse.swt.widgets.Shell;
+import org.eclipse.ltk.core.refactoring.participants.ProcessorBasedRefactoring;
+import org.eclipse.ltk.core.refactoring.participants.RefactoringProcessor;
+import org.eclipse.ltk.ui.refactoring.RefactoringWizardOpenOperation;
 import org.eclipse.ui.IEditorPart;
 import org.eclipse.ui.IWorkbenchPart;
 import org.eclipse.ui.PlatformUI;
@@ -39,8 +35,6 @@ import org.eclipse.ui.handlers.HandlerUtil;
 import org.eclipse.ui.texteditor.AbstractTextEditor;
 import org.eclipse.ui.texteditor.ITextEditor;
 
-import com.google.common.base.Strings;
-
 public class LSPRenameHandler extends AbstractHandler implements IHandler {
 
 	@Override
@@ -55,19 +49,15 @@ public class LSPRenameHandler extends AbstractHandler implements IHandler {
 				LSPDocumentInfo info = infos.iterator().next();
 				ISelection sel = ((AbstractTextEditor) part).getSelectionProvider().getSelection();
 				if (sel instanceof TextSelection) {
+					int offset = ((TextSelection) sel).getOffset();
+					RefactoringProcessor processor = new LSPRenameProcessor(info, offset);
+					ProcessorBasedRefactoring refactoring = new ProcessorBasedRefactoring(processor);
+					LSPRenameRefactoringWizard wizard = new LSPRenameRefactoringWizard(refactoring);
+					RefactoringWizardOpenOperation operation = new RefactoringWizardOpenOperation(wizard);
 					try {
-						RenameParams params = new RenameParams();
-						params.setPosition(LSPEclipseUtils.toPosition(((TextSelection) sel).getOffset(), info.getDocument()));
-						TextDocumentIdentifier identifier = new TextDocumentIdentifier();
-						identifier.setUri(info.getFileUri().toString());
-						params.setTextDocument(identifier);
-						params.setNewName(askNewName(part.getSite().getShell()));
-						if (params.getNewName() != null) {
-							CompletableFuture<WorkspaceEdit> rename = info.getLanguageClient().getTextDocumentService().rename(params);
-							rename.thenAccept((WorkspaceEdit t) -> LSPEclipseUtils.applyWorkspaceEdit(t));
-						}
-					} catch (BadLocationException e) {
-						LanguageServerPlugin.logError(e);
+						operation.run(part.getSite().getShell(), Messages.rename_title);
+					} catch (InterruptedException e1) {
+						LanguageServerPlugin.logError(e1);
 					}
 				}
 			}
@@ -88,17 +78,4 @@ public class LSPRenameHandler extends AbstractHandler implements IHandler {
 		return false;
 	}
 
-	private String askNewName(Shell parentShell) {
-		InputDialog dialog = new InputDialog(parentShell,
-				Messages.rename_title,
-				Messages.rename_label,
-				"newName", //$NON-NLS-1$
-				s -> Strings.isNullOrEmpty(s) ? Messages.rename_invalid : null);
-		dialog.setBlockOnOpen(true);
-		if (dialog.open() == Dialog.OK) {
-			return dialog.getValue();
-		}
-		return null;
-	}
-
 }
diff --git a/org.eclipse.lsp4e/src/org/eclipse/lsp4e/operations/rename/LSPRenameProcessor.java b/org.eclipse.lsp4e/src/org/eclipse/lsp4e/operations/rename/LSPRenameProcessor.java
new file mode 100644
index 00000000..063a685d
--- /dev/null
+++ b/org.eclipse.lsp4e/src/org/eclipse/lsp4e/operations/rename/LSPRenameProcessor.java
@@ -0,0 +1,128 @@
+/**

+ *  Copyright (c) 2017 Angelo ZERR.

+ *  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:

+ *  Angelo Zerr <angelo.zerr@gmail.com> - initial API and implementation

+ */

+package org.eclipse.lsp4e.operations.rename;

+

+import java.util.concurrent.TimeUnit;

+

+import org.eclipse.core.runtime.Assert;

+import org.eclipse.core.runtime.CoreException;

+import org.eclipse.core.runtime.IProgressMonitor;

+import org.eclipse.core.runtime.IStatus;

+import org.eclipse.core.runtime.OperationCanceledException;

+import org.eclipse.core.runtime.Status;

+import org.eclipse.lsp4e.LSPEclipseUtils;

+import org.eclipse.lsp4e.LanguageServerPlugin;

+import org.eclipse.lsp4e.LanguageServiceAccessor.LSPDocumentInfo;

+import org.eclipse.lsp4e.ui.Messages;

+import org.eclipse.lsp4j.RenameParams;

+import org.eclipse.lsp4j.TextDocumentIdentifier;

+import org.eclipse.lsp4j.WorkspaceEdit;

+import org.eclipse.ltk.core.refactoring.Change;

+import org.eclipse.ltk.core.refactoring.RefactoringStatus;

+import org.eclipse.ltk.core.refactoring.participants.CheckConditionsContext;

+import org.eclipse.ltk.core.refactoring.participants.RefactoringParticipant;

+import org.eclipse.ltk.core.refactoring.participants.RefactoringProcessor;

+import org.eclipse.ltk.core.refactoring.participants.SharableParticipants;

+

+/**

+ * LTK {@link RefactoringProcessor} implementation to refactoring LSP symbols.

+ *

+ */

+public class LSPRenameProcessor extends RefactoringProcessor {

+

+	private static final String ID = "org.eclipse.lsp4e.operations.rename"; //$NON-NLS-1$

+

+	private final LSPDocumentInfo info;

+	private final int offset;

+

+	private String newName;

+

+	private WorkspaceEdit rename;

+

+	public LSPRenameProcessor(LSPDocumentInfo info, int offset) {

+		this.info = info;

+		this.offset = offset;

+	}

+

+	@Override

+	public Object[] getElements() {

+		return null;

+	}

+

+	@Override

+	public String getIdentifier() {

+		return ID;

+	}

+

+	@Override

+	public String getProcessorName() {

+		return Messages.rename_processor_name;

+	}

+

+	@Override

+	public boolean isApplicable() throws CoreException {

+		return true;

+	}

+

+	@Override

+	public RefactoringStatus checkInitialConditions(IProgressMonitor pm)

+			throws CoreException, OperationCanceledException {

+		return new RefactoringStatus();

+	}

+

+	@Override

+	public RefactoringStatus checkFinalConditions(IProgressMonitor pm, CheckConditionsContext context)

+			throws CoreException, OperationCanceledException {

+		RefactoringStatus status = new RefactoringStatus();

+		try {

+			RenameParams params = new RenameParams();

+			params.setPosition(LSPEclipseUtils.toPosition(offset, info.getDocument()));

+			TextDocumentIdentifier identifier = new TextDocumentIdentifier();

+			identifier.setUri(info.getFileUri().toString());

+			params.setTextDocument(identifier);

+			params.setNewName(newName);

+			if (params.getNewName() != null) {

+				// TODO: how to manage ltk with CompletableFuture? Is 1000 ms is enough?

+				rename = info.getLanguageClient().getTextDocumentService().rename(params).get(1000,

+						TimeUnit.MILLISECONDS);

+			}

+		} catch (Exception e) {

+			status.addError(e.getMessage());

+		}

+		return status;

+	}

+

+	@Override

+	public Change createChange(IProgressMonitor pm) throws CoreException, OperationCanceledException {

+		if (rename == null) {

+			throw new CoreException(

+					new Status(IStatus.ERROR, LanguageServerPlugin.PLUGIN_ID, Messages.rename_processor_required));

+		}

+		return LSPEclipseUtils.toCompositeChange(rename);

+	}

+

+	@Override

+	public RefactoringParticipant[] loadParticipants(RefactoringStatus status, SharableParticipants sharedParticipants)

+			throws CoreException {

+		return null;

+	}

+

+	/**

+	 * Set new name.

+	 *

+	 * @param newName

+	 *            the new name.

+	 */

+	public void setNewName(String newName) {

+		Assert.isNotNull(newName);

+		this.newName = newName;

+	}

+}

diff --git a/org.eclipse.lsp4e/src/org/eclipse/lsp4e/operations/rename/LSPRenameRefactoringWizard.java b/org.eclipse.lsp4e/src/org/eclipse/lsp4e/operations/rename/LSPRenameRefactoringWizard.java
new file mode 100644
index 00000000..82a07637
--- /dev/null
+++ b/org.eclipse.lsp4e/src/org/eclipse/lsp4e/operations/rename/LSPRenameRefactoringWizard.java
@@ -0,0 +1,133 @@
+/**

+ *  Copyright (c) 2017 Angelo ZERR.

+ *  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:

+ *  Angelo Zerr <angelo.zerr@gmail.com> - initial API and implementation

+ */

+package org.eclipse.lsp4e.operations.rename;

+

+import org.eclipse.jface.wizard.IWizardPage;

+import org.eclipse.lsp4e.ui.Messages;

+import org.eclipse.ltk.core.refactoring.Refactoring;

+import org.eclipse.ltk.core.refactoring.RefactoringStatus;

+import org.eclipse.ltk.ui.refactoring.RefactoringWizard;

+import org.eclipse.ltk.ui.refactoring.UserInputWizardPage;

+import org.eclipse.swt.SWT;

+import org.eclipse.swt.events.ModifyEvent;

+import org.eclipse.swt.events.ModifyListener;

+import org.eclipse.swt.layout.GridData;

+import org.eclipse.swt.layout.GridLayout;

+import org.eclipse.swt.widgets.Composite;

+import org.eclipse.swt.widgets.Label;

+import org.eclipse.swt.widgets.Text;

+

+/**

+ * The refactoring wizard for renaming LSP Symbols.

+ *

+ */

+public class LSPRenameRefactoringWizard extends RefactoringWizard {

+

+	public LSPRenameRefactoringWizard(Refactoring refactoring) {

+		super(refactoring, DIALOG_BASED_USER_INTERFACE);

+		super.setWindowTitle(Messages.rename_title);

+	}

+

+	@Override

+	protected void addUserInputPages() {

+		@SuppressWarnings("null")

+		LSPRenameProcessor processor = this.getRefactoring().getAdapter(LSPRenameProcessor.class);

+		this.addPage(new RenameInputWizardPage(processor));

+	}

+

+	/**

+	 * Rename input wizard page.

+	 *

+	 */

+	class RenameInputWizardPage extends UserInputWizardPage {

+

+		private Text nameText;

+

+		private final LSPRenameProcessor processor;

+

+		RenameInputWizardPage(LSPRenameProcessor processor) {

+			super(RenameInputWizardPage.class.getSimpleName());

+			this.processor = processor;

+		}

+

+		@Override

+		public void createControl(Composite parent) {

+			Composite composite = new Composite(parent, SWT.NONE);

+			composite.setLayout(new GridLayout(2, false));

+			composite.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));

+			composite.setFont(parent.getFont());

+

+			Label label = new Label(composite, SWT.NONE);

+			label.setLayoutData(new GridData());

+			label.setText(Messages.rename_label);

+

+			this.nameText = new Text(composite, SWT.BORDER);

+			// TODO: update name field with symbol name to refactor.

+			this.nameText.setText("newName"); //$NON-NLS-1$

+			this.nameText.setFont(composite.getFont());

+			this.nameText.setLayoutData(new GridData(GridData.FILL, GridData.BEGINNING, true, false));

+			this.nameText.addModifyListener(new ModifyListener() {

+				@Override

+				public void modifyText(ModifyEvent e) {

+					validatePage();

+				}

+			});

+			this.nameText.selectAll();

+			this.setControl(composite);

+			validatePage();

+		}

+

+		@Override

+		public IWizardPage getNextPage() {

+			this.setNewName();

+			return super.getNextPage();

+		}

+

+		@Override

+		public void setVisible(boolean visible) {

+			if (visible) {

+				this.nameText.setFocus();

+			}

+			super.setVisible(visible);

+		}

+

+		@Override

+		protected boolean performFinish() {

+			this.setNewName();

+			return super.performFinish();

+		}

+

+		private void setNewName() {

+			this.processor.setNewName(this.nameText.getText());

+		}

+

+		/**

+		 * Validate page fields.

+		 */

+		private final void validatePage() {

+			RefactoringStatus status = validateName();

+			setPageComplete(status);

+		}

+

+		/**

+		 * Returns the status of the validated name.

+		 *

+		 * @return the status of the validated name.

+		 */

+		private RefactoringStatus validateName() {

+			// Name is required

+			if (this.nameText.getText().trim().length() == 0) {

+				return RefactoringStatus.createFatalErrorStatus(Messages.rename_processor_required);

+			}

+			return new RefactoringStatus();

+		}

+	}

+}

diff --git a/org.eclipse.lsp4e/src/org/eclipse/lsp4e/ui/Messages.java b/org.eclipse.lsp4e/src/org/eclipse/lsp4e/ui/Messages.java
index 4ed9ff86..c22f0f4a 100644
--- a/org.eclipse.lsp4e/src/org/eclipse/lsp4e/ui/Messages.java
+++ b/org.eclipse.lsp4e/src/org/eclipse/lsp4e/ui/Messages.java
@@ -7,6 +7,7 @@
  *
  * Contributors:
  *  Mickael Istria (Red Hat Inc.) - initial implementation
+ *  Angelo Zerr <angelo.zerr@gmail.com> - Bug 525400 - [rename] improve rename support with ltk UI
  *******************************************************************************/
 package org.eclipse.lsp4e.ui;
 
@@ -32,7 +33,6 @@ public class Messages extends NLS {
 	public static String codeLens_emptyMenu;
 	public static String updateCodeActions_menu;
 	public static String initializeLanguageServer_job;
-	public static String rename_job;
 	public static String referenceSearchQuery;
 	public static String computing;
 	public static String notImplemented;
@@ -44,7 +44,8 @@ public class Messages extends NLS {
 	public static String findReferences_updateResultView_jobName;
 	public static String rename_title;
 	public static String rename_label;
-	public static String rename_invalid;
+	public static String rename_processor_name;
+	public static String rename_processor_required;
 	public static String serverEdit;
 	public static String completionError;
 	public static String linkWithEditor_label;
diff --git a/org.eclipse.lsp4e/src/org/eclipse/lsp4e/ui/messages.properties b/org.eclipse.lsp4e/src/org/eclipse/lsp4e/ui/messages.properties
index ca569034..e73c8d4c 100644
--- a/org.eclipse.lsp4e/src/org/eclipse/lsp4e/ui/messages.properties
+++ b/org.eclipse.lsp4e/src/org/eclipse/lsp4e/ui/messages.properties
@@ -30,7 +30,6 @@ codeActions_emptyMenu=No available code actions
 codeLens_emptyMenu=No available code lenses
 updateCodeActions_menu=Update Code Actions
 initializeLanguageServer_job=Initialize language server
-rename_job=Rename
 referenceSearchQuery=References
 computing=Computing...
 LSPSymbolInWorkspaceDialog_DialogLabel=Select an item to open.
@@ -44,7 +43,8 @@ completionError=Error while computing completion
 
 rename_title=Rename
 rename_label=New name:
-rename_invalid=Invalid new name
+rename_processor_name=Rename Symbol
+rename_processor_required=new rename cannot be null
 
 serverEdit=Edit from Language Server