[23] [markdown] JDT is erratic in rendering markdown with newline cha…

…racters as unicode (#3256) #3256
eclipse-jdt · Nov 8, 2024 · dd9a963 · dd9a963
1 parent 2e87a52
commit dd9a963
Show file tree

Hide file tree

Showing 109 changed files with 308 additions and 3,247 deletions.
diff --git a/...re.compiler.batch/src/org/eclipse/jdt/internal/compiler/parser/AbstractCommentParser.java b/...re.compiler.batch/src/org/eclipse/jdt/internal/compiler/parser/AbstractCommentParser.java
@@ -3341,7 +3341,7 @@ protected int readToken() throws InvalidInputException {
 	}
 
 	protected boolean readMarkdownEscapedToken(int expectedToken) throws InvalidInputException {
-		if (!this.markdown)
+		if (!this.markdown || (this.tagValue != TAG_LINK_VALUE && this.tagValue != TAG_LINKPLAIN_VALUE))
 			return readToken() == expectedToken;
 		if (this.currentTokenType < 0) {
 			this.tokenPreviousPosition = this.scanner.currentPosition;

diff --git a/...e.jdt.core.compiler.batch/src/org/eclipse/jdt/internal/compiler/parser/JavadocParser.java b/...e.jdt.core.compiler.batch/src/org/eclipse/jdt/internal/compiler/parser/JavadocParser.java
@@ -601,7 +601,9 @@ protected boolean parseMarkdownLinks(int previousPosition) throws InvalidInputEx
 		}
 		int eofBkup = this.scanner.eofPosition;
 		this.scanner.resetTo(start, Math.max(this.javadocEnd, this.index));
+		this.tagValue = TAG_LINK_VALUE;
 		valid = parseReference(true);
+		this.tagValue = NO_TAG_VALUE;
 		this.scanner.eofPosition = eofBkup;
 		this.markdownHelper.resetLineStart();
 		return valid;

diff --git a/...eclipse.jdt.core.compiler.batch/src/org/eclipse/jdt/internal/compiler/parser/Scanner.java b/...eclipse.jdt.core.compiler.batch/src/org/eclipse/jdt/internal/compiler/parser/Scanner.java
@@ -557,13 +557,24 @@ protected final boolean scanForTextBlockBeginning() {
 	}
 	return false;
 }
-protected final boolean lineBeginsWithMarkdown() {
+protected final boolean lineBeginsWithMarkdown() throws InvalidInputException {
 	try {
 		int temp = this.currentPosition;
 		int count = 0;
 		// The scanner is already at \r, look for matching \n
-		if (this.currentCharacter == '\r' && this.source[temp] == '\n') {
-			temp++;
+		if (this.currentCharacter == '\r') {
+			char c = this.source[temp];
+			if (c == '\\') {
+				if (this.source[temp+1] == 'u') {
+					getNextUnicodeChar();
+					if (this.currentCharacter == '\n') {
+						pushUnicodeLineSeparator();
+					}
+					temp = this.currentPosition;
+				}
+			} else if (c == '\n') {
+				temp++;
+			}
 		}
 		while(true) {
 			char c = this.source[temp++];
@@ -1891,7 +1902,7 @@ protected int getNextToken0() throws InvalidInputException {
 									previous = this.currentPosition;
 									if (((this.currentCharacter = this.source[this.currentPosition++]) == '\\')
 										&& (this.source[this.currentPosition] == 'u')) {
-										//-------------unicode traitement ------------
+										//-------------unicode treatement ------------
 										getNextUnicodeChar();
 										isUnicode = true;
 									} else {

diff --git a/...jdt.core.tests.model/src/org/eclipse/jdt/core/tests/dom/ASTConverterJavadocFlattener.java b/...jdt.core.tests.model/src/org/eclipse/jdt/core/tests/dom/ASTConverterJavadocFlattener.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2000, 2016 IBM Corporation and others.
+ * Copyright (c) 2000, 2024 IBM Corporation and others.
  *
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
@@ -27,6 +27,7 @@ public class ASTConverterJavadocFlattener extends ASTVisitor {
 	private final StringBuilder buffer;
 	private final int indent = 0;
 	private final String comment;
+	private boolean markdown = false;
 
 /**
  * Creates a new AST printer.
@@ -91,13 +92,20 @@ public boolean visit(BlockComment node) {
  * @see ASTVisitor#visit(Javadoc)
  */
 public boolean visit(Javadoc javadoc) {
+	try {
+		this.markdown = javadoc.isMarkdown();
+	} catch(UnsupportedOperationException usoe) {
+		// nothing
+	}
 	printIndent();
-	this.buffer.append("/**");//$NON-NLS-1$
+	if (!this.markdown)
+		this.buffer.append("/**");//$NON-NLS-1$
 	for (Iterator it = javadoc.tags().iterator(); it.hasNext(); ) {
 		ASTNode e = (ASTNode) it.next();
 		e.accept(this);
 	}
-	this.buffer.append("\n */\n");//$NON-NLS-1$
+	if (!this.markdown)
+		this.buffer.append("\n */\n");//$NON-NLS-1$
 	return false;
 }
 
@@ -150,13 +158,15 @@ public boolean visit(MethodRef node) {
 	this.buffer.append("(");//$NON-NLS-1$
 	for (Iterator it = node.parameters().iterator(); it.hasNext(); ) {
 		MethodRefParameter e = (MethodRefParameter) it.next();
-		e.accept(this);
+		if (!this.markdown) {
+			e.accept(this);
+		}
 		if (it.hasNext()) {
 			this.buffer.append(",");//$NON-NLS-1$
 		}
 	}
 	this.buffer.append(")");//$NON-NLS-1$
-	return true;
+	return false;
 }
 
 /*
@@ -177,16 +187,24 @@ public boolean visit(MethodRefParameter node) {
  * @since 3.0
  */
 public boolean visit(TagElement node) {
+	String tagName = node.getTagName();
+	boolean isLink = this.markdown && tagName != null && tagName.equals("@link");
 	if (node.isNested()) {
 		// nested tags are always enclosed in braces
-		this.buffer.append("{");//$NON-NLS-1$
+		if (isLink)
+			this.buffer.append("[");//$NON-NLS-1$
+		else
+			this.buffer.append("{");//$NON-NLS-1$
 	} else {
 		// top-level tags always begin on a new line
-		this.buffer.append("\n * ");//$NON-NLS-1$
+		if (this.markdown)
+			this.buffer.append("\n/// ");//$NON-NLS-1$
+		else
+			this.buffer.append("\n * ");//$NON-NLS-1$
 	}
 	boolean previousRequiresWhiteSpace = false;
-	if (node.getTagName() != null) {
-		this.buffer.append(node.getTagName());
+	if (tagName != null && !isLink) {
+		this.buffer.append(tagName);
 		previousRequiresWhiteSpace = true;
 	}
 	boolean previousRequiresNewLine = false;
@@ -196,7 +214,10 @@ public boolean visit(TagElement node) {
 		// but Name, MemberRef, MethodRef, and nested TagElement do not include white space
 		boolean currentIncludesWhiteSpace = (e instanceof TextElement);
 		if (previousRequiresNewLine && currentIncludesWhiteSpace) {
-			this.buffer.append("\n * ");//$NON-NLS-1$
+			if (this.markdown)
+				this.buffer.append("\n/// ");//$NON-NLS-1$
+			else
+				this.buffer.append("\n * ");//$NON-NLS-1$
 		}
 		previousRequiresNewLine = currentIncludesWhiteSpace;
 		// add space if required to separate
@@ -207,7 +228,10 @@ public boolean visit(TagElement node) {
 		previousRequiresWhiteSpace = !currentIncludesWhiteSpace && !(e instanceof TagElement);
 	}
 	if (node.isNested()) {
-		this.buffer.append("}");//$NON-NLS-1$
+		if (isLink)
+			this.buffer.append("]");//$NON-NLS-1$
+		else
+			this.buffer.append("}");//$NON-NLS-1$
 	}
 	return false;
 }