Declarations3: add RULE-5-6

Author: knewbury01

c/misra/src/rules/RULE-5-6/TypedefNameNotUnique.ql

@@ -0,0 +1,40 @@
+/**
+ * @id c/misra/typedef-name-not-unique
+ * @name RULE-5-6: A typedef name shall be a unique identifier
+ * @description Reusing a typedef name compared to the name of any other identifier can cause
+ *              confusion and make code harder to read.
+ * @kind problem
+ * @precision very-high
+ * @problem.severity error
+ * @tags external/misra/id/rule-5-6
+ *       readability
+ *       maintainability
+ *       external/misra/obligation/required
+ */
+
+import cpp
+import codingstandards.c.misra
+
+//exception cases additional to rule description
+class InterestingIdentifiers extends Declaration {
+  InterestingIdentifiers() {
+    not this.isFromTemplateInstantiation(_) and
+    not this.isFromUninstantiatedTemplate(_) and
+    not this instanceof TemplateParameter and
+    not this.hasDeclaringType() and
+    not this instanceof Operator and
+    not this.hasName("main") and
+    exists(this.getADeclarationLocation())
+  }
+}
+
+from TypedefType t, InterestingIdentifiers d
+where
+  not isExcluded(t, Declarations3Package::typedefNameNotUniqueQuery()) and
+  not isExcluded(d, Declarations3Package::typedefNameNotUniqueQuery()) and
+  not t.getADeclarationLocation() = d.getADeclarationLocation() and
+  t.getName() = d.getName() and
+  //exception cases
+  not d.(Struct).getName() = t.getBaseType().toString() and
+  not d.(Enum).getName() = t.getBaseType().toString()
+select t, "Typedef name is nonunique compared to $@.", d, d.getName()

c/misra/test/rules/RULE-5-6/TypedefNameNotUnique.expected

@@ -0,0 +1,2 @@
+| test.c:11:15:11:19 | test1 | Typedef name is nonunique compared to $@. | test.c:13:17:13:21 | test1 | test1 |
+| test.c:30:3:30:7 | chain | Typedef name is nonunique compared to $@. | test.c:26:10:26:14 | chain | chain |

c/misra/test/rules/RULE-5-6/TypedefNameNotUnique.qlref

@@ -0,0 +1 @@
+rules/RULE-5-6/TypedefNameNotUnique.ql

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

@@ -0,0 +1,32 @@
+#include "test.h"
+void f() {
+  {
+    typedef unsigned char test; // NON_COMPLIANT
+  }
+  {
+    typedef unsigned char test; // NON_COMPLIANT
+  }
+}
+
+typedef float test1; // NON_COMPLIANT
+
+void f2() { int test1 = 0; }
+
+typedef struct list {
+  int i;
+} list; // COMPLIANT
+
+typedef struct BIGList1 {
+  int i;
+} list1; // COMPLIANT
+
+typedef enum enum1 { testenum } enum1; // COMPLIANT
+
+typedef struct {
+  struct chain {
+    int ii;
+  } s1;
+  int i;
+} chain; // NON_COMPLIANT
+
+typedef void (*pointercase)(int i); // COMPLIANT

c/misra/test/rules/RULE-5-6/test.h

@@ -0,0 +1 @@
+typedef int headertest; // COMPLIANT

c/misra/test/rules/RULE-5-6/test1.c

@@ -0,0 +1 @@
+#include "test.h"

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

@@ -3,7 +3,9 @@ import cpp
 import RuleMetadata
 import codingstandards.cpp.exclusions.RuleMetadata
 
-newtype Declarations3Query = TIdentifierHidingCQuery()
+newtype Declarations3Query =
+  TIdentifierHidingCQuery() or
+  TTypedefNameNotUniqueQuery()
 
 predicate isDeclarations3QueryMetadata(Query query, string queryId, string ruleId) {
   query =
@@ -13,6 +15,14 @@ predicate isDeclarations3QueryMetadata(Query query, string queryId, string ruleI
     // `@id` for the `identifierHidingC` query
     "c/misra/identifier-hiding-c" and
   ruleId = "RULE-5-3"
+  or
+  query =
+    // `Query` instance for the `typedefNameNotUnique` query
+    Declarations3Package::typedefNameNotUniqueQuery() and
+  queryId =
+    // `@id` for the `typedefNameNotUnique` query
+    "c/misra/typedef-name-not-unique" and
+  ruleId = "RULE-5-6"
 }
 
 module Declarations3Package {
@@ -22,4 +32,11 @@ module Declarations3Package {
       // `Query` type for `identifierHidingC` query
       TQueryC(TDeclarations3PackageQuery(TIdentifierHidingCQuery()))
   }
+
+  Query typedefNameNotUniqueQuery() {
+    //autogenerate `Query` type
+    result =
+      // `Query` type for `typedefNameNotUnique` query
+      TQueryC(TDeclarations3PackageQuery(TTypedefNameNotUniqueQuery()))
+  }
 }

rule_packages/c/Declarations3.json

@@ -23,6 +23,26 @@
         }
       ],
       "title": "An identifier declared in an inner scope shall not hide an identifier declared in an outer scope."
+    },
+    "RULE-5-6": {
+      "properties": {
+        "obligation": "required"
+      },
+      "queries": [
+        {
+          "description": "Reusing a typedef name compared to the name of any other identifier can cause confusion and make code harder to read.",
+          "kind": "problem",
+          "name": "A typedef name shall be a unique identifier",
+          "precision": "very-high",
+          "severity": "error",
+          "short_name": "TypedefNameNotUnique",
+          "tags": [
+            "readability",
+            "maintainability"
+          ]
+        }
+      ],
+      "title": "A typedef name shall be a unique identifier"
     }
   }
 }

rules.csv

@@ -636,7 +636,7 @@ c,MISRA-C-2012,RULE-5-2,Yes,Required,,,Identifiers declared in the same scope an
 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,Declarations3,Import,
 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-6,Yes,Required,,,A typedef name shall be a unique identifier,,Declarations3,Easy,
 c,MISRA-C-2012,RULE-5-7,Yes,Required,,,A tag name shall be a unique identifier,,Declarations,Easy,
 c,MISRA-C-2012,RULE-5-8,Yes,Required,,,Identifiers that define objects or functions with external linkage shall be unique,,Declarations,Easy,
 c,MISRA-C-2012,RULE-5-9,Yes,Advisory,,,Identifiers that define objects or functions with internal linkage should be unique,,Declarations,Easy,