C++: Comments.

geoffw0 · geoffw0 · commit e8d0f1fa3e84 · 2024-03-08T18:25:01.000Z
diff --git a/cpp/ql/lib/semmle/code/cpp/dataflow/internal/FlowSummaryImpl.qll b/cpp/ql/lib/semmle/code/cpp/dataflow/internal/FlowSummaryImpl.qll
@@ -119,6 +119,7 @@ module SourceSinkInterpretationInput implements
     DataFlowCall asCall() {
       this.asElement() = result.asCallInstruction().getUnconvertedResultExpression()
       // TODO: or summary call?
+      // ??? this.asNode().(FlowSummaryNode).getSummaryNode() = result.(SummaryCall).getReceiver()
     }
 
     /** Gets the callable that this node corresponds to, if any. */
diff --git a/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowPrivate.qll b/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowPrivate.qll
@@ -1161,7 +1161,12 @@ class SummaryCall extends DataFlowCall, TSummaryCall {
 
   SummaryCall() { this = TSummaryCall(c, receiver) }
 
-  /** Gets the data flow node that this call targets. */
+  /**
+   * Gets the data flow node that this call targets.
+   * OR
+   * Gets the data flow node that receives the result of the call.
+   * TODO: which is right?
+   */
   FlowSummaryImpl::Private::SummaryNode getReceiver() { result = receiver }
 
   //  override CallTargetOperand getCallTargetOperand() TODO
diff --git a/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowUtil.qll b/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowUtil.qll
@@ -757,7 +757,7 @@ class FlowSummaryNode extends Node, TFlowSummaryNode {
    * TODO: QLDoc.
    */
   override DataFlowCallable getEnclosingCallable() {
-    result = TSummarizedCallable(this.getSummarizedCallable())
+    result = TSummarizedCallable(this.getSummarizedCallable()) // TODO: this doesn't look right.
   }
 
   override Location getLocationImpl() { result = this.getSummarizedCallable().getLocation() }

Original file line number	Diff line number	Diff line change
`@@ -119,6 +119,7 @@ module SourceSinkInterpretationInput implements`
`119`	`119`	`DataFlowCall asCall() {`
`120`	`120`	`this.asElement() = result.asCallInstruction().getUnconvertedResultExpression()`
`121`	`121`	`// TODO: or summary call?`
	`122`	`+ // ??? this.asNode().(FlowSummaryNode).getSummaryNode() = result.(SummaryCall).getReceiver()`
`122`	`123`	`}`
`123`	`124`
`124`	`125`	`/** Gets the callable that this node corresponds to, if any. */`
Original file line number	Diff line number	Diff line change
`@@ -757,7 +757,7 @@ class FlowSummaryNode extends Node, TFlowSummaryNode {`
`757`	`757`	`* TODO: QLDoc.`
`758`	`758`	`*/`
`759`	`759`	`override DataFlowCallable getEnclosingCallable() {`
`760`		`- result = TSummarizedCallable(this.getSummarizedCallable())`
	`760`	`+ result = TSummarizedCallable(this.getSummarizedCallable()) // TODO: this doesn't look right.`
`761`	`761`	`}`
`762`	`762`
`763`	`763`	`override Location getLocationImpl() { result = this.getSummarizedCallable().getLocation() }`