Document elementAppliesToQualifier

smowton · owen-mc · commit f61251cc2497 · 2024-11-11T23:43:59.000Z
diff --git a/go/ql/lib/semmle/go/dataflow/internal/FlowSummaryImpl.qll b/go/ql/lib/semmle/go/dataflow/internal/FlowSummaryImpl.qll
@@ -271,6 +271,14 @@ module SourceSinkInterpretationInput implements
     }
   }
 
+  /**
+   * Holds if method or field spec `sse` applies in the context of qualifier `qual`.
+   *
+   * Note that naively checking `sse.asEntity()`'s qualified name is not correct, because
+   * `Method`s and `Field`s may have multiple qualified names due to embedding. We must instead
+   * check that the specific name given be `sse.hasTypeInfo` refers to either `qual`'s type
+   * or to a type it embeds.
+   */
   private predicate elementAppliesToQualifier(SourceOrSinkElement sse, DataFlow::Node qual) {
     (
       exists(DataFlow::CallNode cn | cn.getReceiver() = qual and cn.getTarget() = sse.asEntity())

Original file line number	Diff line number	Diff line change
`@@ -271,6 +271,14 @@ module SourceSinkInterpretationInput implements`
`271`	`271`	`}`
`272`	`272`	`}`
`273`	`273`
	`274`	`+ /**`
	`275`	+ * Holds if method or field spec `sse` applies in the context of qualifier `qual`.
	`276`	`+ *`
	`277`	+ * Note that naively checking `sse.asEntity()`'s qualified name is not correct, because
	`278`	+ * `Method`s and `Field`s may have multiple qualified names due to embedding. We must instead
	`279`	+ * check that the specific name given be `sse.hasTypeInfo` refers to either `qual`'s type
	`280`	`+ * or to a type it embeds.`
	`281`	`+ */`
`274`	`282`	`private predicate elementAppliesToQualifier(SourceOrSinkElement sse, DataFlow::Node qual) {`
`275`	`283`	`(`
`276`	`284`	`exists(DataFlow::CallNode cn \| cn.getReceiver() = qual and cn.getTarget() = sse.asEntity())`