Merge pull request #186 from unity/platform-defines

sailro · GitHub Enterprise · commit 23a073d18e59 · 2023-09-25T19:30:34.000+02:00
Use Platform defines instead of run-time conditions
diff --git a/Packages/com.unity.ide.visualstudio/Editor/Discovery.cs b/Packages/com.unity.ide.visualstudio/Editor/Discovery.cs
@@ -13,11 +13,13 @@ internal static class Discovery
 	{
 		public static IEnumerable<IVisualStudioInstallation> GetVisualStudioInstallations()
 		{
+#if UNITY_EDITOR_WIN
 			foreach (var installation in VisualStudioForWindowsInstallation.GetVisualStudioInstallations())
 				yield return installation;
-
+#elif UNITY_EDITOR_OSX
 			foreach (var installation in VisualStudioForMacInstallation.GetVisualStudioInstallations())
 				yield return installation;
+#endif
 
 			foreach (var installation in VisualStudioCodeInstallation.GetVisualStudioInstallations())
 				yield return installation;
@@ -27,12 +29,13 @@ public static bool TryDiscoverInstallation(string editorPath, out IVisualStudioI
 		{
 			try
 			{
+#if UNITY_EDITOR_WIN
 				if (VisualStudioForWindowsInstallation.TryDiscoverInstallation(editorPath, out installation))
 					return true;
-
+#elif UNITY_EDITOR_OSX
 				if (VisualStudioForMacInstallation.TryDiscoverInstallation(editorPath, out installation))
 					return true;
-
+#endif
 				if (VisualStudioCodeInstallation.TryDiscoverInstallation(editorPath, out installation))
 					return true;
 			}
@@ -46,8 +49,11 @@ public static bool TryDiscoverInstallation(string editorPath, out IVisualStudioI
 
 		public static void Initialize()
 		{
+#if UNITY_EDITOR_WIN
 			VisualStudioForWindowsInstallation.Initialize();
+#elif UNITY_EDITOR_OSX
 			VisualStudioForMacInstallation.Initialize();
+#endif
 			VisualStudioCodeInstallation.Initialize();
 		}
 	}
diff --git a/Packages/com.unity.ide.visualstudio/Editor/Messaging/UdpSocket.cs b/Packages/com.unity.ide.visualstudio/Editor/Messaging/UdpSocket.cs
@@ -27,9 +27,7 @@ public void Bind(IPAddress address, int port = 0)
 
 		private void SetIOControl()
 		{
-			if (!VisualStudioEditor.IsWindows)
-				return;
-
+#if UNITY_EDITOR_WIN
 			try
 			{
 				const int SIO_UDP_CONNRESET = -1744830452;
@@ -40,6 +38,7 @@ private void SetIOControl()
 			{
 				// fallback
 			}
+#endif
 		}
 
 		public static byte[] BufferFor(IAsyncResult result)
diff --git a/Packages/com.unity.ide.visualstudio/Editor/ProjectGeneration/ProjectGeneration.cs b/Packages/com.unity.ide.visualstudio/Editor/ProjectGeneration/ProjectGeneration.cs
@@ -597,7 +597,11 @@ public string ProjectFile(Assembly assembly)
 			return Path.Combine(ProjectDirectory, $"{m_AssemblyNameProvider.GetAssemblyName(assembly.outputPath, assembly.name)}.csproj");
 		}
 
-		private static readonly Regex InvalidCharactersRegexPattern = new Regex(@"\?|&|\*|""|<|>|\||#|%|\^|;" + (VisualStudioEditor.IsWindows ? "" : "|:"));
+#if UNITY_EDITOR_WIN
+		private static readonly Regex InvalidCharactersRegexPattern = new Regex(@"\?|&|\*|""|<|>|\||#|%|\^|;", RegexOptions.Compiled);
+#else
+		private static readonly Regex InvalidCharactersRegexPattern = new Regex(@"\?|&|\*|""|<|>|\||#|%|\^|;|:", RegexOptions.Compiled);
+#endif
 
 		public string SolutionFile()
 		{
diff --git a/Packages/com.unity.ide.visualstudio/Editor/VisualStudioCodeInstallation.cs b/Packages/com.unity.ide.visualstudio/Editor/VisualStudioCodeInstallation.cs
@@ -66,13 +66,13 @@ public override IGenerator ProjectGenerator
 
 		private static bool IsCandidateForDiscovery(string path)
 		{
-			if (VisualStudioEditor.IsOSX)
-				return Directory.Exists(path) && Regex.IsMatch(path, ".*Code.*.app$", RegexOptions.IgnoreCase);
-
-			if (VisualStudioEditor.IsWindows)
-				return File.Exists(path) && Regex.IsMatch(path, ".*Code.*.exe$", RegexOptions.IgnoreCase);
-
+#if UNITY_EDITOR_OSX
+			return Directory.Exists(path) && Regex.IsMatch(path, ".*Code.*.app$", RegexOptions.IgnoreCase);
+#elif UNITY_EDITOR_WIN
+			return File.Exists(path) && Regex.IsMatch(path, ".*Code.*.exe$", RegexOptions.IgnoreCase);
+#else
 			return File.Exists(path) && path.EndsWith("code", StringComparison.OrdinalIgnoreCase);
+#endif
 		}
 
 		[Serializable]
@@ -99,22 +99,23 @@ public static bool TryDiscoverInstallation(string editorPath, out IVisualStudioI
 			{
 				var manifestBase = GetRealPath(editorPath);
 
-				if (VisualStudioEditor.IsWindows)  // on Windows, editorPath is a file, resources as subdirectory
-					manifestBase = IOPath.GetDirectoryName(manifestBase);
-				else if (VisualStudioEditor.IsOSX) // on Mac, editorPath is a directory
-					manifestBase = IOPath.Combine(manifestBase, "Contents");
-				else
-				{
-					// on Linux, editorPath is a file, in a bin sub-directory
-					var parent = Directory.GetParent(manifestBase);
-					// but we can link to [vscode]/code or [vscode]/bin/code
-					manifestBase = parent?.Name == "bin" ? parent.Parent?.FullName : parent?.FullName;
-				}                               
+#if UNITY_EDITOR_WIN
+				// on Windows, editorPath is a file, resources as subdirectory
+				manifestBase = IOPath.GetDirectoryName(manifestBase);
+#elif UNITY_EDITOR_OSX
+				// on Mac, editorPath is a directory
+				manifestBase = IOPath.Combine(manifestBase, "Contents");
+#else
+				// on Linux, editorPath is a file, in a bin sub-directory
+				var parent = Directory.GetParent(manifestBase);
+				// but we can link to [vscode]/code or [vscode]/bin/code
+				manifestBase = parent?.Name == "bin" ? parent.Parent?.FullName : parent?.FullName;
+#endif
 
 				if (manifestBase == null)
 					return false;
 
-				var manifestFullPath = IOPath.Combine(manifestBase, @"resources", "app", "package.json");
+				var manifestFullPath = IOPath.Combine(manifestBase, "resources", "app", "package.json");
 				if (File.Exists(manifestFullPath))
 				{
 					var manifest = JsonUtility.FromJson<VisualStudioCodeManifest>(File.ReadAllText(manifestFullPath));
@@ -143,32 +144,27 @@ public static IEnumerable<IVisualStudioInstallation> GetVisualStudioInstallation
 		{
 			var candidates = new List<string>();
 
-			if (VisualStudioEditor.IsWindows)
-			{
-				var localAppPath = IOPath.Combine(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData), "Programs");
-				var programFiles = IOPath.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ProgramFiles));
+#if UNITY_EDITOR_WIN
+			var localAppPath = IOPath.Combine(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData), "Programs");
+			var programFiles = IOPath.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ProgramFiles));
 
-				foreach (var basePath in new[] {localAppPath, programFiles})
-				{
-					candidates.Add(IOPath.Combine(basePath, "Microsoft VS Code", "Code.exe"));
-					candidates.Add(IOPath.Combine(basePath, "Microsoft VS Code Insiders", "Code - Insiders.exe"));
-				}
-			}
-			else if (VisualStudioEditor.IsOSX)
+			foreach (var basePath in new[] {localAppPath, programFiles})
 			{
-				var appPath = IOPath.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ProgramFiles));
-				candidates.AddRange(Directory.EnumerateDirectories(appPath, "Visual Studio Code*.app"));
-			}
-			else
-			{
-				// Well known locations
-				candidates.Add("/usr/bin/code");
-				candidates.Add("/bin/code");
-				candidates.Add("/usr/local/bin/code");
-
-				// Preference ordered base directories relative to which desktop files should be searched
-				candidates.AddRange(GetXdgCandidates());
+				candidates.Add(IOPath.Combine(basePath, "Microsoft VS Code", "Code.exe"));
+				candidates.Add(IOPath.Combine(basePath, "Microsoft VS Code Insiders", "Code - Insiders.exe"));
 			}
+#elif UNITY_EDITOR_OSX
+			var appPath = IOPath.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ProgramFiles));
+			candidates.AddRange(Directory.EnumerateDirectories(appPath, "Visual Studio Code*.app"));
+#elif UNITY_EDITOR_LINUX
+			// Well known locations
+			candidates.Add("/usr/bin/code");
+			candidates.Add("/bin/code");
+			candidates.Add("/usr/local/bin/code");
+
+			// Preference ordered base directories relative to which desktop files should be searched
+			candidates.AddRange(GetXdgCandidates());
+#endif
 
 			foreach (var candidate in candidates.Distinct())
 			{
@@ -177,6 +173,7 @@ public static IEnumerable<IVisualStudioInstallation> GetVisualStudioInstallation
 			}
 		}
 
+#if UNITY_EDITOR_LINUX
 		private static readonly Regex DesktopFileExecEntry = new Regex(@"Exec=(\S+)", RegexOptions.Singleline | RegexOptions.Compiled);
 
 		private static IEnumerable<string> GetXdgCandidates()
@@ -212,7 +209,6 @@ private static IEnumerable<string> GetXdgCandidates()
 			}
 		}
 
-#if UNITY_EDITOR_LINUX
 		[System.Runtime.InteropServices.DllImport ("libc")]
 		private static extern int readlink(string path, byte[] buffer, int buflen);
 
@@ -519,13 +515,14 @@ public override bool Open(string path, int line, int column, string solution)
 
 		private static ProcessStartInfo ProcessStartInfoFor(string application, string arguments)
 		{
-			if (!VisualStudioEditor.IsOSX)
-				return ProcessRunner.ProcessStartInfoFor(application, arguments, redirect: false);
-
+#if UNITY_EDITOR_OSX
 			// wrap with built-in OSX open feature
 			arguments = $"-n \"{application}\" --args {arguments}";
 			application = "open";
 			return ProcessRunner.ProcessStartInfoFor(application, arguments, redirect:false, shell: true);
+#else
+			return ProcessRunner.ProcessStartInfoFor(application, arguments, redirect: false);
+#endif
 		}
 
 		public static void Initialize()
diff --git a/Packages/com.unity.ide.visualstudio/Editor/VisualStudioEditor.cs b/Packages/com.unity.ide.visualstudio/Editor/VisualStudioEditor.cs
@@ -21,9 +21,6 @@ namespace Microsoft.Unity.VisualStudio.Editor
 	[InitializeOnLoad]
 	public class VisualStudioEditor : IExternalCodeEditor
 	{
-		internal static bool IsOSX => Application.platform == RuntimePlatform.OSXEditor;
-		internal static bool IsWindows => !IsOSX && Path.DirectorySeparatorChar == FileUtility.WinSeparator && Environment.NewLine == "\r\n";
-
 		CodeEditor.Installation[] IExternalCodeEditor.Installations => _discoverInstallations
 			.Result
 			.Values
diff --git a/Packages/com.unity.ide.visualstudio/Editor/VisualStudioForMacInstallation.cs b/Packages/com.unity.ide.visualstudio/Editor/VisualStudioForMacInstallation.cs
@@ -3,6 +3,8 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
+#if UNITY_EDITOR_OSX
+
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
@@ -101,7 +103,7 @@ public override IGenerator ProjectGenerator
 
 		private static bool IsCandidateForDiscovery(string path)
 		{
-			return Directory.Exists(path) && VisualStudioEditor.IsOSX && Regex.IsMatch(path, "Visual\\s?Studio(?!.*Code.*).*.app$", RegexOptions.IgnoreCase);
+			return Directory.Exists(path) && Regex.IsMatch(path, "Visual\\s?Studio(?!.*Code.*).*.app$", RegexOptions.IgnoreCase);
 		}
 
 		public static bool TryDiscoverInstallation(string editorPath, out IVisualStudioInstallation installation)
@@ -144,9 +146,6 @@ public static bool TryDiscoverInstallation(string editorPath, out IVisualStudioI
 
 		public static IEnumerable<IVisualStudioInstallation> GetVisualStudioInstallations()
 		{
-			if (!VisualStudioEditor.IsOSX)
-				yield break;
-
 			var candidates = Directory.EnumerateDirectories("/Applications", "*.app");
 			foreach (var candidate in candidates)
 			{
@@ -178,3 +177,5 @@ public static void Initialize()
 		}
 	}
 }
+
+#endif
diff --git a/Packages/com.unity.ide.visualstudio/Editor/VisualStudioForWindowsInstallation.cs b/Packages/com.unity.ide.visualstudio/Editor/VisualStudioForWindowsInstallation.cs
@@ -3,6 +3,8 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
+#if UNITY_EDITOR_WIN
+
 using System;
 using System.Collections.Concurrent;
 using System.Collections.Generic;
@@ -126,7 +128,7 @@ public override IGenerator ProjectGenerator
 
 		private static bool IsCandidateForDiscovery(string path)
 		{
-			return File.Exists(path) && VisualStudioEditor.IsWindows && Regex.IsMatch(path, "devenv.exe$", RegexOptions.IgnoreCase);
+			return File.Exists(path) && Regex.IsMatch(path, "devenv.exe$", RegexOptions.IgnoreCase);
 		}
 
 		public static bool TryDiscoverInstallation(string editorPath, out IVisualStudioInstallation installation)
@@ -169,9 +171,6 @@ public static string FormatProductName(string productName)
 
 		public static IEnumerable<IVisualStudioInstallation> GetVisualStudioInstallations()
 		{
-			if (!VisualStudioEditor.IsWindows)
-				yield break;
-
 			foreach (var installation in QueryVsWhere())
 				yield return installation;
 		}
@@ -373,8 +372,9 @@ private static void OnOutputReceived(string data, BlockingCollection<COMIntegrat
 
 		public static void Initialize()
 		{
-			if (VisualStudioEditor.IsWindows)
-				_vsWherePath = FileUtility.GetPackageAssetFullPath("Editor", "VSWhere", "vswhere.exe");
+			_vsWherePath = FileUtility.GetPackageAssetFullPath("Editor", "VSWhere", "vswhere.exe");
 		}
 	}
 }
+
+#endif
diff --git a/Packages/com.unity.ide.visualstudio/Editor/VisualStudioIntegration.cs b/Packages/com.unity.ide.visualstudio/Editor/VisualStudioIntegration.cs
@@ -106,10 +106,9 @@ private static void RunOnceOnUpdate(Action action)
 		private static void RunOnShutdown(Action action)
 		{
 			// Mono on OSX has all kinds of quirks on AppDomain shutdown
-			if (!VisualStudioEditor.IsWindows)
-				return;
-
+#if UNITY_EDITOR_WIN
 			AppDomain.CurrentDomain.DomainUnload += (_, __) => action();
+#endif
 		}
 
 		private static int DebuggingPort()

Original file line number	Diff line number	Diff line change
`@@ -13,11 +13,13 @@ internal static class Discovery`
`13`	`13`	`{`
`14`	`14`	`public static IEnumerable<IVisualStudioInstallation> GetVisualStudioInstallations()`
`15`	`15`	`{`
	`16`	`+#if UNITY_EDITOR_WIN`
`16`	`17`	`foreach (var installation in VisualStudioForWindowsInstallation.GetVisualStudioInstallations())`
`17`	`18`	`yield return installation;`
`18`		`-`
	`19`	`+#elif UNITY_EDITOR_OSX`
`19`	`20`	`foreach (var installation in VisualStudioForMacInstallation.GetVisualStudioInstallations())`
`20`	`21`	`yield return installation;`
	`22`	`+#endif`
`21`	`23`
`22`	`24`	`foreach (var installation in VisualStudioCodeInstallation.GetVisualStudioInstallations())`
`23`	`25`	`yield return installation;`
`@@ -27,12 +29,13 @@ public static bool TryDiscoverInstallation(string editorPath, out IVisualStudioI`
`27`	`29`	`{`
`28`	`30`	`try`
`29`	`31`	`{`
	`32`	`+#if UNITY_EDITOR_WIN`
`30`	`33`	`if (VisualStudioForWindowsInstallation.TryDiscoverInstallation(editorPath, out installation))`
`31`	`34`	`return true;`
`32`		`-`
	`35`	`+#elif UNITY_EDITOR_OSX`
`33`	`36`	`if (VisualStudioForMacInstallation.TryDiscoverInstallation(editorPath, out installation))`
`34`	`37`	`return true;`
`35`		`-`
	`38`	`+#endif`
`36`	`39`	`if (VisualStudioCodeInstallation.TryDiscoverInstallation(editorPath, out installation))`
`37`	`40`	`return true;`
`38`	`41`	`}`
`@@ -46,8 +49,11 @@ public static bool TryDiscoverInstallation(string editorPath, out IVisualStudioI`
`46`	`49`
`47`	`50`	`public static void Initialize()`
`48`	`51`	`{`
	`52`	`+#if UNITY_EDITOR_WIN`
`49`	`53`	`VisualStudioForWindowsInstallation.Initialize();`
	`54`	`+#elif UNITY_EDITOR_OSX`
`50`	`55`	`VisualStudioForMacInstallation.Initialize();`
	`56`	`+#endif`
`51`	`57`	`VisualStudioCodeInstallation.Initialize();`
`52`	`58`	`}`
`53`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,9 +27,7 @@ public void Bind(IPAddress address, int port = 0)`
`27`	`27`
`28`	`28`	`private void SetIOControl()`
`29`	`29`	`{`
`30`		`- if (!VisualStudioEditor.IsWindows)`
`31`		`- return;`
`32`		`-`
	`30`	`+#if UNITY_EDITOR_WIN`
`33`	`31`	`try`
`34`	`32`	`{`
`35`	`33`	`const int SIO_UDP_CONNRESET = -1744830452;`
`@@ -40,6 +38,7 @@ private void SetIOControl()`
`40`	`38`	`{`
`41`	`39`	`// fallback`
`42`	`40`	`}`
	`41`	`+#endif`
`43`	`42`	`}`
`44`	`43`
`45`	`44`	`public static byte[] BufferFor(IAsyncResult result)`
Original file line number	Diff line number	Diff line change
`@@ -597,7 +597,11 @@ public string ProjectFile(Assembly assembly)`
`597`	`597`	`return Path.Combine(ProjectDirectory, $"{m_AssemblyNameProvider.GetAssemblyName(assembly.outputPath, assembly.name)}.csproj");`
`598`	`598`	`}`
`599`	`599`
`600`		`- private static readonly Regex InvalidCharactersRegexPattern = new Regex(@"\?\|&\|\*\|""\|<\|>\|\\|\|#\|%\|\^\|;" + (VisualStudioEditor.IsWindows ? "" : "\|:"));`
	`600`	`+#if UNITY_EDITOR_WIN`
	`601`	`+ private static readonly Regex InvalidCharactersRegexPattern = new Regex(@"\?\|&\|\*\|""\|<\|>\|\\|\|#\|%\|\^\|;", RegexOptions.Compiled);`
	`602`	`+#else`
	`603`	`+ private static readonly Regex InvalidCharactersRegexPattern = new Regex(@"\?\|&\|\*\|""\|<\|>\|\\|\|#\|%\|\^\|;\|:", RegexOptions.Compiled);`
	`604`	`+#endif`
`601`	`605`
`602`	`606`	`public string SolutionFile()`
`603`	`607`	`{`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,8 @@`
`3`	`3`	`* Licensed under the MIT License. See License.txt in the project root for license information.`
`4`	`4`	`--------------------------------------------------------------------------------------------/`
`5`	`5`
	`6`	`+#if UNITY_EDITOR_OSX`
	`7`	`+`
`6`	`8`	`using System;`
`7`	`9`	`using System.Collections.Generic;`
`8`	`10`	`using System.Diagnostics;`
`@@ -101,7 +103,7 @@ public override IGenerator ProjectGenerator`
`101`	`103`
`102`	`104`	`private static bool IsCandidateForDiscovery(string path)`
`103`	`105`	`{`
`104`		`- return Directory.Exists(path) && VisualStudioEditor.IsOSX && Regex.IsMatch(path, "Visual\\s?Studio(?!.Code.).*.app$", RegexOptions.IgnoreCase);`
	`106`	`+ return Directory.Exists(path) && Regex.IsMatch(path, "Visual\\s?Studio(?!.Code.).*.app$", RegexOptions.IgnoreCase);`
`105`	`107`	`}`
`106`	`108`
`107`	`109`	`public static bool TryDiscoverInstallation(string editorPath, out IVisualStudioInstallation installation)`
`@@ -144,9 +146,6 @@ public static bool TryDiscoverInstallation(string editorPath, out IVisualStudioI`
`144`	`146`
`145`	`147`	`public static IEnumerable<IVisualStudioInstallation> GetVisualStudioInstallations()`
`146`	`148`	`{`
`147`		`- if (!VisualStudioEditor.IsOSX)`
`148`		`- yield break;`
`149`		`-`
`150`	`149`	`var candidates = Directory.EnumerateDirectories("/Applications", "*.app");`
`151`	`150`	`foreach (var candidate in candidates)`
`152`	`151`	`{`
`@@ -178,3 +177,5 @@ public static void Initialize()`
`178`	`177`	`}`
`179`	`178`	`}`
`180`	`179`	`}`
	`180`	`+`
	`181`	`+#endif`
Original file line number	Diff line number	Diff line change
`@@ -106,10 +106,9 @@ private static void RunOnceOnUpdate(Action action)`
`106`	`106`	`private static void RunOnShutdown(Action action)`
`107`	`107`	`{`
`108`	`108`	`// Mono on OSX has all kinds of quirks on AppDomain shutdown`
`109`		`- if (!VisualStudioEditor.IsWindows)`
`110`		`- return;`
`111`		`-`
	`109`	`+#if UNITY_EDITOR_WIN`
`112`	`110`	`AppDomain.CurrentDomain.DomainUnload += (_, __) => action();`
	`111`	`+#endif`
`113`	`112`	`}`
`114`	`113`
`115`	`114`	`private static int DebuggingPort()`