Fix C identifier lists for functions returning pointers

wpilibsuite · Jun 27, 2023 · 7bc8383 · 7bc8383
1 parent c5357db
commit 7bc8383
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/wpiformat/wpiformat/cidentlist.py b/wpiformat/wpiformat/cidentlist.py
@@ -38,12 +38,16 @@ def run_pipeline(self, config_file, name, lines):
         #
         # "def\\s+\w+" matches preprocessor directives "#ifdef" and "#ifndef" so
         # their contents aren't used as a return type.
+        #
+        # "\w+\**\s+\w+\s*" matches a function return type with 0 or more
+        # trailing asterisks, spaces, a function name, then spaces before the
+        # open parenthesis
         preproc_str = r"#else|#endif|"
         comment_str = r"/\*|\*/|//|" + linesep + r"|"
         string_str = r"\\\\|\\\"|\"|"
         char_str = r"\\'|'|"
         extern_str = r"(?P<ext_decl>extern \"C(\+\+)?\")\s+(?P<ext_brace>\{)?|"
-        braces_str = r"\{|\}|;|def\s+\w+|\w+\s+\w+\s*(?P<paren>\(\))"
+        braces_str = r"\{|\}|;|def\s+\w+|\w+\**\s+\w+\s*(?P<paren>\(\))"
         postfix_str = r"(?=\s*(;|\{))"
         token_regex = regex.compile(
             preproc_str

diff --git a/wpiformat/wpiformat/test/test_cidentlist.py b/wpiformat/wpiformat/test/test_cidentlist.py
@@ -484,4 +484,14 @@ def test_cidentlist():
     )
     test.add_latest_input_as_output(True)
 
+    # Ensure extern "C" function with pointer return type gets matched
+    test.add_input(
+        "./Test.cpp",
+        'extern "C" void* func() {}' + os.linesep,
+    )
+    test.add_output(
+        'extern "C" void* func(void) {}' + os.linesep,
+        True,
+    )
+
     test.run(OutputType.FILE)