Merge pull request #445 from github/lcartey/a7-1-1-params

A7-1-1: Do not report for function parameters

Author: knewbury01

change_notes/2023-11-22-remove-parameters-a7-1-1.md

@@ -0,0 +1 @@
+ * `A7-1-1` - no longer report parameters as contravening this rule. This is inline with the rule intent as described in the referenced C++ Core Guidelines rule [CON.1](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#con1-by-default-make-objects-immutable), which states "To avoid confusion and lots of false positives, don’t enforce this rule for function parameters."

cpp/autosar/src/rules/A7-1-1/DeclarationUnmodifiedParamMissingConstSpecifier.ql

@@ -4,7 +4,7 @@
 void f1(int *p) { // COMPLIANT
   *p += 2;
 }
-void f2(int *p) { // NON_COMPLIANT
+void f2(int *p) { // COMPLIANT - we ignore parameters for this rule
   int l4 = 1;     // NON_COMPLIANT
   int *p1 = p;    // NON_COMPLIANT
 }

cpp/autosar/test/rules/A7-1-1/DeclarationUnmodifiedParamMissingConstSpecifier.expected

@@ -5,7 +5,6 @@ import codingstandards.cpp.exclusions.RuleMetadata
 
 newtype ConstQuery =
   TRemoveConstOrVolatileQualificationAutosarQuery() or
-  TDeclarationUnmodifiedParamMissingConstSpecifierQuery() or
   TDeclarationUnmodifiedObjectMissingConstSpecifierQuery() or
   TVariableMissingConstexprQuery() or
   TFunctionMissingConstexprQuery() or
@@ -28,15 +27,6 @@ predicate isConstQueryMetadata(Query query, string queryId, string ruleId, strin
   ruleId = "A5-2-3" and
   category = "required"
   or
-  query =
-    // `Query` instance for the `declarationUnmodifiedParamMissingConstSpecifier` query
-    ConstPackage::declarationUnmodifiedParamMissingConstSpecifierQuery() and
-  queryId =
-    // `@id` for the `declarationUnmodifiedParamMissingConstSpecifier` query
-    "cpp/autosar/declaration-unmodified-param-missing-const-specifier" and
-  ruleId = "A7-1-1" and
-  category = "required"
-  or
   query =
     // `Query` instance for the `declarationUnmodifiedObjectMissingConstSpecifier` query
     ConstPackage::declarationUnmodifiedObjectMissingConstSpecifierQuery() and
@@ -145,13 +135,6 @@ module ConstPackage {
       TQueryCPP(TConstPackageQuery(TRemoveConstOrVolatileQualificationAutosarQuery()))
   }
 
-  Query declarationUnmodifiedParamMissingConstSpecifierQuery() {
-    //autogenerate `Query` type
-    result =
-      // `Query` type for `declarationUnmodifiedParamMissingConstSpecifier` query
-      TQueryCPP(TConstPackageQuery(TDeclarationUnmodifiedParamMissingConstSpecifierQuery()))
-  }
-
   Query declarationUnmodifiedObjectMissingConstSpecifierQuery() {
     //autogenerate `Query` type
     result =

cpp/autosar/test/rules/A7-1-1/DeclarationUnmodifiedParamMissingConstSpecifier.qlref

@@ -33,19 +33,6 @@
         "obligation": "required"
       },
       "queries": [
-        {
-          "description": "`Constexpr`/`const` specifiers prevent unintentional data modification for parameters intended as immutable.",
-          "kind": "problem",
-          "name": "Constexpr or const specifiers shall be used for immutable parameter usage",
-          "precision": "high",
-          "severity": "warning",
-          "short_name": "DeclarationUnmodifiedParamMissingConstSpecifier",
-          "tags": [
-            "correctness",
-            "maintainability",
-            "readability"
-          ]
-        },
         {
           "description": "`Constexpr`/`const` specifiers prevent unintentional data modification for data intended as immutable.",
           "kind": "problem",
@@ -57,7 +44,10 @@
             "correctness",
             "maintainability",
             "readability"
-          ]
+          ],
+          "implementation_scope": {
+            "description": "We exclude function parameters from this rule in line with the rule intention as described in the C++ Core Guidelines Con.1 which excludes function parameters."
+          }
         }
       ],
       "title": "Constexpr or const specifiers shall be used for immutable data declaration."