Add WinUI 2.6 animated icon support. (#412)

* Add support for WinUI 2.6 animated icon.

This also removes the ability to set a custom interface in place of the WinUI
interface, because nobody seems to need it now, and it adds a bunch of
complexity.

Author: Simeon

LottieGen/CommandLineOptions.cs

@@ -6,28 +6,12 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
-
-internal enum Lang
-{
-    // Language wasn't recognized.
-    Unknown,
-
-    // Language specified was ambigious.
-    Ambiguous,
-
-    CSharp,
-    Cx,
-    Cppwinrt,
-    LottieYaml,
-    WinCompDgml,
-    Stats,
-}
+using Microsoft.Toolkit.Uwp.UI.Lottie.UIData.CodeGen.CSharp;
 
 sealed class CommandLineOptions
 {
     readonly List<string> _additionalInterfaces = new List<string>();
     readonly List<string> _languageStrings = new List<string>();
-    string? _interfaceBaseName;
     Version? _winUIVersion;
 
     internal IReadOnlyList<string> AdditionalInterfaces => _additionalInterfaces;
@@ -48,9 +32,7 @@ sealed class CommandLineOptions
 
     internal string? InputFile { get; private set; }
 
-    internal string InterfaceBaseName => _interfaceBaseName ?? "Microsoft.UI.Xaml.Controls.IAnimatedVisual";
-
-    internal IReadOnlyList<Lang> Languages { get; private set; } = Array.Empty<Lang>();
+    internal IReadOnlyList<Language> Languages { get; private set; } = Array.Empty<Language>();
 
     internal uint? MinimumUapVersion { get; private set; }
 
@@ -84,7 +66,7 @@ sealed class CommandLineOptions
     // for adding to generated code so that users can regenerate the code and know that
     // they got the set of options the same as a previous run. It does not include the
     // InputFile, OutputFolder, or Language options.
-    internal string ToConfigurationCommandLine(string languageSwitch)
+    internal string ToConfigurationCommandLine(Language languageSwitch)
     {
         var sb = new StringBuilder();
         sb.Append(ThisAssembly.AssemblyName);
@@ -117,8 +99,6 @@ internal string ToConfigurationCommandLine(string languageSwitch)
             sb.Append($" -{nameof(GenerateDependencyObject)}");
         }
 
-        sb.Append($" -{nameof(InterfaceBaseName)} {InterfaceBaseName}");
-
         sb.Append($" -Language {languageSwitch}");
 
         if (MinimumUapVersion.HasValue)
@@ -131,18 +111,28 @@ internal string ToConfigurationCommandLine(string languageSwitch)
             sb.Append($" -{nameof(Namespace)} {Namespace}");
         }
 
-        // The -Public switch is ignored for c++.
-        if (Public &&
-            !(languageSwitch.Equals("cppwinrt", StringComparison.OrdinalIgnoreCase) ||
-                languageSwitch.Equals("cx", StringComparison.OrdinalIgnoreCase)))
+        switch (languageSwitch)
         {
-            sb.Append($" -{nameof(Public)}");
+            case Language.Cx:
+            case Language.Cppwinrt:
+                // The -Public switch is ignored for c++.
+                break;
+
+            default:
+                sb.Append($" -{nameof(Public)}");
+                break;
         }
 
-        // The -RootNamespace parameter is only used for cppwinrt.
-        if (!string.IsNullOrWhiteSpace(RootNamespace) && languageSwitch.Equals("cppwinrt", StringComparison.OrdinalIgnoreCase))
+        switch (languageSwitch)
         {
-            sb.Append($" -{nameof(RootNamespace)} {RootNamespace}");
+            case Language.Cppwinrt:
+                // The -RootNamespace parameter is only used for cppwinrt.
+                if (!string.IsNullOrWhiteSpace(RootNamespace))
+                {
+                    sb.Append($" -{nameof(RootNamespace)} {RootNamespace}");
+                }
+
+                break;
         }
 
         if (StrictMode)
@@ -201,17 +191,17 @@ internal static CommandLineOptions ParseCommandLine(string[] args)
         result.ParseCommandLineStrings(args);
 
         // Convert the language strings to language values.
-        var languageTokenizer = new CommandlineTokenizer<Lang>(Lang.Ambiguous)
-                .AddKeyword(Lang.CSharp)
-                .AddKeyword(Lang.Cx, "cppcx")
-                .AddKeyword(Lang.Cx)
-                .AddKeyword(Lang.Cppwinrt)
-                .AddKeyword(Lang.Cppwinrt, "winrtcpp")
-                .AddKeyword(Lang.LottieYaml)
-                .AddKeyword(Lang.WinCompDgml, "dgml")
-                .AddKeyword(Lang.Stats);
-
-        var languages = new List<Lang>();
+        var languageTokenizer = new CommandlineTokenizer<Language>(Language.Ambiguous)
+                .AddKeyword(Language.CSharp)
+                .AddKeyword(Language.Cx, "cppcx")
+                .AddKeyword(Language.Cx)
+                .AddKeyword(Language.Cppwinrt)
+                .AddKeyword(Language.Cppwinrt, "winrtcpp")
+                .AddKeyword(Language.LottieYaml)
+                .AddKeyword(Language.WinCompDgml, "dgml")
+                .AddKeyword(Language.Stats);
+
+        var languages = new List<Language>();
 
         // Parse the language string.
         foreach (var languageString in result._languageStrings)
@@ -220,10 +210,10 @@ internal static CommandLineOptions ParseCommandLine(string[] args)
             languages.Add(language);
             switch (language)
             {
-                case Lang.Unknown:
+                case Language.Unknown:
                     result.ErrorDescription = $"Unrecognized language: {languageString}";
                     break;
-                case Lang.Ambiguous:
+                case Language.Ambiguous:
                     result.ErrorDescription = $"Ambiguous language: {languageString}";
                     break;
             }
@@ -342,16 +332,6 @@ void ParseCommandLineStrings(string[] args)
                     InputFile = arg;
                     previousKeyword = Keyword.None;
                     break;
-                case Keyword.Interface:
-                    if (_interfaceBaseName != null)
-                    {
-                        ErrorDescription = ArgumentSpecifiedMoreThanOnce("Interface base name");
-                        return;
-                    }
-
-                    _interfaceBaseName = arg;
-                    previousKeyword = Keyword.None;
-                    break;
                 case Keyword.Language:
                     _languageStrings.Add(arg);
                     previousKeyword = Keyword.None;
@@ -424,6 +404,7 @@ void ParseCommandLineStrings(string[] args)
 
                     previousKeyword = Keyword.None;
                     break;
+
                 case Keyword.WinUIVersion:
                     if (_winUIVersion != null)
                     {

LottieGen/Language.cs

@@ -0,0 +1,19 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+enum Language
+{
+    // Language wasn't recognized.
+    Unknown,
+
+    // Language specified was ambigious.
+    Ambiguous,
+
+    CSharp,
+    Cx,
+    Cppwinrt,
+    LottieYaml,
+    WinCompDgml,
+    Stats,
+}

LottieGen/LottieJsonFileProcessor.cs

@@ -144,18 +144,18 @@ bool TryGenerateCode(LottieComposition lottieComposition)
 
         var codeGenSucceeded = true;
 
-        var areBothCppwinrtAndCxRequested = _options.Languages.Where(l => l == Lang.Cppwinrt || l == Lang.Cx).Count() == 2;
+        var areBothCppwinrtAndCxRequested = _options.Languages.Where(l => l == Language.Cppwinrt || l == Language.Cx).Count() == 2;
 
         foreach (var lang in _options.Languages)
         {
             switch (lang)
             {
-                case Lang.CSharp:
+                case Language.CSharp:
                     codeGenSucceeded &= TryGenerateCSharpCode(lottieComposition, $"{outputFileBase}.cs");
                     _profiler.OnCodeGenFinished();
                     break;
 
-                case Lang.Cx:
+                case Language.Cx:
                     {
                         // If both cppwinrt and cx files were requested, add a differentiator to
                         // the folder name for the cx files to make their names distinct from the
@@ -176,22 +176,22 @@ bool TryGenerateCode(LottieComposition lottieComposition)
                         break;
                     }
 
-                case Lang.Cppwinrt:
+                case Language.Cppwinrt:
                     codeGenSucceeded &= TryGenerateCppwinrtCode(lottieComposition, _outputFolder);
                     _profiler.OnCodeGenFinished();
                     break;
 
-                case Lang.LottieYaml:
+                case Language.LottieYaml:
                     codeGenSucceeded &= TryGenerateLottieYaml(lottieComposition, $"{outputFileBase}-Lottie.yaml");
                     _profiler.OnSerializationFinished();
                     break;
 
-                case Lang.WinCompDgml:
+                case Language.WinCompDgml:
                     codeGenSucceeded &= TryGenerateWincompDgml(lottieComposition, $"{outputFileBase}.dgml");
                     _profiler.OnSerializationFinished();
                     break;
 
-                case Lang.Stats:
+                case Language.Stats:
                     codeGenSucceeded &= TryGenerateStats(lottieComposition);
                     break;
 
@@ -434,15 +434,18 @@ bool TryGenerateWincompDgml(
         return result;
     }
 
-    bool TryGenerateCSharpCode(LottieComposition lottieComposition, string outputFilePath)
+    bool TryGenerateCSharpCode(
+        LottieComposition lottieComposition,
+        string outputFilePath)
     {
         if (!TryEnsureTranslated(lottieComposition))
         {
             return false;
         }
 
         var codegenResult =
-            CSharpInstantiatorGenerator.CreateFactoryCode(CreateCodeGenConfiguration(lottieComposition, "CSharp"));
+            CSharpInstantiatorGenerator.CreateFactoryCode(
+                CreateCodeGenConfiguration(lottieComposition, Language.CSharp));
 
         if (string.IsNullOrWhiteSpace(codegenResult.CsText))
         {
@@ -478,7 +481,7 @@ bool TryGenerateCppwinrtCode(LottieComposition lottieComposition, string outputF
         }
 
         var codegenResult =
-                    CppwinrtInstantiatorGenerator.CreateFactoryCode(CreateCodeGenConfiguration(lottieComposition, "Cppwinrt"));
+                    CppwinrtInstantiatorGenerator.CreateFactoryCode(CreateCodeGenConfiguration(lottieComposition, Language.Cppwinrt));
 
         if (string.IsNullOrWhiteSpace(codegenResult.CppText))
         {
@@ -532,7 +535,7 @@ bool TryGenerateCXCode(LottieComposition lottieComposition, string outputFolder)
         }
 
         var codegenResult =
-            CxInstantiatorGenerator.CreateFactoryCode(CreateCodeGenConfiguration(lottieComposition, "CX"));
+            CxInstantiatorGenerator.CreateFactoryCode(CreateCodeGenConfiguration(lottieComposition, Language.Cx));
 
         if (string.IsNullOrWhiteSpace(codegenResult.CppText))
         {
@@ -635,7 +638,7 @@ static bool TryEnsureDirectoryExists(string directoryPath)
 
     CodegenConfiguration CreateCodeGenConfiguration(
         LottieComposition lottieComposition,
-        string languageSwitch)
+        Language languageSwitch)
     {
         if (_translationResults is null)
         {
@@ -644,7 +647,6 @@ CodegenConfiguration CreateCodeGenConfiguration(
 
         var result = new CodegenConfiguration(
             className: _className,
-            interfaceType: _options.InterfaceBaseName,
             additionalInterfaces: _options.AdditionalInterfaces,
             objectGraphs: _translationResults.Select(
                             tr => ((CompositionObject?)tr.RootVisual!, tr.MinimumRequiredUapVersion)).ToArray(),
@@ -674,7 +676,7 @@ CodegenConfiguration CreateCodeGenConfiguration(
     // Returns lines that describe the invocation of this tool.
     // This information is passed to the code generator so that it can
     // be included in the generated output.
-    IEnumerable<string> GetToolInvocationInfo(string languageSwitch)
+    IEnumerable<string> GetToolInvocationInfo(Language languageSwitch)
     {
         var inputFile = new FileInfo(_sourceFilePath);