Merge pull request #647 from rak3-sh/rp/m0-1-10-646

Consider "main()" with typedef'd int return type as MainFunction

Author: lcartey

change_notes/2024-07-23-fix-fp-646-M0-1-10.md

@@ -0,0 +1,2 @@
+- `M0-1-10` - `EncapsulatingFunctions.qll`:
+  - Fixes #646. Consider typedef'd `int` return types for `main()` function as MainFunction.

cpp/autosar/test/rules/M0-1-10.1/UnusedFunction.expected

@@ -0,0 +1 @@
+| test.cpp:23:14:23:26 | uncalled_func | Function uncalled_func is never called. |

cpp/autosar/test/rules/M0-1-10.1/UnusedFunction.qlref

@@ -0,0 +1 @@
+rules/M0-1-10/UnusedFunction.ql

cpp/autosar/test/rules/M0-1-10.1/test.cpp

@@ -0,0 +1,39 @@
+#include <cstdint>
+
+namespace mains {
+static std::int32_t var;
+
+// @brief namespace_func
+static void
+namespace_func(void) noexcept { // COMPLIANT: Called from "main" below.
+  mains::var = -1;
+  return;
+}
+} // namespace mains
+
+std::int32_t func2() // COMPLIANT: Called from func1
+{
+  return mains::var + 20;
+}
+
+std::int32_t func1() {         // COMPLIANT: Called from main
+  return mains::var + func2(); // func2 called here.
+}
+
+std::int32_t uncalled_func() // NON_COMPLIANT: Not called.
+{
+  return mains::var + func1(); // func1 called here.
+}
+
+// @brief main
+// @return exit code
+std::int32_t main(void) {
+  std::int32_t ret{0};
+  try {
+    ret = func1(); // func1 called here.
+    mains::var += ret;
+  } catch (...) {
+    mains::namespace_func(); // namespace_func called here.
+  }
+  return ret;
+}

cpp/common/src/codingstandards/cpp/EncapsulatingFunctions.qll

@@ -14,7 +14,7 @@ abstract class EncapsulatingFunction extends Function { }
 class MainFunction extends MainLikeFunction {
   MainFunction() {
     hasGlobalName("main") and
-    getType() instanceof IntType
+    getType().resolveTypedefs() instanceof IntType
   }
 }
 

cpp/common/test/library/codingstandards/cpp/mainlikefunctions/typedefint/MainLikeFunction.expected

@@ -0,0 +1 @@
+| test.cpp:5:9:5:12 | main |

cpp/common/test/library/codingstandards/cpp/mainlikefunctions/typedefint/MainLikeFunction.ql

@@ -0,0 +1,5 @@
+import cpp
+import codingstandards.cpp.EncapsulatingFunctions
+
+from MainFunction m
+select m

cpp/common/test/library/codingstandards/cpp/mainlikefunctions/typedefint/test.cpp

@@ -0,0 +1,8 @@
+typedef signed int int32_t;
+
+// @brief main
+// @return exit code
+int32_t main(void) {
+  int32_t ret{0};
+  return ret;
+}