Implement RULE-6-5-1 as a shared rule with A3-3-1

knewbury01 · knewbury01 · commit b32160835fee · 2026-01-15T14:09:28.000-05:00
diff --git a/cpp/autosar/src/rules/A3-3-1/ExternalLinkageNotDeclaredInHeaderFile.ql b/cpp/autosar/src/rules/A3-3-1/ExternalLinkageNotDeclaredInHeaderFile.ql
@@ -17,25 +17,10 @@
 
 import cpp
 import codingstandards.cpp.autosar
-import codingstandards.cpp.Linkage
-import codingstandards.cpp.EncapsulatingFunctions
+import codingstandards.cpp.rules.externallinkagenotdeclaredinheaderfile.ExternalLinkageNotDeclaredInHeaderFile
 
-from DeclarationEntry de, string kind
-where
-  not isExcluded(de, IncludesPackage::externalLinkageNotDeclaredInHeaderFileQuery()) and
-  hasExternalLinkage(de.getDeclaration()) and
-  // Exclude subobjects such as struct members or member functions
-  de.getDeclaration().isTopLevel() and
-  // The declaration with external linkage does not have a declaration in a header file
-  exists(Compilation c | de.getFile() = c.getAFileCompiled()) and
-  not exists(DeclarationEntry otherDe |
-    de.getDeclaration() = otherDe.getDeclaration() and
-    not de = otherDe and
-    not otherDe.isDefinition()
-  |
-    otherDe.getFile() instanceof HeaderFile
-  ) and
-  // Main functions are an exception to the rule
-  not de.getDeclaration() instanceof MainFunction and
-  if de.getDeclaration() instanceof Function then kind = "function" else kind = "object"
-select de, "Externally linked " + kind + " '" + de.getName() + "' not declared in header file."
+class ExternalLinkageNotDeclaredInHeaderFileQuery extends ExternalLinkageNotDeclaredInHeaderFileSharedQuery {
+  ExternalLinkageNotDeclaredInHeaderFileQuery() {
+    this = IncludesPackage::externalLinkageNotDeclaredInHeaderFileQuery()
+  }
+}
diff --git a/cpp/autosar/test/rules/A3-3-1/ExternalLinkageNotDeclaredInHeaderFile.qlref b/cpp/autosar/test/rules/A3-3-1/ExternalLinkageNotDeclaredInHeaderFile.qlref
diff --git a/cpp/autosar/test/rules/A3-3-1/ExternalLinkageNotDeclaredInHeaderFile.testref b/cpp/autosar/test/rules/A3-3-1/ExternalLinkageNotDeclaredInHeaderFile.testref
@@ -0,0 +1 @@
+cpp/common/test/rules/externallinkagenotdeclaredinheaderfile/ExternalLinkageNotDeclaredInHeaderFile.ql
diff --git a/cpp/common/src/codingstandards/cpp/exclusions/cpp/Linkage1.qll b/cpp/common/src/codingstandards/cpp/exclusions/cpp/Linkage1.qll
@@ -4,41 +4,41 @@ import RuleMetadata
 import codingstandards.cpp.exclusions.RuleMetadata
 
 newtype Linkage1Query =
-  TArrayExternalLinkageSizeExplicitQuery() or
-  TExternalLinkageArrayWithoutExplicitSizeMisraQuery()
+  TExternalLinkageArrayWithoutExplicitSizeMisraQuery() or
+  TExternalLinkageNotDeclaredInHeaderFileMisraQuery()
 
 predicate isLinkage1QueryMetadata(Query query, string queryId, string ruleId, string category) {
   query =
-    // `Query` instance for the `arrayExternalLinkageSizeExplicit` query
-    Linkage1Package::arrayExternalLinkageSizeExplicitQuery() and
+    // `Query` instance for the `externalLinkageArrayWithoutExplicitSizeMisra` query
+    Linkage1Package::externalLinkageArrayWithoutExplicitSizeMisraQuery() and
   queryId =
-    // `@id` for the `arrayExternalLinkageSizeExplicit` query
-    "cpp/misra/array-external-linkage-size-explicit" and
+    // `@id` for the `externalLinkageArrayWithoutExplicitSizeMisra` query
+    "cpp/misra/external-linkage-array-without-explicit-size-misra" and
   ruleId = "RULE-6-0-2" and
   category = "advisory"
   or
   query =
-    // `Query` instance for the `externalLinkageArrayWithoutExplicitSizeMisra` query
-    Linkage1Package::externalLinkageArrayWithoutExplicitSizeMisraQuery() and
+    // `Query` instance for the `externalLinkageNotDeclaredInHeaderFileMisra` query
+    Linkage1Package::externalLinkageNotDeclaredInHeaderFileMisraQuery() and
   queryId =
-    // `@id` for the `externalLinkageArrayWithoutExplicitSizeMisra` query
-    "cpp/misra/external-linkage-array-without-explicit-size-misra" and
+    // `@id` for the `externalLinkageNotDeclaredInHeaderFileMisra` query
+    "cpp/misra/external-linkage-not-declared-in-header-file-misra" and
   ruleId = "RULE-6-5-1" and
   category = "advisory"
 }
 
 module Linkage1Package {
-  Query arrayExternalLinkageSizeExplicitQuery() {
+  Query externalLinkageArrayWithoutExplicitSizeMisraQuery() {
     //autogenerate `Query` type
     result =
-      // `Query` type for `arrayExternalLinkageSizeExplicit` query
-      TQueryCPP(TLinkage1PackageQuery(TArrayExternalLinkageSizeExplicitQuery()))
+      // `Query` type for `externalLinkageArrayWithoutExplicitSizeMisra` query
+      TQueryCPP(TLinkage1PackageQuery(TExternalLinkageArrayWithoutExplicitSizeMisraQuery()))
   }
 
-  Query externalLinkageArrayWithoutExplicitSizeMisraQuery() {
+  Query externalLinkageNotDeclaredInHeaderFileMisraQuery() {
     //autogenerate `Query` type
     result =
-      // `Query` type for `externalLinkageArrayWithoutExplicitSizeMisra` query
-      TQueryCPP(TLinkage1PackageQuery(TExternalLinkageArrayWithoutExplicitSizeMisraQuery()))
+      // `Query` type for `externalLinkageNotDeclaredInHeaderFileMisra` query
+      TQueryCPP(TLinkage1PackageQuery(TExternalLinkageNotDeclaredInHeaderFileMisraQuery()))
   }
 }
diff --git a/cpp/common/src/codingstandards/cpp/rules/externallinkagenotdeclaredinheaderfile/ExternalLinkageNotDeclaredInHeaderFile.qll b/cpp/common/src/codingstandards/cpp/rules/externallinkagenotdeclaredinheaderfile/ExternalLinkageNotDeclaredInHeaderFile.qll
@@ -0,0 +1,36 @@
+/**
+ * Provides a library with a `problems` predicate for the following issue:
+ * Using objects or functions with external linkage in implementation files makes code
+ * harder to understand.
+ */
+
+import cpp
+import codingstandards.cpp.Customizations
+import codingstandards.cpp.Exclusions
+import codingstandards.cpp.Linkage
+import codingstandards.cpp.EncapsulatingFunctions
+
+abstract class ExternalLinkageNotDeclaredInHeaderFileSharedQuery extends Query { }
+
+Query getQuery() { result instanceof ExternalLinkageNotDeclaredInHeaderFileSharedQuery }
+
+query predicate problems(DeclarationEntry de, string message) {
+  not isExcluded(de, getQuery()) and
+  hasExternalLinkage(de.getDeclaration()) and
+  // Exclude subobjects such as struct members or member functions
+  de.getDeclaration().isTopLevel() and
+  // The declaration with external linkage does not have a declaration in a header file
+  exists(Compilation c | de.getFile() = c.getAFileCompiled()) and
+  not exists(DeclarationEntry otherDe |
+    de.getDeclaration() = otherDe.getDeclaration() and
+    not de = otherDe and
+    not otherDe.isDefinition()
+  |
+    otherDe.getFile() instanceof HeaderFile
+  ) and
+  // Main functions are an exception to the rule
+  not de.getDeclaration() instanceof MainFunction and
+  if de.getDeclaration() instanceof Function
+  then message = "Externally linked function '" + de.getName() + "' not declared in header file."
+  else message = "Externally linked object '" + de.getName() + "' not declared in header file."
+}
diff --git a/cpp/common/test/rules/externallinkagenotdeclaredinheaderfile/ExternalLinkageNotDeclaredInHeaderFile.expected b/cpp/common/test/rules/externallinkagenotdeclaredinheaderfile/ExternalLinkageNotDeclaredInHeaderFile.expected
diff --git a/cpp/common/test/rules/externallinkagenotdeclaredinheaderfile/ExternalLinkageNotDeclaredInHeaderFile.ql b/cpp/common/test/rules/externallinkagenotdeclaredinheaderfile/ExternalLinkageNotDeclaredInHeaderFile.ql
@@ -0,0 +1,4 @@
+// GENERATED FILE - DO NOT MODIFY
+import codingstandards.cpp.rules.externallinkagenotdeclaredinheaderfile.ExternalLinkageNotDeclaredInHeaderFile
+
+class TestFileQuery extends ExternalLinkageNotDeclaredInHeaderFileSharedQuery, TestQuery { }
diff --git a/cpp/common/test/rules/externallinkagenotdeclaredinheaderfile/test.cpp b/cpp/common/test/rules/externallinkagenotdeclaredinheaderfile/test.cpp
diff --git a/cpp/common/test/rules/externallinkagenotdeclaredinheaderfile/test.hpp b/cpp/common/test/rules/externallinkagenotdeclaredinheaderfile/test.hpp
diff --git a/cpp/misra/src/rules/RULE-6-5-1/ExternalLinkageNotDeclaredInHeaderFileMisra.ql b/cpp/misra/src/rules/RULE-6-5-1/ExternalLinkageNotDeclaredInHeaderFileMisra.ql
@@ -0,0 +1,26 @@
+/**
+ * @id cpp/misra/external-linkage-not-declared-in-header-file-misra
+ * @name RULE-6-5-1: Objects or functions with external linkage shall be declared in a header file
+ * @description Using objects or functions with external linkage in implementation files makes code
+ *              harder to understand.
+ * @kind problem
+ * @precision very-high
+ * @problem.severity warning
+ * @tags external/misra/id/rule-6-5-1
+ *       correctness
+ *       maintainability
+ *       readability
+ *       scope/single-translation-unit
+ *       external/misra/enforcement/decidable
+ *       external/misra/obligation/advisory
+ */
+
+import cpp
+import codingstandards.cpp.misra
+import codingstandards.cpp.rules.externallinkagenotdeclaredinheaderfile.ExternalLinkageNotDeclaredInHeaderFile
+
+class ExternalLinkageNotDeclaredInHeaderFileMisraQuery extends ExternalLinkageNotDeclaredInHeaderFileSharedQuery {
+  ExternalLinkageNotDeclaredInHeaderFileMisraQuery() {
+    this = Linkage1Package::externalLinkageNotDeclaredInHeaderFileMisraQuery()
+  }
+}
diff --git a/cpp/misra/test/rules/RULE-6-5-1/ExternalLinkageNotDeclaredInHeaderFileMisra.testref b/cpp/misra/test/rules/RULE-6-5-1/ExternalLinkageNotDeclaredInHeaderFileMisra.testref
@@ -0,0 +1 @@
+cpp/common/test/rules/externallinkagenotdeclaredinheaderfile/ExternalLinkageNotDeclaredInHeaderFile.ql
diff --git a/rule_packages/cpp/Includes.json b/rule_packages/cpp/Includes.json
@@ -119,6 +119,7 @@
           "precision": "very-high",
           "severity": "warning",
           "short_name": "ExternalLinkageNotDeclaredInHeaderFile",
+          "shared_implementation_short_name": "ExternalLinkageNotDeclaredInHeaderFile",
           "tags": [
             "correctness",
             "maintainability",
diff --git a/rule_packages/cpp/Linkage1.json b/rule_packages/cpp/Linkage1.json
@@ -12,7 +12,8 @@
           "name": "Arrays with external linkage declared without explicit size shall not be used",
           "precision": "very-high",
           "severity": "warning",
-          "short_name": "ArrayExternalLinkageSizeExplicit",
+          "short_name": "ExternalLinkageArrayWithoutExplicitSizeMisra",
+          "shared_implementation_short_name": "ExternalLinkageArrayWithoutExplicitSize",
           "tags": [
             "maintainability",
             "readability",
@@ -29,14 +30,15 @@
       },
       "queries": [
         {
-          "description": "Introducing a function or object with external linkage outside of a header file can cause developer confusion about its translation unit access semantics.",
+          "description": "Using objects or functions with external linkage in implementation files makes code harder to understand.",
           "kind": "problem",
-          "name": "Introducing a function or object with external linkage outside of a header file can cause developer confusion about its translation unit access semantics.",
+          "name": "Objects or functions with external linkage shall be declared in a header file",
           "precision": "very-high",
           "severity": "warning",
-          "short_name": "ExternalLinkageArrayWithoutExplicitSizeMisra",
-          "shared_implementation_short_name": "ExternalLinkageArrayWithoutExplicitSize",
+          "short_name": "ExternalLinkageNotDeclaredInHeaderFileMisra",
+          "shared_implementation_short_name": "ExternalLinkageNotDeclaredInHeaderFile",
           "tags": [
+            "correctness",
             "maintainability",
             "readability",
             "scope/single-translation-unit"
diff --git a/rules.csv b/rules.csv
@@ -850,7 +850,7 @@ cpp,MISRA-C++-2023,RULE-5-13-5,Yes,Required,Decidable,Single Translation Unit,Th
 cpp,MISRA-C++-2023,RULE-5-13-6,Yes,Required,Decidable,Single Translation Unit,An integer-literal of type long long shall not use a single L or l in any suffix,,Expressions2,Easy,
 cpp,MISRA-C++-2023,RULE-5-13-7,No,Required,Decidable,Single Translation Unit,String literals with different encoding prefixes shall not be concatenated,A2-13-2,,,
 cpp,MISRA-C++-2023,RULE-6-0-1,Yes,Required,Decidable,Single Translation Unit,Block scope declarations shall not be visually ambiguous,"M3-1-2,DCL53-CPP",Declarations2,Easy,
-cpp,MISRA-C++-2023,RULE-6-0-2,Yes,Advisory,Decidable,Single Translation Unit,"When an array with external linkage is declared, its size should be explicitly specified",RULE-18-8,Linkage1,Easy,
+cpp,MISRA-C++-2023,RULE-6-0-2,Yes,Advisory,Decidable,Single Translation Unit,"When an array with external linkage is declared, its size should be explicitly specified",RULE-18-8,Linkage1,Import,
 cpp,MISRA-C++-2023,RULE-6-0-3,Yes,Advisory,Decidable,Single Translation Unit,"The only declarations in the global namespace should be main, namespace declarations and extern ""C"" declarations",M7-3-1,ImportMisra23,Import,
 cpp,MISRA-C++-2023,RULE-6-0-4,Yes,Required,Decidable,Single Translation Unit,The identifier main shall not be used for a function other than the global function main,M7-3-2,ImportMisra23,Import,
 cpp,MISRA-C++-2023,RULE-6-2-1,Yes,Required,Decidable,System,The one-definition rule shall not be violated,M3-2-2,ImportMisra23,Import,
@@ -860,7 +860,7 @@ cpp,MISRA-C++-2023,RULE-6-2-4,Yes,Required,Decidable,Single Translation Unit,A h
 cpp,MISRA-C++-2023,RULE-6-4-1,Yes,Required,Decidable,Single Translation Unit,A variable declared in an inner scope shall not hide a variable declared in an outer scope,A2-10-1,ImportMisra23,Import,
 cpp,MISRA-C++-2023,RULE-6-4-2,Yes,Required,Decidable,Single Translation Unit,Derived classes shall not conceal functions that are inherited from their bases,A7-3-1,ImportMisra23,Import,
 cpp,MISRA-C++-2023,RULE-6-4-3,Yes,Required,Decidable,Single Translation Unit,A name that is present in a dependent base shall not be resolved by unqualified lookup,M14-6-1,ImportMisra23,Import,
-cpp,MISRA-C++-2023,RULE-6-5-1,Yes,Advisory,Decidable,Single Translation Unit,A function or object with external linkage should be introduced in a header file,,Linkage1,Medium,
+cpp,MISRA-C++-2023,RULE-6-5-1,Yes,Advisory,Decidable,Single Translation Unit,A function or object with external linkage should be introduced in a header file,A3-3-1,Linkage1,Import,
 cpp,MISRA-C++-2023,RULE-6-5-2,Yes,Advisory,Decidable,Single Translation Unit,Internal linkage should be specified appropriately,,Linkage,Medium,
 cpp,MISRA-C++-2023,RULE-6-7-1,Yes,Required,Decidable,Single Translation Unit,Local variables shall not have static storage duration,,Declarations2,Easy,
 cpp,MISRA-C++-2023,RULE-6-7-2,Yes,Required,Decidable,Single Translation Unit,Global variables shall not be used,,Banned,Easy,

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+cpp/common/test/rules/externallinkagenotdeclaredinheaderfile/ExternalLinkageNotDeclaredInHeaderFile.ql`