Merge pull request #17070 from aschackmull/dataflow/pptype-refactor

Dataflow: Replace `ppReprType` with `DataFlowType.toString`.

Author: aschackmull

cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowPrivate.qll

@@ -215,19 +215,16 @@ predicate typeStrongerThan(DataFlowType t1, DataFlowType t2) { none() }
 predicate localMustFlowStep(Node node1, Node node2) { none() }
 
 /** Gets the type of `n` used for type pruning. */
-Type getNodeType(Node n) {
+DataFlowType getNodeType(Node n) {
   exists(n) and
   result instanceof VoidType // stub implementation
 }
 
-/** Gets a string representation of a type returned by `getNodeType`. */
-string ppReprType(Type t) { none() } // stub implementation
-
 /**
  * Holds if `t1` and `t2` are compatible, that is, whether data can flow from
  * a node of type `t1` to a node of type `t2`.
  */
-predicate compatibleTypes(Type t1, Type t2) {
+predicate compatibleTypes(DataFlowType t1, DataFlowType t2) {
   t1 instanceof VoidType and t2 instanceof VoidType // stub implementation
 }
 
@@ -243,7 +240,11 @@ class DataFlowCallable extends Function { }
 
 class DataFlowExpr = Expr;
 
-class DataFlowType = Type;
+final private class TypeFinal = Type;
+
+class DataFlowType extends TypeFinal {
+  string toString() { result = "" }
+}
 
 /** A function call relevant for data flow. */
 class DataFlowCall extends Expr instanceof Call {

cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowPrivate.qll

@@ -994,9 +994,6 @@ DataFlowType getNodeType(Node n) {
   result instanceof VoidType // stub implementation
 }
 
-/** Gets a string representation of a type returned by `getNodeType`. */
-string ppReprType(DataFlowType t) { none() } // stub implementation
-
 /**
  * Holds if `t1` and `t2` are compatible, that is, whether data can flow from
  * a node of type `t1` to a node of type `t2`.
@@ -1097,7 +1094,11 @@ class SummarizedCallable extends DataFlowCallable, TSummarizedCallable {
 
 class DataFlowExpr = Expr;
 
-class DataFlowType = Type;
+final private class TypeFinal = Type;
+
+class DataFlowType extends TypeFinal {
+  string toString() { result = "" }
+}
 
 cached
 private newtype TDataFlowCall =

csharp/ql/lib/semmle/code/csharp/dataflow/internal/DataFlowPrivate.qll

@@ -2444,9 +2444,6 @@ DataFlowType getNodeType(Node n) {
   ] = result.getADelegateCreation()
 }
 
-/** Gets a string representation of a `DataFlowType`. */
-string ppReprType(DataFlowType t) { result = t.toString() }
-
 private class DataFlowNullType extends Gvn::GvnType {
   DataFlowNullType() { this = Gvn::getGlobalValueNumber(any(NullType nt)) }
 

docs/ql-libraries/dataflow/dataflow.md

@@ -548,12 +548,9 @@ DataFlowType getNodeType(Node n)
 ```
 and every `Node` should have a type.
 
-One also needs to define the string representation of a `DataFlowType`:
-```ql
-string ppReprType(DataFlowType t)
-```
-The `ppReprType` predicate is used for printing a type in the labels of
-`PathNode`s, this can be defined as `none()` if type pruning is not used.
+One also needs to define the string representation of a `DataFlowType`.
+The `DataFlowType.toString` predicate is used for printing a type in the labels of
+`PathNode`s, this should be defined as `result = ""` if type pruning is not used.
 
 Finally, one must define `CastNode` as a subclass of `Node` as those nodes
 where types should be checked. Usually this will be things like explicit casts.

go/ql/lib/semmle/go/dataflow/internal/DataFlowPrivate.qll

@@ -215,9 +215,6 @@ predicate localMustFlowStep(Node node1, Node node2) { none() }
 /** Gets the type of `n` used for type pruning. */
 DataFlowType getNodeType(Node n) { result = TTodoDataFlowType() and exists(n) }
 
-/** Gets a string representation of a type returned by `getNodeType()`. */
-string ppReprType(DataFlowType t) { none() }
-
 /**
  * Holds if `t1` and `t2` are compatible, that is, whether data can flow from
  * a node of type `t1` to a node of type `t2`.

java/ql/lib/semmle/code/java/dataflow/internal/DataFlowPrivate.qll

@@ -356,8 +356,12 @@ RefType getErasedRepr(Type t) {
   t instanceof NullType and result instanceof TypeObject
 }
 
-class DataFlowType extends SrcRefType {
+final private class SrcRefTypeFinal = SrcRefType;
+
+class DataFlowType extends SrcRefTypeFinal {
   DataFlowType() { this = getErasedRepr(_) }
+
+  string toString() { result = ppReprType(this) }
 }
 
 pragma[nomagic]
@@ -371,7 +375,7 @@ DataFlowType getNodeType(Node n) {
 }
 
 /** Gets a string representation of a type returned by `getErasedRepr`. */
-string ppReprType(DataFlowType t) {
+private string ppReprType(SrcRefType t) {
   if t.(BoxedType).getPrimitiveType().getName() = "double"
   then result = "Number"
   else result = t.toString()

python/ql/lib/semmle/python/dataflow/new/internal/DataFlowPrivate.qll

@@ -534,7 +534,7 @@ newtype TDataFlowType = TAnyFlow()
 
 class DataFlowType extends TDataFlowType {
   /** Gets a textual representation of this element. */
-  string toString() { result = "DataFlowType" }
+  string toString() { result = "" }
 }
 
 /** A node that performs a type cast. */
@@ -578,9 +578,6 @@ DataFlowType getNodeType(Node node) {
   exists(node)
 }
 
-/** Gets a string representation of a type returned by `getErasedRepr`. */
-string ppReprType(DataFlowType t) { none() }
-
 //--------
 // Extra flow
 //--------

ruby/ql/lib/codeql/ruby/dataflow/internal/DataFlowPrivate.qll

@@ -2077,9 +2077,6 @@ DataFlowType getNodeType(Node n) {
   result = TUnknownDataFlowType()
 }
 
-/** Gets a string representation of a `DataFlowType`. */
-string ppReprType(DataFlowType t) { none() }
-
 pragma[inline]
 private predicate compatibleTypesNonSymRefl(DataFlowType t1, DataFlowType t2) {
   t1 != TUnknownDataFlowType() and

shared/dataflow/codeql/dataflow/DataFlow.qll

@@ -124,8 +124,6 @@ signature module InputSig<LocationSig Location> {
     string toString();
   }
 
-  string ppReprType(DataFlowType t);
-
   /**
    * Holds if `t1` and `t2` are compatible types.
    *

shared/dataflow/codeql/dataflow/internal/DataFlowImpl.qll

@@ -3445,9 +3445,11 @@ module MakeImpl<LocationSig Location, InputSig<Location> Lang> {
 
       AccessPathApproxConsNil() { this = TConsNil(c, t) }
 
+      private string ppTyp() { result = t.toString() and result != "" }
+
       override string toString() {
-        // The `concat` becomes "" if `ppReprType` has no result.
-        result = "[" + c.toString() + "]" + concat(" : " + ppReprType(t))
+        // The `concat` becomes "" if `ppTyp` has no result.
+        result = "[" + c.toString() + "]" + concat(" : " + this.ppTyp())
       }
 
       override Content getHead() { result = c }
@@ -3668,7 +3670,9 @@ module MakeImpl<LocationSig Location, InputSig<Location> Lang> {
 
       ParamNodeEx getParamNode() { result = p }
 
-      override string toString() { result = p + concat(" : " + ppReprType(t)) + " " + ap }
+      private string ppTyp() { result = t.toString() and result != "" }
+
+      override string toString() { result = p + concat(" : " + this.ppTyp()) + " " + ap }
 
       Location getLocation() { result = p.getLocation() }
     }
@@ -3935,10 +3939,12 @@ module MakeImpl<LocationSig Location, InputSig<Location> Lang> {
 
       override int length() { result = 1 + tail_.length() }
 
+      private string ppTyp() { result = t.toString() and result != "" }
+
       private string toStringImpl(boolean needsSuffix) {
         tail_ = TAccessPathNil() and
         needsSuffix = false and
-        result = head_.toString() + "]" + concat(" : " + ppReprType(t))
+        result = head_.toString() + "]" + concat(" : " + this.ppTyp())
         or
         result = head_ + ", " + tail_.(AccessPathCons).toStringImpl(needsSuffix)
         or
@@ -4087,9 +4093,8 @@ module MakeImpl<LocationSig Location, InputSig<Location> Lang> {
       private string ppType() {
         this instanceof PathNodeSink and result = ""
         or
-        exists(DataFlowType t | t = this.(PathNodeMid).getType() |
-          // The `concat` becomes "" if `ppReprType` has no result.
-          result = concat(" : " + ppReprType(t))
+        exists(string t | t = this.(PathNodeMid).getType().toString() |
+          if t = "" then result = "" else result = " : " + t
         )
       }
 
@@ -5402,9 +5407,8 @@ module MakeImpl<LocationSig Location, InputSig<Location> Lang> {
           private string ppType() {
             this instanceof PartialPathNodeRev and result = ""
             or
-            exists(DataFlowType t | t = this.(PartialPathNodeFwd).getType() |
-              // The `concat` becomes "" if `ppReprType` has no result.
-              result = concat(" : " + ppReprType(t))
+            exists(string t | t = this.(PartialPathNodeFwd).getType().toString() |
+              if t = "" then result = "" else result = " : " + t
             )
           }