C#: Re-factor printing of summary component stacks.

Author: michaelnebel

csharp/ql/lib/semmle/code/csharp/dataflow/FlowSummary.qll

@@ -110,8 +110,12 @@ module SummaryComponentStack {
     result = singleton(SummaryComponent::syntheticGlobal(synthetic))
   }
 
-  /** Gets a textual representation of this stack used for flow summaries. */
-  string getComponentStack(SummaryComponentStack s) { result = Impl::Public::getComponentStack(s) }
+  /**
+   * DEPRECATED: Use the member predicate `getAccessPath` instead.
+   *
+   * Gets a textual representation of this stack used for flow summaries.
+   */
+  deprecated string getComponentStack(SummaryComponentStack s) { result = s.getAccessPath() }
 }
 
 class SummarizedCallable = Impl::Public::SummarizedCallable;

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

@@ -23,29 +23,30 @@ module Public {
    * content type, or a return kind.
    */
   class SummaryComponent extends TSummaryComponent {
-    /** Gets a textual representation of this summary component. */
-    string toString() {
-      exists(ContentSet c | this = TContentSummaryComponent(c) and result = c.toString())
-      or
-      exists(ContentSet c | this = TWithoutContentSummaryComponent(c) and result = "without " + c)
-      or
-      exists(ContentSet c | this = TWithContentSummaryComponent(c) and result = "with " + c)
+    /** Gets a textual representation of this component used for flow summaries. */
+    string getAccessStep() {
+      result = getAccessStepSpecific(this)
       or
       exists(ArgumentPosition pos |
-        this = TParameterSummaryComponent(pos) and result = "parameter " + pos
+        this = TParameterSummaryComponent(pos) and
+        result = "Parameter[" + getArgumentPosition(pos) + "]"
       )
       or
       exists(ParameterPosition pos |
-        this = TArgumentSummaryComponent(pos) and result = "argument " + pos
+        this = TArgumentSummaryComponent(pos) and
+        result = "Argument[" + getParameterPosition(pos) + "]"
       )
       or
-      exists(ReturnKind rk | this = TReturnSummaryComponent(rk) and result = "return (" + rk + ")")
-      or
-      exists(SummaryComponent::SyntheticGlobal sg |
-        this = TSyntheticGlobalSummaryComponent(sg) and
-        result = "synthetic global (" + sg + ")"
+      exists(string synthetic |
+        this = TSyntheticGlobalSummaryComponent(synthetic) and
+        result = "SyntheticGlobal[" + synthetic + "]"
       )
+      or
+      this = TReturnSummaryComponent(getReturnValueKind()) and result = "ReturnValue"
     }
+
+    /** Gets a textual representation of this summary component. */
+    string toString() { result = this.getAccessStep() }
   }
 
   /** Provides predicates for constructing summary components. */
@@ -125,19 +126,22 @@ module Public {
       this = TSingletonSummaryComponentStack(result) or result = this.tail().bottom()
     }
 
-    /** Gets a textual representation of this stack. */
-    string toString() {
+    /** Gets a textual representation of this stack used for MaD models. */
+    string getAccessPath() {
       exists(SummaryComponent head, SummaryComponentStack tail |
         head = this.head() and
         tail = this.tail() and
-        result = tail + "." + head
+        result = tail.getAccessPath() + "." + head.getAccessStep()
       )
       or
       exists(SummaryComponent c |
         this = TSingletonSummaryComponentStack(c) and
-        result = c.toString()
+        result = c.getAccessStep()
       )
     }
+
+    /** Gets a textual representation of this stack. */
+    string toString() { result = this.getAccessPath() }
   }
 
   /** Provides predicates for constructing stacks of summary components. */
@@ -166,42 +170,6 @@ module Public {
     SummaryComponentStack return(ReturnKind rk) { result = singleton(SummaryComponent::return(rk)) }
   }
 
-  /** Gets a textual representation of this component used for flow summaries. */
-  private string getComponent(SummaryComponent sc) {
-    result = getComponentSpecific(sc)
-    or
-    exists(ArgumentPosition pos |
-      sc = TParameterSummaryComponent(pos) and
-      result = "Parameter[" + getArgumentPosition(pos) + "]"
-    )
-    or
-    exists(ParameterPosition pos |
-      sc = TArgumentSummaryComponent(pos) and
-      result = "Argument[" + getParameterPosition(pos) + "]"
-    )
-    or
-    exists(string synthetic |
-      sc = TSyntheticGlobalSummaryComponent(synthetic) and
-      result = "SyntheticGlobal[" + synthetic + "]"
-    )
-    or
-    sc = TReturnSummaryComponent(getReturnValueKind()) and result = "ReturnValue"
-  }
-
-  /** Gets a textual representation of this stack used for flow summaries. */
-  string getComponentStack(SummaryComponentStack stack) {
-    exists(SummaryComponent head, SummaryComponentStack tail |
-      head = stack.head() and
-      tail = stack.tail() and
-      result = getComponentStack(tail) + "." + getComponent(head)
-    )
-    or
-    exists(SummaryComponent c |
-      stack = TSingletonSummaryComponentStack(c) and
-      result = getComponent(c)
-    )
-  }
-
   /**
    * A class that exists for QL technical reasons only (the IPA type used
    * to represent component stacks needs to be bounded).
@@ -1382,8 +1350,8 @@ module Private {
         c.relevantSummary(input, output, preservesValue) and
         csv =
           c.getCallableCsv() // Callable information
-            + getComponentStack(input) + ";" // input
-            + getComponentStack(output) + ";" // output
+            + input.getAccessPath() + ";" // input
+            + output.getAccessPath() + ";" // output
             + renderKind(preservesValue) + ";" // kind
             + renderProvenance(c) // provenance
       )

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

@@ -198,7 +198,7 @@ private string getContentSpecific(Content c) {
 }
 
 /** Gets the textual representation of a summary component in the format used for flow summaries. */
-string getComponentSpecific(SummaryComponent sc) {
+string getAccessStepSpecific(SummaryComponent sc) {
   exists(Content c | sc = TContentSummaryComponent(c) and result = getContentSpecific(c))
   or
   sc = TWithoutContentSummaryComponent(_) and result = "WithoutElement"

csharp/ql/lib/semmle/code/csharp/frameworks/EntityFramework.qll

@@ -410,7 +410,7 @@ module EntityFramework {
     ) {
       this = dbSet.getDbContextClass() and
       this.output(output, mapped, dbSet) and
-      result = dbSet.getFullName() + "#" + SummaryComponentStack::getComponentStack(output)
+      result = dbSet.getFullName() + "#" + output.getAccessPath()
     }
   }