Declarations3: add shared RULE-8-1

Author: knewbury01

c/cert/src/rules/DCL31-C/DeclareIdentifiersBeforeUsingThem.md

@@ -153,7 +153,7 @@ Search for [vulnerabilities](https://wiki.sei.cmu.edu/confluence/display/c/BB.+D
 
 ## Implementation notes
 
-This query does not check for implicit function declarations as this is partially compiler checked.
+This query does not check for implicitly typed parameters, typedefs or member declarations as this is partially compiler checked.
 
 ## References
 

c/cert/src/rules/DCL31-C/DeclareIdentifiersBeforeUsingThem.ql

@@ -13,16 +13,10 @@
 
 import cpp
 import codingstandards.c.cert
+import codingstandards.cpp.rules.typeomitted.TypeOmitted
 
-from Declaration d
-where
-  not isExcluded(d, Declarations1Package::declareIdentifiersBeforeUsingThemQuery()) and
-  d.hasSpecifier("implicit_int") and
-  exists(Type t |
-    (d.(Variable).getType() = t or d.(Function).getType() = t) and
-    // Exclude "short" or "long", as opposed to "short int" or "long int".
-    t instanceof IntType and
-    // Exclude "signed" or "unsigned", as opposed to "signed int" or "unsigned int".
-    not exists(IntegralType it | it = t | it.isExplicitlySigned() or it.isExplicitlyUnsigned())
-  )
-select d, "Declaration " + d.getName() + " is missing a type specifier."
+class DeclareIdentifiersBeforeUsingThem extends TypeOmittedSharedQuery {
+  DeclareIdentifiersBeforeUsingThem() {
+    this = Declarations1Package::declareIdentifiersBeforeUsingThemQuery()
+  }
+}

c/cert/test/rules/DCL31-C/DeclareIdentifiersBeforeUsingThem.qlref

@@ -0,0 +1 @@
+c/common/test/rules/typeomitted/TypeOmitted.ql

c/cert/test/rules/DCL31-C/DeclareIdentifiersBeforeUsingThem.testref

@@ -0,0 +1,2 @@
+// GENERATED FILE - DO NOT MODIFY
+import codingstandards.cpp.rules.typeomitted.TypeOmitted

c/cert/test/rules/DCL31-C/DeclareIdentifiersBeforeUsingThem.expected renamed to c/common/test/rules/typeomitted/TypeOmitted.expected

@@ -13,3 +13,13 @@ int f1(void) { // COMPLIANT
 short g2;                 // COMPLIANT
 long g3;                  // COMPLIANT
 signed g4() { return 1; } // COMPLIANT
+
+typedef *newtype3; // NON_COMPLIANT[FALSE_NEGATIVE]
+
+int f2(const x) { // NON_COMPLIANT[FALSE_NEGATIVE]
+  return 1;
+}
+
+struct str {
+  const y; // NON_COMPLIANT[FALSE_NEGATIVE]
+} s;

c/common/test/rules/typeomitted/TypeOmitted.ql

@@ -0,0 +1,20 @@
+/**
+ * @id c/misra/explicitly-declare-types
+ * @name RULE-8-1: Declare identifiers before using them
+ * @description Omission of type specifiers may not be supported by some compilers.
+ * @kind problem
+ * @precision very-high
+ * @problem.severity error
+ * @tags external/misra/id/rule-8-1
+ *       correctness
+ *       readability
+ *       external/misra/obligation/required
+ */
+
+import cpp
+import codingstandards.c.misra
+import codingstandards.cpp.rules.typeomitted.TypeOmitted
+
+class ExplicitlyDeclareTypesQuery extends TypeOmittedSharedQuery {
+  ExplicitlyDeclareTypesQuery() { this = Declarations3Package::explicitlyDeclareTypesQuery() }
+}

c/cert/test/rules/DCL31-C/test.c renamed to c/common/test/rules/typeomitted/test.c

@@ -0,0 +1 @@
+c/common/test/rules/typeomitted/TypeOmitted.ql

c/misra/src/rules/RULE-8-1/ExplicitlyDeclareTypes.ql

@@ -7,7 +7,8 @@ newtype Declarations3Query =
   TIdentifierHidingCQuery() or
   TIdentifiersNotDistinctFromMacroNamesQuery() or
   TTypedefNameNotUniqueQuery() or
-  TTagNameNotUniqueQuery()
+  TTagNameNotUniqueQuery() or
+  TExplicitlyDeclareTypesQuery()
 
 predicate isDeclarations3QueryMetadata(Query query, string queryId, string ruleId) {
   query =
@@ -41,6 +42,14 @@ predicate isDeclarations3QueryMetadata(Query query, string queryId, string ruleI
     // `@id` for the `tagNameNotUnique` query
     "c/misra/tag-name-not-unique" and
   ruleId = "RULE-5-7"
+  or
+  query =
+    // `Query` instance for the `explicitlyDeclareTypes` query
+    Declarations3Package::explicitlyDeclareTypesQuery() and
+  queryId =
+    // `@id` for the `explicitlyDeclareTypes` query
+    "c/misra/explicitly-declare-types" and
+  ruleId = "RULE-8-1"
 }
 
 module Declarations3Package {
@@ -71,4 +80,11 @@ module Declarations3Package {
       // `Query` type for `tagNameNotUnique` query
       TQueryC(TDeclarations3PackageQuery(TTagNameNotUniqueQuery()))
   }
+
+  Query explicitlyDeclareTypesQuery() {
+    //autogenerate `Query` type
+    result =
+      // `Query` type for `explicitlyDeclareTypes` query
+      TQueryC(TDeclarations3PackageQuery(TExplicitlyDeclareTypesQuery()))
+  }
 }

c/misra/test/rules/RULE-8-1/ExplicitlyDeclareTypes.testref

@@ -0,0 +1,24 @@
+/**
+ * Provides a library which includes a `problems` predicate for reporting....
+ */
+
+import cpp
+import codingstandards.cpp.Customizations
+import codingstandards.cpp.Exclusions
+
+abstract class TypeOmittedSharedQuery extends Query { }
+
+Query getQuery() { result instanceof TypeOmittedSharedQuery }
+
+query predicate problems(Declaration d, string message) {
+  not isExcluded(d, getQuery()) and
+  d.hasSpecifier("implicit_int") and
+  exists(Type t |
+    (d.(Variable).getType() = t or d.(Function).getType() = t) and
+    // Exclude "short" or "long", as opposed to "short int" or "long int".
+    t instanceof IntType and
+    // Exclude "signed" or "unsigned", as opposed to "signed int" or "unsigned int".
+    not exists(IntegralType it | it = t | it.isExplicitlySigned() or it.isExplicitlyUnsigned())
+  ) and
+  message = "Declaration " + d.getName() + " is missing a type specifier."
+}

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

@@ -12,12 +12,13 @@
             "precision": "very-high",
             "severity": "error",
             "short_name": "DeclareIdentifiersBeforeUsingThem",
+            "shared_implementation_short_name": "TypeOmitted",
             "tags": [
               "correctness",
               "readability" 
             ],
             "implementation_scope": {
-              "description": "This query does not check for implicit function declarations as this is partially compiler checked.",
+              "description": "This query does not check for implicitly typed parameters, typedefs or member declarations as this is partially compiler checked.",
               "items": []
             }
           }

cpp/common/src/codingstandards/cpp/rules/typeomitted/TypeOmitted.qll

@@ -83,6 +83,31 @@
         }
       ],
       "title": "A tag name shall be a unique identifier"
+    },
+    "RULE-8-1": {
+      "properties": {
+        "obligation": "required"
+      },
+      "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": "ExplicitlyDeclareTypes",
+          "shared_implementation_short_name": "TypeOmitted",
+          "tags": [
+            "correctness",
+            "readability" 
+          ],
+          "implementation_scope": {
+            "description": "This query does not check for implicitly typed parameters, typedefs or member declarations as this is partially compiler checked.",
+            "items": []
+          }
+        }
+      ],
+      "title": "Types shall be explicitly specified"
     }
   }
 }

rule_packages/c/Declarations1.json

@@ -646,7 +646,7 @@ c,MISRA-C-2012,RULE-7-1,Yes,Required,,,Octal constants shall not be used,M2-13-2
 c,MISRA-C-2012,RULE-7-2,Yes,Required,,,A �u� or �U� suffix shall be applied to all integer constants that are represented in an unsigned type,M2-13-3,Syntax,Easy,
 c,MISRA-C-2012,RULE-7-3,Yes,Required,,,The lowercase character �l� shall not be used in a literal suffix,M2-13-4,Syntax,Easy,
 c,MISRA-C-2012,RULE-7-4,Yes,Required,,,A string literal shall not be assigned to an object unless the object�s type is �pointer to const-qualified char�,A2-13-4,Types,Easy,
-c,MISRA-C-2012,RULE-8-1,Yes,Required,,,Types shall be explicitly specified,,Declarations,Medium,
+c,MISRA-C-2012,RULE-8-1,Yes,Required,,,Types shall be explicitly specified,,Declarations3,Medium,
 c,MISRA-C-2012,RULE-8-2,Yes,Required,,,Function types shall be in prototype form with named parameters,,Declarations,Medium,
 c,MISRA-C-2012,RULE-8-3,Yes,Required,,,All declarations of an object or function shall use the same names and type qualifiers,M3-2-1,Declarations,Medium,
 c,MISRA-C-2012,RULE-8-4,Yes,Required,,,A compatible declaration shall be visible when an object or function with external linkage is defined,,Declarations,Medium,