add: script template + chore

Author: sator-imaging

Editor/EditorExtension.cs

@@ -0,0 +1,107 @@
+#if UNITY_EDITOR
+
+using System.Collections;
+using System.Collections.Generic;
+using UnityEditor;
+using UnityEngine;
+using UnityEditor.Callbacks;
+using System;
+using System.Reflection;
+
+namespace SatorImaging.UnitySourceGenerator
+{
+    class EditorExtension
+    {
+        const string ROOT_MENU = @"Assets/Unity Source Generator/";
+        const string TEMPLATE_PATH = @"Packages/com.sator-imaging.alt-source-generator/Template/Template_";
+        const string CS_EXT = @".cs";
+        const string TXT_EXT = @".txt";
+
+
+        [MenuItem(ROOT_MENU + "Force Generate while Overwriting Disabled")]
+        static void ForceGenerateSelectedScripts()
+        {
+            USGEngine.IgnoreOverwriteSettingByAttribute = true;  // always disabled after import event.
+
+            foreach (var GUID in Selection.assetGUIDs)
+            {
+                var path = AssetDatabase.GUIDToAssetPath(GUID);
+                AssetDatabase.ImportAsset(path);
+            }
+        }
+
+
+        [MenuItem(ROOT_MENU + "Method Generator Template", priority = 100)]
+        static void MethodGenerator()
+        {
+            ProjectWindowUtil.CreateScriptAssetFromTemplateFile(
+                TEMPLATE_PATH + nameof(MethodGenerator) + TXT_EXT,
+                nameof(MethodGenerator) + CS_EXT);
+        }
+
+
+        [MenuItem(ROOT_MENU + "Generic Generator Template", priority = 100)]
+        static void GenericGenerator()
+        {
+            ProjectWindowUtil.CreateScriptAssetFromTemplateFile(
+                TEMPLATE_PATH + nameof(GenericGenerator) + TXT_EXT,
+                nameof(GenericGenerator) + CS_EXT);
+        }
+
+
+        /* kept for reference. USGEngine update seems to work as expected.
+        // NOTE: This will prevent Unity to reload updated scripts in background.
+        //       Unity doesn't invoke asset import event correctly when load script in background.
+        [InitializeOnLoadMethod]
+        static void InitializeFocusChangedEvent()
+        {
+            //https://github.com/Unity-Technologies/UnityCsReference/blob/master/Editor/Mono/EditorApplication.cs#L275
+            var focusChanged = typeof(EditorApplication).GetField("focusChanged",
+                BindingFlags.Static | BindingFlags.NonPublic);
+            if (focusChanged == null) return;
+
+            var focusAction = focusChanged.GetValue(null) as Action<bool>;
+            focusAction -= OnEditorApplicationFocus;
+            focusAction += OnEditorApplicationFocus;
+            focusChanged.SetValue(null, focusAction);
+
+            s_restoreAutoRefresh = EditorPrefs.GetInt(PREF_AUTO_REFRESH, EditorPrefs.GetInt(PREF_AUTO_REFRESH_OLD));
+            s_restoreDirMonitoring = EditorPrefs.GetBool(PREF_DIR_MONITORING);
+        }
+
+        const string PREF_AUTO_REFRESH = "kAutoRefreshMode";
+        const string PREF_AUTO_REFRESH_OLD = "kAutoRefresh";
+        const string PREF_DIR_MONITORING = "DirectoryMonitoring";
+        static bool s_restoreDirMonitoring;
+        static int s_restoreAutoRefresh;
+        static void OnEditorApplicationFocus(bool focus)
+        {
+            //https://github.com/Unity-Technologies/UnityCsReference/blob/master/Editor/Mono/PreferencesWindow/AssetPipelinePreferences.cs#L94
+            if (focus == false)
+            {
+                s_restoreAutoRefresh = EditorPrefs.GetInt(PREF_AUTO_REFRESH, EditorPrefs.GetInt(PREF_AUTO_REFRESH_OLD));
+                s_restoreDirMonitoring = EditorPrefs.GetBool(PREF_DIR_MONITORING);
+                //AssetDatabase.DisallowAutoRefresh();
+                EditorApplication.LockReloadAssemblies();
+                EditorPrefs.GetBool(PREF_DIR_MONITORING, false);
+                EditorPrefs.SetInt(PREF_AUTO_REFRESH, 0);
+                EditorPrefs.SetInt(PREF_AUTO_REFRESH_OLD, 0);
+            }
+            else
+            {
+                //AssetDatabase.AllowAutoRefresh();
+                EditorApplication.UnlockReloadAssemblies();
+                EditorPrefs.GetBool(PREF_DIR_MONITORING, s_restoreDirMonitoring);
+                EditorPrefs.SetInt(PREF_AUTO_REFRESH, s_restoreAutoRefresh);
+                EditorPrefs.SetInt(PREF_AUTO_REFRESH_OLD, s_restoreAutoRefresh);
+
+                AssetDatabase.Refresh();
+            }
+            Debug.Log($"[USG] Focus:{focus} / AutoRefresh:{s_restoreAutoRefresh} / DirMonitoring:{s_restoreDirMonitoring}");
+        }
+        */
+
+    }
+}
+
+#endif

Editor/EditorExtension.cs.meta

@@ -13,19 +13,6 @@ namespace SatorImaging.UnitySourceGenerator
 {
     public class USGUtility
     {
-        [MenuItem("Assets/Unity Source Generator/Force Generate while Overwriting Disabled")]
-        static void ForceGenerateSelectedScripts()
-        {
-            USGEngine.IgnoreOverwriteSettingByAttribute = true;  // always disabled after import event.
-
-            foreach (var GUID in Selection.assetGUIDs)
-            {
-                var path = AssetDatabase.GUIDToAssetPath(GUID);
-                AssetDatabase.ImportAsset(path);
-            }
-        }
-
-
         ///<summary>Force perform source code generation by class name.</summary>
         ///<param name="showInProjectPanel">works only when Unity is not building app.</param>
         public static void ForceGenerateByName(string clsName, bool showInProjectPanel = true)

Editor/USGUtility.cs

@@ -5,7 +5,7 @@ namespace Sample
 {
     // HOW TO USE: Add the following attribute to *target* class.
     //             Note that target class must be defined as partial.
-    // [UnitySourceGenerator(typeof(Sample.PanicMethodGenerator)]
+    // [UnitySourceGenerator(typeof(Sample.PanicMethodGenerator))]
     public class PanicMethodGenerator
     {
         static string OutputFileName() => "PanicMethod.cs";  // -> PanicMethod.<TargetClass>.<GeneratorClass>.g.cs

Sample/PanicMethodGenerator.cs

@@ -0,0 +1,34 @@
+#if UNITY_EDITOR
+#pragma warning disable IDE0051
+
+using SatorImaging.UnitySourceGenerator;
+using System.Text;
+using Debug = UnityEngine.Debug;
+
+#ROOTNAMESPACEBEGIN#
+    // NOTE: Copy this file to Assets/ folder to enable source generator.
+    //       USG process files in Assets/ folder only.
+    [UnitySourceGenerator(OverwriteIfFileExists = false)]
+    class #SCRIPTNAME#
+    {
+        static string OutputFileName() => "Test.cs";  // -> Test.<ClassName>.g.cs
+
+        static bool Emit(USGContext context, StringBuilder sb)
+        {
+            // write content into passed StringBuilder.
+            sb.AppendLine($"Asset Path: {context.AssetPath}");
+            sb.AppendLine($"Hello World from {typeof(#SCRIPTNAME#)}");
+
+            // you can modify output path. initial file name is that USG updated.
+            // NOTE: USG doesn't care the modified path is valid or not.
+            context.OutputPath += "_MyFirstTest.txt";
+
+            // return true to tell USG to write content into OutputPath. false to do nothing.
+            return true;
+        }
+
+    }
+#ROOTNAMESPACEEND#
+
+#pragma warning restore IDE0051
+#endif

Template.meta

@@ -0,0 +1,53 @@
+#if UNITY_EDITOR
+#pragma warning disable IDE0051
+
+using SatorImaging.UnitySourceGenerator;
+using System.Text;
+using Debug = UnityEngine.Debug;
+
+#ROOTNAMESPACEBEGIN#
+    // HOW TO USE: Add the following attribute to *target* class.
+    //             Note that target class must be defined as partial.
+    // [UnitySourceGenerator(typeof(#SCRIPTNAME#), OverwriteIfFileExists = false)]
+    public class #SCRIPTNAME#
+    {
+        const string METHOD_NAME = "Panic";
+        static string OutputFileName() => METHOD_NAME + ".cs";  // -> Panic.<TargetClass>.<GeneratorClass>.g.cs
+
+        static bool Emit(USGContext context, StringBuilder sb)
+        {
+            if (!context.TargetClass.IsClass || context.TargetClass.IsAbstract)
+                return false;  // return false to tell USG doesn't write file.
+
+            // code generation
+            sb.Append($@"
+using System.Collections;
+using System.Collections.Generic;
+using UnityEngine;
+
+namespace {context.TargetClass.Namespace}
+{{
+    internal partial class {context.TargetClass.Name}
+    {{
+        public void {METHOD_NAME}()
+        {{
+");
+            // Method Implementation
+            var INDENT = "            ";
+
+
+
+            // End of Method Implementation
+            sb.Append($@"
+        }}
+    }}
+}}
+");
+            return true;
+        }
+
+    }
+#ROOTNAMESPACEEND#
+
+#pragma warning restore IDE0051
+#endif