Rule 25.5.1 - LocaleGlobalFunctionNotAllowed.ql

Add query for banned locale functions. [a]

cpp/misra/src/rules/RULE-25-5-1/LocaleGlobalFunctionNotAllowed.ql

@@ -0,0 +1,28 @@
+/**
+ * @id cpp/misra/locale-global-function-not-allowed
+ * @name RULE-25-5-1: The setlocale and std::locale::global functions shall not be called
+ * @description Calling setlocale or std::locale::global functions can introduce data races with
+ *              functions that use the locale, leading to undefined behavior.
+ * @kind problem
+ * @precision very-high
+ * @problem.severity error
+ * @tags external/misra/id/rule-25-5-1
+ *       scope/single-translation-unit
+ *       external/misra/enforcement/decidable
+ *       external/misra/obligation/required
+ */
+
+import cpp
+import codingstandards.cpp.misra
+import codingstandards.cpp.BannedFunctions
+
+class BannedLocaleFunction extends Function {
+  BannedLocaleFunction() {
+    this.hasGlobalOrStdName("setlocale") or
+    this.hasQualifiedName("std", "locale", "global")
+  }
+}
+
+from BannedFunctions<BannedLocaleFunction>::Use use
+where not isExcluded(use, BannedAPIsPackage::localeGlobalFunctionNotAllowedQuery())
+select use, use.getAction() + " banned function '" + use.getFunctionName() + "' from <locale>."

cpp/misra/test/rules/RULE-25-5-1/LocaleGlobalFunctionNotAllowed.expected

@@ -0,0 +1,9 @@
+| test.cpp:6:3:6:16 | call to setlocale | Call to banned function 'setlocale' from <locale>. |
+| test.cpp:7:3:7:16 | call to setlocale | Call to banned function 'setlocale' from <locale>. |
+| test.cpp:8:3:8:16 | call to setlocale | Call to banned function 'setlocale' from <locale>. |
+| test.cpp:12:3:12:21 | call to global | Call to banned function 'global' from <locale>. |
+| test.cpp:13:3:13:21 | call to global | Call to banned function 'global' from <locale>. |
+| test.cpp:36:5:36:18 | call to setlocale | Call to banned function 'setlocale' from <locale>. |
+| test.cpp:40:5:40:18 | call to setlocale | Call to banned function 'setlocale' from <locale>. |
+| test.cpp:45:3:45:21 | call to global | Call to banned function 'global' from <locale>. |
+| test.cpp:46:3:46:21 | call to global | Call to banned function 'global' from <locale>. |

cpp/misra/test/rules/RULE-25-5-1/LocaleGlobalFunctionNotAllowed.qlref

@@ -0,0 +1 @@
+rules/RULE-25-5-1/LocaleGlobalFunctionNotAllowed.ql

cpp/misra/test/rules/RULE-25-5-1/test.cpp

@@ -0,0 +1,47 @@
+#include <cctype>
+#include <clocale>
+#include <locale>
+
+void test_setlocale_call() {
+  std::setlocale(LC_ALL, "C");            // NON_COMPLIANT
+  std::setlocale(LC_NUMERIC, "C");        // NON_COMPLIANT
+  std::setlocale(LC_TIME, "en_US.UTF-8"); // NON_COMPLIANT
+}
+
+void test_locale_global_call() {
+  std::locale::global(std::locale("C"));       // NON_COMPLIANT
+  std::locale::global(std::locale::classic()); // NON_COMPLIANT
+}
+
+void test_compliant_locale_usage() {
+  wchar_t l1 = L'\u2002';
+  std::locale l2("C");
+
+  if (std::isspace(l1, l2)) { // COMPLIANT
+  }
+  if (std::isalpha(l1, l2)) { // COMPLIANT
+  }
+  if (std::isdigit(l1, l2)) { // COMPLIANT
+  }
+}
+
+void test_compliant_locale_construction() {
+  std::locale l3("C");                     // COMPLIANT
+  std::locale l4 = std::locale::classic(); // COMPLIANT
+  std::locale l5;                          // COMPLIANT
+}
+
+void test_nested_setlocale_calls() {
+  if (true) {
+    std::setlocale(LC_ALL, "ja_JP.utf8"); // NON_COMPLIANT
+  }
+
+  for (int l6 = 0; l6 < 1; ++l6) {
+    std::setlocale(LC_CTYPE, "C"); // NON_COMPLIANT
+  }
+}
+
+void test_locale_global_with_different_locales() {
+  std::locale::global(std::locale("en_US.UTF-8")); // NON_COMPLIANT
+  std::locale::global(std::locale("ja_JP.utf8"));  // NON_COMPLIANT
+}