Fix null reference exception when no element is selected

Eastrall · Mar 5, 2022 · 48f5c42 · 48f5c42
1 parent a8fb7c6
commit 48f5c42
Show file tree

Hide file tree

Showing 11 changed files with 110 additions and 55 deletions.
diff --git a/Editor/Scripts/Generator/RosalinaBindingsGenerator.cs b/Editor/Scripts/Generator/RosalinaBindingsGenerator.cs
@@ -9,7 +9,7 @@
 using UnityEngine;
 using UnityEngine.UIElements;
 
-internal class RosalinaBindingsGenerator : IRosalinaGenerator
+internal class RosalinaBindingsGenerator
 {
     private static readonly string GeneratedCodeHeader = @$"//------------------------------------------------------------------------------
 // <auto-generated>
@@ -64,9 +64,6 @@ public RosalinaGenerationResult Generate(UIDocumentAsset document, string output
         ClassDeclarationSyntax @class = SyntaxFactory.ClassDeclaration(document.Name)
             .AddModifiers(SyntaxFactory.Token(SyntaxKind.PublicKeyword))
             .AddModifiers(SyntaxFactory.Token(SyntaxKind.PartialKeyword))
-            //.AddBaseListTypes(
-            //    SyntaxFactory.SimpleBaseType(SyntaxFactory.ParseName(typeof(MonoBehaviour).Name))
-            //)
             .AddMembers(documentVariable)
             .AddMembers(classMembers);
 
@@ -138,7 +135,7 @@ private static InitializationStatement[] GenerateInitializeStatements(UxmlDocume
         MemberAccessExpressionSyntax documentQueryMethodAccess = CreateRootQueryMethodAccessor();
         IEnumerable<UxmlNode> childNodes = uxmlDocument.GetChildren();
 
-        foreach (var node in childNodes)
+        foreach (UxmlNode node in childNodes)
         {
             var uiProperty = new UIPropertyDescriptor(node.Type, node.Name);
             Type uiPropertyType = UIPropertyTypes.GetUIElementType(uiProperty.Type);

diff --git a/Editor/Scripts/Generator/RosalinaScriptGenerator.cs b/Editor/Scripts/Generator/RosalinaScriptGenerator.cs
@@ -5,8 +5,11 @@
 using System.IO;
 using UnityEngine;
 
-internal class RosalinaScriptGenerator : IRosalinaGenerator
+internal class RosalinaScriptGenerator
 {
+    private const string InitializeMethodName = "InitializeDocument";
+    private const string UnityInitializeHookName = "OnEnable";
+
     public RosalinaGenerationResult Generate(UIDocumentAsset document, string outputFileName)
     {
         if (document is null)
@@ -21,11 +24,11 @@ public RosalinaGenerationResult Generate(UIDocumentAsset document, string output
 
         var initializeDocumentMethod = SyntaxFactory.ExpressionStatement(
             SyntaxFactory.InvocationExpression(
-                SyntaxFactory.IdentifierName("InitializeDocument")
+                SyntaxFactory.IdentifierName(InitializeMethodName)
             )
         );
 
-        MethodDeclarationSyntax onEnableMethod = RosalinaSyntaxFactory.CreateMethod("void", "OnEnable", SyntaxKind.PrivateKeyword)
+        MethodDeclarationSyntax onEnableMethod = RosalinaSyntaxFactory.CreateMethod("void", UnityInitializeHookName, SyntaxKind.PrivateKeyword)
             .WithBody(SyntaxFactory.Block(initializeDocumentMethod));
 
         ClassDeclarationSyntax @class = SyntaxFactory.ClassDeclaration(document.Name)

diff --git a/Editor/Scripts/IRosalinaGenerator.cs b/Editor/Scripts/IRosalinaGenerator.cs
diff --git a/Editor/Scripts/MenuItems/RosalinaGenerateBindingsMenuItem.cs b/Editor/Scripts/MenuItems/RosalinaGenerateBindingsMenuItem.cs
@@ -1,5 +1,4 @@
 using System;
-using System.IO;
 using UnityEditor;
 using UnityEngine;
 using UnityEngine.UIElements;
@@ -13,16 +12,15 @@ private static void GenerateUIBindings()
     {
         string assetPath = AssetDatabase.GetAssetPath(Selection.activeObject);
         var document = new UIDocumentAsset(assetPath);
-        IRosalinaGenerator generator = new RosalinaBindingsGenerator();
 
         try
         {
             EditorUtility.DisplayProgressBar("Rosalina", $"Generating {document.Name} UI bindings...", 50);
             Debug.Log($"[Rosalina]: Generating UI bindings for {assetPath}");
 
-            RosalinaGenerationResult result = generator.Generate(document, $"{document.Name}.g.cs");
+            RosalinaGenerationResult result = RosalinaGenerator.GenerateBindings(document, $"{document.Name}.g.cs");
+            result.Save();
 
-            File.WriteAllText(result.OutputFilePath, result.Code);
             AssetDatabase.Refresh();
 
             Debug.Log($"[Rosalina]: Done generating UI bindings: {document.Name} (output: {result.OutputFilePath})");
@@ -40,6 +38,6 @@ private static void GenerateUIBindings()
     [MenuItem(MenuItemPath, true)]
     private static bool GenerateUIBindingsValidation()
     {
-        return Selection.activeObject.GetType() == typeof(VisualTreeAsset);
+        return Selection.activeObject != null && Selection.activeObject.GetType() == typeof(VisualTreeAsset);
     }
 }
diff --git a/Editor/Scripts/MenuItems/RosalinaGenerateScriptMenuItem.cs b/Editor/Scripts/MenuItems/RosalinaGenerateScriptMenuItem.cs
@@ -16,33 +16,7 @@ public static void GenerateUIScript()
 
         try
         {
-            bool refreshAssetDatabase = false;
-            string scriptName = $"{document.Name}.cs";
-            string scriptPath = Path.Combine(document.Path, scriptName);
-            string generatedBindingsScriptName = $"{document.Name}.g.cs";
-            string generatedBindingsScriptPath = Path.Combine(document.Path, generatedBindingsScriptName);
-
-            if (!File.Exists(generatedBindingsScriptPath) && AskGenerateBindings())
-            {
-                Debug.Log($"[Rosalina]: Generating UI code behind for {generatedBindingsScriptPath}");
-                RosalinaGenerationResult result = new RosalinaBindingsGenerator().Generate(document, generatedBindingsScriptName);
-
-                File.WriteAllText(result.OutputFilePath, result.Code);
-                Debug.Log($"[Rosalina]: Done generating: {document.Name} (output: {result.OutputFilePath})");
-                refreshAssetDatabase = true;
-            }
-
-            if (!File.Exists(scriptPath) || File.Exists(scriptPath) && AskOverrideExistingScript())
-            {
-                Debug.Log($"[Rosalina]: Generating UI script for {scriptPath}");
-                RosalinaGenerationResult result = new RosalinaScriptGenerator().Generate(document, scriptName);
-
-                File.WriteAllText(result.OutputFilePath, result.Code);
-                Debug.Log($"[Rosalina]: Done generating: {document.Name} (output: {result.OutputFilePath})");
-                refreshAssetDatabase = true;
-            }
-
-            if (refreshAssetDatabase)
+            if (TryGenerateBindings(document) || TryGenerateScript(document))
             {
                 AssetDatabase.Refresh();
             }
@@ -60,7 +34,47 @@ public static void GenerateUIScript()
     [MenuItem(MenuItemPath, true)]
     public static bool GenerateUIScriptValidation()
     {
-        return Selection.activeObject.GetType() == typeof(VisualTreeAsset);
+        return Selection.activeObject != null && Selection.activeObject.GetType() == typeof(VisualTreeAsset);
+    }
+
+    private static bool TryGenerateBindings(UIDocumentAsset document)
+    {
+        string generatedBindingsScriptName = $"{document.Name}.g.cs";
+        string generatedBindingsScriptPath = Path.Combine(document.Path, generatedBindingsScriptName);
+
+        if (!File.Exists(generatedBindingsScriptPath) && AskGenerateBindings())
+        {
+            Debug.Log($"[Rosalina]: Generating UI code behind for {generatedBindingsScriptPath}");
+
+            RosalinaGenerationResult result = RosalinaGenerator.GenerateBindings(document, generatedBindingsScriptName);
+            result.Save();
+
+            Debug.Log($"[Rosalina]: Done generating: {document.Name} (output: {result.OutputFilePath})");
+
+            return true;
+        }
+
+        return false;
+    }
+
+    private static bool TryGenerateScript(UIDocumentAsset document)
+    {
+        string scriptName = $"{document.Name}.cs";
+        string scriptPath = Path.Combine(document.Path, scriptName);
+
+        if (!File.Exists(scriptPath) || File.Exists(scriptPath) && AskOverrideExistingScript())
+        {
+            Debug.Log($"[Rosalina]: Generating UI script for {scriptPath}");
+
+            RosalinaGenerationResult result = RosalinaGenerator.GenerateScript(document, scriptName);
+            result.Save();
+
+            Debug.Log($"[Rosalina]: Done generating: {document.Name} (output: {result.OutputFilePath})");
+
+            return true;
+        }
+
+        return false;
     }
 
     private static bool AskOverrideExistingScript()

diff --git a/Editor/Scripts/RosalinaAssetProcessor.cs b/Editor/Scripts/RosalinaAssetProcessor.cs
@@ -20,16 +20,15 @@ private static void OnPostprocessAllAssets(string[] importedAssets, string[] del
             {
                 string uiDocumentPath = uiFilesChanged[i];
                 var document = new UIDocumentAsset(uiDocumentPath);
-                IRosalinaGenerator generator = new RosalinaBindingsGenerator();
 
                 try
                 {
                     EditorUtility.DisplayProgressBar("Rosalina", $"Generating {document.Name} bindings...", GeneratePercentage(i, uiFilesChanged.Length));
                     Debug.Log($"[Rosalina]: Generating UI bindings for {uiDocumentPath}");
 
-                    RosalinaGenerationResult result = generator.Generate(document, $"{document.Name}.g.cs");
+                    RosalinaGenerationResult result = RosalinaGenerator.GenerateBindings(document, $"{document.Name}.g.cs");
+                    result.Save();
 
-                    File.WriteAllText(result.OutputFilePath, result.Code);
                     Debug.Log($"[Rosalina]: Done generating: {document.Name} (output: {result.OutputFilePath})");
                 }
                 catch (Exception ex)

diff --git a/Editor/Scripts/RosalinaConstants.cs b/Editor/Scripts/RosalinaConstants.cs
@@ -1,4 +1,4 @@
 public class RosalinaConstants
 {
-    public const string Version = "1.0.0";
+    public const string Version = "1.0.1";
 }
diff --git a/Editor/Scripts/RosalinaGenerationResult.cs b/Editor/Scripts/RosalinaGenerationResult.cs
@@ -1,12 +1,36 @@
-internal class RosalinaGenerationResult
+using System.IO;
+
+/// <summary>
+/// Describes a generation result.
+/// </summary>
+internal class RosalinaGenerationResult
 {
+    /// <summary>
+    /// Gets the generated code.
+    /// </summary>
     public string Code { get; }
 
+    /// <summary>
+    /// Gets the output file path.
+    /// </summary>
     public string OutputFilePath { get; }
 
+    /// <summary>
+    /// Creates a new <see cref="RosalinaGenerationResult"/> instance.
+    /// </summary>
+    /// <param name="code">Generated code.</param>
+    /// <param name="outputFilePath">Output file path.</param>
     public RosalinaGenerationResult(string code, string outputFilePath)
     {
         Code = code;
         OutputFilePath = outputFilePath;
     }
+
+    /// <summary>
+    /// Saves the result to the output path.
+    /// </summary>
+    public void Save()
+    {
+        File.WriteAllText(OutputFilePath, Code);
+    }
 }
diff --git a/Editor/Scripts/RosalinaGenerator.cs b/Editor/Scripts/RosalinaGenerator.cs
@@ -0,0 +1,24 @@
+internal static class RosalinaGenerator
+{
+    /// <summary>
+    /// Generates a C# script containing the bindings of the given UI document.
+    /// </summary>
+    /// <param name="document">UI Document.</param>
+    /// <param name="outputFileName">C# script output file.</param>
+    /// <returns>Rosalina generation result.</returns>
+    public static RosalinaGenerationResult GenerateBindings(UIDocumentAsset document, string outputFileName)
+    {
+        return new RosalinaBindingsGenerator().Generate(document, outputFileName);
+    }
+
+    /// <summary>
+    /// Geneartes a C# script for the UI logic.
+    /// </summary>
+    /// <param name="document">UI Document asset information.</param>
+    /// <param name="outputFileName">Output file name.</param>
+    /// <returns>Rosalina generation result.</returns>
+    public static RosalinaGenerationResult GenerateScript(UIDocumentAsset document, string outputFileName)
+    {
+        return new RosalinaScriptGenerator().Generate(document, outputFileName);
+    }
+}
diff --git a/Editor/Scripts/IRosalinaGenerator.cs.meta → Editor/Scripts/RosalinaGenerator.cs.meta b/Editor/Scripts/IRosalinaGenerator.cs.meta → Editor/Scripts/RosalinaGenerator.cs.meta
diff --git a/package.json b/package.json
@@ -1,8 +1,10 @@
 {
   "name": "com.eastylabs.rosalina",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "type": "tool",
   "displayName": "Rosalina",
   "unity": "2021.2",
-  "description": "Rosalina is an UI Toolkit extension tool that generates C# binding scripts based on a UXML template."
+  "description": "Rosalina is an UI Toolkit extension tool that generates C# binding scripts based on a UXML template.",
+  "hideInEditor": true,
+  "unityRelease": "7f1"
 }