From 6bef8953135c360d6ad15afb067716efaa8775f7 Mon Sep 17 00:00:00 2001
From: Campbell Barton <ideasman42@gmail.com>
Date: Wed, 12 Oct 2022 10:40:58 +1100
Subject: [PATCH] code_clean: add unused_arg_as_comment edit generator
---
utils_maintenance/code_clean.py | 39 +++++++++++++++++++++++++++++++++
1 file changed, 39 insertions(+)
diff --git a/utils_maintenance/code_clean.py b/utils_maintenance/code_clean.py
index 86e9fe8..1e567c0 100755
--- a/utils_maintenance/code_clean.py
+++ b/utils_maintenance/code_clean.py
@@ -526,6 +526,45 @@ class edit_generators:
return edits
+ class unused_arg_as_comment(EditGenerator):
+ """
+ Replace `UNUSED(argument)` in C++ code.
+
+ Replace:
+ void function(int UNUSED(arg)) {...}
+ With:
+ void function(int /*arg*/) {...}
+ """
+ @staticmethod
+ def edit_list_from_file(source: str, data: str, _shared_edit_data: Any) -> List[Edit]:
+ edits = []
+
+ # The user might exclude C++, if they forget, it is better not to operate on C.
+ if not source.lower().endswith((".h", ".c")):
+ return edits
+
+ # `UNUSED(arg)` -> `/*arg*/`.
+ for match in re.finditer(
+ r"\b(UNUSED)"
+ # # Opening parenthesis.
+ r"\("
+ # Capture the identifier as group 1.
+ r"([" + "".join(list(IDENTIFIER_CHARS)) + "]+)"
+ # # Capture any non-identifier characters as group 2.
+ # (e.g. `[3]`) which need to be added outside the comment.
+ r"([^\)]*)"
+ # Closing parenthesis of `UNUSED(..)`.
+ r"\)",
+ data,
+ ):
+ edits.append(Edit(
+ span=match.span(),
+ content='/*%s*/%s' % (match.group(2), match.group(3)),
+ content_fail='__ALWAYS_FAIL__(%s%s)' % (match.group(2), match.group(3)),
+ ))
+
+ return edits
+
class use_elem_macro(EditGenerator):
"""
Use the `ELEM` macro for more abbreviated expressions.
--
GitLab