Explain getSyntacticQual

smowton · owen-mc · commit cd99bea9c10b · 2024-11-11T23:43:55.000Z
diff --git a/go/ql/lib/semmle/go/dataflow/internal/FlowSummaryImpl.qll b/go/ql/lib/semmle/go/dataflow/internal/FlowSummaryImpl.qll
@@ -303,6 +303,13 @@ module SourceSinkInterpretationInput implements
     )
   }
 
+  /**
+   * Gets `underlying`, where `n` if of the form `implicitDeref?(underlying.implicitFieldRead1.implicitFieldRead2...)`
+   *
+   * For Go syntax like `qualifier.method()` or `qualifier.field`, this is the type of `qualifier`, before any
+   * implicit dereference is interposed because `qualifier` is of pointer type, or implicit field accesses
+   * navigate to any embedded struct types that truly host `field`.
+   */
   private DataFlow::Node getSyntacticQualifier(DataFlow::Node n) {
     exists(DataFlow::Node n2 |
       // look through implicit dereference, if there is one

Original file line number	Diff line number	Diff line change
`@@ -303,6 +303,13 @@ module SourceSinkInterpretationInput implements`
`303`	`303`	`)`
`304`	`304`	`}`
`305`	`305`
	`306`	`+ /**`
	`307`	+ * Gets `underlying`, where `n` if of the form `implicitDeref?(underlying.implicitFieldRead1.implicitFieldRead2...)`
	`308`	`+ *`
	`309`	+ * For Go syntax like `qualifier.method()` or `qualifier.field`, this is the type of `qualifier`, before any
	`310`	+ * implicit dereference is interposed because `qualifier` is of pointer type, or implicit field accesses
	`311`	+ * navigate to any embedded struct types that truly host `field`.
	`312`	`+ */`
`306`	`313`	`private DataFlow::Node getSyntacticQualifier(DataFlow::Node n) {`
`307`	`314`	`exists(DataFlow::Node n2 \|`
`308`	`315`	`// look through implicit dereference, if there is one`