C#: Address more review comments

hvitved · hvitved · commit 349e0e8e6282 · 2019-07-04T16:46:01.000+02:00
diff --git a/csharp/ql/src/semmle/code/csharp/controlflow/internal/Completion.qll b/csharp/ql/src/semmle/code/csharp/controlflow/internal/Completion.qll
@@ -655,8 +655,8 @@ class BreakNormalCompletion extends NormalCompletion, TBreakNormalCompletion {
  * }
  * ```
  *
- * `System.Console.WriteLine("M called")` inherits the throw completion
- * from `throw new Exception` with an underlying simple completion.
+ * `System.Console.WriteLine("M called")` has an outer throw completion
+ * from `throw new Exception` and an inner simple completion.
  */
 class NestedCompletion extends Completion, TNestedCompletion {
   private NormalCompletion inner;
@@ -682,7 +682,10 @@ class ReturnCompletion extends Completion {
     this = TNestedCompletion(_, TReturnCompletion())
   }
 
-  override string toString() { this = TReturnCompletion() and result = "return" }
+  override string toString() {
+    // `NestedCompletion` defines `toString()` for the other case
+    this = TReturnCompletion() and result = "return"
+  }
 }
 
 /**
@@ -696,7 +699,10 @@ class BreakCompletion extends Completion {
     this = TNestedCompletion(_, TBreakCompletion())
   }
 
-  override string toString() { this = TBreakCompletion() and result = "break" }
+  override string toString() {
+    // `NestedCompletion` defines `toString()` for the other case
+    this = TBreakCompletion() and result = "break"
+  }
 }
 
 /**
@@ -710,7 +716,10 @@ class ContinueCompletion extends Completion {
     this = TNestedCompletion(_, TContinueCompletion())
   }
 
-  override string toString() { this = TContinueCompletion() and result = "continue" }
+  override string toString() {
+    // `NestedCompletion` defines `toString()` for the other case
+    this = TContinueCompletion() and result = "continue"
+  }
 }
 
 /**
@@ -738,6 +747,7 @@ class GotoLabelCompletion extends GotoCompletion {
   GotoLabelStmt getGotoStmt() { result = goto }
 
   override string toString() {
+    // `NestedCompletion` defines `toString()` for the other case
     this = TGotoLabelCompletion(goto) and result = "goto(" + this.getLabel() + ")"
   }
 }
@@ -761,6 +771,7 @@ class GotoCaseCompletion extends GotoCompletion {
   GotoCaseStmt getGotoStmt() { result = goto }
 
   override string toString() {
+    // `NestedCompletion` defines `toString()` for the other case
     this = TGotoCaseCompletion(goto) and result = "goto case(" + this.getLabel() + ")"
   }
 }
@@ -775,7 +786,10 @@ class GotoDefaultCompletion extends GotoCompletion {
     this = TNestedCompletion(_, TGotoDefaultCompletion())
   }
 
-  override string toString() { this = TGotoDefaultCompletion() and result = "goto default" }
+  override string toString() {
+    // `NestedCompletion` defines `toString()` for the other case
+    this = TGotoDefaultCompletion() and result = "goto default"
+  }
 }
 
 /**
@@ -793,7 +807,10 @@ class ThrowCompletion extends Completion {
   /** Gets the type of the exception being thrown. */
   ExceptionClass getExceptionClass() { result = ec }
 
-  override string toString() { this = TThrowCompletion(ec) and result = "throw(" + ec + ")" }
+  override string toString() {
+    // `NestedCompletion` defines `toString()` for the other case
+    this = TThrowCompletion(ec) and result = "throw(" + ec + ")"
+  }
 }
 
 /**
@@ -811,5 +828,8 @@ class ExitCompletion extends Completion {
     this = TNestedCompletion(_, TExitCompletion())
   }
 
-  override string toString() { this = TExitCompletion() and result = "exit" }
+  override string toString() {
+    // `NestedCompletion` defines `toString()` for the other case
+    this = TExitCompletion() and result = "exit"
+  }
 }

Original file line number	Diff line number	Diff line change
`@@ -655,8 +655,8 @@ class BreakNormalCompletion extends NormalCompletion, TBreakNormalCompletion {`
`655`	`655`	`* }`
`656`	`656`	* ```
`657`	`657`	`*`
`658`		- * `System.Console.WriteLine("M called")` inherits the throw completion
`659`		- * from `throw new Exception` with an underlying simple completion.
	`658`	+ * `System.Console.WriteLine("M called")` has an outer throw completion
	`659`	+ * from `throw new Exception` and an inner simple completion.
`660`	`660`	`*/`
`661`	`661`	`class NestedCompletion extends Completion, TNestedCompletion {`
`662`	`662`	`private NormalCompletion inner;`
`@@ -682,7 +682,10 @@ class ReturnCompletion extends Completion {`
`682`	`682`	`this = TNestedCompletion(_, TReturnCompletion())`
`683`	`683`	`}`
`684`	`684`
`685`		`- override string toString() { this = TReturnCompletion() and result = "return" }`
	`685`	`+ override string toString() {`
	`686`	+ // `NestedCompletion` defines `toString()` for the other case
	`687`	`+ this = TReturnCompletion() and result = "return"`
	`688`	`+ }`
`686`	`689`	`}`
`687`	`690`
`688`	`691`	`/**`
`@@ -696,7 +699,10 @@ class BreakCompletion extends Completion {`
`696`	`699`	`this = TNestedCompletion(_, TBreakCompletion())`
`697`	`700`	`}`
`698`	`701`
`699`		`- override string toString() { this = TBreakCompletion() and result = "break" }`
	`702`	`+ override string toString() {`
	`703`	+ // `NestedCompletion` defines `toString()` for the other case
	`704`	`+ this = TBreakCompletion() and result = "break"`
	`705`	`+ }`
`700`	`706`	`}`
`701`	`707`
`702`	`708`	`/**`
`@@ -710,7 +716,10 @@ class ContinueCompletion extends Completion {`
`710`	`716`	`this = TNestedCompletion(_, TContinueCompletion())`
`711`	`717`	`}`
`712`	`718`
`713`		`- override string toString() { this = TContinueCompletion() and result = "continue" }`
	`719`	`+ override string toString() {`
	`720`	+ // `NestedCompletion` defines `toString()` for the other case
	`721`	`+ this = TContinueCompletion() and result = "continue"`
	`722`	`+ }`
`714`	`723`	`}`
`715`	`724`
`716`	`725`	`/**`
`@@ -738,6 +747,7 @@ class GotoLabelCompletion extends GotoCompletion {`
`738`	`747`	`GotoLabelStmt getGotoStmt() { result = goto }`
`739`	`748`
`740`	`749`	`override string toString() {`
	`750`	+ // `NestedCompletion` defines `toString()` for the other case
`741`	`751`	`this = TGotoLabelCompletion(goto) and result = "goto(" + this.getLabel() + ")"`
`742`	`752`	`}`
`743`	`753`	`}`
`@@ -761,6 +771,7 @@ class GotoCaseCompletion extends GotoCompletion {`
`761`	`771`	`GotoCaseStmt getGotoStmt() { result = goto }`
`762`	`772`
`763`	`773`	`override string toString() {`
	`774`	+ // `NestedCompletion` defines `toString()` for the other case
`764`	`775`	`this = TGotoCaseCompletion(goto) and result = "goto case(" + this.getLabel() + ")"`
`765`	`776`	`}`
`766`	`777`	`}`
`@@ -775,7 +786,10 @@ class GotoDefaultCompletion extends GotoCompletion {`
`775`	`786`	`this = TNestedCompletion(_, TGotoDefaultCompletion())`
`776`	`787`	`}`
`777`	`788`
`778`		`- override string toString() { this = TGotoDefaultCompletion() and result = "goto default" }`
	`789`	`+ override string toString() {`
	`790`	+ // `NestedCompletion` defines `toString()` for the other case
	`791`	`+ this = TGotoDefaultCompletion() and result = "goto default"`
	`792`	`+ }`
`779`	`793`	`}`
`780`	`794`
`781`	`795`	`/**`
`@@ -793,7 +807,10 @@ class ThrowCompletion extends Completion {`
`793`	`807`	`/** Gets the type of the exception being thrown. */`
`794`	`808`	`ExceptionClass getExceptionClass() { result = ec }`
`795`	`809`
`796`		`- override string toString() { this = TThrowCompletion(ec) and result = "throw(" + ec + ")" }`
	`810`	`+ override string toString() {`
	`811`	+ // `NestedCompletion` defines `toString()` for the other case
	`812`	`+ this = TThrowCompletion(ec) and result = "throw(" + ec + ")"`
	`813`	`+ }`
`797`	`814`	`}`
`798`	`815`
`799`	`816`	`/**`
`@@ -811,5 +828,8 @@ class ExitCompletion extends Completion {`
`811`	`828`	`this = TNestedCompletion(_, TExitCompletion())`
`812`	`829`	`}`
`813`	`830`
`814`		`- override string toString() { this = TExitCompletion() and result = "exit" }`
	`831`	`+ override string toString() {`
	`832`	+ // `NestedCompletion` defines `toString()` for the other case
	`833`	`+ this = TExitCompletion() and result = "exit"`
	`834`	`+ }`
`815`	`835`	`}`