C#/Java: Rename to Typed based summary model generation.

michaelnebel · michaelnebel · commit c5949fad75f2 · 2022-09-14T11:06:23.000+02:00
diff --git a/csharp/ql/src/utils/model-generator/CaptureTypeBasedSummaryModels.ql b/csharp/ql/src/utils/model-generator/CaptureTypeBasedSummaryModels.ql
@@ -1,14 +1,14 @@
 /**
- * @name Capture Theorems for Free summary models.
+ * @name Capture typed based summary models.
  * @description Finds applicable summary models to be used by other queries.
  * @kind diagnostic
- * @id cs/utils/model-generator/summary-models-theorems-for-free
+ * @id cs/utils/model-generator/summary-models-typed-based
  * @tags model-generator
  */
 
 import semmle.code.csharp.dataflow.ExternalFlow
-import internal.CaptureTheoremsForFreeSummaryModels
+import internal.CaptureTypeBasedSummaryModels
 
-from TheoremTargetApi api, string flow
+from TypeBasedFlowTargetApi api, string flow
 where flow = captureFlow(api)
 select flow order by flow
diff --git a/csharp/ql/src/utils/model-generator/internal/CaptureModels.qll b/csharp/ql/src/utils/model-generator/internal/CaptureModels.qll
@@ -6,7 +6,7 @@
 private import CaptureModelsSpecific
 
 class DataFlowTargetApi extends TargetApiSpecific {
-  DataFlowTargetApi() { isRelevantForFlowModels(this) }
+  DataFlowTargetApi() { isRelevantForDataFlowModels(this) }
 }
 
 /**
diff --git a/csharp/ql/src/utils/model-generator/internal/CaptureModelsSpecific.qll b/csharp/ql/src/utils/model-generator/internal/CaptureModelsSpecific.qll
@@ -42,14 +42,14 @@ private predicate isRelevantForModels(CS::Callable api) {
 /**
  * Holds if it is relevant to generate models for `api` based on data flow analysis.
  */
-predicate isRelevantForFlowModels(CS::Callable api) {
+predicate isRelevantForDataFlowModels(CS::Callable api) {
   isRelevantForModels(api) and not isHigherOrder(api)
 }
 
 /**
- * Holds if it is relevant to generate models for `api` based on Theorems for Free.
+ * Holds if it is relevant to generate models for `api` based on its type.
  */
-predicate isRelevantForTheoremModels = isRelevantForModels/1;
+predicate isRelevantForTypeBasedFlowModels = isRelevantForModels/1;
 
 /**
  * A class of callables that are relevant generating summary, source and sinks models for.
diff --git a/csharp/ql/src/utils/model-generator/internal/CaptureTypeBasedSummaryModels.qll b/csharp/ql/src/utils/model-generator/internal/CaptureTypeBasedSummaryModels.qll
@@ -84,7 +84,7 @@ private string implicit(DotNet::Callable callable, TypeParameter tp) {
 }
 
 /**
- * Holds if `callable` has a delegate type parameter `tp` at parameter position `position`.
+ * Holds if `callable` has a delegate parameter `dt` at parameter position `position`.
  */
 private predicate delegate(DotNet::Callable callable, DelegateType dt, int position) {
   exists(Parameter p |
@@ -192,8 +192,8 @@ private predicate output(DotNet::Callable callable, TypeParameter tp, string out
  * A class of callables that are relevant generating summaries for based
  * on the Theorems for Free approach.
  */
-class TheoremTargetApi extends Specific::TargetApiSpecific {
-  TheoremTargetApi() { Specific::isRelevantForTheoremModels(this) }
+class TypeBasedFlowTargetApi extends Specific::TargetApiSpecific {
+  TypeBasedFlowTargetApi() { Specific::isRelevantForTypeBasedFlowModels(this) }
 
   /**
    * Gets the string representation of all type based summaries inspired by
@@ -228,4 +228,4 @@ class TheoremTargetApi extends Specific::TargetApiSpecific {
 /**
  * Returns the Theorems for Free inspired typed based summaries for `api`.
  */
-string captureFlow(TheoremTargetApi api) { result = api.getSummaries() }
+string captureFlow(TypeBasedFlowTargetApi api) { result = api.getSummaries() }
diff --git a/csharp/ql/test/utils/model-generator/theorems/CaptureTheoremsForFreeSummaryModels.qlref b/csharp/ql/test/utils/model-generator/theorems/CaptureTheoremsForFreeSummaryModels.qlref
diff --git a/csharp/ql/test/utils/model-generator/typebasedflow/CaptureTypeBasedSummaryModels.expected b/csharp/ql/test/utils/model-generator/typebasedflow/CaptureTypeBasedSummaryModels.expected
diff --git a/csharp/ql/test/utils/model-generator/typebasedflow/CaptureTypeBasedSummaryModels.qlref b/csharp/ql/test/utils/model-generator/typebasedflow/CaptureTypeBasedSummaryModels.qlref
@@ -0,0 +1 @@
+utils/model-generator/CaptureTypeBasedSummaryModels.ql
diff --git a/csharp/ql/test/utils/model-generator/typebasedflow/TypeBasedSummaries.cs b/csharp/ql/test/utils/model-generator/typebasedflow/TypeBasedSummaries.cs
diff --git a/java/ql/src/utils/model-generator/internal/CaptureModels.qll b/java/ql/src/utils/model-generator/internal/CaptureModels.qll
@@ -6,7 +6,7 @@
 private import CaptureModelsSpecific
 
 class DataFlowTargetApi extends TargetApiSpecific {
-  DataFlowTargetApi() { isRelevantForFlowModels(this) }
+  DataFlowTargetApi() { isRelevantForDataFlowModels(this) }
 }
 
 /**
diff --git a/java/ql/src/utils/model-generator/internal/CaptureModelsSpecific.qll b/java/ql/src/utils/model-generator/internal/CaptureModelsSpecific.qll
@@ -62,7 +62,7 @@ private predicate isRelevantForModels(J::Callable api) {
 /**
  * Holds if it is relevant to generate models for `api` based on data flow analysis.
  */
-predicate isRelevantForFlowModels = isRelevantForModels/1;
+predicate isRelevantForDataFlowModels = isRelevantForModels/1;
 
 /**
  * A class of Callables that are relevant for generating summary, source and sinks models for.

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`private import CaptureModelsSpecific`
`7`	`7`
`8`	`8`	`class DataFlowTargetApi extends TargetApiSpecific {`
`9`		`- DataFlowTargetApi() { isRelevantForFlowModels(this) }`
	`9`	`+ DataFlowTargetApi() { isRelevantForDataFlowModels(this) }`
`10`	`10`	`}`
`11`	`11`
`12`	`12`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+utils/model-generator/CaptureTypeBasedSummaryModels.ql`