feat: annotate generated code with GeneratedCodeAttribute

jonisavo · Oct 18, 2022 · 75b0c35 · 75b0c35
1 parent ae18491
commit 75b0c35
Show file tree

Hide file tree

Showing 70 changed files with 295 additions and 81 deletions.
diff --git a/Assets/UIComponents/Core/UIComponent.cs b/Assets/UIComponents/Core/UIComponent.cs
@@ -71,7 +71,7 @@ protected UIComponent()
             _dependencyInjector = DiContext.Current.GetInjector(_componentType);
             AssetResolver = Provide<IAssetResolver>();
             Logger = Provide<IUIComponentLogger>();
-            PopulateProvideFields();
+            UIC_PopulateProvideFields();
 
             DependencySetupProfilerMarker.End();
 
@@ -105,8 +105,8 @@ private async void Initialize()
 
             PostHierarchySetupProfilerMarker.Begin();
 
-            ApplyEffects();
-            PopulateQueryFields();
+            UIC_ApplyEffects();
+            UIC_PopulateQueryFields();
             RegisterEventInterfaceCallbacks();
 
             PostHierarchySetupProfilerMarker.End();
@@ -213,15 +213,15 @@ public string GetTypeName()
         {
             return _dependencyInjector.TryProvide(out instance);
         }
-
-        protected virtual Task<VisualTreeAsset> StartLayoutLoad()
+        
+        protected virtual Task<VisualTreeAsset> UIC_StartLayoutLoad()
         {
             return Task.FromResult<VisualTreeAsset>(null);
         }
-
+        
         private Task<VisualTreeAsset> GetLayout()
         {
-            return StartLayoutLoad();
+            return UIC_StartLayoutLoad();
         }
 
         protected readonly struct StyleSheetLoadTuple
@@ -236,15 +236,15 @@ public StyleSheetLoadTuple(string path, StyleSheet styleSheet)
             }
         }
 
-        protected virtual Task<StyleSheetLoadTuple>[] StartStyleSheetLoad()
+        protected virtual Task<StyleSheetLoadTuple>[] UIC_StartStyleSheetLoad()
         {
             return Array.Empty<Task<StyleSheetLoadTuple>>();
         }
 
         private async Task<List<StyleSheet>> GetStyleSheets()
         {
             var styleSheetLoadTasks =
-                StartStyleSheetLoad();
+                UIC_StartStyleSheetLoad();
 
             await Task.WhenAll(styleSheetLoadTasks);
 
@@ -266,10 +266,10 @@ private async Task<List<StyleSheet>> GetStyleSheets()
             return loadedStyleSheets;
         }
 
-        protected virtual void ApplyEffects() {}
+        protected virtual void UIC_ApplyEffects() {}
 
-        protected virtual void PopulateQueryFields() {}
+        protected virtual void UIC_PopulateQueryFields() {}
 
-        protected virtual void PopulateProvideFields() {}
+        protected virtual void UIC_PopulateProvideFields() {}
     }
 }
diff --git a/Assets/UIComponents/Roslyn/UIComponents.Roslyn.Generation.dll b/Assets/UIComponents/Roslyn/UIComponents.Roslyn.Generation.dll
diff --git a/...s/Snapshots/EffectAugmentGeneratorSnapshotTests.It_Allows_Overriding_Priority.verified.cs b/...s/Snapshots/EffectAugmentGeneratorSnapshotTests.It_Allows_Overriding_Priority.verified.cs
@@ -5,12 +5,15 @@
 // </auto-generated>
 
 using System;
+using System.CodeDom.Compiler;
 using UnityEngine.UIElements;
 
 public partial class PriorityEffectComponent
 {
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
     private static UIComponentEffectAttribute[] UIC_EffectAttributes;
 
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
     private static void UIC_InitializeEffectAttributes()
     {
         UIC_EffectAttributes = new [] {
@@ -20,7 +23,8 @@ private static void UIC_InitializeEffectAttributes()
         Array.Sort(UIC_EffectAttributes);
     }
 
-    protected override void ApplyEffects()
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
+    protected override void UIC_ApplyEffects()
     {
         if (UIC_EffectAttributes == null)
             UIC_InitializeEffectAttributes();

diff --git a/...ts/EffectAugmentGeneratorSnapshotTests.It_Generates_Code_For_Applying_Effects.verified.cs b/...ts/EffectAugmentGeneratorSnapshotTests.It_Generates_Code_For_Applying_Effects.verified.cs
@@ -5,12 +5,15 @@
 // </auto-generated>
 
 using System;
+using System.CodeDom.Compiler;
 using UnityEngine.UIElements;
 
 public partial class BasicEffectComponent
 {
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
     private static UIComponentEffectAttribute[] UIC_EffectAttributes;
 
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
     private static void UIC_InitializeEffectAttributes()
     {
         UIC_EffectAttributes = new [] {
@@ -20,7 +23,8 @@ private static void UIC_InitializeEffectAttributes()
         Array.Sort(UIC_EffectAttributes);
     }
 
-    protected override void ApplyEffects()
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
+    protected override void UIC_ApplyEffects()
     {
         if (UIC_EffectAttributes == null)
             UIC_InitializeEffectAttributes();

diff --git a/...neratorSnapshotTests.It_Works_With_Subclasses.00BaseEffectComponent.Effects.g.verified.cs b/...neratorSnapshotTests.It_Works_With_Subclasses.00BaseEffectComponent.Effects.g.verified.cs
@@ -5,12 +5,15 @@
 // </auto-generated>
 
 using System;
+using System.CodeDom.Compiler;
 using UnityEngine.UIElements;
 
 public partial class BaseEffectComponent
 {
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
     private static UIComponentEffectAttribute[] UIC_EffectAttributes;
 
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
     private static void UIC_InitializeEffectAttributes()
     {
         UIC_EffectAttributes = new [] {
@@ -19,7 +22,8 @@ private static void UIC_InitializeEffectAttributes()
         Array.Sort(UIC_EffectAttributes);
     }
 
-    protected override void ApplyEffects()
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
+    protected override void UIC_ApplyEffects()
     {
         if (UIC_EffectAttributes == null)
             UIC_InitializeEffectAttributes();

diff --git a/...pshotTests.It_Works_With_Subclasses.01SecondSubclassEffectComponent.Effects.g.verified.cs b/...pshotTests.It_Works_With_Subclasses.01SecondSubclassEffectComponent.Effects.g.verified.cs
@@ -5,12 +5,15 @@
 // </auto-generated>
 
 using System;
+using System.CodeDom.Compiler;
 using UnityEngine.UIElements;
 
 public partial class SecondSubclassEffectComponent
 {
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
     private static UIComponentEffectAttribute[] UIC_EffectAttributes;
 
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
     private static void UIC_InitializeEffectAttributes()
     {
         UIC_EffectAttributes = new [] {
@@ -21,7 +24,8 @@ private static void UIC_InitializeEffectAttributes()
         Array.Sort(UIC_EffectAttributes);
     }
 
-    protected override void ApplyEffects()
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
+    protected override void UIC_ApplyEffects()
     {
         if (UIC_EffectAttributes == null)
             UIC_InitializeEffectAttributes();

diff --git a/...torSnapshotTests.It_Works_With_Subclasses.02SubclassEffectComponent.Effects.g.verified.cs b/...torSnapshotTests.It_Works_With_Subclasses.02SubclassEffectComponent.Effects.g.verified.cs
@@ -5,12 +5,15 @@
 // </auto-generated>
 
 using System;
+using System.CodeDom.Compiler;
 using UnityEngine.UIElements;
 
 public partial class SubclassEffectComponent
 {
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
     private static UIComponentEffectAttribute[] UIC_EffectAttributes;
 
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
     private static void UIC_InitializeEffectAttributes()
     {
         UIC_EffectAttributes = new [] {
@@ -20,7 +23,8 @@ private static void UIC_InitializeEffectAttributes()
         Array.Sort(UIC_EffectAttributes);
     }
 
-    protected override void ApplyEffects()
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
+    protected override void UIC_ApplyEffects()
     {
         if (UIC_EffectAttributes == null)
             UIC_InitializeEffectAttributes();

diff --git a/...ests.It_Allows_Overriding_Base_Class_Attribute.00BaseLayoutComponent.Layout.g.verified.cs b/...ests.It_Allows_Overriding_Base_Class_Attribute.00BaseLayoutComponent.Layout.g.verified.cs
@@ -5,11 +5,13 @@
 // </auto-generated>
 
 using System.Threading.Tasks;
+using System.CodeDom.Compiler;
 using UnityEngine.UIElements;
 
 public partial class BaseLayoutComponent
 {
-    protected override Task<VisualTreeAsset> StartLayoutLoad()
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
+    protected override Task<VisualTreeAsset> UIC_StartLayoutLoad()
     {
         return AssetResolver.LoadAsset<VisualTreeAsset>("Components/BaseLayoutComponent");
     }

diff --git a/...t_Allows_Overriding_Base_Class_Attribute.01OverriddenLayoutComponent.Layout.g.verified.cs b/...t_Allows_Overriding_Base_Class_Attribute.01OverriddenLayoutComponent.Layout.g.verified.cs
@@ -5,11 +5,13 @@
 // </auto-generated>
 
 using System.Threading.Tasks;
+using System.CodeDom.Compiler;
 using UnityEngine.UIElements;
 
 public partial class OverriddenLayoutComponent
 {
-    protected override Task<VisualTreeAsset> StartLayoutLoad()
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
+    protected override Task<VisualTreeAsset> UIC_StartLayoutLoad()
     {
         return AssetResolver.LoadAsset<VisualTreeAsset>("Components/OverriddenLayoutComponent");
     }

diff --git a/....Tests/Snapshots/LayoutAugmentGeneratorSnapshotTests.It_Generates_Layout_Call.verified.cs b/....Tests/Snapshots/LayoutAugmentGeneratorSnapshotTests.It_Generates_Layout_Call.verified.cs
@@ -5,11 +5,13 @@
 // </auto-generated>
 
 using System.Threading.Tasks;
+using System.CodeDom.Compiler;
 using UnityEngine.UIElements;
 
 public partial class LayoutTestComponent
 {
-    protected override Task<VisualTreeAsset> StartLayoutLoad()
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
+    protected override Task<VisualTreeAsset> UIC_StartLayoutLoad()
     {
         return AssetResolver.LoadAsset<VisualTreeAsset>("Components/LayoutTestComponent");
     }

diff --git a/...shotTests.It_Handles_Nested_Types.00ParentClass.FirstNestedComponent.Layout.g.verified.cs b/...shotTests.It_Handles_Nested_Types.00ParentClass.FirstNestedComponent.Layout.g.verified.cs
@@ -5,13 +5,15 @@
 // </auto-generated>
 
 using System.Threading.Tasks;
+using System.CodeDom.Compiler;
 using UnityEngine.UIElements;
 
 public partial class ParentClass 
 {
 public partial class FirstNestedComponent
 {
-    protected override Task<VisualTreeAsset> StartLayoutLoad()
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
+    protected override Task<VisualTreeAsset> UIC_StartLayoutLoad()
     {
         return AssetResolver.LoadAsset<VisualTreeAsset>("Components/FirstNestedComponent");
     }

diff --git a/...hotTests.It_Handles_Nested_Types.01ParentClass.SecondNestedComponent.Layout.g.verified.cs b/...hotTests.It_Handles_Nested_Types.01ParentClass.SecondNestedComponent.Layout.g.verified.cs
@@ -5,13 +5,15 @@
 // </auto-generated>
 
 using System.Threading.Tasks;
+using System.CodeDom.Compiler;
 using UnityEngine.UIElements;
 
 public partial class ParentClass 
 {
 private partial class SecondNestedComponent
 {
-    protected override Task<VisualTreeAsset> StartLayoutLoad()
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
+    protected override Task<VisualTreeAsset> UIC_StartLayoutLoad()
     {
         return AssetResolver.LoadAsset<VisualTreeAsset>("Components/SecondNestedComponent");
     }

diff --git a/.../LayoutAugmentGeneratorSnapshotTests.It_Takes_AssetPathAttribute_Into_Account.verified.cs b/.../LayoutAugmentGeneratorSnapshotTests.It_Takes_AssetPathAttribute_Into_Account.verified.cs
@@ -5,11 +5,13 @@
 // </auto-generated>
 
 using System.Threading.Tasks;
+using System.CodeDom.Compiler;
 using UnityEngine.UIElements;
 
 public partial class LayoutTestComponent
 {
-    protected override Task<VisualTreeAsset> StartLayoutLoad()
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
+    protected override Task<VisualTreeAsset> UIC_StartLayoutLoad()
     {
         return AssetResolver.LoadAsset<VisualTreeAsset>("UI/Components/LayoutTestComponent");
     }

diff --git a/...atorSnapshotTests.It_Uses_Base_Class_Attribute.00BaseLayoutComponent.Layout.g.verified.cs b/...atorSnapshotTests.It_Uses_Base_Class_Attribute.00BaseLayoutComponent.Layout.g.verified.cs
@@ -5,11 +5,13 @@
 // </auto-generated>
 
 using System.Threading.Tasks;
+using System.CodeDom.Compiler;
 using UnityEngine.UIElements;
 
 public partial class BaseLayoutComponent
 {
-    protected override Task<VisualTreeAsset> StartLayoutLoad()
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
+    protected override Task<VisualTreeAsset> UIC_StartLayoutLoad()
     {
         return AssetResolver.LoadAsset<VisualTreeAsset>("Components/BaseLayoutComponent");
     }

diff --git a/...apshotTests.It_Uses_Base_Class_Attribute.01SuperclassLayoutComponent.Layout.g.verified.cs b/...apshotTests.It_Uses_Base_Class_Attribute.01SuperclassLayoutComponent.Layout.g.verified.cs
@@ -5,11 +5,13 @@
 // </auto-generated>
 
 using System.Threading.Tasks;
+using System.CodeDom.Compiler;
 using UnityEngine.UIElements;
 
 public partial class SuperclassLayoutComponent
 {
-    protected override Task<VisualTreeAsset> StartLayoutLoad()
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
+    protected override Task<VisualTreeAsset> UIC_StartLayoutLoad()
     {
         return AssetResolver.LoadAsset<VisualTreeAsset>("Components/BaseLayoutComponent");
     }

diff --git a/...torSnapshotTests.It_Uses_Base_Class_Attribute.02ThirdLayoutComponent.Layout.g.verified.cs b/...torSnapshotTests.It_Uses_Base_Class_Attribute.02ThirdLayoutComponent.Layout.g.verified.cs
@@ -5,11 +5,13 @@
 // </auto-generated>
 
 using System.Threading.Tasks;
+using System.CodeDom.Compiler;
 using UnityEngine.UIElements;
 
 public partial class ThirdLayoutComponent
 {
-    protected override Task<VisualTreeAsset> StartLayoutLoad()
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
+    protected override Task<VisualTreeAsset> UIC_StartLayoutLoad()
     {
         return AssetResolver.LoadAsset<VisualTreeAsset>("Components/BaseLayoutComponent");
     }

diff --git a/.../ProvideAugmentGeneratorSnapshotTests.It_Can_Be_Used_On_Non_UIComponent_Class.verified.cs b/.../ProvideAugmentGeneratorSnapshotTests.It_Can_Be_Used_On_Non_UIComponent_Class.verified.cs
@@ -6,10 +6,12 @@
 
 using System;
 using UIComponents;
+using System.CodeDom.Compiler;
 using UnityEngine.UIElements;
 
 public partial class MyClass
 {
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
     private void UIC_SetProvideField<TField, TCastFrom>(ref TField value, string fieldName) where TField : class where TCastFrom : class
     {
         try
@@ -26,7 +28,8 @@ public partial class MyClass
         }
     }
 
-    protected override void PopulateProvideFields()
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
+    protected override void UIC_PopulateProvideFields()
     {
         UIC_SetProvideField<IDependency, IDependency>(ref Dependency, "Dependency");
         UIC_SetProvideField<Dependency, IDependency>(ref ConcreteDependency, "ConcreteDependency");

diff --git a/...GeneratorSnapshotTests.It_Does_Not_Generate_For_Non_Interface_Or_Class_Fields.verified.cs b/...GeneratorSnapshotTests.It_Does_Not_Generate_For_Non_Interface_Or_Class_Fields.verified.cs
@@ -6,10 +6,12 @@
 
 using System;
 using UIComponents;
+using System.CodeDom.Compiler;
 using UnityEngine.UIElements;
 
 public partial class InvalidProvideComponent
 {
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
     private void UIC_SetProvideField<TField, TCastFrom>(ref TField value, string fieldName) where TField : class where TCastFrom : class
     {
         try
@@ -26,7 +28,8 @@ public partial class InvalidProvideComponent
         }
     }
 
-    protected override void PopulateProvideFields()
+    [GeneratedCode("UIComponents.Roslyn.Generation", "0.26.0")]
+    protected override void UIC_PopulateProvideFields()
     {
         UIC_SetProvideField<IDependency, IDependency>(ref Dependency, "Dependency");
     }