Declarations1: add rule 21-2

knewbury01 · knewbury01 · commit af73a7808ec9 · 2022-08-08T12:59:09.000-04:00
diff --git a/c/cert/src/rules/DCL37-C/DoNotDeclareOrDefineAReservedIdentifier.md b/c/cert/src/rules/DCL37-C/DoNotDeclareOrDefineAReservedIdentifier.md
@@ -4,13 +4,14 @@ This query implements the CERT-C rule DCL37-C:
 
 > Do not declare or define a reserved identifier
 
+
 ## CERT
 
 ** REPLACE THIS BY RUNNING THE SCRIPT `scripts/help/cert-help-extraction.py` **
 
 ## Implementation notes
 
-None
+This query does not consider identifiers described in the future library directions section of the standard. This query also checks for any reserved identifier as declared regardless of whether its header file is included or not.
 
 ## References
 
diff --git a/c/cert/src/rules/DCL37-C/DoNotDeclareOrDefineAReservedIdentifier.ql b/c/cert/src/rules/DCL37-C/DoNotDeclareOrDefineAReservedIdentifier.ql
@@ -14,27 +14,10 @@
 
 import cpp
 import codingstandards.c.cert
-import codingstandards.cpp.Naming
-import codingstandards.c.Keywords
+import codingstandards.cpp.rules.declaredareservedidentifier.DeclaredAReservedIdentifier
 
-from Element m, string name
-where
-  not isExcluded(m, Declarations1Package::doNotDeclareOrDefineAReservedIdentifierQuery()) and
-  (
-    m.(Macro).hasName(name) or
-    m.(Declaration).hasGlobalName(name)
-  ) and
-  (
-    Naming::Cpp14::hasStandardLibraryMacroName(name)
-    or
-    Naming::Cpp14::hasStandardLibraryObjectName(name)
-    or
-    Naming::Cpp14::hasStandardLibraryFunctionName(name)
-    or
-    name.regexpMatch("_[A-Z_].*")
-    or
-    name.regexpMatch("_.*") and m.(Declaration).hasGlobalName(name)
-    or
-    Keywords::isKeyword(name)
-  )
-select m, "Reserved identifier '" + name + "' is declared."
+class DoNotDeclareAReservedIdentifierQuery extends DeclaredAReservedIdentifierSharedQuery {
+  DoNotDeclareAReservedIdentifierQuery() {
+    this = Declarations1Package::doNotDeclareOrDefineAReservedIdentifierQuery()
+  }
+}
diff --git a/c/cert/test/rules/DCL37-C/DoNotDeclareOrDefineAReservedIdentifier.qlref b/c/cert/test/rules/DCL37-C/DoNotDeclareOrDefineAReservedIdentifier.qlref
diff --git a/c/cert/test/rules/DCL37-C/DoNotDeclareOrDefineAReservedIdentifier.testref b/c/cert/test/rules/DCL37-C/DoNotDeclareOrDefineAReservedIdentifier.testref
@@ -0,0 +1 @@
+c/common/test/rules/declaredareservedidentifier/DeclaredAReservedIdentifier.ql
diff --git a/c/common/test/rules/declaredareservedidentifier/DeclaredAReservedIdentifier.expected b/c/common/test/rules/declaredareservedidentifier/DeclaredAReservedIdentifier.expected
diff --git a/c/common/test/rules/declaredareservedidentifier/DeclaredAReservedIdentifier.ql b/c/common/test/rules/declaredareservedidentifier/DeclaredAReservedIdentifier.ql
@@ -0,0 +1,2 @@
+// GENERATED FILE - DO NOT MODIFY
+import codingstandards.cpp.rules.declaredareservedidentifier.DeclaredAReservedIdentifier
diff --git a/c/common/test/rules/declaredareservedidentifier/test.c b/c/common/test/rules/declaredareservedidentifier/test.c
diff --git a/c/misra/src/rules/RULE-21-2/DoNotDeclareAReservedIdentifier.ql b/c/misra/src/rules/RULE-21-2/DoNotDeclareAReservedIdentifier.ql
@@ -0,0 +1,23 @@
+/**
+ * @id c/misra/do-not-declare-a-reserved-identifier
+ * @name RULE-21-2: A reserved identifier or reserved macro name shall not be declared
+ * @description Declaring a reserved identifier can lead to undefined behaviour.
+ * @kind problem
+ * @precision very-high
+ * @problem.severity warning
+ * @tags external/misra/id/rule-21-2
+ *       correctness
+ *       maintainability
+ *       readability
+ *       external/misra/obligation/required
+ */
+
+import cpp
+import codingstandards.c.misra
+import codingstandards.cpp.rules.declaredareservedidentifier.DeclaredAReservedIdentifier
+
+class DoNotDeclareAReservedIdentifierQuery extends DeclaredAReservedIdentifierSharedQuery {
+  DoNotDeclareAReservedIdentifierQuery() {
+    this = Declarations1Package::doNotDeclareAReservedIdentifierQuery()
+  }
+}
diff --git a/c/misra/test/rules/RULE-21-2/DoNotDeclareAReservedIdentifier.testref b/c/misra/test/rules/RULE-21-2/DoNotDeclareAReservedIdentifier.testref
@@ -0,0 +1 @@
+c/common/test/rules/declaredareservedidentifier/DeclaredAReservedIdentifier.ql
diff --git a/cpp/common/src/codingstandards/cpp/CKeywords.qll b/cpp/common/src/codingstandards/cpp/CKeywords.qll
diff --git a/cpp/common/src/codingstandards/cpp/exclusions/c/Declarations1.qll b/cpp/common/src/codingstandards/cpp/exclusions/c/Declarations1.qll
@@ -5,7 +5,8 @@ import codingstandards.cpp.exclusions.RuleMetadata
 
 newtype Declarations1Query =
   TDeclareIdentifiersBeforeUsingThemQuery() or
-  TDoNotDeclareOrDefineAReservedIdentifierQuery()
+  TDoNotDeclareOrDefineAReservedIdentifierQuery() or
+  TDoNotDeclareAReservedIdentifierQuery()
 
 predicate isDeclarations1QueryMetadata(Query query, string queryId, string ruleId) {
   query =
@@ -23,6 +24,14 @@ predicate isDeclarations1QueryMetadata(Query query, string queryId, string ruleI
     // `@id` for the `doNotDeclareOrDefineAReservedIdentifier` query
     "c/cert/do-not-declare-or-define-a-reserved-identifier" and
   ruleId = "DCL37-C"
+  or
+  query =
+    // `Query` instance for the `doNotDeclareAReservedIdentifier` query
+    Declarations1Package::doNotDeclareAReservedIdentifierQuery() and
+  queryId =
+    // `@id` for the `doNotDeclareAReservedIdentifier` query
+    "c/misra/do-not-declare-a-reserved-identifier" and
+  ruleId = "RULE-21-2"
 }
 
 module Declarations1Package {
@@ -39,4 +48,11 @@ module Declarations1Package {
       // `Query` type for `doNotDeclareOrDefineAReservedIdentifier` query
       TQueryC(TDeclarations1PackageQuery(TDoNotDeclareOrDefineAReservedIdentifierQuery()))
   }
+
+  Query doNotDeclareAReservedIdentifierQuery() {
+    //autogenerate `Query` type
+    result =
+      // `Query` type for `doNotDeclareAReservedIdentifier` query
+      TQueryC(TDeclarations1PackageQuery(TDoNotDeclareAReservedIdentifierQuery()))
+  }
 }
diff --git a/cpp/common/src/codingstandards/cpp/rules/declaredareservedidentifier/DeclaredAReservedIdentifier.qll b/cpp/common/src/codingstandards/cpp/rules/declaredareservedidentifier/DeclaredAReservedIdentifier.qll
@@ -0,0 +1,37 @@
+/**
+ * Provides a library which includes a `problems` predicate for reporting declarations of reserved identifiers.
+ */
+
+import cpp
+import codingstandards.cpp.Customizations
+import codingstandards.cpp.Exclusions
+import codingstandards.cpp.Naming
+import codingstandards.cpp.CKeywords
+
+abstract class DeclaredAReservedIdentifierSharedQuery extends Query { }
+
+Query getQuery() { result instanceof DeclaredAReservedIdentifierSharedQuery }
+
+query predicate problems(Element m, string message) {
+  not isExcluded(m, getQuery()) and
+  exists(string name |
+    (
+      m.(Macro).hasName(name) or
+      m.(Declaration).hasGlobalName(name)
+    ) and
+    (
+      Naming::Cpp14::hasStandardLibraryMacroName(name)
+      or
+      Naming::Cpp14::hasStandardLibraryObjectName(name)
+      or
+      Naming::Cpp14::hasStandardLibraryFunctionName(name)
+      or
+      name.regexpMatch("_[A-Z_].*")
+      or
+      name.regexpMatch("_.*") and m.(Declaration).hasGlobalName(name)
+      or
+      Keywords::isKeyword(name)
+    ) and
+    message = "Reserved identifier '" + name + "' is declared."
+  )
+}
diff --git a/rule_packages/c/Declarations1.json b/rule_packages/c/Declarations1.json
@@ -1,53 +1,78 @@
 {
   "CERT-C": {
     "DCL31-C": {
-      "properties": {
-        "obligation": "rule"
+        "properties": {
+          "obligation": "rule"
+        },
+        "queries": [
+          {
+            "description": "Omission of type specifiers may not be supported by some compilers.",
+            "kind": "problem",
+            "name": "Declare identifiers before using them",
+            "precision": "very-high",
+            "severity": "error",
+            "short_name": "DeclareIdentifiersBeforeUsingThem",
+            "tags": [
+              "correctness",
+              "readability" 
+            ],
+            "implementation_scope": {
+              "description": "This query does not check for implicit function declarations as this is partially compiler checked.",
+              "items": []
+            }
+          }
+        ],
+        "title": "Declare identifiers before using them"
       },
-      "queries": [
-        {
-          "description": "Omission of type specifiers may not be supported by some compilers.",
-          "kind": "problem",
-          "name": "Declare identifiers before using them",
-          "precision": "very-high",
-          "severity": "error",
-          "short_name": "DeclareIdentifiersBeforeUsingThem",
-          "tags": [
-            "correctness",
-            "readability" 
-          ],
-          "implementation_scope": {
-            "description": "This query does not check for implicit function declarations as this is partially compiler checked.",
-            "items": []
+      "DCL37-C": {
+        "properties": {
+          "obligation": "rule"
+        },
+        "queries": [
+          {
+            "description": "Declaring a reserved identifier can lead to undefined behaviour.",
+            "kind": "problem",
+            "name": "Do not declare or define a reserved identifier",
+            "precision": "very-high",
+            "severity": "warning",
+            "short_name": "DoNotDeclareOrDefineAReservedIdentifier",
+            "shared_implementation_short_name": "DeclaredAReservedIdentifier",
+            "tags": [
+              "correctness",
+              "maintainability",
+              "readability"
+            ],
+            "implementation_scope": {
+              "description": "This query does not consider identifiers described in the future library directions section of the standard. This query also checks for any reserved identifier as declared regardless of whether its header file is included or not.",
+              "items": []
+            }
           }
-        }
-      ],
-      "title": "Declare identifiers before using them"
-    },
-    "DCL37-C": {
+        ],
+        "title": "Do not declare or define a reserved identifier"
+      }
+  },
+  "MISRA-C-2012": {
+    "RULE-21-2": {
       "properties": {
-        "obligation": "rule"
+        "obligation": "required"
       },
       "queries": [
         {
           "description": "Declaring a reserved identifier can lead to undefined behaviour.",
           "kind": "problem",
-          "name": "Do not declare or define a reserved identifier",
+          "name": "A reserved identifier or reserved macro name shall not be declared",
           "precision": "very-high",
           "severity": "warning",
-          "short_name": "DoNotDeclareOrDefineAReservedIdentifier",
+          "short_name": "DoNotDeclareAReservedIdentifier",
+          "shared_implementation_short_name": "DeclaredAReservedIdentifier",
           "tags": [
             "correctness",
             "maintainability",
             "readability"
-          ],
-          "implementation_scope": {
-            "description": "This query does not consider identifiers described in the future library directions section of the standard. This query also checks for any reserved identifier as declared regardless of whether its header file is included or not.",
-            "items": []
-          }
+          ]
         }
       ],
-      "title": "Do not declare or define a reserved identifier"
+      "title": "A reserved identifier or reserved macro name shall not be declared"
     }
   }
 }
diff --git a/rules.csv b/rules.csv
@@ -744,7 +744,7 @@ c,MISRA-C-2012,RULE-20-12,Yes,Required,,,"A macro parameter used as an operand t
 c,MISRA-C-2012,RULE-20-13,No,Required,,,A line whose first token is # shall be a valid preprocessing directive,M16-0-8,,,This is verified by the compiler in the cases where the token is not within an ifdef branch that's never taken
 c,MISRA-C-2012,RULE-20-14,No,Required,,,"All #else, #elif and #endif preprocessor directives shall reside in the same file as the #if, #ifdef or #ifndef directive to which they are related",M16-1-2,,,Compilers already prohibit this case
 c,MISRA-C-2012,RULE-21-1,Yes,Required,,,#define and #undef shall not be used on a reserved identifier or reserved macro name,,Preprocessor4,Hard,
-c,MISRA-C-2012,RULE-21-2,Yes,Required,,,A reserved identifier or reserved macro name shall not be declared,,Declarations,Hard,
+c,MISRA-C-2012,RULE-21-2,Yes,Required,,,A reserved identifier or reserved macro name shall not be declared,,Declarations1,Hard,
 c,MISRA-C-2012,RULE-21-3,Yes,Required,,,The memory allocation and deallocation functions of <stdlib.h> shall not be used,,Banned,Medium,
 c,MISRA-C-2012,RULE-21-4,Yes,Required,,,The standard header file shall not be used <setjmp.h>,,Banned,Easy,
 c,MISRA-C-2012,RULE-21-5,Yes,Required,,,The standard header file shall not be used <signal.h>,,Banned,Easy,

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+c/common/test/rules/declaredareservedidentifier/DeclaredAReservedIdentifier.ql`
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.declaredareservedidentifier.DeclaredAReservedIdentifier`