Skip to content

Show progress when pre-calculating the AST during save #2414 #2415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fedejeanne wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Show progress when pre-calculating the AST during save #2414 #2415

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions ...jdt.core.manipulation/core extension/org/eclipse/jdt/internal/corext/fix/FixMessages.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ private FixMessages() {
}

public static String CleanUpPostSaveListener_name;
public static String CleanUpPostSaveListener_CalculatingChanges_taskName;
public static String CleanUpPostSaveListener_CreatingAST_taskName;
public static String CleanUpPostSaveListener_SaveAction_ChangeName;
public static String CleanUpPostSaveListener_SlowCleanUpDialog_link;
public static String CleanUpPostSaveListener_SlowCleanUpDialog_title;
Expand Down
2 changes: 2 additions & 0 deletions ...re.manipulation/core extension/org/eclipse/jdt/internal/corext/fix/FixMessages.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,8 @@ PrimitiveComparisonFix_convert_compareTo_to_primitive_comparison=Convert compare
PrimitiveRatherThanWrapperFix_description=Primitive type rather then wrapper class

CleanUpPostSaveListener_name=Code Clean Up
CleanUpPostSaveListener_CalculatingChanges_taskName=Calculating changes for save actions...
CleanUpPostSaveListener_CreatingAST_taskName=Calculating AST for save actions...
CleanUpPostSaveListener_SaveAction_ChangeName=Save Actions
CleanUpPostSaveListener_SlowCleanUpDialog_link=If this happens again we recommend to disable the corresponding save actions on the <a>'Save Actions'</a> preference page.
CleanUpPostSaveListener_SlowCleanUpDialog_title=Slow Save Actions
Expand Down
55 changes: 53 additions & 2 deletions ...se.jdt.ui/core extension/org/eclipse/jdt/internal/corext/fix/CleanUpPostSaveListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,14 @@
*******************************************************************************/
package org.eclipse.jdt.internal.corext.fix;

import java.lang.reflect.InvocationTargetException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.atomic.AtomicReference;

import org.eclipse.swt.SWT;
import org.eclipse.swt.events.SelectionAdapter;
Expand All @@ -39,6 +41,7 @@
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.OperationCanceledException;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.preferences.DefaultScope;
import org.eclipse.core.runtime.preferences.IEclipsePreferences;
Expand All @@ -60,6 +63,7 @@
import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.jface.dialogs.IDialogConstants;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.operation.IRunnableWithProgress;
import org.eclipse.jface.window.Window;

import org.eclipse.jface.text.BadLocationException;
Expand All @@ -71,7 +75,9 @@
import org.eclipse.jface.text.Position;
import org.eclipse.jface.text.Region;

import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.dialogs.PreferencesUtil;
import org.eclipse.ui.progress.IProgressService;

import org.eclipse.ltk.core.refactoring.Change;
import org.eclipse.ltk.core.refactoring.CompositeChange;
Expand Down Expand Up @@ -362,7 +368,15 @@ public void saved(ICompilationUnit unit, IRegion[] changedRegions, IProgressMoni

CompilationUnit ast= null;
if (requiresAST(cleanUps)) {
ast= createAst(unit, options, Progress.subMonitor(monitor, 10));
AtomicReference<CompilationUnit> ref = new AtomicReference<>();
runUsingProgressService(m -> {
m.beginTask(FixMessages.CleanUpPostSaveListener_CreatingAST_taskName, IProgressMonitor.UNKNOWN);
ref.set(createAst(unit, options, m));
});
ast= ref.get();
if (ast == null) {
return;
}
}

CleanUpContext context;
Expand All @@ -373,7 +387,21 @@ public void saved(ICompilationUnit unit, IRegion[] changedRegions, IProgressMoni
}

ArrayList<ICleanUp> undoneCleanUps= new ArrayList<>();
CleanUpChange change= CleanUpRefactoring.calculateChange(context, cleanUps, undoneCleanUps, slowCleanUps);

AtomicReference<CleanUpChange> ref= new AtomicReference<>();
ICleanUp[] cleanUpsCopy = new ICleanUp[cleanUps.length];
System.arraycopy(cleanUps, 0, cleanUpsCopy, 0, cleanUps.length);

runUsingProgressService(m -> {
m.beginTask(FixMessages.CleanUpPostSaveListener_CalculatingChanges_taskName, IProgressMonitor.UNKNOWN);
try {
ref.set(CleanUpRefactoring.calculateChange(context, cleanUpsCopy, undoneCleanUps, slowCleanUps));
} catch (CoreException e) {
// "e" will be unpacked and rethrown
throw new InvocationTargetException(e);
}
});
CleanUpChange change= ref.get();

RefactoringStatus postCondition= new RefactoringStatus();
for (ICleanUp cleanUp : cleanUps) {
Expand Down Expand Up @@ -570,6 +598,29 @@ private boolean requiresChangedRegions(ICleanUp[] cleanUps) {
return false;
}

private static void runUsingProgressService(IRunnableWithProgress runnable) throws CoreException {
try {
IProgressService progressService= PlatformUI.getWorkbench().getProgressService();
progressService.run(true, false, runnable);
} catch (InvocationTargetException e) {
if (e.getCause() instanceof OperationCanceledException) {
return;
}
if (e.getCause() instanceof RuntimeException rte) {
throw rte;
}
if (e.getCause() instanceof CoreException ce) {
throw ce;
}
// Other kind of exceptions are simply logged
JavaPlugin.log(e);
} catch (InterruptedException e) {
// This currently doesn't happen since canceling the monitor does not throw an OperationCanceledException.
// ... but better safe than sorry, so log it.
JavaPlugin.log(e);
}
}

private CompilationUnit createAst(ICompilationUnit unit, Map<String, String> cleanUpOptions, IProgressMonitor monitor) {
IJavaProject project= unit.getJavaProject();
if (compatibleOptions(project, cleanUpOptions)) {
Expand Down
Loading