Merge pull request #210 from unity/dev18-generator

Use SDK style projects for Dev18

Author: sailro

.gitignore

@@ -8,12 +8,16 @@ ValidationSuiteResults
 Assets/Plugins**
 obj/
 /UserSettings/
+/ProjectSettings/*.asset
 /*.csproj
 /*.sln
+/*.csproj.user
+/*.slnx
 /Temp
 *.bak
 *.bak.meta
 .DS_Store
 
+Packages/packages-lock.json
 Packages/com.unity.ide.visualstudio/Editor/COMIntegration/Release/build/
 Packages/com.unity.ide.visualstudio/Editor/COMIntegration/Release/COMIntegration.exe

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

@@ -5,7 +5,6 @@
  *--------------------------------------------------------------------------------------------*/
 
 using System;
-using System.Collections.Generic;
 
 namespace Microsoft.Unity.VisualStudio.Editor
 {
@@ -17,22 +16,19 @@ internal enum GeneratorStyle
 
 	internal static class GeneratorFactory
 	{
-		private static readonly Dictionary<GeneratorStyle, IGenerator> _generators = new Dictionary<GeneratorStyle, IGenerator>();
-
-		static GeneratorFactory()
-		{
-			_generators.Add(GeneratorStyle.SDK, new SdkStyleProjectGeneration());
-			_generators.Add(GeneratorStyle.Legacy, new LegacyStyleProjectGeneration());
-		}
+		private static readonly SdkStyleProjectGeneration _sdkStyleProjectGeneration = new SdkStyleProjectGeneration();
+		private static readonly LegacyStyleProjectGeneration _legacyStyleProjectGeneration = new LegacyStyleProjectGeneration();
 
 		public static IGenerator GetInstance(GeneratorStyle style)
 		{
 			var forceStyleString = OnSelectingCSProjectStyle();
 			if (forceStyleString != null && Enum.TryParse<GeneratorStyle>(forceStyleString, out var forceStyle))
 				style = forceStyle;
 
-			if (_generators.TryGetValue(style, out var result))
-				return result;
+			if (style == GeneratorStyle.SDK)
+				return _sdkStyleProjectGeneration;
+			if (style == GeneratorStyle.Legacy)
+				return _legacyStyleProjectGeneration;
 
 			throw new ArgumentException("Unknown generator style");
 		}

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

@@ -586,6 +586,11 @@ public string ProjectFile(Assembly assembly)
 #endif
 
 		public string SolutionFile()
+		{
+			return SolutionFileImpl();
+		}
+
+		internal virtual string SolutionFileImpl()
 		{
 			return Path.Combine(ProjectDirectory.NormalizePathSeparators(), $"{InvalidCharactersRegexPattern.Replace(m_ProjectName, "_")}.sln");
 		}
@@ -831,30 +836,13 @@ private void SyncSolution(IEnumerable<Assembly> assemblies)
 			SyncSolutionFileIfNotChanged(solutionFile, SolutionText(assemblies, previousSolution));
 		}
 
-		private string SolutionText(IEnumerable<Assembly> assemblies, Solution previousSolution = null)
+		internal virtual string SolutionText(IEnumerable<Assembly> assemblies, Solution previousSolution = null)
 		{
 			const string fileversion = "12.00";
 			const string vsversion = "15";
 
-			var relevantAssemblies = RelevantAssembliesForMode(assemblies);
-			var generatedProjects = ToProjectEntries(relevantAssemblies).ToList();
-
-			SolutionProperties[] properties = null;
-
-			// First, add all projects generated by Unity to the solution
-			var projects = new List<SolutionProjectEntry>();
-			projects.AddRange(generatedProjects);
-
-			if (previousSolution != null)
-			{
-				// Add all projects that were previously in the solution and that are not generated by Unity, nor generated in the project root directory
-				var externalProjects = previousSolution.Projects
-					.Where(p => p.IsSolutionFolderProjectFactory() || !FileUtility.IsFileInProjectRootDirectory(p.FileName))
-					.Where(p => generatedProjects.All(gp => gp.FileName != p.FileName));
-
-				projects.AddRange(externalProjects);
-				properties = previousSolution.Properties;
-			}
+			var projects = GetSolutionProjects(assemblies, previousSolution);
+			var properties = previousSolution != null ? previousSolution.Properties : null;
 
 			string propertiesText = GetPropertiesText(properties);
 			string projectEntriesText = GetProjectEntriesText(projects);
@@ -863,7 +851,7 @@ private string SolutionText(IEnumerable<Assembly> assemblies, Solution previousS
 			var configurableProjects = projects.Where(p => !p.IsSolutionFolderProjectFactory());
 			string projectConfigurationsText = string.Join(k_WindowsNewline, configurableProjects.Select(p => GetProjectActiveConfigurations(p.ProjectGuid)).ToArray());
 
-			const string solutionText = 
+			const string solutionText =
 				"" + k_WindowsNewline
 				+ "Microsoft Visual Studio Solution File, Format Version {0}" + k_WindowsNewline
 				+ "# Visual Studio {1}" + k_WindowsNewline
@@ -883,6 +871,28 @@ private string SolutionText(IEnumerable<Assembly> assemblies, Solution previousS
 			return string.Format(solutionText, fileversion, vsversion, projectEntriesText, projectConfigurationsText, propertiesText);
 		}
 
+		internal List<SolutionProjectEntry> GetSolutionProjects(IEnumerable<Assembly> assemblies, Solution previousSolution = null)
+		{
+			var relevantAssemblies = RelevantAssembliesForMode(assemblies);
+			var generatedProjects = ToProjectEntries(relevantAssemblies).ToList();
+
+			// First, add all projects generated by Unity to the solution
+			var projects = new List<SolutionProjectEntry>();
+			projects.AddRange(generatedProjects);
+
+			if (previousSolution != null)
+			{
+				// Add all projects that were previously in the solution and that are not generated by Unity, nor generated in the project root directory
+				var externalProjects = previousSolution.Projects
+					.Where(p => p.IsSolutionFolderProjectFactory() || !FileUtility.IsFileInProjectRootDirectory(p.FileName))
+					.Where(p => generatedProjects.All(gp => gp.FileName != p.FileName));
+
+				projects.AddRange(externalProjects);
+			}
+
+			return projects;
+		}
+
 		private static IEnumerable<Assembly> RelevantAssembliesForMode(IEnumerable<Assembly> assemblies)
 		{
 			return assemblies.Where(i => ScriptingLanguage.CSharp == ScriptingLanguageFor(i));
@@ -942,6 +952,7 @@ private string GetProjectEntriesText(IEnumerable<SolutionProjectEntry> entries)
 		private IEnumerable<SolutionProjectEntry> ToProjectEntries(IEnumerable<Assembly> assemblies)
 		{
 			foreach (var assembly in assemblies)
+			{
 				yield return new SolutionProjectEntry()
 				{
 					ProjectFactoryGuid = SolutionGuid(assembly),
@@ -950,6 +961,7 @@ private IEnumerable<SolutionProjectEntry> ToProjectEntries(IEnumerable<Assembly>
 					ProjectGuid = ProjectGuid(assembly),
 					Metadata = k_WindowsNewline
 				};
+			}
 		}
 
 		/// <summary>

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

@@ -4,7 +4,7 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-using System;
+using System.Collections.Generic;
 using System.IO;
 using System.Text;
 using UnityEditor.Compilation;
@@ -122,5 +122,27 @@ internal static void GetCapabilityBlock(StringBuilder footerBuilder, string impo
 			}
 			footerBuilder.Append(@"  </ItemGroup>").Append(k_WindowsNewline);
 		}
+
+		internal override string SolutionFileImpl()
+		{
+			return base.SolutionFileImpl() + "x";
+		}
+
+		internal override string SolutionText(IEnumerable<Assembly> assemblies, Solution previousSolution = null)
+		{
+			var projects = GetSolutionProjects(assemblies, previousSolution);
+
+			var content = new StringBuilder();
+			content.Append("<Solution>").Append(k_WindowsNewline);
+
+			foreach (var project in projects)
+			{
+				content.Append("  ").Append("<Project Path=\"").Append(project.FileName).Append("\" />").Append(k_WindowsNewline);
+			}
+
+			content.Append("</Solution>").Append(k_WindowsNewline);
+
+			return content.ToString();
+		}
 	}
 }

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

@@ -2,8 +2,11 @@
  *  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.Collections.Generic;
+using System.IO;
 using System.Text.RegularExpressions;
+using System.Xml.Linq;
 
 namespace Microsoft.Unity.VisualStudio.Editor
 {
@@ -16,10 +19,20 @@ internal static class SolutionParser
 
 		public static Solution ParseSolutionFile(string filename, IFileIO fileIO)
 		{
-			return ParseSolutionContent(fileIO.ReadAllText(filename));
+			var extension = Path.GetExtension(filename).ToLower();
+			if (extension == ".sln")
+			{
+				return ParseSolutionContent(fileIO.ReadAllText(filename));
+			}
+			if (extension == ".slnx")
+			{
+				return ParseSolutionXmlContent(fileIO.ReadAllText(filename));
+			}
+
+			throw new NotSupportedException();
 		}
 
-		public static Solution ParseSolutionContent(string content)
+		private static Solution ParseSolutionContent(string content)
 		{
 			return new Solution
 			{
@@ -76,5 +89,30 @@ private static SolutionProperties[] ParseSolutionProperties(string content)
 
 			return properties.ToArray();
 		}
+
+		private static Solution ParseSolutionXmlContent(string content)
+		{
+			return new Solution
+			{
+				Projects = ParseSolutionXmlProjects(content),
+				Properties = Array.Empty<SolutionProperties>(),
+			};
+		}
+
+		private static SolutionProjectEntry[] ParseSolutionXmlProjects(string content)
+		{
+			var document = XDocument.Parse(content);
+			var projects = new List<SolutionProjectEntry>();
+
+			foreach (var project in document.Descendants("Project"))
+			{
+				projects.Add(new SolutionProjectEntry
+				{
+					FileName = project.Attribute("Path")?.Value,
+				});
+			}
+
+			return projects.ToArray();
+		}
 	}
 }

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

@@ -382,6 +382,7 @@ private void CreateSettingsFile(string vscodeDirectory, bool enablePatch)
     ""explorer.fileNesting.enabled"": true,
     ""explorer.fileNesting.patterns"": {
         ""*.sln"": ""*.csproj"",
+        ""*.slnx"": ""*.csproj""
     },
     ""dotnet.defaultSolution"": """ + IOPath.GetFileName(ProjectGenerator.SolutionFile()) + @"""
 }";

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

@@ -26,6 +26,8 @@ internal class VisualStudioForWindowsInstallation : VisualStudioInstallation
 		// C# language version support for Visual Studio
 		private static readonly VersionPair[] WindowsVersionTable =
 		{
+			new VersionPair(18, 0, /* => */ 14,0),
+
 			// VisualStudio 2022
 			new VersionPair(17,12, /* => */ 13,0),
 			new VersionPair(17, 8, /* => */ 12,0),
@@ -43,8 +45,7 @@ internal class VisualStudioForWindowsInstallation : VisualStudioInstallation
 			new VersionPair(15,0, /* => */ 7,0),
 		};
 
-		private static string _vsWherePath = null;
-		private static readonly IGenerator _generator = GeneratorFactory.GetInstance(GeneratorStyle.Legacy);
+		private static string _vsWherePath;
 
 		public override bool SupportsAnalyzers
 		{
@@ -124,7 +125,7 @@ public override IGenerator ProjectGenerator
 		{
 			get
 			{
-				return _generator;
+				return GeneratorFactory.GetInstance(Version.Major >= 18 ? GeneratorStyle.SDK : GeneratorStyle.Legacy);
 			}
 		}