C++: Use the word "rank" to denote a rank

jbj · jbj · commit 2b94bb9edabc · 2019-08-26T16:13:08.000+02:00
Previously, the word "position" was used ambiguously in this library.
diff --git a/cpp/ql/src/semmle/code/cpp/controlflow/SubBasicBlocks.qll b/cpp/ql/src/semmle/code/cpp/controlflow/SubBasicBlocks.qll
@@ -57,7 +57,7 @@ class SubBasicBlock extends ControlFlowNodeBase {
    * predecessors.
    */
   predicate firstInBB() {
-    exists(BasicBlock bb | this.getPosInBasicBlock(bb) = 0)
+    exists(BasicBlock bb | this.getRankInBasicBlock(bb) = 1)
   }
 
   /**
@@ -66,19 +66,18 @@ class SubBasicBlock extends ControlFlowNodeBase {
    */
   predicate lastInBB() {
     exists(BasicBlock bb |
-      this.getPosInBasicBlock(bb) = countSubBasicBlocksInBasicBlock(bb) - 1
+      this.getRankInBasicBlock(bb) = countSubBasicBlocksInBasicBlock(bb)
     )
   }
 
   /**
-   * Gets the position of this `SubBasicBlock` in its containing basic block
-   * `bb`, where `bb` is equal to `getBasicBlock()`.
+   * Gets the rank of this `SubBasicBlock` among the other `SubBasicBlock`s in
+   * its containing basic block `bb`, where `bb` is equal to `getBasicBlock()`.
    */
-  int getPosInBasicBlock(BasicBlock bb) {
-    exists(int thisIndexInBB, int rnk |
+  int getRankInBasicBlock(BasicBlock bb) {
+    exists(int thisIndexInBB |
       thisIndexInBB = this.getIndexInBasicBlock(bb) and
-      thisIndexInBB = rank[rnk](int i | i = any(SubBasicBlock n).getIndexInBasicBlock(bb)) and
-      result = rnk - 1
+      thisIndexInBB = rank[result](int i | i = any(SubBasicBlock n).getIndexInBasicBlock(bb))
     )
   }
 
@@ -93,7 +92,7 @@ class SubBasicBlock extends ControlFlowNodeBase {
     result = this.getBasicBlock().getASuccessor()
     or
     exists(BasicBlock bb |
-      result.getPosInBasicBlock(bb) = this.getPosInBasicBlock(bb) + 1
+      result.getRankInBasicBlock(bb) = this.getRankInBasicBlock(bb) + 1
     )
   }
 
@@ -168,9 +167,9 @@ class SubBasicBlock extends ControlFlowNodeBase {
         )
         or
         exists(SubBasicBlock succ, int succPos, int thisRank, int succRank |
-          thisRank = this.getPosInBasicBlock(bb) and
+          thisRank = this.getRankInBasicBlock(bb) and
           succRank = thisRank + 1 and
-          succRank = succ.getPosInBasicBlock(bb) and
+          succRank = succ.getRankInBasicBlock(bb) and
           bb.getNode(succPos) = succ and
           result = succPos - thisPos
         )
diff --git a/cpp/ql/src/semmle/code/cpp/dataflow/internal/SubBasicBlocks.qll b/cpp/ql/src/semmle/code/cpp/dataflow/internal/SubBasicBlocks.qll
@@ -57,7 +57,7 @@ class SubBasicBlock extends ControlFlowNodeBase {
    * predecessors.
    */
   predicate firstInBB() {
-    exists(BasicBlock bb | this.getPosInBasicBlock(bb) = 0)
+    exists(BasicBlock bb | this.getRankInBasicBlock(bb) = 1)
   }
 
   /**
@@ -66,19 +66,18 @@ class SubBasicBlock extends ControlFlowNodeBase {
    */
   predicate lastInBB() {
     exists(BasicBlock bb |
-      this.getPosInBasicBlock(bb) = countSubBasicBlocksInBasicBlock(bb) - 1
+      this.getRankInBasicBlock(bb) = countSubBasicBlocksInBasicBlock(bb)
     )
   }
 
   /**
-   * Gets the position of this `SubBasicBlock` in its containing basic block
-   * `bb`, where `bb` is equal to `getBasicBlock()`.
+   * Gets the rank of this `SubBasicBlock` among the other `SubBasicBlock`s in
+   * its containing basic block `bb`, where `bb` is equal to `getBasicBlock()`.
    */
-  int getPosInBasicBlock(BasicBlock bb) {
-    exists(int thisIndexInBB, int rnk |
+  int getRankInBasicBlock(BasicBlock bb) {
+    exists(int thisIndexInBB |
       thisIndexInBB = this.getIndexInBasicBlock(bb) and
-      thisIndexInBB = rank[rnk](int i | i = any(SubBasicBlock n).getIndexInBasicBlock(bb)) and
-      result = rnk - 1
+      thisIndexInBB = rank[result](int i | i = any(SubBasicBlock n).getIndexInBasicBlock(bb))
     )
   }
 
@@ -93,7 +92,7 @@ class SubBasicBlock extends ControlFlowNodeBase {
     result = this.getBasicBlock().getASuccessor()
     or
     exists(BasicBlock bb |
-      result.getPosInBasicBlock(bb) = this.getPosInBasicBlock(bb) + 1
+      result.getRankInBasicBlock(bb) = this.getRankInBasicBlock(bb) + 1
     )
   }
 
@@ -168,9 +167,9 @@ class SubBasicBlock extends ControlFlowNodeBase {
         )
         or
         exists(SubBasicBlock succ, int succPos, int thisRank, int succRank |
-          thisRank = this.getPosInBasicBlock(bb) and
+          thisRank = this.getRankInBasicBlock(bb) and
           succRank = thisRank + 1 and
-          succRank = succ.getPosInBasicBlock(bb) and
+          succRank = succ.getRankInBasicBlock(bb) and
           bb.getNode(succPos) = succ and
           result = succPos - thisPos
         )

Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ class SubBasicBlock extends ControlFlowNodeBase {`
`57`	`57`	`* predecessors.`
`58`	`58`	`*/`
`59`	`59`	`predicate firstInBB() {`
`60`		`- exists(BasicBlock bb \| this.getPosInBasicBlock(bb) = 0)`
	`60`	`+ exists(BasicBlock bb \| this.getRankInBasicBlock(bb) = 1)`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`/**`
`@@ -66,19 +66,18 @@ class SubBasicBlock extends ControlFlowNodeBase {`
`66`	`66`	`*/`
`67`	`67`	`predicate lastInBB() {`
`68`	`68`	`exists(BasicBlock bb \|`
`69`		`- this.getPosInBasicBlock(bb) = countSubBasicBlocksInBasicBlock(bb) - 1`
	`69`	`+ this.getRankInBasicBlock(bb) = countSubBasicBlocksInBasicBlock(bb)`
`70`	`70`	`)`
`71`	`71`	`}`
`72`	`72`
`73`	`73`	`/**`
`74`		- * Gets the position of this `SubBasicBlock` in its containing basic block
`75`		- * `bb`, where `bb` is equal to `getBasicBlock()`.
	`74`	+ * Gets the rank of this `SubBasicBlock` among the other `SubBasicBlock`s in
	`75`	+ * its containing basic block `bb`, where `bb` is equal to `getBasicBlock()`.
`76`	`76`	`*/`
`77`		`- int getPosInBasicBlock(BasicBlock bb) {`
`78`		`- exists(int thisIndexInBB, int rnk \|`
	`77`	`+ int getRankInBasicBlock(BasicBlock bb) {`
	`78`	`+ exists(int thisIndexInBB \|`
`79`	`79`	`thisIndexInBB = this.getIndexInBasicBlock(bb) and`
`80`		`- thisIndexInBB = rank[rnk](int i \| i = any(SubBasicBlock n).getIndexInBasicBlock(bb)) and`
`81`		`- result = rnk - 1`
	`80`	`+ thisIndexInBB = rank[result](int i \| i = any(SubBasicBlock n).getIndexInBasicBlock(bb))`
`82`	`81`	`)`
`83`	`82`	`}`
`84`	`83`
`@@ -93,7 +92,7 @@ class SubBasicBlock extends ControlFlowNodeBase {`
`93`	`92`	`result = this.getBasicBlock().getASuccessor()`
`94`	`93`	`or`
`95`	`94`	`exists(BasicBlock bb \|`
`96`		`- result.getPosInBasicBlock(bb) = this.getPosInBasicBlock(bb) + 1`
	`95`	`+ result.getRankInBasicBlock(bb) = this.getRankInBasicBlock(bb) + 1`
`97`	`96`	`)`
`98`	`97`	`}`
`99`	`98`
`@@ -168,9 +167,9 @@ class SubBasicBlock extends ControlFlowNodeBase {`
`168`	`167`	`)`
`169`	`168`	`or`
`170`	`169`	`exists(SubBasicBlock succ, int succPos, int thisRank, int succRank \|`
`171`		`- thisRank = this.getPosInBasicBlock(bb) and`
	`170`	`+ thisRank = this.getRankInBasicBlock(bb) and`
`172`	`171`	`succRank = thisRank + 1 and`
`173`		`- succRank = succ.getPosInBasicBlock(bb) and`
	`172`	`+ succRank = succ.getRankInBasicBlock(bb) and`
`174`	`173`	`bb.getNode(succPos) = succ and`
`175`	`174`	`result = succPos - thisPos`
`176`	`175`	`)`