[EXPERIMENTAL]: Always populate cached entities when extracting in overlay mode.

Author: michaelnebel

csharp/extractor/Semmle.Extraction.CSharp/Entities/Attribute.cs

@@ -59,15 +59,15 @@ public override void Populate(TextWriter trapFile)
         {
             // In this case, we don't extract the attribute again, as it was extracted using * ID
             // originally and we re-use that.
-            if (Context.OnlyScaffold && (ReportingLocation is null || !ReportingLocation.IsInSource))
+            if (OnlyScaffold && (ReportingLocation is null || !ReportingLocation.IsInSource))
             {
                 return;
             }
 
             var type = Type.Create(Context, Symbol.AttributeClass);
             trapFile.attributes(this, kind, type.TypeRef, entity);
 
-            if (Context.OnlyScaffold)
+            if (OnlyScaffold)
             {
                 return;
             }

csharp/extractor/Semmle.Extraction.CSharp/Entities/Base/CachedEntity.cs

@@ -25,6 +25,8 @@ protected CachedEntity(Context context) : base(context)
         public abstract void Populate(TextWriter trapFile);
 
         public abstract bool NeedsPopulation { get; }
+
+        public abstract bool OnlyScaffold { get; }
     }
 
     /// <summary>
@@ -70,8 +72,6 @@ protected static void WriteLocationsToTrap<T1>(Action<T1, Location> writeAction,
             }
         }
 
-        public override bool NeedsPopulation { get; }
-
         public override int GetHashCode() => Symbol is null ? 0 : Symbol.GetHashCode();
 
         public override bool Equals(object? obj)
@@ -81,6 +81,8 @@ public override bool Equals(object? obj)
         }
 
         public override TrapStackBehaviour TrapStackBehaviour => TrapStackBehaviour.NoLabel;
+
+        public override bool OnlyScaffold => Context.OnlyScaffold;
     }
 
     /// <summary>

csharp/extractor/Semmle.Extraction.CSharp/Entities/Base/CachedSymbol.cs

@@ -140,9 +140,9 @@ public ExpressionSyntax? ExpressionBody
 
         public virtual bool IsSourceDeclaration => Symbol.IsSourceDeclaration();
 
-        // When scaffolding we always need to populate to ensure that
+        // When extracting in overlay mode we always need to populate to ensure that
         // all transitive dependencies are extracted.
-        public override bool NeedsPopulation => Context.Defines(Symbol) || Context.OnlyScaffold;
+        //public override bool NeedsPopulation => Context.Defines(Symbol) || Context.IsOverlayMode;
 
         public Location Location => Context.CreateLocation(ReportingLocation);
     }

csharp/extractor/Semmle.Extraction.CSharp/Entities/CommentBlock.cs

@@ -10,7 +10,7 @@ private CommentBlock(Context cx, Comments.CommentBlock init)
 
         public override void Populate(TextWriter trapFile)
         {
-            if (Context.OnlyScaffold)
+            if (OnlyScaffold)
             {
                 return;
             }
@@ -31,7 +31,7 @@ public override void WriteId(EscapingTextWriter trapFile)
 
         public void BindTo(Label entity, CommentBinding binding)
         {
-            if (Context.OnlyScaffold)
+            if (OnlyScaffold)
             {
                 return;
             }

csharp/extractor/Semmle.Extraction.CSharp/Entities/CommentLine.cs

@@ -21,7 +21,7 @@ private CommentLine(Context cx, Microsoft.CodeAnalysis.Location loc, CommentLine
 
         public override void Populate(TextWriter trapFile)
         {
-            if (Context.OnlyScaffold)
+            if (OnlyScaffold)
             {
                 return;
             }

csharp/extractor/Semmle.Extraction.CSharp/Entities/Constructor.cs

@@ -37,7 +37,7 @@ public override void Populate(TextWriter trapFile)
             }
             ExtractCompilerGenerated(trapFile);
 
-            if (Context.OnlyScaffold)
+            if (OnlyScaffold)
             {
                 return;
             }
@@ -60,7 +60,7 @@ protected override void ExtractInitializers(TextWriter trapFile)
             // Do not extract initializers for constructed types.
             // Extract initializers for constructors with a body, primary constructors
             // and default constructors for classes and structs declared in source code.
-            if (Block is null && ExpressionBody is null && !MakeSynthetic || Context.OnlyScaffold)
+            if (Block is null && ExpressionBody is null && !MakeSynthetic || OnlyScaffold)
             {
                 return;
             }
@@ -187,7 +187,7 @@ Symbol.ContainingType.TypeKind is TypeKind.Class or TypeKind.Struct &&
         /// </summary>
         private bool IsBestSourceLocation => ReportingLocation is not null && Context.IsLocationInContext(ReportingLocation);
 
-        private bool MakeSynthetic => (IsPrimary || (IsDefault && IsBestSourceLocation)) && !Context.OnlyScaffold;
+        private bool MakeSynthetic => (IsPrimary || (IsDefault && IsBestSourceLocation)) && !OnlyScaffold;
 
         [return: NotNullIfNotNull(nameof(constructor))]
         public static new Constructor? Create(Context cx, IMethodSymbol? constructor)

csharp/extractor/Semmle.Extraction.CSharp/Entities/Event.cs

@@ -20,6 +20,10 @@ public override void WriteId(EscapingTextWriter trapFile)
             trapFile.Write(";event");
         }
 
+        public override bool NeedsPopulation => Context.Defines(Symbol) || Context.IsOverlayMode;
+
+        public override bool OnlyScaffold => base.OnlyScaffold || !Context.Defines(Symbol);
+
         public override void Populate(TextWriter trapFile)
         {
             PopulateNullability(trapFile, Symbol.GetAnnotatedType());
@@ -50,7 +54,7 @@ public override void Populate(TextWriter trapFile)
                     TypeMention.Create(Context, syntax.ExplicitInterfaceSpecifier!.Name, this, explicitInterface);
             }
 
-            if (Context.OnlyScaffold)
+            if (OnlyScaffold)
             {
                 return;
             }

csharp/extractor/Semmle.Extraction.CSharp/Entities/Field.cs

@@ -21,7 +21,7 @@ private Field(Context cx, IFieldSymbol init)
         // Do not populate backing fields.
         // Populate Tuple fields.
         public override bool NeedsPopulation =>
-            (base.NeedsPopulation && !Symbol.IsImplicitlyDeclared) || Symbol.ContainingType.IsTupleType;
+            ((Context.Defines(Symbol) || Context.IsOverlayMode) && !Symbol.IsImplicitlyDeclared) || Symbol.ContainingType.IsTupleType;
 
         public override void Populate(TextWriter trapFile)
         {
@@ -49,7 +49,7 @@ public override void Populate(TextWriter trapFile)
                 }
             }
 
-            if (Context.OnlyScaffold)
+            if (OnlyScaffold)
             {
                 return;
             }

csharp/extractor/Semmle.Extraction.CSharp/Entities/Indexer.cs

@@ -54,7 +54,7 @@ public override void Populate(TextWriter trapFile)
                     TypeMention.Create(Context, syntax.ExplicitInterfaceSpecifier!.Name, this, explicitInterface);
             }
 
-            if (Context.OnlyScaffold)
+            if (OnlyScaffold)
             {
                 return;
             }

csharp/extractor/Semmle.Extraction.CSharp/Entities/LocalVariable.cs

@@ -20,6 +20,9 @@ public sealed override void WriteQuotedId(EscapingTextWriter trapFile)
 
         public override void Populate(TextWriter trapFile) { }
 
+        // Populated by calling "PopulateManual".
+        public override bool NeedsPopulation => false;
+
         public void PopulateManual(Expression parent, bool isVar)
         {
             var trapFile = Context.TrapWriter.Writer;
@@ -41,7 +44,7 @@ public void PopulateManual(Expression parent, bool isVar)
                 trapFile.localvars(this, Kinds.VariableKind.None, Symbol.Name, @var, Type.Create(Context, parent.Type).TypeRef, parent);
             }
 
-            if (Context.OnlyScaffold)
+            if (OnlyScaffold)
             {
                 return;
             }