trivia index

Author: Frotty

de.peeeq.wurstscript/src/main/java/de/peeeq/wurstscript/WurstParser.java

@@ -14,6 +14,7 @@
 import de.peeeq.wurstscript.jurst.ExtendedJurstLexer;
 import de.peeeq.wurstscript.jurst.antlr.JurstParser;
 import de.peeeq.wurstscript.parser.AntlrTokenPipeline;
+import de.peeeq.wurstscript.parser.TriviaIndex;
 import de.peeeq.wurstscript.parser.WurstAntlrErrorListener;
 import de.peeeq.wurstscript.parser.antlr.AntlrWurstParseTreeTransformer;
 import de.peeeq.wurstscript.parser.antlr.ExtendedWurstLexer;
@@ -104,6 +105,7 @@ private CompilationUnit parseWithAntlr(Reader reader, final String source, boole
                 removeSyntacticSugar(root, hasCommonJ);
             }
             root.getCuInfo().setIndentationMode(lexerRef[0].getIndentationMode());
+            root.getCuInfo().setTriviaIndex(TriviaIndex.fromTokens(res.tokens.getTokens()));
             return root;
 
         } catch (IOException e) {

de.peeeq.wurstscript/src/main/java/de/peeeq/wurstscript/attributes/AttrWurstDoc.java

@@ -6,6 +6,10 @@
 public class AttrWurstDoc {
 
     public static String getComment(NameDef nameDef) {
+        String triviaComment = getCommentFromTrivia(nameDef);
+        if (!triviaComment.isEmpty()) {
+            return triviaComment;
+        }
         if (nameDef instanceof HasModifier) {
             HasModifier HasModifier = nameDef;
             return getCommmentHelper(HasModifier);
@@ -26,12 +30,28 @@ private static String getCommmentHelper(
     }
 
     public static String getComment(ConstructorDef constructorDef) {
+        String triviaComment = getCommentFromTrivia(constructorDef);
+        if (!triviaComment.isEmpty()) {
+            return triviaComment;
+        }
         return getCommmentHelper(constructorDef);
     }
 
 
+    private static String getCommentFromTrivia(AstElementWithSource e) {
+        CompilationUnit cu = e.attrCompilationUnit();
+        if (cu == null || cu.getCuInfo() == null) {
+            return "";
+        }
+        return cu.getCuInfo().getTriviaIndex().findLeadingHotdoc(e.getSource().getLeftPos());
+    }
+
     private static String comment(WurstDoc wurstDoc) {
-        String result = wurstDoc.getRawComment();
+        return normalizeHotdocComment(wurstDoc.getRawComment());
+    }
+
+    public static String normalizeHotdocComment(String rawComment) {
+        String result = rawComment;
         if (result.length() <= 5) {
             return "";
         }

de.peeeq.wurstscript/src/main/java/de/peeeq/wurstscript/attributes/CompilationUnitInfo.java

@@ -1,5 +1,6 @@
 package de.peeeq.wurstscript.attributes;
 
+import de.peeeq.wurstscript.parser.TriviaIndex;
 import de.peeeq.wurstscript.utils.Utils;
 
 /**
@@ -9,6 +10,7 @@ public class CompilationUnitInfo {
     private String file = "";
     private de.peeeq.wurstscript.attributes.ErrorHandler cuErrorHandler;
     private IndentationMode indentationMode = IndentationMode.spaces(4);
+    private TriviaIndex triviaIndex = TriviaIndex.empty();
 
     public CompilationUnitInfo(ErrorHandler cuErrorHandler) {
         this.cuErrorHandler = cuErrorHandler;
@@ -38,6 +40,14 @@ public void setIndentationMode(IndentationMode indentationMode) {
         this.indentationMode = indentationMode;
     }
 
+    public TriviaIndex getTriviaIndex() {
+        return triviaIndex;
+    }
+
+    public void setTriviaIndex(TriviaIndex triviaIndex) {
+        this.triviaIndex = triviaIndex == null ? TriviaIndex.empty() : triviaIndex;
+    }
+
     public interface IndentationMode {
 
         static IndentationMode tabs() {

de.peeeq.wurstscript/src/main/java/de/peeeq/wurstscript/parser/TriviaIndex.java

@@ -0,0 +1,75 @@
+package de.peeeq.wurstscript.parser;
+
+import de.peeeq.wurstscript.antlr.WurstParser;
+import de.peeeq.wurstscript.attributes.AttrWurstDoc;
+import org.antlr.v4.runtime.Token;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+public final class TriviaIndex {
+
+    private static final TriviaIndex EMPTY = new TriviaIndex(Collections.emptyList());
+
+    private final List<Token> tokens;
+
+    private TriviaIndex(List<Token> tokens) {
+        this.tokens = tokens;
+    }
+
+    public static TriviaIndex empty() {
+        return EMPTY;
+    }
+
+    public static TriviaIndex fromTokens(List<Token> tokens) {
+        if (tokens == null || tokens.isEmpty()) {
+            return EMPTY;
+        }
+        return new TriviaIndex(new ArrayList<>(tokens));
+    }
+
+    public String findLeadingHotdoc(int declarationStartOffset) {
+        int targetTokenIndex = firstNonTriviaTokenAtOrAfter(declarationStartOffset);
+        if (targetTokenIndex < 0) {
+            return "";
+        }
+        for (int i = targetTokenIndex - 1; i >= 0; i--) {
+            Token token = tokens.get(i);
+            int type = token.getType();
+            if (type == WurstParser.HOTDOC_COMMENT) {
+                return AttrWurstDoc.normalizeHotdocComment(token.getText());
+            }
+            if (!isTriviaBetweenDocAndDeclaration(token)) {
+                return "";
+            }
+        }
+        return "";
+    }
+
+    private int firstNonTriviaTokenAtOrAfter(int offset) {
+        for (int i = 0; i < tokens.size(); i++) {
+            Token token = tokens.get(i);
+            if (token.getStartIndex() < offset) {
+                continue;
+            }
+            if (!isTriviaBetweenDocAndDeclaration(token)) {
+                return i;
+            }
+        }
+        return -1;
+    }
+
+    private boolean isTriviaBetweenDocAndDeclaration(Token token) {
+        int type = token.getType();
+        if (type == WurstParser.HOTDOC_COMMENT
+            || type == WurstParser.LINE_COMMENT
+            || type == WurstParser.ML_COMMENT
+            || type == WurstParser.NL
+            || type == WurstParser.TAB
+            || type == WurstParser.SPACETAB) {
+            return true;
+        }
+        return token.getChannel() != Token.DEFAULT_CHANNEL;
+    }
+}

de.peeeq.wurstscript/src/test/java/tests/wurstscript/tests/AutoCompleteTests.java

@@ -451,6 +451,29 @@ public void nonConstantArrayDoesNotSuggestLength() {
         );
     }
 
+    @Test
+    public void completionUsesHotdocComment() {
+        CompletionTestData testData = input(
+                "package test",
+                "/** docs for foo */",
+                "function fooBar()",
+                "init",
+                "    foo|",
+                "endpackage"
+        );
+
+        CompletionList completions = calculateCompletions(testData);
+        CompletionItem completion = completions.getItems().stream()
+                .filter(c -> "fooBar".equals(c.getLabel()))
+                .findFirst()
+                .orElseThrow(() -> new AssertionError("fooBar completion not found"));
+
+        assertTrue(
+                completion.getDocumentation() != null && completion.getDocumentation().getLeft().contains("docs for foo"),
+                "completion documentation = " + completion.getDocumentation()
+        );
+    }
+
 	private void testCompletions(CompletionTestData testData, String... expectedCompletions) {
         testCompletions(testData, Arrays.asList(expectedCompletions));
     }

de.peeeq.wurstscript/src/test/java/tests/wurstscript/tests/HoverTests.java

@@ -14,6 +14,7 @@
 import java.util.stream.Collectors;
 
 import static org.testng.Assert.assertEquals;
+import static org.testng.Assert.assertTrue;
 
 /**
  * tests the get definition functionality.
@@ -35,6 +36,19 @@ public void nonexistantModule() {
         assertEquals(Collections.emptyList(), text);
     }
 
+    @Test
+    public void hoverUsesHotdocComment() {
+        CompletionTestData testData = input(
+                "package test",
+                "/** this is hover doc */",
+                "function fo|o()",
+                "endpackage"
+        );
+
+        List<String> text = testHoverText(testData);
+        assertTrue(text.stream().anyMatch(s -> s.contains("this is hover doc")), "hover text = " + text);
+    }
+
 
     private List<String> testHoverText(CompletionTestData testData) {
         Hover result = getHoverInfo(testData);