nested comment block as error

Author: mcspr

tools/mkbuildoptglobals.py

@@ -176,10 +176,13 @@ def filter(self, rec):
 
 
 class ParsingException(Exception):
-    def __init__(self, file: Optional[str], lineno: int, line: str):
+    def __init__(self, file: Optional[str], lineno: int, line: str, start: int = 0):
         self.file = file
         self.lineno = lineno
         self.line = line
+        if start < 0:
+            start = 0
+        self.start = start
 
     def __str__(self):
         out = ""
@@ -191,7 +194,9 @@ def __str__(self):
         out += f"\n\n{lineno} {self.line}"
 
         out += f'\n{" " * len(lineno)} '
-        out += "^" * len(self.line.strip())
+        if self.start:
+            out += " " * self.start
+        out += "^" * (len(self.line.strip()) - self.start)
 
         return out
 
@@ -204,6 +209,10 @@ class InvalidSyntax(ParsingException):
     pass
 
 
+class InvalidComment(ParsingException):
+    pass
+
+
 def extract_build_opt(name: str, dst: TextIO, src: TextIO):
     """
     Read src line by line and extract matching 'create-file' directives.
@@ -254,12 +263,18 @@ def extract_build_opt(name: str, dst: TextIO, src: TextIO):
                 state = IN_RAW
                 continue
 
-            if line.startswith(("#", "//", "*")):
+            if not line:
                 continue
 
-            if not line:
+            # allow standalone comments on each line
+            if line.startswith(("#", "//", "*")):
                 continue
 
+            # but not nested ones. this should get caught by -Wcomment, too
+            for comment in ("/*", "*/"):
+                if comment in line:
+                    raise InvalidComment(None, n, raw_line, raw_line.index(comment))
+
             block.append(f"{line}\n")
 
     if state != IN_RAW:

tools/test_mkbuildoptglobals.py

@@ -5,7 +5,7 @@
 import unittest
 
 from typing import TextIO
-from mkbuildoptglobals import extract_build_opt, InvalidSignature, InvalidSyntax
+from mkbuildoptglobals import extract_build_opt, InvalidSignature, InvalidSyntax, InvalidComment
 import contextlib
 
 
@@ -281,6 +281,29 @@ def testParseSignatureSpace(self):
 
             self.assertFalse(dst.getvalue())
 
+    def testCommentBlock(self):
+        src = io.StringIO(
+            r"""
+/*@create-file:commented.opt@
+-ffoo /* wat? */
+-fbar
+  /*   oopsie  */
+*/
+line 1
+line 2
+"""
+        )
+        dst = io.StringIO()
+        with self.assertRaises(InvalidComment) as raises:
+            extract_build_opt("commented.opt", dst, src)
+
+        self.assertFalse(dst.getvalue())
+
+        e = raises.exception
+        self.assertFalse(e.file)
+        self.assertEqual(3, e.lineno)
+        self.assertIn("wat?", e.line)
+
 
 if __name__ == "__main__":
     unittest.main()