Declarations3: add import RULE-5-3

knewbury01 · knewbury01 · commit 24a99a13cc9b · 2022-09-29T11:48:23.000-04:00
diff --git a/c/common/test/rules/identifierhidden/IdentifierHidden.expected b/c/common/test/rules/identifierhidden/IdentifierHidden.expected
@@ -0,0 +1 @@
+No expected results have yet been specified
diff --git a/c/common/test/rules/identifierhidden/IdentifierHidden.ql b/c/common/test/rules/identifierhidden/IdentifierHidden.ql
@@ -0,0 +1,2 @@
+// GENERATED FILE - DO NOT MODIFY
+import codingstandards.cpp.rules.identifierhidden.IdentifierHidden
diff --git a/c/common/test/rules/identifierhidden/test.c b/c/common/test/rules/identifierhidden/test.c
diff --git a/c/misra/src/rules/RULE-5-3/IdentifierHidingC.ql b/c/misra/src/rules/RULE-5-3/IdentifierHidingC.ql
@@ -0,0 +1,24 @@
+/**
+ * @id c/misra/identifier-hiding-c
+ * @name RULE-5-3: An identifier declared in an inner scope shall not hide an identifier declared in an outer scope
+ * @description Use of an identifier declared in an inner scope with an identical name to an
+ *              identifier in an outer scope can lead to inadvertent errors if the incorrect
+ *              identifier is modified.
+ * @kind problem
+ * @precision very-high
+ * @problem.severity warning
+ * @tags external/misra/id/rule-5-3
+ *       readability
+ *       maintainability
+ *       external/misra/obligation/required
+ */
+
+import cpp
+import codingstandards.c.misra
+import codingstandards.cpp.rules.identifierhidden.IdentifierHidden
+
+class IdentifierHidingCQuery extends IdentifierHiddenSharedQuery {
+  IdentifierHidingCQuery() {
+    this = Declarations3Package::identifierHidingCQuery()
+  }
+}
diff --git a/c/misra/test/rules/RULE-5-3/IdentifierHidingC.testref b/c/misra/test/rules/RULE-5-3/IdentifierHidingC.testref
@@ -0,0 +1 @@
+c/common/test/rules/identifierhidden/IdentifierHidden.ql
diff --git a/cpp/autosar/src/rules/A2-10-1/IdentifierHiding.ql b/cpp/autosar/src/rules/A2-10-1/IdentifierHiding.ql
@@ -19,11 +19,8 @@
 
 import cpp
 import codingstandards.cpp.autosar
-import codingstandards.cpp.Scope
+import codingstandards.cpp.rules.identifierhidden.IdentifierHidden
 
-from UserVariable v1, UserVariable v2
-where
-  not isExcluded(v1, NamingPackage::identifierHidingQuery()) and
-  not isExcluded(v2, NamingPackage::identifierHidingQuery()) and
-  hides(v1, v2)
-select v2, "Variable is hiding variable $@.", v1, v1.getName()
+class IdentifierHidingCQuery extends IdentifierHiddenSharedQuery {
+  IdentifierHidingCQuery() { this = NamingPackage::identifierHidingQuery() }
+}
diff --git a/cpp/autosar/test/rules/A2-10-1/IdentifierHiding.qlref b/cpp/autosar/test/rules/A2-10-1/IdentifierHiding.qlref
diff --git a/cpp/autosar/test/rules/A2-10-1/IdentifierHiding.testref b/cpp/autosar/test/rules/A2-10-1/IdentifierHiding.testref
@@ -0,0 +1 @@
+cpp/common/test/rules/identifierhidden/IdentifierHidden.ql
diff --git a/cpp/common/src/codingstandards/cpp/exclusions/c/Declarations3.qll b/cpp/common/src/codingstandards/cpp/exclusions/c/Declarations3.qll
@@ -0,0 +1,25 @@
+//** THIS FILE IS AUTOGENERATED, DO NOT MODIFY DIRECTLY.  **/
+import cpp
+import RuleMetadata
+import codingstandards.cpp.exclusions.RuleMetadata
+
+newtype Declarations3Query = TIdentifierHidingCQuery()
+
+predicate isDeclarations3QueryMetadata(Query query, string queryId, string ruleId) {
+  query =
+    // `Query` instance for the `identifierHidingC` query
+    Declarations3Package::identifierHidingCQuery() and
+  queryId =
+    // `@id` for the `identifierHidingC` query
+    "c/misra/identifier-hiding-c" and
+  ruleId = "RULE-5-3"
+}
+
+module Declarations3Package {
+  Query identifierHidingCQuery() {
+    //autogenerate `Query` type
+    result =
+      // `Query` type for `identifierHidingC` query
+      TQueryC(TDeclarations3PackageQuery(TIdentifierHidingCQuery()))
+  }
+}
diff --git a/cpp/common/src/codingstandards/cpp/exclusions/c/RuleMetadata.qll b/cpp/common/src/codingstandards/cpp/exclusions/c/RuleMetadata.qll
@@ -10,6 +10,7 @@ import Concurrency4
 import Contracts1
 import Declarations1
 import Declarations2
+import Declarations3
 import Expressions
 import IO1
 import IO2
@@ -40,6 +41,7 @@ newtype TCQuery =
   TContracts1PackageQuery(Contracts1Query q) or
   TDeclarations1PackageQuery(Declarations1Query q) or
   TDeclarations2PackageQuery(Declarations2Query q) or
+  TDeclarations3PackageQuery(Declarations3Query q) or
   TExpressionsPackageQuery(ExpressionsQuery q) or
   TIO1PackageQuery(IO1Query q) or
   TIO2PackageQuery(IO2Query q) or
@@ -70,6 +72,7 @@ predicate isQueryMetadata(Query query, string queryId, string ruleId) {
   isContracts1QueryMetadata(query, queryId, ruleId) or
   isDeclarations1QueryMetadata(query, queryId, ruleId) or
   isDeclarations2QueryMetadata(query, queryId, ruleId) or
+  isDeclarations3QueryMetadata(query, queryId, ruleId) or
   isExpressionsQueryMetadata(query, queryId, ruleId) or
   isIO1QueryMetadata(query, queryId, ruleId) or
   isIO2QueryMetadata(query, queryId, ruleId) or
diff --git a/cpp/common/src/codingstandards/cpp/rules/identifierhidden/IdentifierHidden.qll b/cpp/common/src/codingstandards/cpp/rules/identifierhidden/IdentifierHidden.qll
@@ -0,0 +1,20 @@
+/**
+ * Provides a library which includes a `problems` predicate for reporting....
+ */
+
+import cpp
+import codingstandards.cpp.Customizations
+import codingstandards.cpp.Exclusions
+import codingstandards.cpp.Scope
+
+abstract class IdentifierHiddenSharedQuery extends Query { }
+
+Query getQuery() { result instanceof IdentifierHiddenSharedQuery }
+
+query predicate problems(UserVariable v2, string message, UserVariable v1, string varName) {
+  not isExcluded(v1, getQuery()) and
+  not isExcluded(v2, getQuery()) and
+  hides(v1, v2) and
+  varName = v1.getName() and
+  message = "Variable is hiding variable $@."
+}
diff --git a/cpp/common/test/rules/identifierhidden/IdentifierHidden.expected b/cpp/common/test/rules/identifierhidden/IdentifierHidden.expected
diff --git a/cpp/common/test/rules/identifierhidden/IdentifierHidden.ql b/cpp/common/test/rules/identifierhidden/IdentifierHidden.ql
@@ -0,0 +1,2 @@
+// GENERATED FILE - DO NOT MODIFY
+import codingstandards.cpp.rules.identifierhidden.IdentifierHidden
diff --git a/cpp/common/test/rules/identifierhidden/test.cpp b/cpp/common/test/rules/identifierhidden/test.cpp
diff --git a/rule_packages/c/Declarations3.json b/rule_packages/c/Declarations3.json
@@ -0,0 +1,28 @@
+{
+  "MISRA-C-2012": {
+    "RULE-5-3": {
+      "properties": {
+        "obligation": "required"
+      },
+      "queries": [
+        {
+          "description": "Use of an identifier declared in an inner scope with an identical name to an identifier in an outer scope can lead to inadvertent errors if the incorrect identifier is modified.",
+          "name": "An identifier declared in an inner scope shall not hide an identifier declared in an outer scope",
+          "precision": "very-high",
+          "severity": "warning",
+          "short_name": "IdentifierHidingC",
+          "shared_implementation_short_name": "IdentifierHidden",
+          "tags": [
+            "readability",
+            "maintainability"
+          ],
+          "implementation_scope": {
+            "description": "This query does not consider C90 or C99 definitions of significant name and instead uses full name matches only.",
+            "items": []
+          }
+        }
+      ],
+      "title": "An identifier declared in an inner scope shall not hide an identifier declared in an outer scope."
+    }
+  }
+}
diff --git a/rule_packages/cpp/Naming.json b/rule_packages/cpp/Naming.json
@@ -39,6 +39,7 @@
           "precision": "very-high",
           "severity": "warning",
           "short_name": "IdentifierHiding",
+          "shared_implementation_short_name": "IdentifierHidden",
           "tags": [
             "readability",
             "maintainability"
diff --git a/rules.csv b/rules.csv
@@ -633,7 +633,7 @@ c,MISRA-C-2012,RULE-4-1,Yes,Required,,,Octal and hexadecimal escape sequences sh
 c,MISRA-C-2012,RULE-4-2,No,Advisory,,,Trigraphs should not be used,A2-5-1,,Import,
 c,MISRA-C-2012,RULE-5-1,Yes,Required,,,External identifiers shall be distinct,,Declarations1,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-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,

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+No expected results have yet been specified`
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.identifierhidden.IdentifierHidden`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+c/common/test/rules/identifierhidden/IdentifierHidden.ql`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+cpp/common/test/rules/identifierhidden/IdentifierHidden.ql`