Completion within markdown should escape array brackets #3773 (#2112)

Get the new display string for completion proposal via new API CompletionProposal#getDisplayString()

Author: jarthana

org.eclipse.jdt.text.tests/src/org/eclipse/jdt/text/tests/contentassist/CodeCompletionTest23.java

@@ -14,6 +14,7 @@
 package org.eclipse.jdt.text.tests.contentassist;
 
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
 
 import java.util.Hashtable;
 import java.util.List;
@@ -218,5 +219,48 @@ void method() {}
 			""";
 		assertEquals(expectedContents, doc.get());
 	}
+	@Test
+	public void testMarkdown_Escaped() throws CoreException {
+		IPackageFragmentRoot sourceFolder= JavaProjectHelper.addSourceContainer(fJProject1, "src");
+
+		IPackageFragment pack1= sourceFolder.createPackageFragment("javadoc", false, null);
+		String contents=
+			"""
+				///
+				/// see method [#ma
+				///
+				public class X {
+					public static void main(String[] args) {}
+				}""";
+		ICompilationUnit cu= pack1.createCompilationUnit("X.java", contents, false, null);
+
+
+		String str= "[#ma";
+
+		int offset= contents.indexOf(str) + str.length() - 1;
+
+		JavaTypeCompletionProposalComputer comp= new JavaAllCompletionProposalComputer();
+
+		List<ICompletionProposal> proposals= comp.computeCompletionProposals(createContext(offset, cu), null);
+		ICompletionProposal proposal = proposals.get(0);
+
+		IEditorPart part= JavaUI.openInEditor(cu);
+		IDocument doc= JavaUI.getDocumentProvider().getDocument(part.getEditorInput());
+		if (proposal != null) {
+			proposal.apply(doc);
+		}
+
+		String expectedContents=
+				"""
+			///
+			/// see method [#main(String\\[\\])
+			///
+			public class X {
+				public static void main(String[] args) {}
+			}""";
+		assertEquals(expectedContents, doc.get());
+		assertNotNull("Proposal is null", proposal);
+		assertEquals("Incorrect display string", "main(String[]) - X", proposal.getDisplayString());
+	}
 
 }

org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/java/FillArgumentNamesCompletionProposalCollector.java

@@ -66,7 +66,7 @@ protected IJavaCompletionProposal createJavaCompletionProposal(CompletionProposa
 	}
 
 	private IJavaCompletionProposal createMethodReferenceProposal(CompletionProposal methodProposal) {
-		String completion= String.valueOf(methodProposal.getCompletion());
+		String completion= String.valueOf(methodProposal.getDisplayString());
 		// super class' behavior if this is not a normal completion or has no
 		// parameters
 		if ((completion.length() == 0) || ((completion.length() == 1) && completion.charAt(0) == ')') || Signature.getParameterCount(methodProposal.getSignature()) == 0 || getContext().isInJavadoc())

org.eclipse.jdt.ui/ui/org/eclipse/jdt/ui/text/java/CompletionProposalLabelProvider.java

@@ -319,7 +319,7 @@ StyledString createJavadocMethodProposalLabel(CompletionProposal methodProposal)
 		StyledString nameBuffer= new StyledString();
 
 		// method name
-		nameBuffer.append(methodProposal.getCompletion());
+		nameBuffer.append(methodProposal.getDisplayString());
 
 		// declaring type
 		nameBuffer.append(QUALIFIER_SEPARATOR, StyledString.QUALIFIER_STYLER);