Refactored remaining dependencies in the Toolkit

Sergio0694 · Sergio0694 · commit a86d4bd68e57 · 2021-02-03T02:52:35.000+01:00
diff --git a/Microsoft.Toolkit.Uwp.UI.Animations/Builders/AnimationBuilder.Factories.cs b/Microsoft.Toolkit.Uwp.UI.Animations/Builders/AnimationBuilder.Factories.cs
@@ -228,9 +228,33 @@ public Timeline GetAnimation(DependencyObject targetHint)
             private TValue GetToAs<TValue>()
                 where TValue : unmanaged
             {
-                T to = To;
-
-                return Unsafe.As<T, TValue>(ref to);
+                // We employ this (T2)(object)t1 pattern multiple times in this library to alter generics.
+                // This is an equivalent but safer alternative to using Unsafe.As<TFrom, TTo>(ref TFrom).
+                // For instance, this method will result in the following IL being emitted:
+                // =============================
+                // IL_0000: ldarg.0
+                // IL_0001: call instance !0 class AnimationFactory`1<!T>::get_To()
+                // IL_0006: box !T
+                // IL_000b: unbox.any !!TValue
+                // IL_0010: ret
+                // =============================
+                // The key value is that the JIT (and AOT compilers such as .NET Native) can recognize this
+                // pattern and optimize the boxing away in case the types match. This is the case whenever
+                // the generic arguments are value types, which due to generic types in .NET being reified
+                // results in a completely different generic instantiation of the same method, making the
+                // type arguments effectively constant values known at compile time, ie. at JIT time.
+                // As a result of this, the boxing is completely avoided and the value is returned directly.
+                // Leveraging this pattern lets us keep the same optimal codegen while avoiding the extra
+                // NuGet package dependency on UWP, and the more dangerous path using the Unsafe APIs.
+                // As an example, assuming T is float, the JIT will produce the following codegen on x64:
+                // =============================
+                // L0000: vzeroupper
+                // L0003: vmovss xmm0, [rcx+8]
+                // L0008: ret
+                // =============================
+                // We can see how the property value is loaded directly from the underlying field and
+                // then returned to the caller: no boxing or unwanted overhead is introduced at all.
+                return (TValue)(object)To;
             }
 
             /// <summary>
@@ -250,7 +274,7 @@ private TValue GetToAs<TValue>()
 
                 T from = From.GetValueOrDefault();
 
-                return Unsafe.As<T, TValue>(ref from);
+                return (TValue)(object)from;
             }
         }
 
diff --git a/Microsoft.Toolkit.Uwp.UI.Animations/Builders/Helpers/ListBuilder{T}.cs b/Microsoft.Toolkit.Uwp.UI.Animations/Builders/Helpers/ListBuilder{T}.cs
@@ -9,7 +9,7 @@
 namespace Microsoft.Toolkit.Uwp.UI.Animations.Builders.Helpers
 {
     /// <summary>
-    /// A small generic builder type that allows to create <see cref="ReadOnlySpan{T}"/> instances.
+    /// A small generic builder type that allows to create <see cref="ArraySegment{T}"/> instances.
     /// </summary>
     /// <typeparam name="T">The type of items to create a sequence of.</typeparam>
     internal struct ListBuilder<T>
@@ -56,14 +56,14 @@ public void Append(T item)
         }
 
         /// <summary>
-        /// Gets a <see cref="ReadOnlySpan{T}"/> instance with the current items.
+        /// Gets a <see cref="ArraySegment{T}"/> instance with the current items.
         /// </summary>
-        /// <returns>A <see cref="ReadOnlySpan{T}"/> instance with the current items.</returns>
+        /// <returns>A <see cref="ArraySegment{T}"/> instance with the current items.</returns>
         [Pure]
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        public ReadOnlySpan<T> AsSpan()
+        public ArraySegment<T> GetArraySegment()
         {
-            return this.array.AsSpan(0, this.index);
+            return new(this.array, 0, this.index);
         }
     }
 }
diff --git a/Microsoft.Toolkit.Uwp.UI.Animations/Builders/NormalizedKeyFrameAnimationBuilder{T}.Composition.cs b/Microsoft.Toolkit.Uwp.UI.Animations/Builders/NormalizedKeyFrameAnimationBuilder{T}.Composition.cs
@@ -32,7 +32,7 @@ public static CompositionAnimation GetAnimation<TKeyFrame>(
             TimeSpan? delay,
             TimeSpan duration,
             RepeatOption repeat,
-            ReadOnlySpan<TKeyFrame> keyFrames)
+            ArraySegment<TKeyFrame> keyFrames)
             where TKeyFrame : struct, IKeyFrameInfo
         {
             KeyFrameAnimation animation;
@@ -41,7 +41,7 @@ public static CompositionAnimation GetAnimation<TKeyFrame>(
             {
                 BooleanKeyFrameAnimation boolAnimation = target.Compositor.CreateBooleanKeyFrameAnimation();
 
-                foreach (ref readonly var keyFrame in keyFrames)
+                foreach (var keyFrame in keyFrames)
                 {
                     if (keyFrame.TryInsertExpressionKeyFrame(boolAnimation, duration))
                     {
@@ -57,7 +57,7 @@ public static CompositionAnimation GetAnimation<TKeyFrame>(
             {
                 ScalarKeyFrameAnimation scalarAnimation = target.Compositor.CreateScalarKeyFrameAnimation();
 
-                foreach (ref readonly var keyFrame in keyFrames)
+                foreach (var keyFrame in keyFrames)
                 {
                     if (keyFrame.TryInsertExpressionKeyFrame(scalarAnimation, duration))
                     {
@@ -82,7 +82,7 @@ public static CompositionAnimation GetAnimation<TKeyFrame>(
             {
                 ScalarKeyFrameAnimation scalarAnimation = target.Compositor.CreateScalarKeyFrameAnimation();
 
-                foreach (ref readonly var keyFrame in keyFrames)
+                foreach (var keyFrame in keyFrames)
                 {
                     if (keyFrame.TryInsertExpressionKeyFrame(scalarAnimation, duration))
                     {
@@ -107,7 +107,7 @@ public static CompositionAnimation GetAnimation<TKeyFrame>(
             {
                 Vector2KeyFrameAnimation vector2Animation = target.Compositor.CreateVector2KeyFrameAnimation();
 
-                foreach (ref readonly var keyFrame in keyFrames)
+                foreach (var keyFrame in keyFrames)
                 {
                     if (keyFrame.TryInsertExpressionKeyFrame(vector2Animation, duration))
                     {
@@ -132,7 +132,7 @@ public static CompositionAnimation GetAnimation<TKeyFrame>(
             {
                 Vector3KeyFrameAnimation vector3Animation = target.Compositor.CreateVector3KeyFrameAnimation();
 
-                foreach (ref readonly var keyFrame in keyFrames)
+                foreach (var keyFrame in keyFrames)
                 {
                     if (keyFrame.TryInsertExpressionKeyFrame(vector3Animation, duration))
                     {
@@ -157,7 +157,7 @@ public static CompositionAnimation GetAnimation<TKeyFrame>(
             {
                 Vector4KeyFrameAnimation vector4Animation = target.Compositor.CreateVector4KeyFrameAnimation();
 
-                foreach (ref readonly var keyFrame in keyFrames)
+                foreach (var keyFrame in keyFrames)
                 {
                     if (keyFrame.TryInsertExpressionKeyFrame(vector4Animation, duration))
                     {
@@ -182,7 +182,7 @@ public static CompositionAnimation GetAnimation<TKeyFrame>(
             {
                 ColorKeyFrameAnimation colorAnimation = target.Compositor.CreateColorKeyFrameAnimation();
 
-                foreach (ref readonly var keyFrame in keyFrames)
+                foreach (var keyFrame in keyFrames)
                 {
                     if (keyFrame.TryInsertExpressionKeyFrame(colorAnimation, duration))
                     {
@@ -207,7 +207,7 @@ public static CompositionAnimation GetAnimation<TKeyFrame>(
             {
                 QuaternionKeyFrameAnimation quaternionAnimation = target.Compositor.CreateQuaternionKeyFrameAnimation();
 
-                foreach (ref readonly var keyFrame in keyFrames)
+                foreach (var keyFrame in keyFrames)
                 {
                     if (keyFrame.TryInsertExpressionKeyFrame(quaternionAnimation, duration))
                     {
@@ -283,7 +283,7 @@ public CompositionAnimation GetAnimation(CompositionObject targetHint, out Compo
                     this.delay,
                     this.duration,
                     this.repeat,
-                    this.keyFrames.AsSpan());
+                    this.keyFrames.GetArraySegment());
             }
         }
     }
diff --git a/Microsoft.Toolkit.Uwp.UI.Animations/Builders/NormalizedKeyFrameAnimationBuilder{T}.Xaml.cs b/Microsoft.Toolkit.Uwp.UI.Animations/Builders/NormalizedKeyFrameAnimationBuilder{T}.Xaml.cs
@@ -45,7 +45,7 @@ public Timeline GetAnimation(DependencyObject targetHint)
                     this.delay,
                     this.duration,
                     this.repeat,
-                    this.keyFrames.AsSpan());
+                    this.keyFrames.GetArraySegment());
             }
         }
     }
diff --git a/Microsoft.Toolkit.Uwp.UI.Animations/Builders/NormalizedKeyFrameAnimationBuilder{T}.cs b/Microsoft.Toolkit.Uwp.UI.Animations/Builders/NormalizedKeyFrameAnimationBuilder{T}.cs
@@ -150,7 +150,7 @@ public KeyFrameInfo(
             [MethodImpl(MethodImplOptions.AggressiveInlining)]
             public TValue GetValueAs<TValue>()
             {
-                return Unsafe.As<T, TValue>(ref Unsafe.AsRef(in this.value));
+                return (TValue)(object)this.value;
             }
 
             /// <inheritdoc/>
diff --git a/Microsoft.Toolkit.Uwp.UI.Animations/Builders/TimedKeyFrameAnimationBuilder{T}.Composition.cs b/Microsoft.Toolkit.Uwp.UI.Animations/Builders/TimedKeyFrameAnimationBuilder{T}.Composition.cs
@@ -47,8 +47,8 @@ public CompositionAnimation GetAnimation(CompositionObject targetHint, out Compo
 
                 // We can retrieve the total duration from the last timed keyframe, and then set
                 // this as the target duration and use it to normalize the keyframe progresses.
-                ReadOnlySpan<KeyFrameInfo> keyFrames = this.keyFrames.AsSpan();
-                TimeSpan duration = keyFrames[keyFrames.Length - 1].GetTimedProgress(default);
+                ArraySegment<KeyFrameInfo> keyFrames = this.keyFrames.GetArraySegment();
+                TimeSpan duration = keyFrames[keyFrames.Count - 1].GetTimedProgress(default);
 
                 return NormalizedKeyFrameAnimationBuilder<T>.GetAnimation(
                     targetHint,
diff --git a/Microsoft.Toolkit.Uwp.UI.Animations/Builders/TimedKeyFrameAnimationBuilder{T}.Xaml.cs b/Microsoft.Toolkit.Uwp.UI.Animations/Builders/TimedKeyFrameAnimationBuilder{T}.Xaml.cs
@@ -31,7 +31,7 @@ public static Timeline GetAnimation<TKeyFrame>(
             TimeSpan? delay,
             TimeSpan duration,
             RepeatOption repeat,
-            ReadOnlySpan<TKeyFrame> keyFrames)
+            ArraySegment<TKeyFrame> keyFrames)
             where TKeyFrame : struct, IKeyFrameInfo
         {
             Timeline animation;
@@ -164,7 +164,7 @@ public Timeline GetAnimation(DependencyObject targetHint)
                     this.delay,
                     default,
                     this.repeat,
-                    this.keyFrames.AsSpan());
+                    this.keyFrames.GetArraySegment());
             }
         }
     }
diff --git a/Microsoft.Toolkit.Uwp.UI.Animations/Builders/TimedKeyFrameAnimationBuilder{T}.cs b/Microsoft.Toolkit.Uwp.UI.Animations/Builders/TimedKeyFrameAnimationBuilder{T}.cs
@@ -143,7 +143,7 @@ public KeyFrameInfo(
             [MethodImpl(MethodImplOptions.AggressiveInlining)]
             public TValue GetValueAs<TValue>()
             {
-                return Unsafe.As<T, TValue>(ref Unsafe.AsRef(in this.value));
+                return (TValue)(object)this.value;
             }
 
             /// <inheritdoc/>
diff --git a/Microsoft.Toolkit.Uwp.UI/Extensions/Visual/VisualExtensions.cs b/Microsoft.Toolkit.Uwp.UI/Extensions/Visual/VisualExtensions.cs
@@ -6,7 +6,6 @@
 using System.Globalization;
 using System.Linq;
 using System.Numerics;
-using System.Runtime.CompilerServices;
 using Windows.UI.Composition;
 using Windows.UI.Xaml;
 using Windows.UI.Xaml.Hosting;
@@ -165,11 +164,11 @@ public static Vector4 ToVector4(this string str)
         /// </summary>
         /// <param name="str">A string in the format of "float, float, float, float"</param>
         /// <returns><see cref="Quaternion"/></returns>
-        public static Quaternion ToQuaternion(this string str)
+        public static unsafe Quaternion ToQuaternion(this string str)
         {
             Vector4 vector = str.ToVector4();
 
-            return Unsafe.As<Vector4, Quaternion>(ref vector);
+            return *(Quaternion*)&vector;
         }
 
         /// <summary>
diff --git a/Microsoft.Toolkit.Uwp.UI/Microsoft.Toolkit.Uwp.UI.csproj b/Microsoft.Toolkit.Uwp.UI/Microsoft.Toolkit.Uwp.UI.csproj
@@ -40,8 +40,8 @@
       - ThemeListener: Class which listens for changes to Application Theme or High Contrast Modes and Signals an Event when they occur.
       </Description>
     <PackageTags>UWP Toolkit Windows UI Converters XAML extensions helpers</PackageTags>
-
     <UseWindowsDesktopSdk>true</UseWindowsDesktopSdk>
+    <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
   </PropertyGroup>
   
   <ItemGroup>

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`namespace Microsoft.Toolkit.Uwp.UI.Animations.Builders.Helpers`
`10`	`10`	`{`
`11`	`11`	`/// <summary>`
`12`		`- /// A small generic builder type that allows to create <see cref="ReadOnlySpan{T}"/> instances.`
	`12`	`+ /// A small generic builder type that allows to create <see cref="ArraySegment{T}"/> instances.`
`13`	`13`	`/// </summary>`
`14`	`14`	`/// <typeparam name="T">The type of items to create a sequence of.</typeparam>`
`15`	`15`	`internal struct ListBuilder<T>`
`@@ -56,14 +56,14 @@ public void Append(T item)`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`/// <summary>`
`59`		`- /// Gets a <see cref="ReadOnlySpan{T}"/> instance with the current items.`
	`59`	`+ /// Gets a <see cref="ArraySegment{T}"/> instance with the current items.`
`60`	`60`	`/// </summary>`
`61`		`- /// <returns>A <see cref="ReadOnlySpan{T}"/> instance with the current items.</returns>`
	`61`	`+ /// <returns>A <see cref="ArraySegment{T}"/> instance with the current items.</returns>`
`62`	`62`	`[Pure]`
`63`	`63`	`[MethodImpl(MethodImplOptions.AggressiveInlining)]`
`64`		`- public ReadOnlySpan<T> AsSpan()`
	`64`	`+ public ArraySegment<T> GetArraySegment()`
`65`	`65`	`{`
`66`		`- return this.array.AsSpan(0, this.index);`
	`66`	`+ return new(this.array, 0, this.index);`
`67`	`67`	`}`
`68`	`68`	`}`
`69`	`69`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ public static CompositionAnimation GetAnimation<TKeyFrame>(`
`32`	`32`	`TimeSpan? delay,`
`33`	`33`	`TimeSpan duration,`
`34`	`34`	`RepeatOption repeat,`
`35`		`- ReadOnlySpan<TKeyFrame> keyFrames)`
	`35`	`+ ArraySegment<TKeyFrame> keyFrames)`
`36`	`36`	`where TKeyFrame : struct, IKeyFrameInfo`
`37`	`37`	`{`
`38`	`38`	`KeyFrameAnimation animation;`
`@@ -41,7 +41,7 @@ public static CompositionAnimation GetAnimation<TKeyFrame>(`
`41`	`41`	`{`
`42`	`42`	`BooleanKeyFrameAnimation boolAnimation = target.Compositor.CreateBooleanKeyFrameAnimation();`
`43`	`43`
`44`		`- foreach (ref readonly var keyFrame in keyFrames)`
	`44`	`+ foreach (var keyFrame in keyFrames)`
`45`	`45`	`{`
`46`	`46`	`if (keyFrame.TryInsertExpressionKeyFrame(boolAnimation, duration))`
`47`	`47`	`{`
`@@ -57,7 +57,7 @@ public static CompositionAnimation GetAnimation<TKeyFrame>(`
`57`	`57`	`{`
`58`	`58`	`ScalarKeyFrameAnimation scalarAnimation = target.Compositor.CreateScalarKeyFrameAnimation();`
`59`	`59`
`60`		`- foreach (ref readonly var keyFrame in keyFrames)`
	`60`	`+ foreach (var keyFrame in keyFrames)`
`61`	`61`	`{`
`62`	`62`	`if (keyFrame.TryInsertExpressionKeyFrame(scalarAnimation, duration))`
`63`	`63`	`{`
`@@ -82,7 +82,7 @@ public static CompositionAnimation GetAnimation<TKeyFrame>(`
`82`	`82`	`{`
`83`	`83`	`ScalarKeyFrameAnimation scalarAnimation = target.Compositor.CreateScalarKeyFrameAnimation();`
`84`	`84`
`85`		`- foreach (ref readonly var keyFrame in keyFrames)`
	`85`	`+ foreach (var keyFrame in keyFrames)`
`86`	`86`	`{`
`87`	`87`	`if (keyFrame.TryInsertExpressionKeyFrame(scalarAnimation, duration))`
`88`	`88`	`{`
`@@ -107,7 +107,7 @@ public static CompositionAnimation GetAnimation<TKeyFrame>(`
`107`	`107`	`{`
`108`	`108`	`Vector2KeyFrameAnimation vector2Animation = target.Compositor.CreateVector2KeyFrameAnimation();`
`109`	`109`
`110`		`- foreach (ref readonly var keyFrame in keyFrames)`
	`110`	`+ foreach (var keyFrame in keyFrames)`
`111`	`111`	`{`
`112`	`112`	`if (keyFrame.TryInsertExpressionKeyFrame(vector2Animation, duration))`
`113`	`113`	`{`
`@@ -132,7 +132,7 @@ public static CompositionAnimation GetAnimation<TKeyFrame>(`
`132`	`132`	`{`
`133`	`133`	`Vector3KeyFrameAnimation vector3Animation = target.Compositor.CreateVector3KeyFrameAnimation();`
`134`	`134`
`135`		`- foreach (ref readonly var keyFrame in keyFrames)`
	`135`	`+ foreach (var keyFrame in keyFrames)`
`136`	`136`	`{`
`137`	`137`	`if (keyFrame.TryInsertExpressionKeyFrame(vector3Animation, duration))`
`138`	`138`	`{`
`@@ -157,7 +157,7 @@ public static CompositionAnimation GetAnimation<TKeyFrame>(`
`157`	`157`	`{`
`158`	`158`	`Vector4KeyFrameAnimation vector4Animation = target.Compositor.CreateVector4KeyFrameAnimation();`
`159`	`159`
`160`		`- foreach (ref readonly var keyFrame in keyFrames)`
	`160`	`+ foreach (var keyFrame in keyFrames)`
`161`	`161`	`{`
`162`	`162`	`if (keyFrame.TryInsertExpressionKeyFrame(vector4Animation, duration))`
`163`	`163`	`{`
`@@ -182,7 +182,7 @@ public static CompositionAnimation GetAnimation<TKeyFrame>(`
`182`	`182`	`{`
`183`	`183`	`ColorKeyFrameAnimation colorAnimation = target.Compositor.CreateColorKeyFrameAnimation();`
`184`	`184`
`185`		`- foreach (ref readonly var keyFrame in keyFrames)`
	`185`	`+ foreach (var keyFrame in keyFrames)`
`186`	`186`	`{`
`187`	`187`	`if (keyFrame.TryInsertExpressionKeyFrame(colorAnimation, duration))`
`188`	`188`	`{`
`@@ -207,7 +207,7 @@ public static CompositionAnimation GetAnimation<TKeyFrame>(`
`207`	`207`	`{`
`208`	`208`	`QuaternionKeyFrameAnimation quaternionAnimation = target.Compositor.CreateQuaternionKeyFrameAnimation();`
`209`	`209`
`210`		`- foreach (ref readonly var keyFrame in keyFrames)`
	`210`	`+ foreach (var keyFrame in keyFrames)`
`211`	`211`	`{`
`212`	`212`	`if (keyFrame.TryInsertExpressionKeyFrame(quaternionAnimation, duration))`
`213`	`213`	`{`
`@@ -283,7 +283,7 @@ public CompositionAnimation GetAnimation(CompositionObject targetHint, out Compo`
`283`	`283`	`this.delay,`
`284`	`284`	`this.duration,`
`285`	`285`	`this.repeat,`
`286`		`- this.keyFrames.AsSpan());`
	`286`	`+ this.keyFrames.GetArraySegment());`
`287`	`287`	`}`
`288`	`288`	`}`
`289`	`289`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ public Timeline GetAnimation(DependencyObject targetHint)`
`45`	`45`	`this.delay,`
`46`	`46`	`this.duration,`
`47`	`47`	`this.repeat,`
`48`		`- this.keyFrames.AsSpan());`
	`48`	`+ this.keyFrames.GetArraySegment());`
`49`	`49`	`}`
`50`	`50`	`}`
`51`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -150,7 +150,7 @@ public KeyFrameInfo(`
`150`	`150`	`[MethodImpl(MethodImplOptions.AggressiveInlining)]`
`151`	`151`	`public TValue GetValueAs<TValue>()`
`152`	`152`	`{`
`153`		`- return Unsafe.As<T, TValue>(ref Unsafe.AsRef(in this.value));`
	`153`	`+ return (TValue)(object)this.value;`
`154`	`154`	`}`
`155`	`155`
`156`	`156`	`/// <inheritdoc/>`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public static Timeline GetAnimation<TKeyFrame>(`
`31`	`31`	`TimeSpan? delay,`
`32`	`32`	`TimeSpan duration,`
`33`	`33`	`RepeatOption repeat,`
`34`		`- ReadOnlySpan<TKeyFrame> keyFrames)`
	`34`	`+ ArraySegment<TKeyFrame> keyFrames)`
`35`	`35`	`where TKeyFrame : struct, IKeyFrameInfo`
`36`	`36`	`{`
`37`	`37`	`Timeline animation;`
`@@ -164,7 +164,7 @@ public Timeline GetAnimation(DependencyObject targetHint)`
`164`	`164`	`this.delay,`
`165`	`165`	`default,`
`166`	`166`	`this.repeat,`
`167`		`- this.keyFrames.AsSpan());`
	`167`	`+ this.keyFrames.GetArraySegment());`
`168`	`168`	`}`
`169`	`169`	`}`
`170`	`170`	`}`
Original file line number	Diff line number	Diff line change
`@@ -143,7 +143,7 @@ public KeyFrameInfo(`
`143`	`143`	`[MethodImpl(MethodImplOptions.AggressiveInlining)]`
`144`	`144`	`public TValue GetValueAs<TValue>()`
`145`	`145`	`{`
`146`		`- return Unsafe.As<T, TValue>(ref Unsafe.AsRef(in this.value));`
	`146`	`+ return (TValue)(object)this.value;`
`147`	`147`	`}`
`148`	`148`
`149`	`149`	`/// <inheritdoc/>`