UnityExplorer/src/UI/Utility/ToStringUtility.cs

using System;
using System.Collections;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
using System.Text;
using UnityEngine;
using UnityEngine.EventSystems;
using UnityExplorer.Core.Runtime;

namespace UnityExplorer.UI.Utility
{
    public static class ToStringUtility
    {
        internal static Dictionary<string, MethodInfo> toStringMethods = new Dictionary<string, MethodInfo>();
        internal static Dictionary<string, MethodInfo> toStringFormattedMethods = new Dictionary<string, MethodInfo>();

        // string allocs
        private static readonly StringBuilder _stringBuilder = new StringBuilder(16384);
        private const string nullString = "<color=grey>null</color>";
        private const string destroyedString = "<color=red>Destroyed</color>";
        private const string untitledString = "<i><color=grey>untitled</color></i>";

        private const string eventSystemNamespace = "UnityEngine.EventSystem";

        public static string ToStringWithType(object value, Type fallbackType, bool includeNamespace = true)
        {
            if (value == null && fallbackType == null)
                return nullString;

            Type type = value?.GetActualType() ?? fallbackType;

            string richType = SignatureHighlighter.Parse(type, includeNamespace);

            _stringBuilder.Clear();

            if (value.IsNullOrDestroyed())
            {
                if (value == null)
                {
                    _stringBuilder.Append(nullString);
                    AppendRichType(_stringBuilder, richType);
                    return _stringBuilder.ToString();
                }
                else // destroyed unity object
                {
                    _stringBuilder.Append(destroyedString);
                    AppendRichType(_stringBuilder, richType);
                    return _stringBuilder.ToString();
                }
            }

            if (value is UnityEngine.Object obj)
            {
                var name = obj.name;
                if (string.IsNullOrEmpty(name))
                    name = untitledString;
                else if (name.Length > 50)
                    name = $"{name.Substring(0, 50)}...";

                _stringBuilder.Append($"\"{name}\"");
                AppendRichType(_stringBuilder, richType);
            }
            else if (type.FullName.StartsWith(eventSystemNamespace))
            {
                // UnityEngine.EventSystem classes can have some obnoxious ToString results with rich text.
                _stringBuilder.Append(richType);
            }
            else
            {
                var toString = ToString(value);

                if (typeof(IEnumerable).IsAssignableFrom(type))
                {
                    if (value is IList iList)
                        _stringBuilder.Append($"[{iList.Count}] ");
                    else
                        if (value is ICollection iCol)
                        _stringBuilder.Append($"[{iCol.Count}] ");
                    else
                        _stringBuilder.Append("[?] ");
                }
                else if (typeof(IDictionary).IsAssignableFrom(type))
                {
                    if (value is IDictionary iDict)
                        _stringBuilder.Append($"[{iDict.Count}] ");
                    else
                        _stringBuilder.Append("[?] ");
                }

                if (type.IsGenericType 
                    || toString == type.FullName 
                    || toString == $"{type.FullName} {type.FullName}"
                    || toString == $"Il2Cpp{type.FullName}" || type.FullName == $"Il2Cpp{toString}")
                {
                    _stringBuilder.Append(richType);
                }
                else // the ToString contains some actual implementation, use that value.
                {
                    // prune long strings unless they're unity structs
                    // (Matrix4x4 and Rect can have some longs ones that we want to display fully)
                    if (toString.Length > 100 && !(type.IsValueType && type.FullName.StartsWith("UnityEngine")))
                        _stringBuilder.Append(toString.Substring(0, 100));
                    else
                        _stringBuilder.Append(toString);

                    AppendRichType(_stringBuilder, richType);
                }
            }

            return _stringBuilder.ToString();
        }

        private static void AppendRichType(StringBuilder sb, string richType)
        {
            sb.Append(' ');
            sb.Append('(');
            sb.Append(richType);
            sb.Append(')');
        }

        private static string ToString(object value)
        {
            if (value.IsNullOrDestroyed())
            {
                if (value == null)
                    return nullString;
                else // destroyed unity object
                    return destroyedString;
            }

            var type = value.GetActualType();

            // Find and cache the relevant ToString method for this Type, if haven't already.

            if (!toStringMethods.ContainsKey(type.AssemblyQualifiedName))
            {
                try
                {
                    var formatMethod = type.GetMethod("ToString", new Type[] { typeof(string) });
                    formatMethod.Invoke(value, new object[] { "F3" });
                    toStringFormattedMethods.Add(type.AssemblyQualifiedName, formatMethod);
                    toStringMethods.Add(type.AssemblyQualifiedName, null);
                }
                catch
                {
                    var toStringMethod = type.GetMethod("ToString", new Type[0]);
                    toStringMethods.Add(type.AssemblyQualifiedName, toStringMethod);
                }
            }

            // Invoke the ToString method on the object

            value = value.TryCast(type);

            string toString;
            try
            {
                if (toStringFormattedMethods.TryGetValue(type.AssemblyQualifiedName, out MethodInfo f3method))
                    toString = (string)f3method.Invoke(value, new object[] { "F3" });
                else
                    toString = (string)toStringMethods[type.AssemblyQualifiedName].Invoke(value, new object[0]);
            }
            catch (Exception ex)
            {
                toString = ex.ReflectionExToString();
            }

            string _ = null;
            toString = ReflectionUtility.ProcessTypeInString(type, toString, ref _);

#if CPP
            if (value is Il2CppSystem.Type cppType)
            {
                var monoType = Il2CppReflection.GetUnhollowedType(cppType);
                if (monoType != null)
                    toString = ReflectionUtility.ProcessTypeInString(monoType, toString, ref _);
            }
#endif

            return toString;
        }
    }
}