C#: Code tidy. Rename variables, delete dead code, format whitespace, improve comments.

Author: calumgrant

csharp/extractor/Semmle.Extraction.CIL/Context.cs

@@ -33,7 +33,7 @@ public Context(Extraction.Context cx, string assemblyPath, bool extractPdbs)
 
             globalNamespace = new Lazy<Entities.Namespace>(() => Populate(new Entities.Namespace(this, "", null)));
             systemNamespace = new Lazy<Entities.Namespace>(() => Populate(new Entities.Namespace(this, "System")));
-            genericHandleFactory = new CachedFunction<GenericContext, Handle, ILabelledEntity>(CreateGenericHandle);
+            genericHandleFactory = new CachedFunction<GenericContext, Handle, IExtractedEntity>(CreateGenericHandle);
             namespaceFactory = new CachedFunction<StringHandle, Entities.Namespace>(n => CreateNamespace(mdReader.GetString(n)));
             namespaceDefinitionFactory = new CachedFunction<NamespaceDefinitionHandle, Entities.Namespace>(CreateNamespace);
             sourceFiles = new CachedFunction<PDB.ISourceFile, Entities.PdbSourceFile>(path => new Entities.PdbSourceFile(this, path));

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

@@ -7,7 +7,7 @@ namespace Semmle.Extraction.CIL.Entities
     /// <summary>
     /// An event.
     /// </summary>
-    interface IEvent : ILabelledEntity
+    interface IEvent : IExtractedEntity
     {
     }
 

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

@@ -13,7 +13,7 @@ namespace Semmle.Extraction.CIL.Entities
     /// An entity represting a member.
     /// Used to type tuples correctly.
     /// </summary>
-    interface IMember : ILabelledEntity
+    interface IMember : IExtractedEntity
     {
     }
 

csharp/extractor/Semmle.Extraction.CIL/Entities/Folder.cs

@@ -16,7 +16,6 @@ public Folder(Context cx, string path) : base(cx)
             this.path = path;
         }
 
-
         public override void WriteId(TextWriter trapFile)
         {
             trapFile.Write(Semmle.Extraction.Entities.File.PathAsDatabaseId(path));

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

@@ -3,7 +3,7 @@
 
 namespace Semmle.Extraction.CIL.Entities
 {
-    interface ILocal : ILabelledEntity
+    interface ILocal : IExtractedEntity
     {
     }
 

csharp/extractor/Semmle.Extraction.CIL/Entities/Method.cs

@@ -64,7 +64,7 @@ internal protected void MakeMethodId(TextWriter trapFile, Type parent, string me
             int index = 0;
             foreach (var param in signature.ParameterTypes)
             {
-                trapFile.WriteSeparator(",", index++);
+                trapFile.WriteSeparator(",", ref index);
                 param.WriteId(trapFile, this);
             }
             trapFile.Write(')');
@@ -503,7 +503,7 @@ public override void WriteId(TextWriter trapFile)
             int index = 0;
             foreach(var param in typeParams)
             {
-                trapFile.WriteSeparator(",", index++);
+                trapFile.WriteSeparator(",", ref index);
                 trapFile.WriteSubId(param);
             }
             trapFile.Write('>');
@@ -516,10 +516,7 @@ public override bool Equals(object obj)
             return obj is MethodSpecificationMethod method && handle.Equals(method.handle) && typeParams.SequenceEqual(method.typeParams);
         }
 
-        public override int GetHashCode()
-        {
-            return handle.GetHashCode() * 11 + typeParams.SequenceHash();
-        }
+        public override int GetHashCode() => handle.GetHashCode() * 11 + typeParams.SequenceHash();
 
         public override Method SourceDeclaration => unboundMethod;
 

csharp/extractor/Semmle.Extraction.CIL/Entities/Parameter.cs

@@ -6,7 +6,7 @@ namespace Semmle.Extraction.CIL.Entities
     /// <summary>
     /// A parameter entity.
     /// </summary>
-    interface IParameter : ILabelledEntity
+    interface IParameter : IExtractedEntity
     {
     }
 

csharp/extractor/Semmle.Extraction.CIL/Entities/Property.cs

@@ -9,7 +9,7 @@ namespace Semmle.Extraction.CIL.Entities
     /// <summary>
     /// A property.
     /// </summary>
-    interface IProperty : ILabelledEntity
+    interface IProperty : IExtractedEntity
     {
     }
 
@@ -42,11 +42,12 @@ public override void WriteId(TextWriter trapFile)
             var signature = pd.DecodeSignature(new SignatureDecoder(), gc);
             foreach (var param in signature.ParameterTypes)
             {
-                trapFile.WriteSeparator(",", index++);
+                trapFile.WriteSeparator(",", ref index);
                 param.WriteId(trapFile, gc);
             }
             trapFile.Write(")");
         }
+
         public override bool Equals(object obj)
         {
             return obj is Property property && Equals(handle, property.handle);

csharp/extractor/Semmle.Extraction.CIL/Entities/Type.cs

@@ -39,7 +39,7 @@ public enum CilTypeKind
     /// <summary>
     /// A type container (namespace/types/method).
     /// </summary>
-    interface ITypeContainer : ILabelledEntity
+    interface ITypeContainer : IExtractedEntity
     {
     }
 
@@ -231,10 +231,9 @@ public void PrimitiveTypeId(TextWriter trapFile)
         /// <summary>
         /// Gets the primitive type corresponding to this type, if possible.
         /// </summary>
-        /// <param name="cx">Extraction context.</param>
-        /// <param name="t">The resulting primitive type.</param>
+        /// <param name="t">The resulting primitive type, or null.</param>
         /// <returns>True if this type is a primitive type.</returns>
-        public bool TryGetPrimitiveType(Context cx, out PrimitiveType t)
+        public bool TryGetPrimitiveType(out PrimitiveType t)
         {
             if (TryGetPrimitiveTypeCode(out var code))
             {
@@ -830,7 +829,7 @@ public override void WriteId(TextWriter trapFile, bool inContext)
                 int index = 0;
                 foreach (var t in thisTypeArguments)
                 {
-                    trapFile.WriteSeparator(",", index++);
+                    trapFile.WriteSeparator(",", ref index);
                     t.WriteId(trapFile);
                 }
                 trapFile.Write('>');
@@ -1253,7 +1252,7 @@ public void WriteId(TextWriter trapFile, GenericContext gc)
                 int index = 0;
                 foreach(var arg in typeArguments)
                 {
-                    trapFile.WriteSeparator(",", index++);
+                    trapFile.WriteSeparator(",", ref index);
                     arg.WriteId(trapFile, gc);
                 }
                 trapFile.Write('>');

csharp/extractor/Semmle.Extraction.CIL/ExtractionProduct.cs

@@ -12,7 +12,7 @@ namespace Semmle.Extraction.CIL
     /// The extraction algorithm proceeds as follows:
     /// - Construct entity
     /// - Call Extract()
-    /// - ILabelledEntity check if already extracted
+    /// - IExtractedEntity check if already extracted
     /// - Enumerate Contents to produce more extraction products
     /// - Extract these until there is nothing left to extract
     /// </remarks>
@@ -78,7 +78,7 @@ protected UnlabelledEntity(Context cx)
     /// An entity that needs to be populated during extraction.
     /// This assigns a key and optionally extracts its contents.
     /// </summary>
-    public abstract class LabelledEntity : ILabelledEntity
+    public abstract class LabelledEntity : IExtractedEntity
     {
         public abstract IEnumerable<IExtractionProduct> Contents { get; }
         public Label Label { get; set; }
@@ -120,13 +120,6 @@ public override string ToString()
         TrapStackBehaviour IEntity.TrapStackBehaviour => TrapStackBehaviour.NoLabel;
     }
 
-    /// <summary>
-    /// An entity with a defined ID.
-    /// </summary>
-    public interface ILabelledEntity : IExtractedEntity
-    {
-    }
-
     /// <summary>
     /// A tuple that is an extraction product.
     /// </summary>