Add 'CsWinRTRcwFactoryFallbackGeneratorForceOptOut' (#1567)

microsoft · Apr 30, 2024 · d5cf359 · d5cf359
1 parent 64a5e32
commit d5cf359
Show file tree

Hide file tree

Showing 4 changed files with 194 additions and 171 deletions.
diff --git a/nuget/Microsoft.Windows.CsWinRT.targets b/nuget/Microsoft.Windows.CsWinRT.targets
@@ -28,6 +28,7 @@ Copyright (C) Microsoft Corporation. All rights reserved.
 
  <!-- Set the RCW factory fallback generator to not be opt-in by default -->
  <CsWinRTRcwFactoryFallbackGeneratorForceOptIn Condition="'$(CsWinRTRcwFactoryFallbackGeneratorForceOptIn)' != 'true'">false</CsWinRTRcwFactoryFallbackGeneratorForceOptIn>
+ <CsWinRTRcwFactoryFallbackGeneratorForceOptOut Condition="'$(CsWinRTRcwFactoryFallbackGeneratorForceOptOut)' != 'true'">false</CsWinRTRcwFactoryFallbackGeneratorForceOptOut>
 
  <!--
  These properties are defined in this property group and not in the 'CsWinRTGenerateProjection'
@@ -46,6 +47,7 @@ Copyright (C) Microsoft Corporation. All rights reserved.
  <CompilerVisibleProperty Include="CsWinRTAotOptimizerEnabled" />
  <CompilerVisibleProperty Include="CsWinRTAotExportsEnabled" />
  <CompilerVisibleProperty Include="CsWinRTRcwFactoryFallbackGeneratorForceOptIn" />
+ <CompilerVisibleProperty Include="CsWinRTRcwFactoryFallbackGeneratorForceOptOut" />
  </ItemGroup>
 
  <Import Project="$(MSBuildThisFileDirectory)Microsoft.Windows.CsWinRT.Embedded.targets" Condition="'$(CsWinRTEmbedded)' == 'true'"/>

diff --git a/nuget/readme.md b/nuget/readme.md
@@ -46,6 +46,7 @@ C#/WinRT behavior can be customized with these project properties:
 | CsWinRTGeneratedFilesDir | *"$(IntermediateOutputPath)\Generated Files" | Specifies the location for generated project source files |
 | CsWinRTIIDOptimizerOptOut | true \| *false | Determines whether to run the IIDOptimizer on the projection assembly |
 | CsWinRTRcwFactoryFallbackGeneratorForceOptIn | true \| *false | Forces the RCW factory fallback generator to be enabled (it only runs on .exe projects by default) |
+| CsWinRTRcwFactoryFallbackGeneratorForceOptOut | true \| *false | Forces the RCW factory fallback generator to be disabled (overrides "ForceOptIn" as well) |
 \*Default value
 
 **If CsWinRTFilters is not defined, the following effective value is used:

diff --git a/src/Authoring/WinRT.SourceGenerator/Helper.cs b/src/Authoring/WinRT.SourceGenerator/Helper.cs
@@ -1,188 +1,198 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
-
-using Microsoft.CodeAnalysis;
-using Microsoft.CodeAnalysis.CSharp;
+
+using Microsoft.CodeAnalysis;
+using Microsoft.CodeAnalysis.CSharp;
 using Microsoft.CodeAnalysis.CSharp.Syntax;
 using Microsoft.CodeAnalysis.Diagnostics;
-using System;
-using System.Collections.Generic;
-using System.Diagnostics.CodeAnalysis;
-using System.IO;
-using System.Linq;
+using System;
+using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
+using System.IO;
+using System.Linq;
 using System.Text.RegularExpressions;
 
-namespace Generator
-{
- public static class Helper
- {
- public static Guid EncodeGuid(byte[] data)
- {
- if (BitConverter.IsLittleEndian)
- {
- // swap bytes of int a
- byte t = data[0];
- data[0] = data[3];
- data[3] = t;
- t = data[1];
- data[1] = data[2];
- data[2] = t;
- // swap bytes of short b
- t = data[4];
- data[4] = data[5];
- data[5] = t;
- // swap bytes of short c and encode rfc time/version field
- t = data[6];
- data[6] = data[7];
- data[7] = (byte)((t & 0x0f) | (5 << 4));
- // encode rfc clock/reserved field
- data[8] = (byte)((data[8] & 0x3f) | 0x80);
- }
- return new Guid(data.Take(16).ToArray());
- }
- }
-
- class AttributeDataComparer : IEqualityComparer<AttributeData>
- {
- public bool Equals(AttributeData x, AttributeData y)
- {
- return string.CompareOrdinal(x.ToString(), y.ToString()) == 0;
- }
-
- public int GetHashCode(AttributeData obj)
- {
- return obj.ToString().GetHashCode();
- }
- }
-
- static class GeneratorExecutionContextHelper
- {
- public static string GetAssemblyName(this GeneratorExecutionContext context)
- {
- context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.AssemblyName", out var assemblyName);
- return assemblyName;
- }
-
- public static string GetAssemblyVersion(this GeneratorExecutionContext context)
- {
- context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.AssemblyVersion", out var assemblyVersion);
- return assemblyVersion;
- }
-
- [SuppressMessage("MicrosoftCodeAnalysisCorrectness", "RS1035", Justification = "We need to do file IO to invoke the 'cswinrt' tool.")]
- public static string GetGeneratedFilesDir(this GeneratorExecutionContext context)
- {
- context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.CsWinRTGeneratedFilesDir", out var generatedFilesDir);
- Directory.CreateDirectory(generatedFilesDir);
- return generatedFilesDir;
- }
-
- public static string GetCsWinRTExeTFM(this GeneratorExecutionContext context)
- {
- context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.CsWinRTExeTFM", out var csWinRTExeTFM);
- return csWinRTExeTFM;
- }
-
- public static bool IsCsWinRTComponent(this GeneratorExecutionContext context)
- {
- if (context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.CsWinRTComponent", out var isCsWinRTComponentStr))
- {
- return bool.TryParse(isCsWinRTComponentStr, out var isCsWinRTComponent) && isCsWinRTComponent;
- }
-
- return false;
- }
-
- public static bool IsCsWinRTComponent(this AnalyzerConfigOptionsProvider provider)
- {
- if (provider.GlobalOptions.TryGetValue("build_property.CsWinRTComponent", out var isCsWinRTComponentStr))
- {
- return bool.TryParse(isCsWinRTComponentStr, out var isCsWinRTComponent) && isCsWinRTComponent;
- }
-
- return false;
- }
-
- public static bool IsCsWinRTAotOptimizerEnabled(this AnalyzerConfigOptionsProvider provider)
- {
- if (provider.GlobalOptions.TryGetValue("build_property.CsWinRTAotOptimizerEnabled", out var isCsWinRTAotOptimizerEnabledStr))
- {
- return bool.TryParse(isCsWinRTAotOptimizerEnabledStr, out var isCsWinRTAotOptimizerEnabled) && isCsWinRTAotOptimizerEnabled;
- }
-
- return false;
- }
-
- public static bool GetCsWinRTRcwFactoryFallbackGeneratorForceOptIn(this AnalyzerConfigOptionsProvider provider)
- {
- if (provider.GlobalOptions.TryGetValue("build_property.CsWinRTRcwFactoryFallbackGeneratorForceOptIn", out var csWinRTRcwFactoryFallbackGeneratorForceOptIn))
- {
- return bool.TryParse(csWinRTRcwFactoryFallbackGeneratorForceOptIn, out var isCsWinRTRcwFactoryFallbackGeneratorForceOptIn) && isCsWinRTRcwFactoryFallbackGeneratorForceOptIn;
- }
-
- return false;
- }
-
- public static bool ShouldGenerateWinMDOnly(this GeneratorExecutionContext context)
- {
- if (context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.CsWinRTGenerateWinMDOnly", out var CsWinRTGenerateWinMDOnlyStr))
- {
- return bool.TryParse(CsWinRTGenerateWinMDOnlyStr, out var CsWinRTGenerateWinMDOnly) && CsWinRTGenerateWinMDOnly;
- }
-
- return false;
+namespace Generator
+{
+ public static class Helper
+ {
+ public static Guid EncodeGuid(byte[] data)
+ {
+ if (BitConverter.IsLittleEndian)
+ {
+ // swap bytes of int a
+ byte t = data[0];
+ data[0] = data[3];
+ data[3] = t;
+ t = data[1];
+ data[1] = data[2];
+ data[2] = t;
+ // swap bytes of short b
+ t = data[4];
+ data[4] = data[5];
+ data[5] = t;
+ // swap bytes of short c and encode rfc time/version field
+ t = data[6];
+ data[6] = data[7];
+ data[7] = (byte)((t & 0x0f) | (5 << 4));
+ // encode rfc clock/reserved field
+ data[8] = (byte)((data[8] & 0x3f) | 0x80);
+ }
+ return new Guid(data.Take(16).ToArray());
+ }
+ }
+
+ class AttributeDataComparer : IEqualityComparer<AttributeData>
+ {
+ public bool Equals(AttributeData x, AttributeData y)
+ {
+ return string.CompareOrdinal(x.ToString(), y.ToString()) == 0;
+ }
+
+ public int GetHashCode(AttributeData obj)
+ {
+ return obj.ToString().GetHashCode();
+ }
+ }
+
+ static class GeneratorExecutionContextHelper
+ {
+ public static string GetAssemblyName(this GeneratorExecutionContext context)
+ {
+ context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.AssemblyName", out var assemblyName);
+ return assemblyName;
+ }
+
+ public static string GetAssemblyVersion(this GeneratorExecutionContext context)
+ {
+ context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.AssemblyVersion", out var assemblyVersion);
+ return assemblyVersion;
+ }
+
+ [SuppressMessage("MicrosoftCodeAnalysisCorrectness", "RS1035", Justification = "We need to do file IO to invoke the 'cswinrt' tool.")]
+ public static string GetGeneratedFilesDir(this GeneratorExecutionContext context)
+ {
+ context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.CsWinRTGeneratedFilesDir", out var generatedFilesDir);
+ Directory.CreateDirectory(generatedFilesDir);
+ return generatedFilesDir;
+ }
+
+ public static string GetCsWinRTExeTFM(this GeneratorExecutionContext context)
+ {
+ context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.CsWinRTExeTFM", out var csWinRTExeTFM);
+ return csWinRTExeTFM;
+ }
+
+ public static bool IsCsWinRTComponent(this GeneratorExecutionContext context)
+ {
+ if (context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.CsWinRTComponent", out var isCsWinRTComponentStr))
+ {
+ return bool.TryParse(isCsWinRTComponentStr, out var isCsWinRTComponent) && isCsWinRTComponent;
+ }
+
+ return false;
+ }
+
+ public static bool IsCsWinRTComponent(this AnalyzerConfigOptionsProvider provider)
+ {
+ if (provider.GlobalOptions.TryGetValue("build_property.CsWinRTComponent", out var isCsWinRTComponentStr))
+ {
+ return bool.TryParse(isCsWinRTComponentStr, out var isCsWinRTComponent) && isCsWinRTComponent;
+ }
+
+ return false;
+ }
+
+ public static bool IsCsWinRTAotOptimizerEnabled(this AnalyzerConfigOptionsProvider provider)
+ {
+ if (provider.GlobalOptions.TryGetValue("build_property.CsWinRTAotOptimizerEnabled", out var isCsWinRTAotOptimizerEnabledStr))
+ {
+ return bool.TryParse(isCsWinRTAotOptimizerEnabledStr, out var isCsWinRTAotOptimizerEnabled) && isCsWinRTAotOptimizerEnabled;
+ }
+
+ return false;
+ }
+
+ public static bool GetCsWinRTRcwFactoryFallbackGeneratorForceOptIn(this AnalyzerConfigOptionsProvider provider)
+ {
+ if (provider.GlobalOptions.TryGetValue("build_property.CsWinRTRcwFactoryFallbackGeneratorForceOptIn", out var csWinRTRcwFactoryFallbackGeneratorForceOptIn))
+ {
+ return bool.TryParse(csWinRTRcwFactoryFallbackGeneratorForceOptIn, out var isCsWinRTRcwFactoryFallbackGeneratorForceOptIn) && isCsWinRTRcwFactoryFallbackGeneratorForceOptIn;
+ }
+
+ return false;
+ }
+
+ public static bool GetCsWinRTRcwFactoryFallbackGeneratorForceOptOut(this AnalyzerConfigOptionsProvider provider)
+ {
+ if (provider.GlobalOptions.TryGetValue("build_property.CsWinRTRcwFactoryFallbackGeneratorForceOptOut", out var csWinRTRcwFactoryFallbackGeneratorForceOptOut))
+ {
+ return bool.TryParse(csWinRTRcwFactoryFallbackGeneratorForceOptOut, out var isCsWinRTRcwFactoryFallbackGeneratorForceOptOut) && isCsWinRTRcwFactoryFallbackGeneratorForceOptOut;
+ }
+
+ return false;
+ }
+
+ public static bool ShouldGenerateWinMDOnly(this GeneratorExecutionContext context)
+ {
+ if (context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.CsWinRTGenerateWinMDOnly", out var CsWinRTGenerateWinMDOnlyStr))
+ {
+ return bool.TryParse(CsWinRTGenerateWinMDOnlyStr, out var CsWinRTGenerateWinMDOnly) && CsWinRTGenerateWinMDOnly;
+ }
+
+ return false;
  }
 
  /// <summary>
  /// Gets whether the <c>"CsWinRTAotExportsEnabled"</c> MSBuild property is defined.
  /// </summary>
  /// <param name="context">The input <see cref="GeneratorExecutionContext"/> value to use.</param>
  /// <returns>Whether the <c>"CsWinRTAotExportsEnabled"</c> MSBuild property is defined.</returns>
- public static bool ShouldGenerateWinRTNativeExports(this GeneratorExecutionContext context)
- {
- if (context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.CsWinRTAotExportsEnabled", out var isCsWinRTAotExportsEnabledStr))
- {
- return bool.TryParse(isCsWinRTAotExportsEnabledStr, out var isCsWinRTAotExportsEnabled) && isCsWinRTAotExportsEnabled;
- }
-
- return false;
- }
-
- public static string GetCsWinRTExe(this GeneratorExecutionContext context)
- {
- context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.CsWinRTExe", out var cswinrtExe);
- return cswinrtExe;
- }
-
- public static bool GetKeepGeneratedSources(this GeneratorExecutionContext context)
- {
- context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.CsWinRTKeepGeneratedSources", out var keepGeneratedSourcesStr);
- return keepGeneratedSourcesStr != null && bool.TryParse(keepGeneratedSourcesStr, out var keepGeneratedSources) && keepGeneratedSources;
- }
-
- public static string GetCsWinRTWindowsMetadata(this GeneratorExecutionContext context)
- {
- context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.CsWinRTWindowsMetadata", out var cswinrtWindowsMetadata);
- return cswinrtWindowsMetadata;
- }
-
- public static string GetCsWinRTDependentMetadata(this GeneratorExecutionContext context)
- {
- context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.CsWinRTAuthoringInputs", out var winmds);
- return winmds;
- }
-
- public static string GetWinmdOutputFile(this GeneratorExecutionContext context)
- {
+ public static bool ShouldGenerateWinRTNativeExports(this GeneratorExecutionContext context)
+ {
+ if (context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.CsWinRTAotExportsEnabled", out var isCsWinRTAotExportsEnabledStr))
+ {
+ return bool.TryParse(isCsWinRTAotExportsEnabledStr, out var isCsWinRTAotExportsEnabled) && isCsWinRTAotExportsEnabled;
+ }
+
+ return false;
+ }
+
+ public static string GetCsWinRTExe(this GeneratorExecutionContext context)
+ {
+ context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.CsWinRTExe", out var cswinrtExe);
+ return cswinrtExe;
+ }
+
+ public static bool GetKeepGeneratedSources(this GeneratorExecutionContext context)
+ {
+ context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.CsWinRTKeepGeneratedSources", out var keepGeneratedSourcesStr);
+ return keepGeneratedSourcesStr != null && bool.TryParse(keepGeneratedSourcesStr, out var keepGeneratedSources) && keepGeneratedSources;
+ }
+
+ public static string GetCsWinRTWindowsMetadata(this GeneratorExecutionContext context)
+ {
+ context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.CsWinRTWindowsMetadata", out var cswinrtWindowsMetadata);
+ return cswinrtWindowsMetadata;
+ }
+
+ public static string GetCsWinRTDependentMetadata(this GeneratorExecutionContext context)
+ {
+ context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.CsWinRTAuthoringInputs", out var winmds);
+ return winmds;
+ }
+
+ public static string GetWinmdOutputFile(this GeneratorExecutionContext context)
+ {
  var fileName = context.GetAssemblyName();
  if (context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.CsWinRTWinMDOutputFile", out var ret))
  {
  fileName = ret!;
- }
- return Path.Combine(context.GetGeneratedFilesDir(), fileName + ".winmd");
- }
- }
-
+ }
+ return Path.Combine(context.GetGeneratedFilesDir(), fileName + ".winmd");
+ }
+ }
+
  static class GeneratorHelper
  {
  private static bool IsFundamentalType(ISymbol type)
@@ -924,5 +934,5 @@ internal static (string, string, string, bool, bool) GetSystemTypeCustomMapping(
  { "System.Collections.Generic.IList`1", new MappedType("Windows.Foundation.Collections", "IVector`1", "Windows.Foundation.FoundationContract") },
  { "Windows.UI.Color", new MappedType("Windows.UI", "Color", "Windows.Foundation.UniversalApiContract", true, true) },
  };
- }
-}
+ }
+}