Integrate the client's file formatting options with JDT code action h…

…andlers Signed-off-by: Jinbo Wang <[email protected]>
eclipse-jdtls · Feb 5, 2021 · 672164a · 672164a
1 parent b35fdca
commit 672164a
Show file tree

Hide file tree

Showing 18 changed files with 163 additions and 22 deletions.
diff --git a/launch/jdt.ls.socket-stream.launch b/launch/jdt.ls.socket-stream.launch
@@ -40,12 +40,12 @@
 <setEntry value="ch.qos.logback.classic@default:default"/>
 <setEntry value="ch.qos.logback.core@default:default"/>
 <setEntry value="ch.qos.logback.slf4j@default:default"/>
-<setEntry value="com.google.gson*2.8.2.v20180104-1110@default:default"/>
+<setEntry value="com.google.gson@default:default"/>
 <setEntry value="com.google.guava@default:default"/>
 <setEntry value="javax.inject@default:default"/>
 <setEntry value="javax.xml@default:default"/>
 <setEntry value="org.apache.ant@default:default"/>
-<setEntry value="org.apache.commons.io*2.6.0.v20190123-2029@default:default"/>
+<setEntry value="org.apache.commons.io@default:default"/>
 <setEntry value="org.apache.commons.lang3@default:default"/>
 <setEntry value="org.apache.felix.scr@1:true"/>
 <setEntry value="org.apache.log4j@default:default"/>

diff --git a/.../src/org/eclipse/jdt/ls/core/internal/codemanipulation/GenerateGetterSetterOperation.java b/.../src/org/eclipse/jdt/ls/core/internal/codemanipulation/GenerateGetterSetterOperation.java
@@ -15,6 +15,7 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
 
 import org.eclipse.core.runtime.Assert;
 import org.eclipse.core.runtime.CoreException;
@@ -158,7 +159,8 @@ private void insertMethod(IField field, ListRewrite rewrite, AccessorKind kind)
  stub = GetterSetterUtil.getSetterStub(field, name, generateComments, flags);
  }
 
- String formattedStub = CodeFormatterUtil.format(CodeFormatter.K_CLASS_BODY_DECLARATIONS, stub, 0, delimiter, type.getJavaProject().getOptions(true));
+ Map<String, String> options = type.getCompilationUnit() != null ? type.getCompilationUnit().getOptions(true) : type.getJavaProject().getOptions(true);
+ String formattedStub = CodeFormatterUtil.format(CodeFormatter.K_CLASS_BODY_DECLARATIONS, stub, 0, delimiter, options);
  MethodDeclaration declaration = (MethodDeclaration) rewrite.getASTRewrite().createStringPlaceholder(formattedStub, ASTNode.METHOD_DECLARATION);
  rewrite.insertLast(declaration, null);
  }

diff --git a/...e/src/org/eclipse/jdt/ls/core/internal/contentassist/AnonymousTypeCompletionProposal.java b/...e/src/org/eclipse/jdt/ls/core/internal/contentassist/AnonymousTypeCompletionProposal.java
@@ -99,9 +99,8 @@ public String updateReplacementString(IDocument document, int offset, ImportRewr
  buf.append(newBody);
  // use the code formatter
  String lineDelim = TextUtilities.getDefaultLineDelimiter(document);
- final IJavaProject project = fCompilationUnit.getJavaProject();
  IRegion lineInfo = document.getLineInformationOfOffset(fReplacementOffset);
- Map<String, String> options = project != null ? project.getOptions(true) : JavaCore.getOptions();
+ Map<String, String> options = fCompilationUnit.getOptions(true);
  String replacementString = CodeFormatterUtil.format(CodeFormatter.K_EXPRESSION, buf.toString(), 0, lineDelim, options);
  int lineEndOffset = lineInfo.getOffset() + lineInfo.getLength();
  int p = offset;

diff --git a/...s.core/src/org/eclipse/jdt/ls/core/internal/contentassist/OverrideCompletionProposal.java b/...s.core/src/org/eclipse/jdt/ls/core/internal/contentassist/OverrideCompletionProposal.java
@@ -147,7 +147,7 @@ public String updateReplacementString(IDocument document, int offset, ImportRewr
 
  ITrackedNodePosition position= rewrite.track(stub);
  try {
- Map<String, String> options = fJavaProject.getOptions(true);
+ Map<String, String> options = fCompilationUnit.getOptions(true);
 
  rewrite.rewriteAST(recoveredDocument, options).apply(recoveredDocument);
 

diff --git a/...rc/org/eclipse/jdt/ls/core/internal/corext/refactoring/code/ExtractMethodRefactoring.java b/...rc/org/eclipse/jdt/ls/core/internal/corext/refactoring/code/ExtractMethodRefactoring.java
@@ -600,7 +600,7 @@ public Change createChange(IProgressMonitor pm) throws CoreException {
  result.addTextEditGroup(new TextEditGroup(RefactoringCoreMessages.ExtractMethodRefactoring_organize_imports, new TextEdit[] { edit }));
  }
  try {
- Map formatter = this.fFormatterOptions == null ? fCUnit.getJavaProject().getOptions(true) : this.fFormatterOptions;
+ Map formatter = this.fFormatterOptions == null ? fCUnit.getOptions(true) : this.fFormatterOptions;
  IDocument document = new Document(fCUnit.getSource());
  root.addChild(fRewriter.rewriteAST(document, formatter));
  } catch (JavaModelException e) {

diff --git a/...re/src/org/eclipse/jdt/ls/core/internal/corext/refactoring/delegates/DelegateCreator.java b/...re/src/org/eclipse/jdt/ls/core/internal/corext/refactoring/delegates/DelegateCreator.java
@@ -361,7 +361,7 @@ private void createJavadoc() throws JavaModelException {
  public void createEdit() throws JavaModelException {
  try {
  IDocument document= new Document(fDelegateRewrite.getCu().getBuffer().getContents());
- TextEdit edit= fDelegateRewrite.getASTRewrite().rewriteAST(document, fDelegateRewrite.getCu().getJavaProject().getOptions(true));
+ TextEdit edit= fDelegateRewrite.getASTRewrite().rewriteAST(document, fDelegateRewrite.getCu().getOptions(true));
  edit.apply(document, TextEdit.UPDATE_REGIONS);
 
  int tabWidth = CodeFormatterUtil.getTabWidth(fOriginalRewrite.getCu().getJavaProject());

diff --git a/...re/src/org/eclipse/jdt/ls/core/internal/corext/refactoring/reorg/DeleteChangeCreator.java b/...re/src/org/eclipse/jdt/ls/core/internal/corext/refactoring/reorg/DeleteChangeCreator.java
@@ -133,7 +133,7 @@ private static Change createDeleteChange(ICompilationUnit cu, List<IJavaElement>
  private static TextChange addTextEditFromRewrite(TextChangeManager manager, ICompilationUnit cu, ASTRewrite rewrite) throws CoreException {
  try {
  ITextFileBuffer buffer= RefactoringFileBuffers.acquire(cu);
- TextEdit resultingEdits= rewrite.rewriteAST(buffer.getDocument(), cu.getJavaProject().getOptions(true));
+ TextEdit resultingEdits= rewrite.rewriteAST(buffer.getDocument(), cu.getOptions(true));
  TextChange textChange= manager.get(cu);
  if (textChange instanceof TextFileChange) {
  TextFileChange tfc= (TextFileChange) textChange;

diff --git a/.../eclipse/jdt/ls/core/internal/corrections/proposals/AbstractMethodCorrectionProposal.java b/.../eclipse/jdt/ls/core/internal/corrections/proposals/AbstractMethodCorrectionProposal.java
@@ -154,7 +154,7 @@ private MethodDeclaration getStub(ASTRewrite rewrite, ASTNode targetTypeDecl) th
  if (!isAbstractMethod && !isVoid) {
  ReturnStatement returnStatement= ast.newReturnStatement();
  returnStatement.setExpression(ASTNodeFactory.newDefaultExpression(ast, returnType, 0));
- bodyStatement= ASTNodes.asFormattedString(returnStatement, 0, String.valueOf('\n'), getCompilationUnit().getJavaProject().getOptions(true));
+ bodyStatement= ASTNodes.asFormattedString(returnStatement, 0, String.valueOf('\n'), getCompilationUnit().getOptions(true));
  }
  }
 

diff --git a/...eclipse/jdt/ls/core/internal/corrections/proposals/ConstructorFromSuperclassProposal.java b/...eclipse/jdt/ls/core/internal/corrections/proposals/ConstructorFromSuperclassProposal.java
@@ -163,7 +163,7 @@ private MethodDeclaration createNewMethodDeclaration(AST ast, IMethodBinding bin
  }
  }
 
- String bodyStatement = (invocation == null) ? "" : ASTNodes.asFormattedString(invocation, 0, String.valueOf('\n'), getCompilationUnit().getJavaProject().getOptions(true)); //$NON-NLS-1$
+ String bodyStatement = (invocation == null) ? "" : ASTNodes.asFormattedString(invocation, 0, String.valueOf('\n'), getCompilationUnit().getOptions(true)); //$NON-NLS-1$
  String placeHolder= CodeGeneration.getMethodBodyContent(getCompilationUnit(), name, name, true, bodyStatement, String.valueOf('\n'));
  if (placeHolder != null) {
  ASTNode todoNode= rewrite.createStringPlaceholder(placeHolder, ASTNode.RETURN_STATEMENT);

diff --git a/.../eclipse/jdt/ls/core/internal/corrections/proposals/ModifierChangeCorrectionProposal.java b/.../eclipse/jdt/ls/core/internal/corrections/proposals/ModifierChangeCorrectionProposal.java
@@ -113,7 +113,7 @@ protected ASTRewrite getRewrite() throws CoreException {
  if (expression != null) {
  ReturnStatement returnStatement = ast.newReturnStatement();
  returnStatement.setExpression(expression);
- bodyStatement = ASTNodes.asFormattedString(returnStatement, 0, delimiter, unit.getJavaProject().getOptions(true));
+ bodyStatement = ASTNodes.asFormattedString(returnStatement, 0, delimiter, unit.getOptions(true));
  }
  }
  String placeHolder = CodeGeneration.getMethodBodyContent(unit, methodBinding.getDeclaringClass().getName(), methodBinding.getName(), false, bodyStatement, delimiter);

diff --git a/org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/handlers/CodeActionHandler.java b/org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/handlers/CodeActionHandler.java
@@ -16,7 +16,9 @@
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.Comparator;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.Optional;
 import java.util.stream.Collectors;
 
@@ -26,7 +28,9 @@
 import org.eclipse.core.runtime.NullProgressMonitor;
 import org.eclipse.jdt.core.ICompilationUnit;
 import org.eclipse.jdt.core.IJavaModelMarker;
+import org.eclipse.jdt.core.JavaCore;
 import org.eclipse.jdt.core.dom.CompilationUnit;
+import org.eclipse.jdt.core.formatter.DefaultCodeFormatterConstants;
 import org.eclipse.jdt.core.manipulation.CoreASTProvider;
 import org.eclipse.jdt.internal.ui.text.correction.IProblemLocationCore;
 import org.eclipse.jdt.internal.ui.text.correction.ProblemLocationCore;
@@ -40,6 +44,7 @@
 import org.eclipse.jdt.ls.core.internal.corrections.RefactorProcessor;
 import org.eclipse.jdt.ls.core.internal.corrections.proposals.ChangeCorrectionProposal;
 import org.eclipse.jdt.ls.core.internal.preferences.PreferenceManager;
+import org.eclipse.jdt.ls.core.internal.preferences.Preferences;
 import org.eclipse.jdt.ls.core.internal.text.correction.AssignToVariableAssistCommandProposal;
 import org.eclipse.jdt.ls.core.internal.text.correction.CUCorrectionCommandProposal;
 import org.eclipse.jdt.ls.core.internal.text.correction.NonProjectFixProcessor;
@@ -86,6 +91,32 @@ public List<Either<Command, CodeAction>> getCodeActionCommands(CodeActionParams
  return Collections.emptyList();
  }
 
+ Map<String, Object> formattingOptions = ConfigurationHandler.getFormattingOptions(params.getTextDocument().getUri());
+ if (formattingOptions != null && !formattingOptions.isEmpty()) {
+ Object tabSizeValue = formattingOptions.get(Preferences.JAVA_CONFIGURATION_TABSIZE);
+ Object insertSpacesValue = formattingOptions.get(Preferences.JAVA_CONFIGURATION_INSERTSPACES);
+ Map<String, String> customOptions = new HashMap<>();
+ if (tabSizeValue != null) {
+ try {
+ int tabSize = Integer.parseInt(String.valueOf(tabSizeValue));
+ if (tabSize > 0) {
+ customOptions.put(DefaultCodeFormatterConstants.FORMATTER_TAB_SIZE, Integer.toString(tabSize));
+ }
+ } catch (Exception ex) {
+ // do nothing
+ }
+ }
+
+ if (insertSpacesValue != null) {
+ boolean insertSpaces = Boolean.parseBoolean(String.valueOf(insertSpacesValue));
+ customOptions.put(DefaultCodeFormatterConstants.FORMATTER_TAB_CHAR, insertSpaces ? JavaCore.SPACE : JavaCore.TAB);
+ }
+
+ if (!customOptions.isEmpty()) {
+ unit.setOptions(customOptions);
+ }
+ }
+
  CompilationUnit astRoot = getASTRoot(unit, monitor);
  if (astRoot == null || monitor.isCanceled()) {
  return Collections.emptyList();

diff --git a/...lipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/handlers/ConfigurationHandler.java b/...lipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/handlers/ConfigurationHandler.java
@@ -16,6 +16,7 @@
 import java.util.Map;
 
 import org.eclipse.jdt.ls.core.internal.JavaLanguageServerPlugin;
+import org.eclipse.jdt.ls.core.internal.preferences.Preferences;
 import org.eclipse.lsp4j.ConfigurationItem;
 import org.eclipse.lsp4j.ConfigurationParams;
 
@@ -36,8 +37,10 @@ public static Map<String, Object> getFormattingOptions(String uri) {
  };
 
  List<ConfigurationItem> configurationItems = new ArrayList<>();
- // TODO: extract to const once it's available in Preferences.java
- String[] settingKeys = {"java.format.tabSize", "java.format.insertSpaces"};
+ String[] settingKeys = {
+ Preferences.JAVA_CONFIGURATION_TABSIZE,
+ Preferences.JAVA_CONFIGURATION_INSERTSPACES
+ };
 
  ConfigurationItem tabSizeItem = new ConfigurationItem();
  tabSizeItem.setScopeUri(uri);

diff --git a/org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/handlers/FormatterHandler.java b/org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/handlers/FormatterHandler.java
@@ -141,7 +141,7 @@ private IRegion getRegion(Range range, IDocument document) {
  }
 
  public static Map<String, String> getOptions(FormattingOptions options, ICompilationUnit cu) {
- Map<String, String> eclipseOptions = cu.getJavaProject().getOptions(true);
+ Map<String, String> eclipseOptions = cu.getOptions(true);
 
  Map<String, String> customOptions = options.entrySet().stream().filter(map -> chekIfValueIsNotNull(map.getValue())).collect(toMap(e -> e.getKey(), e -> getOptionValue(e.getValue())));
 

diff --git a/org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/handlers/JDTLanguageServer.java b/org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/handlers/JDTLanguageServer.java
@@ -41,6 +41,7 @@
 import org.eclipse.jdt.ls.core.internal.JDTUtils;
 import org.eclipse.jdt.ls.core.internal.JSONUtility;
 import org.eclipse.jdt.ls.core.internal.JVMConfigurator;
+import org.eclipse.jdt.ls.core.internal.JavaClientConnection;
 import org.eclipse.jdt.ls.core.internal.JavaClientConnection.JavaLanguageClient;
 import org.eclipse.jdt.ls.core.internal.JavaLanguageServerPlugin;
 import org.eclipse.jdt.ls.core.internal.JobHelpers;
@@ -214,6 +215,11 @@ public void connectClient(JavaLanguageClient client) {
  this.documentLifeCycleHandler = new DocumentLifeCycleHandler(this.client, preferenceManager, pm, true);
  }
 
+ // For testing purpose
+ public void setClientConnection(JavaClientConnection client) {
+ this.client = client;
+ }
+
  //For testing purposes
  public void disconnectClient() {
  Job.getJobManager().setProgressProvider(null);

diff --git a/org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/preferences/Preferences.java b/org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/preferences/Preferences.java
@@ -62,6 +62,14 @@ public class Preferences {
  * finding references.
  */
  public static final String JAVA_REFERENCES_INCLUDE_ACCESSORS = "java.references.includeAccessors";
+ /**
+ * Insert spaces when pressing Tab
+ */
+ public static final String JAVA_CONFIGURATION_INSERTSPACES = "java.format.insertSpaces";
+ /**
+ * Tab Size
+ */
+ public static final String JAVA_CONFIGURATION_TABSIZE = "java.format.tabSize";
  /**
  * Specifies Java Execution Environments.
  */

diff --git a/org.eclipse.jdt.ls.target/org.eclipse.jdt.ls.tp.target b/org.eclipse.jdt.ls.target/org.eclipse.jdt.ls.tp.target
@@ -31,6 +31,9 @@
  <unit id="org.eclipse.equinox.sdk.feature.group" version="0.0.0"/>
  <unit id="org.eclipse.jdt.source.feature.group" version="0.0.0"/>
  <unit id="org.eclipse.sdk.feature.group" version="0.0.0"/>
+ <repository location="https://download.eclipse.org/eclipse/updates/4.19-I-builds/I20210126-1800/"/>
+ </location>
+ <location includeAllPlatforms="false" includeConfigurePhase="false" includeMode="planner" includeSource="true" type="InstallableUnit">
  <unit id="org.eclipse.xtend.sdk.feature.group" version="0.0.0"/>
  <unit id="org.eclipse.xtext.sdk.feature.group" version="0.0.0"/>
  <repository location="https://download.eclipse.org/releases/2020-12/202012161000/"/>

diff --git a/...se.jdt.ls.tests/src/org/eclipse/jdt/ls/core/internal/correction/AbstractQuickFixTest.java b/...se.jdt.ls.tests/src/org/eclipse/jdt/ls/core/internal/correction/AbstractQuickFixTest.java
@@ -300,13 +300,17 @@ protected String evaluateCodeActionCommand(Either<Command, CodeAction> codeActio
  Assert.assertNotNull(c.getArguments());
  Assert.assertTrue(c.getArguments().get(0) instanceof WorkspaceEdit);
  WorkspaceEdit we = (WorkspaceEdit) c.getArguments().get(0);
- if (we.getDocumentChanges() != null) {
- return evaluateChanges(we.getDocumentChanges());
+ return evaluateWorkspaceEdit(we);
+ }
+
+ public static String evaluateWorkspaceEdit(WorkspaceEdit edit) throws JavaModelException, BadLocationException {
+ if (edit.getDocumentChanges() != null) {
+ return evaluateChanges(edit.getDocumentChanges());
  }
- return evaluateChanges(we.getChanges());
+ return evaluateChanges(edit.getChanges());
  }
 
- private String evaluateChanges(List<Either<TextDocumentEdit, ResourceOperation>> documentChanges) throws BadLocationException, JavaModelException {
+ public static String evaluateChanges(List<Either<TextDocumentEdit, ResourceOperation>> documentChanges) throws BadLocationException, JavaModelException {
  List<TextDocumentEdit> changes = documentChanges.stream().filter(e -> e.isLeft()).map(e -> e.getLeft()).collect(Collectors.toList());
  assertFalse("No edits generated", changes.isEmpty());
  Set<String> uris = changes.stream().map(tde -> tde.getTextDocument().getUri()).distinct().collect(Collectors.toSet());
@@ -316,15 +320,15 @@ private String evaluateChanges(List<Either<TextDocumentEdit, ResourceOperation>>
  return evaluateChanges(uri, edits);
  }
 
- protected String evaluateChanges(Map<String, List<TextEdit>> changes) throws BadLocationException, JavaModelException {
+ public static String evaluateChanges(Map<String, List<TextEdit>> changes) throws BadLocationException, JavaModelException {
  Iterator<Entry<String, List<TextEdit>>> editEntries = changes.entrySet().iterator();
  Entry<String, List<TextEdit>> entry = editEntries.next();
  assertNotNull("No edits generated", entry);
  assertEquals("More than one resource modified", false, editEntries.hasNext());
  return evaluateChanges(entry.getKey(), entry.getValue());
  }
 
- private String evaluateChanges(String uri, List<TextEdit> edits) throws BadLocationException, JavaModelException {
+ private static String evaluateChanges(String uri, List<TextEdit> edits) throws BadLocationException, JavaModelException {
  assertFalse("No edits generated: " + edits, edits == null || edits.isEmpty());
  ICompilationUnit cu = JDTUtils.resolveCompilationUnit(uri);
  assertNotNull("CU not found: " + uri, cu);