Preprocessor5: add Rule 20-7

knewbury01 · knewbury01 · commit 2b0527b48587 · 2022-07-25T10:48:33.000-04:00
diff --git a/c/common/test/rules/macroparameternotenclosedinparentheses/MacroParameterNotEnclosedInParentheses.expected b/c/common/test/rules/macroparameternotenclosedinparentheses/MacroParameterNotEnclosedInParentheses.expected
@@ -0,0 +1,3 @@
+| test.c:1:1:1:27 | #define MACRO(X,Y) (X * Y) | Accesses of parameter 'X' are not always enclosed in parentheses in the macro MACRO. |
+| test.c:1:1:1:27 | #define MACRO(X,Y) (X * Y) | Accesses of parameter 'Y' are not always enclosed in parentheses in the macro MACRO. |
+| test.c:4:1:4:29 | #define MACROFOUR(X,Y) (X).Y | Accesses of parameter 'Y' are not always enclosed in parentheses in the macro MACROFOUR. |
diff --git a/c/common/test/rules/macroparameternotenclosedinparentheses/MacroParameterNotEnclosedInParentheses.ql b/c/common/test/rules/macroparameternotenclosedinparentheses/MacroParameterNotEnclosedInParentheses.ql
@@ -0,0 +1,2 @@
+// GENERATED FILE - DO NOT MODIFY
+import codingstandards.cpp.rules.macroparameternotenclosedinparentheses.MacroParameterNotEnclosedInParentheses
diff --git a/c/common/test/rules/macroparameternotenclosedinparentheses/test.c b/c/common/test/rules/macroparameternotenclosedinparentheses/test.c
@@ -0,0 +1,7 @@
+#define MACRO(X, Y) (X * Y)        // NON_COMPLIANT
+#define MACROTWO(X, Y) ((X) * (Y)) // COMPLIANT
+#define MACROTHREE(X) a##X *(X)    // COMPLIANT
+#define MACROFOUR(X, Y) (X).Y      // COMPLIANT[FALSE_POSITIVE]
+
+#define MACROFIVE(Y) MACROSIX(Y) // COMPLIANT
+#define MACROSIX(X) ((X) + 1)    // COMPLIANT
diff --git a/c/misra/src/rules/RULE-20-7/MacroParameterNotEnclosedInParenthesesCQuery.ql b/c/misra/src/rules/RULE-20-7/MacroParameterNotEnclosedInParenthesesCQuery.ql
@@ -0,0 +1,24 @@
+/**
+ * @id c/misra/macro-parameter-not-enclosed-in-parentheses-c-query
+ * @name RULE-20-7: Expressions resulting from the expansion of macro parameters shall be enclosed in parentheses
+ * @description In the definition of a function-like macro, each instance of a parameter shall be
+ *              enclosed in parentheses, otherwise the result of preprocessor macro substitition may
+ *              not be as expected.
+ * @kind problem
+ * @precision high
+ * @problem.severity warning
+ * @tags external/misra/id/rule-20-7
+ *       correctness
+ *       readability
+ *       external/misra/obligation/required
+ */
+
+import cpp
+import codingstandards.c.misra
+import codingstandards.cpp.rules.macroparameternotenclosedinparentheses.MacroParameterNotEnclosedInParentheses
+
+class MacroParameterNotEnclosedInParenthesesCQueryQuery extends MacroParameterNotEnclosedInParenthesesSharedQuery {
+  MacroParameterNotEnclosedInParenthesesCQueryQuery() {
+    this = Preprocessor5Package::macroParameterNotEnclosedInParenthesesCQueryQuery()
+  }
+}
diff --git a/c/misra/test/rules/RULE-20-7/MacroParameterNotEnclosedInParenthesesCQuery.testref b/c/misra/test/rules/RULE-20-7/MacroParameterNotEnclosedInParenthesesCQuery.testref
@@ -0,0 +1 @@
+c/common/test/rules/macroparameternotenclosedinparentheses/MacroParameterNotEnclosedInParentheses.ql
diff --git a/cpp/autosar/src/rules/M16-0-6/FunctionLikeMacroParameterNotEnclosedInParentheses.ql b/cpp/autosar/src/rules/M16-0-6/FunctionLikeMacroParameterNotEnclosedInParentheses.ql
@@ -17,29 +17,10 @@
 
 import cpp
 import codingstandards.cpp.autosar
-import codingstandards.cpp.FunctionLikeMacro
+import codingstandards.cpp.rules.macroparameternotenclosedinparentheses.MacroParameterNotEnclosedInParentheses
 
-from FunctionLikeMacro m, string param, string squishedBody
-where
-  not isExcluded(m, MacrosPackage::functionLikeMacroParameterNotEnclosedInParenthesesQuery()) and
-  param = m.getAParameter() and
-  //chop out identifiers that contain a substring matching our parameter identifier (i.e., wrapped in other valid identifier characters)
-  squishedBody =
-    m.getBody()
-        .regexpReplaceAll("([\\w]*" + param + "[\\w]+)|([\\w]+" + param + "[\\w]*)", "")
-        .replaceAll(" ", "") and
-  (
-    squishedBody.regexpMatch(".*[^\\(]" + param + ".*") or
-    squishedBody.regexpMatch(".*" + param + "[^\\)].*") or
-    squishedBody.regexpMatch("^" + param + "$")
-  ) and
-  not (
-    //case where param is right hand side operand to either # or ## operator
-    squishedBody.regexpMatch(".*\\#{1,2}?" + param + ".*")
-    or
-    //case where param is left hand side operand to either # or ## operator
-    squishedBody.regexpMatch(".*" + param + "\\#{1,2}?.*")
-  )
-select m,
-  "Accesses of parameter '" + param + "' are not always enclosed in parentheses in the macro " +
-    m.getName() + "."
+class MacroParameterNotEnclosedInParenthesesCQueryQuery extends MacroParameterNotEnclosedInParenthesesSharedQuery {
+  MacroParameterNotEnclosedInParenthesesCQueryQuery() {
+    this = MacrosPackage::functionLikeMacroParameterNotEnclosedInParenthesesQuery()
+  }
+}
diff --git a/cpp/autosar/test/rules/M16-0-6/FunctionLikeMacroParameterNotEnclosedInParentheses.qlref b/cpp/autosar/test/rules/M16-0-6/FunctionLikeMacroParameterNotEnclosedInParentheses.qlref
diff --git a/cpp/autosar/test/rules/M16-0-6/FunctionLikeMacroParameterNotEnclosedInParentheses.testref b/cpp/autosar/test/rules/M16-0-6/FunctionLikeMacroParameterNotEnclosedInParentheses.testref
@@ -0,0 +1 @@
+cpp/common/test/rules/macroparameternotenclosedinparentheses/MacroParameterNotEnclosedInParentheses.ql
diff --git a/cpp/common/src/codingstandards/cpp/exclusions/c/Preprocessor5.qll b/cpp/common/src/codingstandards/cpp/exclusions/c/Preprocessor5.qll
@@ -0,0 +1,25 @@
+//** THIS FILE IS AUTOGENERATED, DO NOT MODIFY DIRECTLY.  **/
+import cpp
+import RuleMetadata
+import codingstandards.cpp.exclusions.RuleMetadata
+
+newtype Preprocessor5Query = TMacroParameterNotEnclosedInParenthesesCQueryQuery()
+
+predicate isPreprocessor5QueryMetadata(Query query, string queryId, string ruleId) {
+  query =
+    // `Query` instance for the `macroParameterNotEnclosedInParenthesesCQuery` query
+    Preprocessor5Package::macroParameterNotEnclosedInParenthesesCQueryQuery() and
+  queryId =
+    // `@id` for the `macroParameterNotEnclosedInParenthesesCQuery` query
+    "c/misra/macro-parameter-not-enclosed-in-parentheses-c-query" and
+  ruleId = "RULE-20-7"
+}
+
+module Preprocessor5Package {
+  Query macroParameterNotEnclosedInParenthesesCQueryQuery() {
+    //autogenerate `Query` type
+    result =
+      // `Query` type for `macroParameterNotEnclosedInParenthesesCQuery` query
+      TQueryC(TPreprocessor5PackageQuery(TMacroParameterNotEnclosedInParenthesesCQueryQuery()))
+  }
+}
diff --git a/cpp/common/src/codingstandards/cpp/exclusions/c/RuleMetadata.qll b/cpp/common/src/codingstandards/cpp/exclusions/c/RuleMetadata.qll
@@ -14,6 +14,7 @@ import Preprocessor1
 import Preprocessor2
 import Preprocessor3
 import Preprocessor4
+import Preprocessor5
 import SideEffects1
 import SideEffects2
 import Strings1
@@ -35,6 +36,7 @@ newtype TCQuery =
   TPreprocessor2PackageQuery(Preprocessor2Query q) or
   TPreprocessor3PackageQuery(Preprocessor3Query q) or
   TPreprocessor4PackageQuery(Preprocessor4Query q) or
+  TPreprocessor5PackageQuery(Preprocessor5Query q) or
   TSideEffects1PackageQuery(SideEffects1Query q) or
   TSideEffects2PackageQuery(SideEffects2Query q) or
   TStrings1PackageQuery(Strings1Query q) or
@@ -56,6 +58,7 @@ predicate isQueryMetadata(Query query, string queryId, string ruleId) {
   isPreprocessor2QueryMetadata(query, queryId, ruleId) or
   isPreprocessor3QueryMetadata(query, queryId, ruleId) or
   isPreprocessor4QueryMetadata(query, queryId, ruleId) or
+  isPreprocessor5QueryMetadata(query, queryId, ruleId) or
   isSideEffects1QueryMetadata(query, queryId, ruleId) or
   isSideEffects2QueryMetadata(query, queryId, ruleId) or
   isStrings1QueryMetadata(query, queryId, ruleId) or
diff --git a/cpp/common/src/codingstandards/cpp/rules/macroparameternotenclosedinparentheses/MacroParameterNotEnclosedInParentheses.qll b/cpp/common/src/codingstandards/cpp/rules/macroparameternotenclosedinparentheses/MacroParameterNotEnclosedInParentheses.qll
@@ -0,0 +1,39 @@
+/**
+ * Provides a library which includes a `problems` predicate for reporting....
+ */
+
+import cpp
+import codingstandards.cpp.Customizations
+import codingstandards.cpp.Exclusions
+import codingstandards.cpp.FunctionLikeMacro
+
+abstract class MacroParameterNotEnclosedInParenthesesSharedQuery extends Query { }
+
+Query getQuery() { result instanceof MacroParameterNotEnclosedInParenthesesSharedQuery }
+
+query predicate problems(FunctionLikeMacro m, string message) {
+  exists(string param, string squishedBody |
+    not isExcluded(m, getQuery()) and
+    param = m.getAParameter() and
+    //chop out identifiers that contain a substring matching our parameter identifier (i.e., wrapped in other valid identifier characters)
+    squishedBody =
+      m.getBody()
+          .regexpReplaceAll("([\\w]*" + param + "[\\w]+)|([\\w]+" + param + "[\\w]*)", "")
+          .replaceAll(" ", "") and
+    (
+      squishedBody.regexpMatch(".*[^\\(]" + param + ".*") or
+      squishedBody.regexpMatch(".*" + param + "[^\\)].*") or
+      squishedBody.regexpMatch("^" + param + "$")
+    ) and
+    not (
+      //case where param is right hand side operand to either # or ## operator
+      squishedBody.regexpMatch(".*\\#{1,2}?" + param + ".*")
+      or
+      //case where param is left hand side operand to either # or ## operator
+      squishedBody.regexpMatch(".*" + param + "\\#{1,2}?.*")
+    ) and
+    message =
+      "Accesses of parameter '" + param + "' are not always enclosed in parentheses in the macro " +
+        m.getName() + "."
+  )
+}
diff --git a/cpp/common/test/rules/macroparameternotenclosedinparentheses/MacroParameterNotEnclosedInParentheses.expected b/cpp/common/test/rules/macroparameternotenclosedinparentheses/MacroParameterNotEnclosedInParentheses.expected
diff --git a/cpp/common/test/rules/macroparameternotenclosedinparentheses/MacroParameterNotEnclosedInParentheses.ql b/cpp/common/test/rules/macroparameternotenclosedinparentheses/MacroParameterNotEnclosedInParentheses.ql
@@ -0,0 +1,2 @@
+// GENERATED FILE - DO NOT MODIFY
+import codingstandards.cpp.rules.macroparameternotenclosedinparentheses.MacroParameterNotEnclosedInParentheses
diff --git a/cpp/common/test/rules/macroparameternotenclosedinparentheses/test.cpp b/cpp/common/test/rules/macroparameternotenclosedinparentheses/test.cpp
diff --git a/rule_packages/c/Preprocessor5.json b/rule_packages/c/Preprocessor5.json
@@ -0,0 +1,25 @@
+{
+  "MISRA-C-2012": {
+    "RULE-20-7": {
+      "properties": {
+        "obligation": "required"
+      },
+      "queries": [
+        {
+          "description": "In the definition of a function-like macro, each instance of a parameter shall be enclosed in parentheses, otherwise the result of preprocessor macro substitition may not be as expected.",
+          "kind": "problem",
+          "name": "Expressions resulting from the expansion of macro parameters shall be enclosed in parentheses",
+          "precision": "high",
+          "severity": "warning",
+          "short_name": "MacroParameterNotEnclosedInParenthesesCQuery",
+          "shared_implementation_short_name": "MacroParameterNotEnclosedInParentheses",
+          "tags": [
+            "correctness",
+            "readability"
+          ]
+        }
+      ],
+      "title": "Expressions resulting from the expansion of macro parameters shall be enclosed in parentheses"
+    }
+  }
+}
diff --git a/rule_packages/cpp/Macros.json b/rule_packages/cpp/Macros.json
@@ -188,6 +188,7 @@
                     "precision": "very-high",
                     "severity": "warning",
                     "short_name": "FunctionLikeMacroParameterNotEnclosedInParentheses",
+                    "shared_implementation_short_name": "MacroParameterNotEnclosedInParentheses",
                     "tags": [
                         "correctness",
                         "readability"
diff --git a/rules.csv b/rules.csv
@@ -735,7 +735,7 @@ c,MISRA-C-2012,RULE-20-3,No,Required,,,"The #include directive shall be followed
 c,MISRA-C-2012,RULE-20-4,Yes,Required,,,A macro shall not be defined with the same name as a keyword,A17-0-1,Preprocessor4,Medium,
 c,MISRA-C-2012,RULE-20-5,Yes,Advisory,,,#undef should not be used,,Preprocessor2,Easy,
 c,MISRA-C-2012,RULE-20-6,Yes,Required,,,Tokens that look like a preprocessing directive shall not occur within a macro argument,M16-0-5,Preprocessor4,Import,
-c,MISRA-C-2012,RULE-20-7,Yes,Required,,,Expressions resulting from the expansion of macro parameters shall be enclosed in parentheses,M16-0-6,Preprocessor,Easy,
+c,MISRA-C-2012,RULE-20-7,Yes,Required,,,Expressions resulting from the expansion of macro parameters shall be enclosed in parentheses,M16-0-6,Preprocessor5,Easy,
 c,MISRA-C-2012,RULE-20-8,Yes,Required,,,The controlling expression of a #if or #elif preprocessing directive shall evaluate to 0 or 1,,Preprocessor3,Hard,
 c,MISRA-C-2012,RULE-20-9,Yes,Required,,,All identifiers used in the controlling expression of #if or #elif preprocessing directives shall be #defined before evaluation,M16-0-7,Preprocessor1,Import,
 c,MISRA-C-2012,RULE-20-10,Yes,Advisory,,,The # and ## preprocessor operators should not be used,M16-3-2,Preprocessor1,Import,

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+\| test.c:1:1:1:27 \| #define MACRO(X,Y) (X * Y) \| Accesses of parameter 'X' are not always enclosed in parentheses in the macro MACRO. \|`
	`2`	`+\| test.c:1:1:1:27 \| #define MACRO(X,Y) (X * Y) \| Accesses of parameter 'Y' are not always enclosed in parentheses in the macro MACRO. \|`
	`3`	`+\| test.c:4:1:4:29 \| #define MACROFOUR(X,Y) (X).Y \| Accesses of parameter 'Y' are not always enclosed in parentheses in the macro MACROFOUR. \|`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+// GENERATED FILE - DO NOT MODIFY`
	`2`	`+import codingstandards.cpp.rules.macroparameternotenclosedinparentheses.MacroParameterNotEnclosedInParentheses`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+c/common/test/rules/macroparameternotenclosedinparentheses/MacroParameterNotEnclosedInParentheses.ql`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+cpp/common/test/rules/macroparameternotenclosedinparentheses/MacroParameterNotEnclosedInParentheses.ql`