com.wallstop-studios.unity-helpers 2.0.0-rc61 → 2.0.0-rc62

package/Editor/AnimationCopier.cs

@@ -121,8 +121,7 @@
                 if (animationClip == null)
                 {
                     this.LogError(
-                        "Invalid AnimationClip (null) found at path '{0}', skipping.",
-                        path
+                        $"Invalid AnimationClip (null) found at path '{path}', skipping."
                     );
                     continue;
                 }
@@ -136,9 +135,7 @@
                 if (prefixIndex < 0)
                 {
                     this.LogWarn(
-                        "Unsupported animation at '{0}', expected to be prefixed by '{1}'.",
-                        path,
-                        prefix
+                        $"Unsupported animation at '{path}', expected to be prefixed by '{prefix}'."
                     );
                     continue;
                 }
@@ -159,18 +156,14 @@
                     bool deleteSuccessful = AssetDatabase.DeleteAsset(path);
                     if (!deleteSuccessful)
                     {
-                        this.LogError("Failed to delete asset at path '{0}'.", path);
+                        this.LogError($"Failed to delete asset at path '{path}'.");
                     }
 
                     ++processed;
                 }
                 else
                 {
-                    this.LogError(
-                        "Failed to copy animation from '{0}' to '{1}'.",
-                        path,
-                        destination
-                    );
+                    this.LogError($"Failed to copy animation from '{path}' to '{destination}'.");
                 }
             }
 

package/Editor/AnimationCreator.cs

@@ -113,7 +113,7 @@
                         }
                         else
                         {
-                            this.LogWarn("Failed to process frame {0}.", frameName);
+                            this.LogWarn($"Failed to process frame {frameName}.");
                         }
                     }
 
@@ -179,7 +179,7 @@
                 string animationName = data.animationName;
                 if (string.IsNullOrWhiteSpace(animationName))
                 {
-                    this.LogWarn("Ignoring animationData without an animation name.");
+                    this.LogWarn($"Ignoring animationData without an animation name.");
                     continue;
                 }
 
@@ -187,9 +187,7 @@
                 if (framesPerSecond <= 0)
                 {
                     this.LogWarn(
-                        "Ignoring animationData with FPS of {0} with name {1}.",
-                        framesPerSecond,
-                        animationName
+                        $"Ignoring animationData with FPS of {framesPerSecond} with name {animationName}."
                     );
                     continue;
                 }
@@ -198,8 +196,7 @@
                 if (frames is not { Count: > 0 })
                 {
                     this.LogWarn(
-                        "Ignoring animationData without frames with name {0}.",
-                        animationName
+                        $"Ignoring animationData without frames with name {animationName}."
                     );
                     continue;
                 }
@@ -227,8 +224,7 @@
                 if (keyFrames.Count <= 0)
                 {
                     this.LogWarn(
-                        "Ignoring animationData with empty frames with name {0}.",
-                        animationName
+                        $"Ignoring animationData with empty frames with name {animationName}."
                     );
                     continue;
                 }

package/Editor/AnimatorControllerCopier.cs

@@ -99,8 +99,7 @@
                 if (animatorController == null)
                 {
                     this.LogError(
-                        "Invalid Animator Controller (null) found at path '{0}', skipping.",
-                        path
+                        $"Invalid Animator Controller (null) found at path '{path}', skipping."
                     );
                     continue;
                 }
@@ -114,9 +113,7 @@
                 if (prefixIndex < 0)
                 {
                     this.LogWarn(
-                        "Unsupported AnimatorController at '{0}', expected to be prefixed by '{1}'.",
-                        path,
-                        prefix
+                        $"Unsupported AnimatorController at '{path}', expected to be prefixed by '{prefix}'."
                     );
                     continue;
                 }
@@ -138,8 +135,7 @@
                     if (!deleteSuccessful)
                     {
                         this.LogError(
-                            "Failed to delete Animator Controller asset at path '{0}'.",
-                            path
+                            $"Failed to delete Animator Controller asset at path '{path}'."
                         );
                     }
 
@@ -148,9 +144,7 @@
                 else
                 {
                     this.LogError(
-                        "Failed to copy Animator Controller from '{0}' to '{1}'.",
-                        path,
-                        destination
+                        $"Failed to copy Animator Controller from '{path}' to '{destination}'."
                     );
                 }
             }

package/Editor/CustomEditors/MatchColliderToSpriteEditor.cs

@@ -17,9 +17,7 @@
             if (matchColliderToSprite == null)
             {
                 this.LogError(
-                    "Target was of type {0}, expected {1}.",
-                    target?.GetType(),
-                    typeof(MatchColliderToSprite)
+                    $"Target was of type {target?.GetType()}, expected {nameof(MatchColliderToSprite)}."
                 );
                 return;
             }

package/Editor/FitTextureSizeWizard.cs

@@ -71,7 +71,7 @@
             textures = textures.Distinct().OrderBy(texture => texture.name).ToList();
             if (textures.Count <= 0)
             {
-                this.Log("Failed to find any texture paths.");
+                this.Log($"Failed to find any texture paths.");
                 return;
             }
 
@@ -140,7 +140,7 @@
             }
             else
             {
-                this.Log("No textures updated.");
+                this.Log($"No textures updated.");
             }
         }
     }

package/Editor/PrefabCheckWizard.cs

@@ -60,13 +60,12 @@
                         Type scriptType = script?.GetType();
                         if (scriptType == null)
                         {
-                            prefab.LogError("Detected missing script.");
+                            prefab.LogError($"Detected missing script.");
                         }
                         else
                         {
                             prefab.LogError(
-                                "Detected missing script for script type {0}.",
-                                scriptType
+                                $"Detected missing script for script type {scriptType}."
                             );
                         }
 
@@ -111,7 +110,7 @@
                 {
                     if (fieldValue == null)
                     {
-                        component.LogError("Field {0} (array) was null.", field.Name);
+                        component.LogError($"Field {field.Name} (array) was null.");
                         continue;
                     }
 
@@ -141,20 +140,18 @@
 
                 continue;
 
-                bool LogIfNull(object thing, int? position = null)
+                bool LogIfNull(object thing, int? elementIndex = null)
                 {
                     if (thing == null || (thing is Object unityThing && !unityThing))
                     {
-                        if (position == null)
+                        if (elementIndex == null)
                         {
-                            component.LogError("Field {0} has a null element in it.", field.Name);
+                            component.LogError($"Field {field.Name} has a null element in it.");
                         }
                         else
                         {
                             component.LogError(
-                                "Field {0} has a null element at position {1}.",
-                                field.Name,
-                                position
+                                $"Field {field.Name} has a null element at position {elementIndex}."
                             );
                         }
 

package/Editor/SpriteSettingsApplier.cs

@@ -172,7 +172,7 @@
                 }
             }
 
-            this.Log("Processed {0} sprites.", spriteCount);
+            this.Log($"Processed {spriteCount} sprites.");
             if (0 < spriteCount)
             {
                 AssetDatabase.Refresh();

package/Editor/TextureResizerWizard.cs

@@ -155,17 +155,12 @@
                         byte[] bytes = copy.EncodeToPNG();
                         File.WriteAllBytes(assetPath, bytes);
                         this.Log(
-                            "Resized {0} from [{1}x{2}] to [{3}x{4}]",
-                            texture.name,
-                            texture.width,
-                            texture.height,
-                            copy.width,
-                            copy.height
+                            $"Resized {texture.name} from [{texture.width}x{texture.height}] to [{copy.width}x{copy.height}]"
                         );
                     }
                     catch (Exception e)
                     {
-                        this.LogError("Failed to resize {0}.", e, texture.name);
+                        this.LogError($"Failed to resize {texture.name}.", e);
                     }
                     finally
                     {

package/Editor/TextureSettingsApplier.cs

@@ -125,7 +125,7 @@
                 }
             }
 
-            this.Log("Processed {0} textures.", textureCount);
+            this.Log($"Processed {textureCount} textures.");
             if (0 < textureCount)
             {
                 AssetDatabase.Refresh();

package/Runtime/Core/Extension/ColorExtensions.cs

@@ -20,6 +20,21 @@
     {
         private static readonly Dictionary<Vector3Int, int> ColorBucketCache = new();
 
+        public static string ToHex(this Color color, bool includeAlpha = true)
+        {
+            int r = (int)(Mathf.Clamp01(color.r) * 255f);
+            int g = (int)(Mathf.Clamp01(color.g) * 255f);
+            int b = (int)(Mathf.Clamp01(color.b) * 255f);
+
+            if (!includeAlpha)
+            {
+                return $"#{r:X2}{g:X2}{b:X2}";
+            }
+
+            int a = (int)(Mathf.Clamp01(color.a) * 255f);
+            return $"#{r:X2}{g:X2}{b:X2}{a:X2}";
+        }
+
         public static Color GetAverageColor(
             this Sprite sprite,
             ColorAveragingMethod method = ColorAveragingMethod.LAB,

package/Runtime/Core/Extension/LoggingExtensions.cs

@@ -6,17 +6,21 @@ namespace UnityHelpers.Core.Extension
 {
     using System;
     using System.Collections.Generic;
+    using System.Linq;
     using System.Reflection;
-    using System.Runtime.CompilerServices;
     using System.Threading;
-    using JetBrains.Annotations;
+    using Helper;
+    using Helper.Logging;
     using UnityEngine;
     using Utils;
-    using Debug = UnityEngine.Debug;
     using Object = UnityEngine.Object;
 
     public static class LoggingExtensions
     {
+        public static readonly UnityLogTagFormatter LogInstance = new(
+            createDefaultDecorators: true
+        );
+
         private static readonly Thread UnityMainThread;
         private const int LogsPerCacheClean = 5;
 
@@ -24,8 +28,10 @@ namespace UnityHelpers.Core.Extension
         private static long _cacheAccessCount;
 
         private static readonly HashSet<Object> Disabled = new();
-        private static readonly Dictionary<Type, FieldInfo[]> FieldCache = new();
-        private static readonly Dictionary<Type, PropertyInfo[]> PropertyCache = new();
+        private static readonly Dictionary<Type, (string, Func<object, object>)[]> MetadataCache =
+            new();
+
+        private static readonly Dictionary<string, object> GenericObject = new();
 
         static LoggingExtensions()
         {
@@ -33,7 +39,7 @@ namespace UnityHelpers.Core.Extension
             /*
                 Unity throws exceptions if you try to log on something that isn't the main thread.
                 Sometimes, it's nice to log in async Tasks. Assume that the first initialization of
-                this class will be done by the Unity main thread, and then check every time we log.
+                this class will be done by the Unity main thread and then check every time we log.
                 If the logging thread is not the unity main thread, then do nothing
                 (instead of throwing...)
              */
@@ -61,6 +67,7 @@ namespace UnityHelpers.Core.Extension
             Disabled.Add(component);
         }
 
+        [HideInCallstack]
         public static string GenericToString(this Object component)
         {
             if (component == null)
@@ -68,148 +75,114 @@ namespace UnityHelpers.Core.Extension
                 return "null";
             }
 
-            Dictionary<string, object> structure = new();
-            Type type = component.GetType();
-            FieldInfo[] fields = FieldCache.GetOrAdd(
-                type,
-                inType => inType.GetFields(BindingFlags.Public | BindingFlags.Instance)
-            );
-            PropertyInfo[] properties = PropertyCache.GetOrAdd(
-                type,
-                inType => inType.GetProperties(BindingFlags.Public | BindingFlags.Instance)
+            (string, Func<object, object>)[] metadataAccess = MetadataCache.GetOrAdd(
+                component.GetType(),
+                inType =>
+                    inType
+                        .GetFields(BindingFlags.Public | BindingFlags.Instance)
+                        .Select(field => (field.Name, ReflectionHelpers.GetFieldGetter(field)))
+                        .Concat(
+                            inType
+                                .GetProperties(BindingFlags.Public | BindingFlags.Instance)
+                                .Select(property =>
+                                    (property.Name, ReflectionHelpers.GetPropertyGetter(property))
+                                )
+                        )
+                        .ToArray()
             );
-            foreach (FieldInfo field in fields)
-            {
-                structure[field.Name] = ValueFormat(field.GetValue(component));
-            }
-
-            foreach (PropertyInfo property in properties)
-            {
-                structure[property.Name] = ValueFormat(property.GetValue(component));
-            }
-
-            return structure.ToJson();
 
-            object ValueFormat(object value)
+            GenericObject.Clear();
+            foreach ((string name, Func<object, object> access) in metadataAccess)
             {
-                if (value is Object obj)
+                try
+                {
+                    string valueFormat = ValueFormat(access(component));
+                    if (valueFormat != null)
+                    {
+                        GenericObject[name] = valueFormat;
+                    }
+                }
+                catch
                 {
-                    return obj != null ? obj.name : null;
+                    // Skip
                 }
-                return value?.ToString();
             }
-        }
-
-        [StringFormatMethod("message")]
-        public static void Log(this Object component, string message, params object[] args)
-        {
-#if ENABLE_UBERLOGGING
-            LogDebug(component, message, args);
-#endif
-        }
 
-        [StringFormatMethod("message")]
-        public static void LogMethod(this Object component, [CallerMemberName] string caller = "")
-        {
-#if ENABLE_UBERLOGGING
-            LogDebug(component, caller);
-#endif
+            return GenericObject.ToJson();
         }
 
-        [StringFormatMethod("message")]
-        public static void LogDebug(this Object component, string message, params object[] args)
+        [HideInCallstack]
+        private static string ValueFormat(object value)
         {
-#if ENABLE_UBERLOGGING
-            LogDebug(component, message, null, args);
-#endif
-        }
-
-        [StringFormatMethod("message")]
-        public static void LogWarn(this Object component, string message, params object[] args)
-        {
-#if ENABLE_UBERLOGGING
-            LogWarn(component, message, null, args);
-#endif
-        }
-
-        [StringFormatMethod("message")]
-        public static void LogError(this Object component, string message, params object[] args)
-        {
-#if ENABLE_UBERLOGGING
-            LogError(component, message, null, args);
-#endif
+            if (value is Object obj)
+            {
+                return obj != null ? obj.name : "null";
+            }
+            return value?.ToString();
         }
 
-        [StringFormatMethod("message")]
+        [HideInCallstack]
         public static void Log(
             this Object component,
-            string message,
-            Exception e,
-            params object[] args
+            FormattableString message,
+            Exception e = null,
+            bool pretty = true
         )
         {
 #if ENABLE_UBERLOGGING
-            LogDebug(component, message, e, args);
+            LogDebug(component, message, e, pretty);
 #endif
         }
 
-        [StringFormatMethod("message")]
+        [HideInCallstack]
         public static void LogDebug(
             this Object component,
-            string message,
-            Exception e,
-            params object[] args
+            FormattableString message,
+            Exception e = null,
+            bool pretty = true
         )
         {
 #if ENABLE_UBERLOGGING
             if (LoggingAllowed(component))
             {
-                Debug.Log(
-                    Wrap(component, args.Length != 0 ? string.Format(message, args) : message, e),
-                    component
-                );
+                LogInstance.Log(message, component, e, pretty);
             }
 #endif
         }
 
-        [StringFormatMethod("message")]
+        [HideInCallstack]
         public static void LogWarn(
             this Object component,
-            string message,
-            Exception e,
-            params object[] args
+            FormattableString message,
+            Exception e = null,
+            bool pretty = true
         )
         {
 #if ENABLE_UBERLOGGING
             if (LoggingAllowed(component))
             {
-                Debug.LogWarning(
-                    Wrap(component, args.Length != 0 ? string.Format(message, args) : message, e),
-                    component
-                );
+                LogInstance.LogWarn(message, component, e, pretty);
             }
 #endif
         }
 
-        [StringFormatMethod("message")]
+        [HideInCallstack]
         public static void LogError(
             this Object component,
-            string message,
-            Exception e,
-            params object[] args
+            FormattableString message,
+            Exception e = null,
+            bool pretty = true
         )
         {
 #if ENABLE_UBERLOGGING
             if (LoggingAllowed(component))
             {
-                Debug.LogError(
-                    Wrap(component, args.Length != 0 ? string.Format(message, args) : message, e),
-                    component
-                );
+                LogInstance.LogError(message, component, e, pretty);
             }
 #endif
         }
 
+        [HideInCallstack]
         private static bool LoggingAllowed(Object component)
         {
             if (Interlocked.Increment(ref _cacheAccessCount) % LogsPerCacheClean == 0)
@@ -234,31 +207,5 @@ namespace UnityHelpers.Core.Extension
                 && Equals(Thread.CurrentThread, UnityMainThread)
                 && !Disabled.Contains(component);
         }
-
-        private static string Wrap(Object component, string message, Exception e)
-        {
-#if ENABLE_UBERLOGGING
-            float now = Time.time;
-            string componentType;
-            string gameObjectName;
-            if (component != null)
-            {
-                componentType = component.GetType().Name;
-                gameObjectName = component.name;
-            }
-            else
-            {
-                componentType = "NO_TYPE";
-                gameObjectName = "NO_NAME";
-            }
-
-            return e != null
-                ? $"{now}|{gameObjectName}[{componentType}]|{message}\n    {e}"
-                : $"{now}|{gameObjectName}[{componentType}]|{message}";
-
-#else
-            return string.Empty;
-#endif
-        }
     }
 }

package/Runtime/Core/Helper/Helpers.cs

@@ -411,7 +411,7 @@
                 }
                 catch
                 {
-                    original.LogWarn("Failed to copy public field {0}.", field.Name);
+                    original.LogWarn($"Failed to copy public field {field.Name}.");
                 }
             }
 
@@ -426,7 +426,7 @@
                 }
                 catch
                 {
-                    original.LogWarn("Failed to copy non-public field {0}.", field.Name);
+                    original.LogWarn($"Failed to copy non-public field {field.Name}.");
                 }
             }
 
@@ -443,7 +443,7 @@
                 }
                 catch
                 {
-                    original.LogWarn("Failed to copy property {0}.", property.Name);
+                    original.LogWarn($"Failed to copy property {property.Name}.");
                 }
             }