Control flow: add order disambuigation customization

redsun82 · redsun82 · commit 9b26921cb67a · 2022-07-28T09:11:42.000+02:00
diff --git a/csharp/ql/lib/semmle/code/csharp/controlflow/internal/ControlFlowGraphImplShared.qll b/csharp/ql/lib/semmle/code/csharp/controlflow/internal/ControlFlowGraphImplShared.qll
@@ -881,7 +881,12 @@ import Cached
  * graph is restricted to nodes from `RelevantNode`.
  */
 module TestOutput {
-  abstract class RelevantNode extends Node { }
+  abstract class RelevantNode extends Node {
+    /**
+     * Gets a string used to resolve ties in node and edge ordering.
+     */
+    string getOrderDisambuigation() { result = "" }
+  }
 
   query predicate nodes(RelevantNode n, string attr, string val) {
     attr = "semmle.order" and
@@ -894,7 +899,8 @@ module TestOutput {
             p
             order by
               l.getFile().getBaseName(), l.getFile().getAbsolutePath(), l.getStartLine(),
-              l.getStartColumn(), l.getEndLine(), l.getEndColumn(), p.toString()
+              l.getStartColumn(), l.getEndLine(), l.getEndColumn(), p.toString(),
+              p.getOrderDisambuigation()
           )
       ).toString()
   }
@@ -916,7 +922,8 @@ module TestOutput {
             s
             order by
               l.getFile().getBaseName(), l.getFile().getAbsolutePath(), l.getStartLine(),
-              l.getStartColumn(), l.getEndLine(), l.getEndColumn(), t.toString(), s.toString()
+              l.getStartColumn(), l.getEndLine(), l.getEndColumn(), t.toString(), s.toString(),
+              s.getOrderDisambuigation()
           )
       ).toString()
   }
diff --git a/ruby/ql/lib/codeql/ruby/controlflow/internal/ControlFlowGraphImplShared.qll b/ruby/ql/lib/codeql/ruby/controlflow/internal/ControlFlowGraphImplShared.qll
@@ -881,7 +881,12 @@ import Cached
  * graph is restricted to nodes from `RelevantNode`.
  */
 module TestOutput {
-  abstract class RelevantNode extends Node { }
+  abstract class RelevantNode extends Node {
+    /**
+     * Gets a string used to resolve ties in node and edge ordering.
+     */
+    string getOrderDisambuigation() { result = "" }
+  }
 
   query predicate nodes(RelevantNode n, string attr, string val) {
     attr = "semmle.order" and
@@ -894,7 +899,8 @@ module TestOutput {
             p
             order by
               l.getFile().getBaseName(), l.getFile().getAbsolutePath(), l.getStartLine(),
-              l.getStartColumn(), l.getEndLine(), l.getEndColumn(), p.toString()
+              l.getStartColumn(), l.getEndLine(), l.getEndColumn(), p.toString(),
+              p.getOrderDisambuigation()
           )
       ).toString()
   }
@@ -916,7 +922,8 @@ module TestOutput {
             s
             order by
               l.getFile().getBaseName(), l.getFile().getAbsolutePath(), l.getStartLine(),
-              l.getStartColumn(), l.getEndLine(), l.getEndColumn(), t.toString(), s.toString()
+              l.getStartColumn(), l.getEndLine(), l.getEndColumn(), t.toString(), s.toString(),
+              s.getOrderDisambuigation()
           )
       ).toString()
   }
diff --git a/swift/ql/lib/codeql/swift/controlflow/internal/ControlFlowGraphImplShared.qll b/swift/ql/lib/codeql/swift/controlflow/internal/ControlFlowGraphImplShared.qll
@@ -881,7 +881,12 @@ import Cached
  * graph is restricted to nodes from `RelevantNode`.
  */
 module TestOutput {
-  abstract class RelevantNode extends Node { }
+  abstract class RelevantNode extends Node {
+    /**
+     * Gets a string used to resolve ties in node and edge ordering.
+     */
+    string getOrderDisambuigation() { result = "" }
+  }
 
   query predicate nodes(RelevantNode n, string attr, string val) {
     attr = "semmle.order" and
@@ -894,7 +899,8 @@ module TestOutput {
             p
             order by
               l.getFile().getBaseName(), l.getFile().getAbsolutePath(), l.getStartLine(),
-              l.getStartColumn(), l.getEndLine(), l.getEndColumn(), p.toString()
+              l.getStartColumn(), l.getEndLine(), l.getEndColumn(), p.toString(),
+              p.getOrderDisambuigation()
           )
       ).toString()
   }
@@ -916,7 +922,8 @@ module TestOutput {
             s
             order by
               l.getFile().getBaseName(), l.getFile().getAbsolutePath(), l.getStartLine(),
-              l.getStartColumn(), l.getEndLine(), l.getEndColumn(), t.toString(), s.toString()
+              l.getStartColumn(), l.getEndLine(), l.getEndColumn(), t.toString(), s.toString(),
+              s.getOrderDisambuigation()
           )
       ).toString()
   }

Original file line number	Diff line number	Diff line change
`@@ -881,7 +881,12 @@ import Cached`
`881`	`881`	* graph is restricted to nodes from `RelevantNode`.
`882`	`882`	`*/`
`883`	`883`	`module TestOutput {`
`884`		`- abstract class RelevantNode extends Node { }`
	`884`	`+ abstract class RelevantNode extends Node {`
	`885`	`+ /**`
	`886`	`+ * Gets a string used to resolve ties in node and edge ordering.`
	`887`	`+ */`
	`888`	`+ string getOrderDisambuigation() { result = "" }`
	`889`	`+ }`
`885`	`890`
`886`	`891`	`query predicate nodes(RelevantNode n, string attr, string val) {`
`887`	`892`	`attr = "semmle.order" and`
`@@ -894,7 +899,8 @@ module TestOutput {`
`894`	`899`	`p`
`895`	`900`	`order by`
`896`	`901`	`l.getFile().getBaseName(), l.getFile().getAbsolutePath(), l.getStartLine(),`
`897`		`- l.getStartColumn(), l.getEndLine(), l.getEndColumn(), p.toString()`
	`902`	`+ l.getStartColumn(), l.getEndLine(), l.getEndColumn(), p.toString(),`
	`903`	`+ p.getOrderDisambuigation()`
`898`	`904`	`)`
`899`	`905`	`).toString()`
`900`	`906`	`}`
`@@ -916,7 +922,8 @@ module TestOutput {`
`916`	`922`	`s`
`917`	`923`	`order by`
`918`	`924`	`l.getFile().getBaseName(), l.getFile().getAbsolutePath(), l.getStartLine(),`
`919`		`- l.getStartColumn(), l.getEndLine(), l.getEndColumn(), t.toString(), s.toString()`
	`925`	`+ l.getStartColumn(), l.getEndLine(), l.getEndColumn(), t.toString(), s.toString(),`
	`926`	`+ s.getOrderDisambuigation()`
`920`	`927`	`)`
`921`	`928`	`).toString()`
`922`	`929`	`}`