Swift: add comment about unique in getImmediateParent

redsun82 · redsun82 · commit a4f97dd67a2f · 2022-06-01T14:32:59.000+02:00
diff --git a/swift/codegen/templates/ql_parent.mustache b/swift/codegen/templates/ql_parent.mustache
@@ -41,5 +41,7 @@ Element getAnImmediateChild(Element e) {
  * if `e` has conversions, `getImmediateParent(e)` will give the bottom conversion in the hidden AST.
  */
  Element getImmediateParent(Element e) {
+   // `unique` is used here to tell the optimizer that there is in fact only one result
+   // this is tested by the `library-tests/parent/no_double_parents.ql` test
    result = unique(Element x | e = getAnImmediateChild(x) | x)
 }
diff --git a/swift/ql/lib/codeql/swift/generated/GetImmediateParent.qll b/swift/ql/lib/codeql/swift/generated/GetImmediateParent.qll
@@ -238,5 +238,7 @@ Element getAnImmediateChild(Element e) {
  * if `e` has conversions, `getImmediateParent(e)` will give the bottom conversion in the hidden AST.
  */
 Element getImmediateParent(Element e) {
+  // `unique` is used here to tell the optimizer that there is in fact only one result
+  // this is tested by the `library-tests/parent/no_double_parents.ql` test
   result = unique(Element x | e = getAnImmediateChild(x) | x)
 }

Original file line number	Diff line number	Diff line change
`@@ -41,5 +41,7 @@ Element getAnImmediateChild(Element e) {`
`41`	`41`	* if `e` has conversions, `getImmediateParent(e)` will give the bottom conversion in the hidden AST.
`42`	`42`	`*/`
`43`	`43`	`Element getImmediateParent(Element e) {`
	`44`	+ // `unique` is used here to tell the optimizer that there is in fact only one result
	`45`	+ // this is tested by the `library-tests/parent/no_double_parents.ql` test
`44`	`46`	`result = unique(Element x \| e = getAnImmediateChild(x) \| x)`
`45`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -238,5 +238,7 @@ Element getAnImmediateChild(Element e) {`
`238`	`238`	* if `e` has conversions, `getImmediateParent(e)` will give the bottom conversion in the hidden AST.
`239`	`239`	`*/`
`240`	`240`	`Element getImmediateParent(Element e) {`
	`241`	+ // `unique` is used here to tell the optimizer that there is in fact only one result
	`242`	+ // this is tested by the `library-tests/parent/no_double_parents.ql` test
`241`	`243`	`result = unique(Element x \| e = getAnImmediateChild(x) \| x)`
`242`	`244`	`}`