Move location-like entities to the Semmle.Extraction.CSharp namespace

Author: tamasvajk

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

@@ -12,7 +12,7 @@ internal class CommentBlock
 
         public IEnumerable<CommentLine> CommentLines => lines;
 
-        public Location Location { get; private set; }
+        public Microsoft.CodeAnalysis.Location Location { get; private set; }
 
         public CommentBlock(CommentLine firstLine)
         {
@@ -49,7 +49,7 @@ public void AddCommentLine(CommentLine line)
         {
             Location = !lines.Any()
                 ? line.Location
-                : Location.Create(
+                : Microsoft.CodeAnalysis.Location.Create(
                     line.Location.SourceTree!,
                     new TextSpan(Location.SourceSpan.Start, line.Location.SourceSpan.End - Location.SourceSpan.Start));
 

csharp/extractor/Semmle.Extraction.CSharp/Comments/CommentProcessor.cs

@@ -19,10 +19,10 @@ public void AddComment(CommentLine comment)
         }
 
         // Comments sorted by location.
-        private readonly SortedDictionary<Location, CommentLine> comments = new SortedDictionary<Location, CommentLine>(new LocationComparer());
+        private readonly SortedDictionary<Microsoft.CodeAnalysis.Location, CommentLine> comments = new SortedDictionary<Microsoft.CodeAnalysis.Location, CommentLine>(new LocationComparer());
 
         // Program elements sorted by location.
-        private readonly SortedDictionary<Location, Label> elements = new SortedDictionary<Location, Label>(new LocationComparer());
+        private readonly SortedDictionary<Microsoft.CodeAnalysis.Location, Label> elements = new SortedDictionary<Microsoft.CodeAnalysis.Location, Label>(new LocationComparer());
 
         private readonly Dictionary<Label, Key> duplicationGuardKeys = new Dictionary<Label, Key>();
 
@@ -33,9 +33,9 @@ public void AddComment(CommentLine comment)
             return null;
         }
 
-        private class LocationComparer : IComparer<Location>
+        private class LocationComparer : IComparer<Microsoft.CodeAnalysis.Location>
         {
-            public int Compare(Location? l1, Location? l2) => CommentProcessor.Compare(l1, l2);
+            public int Compare(Microsoft.CodeAnalysis.Location? l1, Microsoft.CodeAnalysis.Location? l2) => CommentProcessor.Compare(l1, l2);
         }
 
         /// <summary>
@@ -44,7 +44,7 @@ private class LocationComparer : IComparer<Location>
         /// <param name="l1">First location</param>
         /// <param name="l2">Second location</param>
         /// <returns>&lt;0 if l1 before l2, &gt;0 if l1 after l2, else 0.</returns>
-        private static int Compare(Location? l1, Location? l2)
+        private static int Compare(Microsoft.CodeAnalysis.Location? l1, Microsoft.CodeAnalysis.Location? l2)
         {
             if (object.ReferenceEquals(l1, l2))
                 return 0;
@@ -68,7 +68,7 @@ private static int Compare(Location? l1, Location? l2)
         /// <param name="elementLabel">The label of the element in the trap file.</param>
         /// <param name="duplicationGuardKey">The duplication guard key of the element, if any.</param>
         /// <param name="loc">The location of the element.</param>
-        public void AddElement(Label elementLabel, Key? duplicationGuardKey, Location? loc)
+        public void AddElement(Label elementLabel, Key? duplicationGuardKey, Microsoft.CodeAnalysis.Location? loc)
         {
             if (loc is not null && loc.IsInSource)
                 elements[loc] = elementLabel;
@@ -78,7 +78,7 @@ public void AddElement(Label elementLabel, Key? duplicationGuardKey, Location? l
 
         // Ensure that commentBlock and element refer to the same file
         // which can happen when processing multiple files.
-        private static void EnsureSameFile(Comments.CommentBlock commentBlock, ref KeyValuePair<Location, Label>? element)
+        private static void EnsureSameFile(Comments.CommentBlock commentBlock, ref KeyValuePair<Microsoft.CodeAnalysis.Location, Label>? element)
         {
             if (element is not null && element.Value.Key.SourceTree != commentBlock.Location.SourceTree)
                 element = null;
@@ -96,9 +96,9 @@ private static void EnsureSameFile(Comments.CommentBlock commentBlock, ref KeyVa
         /// <param name="callback">Output binding information.</param>
         private void GenerateBindings(
             Comments.CommentBlock commentBlock,
-            KeyValuePair<Location, Label>? previousElement,
-            KeyValuePair<Location, Label>? nextElement,
-            KeyValuePair<Location, Label>? parentElement,
+            KeyValuePair<Microsoft.CodeAnalysis.Location, Label>? previousElement,
+            KeyValuePair<Microsoft.CodeAnalysis.Location, Label>? nextElement,
+            KeyValuePair<Microsoft.CodeAnalysis.Location, Label>? parentElement,
             CommentBindingCallback callback
             )
         {
@@ -125,7 +125,7 @@ CommentBindingCallback callback
             }
 
             // Heuristic to decide which is the "best" element associated with the comment.
-            KeyValuePair<Location, Label>? bestElement;
+            KeyValuePair<Microsoft.CodeAnalysis.Location, Label>? bestElement;
 
             if (previousElement is not null && previousElement.Value.Key.EndLine() == commentBlock.Location.StartLine())
             {
@@ -180,14 +180,14 @@ CommentBindingCallback callback
         private class ElementStack
         {
             // Invariant: the top of the stack must be contained by items below it.
-            private readonly Stack<KeyValuePair<Location, Label>> elementStack = new Stack<KeyValuePair<Location, Label>>();
+            private readonly Stack<KeyValuePair<Microsoft.CodeAnalysis.Location, Label>> elementStack = new();
 
             /// <summary>
             /// Add a new element to the stack.
             /// </summary>
             /// The stack is maintained.
             /// <param name="value">The new element to push.</param>
-            public void Push(KeyValuePair<Location, Label> value)
+            public void Push(KeyValuePair<Microsoft.CodeAnalysis.Location, Label> value)
             {
                 // Maintain the invariant by popping existing elements
                 while (elementStack.Count > 0 && !elementStack.Peek().Key.Contains(value.Key))
@@ -201,15 +201,15 @@ public void Push(KeyValuePair<Location, Label> value)
             /// </summary>
             /// <param name="l">The location of the comment.</param>
             /// <returns>An element completely containing l, or null if none found.</returns>
-            public KeyValuePair<Location, Label>? FindParent(Location l) =>
+            public KeyValuePair<Microsoft.CodeAnalysis.Location, Label>? FindParent(Microsoft.CodeAnalysis.Location l) =>
                 elementStack.Where(v => v.Key.Contains(l)).FirstOrNull();
 
             /// <summary>
             ///     Finds the element on the stack immediately preceding the comment at l.
             /// </summary>
             /// <param name="l">The location of the comment.</param>
             /// <returns>The element before l, or null.</returns>
-            public KeyValuePair<Location, Label>? FindBefore(Location l)
+            public KeyValuePair<Microsoft.CodeAnalysis.Location, Label>? FindBefore(Microsoft.CodeAnalysis.Location l)
             {
                 return elementStack
                     .Where(v => v.Key.SourceSpan.End < l.SourceSpan.Start)
@@ -222,7 +222,7 @@ public void Push(KeyValuePair<Location, Label> value)
             /// <param name="comment">The location of the comment.</param>
             /// <param name="next">The next element.</param>
             /// <returns>The next element.</returns>
-            public KeyValuePair<Location, Label>? FindAfter(Location comment, KeyValuePair<Location, Label>? next)
+            public KeyValuePair<Microsoft.CodeAnalysis.Location, Label>? FindAfter(Microsoft.CodeAnalysis.Location comment, KeyValuePair<Microsoft.CodeAnalysis.Location, Label>? next)
             {
                 var p = FindParent(comment);
                 return next.HasValue && p.HasValue && p.Value.Key.Before(next.Value.Key) ? null : next;
@@ -233,7 +233,7 @@ public void Push(KeyValuePair<Location, Label> value)
         private void GenerateBindings(
             Comments.CommentBlock block,
             ElementStack elementStack,
-            KeyValuePair<Location, Label>? nextElement,
+            KeyValuePair<Microsoft.CodeAnalysis.Location, Label>? nextElement,
             CommentBindingCallback cb
             )
         {
@@ -259,8 +259,8 @@ CommentBindingCallback cb
         /// <param name="cb">Where to send the results.</param>
         /// <returns>true if there are more comments to process, false otherwise.</returns>
         private bool GenerateBindings(
-            IEnumerator<KeyValuePair<Location, CommentLine>> commentEnumerator,
-            KeyValuePair<Location, Label>? nextElement,
+            IEnumerator<KeyValuePair<Microsoft.CodeAnalysis.Location, CommentLine>> commentEnumerator,
+            KeyValuePair<Microsoft.CodeAnalysis.Location, Label>? nextElement,
             ElementStack elementStack,
             CommentBindingCallback cb
             )
@@ -319,8 +319,8 @@ public void GenerateBindings(CommentBindingCallback cb)
 
             var elementStack = new ElementStack();
 
-            using IEnumerator<KeyValuePair<Location, Label>> elementEnumerator = elements.GetEnumerator();
-            using IEnumerator<KeyValuePair<Location, CommentLine>> commentEnumerator = comments.GetEnumerator();
+            using IEnumerator<KeyValuePair<Microsoft.CodeAnalysis.Location, Label>> elementEnumerator = elements.GetEnumerator();
+            using IEnumerator<KeyValuePair<Microsoft.CodeAnalysis.Location, CommentLine>> commentEnumerator = comments.GetEnumerator();
             if (!commentEnumerator.MoveNext())
             {
                 // There are no comments to process.

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

@@ -3,7 +3,7 @@
 
 namespace Semmle.Extraction.CSharp.Entities
 {
-    internal class Assembly : Extraction.Entities.Location
+    internal class Assembly : Location
     {
         public override Context Context => (Context)base.Context;
 
@@ -56,7 +56,7 @@ public override bool Equals(object? obj)
             return false;
         }
 
-        public static Extraction.Entities.Location Create(Context cx, Microsoft.CodeAnalysis.Location loc) => AssemblyConstructorFactory.Instance.CreateEntity(cx, loc, loc);
+        public static Location Create(Context cx, Microsoft.CodeAnalysis.Location loc) => AssemblyConstructorFactory.Instance.CreateEntity(cx, loc, loc);
 
         private class AssemblyConstructorFactory : CachedEntityFactory<Microsoft.CodeAnalysis.Location?, Assembly>
         {

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

@@ -151,9 +151,9 @@ private void ExtractArguments(TextWriter trapFile)
 
         public override Microsoft.CodeAnalysis.Location? ReportingLocation => attributeSyntax?.Name.GetLocation();
 
-        private Semmle.Extraction.Entities.Location? location;
+        private Location? location;
 
-        private Semmle.Extraction.Entities.Location Location =>
+        private Location Location =>
             location ??= Context.CreateLocation(attributeSyntax is null
                 ? entity.ReportingLocation
                 : attributeSyntax.Name.GetLocation());