feat: add experimental UxmlNameAttribute for generating UxmlFactory

jonisavo · Oct 8, 2022 · 5df8799 · 5df8799
1 parent 5573b07
commit 5df8799
Show file tree

Hide file tree

Showing 45 changed files with 552 additions and 102 deletions.
diff --git a/Assets/UIComponents.Tests/Roslyn/Resources/UxmlNameTestComponent.uxml b/Assets/UIComponents.Tests/Roslyn/Resources/UxmlNameTestComponent.uxml
@@ -0,0 +1,3 @@
+<UXML xmlns:test="UIComponents.Tests.Roslyn">
+    <test:UxmlNameTest />
+</UXML>
diff --git a/Assets/UIComponents.Tests/Roslyn/Resources/UxmlNameTestComponent.uxml.meta b/Assets/UIComponents.Tests/Roslyn/Resources/UxmlNameTestComponent.uxml.meta
diff --git a/Assets/UIComponents.Tests/Roslyn/UxmlNameTestComponent.cs b/Assets/UIComponents.Tests/Roslyn/UxmlNameTestComponent.cs
@@ -0,0 +1,7 @@
+using UIComponents.Experimental;
+
+namespace UIComponents.Tests.Roslyn
+{
+    [UxmlName("UxmlNameTest")]
+    public partial class UxmlNameTestComponent : UIComponent {}
+}
diff --git a/Assets/UIComponents.Tests/Roslyn/UxmlNameTestComponent.cs.meta b/Assets/UIComponents.Tests/Roslyn/UxmlNameTestComponent.cs.meta
diff --git a/Assets/UIComponents.Tests/Roslyn/UxmlNameTests.cs b/Assets/UIComponents.Tests/Roslyn/UxmlNameTests.cs
@@ -0,0 +1,23 @@
+using NUnit.Framework;
+using UnityEngine;
+using UnityEngine.UIElements;
+
+namespace UIComponents.Tests.Roslyn
+{
+    [TestFixture]
+    public class UxmlNameTests
+    {
+        [Test]
+        public void Generates_Uxml_Factory_For_Name()
+        {
+            var layout = Resources.Load<VisualTreeAsset>("UxmlNameTestComponent");
+
+            var container = new VisualElement();
+            layout.CloneTree(container);
+
+            var testElement = container.Q<UxmlNameTestComponent>();
+
+            Assert.That(testElement, Is.Not.Null);
+        }
+    }
+}
diff --git a/Assets/UIComponents.Tests/Roslyn/UxmlNameTests.cs.meta b/Assets/UIComponents.Tests/Roslyn/UxmlNameTests.cs.meta
diff --git a/Assets/UIComponents/Core/Experimental/TraitAttribute.cs b/Assets/UIComponents/Core/Experimental/TraitAttribute.cs
@@ -6,9 +6,8 @@ namespace UIComponents.Experimental
 {
     /// <summary>
     /// When used in Unity 2021.2 or later, this attribute will generate
-    /// UxmlTraits and UxmlFactory implementations automatically when
-    /// applied to a field or property which has a set method. The class
-    /// must be partial.
+    /// an UxmlTraits implementation when applied to a field or property
+    /// which has a set method. The class must be partial.
     /// </summary>
     /// <example>
     /// <code>

diff --git a/Assets/UIComponents/Core/Experimental/UxmlNameAttribute.cs b/Assets/UIComponents/Core/Experimental/UxmlNameAttribute.cs
@@ -0,0 +1,54 @@
+using System;
+using System.Diagnostics;
+using JetBrains.Annotations;
+using UnityEngine.TestTools;
+using UnityEngine.UIElements;
+
+namespace UIComponents.Experimental
+{
+    /// <summary>
+    /// When used in Unity 2021.2 or later, this attribute will generate
+    /// a UxmlFactory implementation automatically when
+    /// applied to a partial class.
+    /// </summary>
+    /// <example>
+    /// <code>
+    /// [UxmlName("ListHeader")]
+    /// public partial class ListHeaderComponent : UIComponent {}
+    ///
+    /// // This generates:
+    ///
+    /// public partial class ListHeaderComponent
+    /// {
+    ///     public new class UxmlFactory : UxmlFactory&lt;ListHeaderComponent&gt;
+    ///     {
+    ///         public override string uxmlName
+    ///         {
+    ///             get { return "ListHeader"; }
+    ///         }
+    ///
+    ///         public override string uxmlQualifiedName
+    ///         {
+    ///             get { return uxmlNamespace + "." + uxmlName; }
+    ///         }
+    ///     }
+    /// }
+    /// </code>
+    /// </example>
+    [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
+    [Conditional("UNITY_EDITOR")]
+    [BaseTypeRequired(typeof(VisualElement))]
+    [ExcludeFromCoverage]
+    public sealed class UxmlNameAttribute : Attribute
+    {
+        /// <summary>
+        /// The custom UXML name.
+        /// </summary>
+        public readonly string Name;
+
+        public UxmlNameAttribute(string name)
+        {
+            Name = name;
+        }
+    }
+}
diff --git a/Assets/UIComponents/Core/Experimental/UxmlNameAttribute.cs.meta b/Assets/UIComponents/Core/Experimental/UxmlNameAttribute.cs.meta
diff --git a/Assets/UIComponents/Roslyn/UIComponents.Roslyn.Generation.dll b/Assets/UIComponents/Roslyn/UIComponents.Roslyn.Generation.dll
diff --git a/UIComponents.Roslyn/UIComponents.Roslyn.Generation.Tests/Resources/UxmlNameAttribute.cs b/UIComponents.Roslyn/UIComponents.Roslyn.Generation.Tests/Resources/UxmlNameAttribute.cs
@@ -0,0 +1,16 @@
+using System.Diagnostics.CodeAnalysis;
+
+namespace UIComponents.Experimental
+{
+    [ExcludeFromCodeCoverage]
+    [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
+    public sealed class UxmlNameAttribute : Attribute
+    {
+        public readonly string Name;
+
+        public UxmlNameAttribute(string name)
+        {
+            Name = name;
+        }
+    }
+}
diff --git a/....Allows_Setting_Default_Value.verified.cs → ....Allows_Setting_Default_Value.verified.cs b/....Allows_Setting_Default_Value.verified.cs → ....Allows_Setting_Default_Value.verified.cs
@@ -1,4 +1,4 @@
-//HintName: ComponentWithDefaultValueTraits.UxmlTraits.g.cs
+//HintName: ComponentWithDefaultValueTraits.Uxml.g.cs
 // <auto-generated>
 // This file has been generated automatically by UIComponents.Roslyn.
 // Do not attempt to modify it. Any changes will be overridden during compilation.

diff --git a/...s.Allows_Specifying_Uxml_Name.verified.cs → ...s.Allows_Specifying_Uxml_Name.verified.cs b/...s.Allows_Specifying_Uxml_Name.verified.cs → ...s.Allows_Specifying_Uxml_Name.verified.cs
@@ -1,4 +1,4 @@
-//HintName: CustomNamespaceComponent.UxmlTraits.g.cs
+//HintName: CustomNamespaceComponent.Uxml.g.cs
 // <auto-generated>
 // This file has been generated automatically by UIComponents.Roslyn.
 // Do not attempt to modify it. Any changes will be overridden during compilation.

diff --git a/...otTests.Generates_Bool_Traits.verified.cs → ...otTests.Generates_Bool_Traits.verified.cs b/...otTests.Generates_Bool_Traits.verified.cs → ...otTests.Generates_Bool_Traits.verified.cs
@@ -1,4 +1,4 @@
-//HintName: BoolComponentWithUsing.UxmlTraits.g.cs
+//HintName: BoolComponentWithUsing.Uxml.g.cs
 // <auto-generated>
 // This file has been generated automatically by UIComponents.Roslyn.
 // Do not attempt to modify it. Any changes will be overridden during compilation.

diff --git a/...shots/UxmlAugmentGeneratorSnapshotTests.Generates_Both_Traits_And_UxmlFactory.verified.cs b/...shots/UxmlAugmentGeneratorSnapshotTests.Generates_Both_Traits_And_UxmlFactory.verified.cs
@@ -0,0 +1,35 @@
+//HintName: ComponentWithUxmlNameAndTraits.Uxml.g.cs
+// <auto-generated>
+// This file has been generated automatically by UIComponents.Roslyn.
+// Do not attempt to modify it. Any changes will be overridden during compilation.
+// </auto-generated>
+
+using UnityEngine.UIElements;
+
+public partial class ComponentWithUxmlNameAndTraits
+{
+    public new partial class UxmlFactory : UxmlFactory<ComponentWithUxmlNameAndTraits, UxmlTraits>
+    {
+        public override string uxmlName
+        {
+            get { return "AwesomeUxmlName"; }
+        }
+
+        public override string uxmlQualifiedName
+        {
+            get { return uxmlNamespace + "." + uxmlName; }
+        }
+    }
+
+    public new partial class UxmlTraits : VisualElement.UxmlTraits
+    {
+        UxmlBoolAttributeDescription m_Value = new UxmlBoolAttributeDescription { name = "value" };
+
+        public override void Init(VisualElement ve, IUxmlAttributes bag, CreationContext cc)
+        {
+            base.Init(ve, bag, cc);
+            m_Value.defaultValue = true;
+            ((ComponentWithUxmlNameAndTraits)ve).Value = m_Value.GetValueFromBag(bag, cc);
+        }
+    }
+}
diff --git a/...tTests.Generates_Color_Traits.verified.cs → ...tTests.Generates_Color_Traits.verified.cs b/...tTests.Generates_Color_Traits.verified.cs → ...tTests.Generates_Color_Traits.verified.cs
@@ -1,4 +1,4 @@
-//HintName: ColorComponentWithUsing.UxmlTraits.g.cs
+//HintName: ColorComponentWithUsing.Uxml.g.cs
 // <auto-generated>
 // This file has been generated automatically by UIComponents.Roslyn.
 // Do not attempt to modify it. Any changes will be overridden during compilation.

diff --git a/...Tests.Generates_Double_Traits.verified.cs → ...Tests.Generates_Double_Traits.verified.cs b/...Tests.Generates_Double_Traits.verified.cs → ...Tests.Generates_Double_Traits.verified.cs
@@ -1,4 +1,4 @@
-//HintName: DoubleComponentWithUsing.UxmlTraits.g.cs
+//HintName: DoubleComponentWithUsing.Uxml.g.cs
 // <auto-generated>
 // This file has been generated automatically by UIComponents.Roslyn.
 // Do not attempt to modify it. Any changes will be overridden during compilation.

diff --git a/...Enum_Trait_With_Internal_Enum.verified.cs → ...Enum_Trait_With_Internal_Enum.verified.cs b/...Enum_Trait_With_Internal_Enum.verified.cs → ...Enum_Trait_With_Internal_Enum.verified.cs
@@ -1,4 +1,4 @@
-//HintName: OwnEnumComponent.UxmlTraits.g.cs
+//HintName: OwnEnumComponent.Uxml.g.cs
 // <auto-generated>
 // This file has been generated automatically by UIComponents.Roslyn.
 // Do not attempt to modify it. Any changes will be overridden during compilation.

diff --git a/...otTests.Generates_Enum_Traits.verified.cs → ...otTests.Generates_Enum_Traits.verified.cs b/...otTests.Generates_Enum_Traits.verified.cs → ...otTests.Generates_Enum_Traits.verified.cs
@@ -1,4 +1,4 @@
-//HintName: MyEnumComponentWithUsing.UxmlTraits.g.cs
+//HintName: MyEnumComponentWithUsing.Uxml.g.cs
 // <auto-generated>
 // This file has been generated automatically by UIComponents.Roslyn.
 // Do not attempt to modify it. Any changes will be overridden during compilation.

diff --git a/...tTests.Generates_Float_Traits.verified.cs → ...tTests.Generates_Float_Traits.verified.cs b/...tTests.Generates_Float_Traits.verified.cs → ...tTests.Generates_Float_Traits.verified.cs
@@ -1,4 +1,4 @@
-//HintName: FloatComponentWithUsing.UxmlTraits.g.cs
+//HintName: FloatComponentWithUsing.Uxml.g.cs
 // <auto-generated>
 // This file has been generated automatically by UIComponents.Roslyn.
 // Do not attempt to modify it. Any changes will be overridden during compilation.

diff --git a/...tTests.Generates_In_Namespace.verified.cs → ...tTests.Generates_In_Namespace.verified.cs b/...tTests.Generates_In_Namespace.verified.cs → ...tTests.Generates_In_Namespace.verified.cs
@@ -1,4 +1,4 @@
-//HintName: CustomNamespaceComponent.UxmlTraits.g.cs
+//HintName: CustomNamespaceComponent.Uxml.g.cs
 // <auto-generated>
 // This file has been generated automatically by UIComponents.Roslyn.
 // Do not attempt to modify it. Any changes will be overridden during compilation.

diff --git a/...hotTests.Generates_Int_Traits.verified.cs → ...hotTests.Generates_Int_Traits.verified.cs b/...hotTests.Generates_Int_Traits.verified.cs → ...hotTests.Generates_Int_Traits.verified.cs
@@ -1,4 +1,4 @@
-//HintName: IntComponentWithUsing.UxmlTraits.g.cs
+//HintName: IntComponentWithUsing.Uxml.g.cs
 // <auto-generated>
 // This file has been generated automatically by UIComponents.Roslyn.
 // Do not attempt to modify it. Any changes will be overridden during compilation.

diff --git a/...otTests.Generates_Long_Traits.verified.cs → ...otTests.Generates_Long_Traits.verified.cs b/...otTests.Generates_Long_Traits.verified.cs → ...otTests.Generates_Long_Traits.verified.cs
@@ -1,4 +1,4 @@
-//HintName: LongComponentWithUsing.UxmlTraits.g.cs
+//HintName: LongComponentWithUsing.Uxml.g.cs
 // <auto-generated>
 // This file has been generated automatically by UIComponents.Roslyn.
 // Do not attempt to modify it. Any changes will be overridden during compilation.

diff --git a/...Tests.Generates_String_Traits.verified.cs → ...Tests.Generates_String_Traits.verified.cs b/...Tests.Generates_String_Traits.verified.cs → ...Tests.Generates_String_Traits.verified.cs
@@ -1,4 +1,4 @@
-//HintName: StringComponentWithUsing.UxmlTraits.g.cs
+//HintName: StringComponentWithUsing.Uxml.g.cs
 // <auto-generated>
 // This file has been generated automatically by UIComponents.Roslyn.
 // Do not attempt to modify it. Any changes will be overridden during compilation.

diff --git a/...0FirstTraitClass.UxmlTraits.g.verified.cs → ...sses.00FirstTraitClass.Uxml.g.verified.cs b/...0FirstTraitClass.UxmlTraits.g.verified.cs → ...sses.00FirstTraitClass.Uxml.g.verified.cs
@@ -1,4 +1,4 @@
-//HintName: FirstTraitClass.UxmlTraits.g.cs
+//HintName: FirstTraitClass.Uxml.g.cs
 // <auto-generated>
 // This file has been generated automatically by UIComponents.Roslyn.
 // Do not attempt to modify it. Any changes will be overridden during compilation.

diff --git a/...SecondTraitClass.UxmlTraits.g.verified.cs → ...ses.01SecondTraitClass.Uxml.g.verified.cs b/...SecondTraitClass.UxmlTraits.g.verified.cs → ...ses.01SecondTraitClass.Uxml.g.verified.cs
@@ -1,4 +1,4 @@
-//HintName: SecondTraitClass.UxmlTraits.g.cs
+//HintName: SecondTraitClass.Uxml.g.cs
 // <auto-generated>
 // This file has been generated automatically by UIComponents.Roslyn.
 // Do not attempt to modify it. Any changes will be overridden during compilation.

diff --git a/...2ThirdTraitClass.UxmlTraits.g.verified.cs → ...sses.02ThirdTraitClass.Uxml.g.verified.cs b/...2ThirdTraitClass.UxmlTraits.g.verified.cs → ...sses.02ThirdTraitClass.Uxml.g.verified.cs
@@ -1,4 +1,4 @@
-//HintName: ThirdTraitClass.UxmlTraits.g.cs
+//HintName: ThirdTraitClass.Uxml.g.cs
 // <auto-generated>
 // This file has been generated automatically by UIComponents.Roslyn.
 // Do not attempt to modify it. Any changes will be overridden during compilation.

diff --git a/...hotTests.Generates_Traits_For_Many_Classes.DotNet6_0.00FirstTraitClass.Uxml.g.received.cs b/...hotTests.Generates_Traits_For_Many_Classes.DotNet6_0.00FirstTraitClass.Uxml.g.received.cs
@@ -0,0 +1,25 @@
+//HintName: FirstTraitClass.Uxml.g.cs
+// <auto-generated>
+// This file has been generated automatically by UIComponents.Roslyn.
+// Do not attempt to modify it. Any changes will be overridden during compilation.
+// </auto-generated>
+
+using UnityEngine.UIElements;
+
+public partial class FirstTraitClass
+{
+    public new partial class UxmlFactory : UxmlFactory<FirstTraitClass, UxmlTraits> {}
+
+    public new partial class UxmlTraits : VisualElement.UxmlTraits
+    {
+        UxmlIntAttributeDescription m_FieldTrait = new UxmlIntAttributeDescription { name = "custom-trait-name" };
+        UxmlFloatAttributeDescription m_PropertyTrait = new UxmlFloatAttributeDescription { name = "my-property" };
+
+        public override void Init(VisualElement ve, IUxmlAttributes bag, CreationContext cc)
+        {
+            base.Init(ve, bag, cc);
+            ((FirstTraitClass)ve).FieldTrait = m_FieldTrait.GetValueFromBag(bag, cc);
+            ((FirstTraitClass)ve).PropertyTrait = m_PropertyTrait.GetValueFromBag(bag, cc);
+        }
+    }
+    }
diff --git a/...otTests.Generates_Traits_For_Many_Classes.DotNet6_0.01SecondTraitClass.Uxml.g.received.cs b/...otTests.Generates_Traits_For_Many_Classes.DotNet6_0.01SecondTraitClass.Uxml.g.received.cs
@@ -0,0 +1,26 @@
+//HintName: SecondTraitClass.Uxml.g.cs
+// <auto-generated>
+// This file has been generated automatically by UIComponents.Roslyn.
+// Do not attempt to modify it. Any changes will be overridden during compilation.
+// </auto-generated>
+
+using UnityEngine.UIElements;
+
+public partial class SecondTraitClass
+{
+    public new partial class UxmlFactory : UxmlFactory<SecondTraitClass, UxmlTraits> {}
+
+    public new partial class UxmlTraits : VisualElement.UxmlTraits
+    {
+        UxmlBoolAttributeDescription m_Enabled = new UxmlBoolAttributeDescription { name = "enabled" };
+        UxmlLongAttributeDescription m_SomeValue = new UxmlLongAttributeDescription { name = "secret" };
+
+        public override void Init(VisualElement ve, IUxmlAttributes bag, CreationContext cc)
+        {
+            base.Init(ve, bag, cc);
+            m_Enabled.defaultValue = true;
+            ((SecondTraitClass)ve).Enabled = m_Enabled.GetValueFromBag(bag, cc);
+            ((SecondTraitClass)ve).SomeValue = m_SomeValue.GetValueFromBag(bag, cc);
+        }
+    }
+    }
diff --git a/...hotTests.Generates_Traits_For_Many_Classes.DotNet6_0.02ThirdTraitClass.Uxml.g.received.cs b/...hotTests.Generates_Traits_For_Many_Classes.DotNet6_0.02ThirdTraitClass.Uxml.g.received.cs
@@ -0,0 +1,23 @@
+//HintName: ThirdTraitClass.Uxml.g.cs
+// <auto-generated>
+// This file has been generated automatically by UIComponents.Roslyn.
+// Do not attempt to modify it. Any changes will be overridden during compilation.
+// </auto-generated>
+
+using UnityEngine.UIElements;
+
+public partial class ThirdTraitClass
+{
+    public new partial class UxmlFactory : UxmlFactory<ThirdTraitClass, UxmlTraits> {}
+
+    public new partial class UxmlTraits : VisualElement.UxmlTraits
+    {
+        UxmlStringAttributeDescription m_Name = new UxmlStringAttributeDescription { name = "name" };
+
+        public override void Init(VisualElement ve, IUxmlAttributes bag, CreationContext cc)
+        {
+            base.Init(ve, bag, cc);
+            ((ThirdTraitClass)ve).Name = m_Name.GetValueFromBag(bag, cc);
+        }
+    }
+    }
diff --git a/...apshots/UxmlAugmentGeneratorSnapshotTests.Generates_UxmlFactory_With_UxmlName.verified.cs b/...apshots/UxmlAugmentGeneratorSnapshotTests.Generates_UxmlFactory_With_UxmlName.verified.cs
@@ -0,0 +1,23 @@
+//HintName: MyUxmlNameAttributeComponent.Uxml.g.cs
+// <auto-generated>
+// This file has been generated automatically by UIComponents.Roslyn.
+// Do not attempt to modify it. Any changes will be overridden during compilation.
+// </auto-generated>
+
+using UnityEngine.UIElements;
+
+public partial class MyUxmlNameAttributeComponent
+{
+    public new partial class UxmlFactory : UxmlFactory<MyUxmlNameAttributeComponent>
+    {
+        public override string uxmlName
+        {
+            get { return "MyUxmlNameAttribute"; }
+        }
+
+        public override string uxmlQualifiedName
+        {
+            get { return uxmlNamespace + "." + uxmlName; }
+        }
+    }
+}
diff --git a/...shots/UxmlAugmentGeneratorSnapshotTests.Handles_Subclass.00MyComponent.Uxml.g.verified.cs b/...shots/UxmlAugmentGeneratorSnapshotTests.Handles_Subclass.00MyComponent.Uxml.g.verified.cs
@@ -0,0 +1 @@
+
diff --git a/...AugmentGeneratorSnapshotTests.Handles_Subclass.01MyComponentWithTraits.Uxml.g.verified.cs b/...AugmentGeneratorSnapshotTests.Handles_Subclass.01MyComponentWithTraits.Uxml.g.verified.cs
@@ -0,0 +1 @@
+
diff --git a/...AugmentGeneratorSnapshotTests.Handles_Subclass.DotNet6_0.00MyComponent.Uxml.g.received.cs b/...AugmentGeneratorSnapshotTests.Handles_Subclass.DotNet6_0.00MyComponent.Uxml.g.received.cs
@@ -0,0 +1,23 @@
+//HintName: MyComponent.Uxml.g.cs
+// <auto-generated>
+// This file has been generated automatically by UIComponents.Roslyn.
+// Do not attempt to modify it. Any changes will be overridden during compilation.
+// </auto-generated>
+
+using UnityEngine.UIElements;
+
+public partial class MyComponent
+{
+    public new partial class UxmlFactory : UxmlFactory<MyComponent, UxmlTraits> {}
+
+    public new partial class UxmlTraits : VisualElement.UxmlTraits
+    {
+        UxmlDoubleAttributeDescription m_Trait = new UxmlDoubleAttributeDescription { name = "double-value" };
+
+        public override void Init(VisualElement ve, IUxmlAttributes bag, CreationContext cc)
+        {
+            base.Init(ve, bag, cc);
+            ((MyComponent)ve).Trait = m_Trait.GetValueFromBag(bag, cc);
+        }
+    }
+}