File size: 35,817 Bytes
18a519f | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 | using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Security;
using System.Text;
using Packages.Rider.Editor.Util;
using UnityEditor;
using UnityEditor.Compilation;
using UnityEditorInternal;
using UnityEngine;
namespace Packages.Rider.Editor.ProjectGeneration
{
internal class ProjectGeneration : IGenerator
{
private enum ScriptingLanguage
{
None,
CSharp
}
public static readonly string MSBuildNamespaceUri = "http://schemas.microsoft.com/developer/msbuild/2003";
/// <summary>
/// Map source extensions to ScriptingLanguages
/// </summary>
private static readonly Dictionary<string, ScriptingLanguage> k_BuiltinSupportedExtensions =
new Dictionary<string, ScriptingLanguage>
{
{ "cs", ScriptingLanguage.CSharp },
{ "uxml", ScriptingLanguage.None },
{ "uss", ScriptingLanguage.None },
{ "shader", ScriptingLanguage.None },
{ "compute", ScriptingLanguage.None },
{ "cginc", ScriptingLanguage.None },
{ "hlsl", ScriptingLanguage.None },
{ "glslinc", ScriptingLanguage.None },
{ "template", ScriptingLanguage.None },
{ "raytrace", ScriptingLanguage.None },
{ "json", ScriptingLanguage.None},
{ "rsp", ScriptingLanguage.None},
{ "asmdef", ScriptingLanguage.None},
{ "asmref", ScriptingLanguage.None},
{ "xaml", ScriptingLanguage.None},
{ "tt", ScriptingLanguage.None},
{ "t4", ScriptingLanguage.None},
{ "ttinclude", ScriptingLanguage.None}
};
private string m_SolutionProjectEntryTemplate = string.Join(Environment.NewLine,
@"Project(""{{{0}}}"") = ""{1}"", ""{2}"", ""{{{3}}}""",
@"EndProject").Replace(" ", "\t");
private string m_SolutionProjectConfigurationTemplate = string.Join(Environment.NewLine,
@" {{{0}}}.Debug|Any CPU.ActiveCfg = Debug|Any CPU",
@" {{{0}}}.Debug|Any CPU.Build.0 = Debug|Any CPU").Replace(" ", "\t");
private string[] m_ProjectSupportedExtensions = new string[0];
public string ProjectDirectory { get; }
private readonly string m_ProjectName;
private readonly IAssemblyNameProvider m_AssemblyNameProvider;
private readonly IFileIO m_FileIOProvider;
private readonly IGUIDGenerator m_GUIDGenerator;
internal static bool isRiderProjectGeneration; // workaround to https://github.cds.internal.unity3d.com/unity/com.unity.ide.rider/issues/28
private const string k_ToolsVersion = "4.0";
private const string k_ProductVersion = "10.0.20506";
private const string k_BaseDirectory = ".";
private const string k_TargetLanguageVersion = "latest";
IAssemblyNameProvider IGenerator.AssemblyNameProvider => m_AssemblyNameProvider;
public ProjectGeneration()
: this(Directory.GetParent(Application.dataPath).FullName) { }
public ProjectGeneration(string tempDirectory)
: this(tempDirectory, new AssemblyNameProvider(), new FileIOProvider(), new GUIDProvider()) { }
public ProjectGeneration(string tempDirectory, IAssemblyNameProvider assemblyNameProvider, IFileIO fileIoProvider, IGUIDGenerator guidGenerator)
{
ProjectDirectory = tempDirectory.NormalizePath();
m_ProjectName = Path.GetFileName(ProjectDirectory);
m_AssemblyNameProvider = assemblyNameProvider;
m_FileIOProvider = fileIoProvider;
m_GUIDGenerator = guidGenerator;
}
/// <summary>
/// Syncs the scripting solution if any affected files are relevant.
/// </summary>
/// <returns>
/// Whether the solution was synced.
/// </returns>
/// <param name='affectedFiles'>
/// A set of files whose status has changed
/// </param>
/// <param name="reimportedFiles">
/// A set of files that got reimported
/// </param>
/// <param name="checkProjectFiles">
/// Check if project files were changed externally
/// </param>
public bool SyncIfNeeded(IEnumerable<string> affectedFiles, IEnumerable<string> reimportedFiles, bool checkProjectFiles = false)
{
SetupSupportedExtensions();
PackageManagerTracker.SyncIfNeeded(checkProjectFiles);
if (HasFilesBeenModified(affectedFiles, reimportedFiles) || RiderScriptEditorData.instance.hasChanges
|| RiderScriptEditorData.instance.HasChangesInCompilationDefines()
|| (checkProjectFiles && LastWriteTracker.HasLastWriteTimeChanged()))
{
Sync();
return true;
}
return false;
}
private bool HasFilesBeenModified(IEnumerable<string> affectedFiles, IEnumerable<string> reimportedFiles)
{
return affectedFiles.Any(ShouldFileBePartOfSolution) || reimportedFiles.Any(ShouldSyncOnReimportedAsset);
}
private static bool ShouldSyncOnReimportedAsset(string asset)
{
var extension = Path.GetExtension(asset);
return extension == ".asmdef" || extension == ".asmref" || Path.GetFileName(asset) == "csc.rsp";
}
public void Sync()
{
SetupSupportedExtensions();
var types = GetAssetPostprocessorTypes();
isRiderProjectGeneration = true;
var externalCodeAlreadyGeneratedProjects = OnPreGeneratingCSProjectFiles(types);
isRiderProjectGeneration = false;
if (!externalCodeAlreadyGeneratedProjects)
{
GenerateAndWriteSolutionAndProjects(types);
}
OnGeneratedCSProjectFiles(types);
m_AssemblyNameProvider.ResetPackageInfoCache();
m_AssemblyNameProvider.ResetAssembliesCache();
RiderScriptEditorData.instance.hasChanges = false;
RiderScriptEditorData.instance.InvalidateSavedCompilationDefines();
}
public bool HasSolutionBeenGenerated()
{
return m_FileIOProvider.Exists(SolutionFile());
}
private void SetupSupportedExtensions()
{
m_ProjectSupportedExtensions = m_AssemblyNameProvider.ProjectSupportedExtensions;
}
private bool ShouldFileBePartOfSolution(string file)
{
// Exclude files coming from packages except if they are internalized.
if (m_AssemblyNameProvider.IsInternalizedPackagePath(file))
{
return false;
}
return HasValidExtension(file);
}
public bool HasValidExtension(string file)
{
var extension = Path.GetExtension(file);
// Dll's are not scripts but still need to be included..
if (extension.Equals(".dll", StringComparison.OrdinalIgnoreCase))
return true;
return IsSupportedExtension(extension);
}
private bool IsSupportedExtension(string extension)
{
extension = extension.TrimStart('.');
return k_BuiltinSupportedExtensions.ContainsKey(extension) || m_ProjectSupportedExtensions.Contains(extension);
}
public void GenerateAndWriteSolutionAndProjects(Type[] types)
{
// Only synchronize islands that have associated source files and ones that we actually want in the project.
// This also filters out DLLs coming from .asmdef files in packages.
var assemblies = m_AssemblyNameProvider.GetAssemblies(ShouldFileBePartOfSolution).ToArray();
var allAssetProjectParts = GenerateAllAssetProjectParts();
var projectParts = new List<ProjectPart>();
var visitedAssemblyNames = new HashSet<string>();
foreach (var assembly in assemblies)
{
if (visitedAssemblyNames.Contains(assembly.name))
projectParts.Add(new ProjectPart(assembly.name, assembly, string.Empty)); // do not add asset project parts to both editor and player projects
else
{
allAssetProjectParts.TryGetValue(assembly.name, out var additionalAssetsForProject);
projectParts.Add(new ProjectPart(assembly.name, assembly, additionalAssetsForProject));
visitedAssemblyNames.Add(assembly.name);
}
}
var executingAssemblyName = typeof(ProjectGeneration).Assembly.GetName().Name;
var riderAssembly = m_AssemblyNameProvider.GetAssemblies(_ => true).FirstOrDefault(a=>a.name == executingAssemblyName);
var projectPartsWithoutAssembly = allAssetProjectParts.Where(a => !visitedAssemblyNames.Contains(a.Key));
projectParts.AddRange(projectPartsWithoutAssembly.Select(allAssetProjectPart =>
AddProjectPart(allAssetProjectPart.Key, riderAssembly, allAssetProjectPart.Value)));
SyncSolution(projectParts.ToArray(), types);
foreach (var projectPart in projectParts)
{
SyncProject(projectPart, types);
}
}
private static ProjectPart AddProjectPart(string assemblyName, Assembly riderAssembly, string assetProjectPart)
{
Assembly assembly = null;
if (riderAssembly != null)
// We want to add those references, so that Rider would detect Unity path and version and provide rich features for shader files
assembly = new Assembly(assemblyName, riderAssembly.outputPath, Array.Empty<string>(),
new []{"UNITY_EDITOR"},
Array.Empty<Assembly>(),
riderAssembly.compiledAssemblyReferences.Where(a =>
a.EndsWith("UnityEditor.dll", StringComparison.Ordinal) || a.EndsWith("UnityEngine.dll", StringComparison.Ordinal) ||
a.EndsWith("UnityEngine.CoreModule.dll", StringComparison.Ordinal)).ToArray(), riderAssembly.flags);
return new ProjectPart(assemblyName, assembly, assetProjectPart);
}
private Dictionary<string, string> GenerateAllAssetProjectParts()
{
var stringBuilders = new Dictionary<string, StringBuilder>();
foreach (var asset in m_AssemblyNameProvider.GetAllAssetPaths())
{
// Exclude files coming from packages except if they are internalized.
if (m_AssemblyNameProvider.IsInternalizedPackagePath(asset))
{
continue;
}
var fallbackAssemblyName = "Assembly-CSharp";
var extension = Path.GetExtension(asset);
if (AssetDatabase.IsValidFolder(asset))
{
var assemblyName = m_AssemblyNameProvider.GetAssemblyNameFromScriptPath($"{asset}/asset.cs");
if (string.IsNullOrEmpty(assemblyName))
{
assemblyName = fallbackAssemblyName;
}
assemblyName = FileSystemUtil.FileNameWithoutExtension(assemblyName);
if (!stringBuilders.TryGetValue(assemblyName, out var projectBuilder))
{
projectBuilder = new StringBuilder();
stringBuilders[assemblyName] = projectBuilder;
}
projectBuilder.Append(" <Folder Include=\"").Append(m_FileIOProvider.EscapedRelativePathFor(asset, ProjectDirectory)).Append("\" />")
.Append(Environment.NewLine);
}
else if (IsSupportedExtension(extension) && !extension.Equals(".cs", StringComparison.OrdinalIgnoreCase))
{
// Find assembly the asset belongs to by adding script extension and using compilation pipeline.
var assemblyName = m_AssemblyNameProvider.GetAssemblyNameFromScriptPath(asset + ".cs");
if (string.IsNullOrEmpty(assemblyName))
{
assemblyName = fallbackAssemblyName;
}
assemblyName = FileSystemUtil.FileNameWithoutExtension(assemblyName);
if (!stringBuilders.TryGetValue(assemblyName, out var projectBuilder))
{
projectBuilder = new StringBuilder();
stringBuilders[assemblyName] = projectBuilder;
}
projectBuilder.Append(" <None Include=\"").Append(m_FileIOProvider.EscapedRelativePathFor(asset, ProjectDirectory)).Append("\" />")
.Append(Environment.NewLine);
}
}
var result = new Dictionary<string, string>();
foreach (var entry in stringBuilders)
result[entry.Key] = entry.Value.ToString();
return result;
}
private void SyncProject(
ProjectPart island,
Type[] types)
{
SyncProjectFileIfNotChanged(
ProjectFile(island),
ProjectText(island),
types);
}
private void SyncProjectFileIfNotChanged(string path, string newContents, Type[] types)
{
if (Path.GetExtension(path) == ".csproj")
{
newContents = OnGeneratedCSProject(path, newContents, types);
}
SyncFileIfNotChanged(path, newContents);
}
private void SyncSolutionFileIfNotChanged(string path, string newContents, Type[] types)
{
newContents = OnGeneratedSlnSolution(path, newContents, types);
SyncFileIfNotChanged(path, newContents);
}
private static void OnGeneratedCSProjectFiles(Type[] types)
{
foreach (var type in types)
{
var method = type.GetMethod("OnGeneratedCSProjectFiles",
System.Reflection.BindingFlags.Public | System.Reflection.BindingFlags.NonPublic |
System.Reflection.BindingFlags.Static);
if (method == null)
{
continue;
}
Debug.LogWarning("OnGeneratedCSProjectFiles is not supported.");
// RIDER-51958
//method.Invoke(null, args);
}
}
public static Type[] GetAssetPostprocessorTypes()
{
return TypeCache.GetTypesDerivedFrom<AssetPostprocessor>().ToArray(); // doesn't find types from EditorPlugin, which is fine
}
private static bool OnPreGeneratingCSProjectFiles(Type[] types)
{
var result = false;
foreach (var type in types)
{
var args = new object[0];
var method = type.GetMethod("OnPreGeneratingCSProjectFiles",
System.Reflection.BindingFlags.Public | System.Reflection.BindingFlags.NonPublic |
System.Reflection.BindingFlags.Static);
if (method == null)
{
continue;
}
var returnValue = method.Invoke(null, args);
if (method.ReturnType == typeof(bool))
{
result |= (bool)returnValue;
}
}
return result;
}
private static string OnGeneratedCSProject(string path, string content, Type[] types)
{
foreach (var type in types)
{
var args = new[] { path, content };
var method = type.GetMethod("OnGeneratedCSProject",
System.Reflection.BindingFlags.Public | System.Reflection.BindingFlags.NonPublic |
System.Reflection.BindingFlags.Static);
if (method == null)
{
continue;
}
var returnValue = method.Invoke(null, args);
if (method.ReturnType == typeof(string))
{
content = (string)returnValue;
}
}
return content;
}
private static string OnGeneratedSlnSolution(string path, string content, Type[] types)
{
foreach (var type in types)
{
var args = new[] { path, content };
var method = type.GetMethod("OnGeneratedSlnSolution",
System.Reflection.BindingFlags.Public | System.Reflection.BindingFlags.NonPublic |
System.Reflection.BindingFlags.Static);
if (method == null)
{
continue;
}
var returnValue = method.Invoke(null, args);
if (method.ReturnType == typeof(string))
{
content = (string)returnValue;
}
}
return content;
}
private void SyncFileIfNotChanged(string path, string newContents)
{
try
{
if (m_FileIOProvider.Exists(path) && newContents == m_FileIOProvider.ReadAllText(path))
{
return;
}
}
catch (Exception exception)
{
Debug.LogException(exception);
}
m_FileIOProvider.WriteAllText(path, newContents);
}
private string ProjectText(ProjectPart assembly)
{
var responseFilesData = assembly.ParseResponseFileData(m_AssemblyNameProvider, ProjectDirectory).ToList();
var projectBuilder = new StringBuilder(ProjectHeader(assembly, responseFilesData));
foreach (var file in assembly.SourceFiles)
{
var fullFile = m_FileIOProvider.EscapedRelativePathFor(file, ProjectDirectory);
projectBuilder.Append(" <Compile Include=\"").Append(fullFile).Append("\" />").Append(Environment.NewLine);
}
projectBuilder.Append(assembly.AssetsProjectPart);
var responseRefs = responseFilesData.SelectMany(x => x.FullPathReferences.Select(r => r));
var internalAssemblyReferences = assembly.AssemblyReferences
.Where(reference => !reference.sourceFiles.Any(ShouldFileBePartOfSolution)).Select(i => i.outputPath);
var allReferences =
assembly.CompiledAssemblyReferences
.Union(responseRefs)
.Union(internalAssemblyReferences).ToArray();
foreach (var reference in allReferences)
{
var fullReference = Path.IsPathRooted(reference) ? reference : Path.GetFullPath(reference);
AppendReference(fullReference, projectBuilder);
}
if (0 < assembly.AssemblyReferences.Length)
{
projectBuilder.Append(" </ItemGroup>").Append(Environment.NewLine);
projectBuilder.Append(" <ItemGroup>").Append(Environment.NewLine);
foreach (var reference in assembly.AssemblyReferences.Where(i => i.sourceFiles.Any(ShouldFileBePartOfSolution)))
{
var name = m_AssemblyNameProvider.GetProjectName(reference.name, reference.defines);
projectBuilder.Append(" <ProjectReference Include=\"").Append(name).Append(GetProjectExtension()).Append("\">").Append(Environment.NewLine);
projectBuilder.Append(" <Project>{").Append(ProjectGuid(name)).Append("}</Project>").Append(Environment.NewLine);
projectBuilder.Append(" <Name>").Append(name).Append("</Name>").Append(Environment.NewLine);
projectBuilder.Append(" </ProjectReference>").Append(Environment.NewLine);
}
}
projectBuilder.Append(ProjectFooter());
return projectBuilder.ToString();
}
private static void AppendReference(string fullReference, StringBuilder projectBuilder)
{
var escapedFullPath = SecurityElement.Escape(fullReference);
escapedFullPath = escapedFullPath.NormalizePath();
projectBuilder.Append(" <Reference Include=\"").Append(FileSystemUtil.FileNameWithoutExtension(escapedFullPath))
.Append("\">").Append(Environment.NewLine);
projectBuilder.Append(" <HintPath>").Append(escapedFullPath).Append("</HintPath>").Append(Environment.NewLine);
projectBuilder.Append(" </Reference>").Append(Environment.NewLine);
}
private string ProjectFile(ProjectPart projectPart)
{
return Path.Combine(ProjectDirectory, $"{m_AssemblyNameProvider.GetProjectName(projectPart.Name, projectPart.Defines)}.csproj");
}
public string SolutionFile()
{
return Path.Combine(ProjectDirectory, $"{m_ProjectName}.sln");
}
private string ProjectHeader(
ProjectPart assembly,
List<ResponseFileData> responseFilesData
)
{
var otherResponseFilesData = GetOtherArgumentsFromResponseFilesData(responseFilesData);
var arguments = new object[]
{
k_ToolsVersion,
k_ProductVersion,
ProjectGuid(m_AssemblyNameProvider.GetProjectName(assembly.Name, assembly.Defines)),
InternalEditorUtility.GetEngineAssemblyPath(),
InternalEditorUtility.GetEditorAssemblyPath(),
string.Join(";", assembly.Defines.Concat(responseFilesData.SelectMany(x => x.Defines)).Distinct().ToArray()),
MSBuildNamespaceUri,
assembly.Name,
assembly.OutputPath,
assembly.RootNamespace,
assembly.CompilerOptions.ApiCompatibilityLevel,
GenerateLangVersion(otherResponseFilesData["langversion"], assembly),
k_BaseDirectory,
assembly.CompilerOptions.AllowUnsafeCode | responseFilesData.Any(x => x.Unsafe),
GenerateNoWarn(otherResponseFilesData["nowarn"].Distinct().ToList()),
GenerateAnalyserItemGroup(RetrieveRoslynAnalyzers(assembly, otherResponseFilesData)),
GenerateAnalyserAdditionalFiles(RetrieveAdditionalFiles(assembly, otherResponseFilesData)),
GenerateRoslynAnalyzerRulesetPath(assembly, otherResponseFilesData),
GenerateWarningLevel(otherResponseFilesData["warn"].Concat(otherResponseFilesData["w"]).Distinct()),
GenerateWarningAsError(otherResponseFilesData["warnaserror"], otherResponseFilesData["warnaserror-"], otherResponseFilesData["warnaserror+"]),
GenerateDocumentationFile(otherResponseFilesData["doc"].ToArray()),
GenerateNullable(otherResponseFilesData["nullable"]),
GenerateGlobalAnalyzerConfigFiles(assembly)
};
try
{
return string.Format(GetProjectHeaderTemplate(), arguments);
}
catch (Exception)
{
throw new NotSupportedException(
"Failed creating c# project because the c# project header did not have the correct amount of arguments, which is " +
arguments.Length);
}
}
private static string GenerateGlobalAnalyzerConfigFiles(ProjectPart assembly)
{
var configFile =
#if UNITY_2021_3 || UNITY_2022_2_OR_NEWER
assembly.CompilerOptions.AnalyzerConfigPath; // https://docs.unity3d.com/2021.3/Documentation/ScriptReference/Compilation.ScriptCompilerOptions.AnalyzerConfigPath.html
#else
string.Empty;
#endif
if (string.IsNullOrEmpty(configFile))
return string.Empty;
var builder = new StringBuilder();
builder.AppendLine(" <ItemGroup>");
builder.AppendLine($" <GlobalAnalyzerConfigFiles Include=\"{configFile}\" />");
builder.AppendLine(" </ItemGroup>");
return builder.ToString();
}
private static string[] RetrieveAdditionalFiles(ProjectPart assembly, ILookup<string, string> otherResponseFilesData)
{
return otherResponseFilesData["additionalfile"]
.SelectMany(x=>x.Split(';'))
#if UNITY_2021_3 || UNITY_2022_2_OR_NEWER // https://docs.unity3d.com/2021.3/Documentation/ScriptReference/Compilation.ScriptCompilerOptions.RoslynAdditionalFilePaths.html
.Concat(assembly.CompilerOptions.RoslynAdditionalFilePaths)
#endif
.Distinct().ToArray();
}
string[] RetrieveRoslynAnalyzers(ProjectPart assembly, ILookup<string, string> otherResponseFilesData)
{
#if UNITY_2020_2_OR_NEWER
return otherResponseFilesData["analyzer"].Concat(otherResponseFilesData["a"])
.SelectMany(x=>x.Split(';'))
#if !ROSLYN_ANALYZER_FIX
.Concat(m_AssemblyNameProvider.GetRoslynAnalyzerPaths())
#else
.Concat(assembly.CompilerOptions.RoslynAnalyzerDllPaths)
#endif
.Select(MakeAbsolutePath)
.Distinct()
.ToArray();
#else
return otherResponseFilesData["analyzer"].Concat(otherResponseFilesData["a"])
.SelectMany(x=>x.Split(';'))
.Distinct()
.Select(MakeAbsolutePath)
.ToArray();
#endif
}
private static string MakeAbsolutePath(string path)
{
return Path.IsPathRooted(path) ? path : Path.GetFullPath(path);
}
private string GenerateRoslynAnalyzerRulesetPath(ProjectPart assembly, ILookup<string, string> otherResponseFilesData)
{
#if UNITY_2020_2_OR_NEWER
return GenerateAnalyserRuleSet(otherResponseFilesData["ruleset"].Append(assembly.CompilerOptions.RoslynAnalyzerRulesetPath).Where(a=>!string.IsNullOrEmpty(a)).Distinct().Select(x => MakeAbsolutePath(x).NormalizePath()).ToArray());
#else
return GenerateAnalyserRuleSet(otherResponseFilesData["ruleset"].Distinct().Select(x => MakeAbsolutePath(x).NormalizePath()).ToArray());
#endif
}
private string GenerateNullable(IEnumerable<string> enumerable)
{
var val = enumerable.FirstOrDefault();
if (string.IsNullOrWhiteSpace(val))
return string.Empty;
return $"{Environment.NewLine} <Nullable>{val}</Nullable>";
}
private static string GenerateDocumentationFile(string[] paths)
{
if (!paths.Any())
return String.Empty;
return $"{Environment.NewLine}{string.Join(Environment.NewLine, paths.Select(a => $" <DocumentationFile>{a}</DocumentationFile>"))}";
}
private static string GenerateWarningAsError(IEnumerable<string> args, IEnumerable<string> argsMinus, IEnumerable<string> argsPlus)
{
var returnValue = String.Empty;
var allWarningsAsErrors = false;
var warningIds = new List<string>();
foreach (var s in args)
{
if (s == "+" || s == string.Empty) allWarningsAsErrors = true;
else if (s == "-") allWarningsAsErrors = false;
else
{
warningIds.Add(s);
}
}
warningIds.AddRange(argsPlus);
returnValue += $@" <TreatWarningsAsErrors>{allWarningsAsErrors}</TreatWarningsAsErrors>";
if (warningIds.Any())
{
returnValue += $"{Environment.NewLine} <WarningsAsErrors>{string.Join(";", warningIds)}</WarningsAsErrors>";
}
if (argsMinus.Any())
returnValue += $"{Environment.NewLine} <WarningsNotAsErrors>{string.Join(";", argsMinus)}</WarningsNotAsErrors>";
return $"{Environment.NewLine}{returnValue}";
}
private static string GenerateWarningLevel(IEnumerable<string> warningLevel)
{
var level = warningLevel.FirstOrDefault();
if (!string.IsNullOrWhiteSpace(level))
return level;
return 4.ToString();
}
private static string GetSolutionText()
{
return string.Join(Environment.NewLine,
@"",
@"Microsoft Visual Studio Solution File, Format Version {0}",
@"# Visual Studio {1}",
@"{2}",
@"Global",
@" GlobalSection(SolutionConfigurationPlatforms) = preSolution",
@" Debug|Any CPU = Debug|Any CPU",
@" EndGlobalSection",
@" GlobalSection(ProjectConfigurationPlatforms) = postSolution",
@"{3}",
@" EndGlobalSection",
@" GlobalSection(SolutionProperties) = preSolution",
@" HideSolutionNode = FALSE",
@" EndGlobalSection",
@"EndGlobal",
@"").Replace(" ", "\t");
}
private static string GetProjectFooterTemplate()
{
return string.Join(Environment.NewLine,
@" </ItemGroup>",
@" <Import Project=""$(MSBuildToolsPath)\Microsoft.CSharp.targets"" />",
@" <!-- To modify your build process, add your task inside one of the targets below and uncomment it.",
@" Other similar extension points exist, see Microsoft.Common.targets.",
@" <Target Name=""BeforeBuild"">",
@" </Target>",
@" <Target Name=""AfterBuild"">",
@" </Target>",
@" -->",
@"</Project>",
@"");
}
private static string GetProjectHeaderTemplate()
{
var header = new[]
{
@"<?xml version=""1.0"" encoding=""utf-8""?>",
@"<Project ToolsVersion=""{0}"" DefaultTargets=""Build"" xmlns=""{6}"">",
@" <PropertyGroup>",
@" <LangVersion>{11}</LangVersion>",
@" <_TargetFrameworkDirectories>non_empty_path_generated_by_unity.rider.package</_TargetFrameworkDirectories>",
@" <_FullFrameworkReferenceAssemblyPaths>non_empty_path_generated_by_unity.rider.package</_FullFrameworkReferenceAssemblyPaths>",
@" <DisableHandlePackageFileConflicts>true</DisableHandlePackageFileConflicts>{17}",
@" </PropertyGroup>",
@" <PropertyGroup>",
@" <Configuration Condition="" '$(Configuration)' == '' "">Debug</Configuration>",
@" <Platform Condition="" '$(Platform)' == '' "">AnyCPU</Platform>",
@" <ProductVersion>{1}</ProductVersion>",
@" <SchemaVersion>2.0</SchemaVersion>",
@" <RootNamespace>{9}</RootNamespace>",
@" <ProjectGuid>{{{2}}}</ProjectGuid>",
@" <ProjectTypeGuids>{{E097FAD1-6243-4DAD-9C02-E9B9EFC3FFC1}};{{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}}</ProjectTypeGuids>",
@" <OutputType>Library</OutputType>",
@" <AppDesignerFolder>Properties</AppDesignerFolder>",
@" <AssemblyName>{7}</AssemblyName>",
@" <TargetFrameworkVersion>v4.7.1</TargetFrameworkVersion>",
@" <FileAlignment>512</FileAlignment>",
@" <BaseDirectory>{12}</BaseDirectory>",
@" </PropertyGroup>",
@" <PropertyGroup Condition="" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' "">",
@" <DebugSymbols>true</DebugSymbols>",
@" <DebugType>full</DebugType>",
@" <Optimize>false</Optimize>",
@" <OutputPath>{8}</OutputPath>",
@" <DefineConstants>{5}</DefineConstants>",
@" <ErrorReport>prompt</ErrorReport>",
@" <WarningLevel>{18}</WarningLevel>",
@" <NoWarn>{14}</NoWarn>",
@" <AllowUnsafeBlocks>{13}</AllowUnsafeBlocks>{19}{20}{21}",
@" </PropertyGroup>"
};
var forceExplicitReferences = new[]
{
@" <PropertyGroup>",
@" <NoConfig>true</NoConfig>",
@" <NoStdLib>true</NoStdLib>",
@" <AddAdditionalExplicitAssemblyReferences>false</AddAdditionalExplicitAssemblyReferences>",
@" <ImplicitlyExpandNETStandardFacades>false</ImplicitlyExpandNETStandardFacades>",
@" <ImplicitlyExpandDesignTimeFacades>false</ImplicitlyExpandDesignTimeFacades>",
@" </PropertyGroup>"
};
var footer = new[]
{
@"{15}{16}{22} <ItemGroup>",
@""
};
var pieces = header.Concat(forceExplicitReferences).Concat(footer).ToArray();
return string.Join(Environment.NewLine, pieces);
}
private void SyncSolution(ProjectPart[] islands, Type[] types)
{
SyncSolutionFileIfNotChanged(SolutionFile(), SolutionText(islands), types);
}
private string SolutionText(ProjectPart[] islands)
{
var fileversion = "11.00";
var vsversion = "2010";
var projectEntries = GetProjectEntries(islands);
var projectConfigurations = string.Join(Environment.NewLine,
islands.Select(i => GetProjectActiveConfigurations(ProjectGuid(m_AssemblyNameProvider.GetProjectName(i.Name, i.Defines)))).ToArray());
return string.Format(GetSolutionText(), fileversion, vsversion, projectEntries, projectConfigurations);
}
private static string GenerateAnalyserItemGroup(string[] paths)
{
// <ItemGroup>
// <Analyzer Include="..\packages\Comments_analyser.1.0.6626.21356\analyzers\dotnet\cs\Comments_analyser.dll" />
// <Analyzer Include="..\packages\UnityEngineAnalyzer.1.0.0.0\analyzers\dotnet\cs\UnityEngineAnalyzer.dll" />
// </ItemGroup>
if (!paths.Any())
return string.Empty;
var analyserBuilder = new StringBuilder();
analyserBuilder.AppendLine(" <ItemGroup>");
foreach (var path in paths)
{
analyserBuilder.AppendLine($" <Analyzer Include=\"{path.NormalizePath()}\" />");
}
analyserBuilder.AppendLine(" </ItemGroup>");
return analyserBuilder.ToString();
}
private static ILookup<string, string> GetOtherArgumentsFromResponseFilesData(List<ResponseFileData> responseFilesData)
{
var paths = responseFilesData.SelectMany(x =>
{
return x.OtherArguments
.Where(a => a.StartsWith("/", StringComparison.Ordinal) || a.StartsWith("-", StringComparison.Ordinal))
.Select(b =>
{
var index = b.IndexOf(":", StringComparison.Ordinal);
if (index > 0 && b.Length > index)
{
var key = b.Substring(1, index - 1);
return new KeyValuePair<string, string>(key, b.Substring(index + 1));
}
const string warnaserror = "warnaserror";
if (b.Substring(1).StartsWith(warnaserror, StringComparison.Ordinal))
{
return new KeyValuePair<string, string>(warnaserror, b.Substring(warnaserror.Length + 1));
}
const string nullable = "nullable";
if (b.Substring(1).StartsWith(nullable, StringComparison.Ordinal))
{
var res = b.Substring(nullable.Length + 1);
if (string.IsNullOrWhiteSpace(res) || res.Equals("+"))
res = "enable";
else if (res.Equals("-"))
res = "disable";
return new KeyValuePair<string, string>(nullable, res);
}
return default;
});
})
.Distinct()
.ToLookup(o => o.Key, pair => pair.Value);
return paths;
}
private string GenerateLangVersion(IEnumerable<string> langVersionList, ProjectPart assembly)
{
var langVersion = langVersionList.FirstOrDefault();
if (!string.IsNullOrWhiteSpace(langVersion))
return langVersion;
#if UNITY_2020_2_OR_NEWER
return assembly.CompilerOptions.LanguageVersion;
#else
return k_TargetLanguageVersion;
#endif
}
private static string GenerateAnalyserRuleSet(string[] paths)
{
//<CodeAnalysisRuleSet>..\path\to\myrules.ruleset</CodeAnalysisRuleSet>
if (!paths.Any())
return string.Empty;
return $"{Environment.NewLine}{string.Join(Environment.NewLine, paths.Select(a => $" <CodeAnalysisRuleSet>{a}</CodeAnalysisRuleSet>"))}";
}
private static string GenerateAnalyserAdditionalFiles(string[] paths)
{
if (!paths.Any())
return string.Empty;
var analyserBuilder = new StringBuilder();
analyserBuilder.AppendLine(" <ItemGroup>");
foreach (var path in paths)
{
analyserBuilder.AppendLine($" <AdditionalFiles Include=\"{path}\" />");
}
analyserBuilder.AppendLine(" </ItemGroup>");
return analyserBuilder.ToString();
}
public static string GenerateNoWarn(List<string> codes)
{
#if UNITY_2020_1 // RIDER-77206 Unity 2020.1.3 'PlayerSettings' does not contain a definition for 'suppressCommonWarnings'
var type = typeof(PlayerSettings);
var propertyInfo = type.GetProperty("suppressCommonWarnings");
if (propertyInfo != null && propertyInfo.GetValue(null) is bool && (bool)propertyInfo.GetValue(null))
{
codes.AddRange(new[] {"0169", "0649"});
}
#elif UNITY_2020_2_OR_NEWER
if (PlayerSettings.suppressCommonWarnings)
codes.AddRange(new[] {"0169", "0649"});
#endif
if (!codes.Any())
return string.Empty;
return string.Join(",", codes.Distinct());
}
private string GetProjectEntries(ProjectPart[] islands)
{
var projectEntries = islands.Select(i => string.Format(
m_SolutionProjectEntryTemplate,
SolutionGuidGenerator.GuidForSolution(),
i.Name,
Path.GetFileName(ProjectFile(i)),
ProjectGuid(m_AssemblyNameProvider.GetProjectName(i.Name, i.Defines))
));
return string.Join(Environment.NewLine, projectEntries.ToArray());
}
/// <summary>
/// Generate the active configuration string for a given project guid
/// </summary>
private string GetProjectActiveConfigurations(string projectGuid)
{
return string.Format(
m_SolutionProjectConfigurationTemplate,
projectGuid);
}
private static string ProjectFooter()
{
return GetProjectFooterTemplate();
}
private static string GetProjectExtension()
{
return ".csproj";
}
private string ProjectGuid(string name)
{
return m_GUIDGenerator.ProjectGuid(m_ProjectName + name);
}
}
}
|