Address feedback

Author: MichaelRFairhurst

c/misra/src/rules/RULE-2-8/UnusedObjectDefinition.ql

@@ -16,7 +16,7 @@ import cpp
 import codingstandards.c.misra
 import codingstandards.cpp.deadcode.UnusedObjects
 
-from ReportDeadObjectAtDefinition report
+from ReportDeadObject report
 where
   not isExcluded(report.getPrimaryElement(), DeadCode2Package::unusedObjectDefinitionQuery()) and
   not report.hasAttrUnused()

c/misra/src/rules/RULE-2-8/UnusedObjectDefinitionInMacro.ql

@@ -18,7 +18,7 @@ import cpp
 import codingstandards.c.misra
 import codingstandards.cpp.deadcode.UnusedObjects
 
-from ReportDeadObjectAtDefinition report
+from ReportDeadObject report
 where
   not isExcluded(report.getPrimaryElement(), DeadCode2Package::unusedObjectDefinitionStrictQuery()) and
   report.hasAttrUnused()

c/misra/src/rules/RULE-2-8/UnusedObjectDefinitionInMacroStrict.ql

@@ -1,10 +1,12 @@
-| test.c:6:5:6:6 | definition of g2 | Unused object definition 'g2'. | test.c:6:5:6:6 | test.c:6:5:6:6 |  |
-| test.c:9:5:9:6 | definition of g3 | Unused object definition 'g3'. | test.c:9:5:9:6 | test.c:9:5:9:6 |  |
-| test.c:20:7:20:8 | definition of l2 | Unused object definition 'l2'. | test.c:20:7:20:8 | test.c:20:7:20:8 |  |
-| test.c:27:7:27:8 | definition of l5 | Unused object definition 'l5'. | test.c:27:7:27:8 | test.c:27:7:27:8 |  |
-| test.c:37:10:37:11 | definition of g5 | Unused object definition 'g5'. | test.c:37:10:37:11 | test.c:37:10:37:11 |  |
-| test.c:45:9:45:10 | definition of g6 | Unused object definition 'g6'. | test.c:45:9:45:10 | test.c:45:9:45:10 |  |
-| test.c:51:5:51:6 | definition of g7 | Unused object definition 'g7'. | test.c:51:5:51:6 | test.c:51:5:51:6 |  |
-| test.c:64:3:64:18 | ONLY_DEF_VAR(x) | Unused object definition 'l2' from macro '$@'. | test.c:60:1:60:34 | test.c:60:1:60:34 | ONLY_DEF_VAR |
-| test.c:117:11:117:13 | definition of g10 | Unused object definition 'g10'. | test.c:117:11:117:13 | test.c:117:11:117:13 |  |
-| test.c:122:13:122:14 | definition of l2 | Unused object definition 'l2'. | test.c:122:13:122:14 | test.c:122:13:122:14 |  |
+| test.c:6:5:6:6 | definition of g2 | Unused object 'g2'. | test.c:6:5:6:6 | test.c:6:5:6:6 | (ignored) |
+| test.c:9:5:9:6 | definition of g3 | Unused object 'g3'. | test.c:9:5:9:6 | test.c:9:5:9:6 | (ignored) |
+| test.c:20:7:20:8 | definition of l2 | Unused object 'l2'. | test.c:20:7:20:8 | test.c:20:7:20:8 | (ignored) |
+| test.c:27:7:27:8 | definition of l5 | Unused object 'l5'. | test.c:27:7:27:8 | test.c:27:7:27:8 | (ignored) |
+| test.c:37:10:37:11 | definition of g5 | Unused object 'g5'. | test.c:37:10:37:11 | test.c:37:10:37:11 | (ignored) |
+| test.c:45:9:45:10 | definition of g6 | Unused object 'g6'. | test.c:45:9:45:10 | test.c:45:9:45:10 | (ignored) |
+| test.c:51:5:51:6 | definition of g7 | Unused object 'g7'. | test.c:51:5:51:6 | test.c:51:5:51:6 | (ignored) |
+| test.c:64:3:64:18 | ONLY_DEF_VAR(x) | Invocation of macro '$@' defines unused object 'l2'. | test.c:60:1:60:34 | test.c:60:1:60:34 | ONLY_DEF_VAR |
+| test.c:68:1:71:5 | #define ALSO_DEF_VAR(x) int x = 0; while (1) ; | Macro 'ALSO_DEF_VAR' defines unused object with an invocation-dependent name, for example, '$@'. | test.c:73:16:73:17 | test.c:73:16:73:17 | l1 |
+| test.c:77:1:82:3 | #define DEF_UNUSED_INNER_VAR() { int _v = 0; while (1) ; } | Macro 'DEF_UNUSED_INNER_VAR' defines unused object '_v'. | test.c:77:1:82:3 | test.c:77:1:82:3 | (ignored) |
+| test.c:119:11:119:13 | definition of g10 | Unused object 'g10'. | test.c:119:11:119:13 | test.c:119:11:119:13 | (ignored) |
+| test.c:124:13:124:14 | definition of l2 | Unused object 'l2'. | test.c:124:13:124:14 | test.c:124:13:124:14 | (ignored) |

c/misra/src/rules/RULE-2-8/UnusedObjectDefinitionStrict.ql

@@ -1,2 +1,4 @@
-| test.c:87:29:87:30 | definition of g8 | Unused object definition 'g8'. | test.c:87:29:87:30 | test.c:87:29:87:30 |  |
-| test.c:90:3:90:30 | ONLY_DEF_ATTR_UNUSED_VAR(x) | Unused object definition 'l2' from macro '$@'. | test.c:88:1:88:70 | test.c:88:1:88:70 | ONLY_DEF_ATTR_UNUSED_VAR |
+| test.c:87:29:87:30 | definition of g8 | Unused object 'g8'. | test.c:87:29:87:30 | test.c:87:29:87:30 | (ignored) |
+| test.c:92:3:92:30 | ONLY_DEF_ATTR_UNUSED_VAR(x) | Invocation of macro '$@' defines unused object 'l2'. | test.c:88:1:88:70 | test.c:88:1:88:70 | ONLY_DEF_ATTR_UNUSED_VAR |
+| test.c:96:1:99:5 | #define ALSO_DEF_ATTR_UNUSED_VAR(x) __attribute__((unused)) int x = 0; while (1) ; | Macro 'ALSO_DEF_ATTR_UNUSED_VAR' defines unused object with an invocation-dependent name, for example, '$@'. | test.c:101:28:101:29 | test.c:101:28:101:29 | l1 |
+| test.c:106:1:111:3 | #define DEF_ATTR_UNUSED_INNER_VAR() { __attribute__((unused)) int _v = 0; while (1) ; } | Macro 'DEF_ATTR_UNUSED_INNER_VAR' defines unused object '_v'. | test.c:106:1:111:3 | test.c:106:1:111:3 | (ignored) |

c/misra/test/rules/RULE-2-8/UnusedObjectDefinition.expected

@@ -87,6 +87,8 @@ void f6() {
 __attribute__((unused)) int g8 = 1; // NON-COMPLIANT
 #define ONLY_DEF_ATTR_UNUSED_VAR(x) __attribute__((unused)) int x = 0;
 void f7() {
+  ONLY_DEF_ATTR_UNUSED_VAR(l1); // COMPLIANT
+  l1;
   ONLY_DEF_ATTR_UNUSED_VAR(l2); // NON-COMPLIANT
 }
 

c/misra/test/rules/RULE-2-8/UnusedObjectDefinitionInMacro.expected

@@ -29,12 +29,16 @@ signature module MacroReportConfigSig<ResultType ResultElement> {
   /* Create a message to describe this macro, using '$@' to describe an example `ResultElement`. */
   string getMessageVariedResultInAllExpansions(Macro m);
 
-  /*
+  /**
    * Create a message to describe this macro expansion which produces a `ResultElement`, using '$@'
    * to describe the relevant macro.
    */
-
   string getMessageResultInIsolatedExpansion(ResultElement element);
+
+  /**
+   * Create a message to describe a `ResultElement` which is not generated by a macro expansion.
+   */
+  string getMessageNotInMacro(ResultElement element);
 }
 
 /**
@@ -88,7 +92,7 @@ signature module MacroReportConfigSig<ResultType ResultElement> {
  * ## Generating Report Objects
  *
  * This module also can be used to more easily report issues across these cases, by implementing
- * `MacroReportConfigSig` and importing `DeduplicateMacroResults::Report::ReportResultInMacro`.
+ * `MacroReportConfigSig` and importing `DeduplicateMacroResults::Report::ReportResult`.
  *
  * ```
  *   module InvalidFooInMacroReportConfig implements MacroReportConfigSig<InvalidFoo> {
@@ -106,11 +110,15 @@ signature module MacroReportConfigSig<ResultType ResultElement> {
  *     string getMessageResultInIsolatedExpansion(InvalidFoo foo) {
  *       result = "Invocation of macro $@ has invalid foo '" + foo.getName() + "'."
  *     }
+ * 
+ *     string getMessageNotInMacro(ResultElement element) {
+ *       result = "Invalid foo '" + element.getName() + "'."
+ *     }
  *   }
  *
  *   import DeduplicateFooInMacros::Report<InvalidFooInMacroReportConfig> as Report;
  *
- *   from Report::ReportResultInMacro report
+ *   from Report::ReportResult report
  *     where not excluded(report.getPrimaryElement(), ...)
  *   select report.getPrimaryElement(), report.getMessage(), report.getOptionalPlaceholderLocation(),
  *     report.getOptionalPlaceholderMessage()
@@ -234,11 +242,10 @@ module DeduplicateMacroResults<
     }
   }
 
-  /*
+  /**
    * Convenience predicate to know when invalid macro expansions have been reported at their macro
    * definition.
    */
-
   private predicate reported(Macro macro) {
     macro instanceof PrimaryMacroSameResultElementInAllInvocations or
     macro instanceof PrimaryMacroDifferentResultElementInAllInvocations
@@ -248,7 +255,7 @@ module DeduplicateMacroResults<
    * A macro invocation for which the target macro does not always produce a `ResultElement`, but
    * this specific invocation of it does.
    *
-   * This is "primary" / most specific macro for these result elements. It will also does not match
+   * This is the "primary" / most specific macro for these result elements. It also does not match
    * `MacroInvocation`s inside of a `MacroInvocation` of a `Macro` which always produces a
    * `ResultElement`, indicating that the real problem lies with that other `Macro` instead of with
    * this particular invocation.
@@ -274,10 +281,15 @@ module DeduplicateMacroResults<
    * See the doc comment for the `DeduplicateMacroResults` module for more info.
    */
   module Report<MacroReportConfigSig<ResultElement> ReportConfig> {
-    newtype TReportResultInMacro =
+    newtype TReportResult =
       TReportMacroResultWithSameName(PrimaryMacroSameResultElementInAllInvocations def) or
       TReportMacroResultWithVariedName(PrimaryMacroDifferentResultElementInAllInvocations def) or
-      TReportIsolatedMacroResult(IsolatedMacroExpansionWithResultElement def)
+      TReportIsolatedMacroResult(IsolatedMacroExpansionWithResultElement def) or
+      TReportNotInMacro(ResultElement def) {
+        not exists (ResultMacroExpansion macroExpansion |
+          macroExpansion.getResultElement() = def
+        )
+      }
 
     /**
      * An instance of a `ResultElement` to be reported to a user.
@@ -291,7 +303,7 @@ module DeduplicateMacroResults<
      * The values returned by these methods are configured by the `MacroReportConfigSig`
      * signature parameter.
      */
-    class ReportResultInMacro extends TReportResultInMacro {
+    class ReportResult extends TReportResult {
       string toString() { result = getMessage() }
 
       string getMessage() {
@@ -310,6 +322,11 @@ module DeduplicateMacroResults<
           this = TReportIsolatedMacroResult(def) and
           result = ReportConfig::getMessageResultInIsolatedExpansion(def.getResultElement())
         )
+        or
+        exists(ResultElement def |
+          this = TReportNotInMacro(def) and
+          result = ReportConfig::getMessageNotInMacro(def)
+        )
       }
 
       Element getPrimaryElement() {
@@ -318,6 +335,8 @@ module DeduplicateMacroResults<
         this = TReportMacroResultWithVariedName(result)
         or
         this = TReportIsolatedMacroResult(result)
+        or
+        this = TReportNotInMacro(result)
       }
 
       Location getOptionalPlaceholderLocation() {
@@ -335,6 +354,11 @@ module DeduplicateMacroResults<
           this = TReportIsolatedMacroResult(def) and
           result = def.getMacro().getLocation()
         )
+        or
+        exists(ResultElement def |
+          this = TReportNotInMacro(def) and
+          result = def.getLocation()
+        )
       }
 
       string getOptionalPlaceholderMessage() {
@@ -343,7 +367,10 @@ module DeduplicateMacroResults<
           result = Config::describe(def.getExampleResultElement())
         )
         or
-        this = TReportMacroResultWithSameName(_) and
+        (
+        this = TReportMacroResultWithSameName(_)
+        or this = TReportNotInMacro(_)
+        ) and
         result = "(ignored)"
         or
         this = TReportIsolatedMacroResult(_) and
@@ -374,6 +401,12 @@ module DeduplicateMacroResults<
         or
         this = TReportIsolatedMacroResult(result)
       }
+
+      ResultElement getAResultElement() {
+        result = getAResultMacroExpansion().getResultElement()
+        or
+        this = TReportNotInMacro(result)
+      }
     }
   }
 }