Make derived 'Context' classes internal and adjust visibility of members in base 'Context'

Author: tamasvajk

csharp/extractor/Semmle.Extraction.CIL.Driver/Program.cs

@@ -24,7 +24,7 @@ private static void ExtractAssembly(Layout layout, string assemblyPath, ILogger
         {
             var sw = new Stopwatch();
             sw.Start();
-            Entities.Assembly.ExtractCIL(layout, assemblyPath, logger, nocache, extractPdbs, trapCompression, out _, out _);
+            Analyser.ExtractCIL(layout, assemblyPath, logger, nocache, extractPdbs, trapCompression, out _, out _);
             sw.Stop();
             logger.Log(Severity.Info, "  {0} ({1})", assemblyPath, sw.Elapsed);
         }

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

@@ -0,0 +1,53 @@
+using Semmle.Util.Logging;
+using System;
+using Semmle.Util;
+using Semmle.Extraction.CIL.Entities;
+
+namespace Semmle.Extraction.CIL
+{
+    public static class Analyser
+    {
+        private static void ExtractCIL(Extractor extractor, TrapWriter trapWriter, bool extractPdbs)
+        {
+            using var cilContext = new Context(extractor, trapWriter, extractor.OutputPath, extractPdbs);
+            cilContext.Populate(new Assembly(cilContext));
+            cilContext.PopulateAll();
+        }
+
+        /// <summary>
+        /// Main entry point to the CIL extractor.
+        /// Call this to extract a given assembly.
+        /// </summary>
+        /// <param name="layout">The trap layout.</param>
+        /// <param name="assemblyPath">The full path of the assembly to extract.</param>
+        /// <param name="logger">The logger.</param>
+        /// <param name="nocache">True to overwrite existing trap file.</param>
+        /// <param name="extractPdbs">Whether to extract PDBs.</param>
+        /// <param name="trapFile">The path of the trap file.</param>
+        /// <param name="extracted">Whether the file was extracted (false=cached).</param>
+        public static void ExtractCIL(Layout layout, string assemblyPath, ILogger logger, bool nocache, bool extractPdbs, TrapWriter.CompressionMode trapCompression, out string trapFile, out bool extracted)
+        {
+            trapFile = "";
+            extracted = false;
+            try
+            {
+                var canonicalPathCache = CanonicalPathCache.Create(logger, 1000);
+                var pathTransformer = new PathTransformer(canonicalPathCache);
+                var extractor = new Extractor(false, assemblyPath, logger, pathTransformer);
+                var transformedAssemblyPath = pathTransformer.Transform(assemblyPath);
+                var project = layout.LookupProjectOrDefault(transformedAssemblyPath);
+                using var trapWriter = project.CreateTrapWriter(logger, transformedAssemblyPath.WithSuffix(".cil"), trapCompression, discardDuplicates: true);
+                trapFile = trapWriter.TrapFile;
+                if (nocache || !System.IO.File.Exists(trapFile))
+                {
+                    ExtractCIL(extractor, trapWriter, extractPdbs);
+                    extracted = true;
+                }
+            }
+            catch (Exception ex)  // lgtm[cs/catch-of-all-exceptions]
+            {
+                logger.Log(Severity.Error, string.Format("Exception extracting {0}: {1}", assemblyPath, ex));
+            }
+        }
+    }
+}

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

@@ -9,11 +9,11 @@ namespace Semmle.Extraction.CIL
     /// <summary>
     /// Provides methods for creating and caching various entities.
     /// </summary>
-    public sealed partial class Context
+    internal sealed partial class Context
     {
         private readonly Dictionary<object, Label> ids = new Dictionary<object, Label>();
 
-        public T Populate<T>(T e) where T : IExtractedEntity
+        internal T Populate<T>(T e) where T : IExtractedEntity
         {
             if (e.Label.Valid)
             {
@@ -28,7 +28,7 @@ public T Populate<T>(T e) where T : IExtractedEntity
             else
             {
                 e.Label = GetNewLabel();
-                DefineLabel(e, TrapWriter.Writer, Extractor);
+                DefineLabel(e);
                 ids.Add(e, e.Label);
                 PopulateLater(() =>
                 {
@@ -76,7 +76,7 @@ public PrimitiveType Create(PrimitiveTypeCode code)
                 {
                     Label = GetNewLabel()
                 };
-                DefineLabel(e, TrapWriter.Writer, Extractor);
+                DefineLabel(e);
                 primitiveTypes[(int)code] = e;
             }
 

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

@@ -10,7 +10,7 @@ namespace Semmle.Extraction.CIL
     /// Adds additional context that is specific for CIL extraction.
     /// One context = one DLL/EXE.
     /// </summary>
-    public sealed partial class Context : Extraction.Context, IDisposable
+    internal sealed partial class Context : Extraction.Context, IDisposable
     {
         private readonly FileStream stream;
         private Entities.Assembly? assemblyNull;

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

@@ -5,7 +5,7 @@ namespace Semmle.Extraction.CIL
     /// <summary>
     /// A generic context which does not contain any type parameters.
     /// </summary>
-    public class EmptyContext : IGenericContext
+    internal class EmptyContext : IGenericContext
     {
         public EmptyContext(Context cx)
         {

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

@@ -1,18 +1,15 @@
 using System.Reflection;
 using System.Globalization;
 using System.Collections.Generic;
-using Semmle.Util.Logging;
-using System;
 using Semmle.Extraction.Entities;
 using System.IO;
-using Semmle.Util;
 
 namespace Semmle.Extraction.CIL.Entities
 {
     /// <summary>
     /// An assembly to extract.
     /// </summary>
-    public class Assembly : LabelledEntity, ILocation
+    internal class Assembly : LabelledEntity, ILocation
     {
         private readonly File file;
         private readonly AssemblyName assemblyName;
@@ -101,48 +98,5 @@ public override IEnumerable<IExtractionProduct> Contents
                 }
             }
         }
-
-        private static void ExtractCIL(Extractor extractor, TrapWriter trapWriter, bool extractPdbs)
-        {
-            using var cilContext = new Context(extractor, trapWriter, extractor.OutputPath, extractPdbs);
-            cilContext.Populate(new Assembly(cilContext));
-            cilContext.PopulateAll();
-        }
-
-        /// <summary>
-        /// Main entry point to the CIL extractor.
-        /// Call this to extract a given assembly.
-        /// </summary>
-        /// <param name="layout">The trap layout.</param>
-        /// <param name="assemblyPath">The full path of the assembly to extract.</param>
-        /// <param name="logger">The logger.</param>
-        /// <param name="nocache">True to overwrite existing trap file.</param>
-        /// <param name="extractPdbs">Whether to extract PDBs.</param>
-        /// <param name="trapFile">The path of the trap file.</param>
-        /// <param name="extracted">Whether the file was extracted (false=cached).</param>
-        public static void ExtractCIL(Layout layout, string assemblyPath, ILogger logger, bool nocache, bool extractPdbs, TrapWriter.CompressionMode trapCompression, out string trapFile, out bool extracted)
-        {
-            trapFile = "";
-            extracted = false;
-            try
-            {
-                var canonicalPathCache = CanonicalPathCache.Create(logger, 1000);
-                var pathTransformer = new PathTransformer(canonicalPathCache);
-                var extractor = new Extractor(false, assemblyPath, logger, pathTransformer);
-                var transformedAssemblyPath = pathTransformer.Transform(assemblyPath);
-                var project = layout.LookupProjectOrDefault(transformedAssemblyPath);
-                using var trapWriter = project.CreateTrapWriter(logger, transformedAssemblyPath.WithSuffix(".cil"), trapCompression, discardDuplicates: true);
-                trapFile = trapWriter.TrapFile;
-                if (nocache || !System.IO.File.Exists(trapFile))
-                {
-                    ExtractCIL(extractor, trapWriter, extractPdbs);
-                    extracted = true;
-                }
-            }
-            catch (Exception ex)  // lgtm[cs/catch-of-all-exceptions]
-            {
-                logger.Log(Severity.Error, string.Format("Exception extracting {0}: {1}", assemblyPath, ex));
-            }
-        }
     }
 }

csharp/extractor/Semmle.Extraction.CIL/Entities/Base/IExtractedEntity.cs

@@ -5,7 +5,7 @@ namespace Semmle.Extraction.CIL
     /// <summary>
     /// A CIL entity which has been extracted.
     /// </summary>
-    public interface IExtractedEntity : IExtractionProduct, IEntity
+    internal interface IExtractedEntity : IExtractionProduct, IEntity
     {
         /// <summary>
         /// The contents of the entity.

csharp/extractor/Semmle.Extraction.CIL/Entities/Base/IExtractionProduct.cs

@@ -12,7 +12,7 @@ namespace Semmle.Extraction.CIL
     /// - Enumerate Contents to produce more extraction products
     /// - Extract these until there is nothing left to extract
     /// </remarks>
-    public interface IExtractionProduct
+    internal interface IExtractionProduct
     {
         /// <summary>
         /// Perform further extraction/population of this item as necessary.

csharp/extractor/Semmle.Extraction.CIL/Entities/Base/IGenericContext.cs

@@ -6,7 +6,7 @@ namespace Semmle.Extraction.CIL
     /// When we decode a type/method signature, we need access to
     /// generic parameters.
     /// </summary>
-    public interface IGenericContext
+    internal interface IGenericContext
     {
         Context Cx { get; }
 

csharp/extractor/Semmle.Extraction.CIL/Entities/Base/LabelledEntity.cs

@@ -8,7 +8,7 @@ namespace Semmle.Extraction.CIL
     /// An entity that needs to be populated during extraction.
     /// This assigns a key and optionally extracts its contents.
     /// </summary>
-    public abstract class LabelledEntity : Extraction.LabelledEntity, IExtractedEntity
+    internal abstract class LabelledEntity : Extraction.LabelledEntity, IExtractedEntity
     {
         // todo: with .NET 5 this can override the base context, and change the return type.
         public Context Cx => (Context)base.Context;