Declarations1: add rule 5-4

Author: knewbury01

c/misra/src/rules/RULE-5-4/MacroIdentifierNotDistinctFromParameter.ql

@@ -0,0 +1,22 @@
+/**
+ * @id c/misra/macro-identifier-not-distinct-from-parameter
+ * @name RULE-5-4: Macro identifiers shall be distinct
+ * @description Macros with the same name as their parameters are less readable.
+ * @kind problem
+ * @precision very-high
+ * @problem.severity warning
+ * @tags external/misra/id/rule-5-4
+ *       maintainability
+ *       readability
+ *       external/misra/obligation/required
+ */
+
+import cpp
+import codingstandards.c.misra
+import codingstandards.cpp.FunctionLikeMacro
+
+from FunctionLikeMacro m
+where
+  not isExcluded(m, Declarations1Package::macroIdentifierNotDistinctFromParameterQuery()) and
+  exists(string p | p = m.(FunctionLikeMacro).getAParameter() and p = m.getName())
+select m, "Macro name matches parameter " + m.getName() + " ."

c/misra/src/rules/RULE-5-4/MacroIdentifiersNotDistinct.ql

@@ -0,0 +1,27 @@
+/**
+ * @id c/misra/macro-identifiers-not-distinct
+ * @name RULE-5-4: Macro identifiers shall be distinct
+ * @description Declaring multiple macros with the same name leads to undefined behaviour.
+ * @kind problem
+ * @precision very-high
+ * @problem.severity warning
+ * @tags external/misra/id/rule-5-4
+ *       correctness
+ *       maintainability
+ *       readability
+ *       external/misra/obligation/required
+ */
+
+import cpp
+import codingstandards.c.misra
+
+from Macro m
+where
+  not isExcluded(m, Declarations1Package::macroIdentifiersNotDistinctQuery()) and
+  exists(Macro m2 |
+    not m = m2 and
+    if m.getName().length() >= 64
+    then m.getName().substring(0, 62) = m2.getName().substring(0, 62)
+    else m.getName() = m2.getName()
+  )
+select m, "Nondistinct macro identifer used " + m.getName() + " ."

c/misra/test/rules/RULE-5-4/MacroIdentifierNotDistinctFromParameter.expected

@@ -0,0 +1 @@
+| test.c:7:1:7:57 | #define FUNCTION_MACRO(FUNCTION_MACRO) FUNCTION_MACRO + 1 | Macro name matches parameter FUNCTION_MACRO . |

c/misra/test/rules/RULE-5-4/MacroIdentifierNotDistinctFromParameter.qlref

@@ -0,0 +1 @@
+rules/RULE-5-4/MacroIdentifierNotDistinctFromParameter.ql

c/misra/test/rules/RULE-5-4/MacroIdentifiersNotDistinct.expected

@@ -0,0 +1,4 @@
+| test.c:1:1:1:72 | #define iltiqzxgfqsgigwfuyntzghvzltueatcxqnqofnnvjyszmcsylyohvqaosjbqyyA | Nondistinct macro identifer used iltiqzxgfqsgigwfuyntzghvzltueatcxqnqofnnvjyszmcsylyohvqaosjbqyyA . |
+| test.c:2:1:2:72 | #define iltiqzxgfqsgigwfuyntzghvzltueatcxqnqofnnvjyszmcsylyohvqaosjbqyyB | Nondistinct macro identifer used iltiqzxgfqsgigwfuyntzghvzltueatcxqnqofnnvjyszmcsylyohvqaosjbqyyB . |
+| test.c:7:1:7:57 | #define FUNCTION_MACRO(FUNCTION_MACRO) FUNCTION_MACRO + 1 | Nondistinct macro identifer used FUNCTION_MACRO . |
+| test.c:8:1:8:31 | #define FUNCTION_MACRO(X) X + 1 | Nondistinct macro identifer used FUNCTION_MACRO . |

c/misra/test/rules/RULE-5-4/MacroIdentifiersNotDistinct.qlref

@@ -0,0 +1 @@
+rules/RULE-5-4/MacroIdentifiersNotDistinct.ql

c/misra/test/rules/RULE-5-4/test.c

@@ -0,0 +1,9 @@
+#define iltiqzxgfqsgigwfuyntzghvzltueatcxqnqofnnvjyszmcsylyohvqaosjbqyyA // NON_COMPLIANT
+#define iltiqzxgfqsgigwfuyntzghvzltueatcxqnqofnnvjyszmcsylyohvqaosjbqyyB // NON_COMPLIANT
+
+#define MACRO1 // COMPLIANT
+#define MACRO2 // COMPLIANT
+
+#define FUNCTION_MACRO(FUNCTION_MACRO) FUNCTION_MACRO + 1 // NON_COMPLIANT
+#define FUNCTION_MACRO(X) X + 1                           // NON_COMPLIANT
+#define FUNCTION_MACRO2(X) X + 1                          // COMPLIANT

cpp/common/src/codingstandards/cpp/exclusions/c/Declarations1.qll

@@ -6,7 +6,9 @@ import codingstandards.cpp.exclusions.RuleMetadata
 newtype Declarations1Query =
   TDeclareIdentifiersBeforeUsingThemQuery() or
   TDoNotDeclareOrDefineAReservedIdentifierQuery() or
-  TDoNotDeclareAReservedIdentifierQuery()
+  TDoNotDeclareAReservedIdentifierQuery() or
+  TMacroIdentifiersNotDistinctQuery() or
+  TMacroIdentifierNotDistinctFromParameterQuery()
 
 predicate isDeclarations1QueryMetadata(Query query, string queryId, string ruleId) {
   query =
@@ -32,6 +34,22 @@ predicate isDeclarations1QueryMetadata(Query query, string queryId, string ruleI
     // `@id` for the `doNotDeclareAReservedIdentifier` query
     "c/misra/do-not-declare-a-reserved-identifier" and
   ruleId = "RULE-21-2"
+  or
+  query =
+    // `Query` instance for the `macroIdentifiersNotDistinct` query
+    Declarations1Package::macroIdentifiersNotDistinctQuery() and
+  queryId =
+    // `@id` for the `macroIdentifiersNotDistinct` query
+    "c/misra/macro-identifiers-not-distinct" and
+  ruleId = "RULE-5-4"
+  or
+  query =
+    // `Query` instance for the `macroIdentifierNotDistinctFromParameter` query
+    Declarations1Package::macroIdentifierNotDistinctFromParameterQuery() and
+  queryId =
+    // `@id` for the `macroIdentifierNotDistinctFromParameter` query
+    "c/misra/macro-identifier-not-distinct-from-parameter" and
+  ruleId = "RULE-5-4"
 }
 
 module Declarations1Package {
@@ -55,4 +73,18 @@ module Declarations1Package {
       // `Query` type for `doNotDeclareAReservedIdentifier` query
       TQueryC(TDeclarations1PackageQuery(TDoNotDeclareAReservedIdentifierQuery()))
   }
+
+  Query macroIdentifiersNotDistinctQuery() {
+    //autogenerate `Query` type
+    result =
+      // `Query` type for `macroIdentifiersNotDistinct` query
+      TQueryC(TDeclarations1PackageQuery(TMacroIdentifiersNotDistinctQuery()))
+  }
+
+  Query macroIdentifierNotDistinctFromParameterQuery() {
+    //autogenerate `Query` type
+    result =
+      // `Query` type for `macroIdentifierNotDistinctFromParameter` query
+      TQueryC(TDeclarations1PackageQuery(TMacroIdentifierNotDistinctFromParameterQuery()))
+  }
 }

rule_packages/c/Declarations1.json

@@ -73,6 +73,44 @@
         }
       ],
       "title": "A reserved identifier or reserved macro name shall not be declared"
+    },
+    "RULE-5-4": {
+      "properties": {
+        "obligation": "required"
+      },
+      "queries": [
+        {
+          "description": "Declaring multiple macros with the same name leads to undefined behaviour.",
+          "kind": "problem",
+          "name": "Macro identifiers shall be distinct",
+          "precision": "very-high",
+          "severity": "warning",
+          "short_name": "MacroIdentifiersNotDistinct",
+          "tags": [
+            "correctness",
+            "maintainability",
+            "readability"
+          ]
+          ,
+            "implementation_scope": {
+              "description": "This query checks the first 63 characters of macro identifiers as significant, as per C99. Distinctness of parameters within the same function like macro are checked by compiler and therefore not checked by this rule.",
+              "items": []
+            }
+        },
+        {
+            "description": "Macros with the same name as their parameters are less readable.",
+            "kind": "problem",
+            "name": "Macro identifiers shall be distinct",
+            "precision": "very-high",
+            "severity": "warning",
+            "short_name": "MacroIdentifierNotDistinctFromParameter",
+            "tags": [
+              "maintainability",
+              "readability"
+            ]
+          }
+      ],
+      "title": "Macro identifiers shall be distinct"
     }
   }
 }

rules.csv

@@ -634,7 +634,7 @@ c,MISRA-C-2012,RULE-4-2,No,Advisory,,,Trigraphs should not be used,A2-5-1,,Impor
 c,MISRA-C-2012,RULE-5-1,Yes,Required,,,External identifiers shall be distinct,,Declarations,Medium,
 c,MISRA-C-2012,RULE-5-2,Yes,Required,,,Identifiers declared in the same scope and name space shall be distinct,,Declarations,Medium,
 c,MISRA-C-2012,RULE-5-3,Yes,Required,,,An identifier declared in an inner scope shall not hide an identifier declared in an outer scope,A2-10-1,Declarations,Import,
-c,MISRA-C-2012,RULE-5-4,Yes,Required,,,Macro identifiers shall be distinct,,Declarations,Easy,
+c,MISRA-C-2012,RULE-5-4,Yes,Required,,,Macro identifiers shall be distinct,,Declarations1,Easy,
 c,MISRA-C-2012,RULE-5-5,Yes,Required,,,Identifiers shall be distinct from macro names,,Declarations,Easy,
 c,MISRA-C-2012,RULE-5-6,Yes,Required,,,A typedef name shall be a unique identifier,,Declarations,Easy,
 c,MISRA-C-2012,RULE-5-7,Yes,Required,,,A tag name shall be a unique identifier,,Declarations,Easy,