A3-9-1: Convert to shared query

Convert AUTOSAR rule A3-9-1 to a shared query to reuse the
implementation for MISRA C++ 2023 Rule 6.9.2.

Author: lcartey

cpp/autosar/src/rules/A3-9-1/VariableWidthIntegerTypesUsed.ql

@@ -17,26 +17,10 @@
 
 import cpp
 import codingstandards.cpp.autosar
-import codingstandards.cpp.EncapsulatingFunctions
-import codingstandards.cpp.BuiltInNumericTypes
-import codingstandards.cpp.Type
-import codingstandards.cpp.Operator
+import codingstandards.cpp.rules.variablewidthintegertypesused.VariableWidthIntegerTypesUsed
 
-from Variable v, Type typeStrippedOfSpecifiers
-where
-  not isExcluded(v, DeclarationsPackage::variableWidthIntegerTypesUsedQuery()) and
-  typeStrippedOfSpecifiers = stripSpecifiers(v.getType()) and
-  (
-    typeStrippedOfSpecifiers instanceof BuiltInIntegerType or
-    typeStrippedOfSpecifiers instanceof UnsignedCharType or
-    typeStrippedOfSpecifiers instanceof SignedCharType
-  ) and
-  not v instanceof ExcludedVariable and
-  // Dont consider template instantiations because instantiations with
-  // Fixed Width Types are recorded after stripping their typedef'd type,
-  // thereby, causing false positives (#540).
-  not v.isFromTemplateInstantiation(_) and
-  //post-increment/post-decrement operators are required by the standard to have a dummy int parameter
-  not v.(Parameter).getFunction() instanceof PostIncrementOperator and
-  not v.(Parameter).getFunction() instanceof PostDecrementOperator
-select v, "Variable '" + v.getName() + "' has variable-width type."
+class VariableWidthIntegerTypesUsedQuery extends VariableWidthIntegerTypesUsedSharedQuery {
+  VariableWidthIntegerTypesUsedQuery() {
+    this = DeclarationsPackage::variableWidthIntegerTypesUsedQuery()
+  }
+}

cpp/autosar/test/rules/A3-9-1/VariableWidthIntegerTypesUsed.qlref

@@ -0,0 +1 @@
+cpp/common/test/rules/variablewidthintegertypesused/VariableWidthIntegerTypesUsed.ql

cpp/autosar/test/rules/A3-9-1/VariableWidthIntegerTypesUsed.testref

@@ -1,3 +1,3 @@
 | test.cpp:4:8:4:8 | c | Variable 'c' has variable-width char type. |
-| test.cpp:38:14:38:15 | c1 | Variable 'c1' has variable-width char type. |
-| test.cpp:56:17:56:18 | c2 | Variable 'c2' has variable-width char type. |
+| test.cpp:10:14:10:15 | c1 | Variable 'c1' has variable-width char type. |
+| test.cpp:14:17:14:18 | c2 | Variable 'c2' has variable-width char type. |

cpp/autosar/test/rules/A3-9-1/VariableWidthPlainCharTypeUsed.expected

@@ -2,88 +2,16 @@
 
 void test_variable_width_type_variables() {
   char c;           // NON_COMPLIANT
-  unsigned char uc; // NON_COMPLIANT
-  signed char sc;   // NON_COMPLIANT
-
-  int i;           // NON_COMPLIANT
-  unsigned int ui; // NON_COMPLIANT
-  unsigned u;      // NON_COMPLIANT
-  signed int si;   // NON_COMPLIANT
-  signed s;        // NON_COMPLIANT
-
-  short sh;           // NON_COMPLIANT
-  unsigned short ush; // NON_COMPLIANT
-  signed short ssh;   // NON_COMPLIANT
-
-  long l;           // NON_COMPLIANT
-  unsigned long ul; // NON_COMPLIANT
-  signed long sl;   // NON_COMPLIANT
-
-  std::int8_t i8;   // COMPLIANT
-  std::int16_t i16; // COMPLIANT
-  std::int32_t i32; // COMPLIANT
-  std::int64_t i64; // COMPLIANT
-
-  std::uint8_t u8;   // COMPLIANT
-  std::uint16_t u16; // COMPLIANT
-  std::uint32_t u32; // COMPLIANT
-  std::uint64_t u64; // COMPLIANT
-}
-
-int main(int argc, char *argv[]) { // COMPLIANT
-  // main as an exception
+  unsigned char uc; // COMPLIANT - covered by VariableWidthIntegerTypesUsed
+  signed char sc;   // COMPLIANT - covered by VariableWidthIntegerTypesUsed
 }
 
 void test_variable_width_type_qualified_variables() {
   const char c1 = 0;           // NON_COMPLIANT
-  const unsigned char uc1 = 0; // NON_COMPLIANT
-  const signed char sc1 = 0;   // NON_COMPLIANt
-
-  const int i1 = 0;           // NON_COMPLIANT
-  const unsigned int ui1 = 0; // NON_COMPLIANT
-  const unsigned u1 = 0;      // NON_COMPLIANT
-  const signed int si1 = 0;   // NON_COMPLIANT
-  const signed s1 = 0;        // NON_COMPLIANT
-
-  const short sh1 = 0;           // NON_COMPLIANT
-  const unsigned short ush1 = 0; // NON_COMPLIANT
-  const signed short ssh1 = 0;   // NON_COMPLIANT
-
-  const long l1 = 0;           // NON_COMPLIANT
-  const unsigned long ul1 = 0; // NON_COMPLIANT
-  const signed long sl1 = 0;   // NON_COMPLIANT
+  const unsigned char uc1 = 0; // COMPLIANT - (VariableWidthIntegerTypesUsed)
+  const signed char sc1 = 0;   // COMPLIANT - (VariableWidthIntegerTypesUsed)
 
   volatile char c2;           // NON_COMPLIANT
-  volatile unsigned char uc2; // NON_COMPLIANT
-  volatile signed char sc2;   // NON_COMPLIANt
-
-  volatile int i2;           // NON_COMPLIANT
-  volatile unsigned int ui2; // NON_COMPLIANT
-  volatile unsigned u2;      // NON_COMPLIANT
-  volatile signed int si2;   // NON_COMPLIANT
-  volatile signed s2;        // NON_COMPLIANT
-
-  volatile short sh2;           // NON_COMPLIANT
-  volatile unsigned short ush2; // NON_COMPLIANT
-  volatile signed short ssh2;   // NON_COMPLIANT
-
-  volatile long l2;           // NON_COMPLIANT
-  volatile unsigned long ul2; // NON_COMPLIANT
-  volatile signed long sl2;   // NON_COMPLIANT
-}
-
-struct test_fix_fp_614 {
-  test_fix_fp_614 operator++(int); // COMPLIANT
-  test_fix_fp_614 operator--(int); // COMPLIANT
-};
-
-// COMPLIANT - instantiated with Fixed Width Types.
-template <typename MyType> constexpr void test_fix_fp_540(MyType value) {
-  value++;
-}
-
-int call_test_fix_fp_540() {
-  test_fix_fp_540<std::uint8_t>(19);
-  test_fix_fp_540<std::int16_t>(20);
-  return 0;
-}
+  volatile unsigned char uc2; // COMPLIANT - (VariableWidthIntegerTypesUsed)
+  volatile signed char sc2;   // COMPLIANT - (VariableWidthIntegerTypesUsed)
+}

cpp/autosar/test/rules/A3-9-1/test.cpp

@@ -0,0 +1,38 @@
+/**
+ * Provides a library with a `problems` predicate for the following issue:
+ * The basic numerical types of signed/unsigned char, int, short, long are not supposed
+ * to be used. The specific-length types from <cstdint> header need be used instead.
+ */
+
+import cpp
+import codingstandards.cpp.Customizations
+import codingstandards.cpp.Exclusions
+import codingstandards.cpp.EncapsulatingFunctions
+import codingstandards.cpp.BuiltInNumericTypes
+import codingstandards.cpp.Type
+import codingstandards.cpp.Operator
+
+abstract class VariableWidthIntegerTypesUsedSharedQuery extends Query { }
+
+Query getQuery() { result instanceof VariableWidthIntegerTypesUsedSharedQuery }
+
+query predicate problems(Variable v, string message) {
+  not isExcluded(v, getQuery()) and
+  exists(Type typeStrippedOfSpecifiers |
+    typeStrippedOfSpecifiers = stripSpecifiers(v.getType()) and
+    (
+      typeStrippedOfSpecifiers instanceof BuiltInIntegerType or
+      typeStrippedOfSpecifiers instanceof UnsignedCharType or
+      typeStrippedOfSpecifiers instanceof SignedCharType
+    ) and
+    not v instanceof ExcludedVariable and
+    // Dont consider template instantiations because instantiations with
+    // Fixed Width Types are recorded after stripping their typedef'd type,
+    // thereby, causing false positives (#540).
+    not v.isFromTemplateInstantiation(_) and
+    //post-increment/post-decrement operators are required by the standard to have a dummy int parameter
+    not v.(Parameter).getFunction() instanceof PostIncrementOperator and
+    not v.(Parameter).getFunction() instanceof PostDecrementOperator
+  ) and
+  message = "Variable '" + v.getName() + "' has variable-width type."
+}

cpp/common/src/codingstandards/cpp/rules/variablewidthintegertypesused/VariableWidthIntegerTypesUsed.qll

@@ -0,0 +1,4 @@
+// GENERATED FILE - DO NOT MODIFY
+import codingstandards.cpp.rules.variablewidthintegertypesused.VariableWidthIntegerTypesUsed
+
+class TestFileQuery extends VariableWidthIntegerTypesUsedSharedQuery, TestQuery { }

cpp/autosar/test/rules/A3-9-1/VariableWidthIntegerTypesUsed.expected renamed to cpp/common/test/rules/variablewidthintegertypesused/VariableWidthIntegerTypesUsed.expected

@@ -0,0 +1,89 @@
+#include <cstdint>
+
+void test_variable_width_type_variables() {
+  char c;           // COMPLIANT
+  unsigned char uc; // NON_COMPLIANT
+  signed char sc;   // NON_COMPLIANT
+
+  int i;           // NON_COMPLIANT
+  unsigned int ui; // NON_COMPLIANT
+  unsigned u;      // NON_COMPLIANT
+  signed int si;   // NON_COMPLIANT
+  signed s;        // NON_COMPLIANT
+
+  short sh;           // NON_COMPLIANT
+  unsigned short ush; // NON_COMPLIANT
+  signed short ssh;   // NON_COMPLIANT
+
+  long l;           // NON_COMPLIANT
+  unsigned long ul; // NON_COMPLIANT
+  signed long sl;   // NON_COMPLIANT
+
+  std::int8_t i8;   // COMPLIANT
+  std::int16_t i16; // COMPLIANT
+  std::int32_t i32; // COMPLIANT
+  std::int64_t i64; // COMPLIANT
+
+  std::uint8_t u8;   // COMPLIANT
+  std::uint16_t u16; // COMPLIANT
+  std::uint32_t u32; // COMPLIANT
+  std::uint64_t u64; // COMPLIANT
+}
+
+int main(int argc, char *argv[]) { // COMPLIANT
+  // main as an exception
+}
+
+void test_variable_width_type_qualified_variables() {
+  const char c1 = 0;           // COMPLIANT
+  const unsigned char uc1 = 0; // NON_COMPLIANT
+  const signed char sc1 = 0;   // NON_COMPLIANt
+
+  const int i1 = 0;           // NON_COMPLIANT
+  const unsigned int ui1 = 0; // NON_COMPLIANT
+  const unsigned u1 = 0;      // NON_COMPLIANT
+  const signed int si1 = 0;   // NON_COMPLIANT
+  const signed s1 = 0;        // NON_COMPLIANT
+
+  const short sh1 = 0;           // NON_COMPLIANT
+  const unsigned short ush1 = 0; // NON_COMPLIANT
+  const signed short ssh1 = 0;   // NON_COMPLIANT
+
+  const long l1 = 0;           // NON_COMPLIANT
+  const unsigned long ul1 = 0; // NON_COMPLIANT
+  const signed long sl1 = 0;   // NON_COMPLIANT
+
+  volatile char c2;           // COMPLIANT
+  volatile unsigned char uc2; // NON_COMPLIANT
+  volatile signed char sc2;   // NON_COMPLIANt
+
+  volatile int i2;           // NON_COMPLIANT
+  volatile unsigned int ui2; // NON_COMPLIANT
+  volatile unsigned u2;      // NON_COMPLIANT
+  volatile signed int si2;   // NON_COMPLIANT
+  volatile signed s2;        // NON_COMPLIANT
+
+  volatile short sh2;           // NON_COMPLIANT
+  volatile unsigned short ush2; // NON_COMPLIANT
+  volatile signed short ssh2;   // NON_COMPLIANT
+
+  volatile long l2;           // NON_COMPLIANT
+  volatile unsigned long ul2; // NON_COMPLIANT
+  volatile signed long sl2;   // NON_COMPLIANT
+}
+
+struct test_fix_fp_614 {
+  test_fix_fp_614 operator++(int); // COMPLIANT
+  test_fix_fp_614 operator--(int); // COMPLIANT
+};
+
+// COMPLIANT - instantiated with Fixed Width Types.
+template <typename MyType> constexpr void test_fix_fp_540(MyType value) {
+  value++;
+}
+
+int call_test_fix_fp_540() {
+  test_fix_fp_540<std::uint8_t>(19);
+  test_fix_fp_540<std::int16_t>(20);
+  return 0;
+}

cpp/common/test/rules/variablewidthintegertypesused/VariableWidthIntegerTypesUsed.ql

@@ -93,7 +93,8 @@
           ],
           "implementation_scope": {
             "description": "This implementation excludes the plain char type from consideration."
-          }
+          },
+          "shared_implementation_short_name": "VariableWidthIntegerTypesUsed"
         },
         {
           "description": "The basic numerical type char is not supposed to be used. The specific-length types from <cstdint> header need be used instead.",