C++: Add documentation for TranslatedStructuredBindingVariableAccess

jketema · jketema · commit e40c51cc8317 · 2022-02-27T21:13:48.000+01:00
diff --git a/cpp/ql/lib/semmle/code/cpp/ir/implementation/raw/internal/TranslatedExpr.qll b/cpp/ql/lib/semmle/code/cpp/ir/implementation/raw/internal/TranslatedExpr.qll
@@ -863,6 +863,15 @@ class TranslatedFieldAccess extends TranslatedVariableAccess {
   }
 }
 
+/**
+ * The IR translation of a variable access of a structured binding, where the type
+ * of the structured binding is not of a reference type, e.g., `x0` and `x1`
+ * in `auto [x0, x1] = xs` where `xs` is an array. Although the type of the
+ * structured binding is a non-reference type, the structured binding behaves
+ * like a reference. Hence, the translation requires a `VariableAddress` followed
+ * by a `Load` instead of only a `VariableAddress` as produced by
+ * `TranslatedVariableAccess`.
+ */
 class TranslatedStructuredBindingVariableAccess extends TranslatedNonConstantExpr {
   override VariableAccess expr;
 

Original file line number	Diff line number	Diff line change
`@@ -863,6 +863,15 @@ class TranslatedFieldAccess extends TranslatedVariableAccess {`
`863`	`863`	`}`
`864`	`864`	`}`
`865`	`865`
	`866`	`+/**`
	`867`	`+ * The IR translation of a variable access of a structured binding, where the type`
	`868`	+ * of the structured binding is not of a reference type, e.g., `x0` and `x1`
	`869`	+ * in `auto [x0, x1] = xs` where `xs` is an array. Although the type of the
	`870`	`+ * structured binding is a non-reference type, the structured binding behaves`
	`871`	+ * like a reference. Hence, the translation requires a `VariableAddress` followed
	`872`	+ * by a `Load` instead of only a `VariableAddress` as produced by
	`873`	+ * `TranslatedVariableAccess`.
	`874`	`+ */`
`866`	`875`	`class TranslatedStructuredBindingVariableAccess extends TranslatedNonConstantExpr {`
`867`	`876`	`override VariableAccess expr;`
`868`	`877`