C#: Only write locations for unbound declarations and don't write empty locations.

Author: michaelnebel

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

@@ -63,8 +63,10 @@ public override void Populate(TextWriter trapFile)
 
             trapFile.accessors(this, kind, Symbol.Name, parent, unboundAccessor);
 
-            foreach (var l in Locations)
-                trapFile.accessor_location(this, l);
+            if (Context.ExtractLocation(Symbol))
+            {
+                WriteLocationsToTrap(trapFile.accessor_location, this, Locations);
+            }
 
             Overrides(trapFile);
 

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

@@ -59,11 +59,11 @@ public override void Populate(TextWriter trapFile)
         {
             var type = Type.Create(Context, Symbol.AttributeClass);
             trapFile.attributes(this, kind, type.TypeRef, entity);
-            trapFile.attribute_location(this, Location);
+            WriteLocationToTrap(trapFile.attribute_location, this, Location);
 
             if (attributeSyntax is not null)
             {
-                trapFile.attribute_location(this, Assembly.CreateOutputAssembly(Context));
+                WriteLocationToTrap(trapFile.attribute_location, this, Assembly.CreateOutputAssembly(Context));
 
                 TypeMention.Create(Context, attributeSyntax.Name, this, type);
             }

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

@@ -1,3 +1,5 @@
+using System;
+using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using Microsoft.CodeAnalysis;
@@ -52,6 +54,22 @@ public string DebugContents
             }
         }
 
+        protected static void WriteLocationToTrap<T1>(Action<T1, Location> writeAction, T1 entity, Location l)
+        {
+            if (l is not EmptyLocation)
+            {
+                writeAction(entity, l);
+            }
+        }
+
+        protected static void WriteLocationsToTrap<T1>(Action<T1, Location> writeAction, T1 entity, IEnumerable<Location> locations)
+        {
+            foreach (var loc in locations)
+            {
+                WriteLocationToTrap(writeAction, entity, loc);
+            }
+        }
+
         public override bool NeedsPopulation { get; }
 
         public override int GetHashCode() => Symbol is null ? 0 : Symbol.GetHashCode();

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

@@ -103,22 +103,6 @@ public virtual IEnumerable<Location> Locations
             }
         }
 
-        protected static void WriteLocationToTrap<T1>(Action<T1, Location> writeAction, T1 entity, Location l)
-        {
-            if (l is not EmptyLocation)
-            {
-                writeAction(entity, l);
-            }
-        }
-
-        protected static void WriteLocationsToTrap<T1>(Action<T1, Location> writeAction, T1 entity, IEnumerable<Location> locations)
-        {
-            foreach (var loc in locations)
-            {
-                WriteLocationToTrap(writeAction, entity, loc);
-            }
-        }
-
         /// <summary>
         /// Bind comments to this symbol.
         /// Comments are only bound to source declarations.

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

@@ -11,7 +11,7 @@ private CommentBlock(Context cx, Comments.CommentBlock init)
         public override void Populate(TextWriter trapFile)
         {
             trapFile.commentblock(this);
-            trapFile.commentblock_location(this, Context.CreateLocation(Symbol.Location));
+            WriteLocationToTrap(trapFile.commentblock_location, this, Context.CreateLocation(Symbol.Location));
             Symbol.CommentLines.ForEach((l, child) => trapFile.commentblock_child(this, l, child));
         }
 

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

@@ -23,7 +23,7 @@ public override void Populate(TextWriter trapFile)
         {
             location = Context.CreateLocation(Location);
             trapFile.commentline(this, Type == CommentLineType.MultilineContinuation ? CommentLineType.Multiline : Type, Text, RawText);
-            trapFile.commentline_location(this, location);
+            WriteLocationToTrap(trapFile.commentline_location, this, location);
         }
 
         public override Microsoft.CodeAnalysis.Location? ReportingLocation => location?.Symbol;

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

@@ -15,7 +15,7 @@ public override void Populate(TextWriter trapFile)
             ContainingType!.PopulateGenerics();
 
             trapFile.destructors(this, $"~{Symbol.ContainingType.Name}", ContainingType, OriginalDefinition(Context, this, Symbol));
-            trapFile.destructor_location(this, Location);
+            WriteLocationToTrap(trapFile.destructor_location, this, Location);
         }
 
         private static new Destructor OriginalDefinition(Context cx, Destructor original, IMethodSymbol symbol)

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

@@ -51,8 +51,10 @@ public override void Populate(TextWriter trapFile)
                     TypeMention.Create(Context, syntax.ExplicitInterfaceSpecifier!.Name, this, explicitInterface);
             }
 
-            foreach (var l in Locations)
-                trapFile.event_location(this, l);
+            if (Context.ExtractLocation(Symbol))
+            {
+                WriteLocationsToTrap(trapFile.event_location, this, Locations);
+            }
 
             foreach (var syntaxType in declSyntaxReferences
                 .OfType<VariableDeclaratorSyntax>()

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

@@ -48,8 +48,10 @@ public override void Populate(TextWriter trapFile)
 
             trapFile.event_accessors(this, kind, Symbol.Name, parent, unboundAccessor);
 
-            foreach (var l in Locations)
-                trapFile.event_accessor_location(this, l);
+            if (Context.ExtractLocation(Symbol))
+            {
+                WriteLocationsToTrap(trapFile.event_accessor_location, this, Locations);
+            }
 
             Overrides(trapFile);
 

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

@@ -40,6 +40,7 @@ protected sealed override void Populate(TextWriter trapFile)
                 trapFile.expr_parent_top_level(this, info.Child, info.Parent);
             else
                 trapFile.expr_parent(this, info.Child, info.Parent);
+
             trapFile.expr_location(this, Location);
 
             if (Type.HasValue && !Type.Value.HasObliviousNullability())