Refactor

Author: sailro

Packages/com.unity.ide.visualstudio/Editor/Discovery.cs

@@ -3,162 +3,44 @@
  *  Copyright (c) Microsoft Corporation. All rights reserved.
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
-using System;
-using System.IO;
 using System.Collections.Generic;
-using System.Diagnostics;
-using System.Text.RegularExpressions;
-using System.Linq;
-using UnityEngine;
+using System.IO;
 
 namespace Microsoft.Unity.VisualStudio.Editor
 {
 	internal static class Discovery
 	{
-		internal const string ManagedWorkload = "Microsoft.VisualStudio.Workload.ManagedGame";
-
-		internal static string _vsWherePath;
-
-		public static void FindVSWhere()
-		{
-			_vsWherePath = FileUtility.GetPackageAssetFullPath("Editor", "VSWhere", "vswhere.exe");
-		}
-
 		public static IEnumerable<IVisualStudioInstallation> GetVisualStudioInstallations()
 		{
-			if (VisualStudioEditor.IsWindows)
-			{
-				foreach (var installation in QueryVsWhere())
-					yield return installation;
-			}
-
-			if (VisualStudioEditor.IsOSX)
-			{
-				var candidates = Directory.EnumerateDirectories("/Applications", "*.app");
-				foreach (var candidate in candidates)
-				{
-					if (TryDiscoverInstallation(candidate, out var installation))
-						yield return installation;
-				}
-			}
-		}
-
-		private static bool IsCandidateForDiscovery(string path)
-		{
-			if (File.Exists(path) && VisualStudioEditor.IsWindows && Regex.IsMatch(path, "devenv.exe$", RegexOptions.IgnoreCase))
-				return true;
-
-			if (Directory.Exists(path) && VisualStudioEditor.IsOSX && Regex.IsMatch(path, "Visual\\s?Studio(?!.*Code.*).*.app$", RegexOptions.IgnoreCase))
-				return true;
+			foreach (var installation in VisualStudioForWindowsInstallation.GetVisualStudioInstallations())
+				yield return installation;
 
-			return false;
+			foreach (var installation in VisualStudioForMacInstallation.GetVisualStudioInstallations())
+				yield return installation;
 		}
 
 		public static bool TryDiscoverInstallation(string editorPath, out IVisualStudioInstallation installation)
 		{
-			installation = null;
-
-			if (string.IsNullOrEmpty(editorPath))
-				return false;
-
-			if (!IsCandidateForDiscovery(editorPath))
-				return false;
-
-			// On windows we use the executable directly, so we can query extra information
-			var fvi = editorPath;
-
-			// On Mac we use the .app folder, so we need to access to main assembly
-			if (VisualStudioEditor.IsOSX)
+			try
 			{
-				fvi = Path.Combine(editorPath, "Contents/Resources/lib/monodevelop/bin/VisualStudio.exe");
-
-				if (!File.Exists(fvi))
-					fvi = Path.Combine(editorPath, "Contents/MonoBundle/VisualStudio.exe");
+				if (VisualStudioForWindowsInstallation.TryDiscoverInstallation(editorPath, out installation))
+					return true;
 
-				if (!File.Exists(fvi))
-					fvi = Path.Combine(editorPath, "Contents/MonoBundle/VisualStudio.dll");				
+				if (VisualStudioForMacInstallation.TryDiscoverInstallation(editorPath, out installation))
+					return true;
 			}
-
-			if (!File.Exists(fvi))
-				return false;
-
-			// VS preview are not using the isPrerelease flag so far
-			// On Windows FileDescription contains "Preview", but not on Mac
-			var vi = FileVersionInfo.GetVersionInfo(fvi);
-			var version = new Version(vi.ProductVersion);
-			var isPrerelease = vi.IsPreRelease || string.Concat(editorPath, "/" + vi.FileDescription).ToLower().Contains("preview");
-
-			installation = new VisualStudioInstallation()
+			catch (IOException)
 			{
-				IsPrerelease = isPrerelease,
-				Name = $"{vi.FileDescription}{(isPrerelease && VisualStudioEditor.IsOSX ? " Preview" : string.Empty)} [{version.ToString(3)}]",
-				Path = editorPath,
-				Version = version
-			};
-			return true;
-		}
-
-		#region VsWhere Json Schema
-#pragma warning disable CS0649
-		[Serializable]
-		internal class VsWhereResult
-		{
-			public VsWhereEntry[] entries;
-
-			public static VsWhereResult FromJson(string json)
-			{
-				return JsonUtility.FromJson<VsWhereResult>("{ \"" + nameof(VsWhereResult.entries) + "\": " + json + " }");
+				installation = null;
 			}
 
-			public IEnumerable<VisualStudioInstallation> ToVisualStudioInstallations()
-			{
-				foreach (var entry in entries)
-				{
-					yield return new VisualStudioInstallation()
-					{
-						Name = $"{entry.displayName} [{entry.catalog.productDisplayVersion}]",
-						Path = entry.productPath,
-						IsPrerelease = entry.isPrerelease,
-						Version = Version.Parse(entry.catalog.buildVersion)
-					};
-				}
-			}
-		}
-
-		[Serializable]
-		internal class VsWhereEntry
-		{
-			public string displayName;
-			public bool isPrerelease;
-			public string productPath;
-			public VsWhereCatalog catalog;
-		}
-
-		[Serializable]
-		internal class VsWhereCatalog
-		{
-			public string productDisplayVersion; // non parseable like "16.3.0 Preview 3.0"
-			public string buildVersion;
+			return false;
 		}
-#pragma warning restore CS3021
-		#endregion
 
-		private static IEnumerable<VisualStudioInstallation> QueryVsWhere()
+		public static void Initialize()
 		{
-			var progpath = _vsWherePath;
-
-			if (string.IsNullOrWhiteSpace(progpath))
-				return Enumerable.Empty<VisualStudioInstallation>();
-
-			var result = ProcessRunner.StartAndWaitForExit(progpath, "-prerelease -format json -utf8");
-
-			if (!result.Success)
-				throw new Exception($"Failure while running vswhere: {result.Error}");
-
-			// Do not catch any JsonException here, this will be handled by the caller
-			return VsWhereResult
-				.FromJson(result.Output)
-				.ToVisualStudioInstallations();
+			VisualStudioForWindowsInstallation.Initialize();
+			VisualStudioForMacInstallation.Initialize();
 		}
 	}
 }

Packages/com.unity.ide.visualstudio/Editor/ProjectGeneration/ProjectGeneration.cs

@@ -150,6 +150,8 @@ public bool SyncIfNeeded(IEnumerable<string> affectedFiles, IEnumerable<string>
 
 		private void CreateVsConfigIfNotFound()
 		{
+			const string ManagedWorkload = "Microsoft.VisualStudio.Workload.ManagedGame";
+
 			try
 			{
 				var vsConfigFile = VsConfigFile();
@@ -159,7 +161,7 @@ private void CreateVsConfigIfNotFound()
 				var content = $@"{{
   ""version"": ""1.0"",
   ""components"": [
-    ""{Discovery.ManagedWorkload}""
+    ""{ManagedWorkload}""
   ]
 }}
 ";

Packages/com.unity.ide.visualstudio/Editor/VisualStudioEditor.cs

@@ -38,9 +38,7 @@ static VisualStudioEditor()
 			if (!UnityInstallation.IsMainUnityEditorProcess)
 				return;
 
-			if (IsWindows)
-				Discovery.FindVSWhere();
-
+			Discovery.Initialize();
 			CodeEditor.Register(new VisualStudioEditor());
 
 			_discoverInstallations = AsyncOperation<IVisualStudioInstallation[]>.Run(DiscoverInstallations);
@@ -193,38 +191,23 @@ bool IsSupportedPath(string path)
 			return false;
 		}
 
-		private static void CheckCurrentEditorInstallation()
+		public bool OpenProject(string path, int line, int column)
 		{
 			var editorPath = CodeEditor.CurrentEditorInstallation;
-			try
-			{
-				if (Discovery.TryDiscoverInstallation(editorPath, out _))
-					return;
-			}
-			catch (IOException)
-			{
-			}
 
-			Debug.LogWarning($"Visual Studio executable {editorPath} is not found. Please change your settings in Edit > Preferences > External Tools.");
-		}
-
-		public bool OpenProject(string path, int line, int column)
-		{
-			CheckCurrentEditorInstallation();
+			if (!Discovery.TryDiscoverInstallation(editorPath, out var installation)) {
+				Debug.LogWarning($"Visual Studio executable {editorPath} is not found. Please change your settings in Edit > Preferences > External Tools.");
+				return false;
+			}
 
 			if (!IsSupportedPath(path))
 				return false;
 
 			if (!IsProjectGeneratedFor(path, out var missingFlag))
 				Debug.LogWarning($"You are trying to open {path} outside a generated project. This might cause problems with IntelliSense and debugging. To avoid this, you can change your .csproj preferences in Edit > Preferences > External Tools and enable {GetProjectGenerationFlagDescription(missingFlag)} generation.");
 
-			if (IsOSX)
-				return OpenOSXApp(path, line, column);
-
-			if (IsWindows)
-				return OpenWindowsApp(path, line);
-
-			return false;
+			var solution = GetOrGenerateSolutionFile(path);
+			return installation.Open(path, line, column, solution);
 		}
 
 		private static string GetProjectGenerationFlagDescription(ProjectGenerationFlag flag)
@@ -287,114 +270,6 @@ private bool IsProjectGeneratedFor(string path, out ProjectGenerationFlag missin
 			return false;
 		}
 
-		private enum COMIntegrationState
-		{
-			Running,
-			DisplayProgressBar,
-			ClearProgressBar,
-			Exited
-		}
-
-		private bool OpenWindowsApp(string path, int line)
-		{
-			var progpath = FileUtility.GetPackageAssetFullPath("Editor", "COMIntegration", "Release", "COMIntegration.exe");
-
-			if (string.IsNullOrWhiteSpace(progpath))
-				return false;
-
-			string absolutePath = "";
-			if (!string.IsNullOrWhiteSpace(path))
-			{
-				absolutePath = Path.GetFullPath(path);
-			}
-
-			// We remove all invalid chars from the solution filename, but we cannot prevent the user from using a specific path for the Unity project
-			// So process the fullpath to make it compatible with VS
-			var solution = GetOrGenerateSolutionFile(path);
-			if (!string.IsNullOrWhiteSpace(solution))
-			{
-				solution = $"\"{solution}\"";
-				solution = solution.Replace("^", "^^");
-			}
-
-			
-			var psi = ProcessRunner.ProcessStartInfoFor(progpath, $"\"{CodeEditor.CurrentEditorInstallation}\" {solution} \"{absolutePath}\" {line}");
-			psi.StandardOutputEncoding = System.Text.Encoding.Unicode;
-			psi.StandardErrorEncoding = System.Text.Encoding.Unicode;
-
-			// inter thread communication
-			var messages = new BlockingCollection<COMIntegrationState>();
-
-			var asyncStart = AsyncOperation<ProcessRunnerResult>.Run(
-				() => ProcessRunner.StartAndWaitForExit(psi, onOutputReceived: data => OnOutputReceived(data, messages)),
-				e => new ProcessRunnerResult {Success = false, Error = e.Message, Output = string.Empty},
-				() => messages.Add(COMIntegrationState.Exited)
-			);
-
-			MonitorCOMIntegration(messages);
-
-			var result = asyncStart.Result;
-
-			if (!result.Success && !string.IsNullOrWhiteSpace(result.Error))
-				Debug.LogError($"Error while starting Visual Studio: {result.Error}");
-
-			return result.Success;
-		}
-
-		private static void MonitorCOMIntegration(BlockingCollection<COMIntegrationState> messages)
-		{
-			var displayingProgress = false;
-			COMIntegrationState state;
-			
-			do
-			{
-				state = messages.Take();
-				switch (state)
-				{
-					case COMIntegrationState.ClearProgressBar:
-						EditorUtility.ClearProgressBar();
-						displayingProgress = false;
-						break;
-					case COMIntegrationState.DisplayProgressBar:
-						EditorUtility.DisplayProgressBar("Opening Visual Studio", "Starting up Visual Studio, this might take some time.", .5f);
-						displayingProgress = true;
-						break;
-				}
-			} while (state != COMIntegrationState.Exited);
-
-			// Make sure the progress bar is properly cleared in case of COMIntegration failure
-			if (displayingProgress)
-				EditorUtility.ClearProgressBar();
-		}
-		
-		private static readonly COMIntegrationState[] ProgressBarCommands = {COMIntegrationState.DisplayProgressBar, COMIntegrationState.ClearProgressBar};
-		private static void OnOutputReceived(string data, BlockingCollection<COMIntegrationState> messages)
-		{
-			if (data == null)
-				return;
-
-			foreach (var cmd in ProgressBarCommands)
-			{
-				if (data.IndexOf(cmd.ToString(), StringComparison.OrdinalIgnoreCase) >= 0)
-					messages.Add(cmd);
-			}
-		}
-
-		[DllImport("AppleEventIntegration")]
-		static extern bool OpenVisualStudio(string appPath, string solutionPath, string filePath, int line);
-
-		bool OpenOSXApp(string path, int line, int column)
-		{
-			string absolutePath = "";
-			if (!string.IsNullOrWhiteSpace(path))
-			{
-				absolutePath = Path.GetFullPath(path);
-			}
-
-			var solution = GetOrGenerateSolutionFile(path);
-			return OpenVisualStudio(CodeEditor.CurrentEditorInstallation, solution, absolutePath, line);
-		}
-
 		private string GetOrGenerateSolutionFile(string path)
 		{
 			_generator.Sync();