Changes and fixes in handling of .NET reference assemblies (#3)

* Added automatic searching for .NET referenced assembly directory. * Show error messages instead of crash if a reference cannot be found. * Also update dependencies.
lwchkg · May 13, 2017 · 82420e6 · 82420e6
1 parent b9c89fa
commit 82420e6
Show file tree

Hide file tree

Showing 7 changed files with 93 additions and 16 deletions.
diff --git a/DotNetEditor/App.config b/DotNetEditor/App.config
@@ -53,6 +53,10 @@
         <assemblyIdentity name="System.Composition.Hosting" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
         <bindingRedirect oldVersion="0.0.0.0-1.0.30.0" newVersion="1.0.30.0" />
       </dependentAssembly>
+      <dependentAssembly>
+        <assemblyIdentity name="System.ValueTuple" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral" />
+        <bindingRedirect oldVersion="0.0.0.0-4.0.1.1" newVersion="4.0.1.1" />
+      </dependentAssembly>
     </assemblyBinding>
   </runtime>
 </configuration>
diff --git a/DotNetEditor/CodeRunner/CSCodeRunner.cs b/DotNetEditor/CodeRunner/CSCodeRunner.cs
@@ -28,10 +28,20 @@ protected override Compilation GetCompilation()
             uniqueImports.Add("mscorlib.dll");
             uniqueImports.Add("Microsoft.CSharp.dll");
 
-            string dllPath = GetReferenceAssembliesPath();
-            IEnumerable<MetadataReference> references =
-                uniqueImports.Select(import => MetadataReference.CreateFromFile(
-                    System.IO.Path.Combine(dllPath, import)));
+            List<MetadataReference> references = new List<MetadataReference>();
+            try
+            {
+                string dllPath = GetReferenceAssembliesPath();
+                foreach (string import in uniqueImports)
+                {
+                    references.Add(MetadataReference.CreateFromFile(System.IO.Path.Combine(
+                                                                        dllPath, import)));
+                }
+            }
+            catch (Exception e)
+            {
+                throw new CodeRunnerException(e.Message, e);
+            }
 
             var options = new CSharpCompilationOptions(OutputKind.ConsoleApplication);
 

diff --git a/DotNetEditor/CodeRunner/CodeRunnerBase.cs b/DotNetEditor/CodeRunner/CodeRunnerBase.cs
@@ -112,10 +112,38 @@ void dumpConsoleBuffer(TextWriterWithConsoleColor.TextWriterWithConsoleColor buf
             buffer.ForEachPart(addConsoleColoredText);
         }
 
-        // Return: whether a the code runs successfully without error.
+        // Get the path to the optimally selected version of the .NET reference assemblies. If no
+        // matches are found, throw DirectoryNotFoundException.
         protected string GetReferenceAssembliesPath()
         {
-            return @"C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.6.1";
+            string basepath = System.IO.Path.Combine(
+                Environment.GetFolderPath(Environment.SpecialFolder.ProgramFilesX86,
+                                          Environment.SpecialFolderOption.DoNotVerify),
+                "Reference Assemblies",
+                "Microsoft",
+                "Framework",
+                ".NETFramework");
+
+            // List of .NET reference assembly directories, with glob wildcards characters.
+            string[] globPatternList = { "v4.6.*", "v4.*" };
+
+            // Try to match the first pattern. If no match, try the second pattern, etc.
+            foreach (string pattern in globPatternList)
+            {
+                string[] directories = System.IO.Directory.GetDirectories(basepath, pattern);
+                if (directories.Any())
+                {
+                    // If multiple versions are found, return the path to the latest version.
+                    return directories.Max();
+                }
+            }
+
+            // If no .NET reference assembly is found, throw an exception.
+            string dotNetDeveloperPackURL =
+                "https://www.microsoft.com/en-us/download/details.aspx?id=49978";
+            throw new System.IO.DirectoryNotFoundException(
+                String.Format("No .NET 4.x reference assemblies is found. Please install .NET Framework 4.6.1 Developer Pack at {0}",
+                              dotNetDeveloperPackURL));
         }
 
         protected abstract Compilation GetCompilation();
@@ -130,7 +158,16 @@ private string DiagToString(Diagnostic diag)
         public bool Run()
         {
             _outputArea.Clear();
-            Compilation compilation = GetCompilation();
+            Compilation compilation;
+            try
+            {
+                compilation = GetCompilation();
+            }
+            catch (CodeRunnerException e)
+            {
+                addResult(Environment.NewLine + e.Message, "Unable to compile", errorFgColor);
+                return false;
+            }
 
             var stream = new System.IO.MemoryStream();
             var emitResult = compilation.Emit(stream);
@@ -227,8 +264,7 @@ public bool Run()
 
             if (hasError)
             {
-                addResult(exStore.InnerException.Message,
-                    "Runtime error");//, errorColor)
+                addResult(exStore.InnerException.Message, "Runtime error", errorFgColor);
             }
 
             return !hasError;

diff --git a/DotNetEditor/CodeRunner/CodeRunnerException.cs b/DotNetEditor/CodeRunner/CodeRunnerException.cs
@@ -0,0 +1,16 @@
+// Copyright 2017 Leung Wing-chung. All rights reserved.
+// Use of this source code is governed by a GPLv3 license that can be found in
+// the LICENSE file.
+
+using System;
+
+namespace DotNetEditor.CodeRunner
+{
+    [Serializable]
+    class CodeRunnerException : Exception
+    {
+        public CodeRunnerException() { }
+        public CodeRunnerException(string message) : base(message) { }
+        public CodeRunnerException(string message, Exception e) : base(message, e) { }
+    }
+}
diff --git a/DotNetEditor/CodeRunner/VBCodeRunner.cs b/DotNetEditor/CodeRunner/VBCodeRunner.cs
@@ -32,10 +32,20 @@ protected override Compilation GetCompilation()
             uniqueImports.Add("mscorlib.dll");
             uniqueImports.Add("Microsoft.VisualBasic.dll");
 
-            string dllPath = GetReferenceAssembliesPath();
-            IEnumerable<MetadataReference> references =
-                uniqueImports.Select(import => MetadataReference.CreateFromFile(
-                    System.IO.Path.Combine(dllPath, import)));
+            List<MetadataReference> references = new List<MetadataReference>();
+            try
+            {
+                string dllPath = GetReferenceAssembliesPath();
+                foreach (string import in uniqueImports)
+                {
+                    references.Add(MetadataReference.CreateFromFile(System.IO.Path.Combine(
+                                                                        dllPath, import)));
+                }
+            }
+            catch (Exception e)
+            {
+                throw new CodeRunnerException(e.Message, e);
+            }
 
             var compilationOptions = new VisualBasicCompilationOptions(
                 OutputKind.ConsoleApplication,

diff --git a/DotNetEditor/DotNetEditor.csproj b/DotNetEditor/DotNetEditor.csproj
@@ -146,8 +146,8 @@
       <HintPath>..\packages\System.Threading.Thread.4.3.0\lib\net46\System.Threading.Thread.dll</HintPath>
       <Private>True</Private>
     </Reference>
-    <Reference Include="System.ValueTuple, Version=4.0.1.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51, processorArchitecture=MSIL">
-      <HintPath>..\packages\System.ValueTuple.4.3.0\lib\netstandard1.0\System.ValueTuple.dll</HintPath>
+    <Reference Include="System.ValueTuple, Version=4.0.1.1, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51, processorArchitecture=MSIL">
+      <HintPath>..\packages\System.ValueTuple.4.3.1\lib\netstandard1.0\System.ValueTuple.dll</HintPath>
       <Private>True</Private>
     </Reference>
     <Reference Include="System.Windows.Forms" />
@@ -202,6 +202,7 @@
     <Compile Include="AvalonUtils\AvalonRichTextBox.cs" />
     <Compile Include="AvalonUtils\PixelSnapper.cs" />
     <Compile Include="CodeRunner\CodeRunnerBase.cs" />
+    <Compile Include="CodeRunner\CodeRunnerException.cs" />
     <Compile Include="CodeRunner\CSCodeRunner.cs" />
     <Compile Include="ConsoleColorScheme.cs" />
     <Compile Include="ConsoleUtil.cs" />

diff --git a/DotNetEditor/packages.config b/DotNetEditor/packages.config
@@ -42,7 +42,7 @@
   <package id="System.Threading.Tasks" version="4.3.0" targetFramework="net461" />
   <package id="System.Threading.Tasks.Parallel" version="4.3.0" targetFramework="net461" />
   <package id="System.Threading.Thread" version="4.3.0" targetFramework="net461" />
-  <package id="System.ValueTuple" version="4.3.0" targetFramework="net461" />
+  <package id="System.ValueTuple" version="4.3.1" targetFramework="net461" />
   <package id="System.Xml.ReaderWriter" version="4.3.0" targetFramework="net461" />
   <package id="System.Xml.XDocument" version="4.3.0" targetFramework="net461" />
   <package id="System.Xml.XmlDocument" version="4.3.0" targetFramework="net461" />