fix moved or eaten comments (fixes #102, #111) (#112)

Author: arnetheduck

src/phparser.nim

@@ -2598,7 +2598,7 @@ proc parseStmtPragma(p: var Parser): PNode =
     result = newNodeI(nkPragmaBlock, a.info)
     result.add a
     getTok(p)
-    splitLookahead(p, result, clPostfix) # TODO mid
+    splitLookahead(p, result, clMid)
     result.add parseStmt(p)
     splitLookahead(p, result, clPostfix)
   setEndInfo()

src/phrenderer.nim

@@ -1359,7 +1359,12 @@ proc infixArgument(g: var TOutput, n: PNode, i: int, flags: SubFlags) =
     put(g, tkParRi, ")")
 
 proc postStatements(
-    g: var TOutput, n: PNode, start: int, skipDo: bool, skipColon = false
+    g: var TOutput,
+    n: PNode,
+    start: int,
+    skipDo: bool,
+    skipColon = false,
+    skipMids = true,
 ) =
   # Sometimes, `do` can be skipped but it is not entirely clear when - this
   # feature rests on experiments with large codebases but should be researched
@@ -1378,6 +1383,9 @@ proc postStatements(
   elif not skipColon:
     putWithSpace(g, tkColon, ":")
 
+  if not skipMids:
+    gmids(g, n)
+
   gsub(g, n[i])
 
   i.inc
@@ -1483,7 +1491,8 @@ proc gsub(g: var TOutput, n: PNode, flags: SubFlags, extra: int) =
           g, n, tkParLe, start = 1, theEnd = i - 1 - n.len, flags = {lfLongSepAtEnd}
         )
 
-      postStatements(g, n, i, sfSkipDo in flags)
+      postStatements(g, n, i, sfSkipDo in flags, skipMids = i > 1)
+
       dedent(g, ind)
 
       if n.lastSon.kind == nkDo and sfParDo in flags:
@@ -1561,7 +1570,9 @@ proc gsub(g: var TOutput, n: PNode, flags: SubFlags, extra: int) =
       # ":" is present so it looks like we can skip the `do` here :/ this needs
       # deeper investigation - see also `nkPar` which sometimes removes the
       # parenthesis from the AST
-      postStatements(g, n, i, sfSkipDo in flags, n[i].kind == nkStmtListExpr)
+      postStatements(
+        g, n, i, sfSkipDo in flags, n[i].kind == nkStmtListExpr, skipMids = false
+      )
     else:
       # The first argument must not be line-broken, or command syntax breaks!
       if n.len > 1:

tests/after/comments.nim

@@ -498,3 +498,19 @@ block:
     discard
   else: #comment
     discard
+
+checkUntilTimeout: # wait for nodes subscribe to finish
+  discard
+
+checkUntilTimeout( # wait for nodes subscribe to finish
+  arg
+)
+
+checkUntilTimeout: # wait for nodes subscribe to finish
+  discard
+
+command a: # comment
+  discard
+
+{.gcsafe.}: # comment
+  discard

tests/after/comments.nim.nph.yaml

@@ -2038,3 +2038,59 @@ sons:
                       - kind: "nkDiscardStmt"
                         sons:
                           - kind: "nkEmpty"
+  - kind: "nkCall"
+    mid:
+      - "# wait for nodes subscribe to finish"
+    sons:
+      - kind: "nkIdent"
+        ident: "checkUntilTimeout"
+      - kind: "nkStmtList"
+        sons:
+          - kind: "nkDiscardStmt"
+            sons:
+              - kind: "nkEmpty"
+  - kind: "nkCall"
+    mid:
+      - "# wait for nodes subscribe to finish"
+    sons:
+      - kind: "nkIdent"
+        ident: "checkUntilTimeout"
+      - kind: "nkIdent"
+        ident: "arg"
+  - kind: "nkCall"
+    mid:
+      - "# wait for nodes subscribe to finish"
+    sons:
+      - kind: "nkIdent"
+        ident: "checkUntilTimeout"
+      - kind: "nkStmtList"
+        sons:
+          - kind: "nkDiscardStmt"
+            sons:
+              - kind: "nkEmpty"
+  - kind: "nkCommand"
+    mid:
+      - "# comment"
+    sons:
+      - kind: "nkIdent"
+        ident: "command"
+      - kind: "nkIdent"
+        ident: "a"
+      - kind: "nkStmtList"
+        sons:
+          - kind: "nkDiscardStmt"
+            sons:
+              - kind: "nkEmpty"
+  - kind: "nkPragmaBlock"
+    mid:
+      - "# comment"
+    sons:
+      - kind: "nkPragma"
+        sons:
+          - kind: "nkIdent"
+            ident: "gcsafe"
+      - kind: "nkStmtList"
+        sons:
+          - kind: "nkDiscardStmt"
+            sons:
+              - kind: "nkEmpty"

tests/before/comments.nim

@@ -492,4 +492,22 @@ block:
     true:
       discard
   else #comment
-    : discard
+    : discard
+
+checkUntilTimeout: # wait for nodes subscribe to finish
+  discard
+
+checkUntilTimeout(# wait for nodes subscribe to finish
+  arg
+)
+
+checkUntilTimeout(# wait for nodes subscribe to finish
+):
+  discard
+
+command a:# comment
+  discard
+
+{.gcsafe.}: # comment
+  discard
+  

tests/before/comments.nim.nph.yaml

@@ -2034,3 +2034,59 @@ sons:
                       - kind: "nkDiscardStmt"
                         sons:
                           - kind: "nkEmpty"
+  - kind: "nkCall"
+    mid:
+      - "# wait for nodes subscribe to finish"
+    sons:
+      - kind: "nkIdent"
+        ident: "checkUntilTimeout"
+      - kind: "nkStmtList"
+        sons:
+          - kind: "nkDiscardStmt"
+            sons:
+              - kind: "nkEmpty"
+  - kind: "nkCall"
+    mid:
+      - "# wait for nodes subscribe to finish"
+    sons:
+      - kind: "nkIdent"
+        ident: "checkUntilTimeout"
+      - kind: "nkIdent"
+        ident: "arg"
+  - kind: "nkCall"
+    mid:
+      - "# wait for nodes subscribe to finish"
+    sons:
+      - kind: "nkIdent"
+        ident: "checkUntilTimeout"
+      - kind: "nkStmtList"
+        sons:
+          - kind: "nkDiscardStmt"
+            sons:
+              - kind: "nkEmpty"
+  - kind: "nkCommand"
+    mid:
+      - "# comment"
+    sons:
+      - kind: "nkIdent"
+        ident: "command"
+      - kind: "nkIdent"
+        ident: "a"
+      - kind: "nkStmtList"
+        sons:
+          - kind: "nkDiscardStmt"
+            sons:
+              - kind: "nkEmpty"
+  - kind: "nkPragmaBlock"
+    mid:
+      - "# comment"
+    sons:
+      - kind: "nkPragma"
+        sons:
+          - kind: "nkIdent"
+            ident: "gcsafe"
+      - kind: "nkStmtList"
+        sons:
+          - kind: "nkDiscardStmt"
+            sons:
+              - kind: "nkEmpty"