Document testedBranch

smowton · smowton · commit 0b08507033fb · 2023-11-30T11:24:04.000Z
diff --git a/java/ql/lib/semmle/code/java/PrettyPrintAst.qll b/java/ql/lib/semmle/code/java/PrettyPrintAst.qll
@@ -16,7 +16,7 @@ predicate pp(ClassOrInterface c, string s, int line) {
       exists(PpAst e | getEnclosingAst*(e) = c | ppPart(e, part, line, i))
     |
       part order by i
-    )
+  )
 }
 
 private PpAst getEnclosingAst(PpAst e) {
diff --git a/java/ql/lib/semmle/code/java/controlflow/Guards.qll b/java/ql/lib/semmle/code/java/controlflow/Guards.qll
@@ -223,7 +223,7 @@ class TypeTestGuard extends Guard {
   }
 
   /**
-   * Holds if this guard tests whether `e` has type `t`.
+   * Holds if this guard tests whether `e` has type `t` on `testedBranch`.
    *
    * Note that record patterns that make at least one tighter restriction than the record's definition
    * (e.g. matching `record R(Object)` with `case R(String)`) means this only guarantees the tested type

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ predicate pp(ClassOrInterface c, string s, int line) {`
`16`	`16`	`exists(PpAst e \| getEnclosingAst*(e) = c \| ppPart(e, part, line, i))`
`17`	`17`	`\|`
`18`	`18`	`part order by i`
`19`		`- )`
	`19`	`+ )`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`private PpAst getEnclosingAst(PpAst e) {`
Original file line number	Diff line number	Diff line change
`@@ -223,7 +223,7 @@ class TypeTestGuard extends Guard {`
`223`	`223`	`}`
`224`	`224`
`225`	`225`	`/**`
`226`		- * Holds if this guard tests whether `e` has type `t`.
	`226`	+ * Holds if this guard tests whether `e` has type `t` on `testedBranch`.
`227`	`227`	`*`
`228`	`228`	`* Note that record patterns that make at least one tighter restriction than the record's definition`
`229`	`229`	* (e.g. matching `record R(Object)` with `case R(String)`) means this only guarantees the tested type