rabidus-test/Assets/Plugins/QFSW/Quantum Console/Source/Scripts/QuantumConsoleProcessor.cs

#if UNITY_EDITOR || !UNITY_WEBGL
#define THREADS_SUPPORTED
#endif

using QFSW.QC.Internal;
using QFSW.QC.Utilities;
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
using System.Runtime.CompilerServices;
using System.Threading;
using System.Threading.Tasks;
using UnityEngine;

namespace QFSW.QC
{
    public enum LoggingLevel
    {
        None = 0,
        Errors = 1,
        Warnings = 2,
        Full = 3
    }

    /// <summary>The core processor of Quantum Console handling command table generation and invocation.</summary>
    public static partial class QuantumConsoleProcessor
    {
        /// <summary>The logging level to use during operation of the Quantum Console Processor.</summary>
        public static LoggingLevel loggingLevel = LoggingLevel.Full;

        private static readonly QuantumParser _parser = new QuantumParser();
        private static readonly QuantumPreprocessor _preprocessor = new QuantumPreprocessor();
        private static readonly ConcurrentDictionary<string, CommandData> _commandTable = new ConcurrentDictionary<string, CommandData>();

        public static bool TableGenerated { get; private set; }
        public static bool TableIsGenerating { get; private set; }

        [Command("command-count", "Gets the number of loaded commands")]
        public static int LoadedCommandCount => _loadedCommandCount;
        private static int _loadedCommandCount = 0;

        private static readonly Assembly[] _loadedAssemblies = AppDomain.CurrentDomain.GetAssemblies();

        /// <summary>
        /// Gets all loaded commands.
        /// </summary>
        /// <returns>All loaded commands.</returns>
        public static IEnumerable<CommandData> GetAllCommands()
        {
            return _commandTable.Values;
        }

        #region Table Generation
        /// <summary>
        /// Generates the command table so that commands can be invoked.
        /// </summary>
        /// <param name="deployThread">If set to <c>true</c> a second thread will be deployed for the table generation.</param>
        /// <param name="forceReload">If set to <c>true</c> then the table will be cleared and generated again.</param>
        public static void GenerateCommandTable(bool deployThread = false, bool forceReload = false)
        {
#if THREADS_SUPPORTED
            if (deployThread)
            {
                ThreadPool.QueueUserWorkItem(state =>
                {
                    try
                    {
                        GenerateCommandTable(false, forceReload);
                    }
                    catch (Exception e)
                    {
                        Debug.LogException(e);
                    }
                });

                return;
            }
#endif

            lock (_commandTable)
            {
                if (!TableGenerated || forceReload)
                {
                    TableIsGenerating = true;
                    {
                        if (forceReload && TableGenerated)
                        {
                            _commandTable.Clear();
                            _loadedCommandCount = 0;
                        }

#if THREADS_SUPPORTED
                        Parallel.ForEach(_loadedAssemblies, assembly =>
                        {
                            if (AssemblyRequiresScan(assembly))
                            {
                                LoadCommandsFromAssembly(assembly);
                            }
                        });
#else
                        foreach (Assembly assembly in _loadedAssemblies)
                        {
                            if (AssemblyRequiresScan(assembly))
                            {
                                LoadCommandsFromAssembly(assembly);
                            }
                        }
#endif
                    }

                    TableIsGenerating = false;
                    TableGenerated = true;
                    GC.Collect(3, GCCollectionMode.Forced, false, true);
                }
            }
        }

        private static IEnumerable<(MethodInfo method, MemberInfo member)> ExtractCommandMethods(Type type)
        {
            const BindingFlags flags = 
                  BindingFlags.Static 
                | BindingFlags.Instance 
                | BindingFlags.Public
                | BindingFlags.NonPublic
                | BindingFlags.DeclaredOnly;

            MethodInfo[] methods = type.GetMethods(flags);
            PropertyInfo[] properties = type.GetProperties(flags);
            FieldInfo[] fields = type.GetFields(flags);

            foreach (MethodInfo method in methods)
            {
                yield return (method, method);
            }

            foreach (PropertyInfo property in properties)
            {
                if (property.CanWrite)
                {
                    yield return (property.SetMethod, property);
                }
                if (property.CanRead)
                {
                    yield return (property.GetMethod, property);
                }
            }

            foreach (FieldInfo field in fields)
            {
                if (field.HasAttribute<CommandAttribute>())
                {
                    if (field.IsDelegate())
                    {
                        if (field.IsStrongDelegate())
                        {
                            FieldDelegateMethod executer = new FieldDelegateMethod(field);
                            yield return (executer, field);
                        }
                        else if (loggingLevel >= LoggingLevel.Warnings)
                        {
                            Debug.LogWarning($"Quantum Processor Warning: Could not add '{field.Name}' from {field.DeclaringType} to the table as it is an invalid delegate type.");
                        }
                    }
                    else
                    {
                        FieldAutoMethod reader = new FieldAutoMethod(field, FieldAutoMethod.AccessType.Read);
                        yield return (reader, field);

                        if (!(field.IsLiteral || field.IsInitOnly))
                        {
                            FieldAutoMethod writer = new FieldAutoMethod(field, FieldAutoMethod.AccessType.Write);
                            yield return (writer, field);
                        }
                    }
                }
            }
        }

        private static bool GetCommandSupported(CommandData command, out string unsupportedReason)
        {
            for (int i = 0; i < command.ParamCount; i++)
            {
                ParameterInfo param = command.MethodParamData[i];
                Type paramType = param.ParameterType;

                if (!_parser.CanParse(paramType) && !paramType.IsGenericParameter)
                {
                    unsupportedReason = $"Parameter type {paramType} is not supported by the Quantum Parser.";
                    return false;
                }
            }

            if (command.MonoTarget != MonoTargetType.Registry
                && !command.MethodData.IsStatic
                && !command.MethodData.DeclaringType.IsDerivedTypeOf(typeof(MonoBehaviour)))
            {
                unsupportedReason = $"Non static non MonoBehaviour commands are incompatible with MonoTargetType.{command.MonoTarget}.";
                return false;
            }

            unsupportedReason = string.Empty;
            return true;
        }

        private static bool AssemblyRequiresScan(Assembly assembly)
        {
            if (assembly.HasAttribute<QcIgnoreAttribute>(false))
            {
                return false;
            }

            string[] bannedPrefixes = new string[]
            {
                "System", "Unity", "Microsoft", "Mono.", "mscorlib", "NSubstitute", "JetBrains", "nunit.",
                "GeNa."
#if QC_DISABLE_BUILTIN_ALL
                , "QFSW.QC"
#elif QC_DISABLE_BUILTIN_EXTRA
                , "QFSW.QC.Extra"
#endif
            };

            string[] bannedAssemblies = new string[]
            {
                "mcs", "AssetStoreTools"
            };

            string assemblyFullName = assembly.FullName;
            foreach (string prefix in bannedPrefixes)
            {
                if (assemblyFullName.StartsWith(prefix))
                {
                    return false;
                }
            }

            string assemblyShortName = assembly.GetName().Name;
            foreach (string name in bannedAssemblies)
            {
                if (assemblyShortName == name)
                {
                    return false;
                }
            }

            return true;
        }

        private static void LoadCommandsFromAssembly(Assembly assembly)
        {
            Type[] loadedTypes = assembly.GetTypes();
            foreach (Type type in loadedTypes)
            {
                try
                {
                    LoadCommandsFromType(type);
                }
                catch (TypeLoadException)
                {
                    // Issue under investigation

                    /*
                    if (loggingLevel >= LoggingLevel.Warnings)
                    {
                        Debug.LogWarning($"Unable to extract command data from type {type} in assembly {assembly.GetName().Name} as it may be corrupted. The following exception was thrown: {e.Message}");
                    }
                    */
                }
                catch (BadImageFormatException)
                {
                    // Confirmed to be an issue on Unity/Mono's side
                    // Extremely unlikely that it will ever occur in user code, so for this reason it is ignored silently
                    // QC Issue: https://bitbucket.org/QFSW/quantum-console/issues/67/add-protection-against-corrupt-dlls
                    // Unity Issue: https://issuetracker.unity3d.com/issues/badimageformatexception-is-thrown-when-calling-getcustomattributes-on-certain-memberinfo-instances
                    // Mono Issue: https://github.com/mono/mono/issues/17278

                    /*
                    if (loggingLevel >= LoggingLevel.Warnings)
                    {
                        Debug.LogWarning($"Unable to extract command data from type {type} in assembly {assembly.GetName().Name} as it may be corrupted. The following exception was thrown: {e.Message}");
                    }
                    */
                }
            }
        }

        private static void LoadCommandsFromType(Type type)
        {
            if (type.HasAttribute<QcIgnoreAttribute>(false)) return;
            if (type.HasAttribute<CompilerGeneratedAttribute>(true)) { return; }

            foreach ((MethodInfo method, MemberInfo member) in ExtractCommandMethods(type))
            {
                if (member.DeclaringType == type)
                {
                    LoadCommandsFromMember(member, method);
                }
            }
        }

        private static void LoadCommandsFromMember(MemberInfo member, MethodInfo method)
        {
            IEnumerable<CommandAttribute> commandAttributes = member.GetCustomAttributes<CommandAttribute>();
            CommandDescriptionAttribute descriptionAttribute = member.GetCustomAttribute<CommandDescriptionAttribute>();

            foreach (CommandAttribute commandAttribute in commandAttributes)
            {
                if (!commandAttribute.Valid)
                {
                    if (loggingLevel >= LoggingLevel.Warnings)
                    {
                        Debug.LogWarning($"Quantum Processor Warning: Could not add '{commandAttribute.Alias}' to the table as it is invalid.");
                    }
                }
                else
                {
                    CommandPlatformAttribute platformAttribute = member.GetCustomAttribute<CommandPlatformAttribute>();
                    Platform commandPlatforms = platformAttribute?.SupportedPlatforms ?? commandAttribute.SupportedPlatforms;
                    if (commandPlatforms.HasFlag(Application.platform.ToPlatform()))
                    {
                        IEnumerable<CommandData> newCommands = CreateCommandOverloads(method, commandAttribute, descriptionAttribute);
                        foreach (CommandData command in newCommands)
                        {
                            TryAddCommand(command);
                        }
                    }
                }
            }
        }

        private static IEnumerable<CommandData> CreateCommandOverloads(MethodInfo method, CommandAttribute commandAttribute, CommandDescriptionAttribute descriptionAttribute)
        {
            int defaultParameters = method.GetParameters().Count(x => x.HasDefaultValue);
            for (int i = 0; i < defaultParameters + 1; i++)
            {
                CommandData command = new CommandData(method, commandAttribute, descriptionAttribute, i);
                yield return command;
            }
        }

        private static string GenerateCommandKey(CommandData command)
        {
            return $"{command.CommandName}({command.ParamCount})";
        }

        /// <summary>
        /// Registers a new command.
        /// </summary>
        /// <param name="command">The command to register.</param>
        /// <returns>If the addition was successful.</returns>
        public static bool TryAddCommand(CommandData command)
        {
            if (!GetCommandSupported(command, out string reason))
            {
                if (loggingLevel >= LoggingLevel.Warnings)
                {
                    Debug.LogWarning($"Quantum Processor Warning: Could not add '{command.CommandSignature}' from {command.MethodData.DeclaringType.GetDisplayName()} " +
                        $"to the table as it is not supported. {reason}");
                }

                return false;
            }

            string key = GenerateCommandKey(command);
            bool alreadyExists = !_commandTable.TryAdd(key, command);

            if (alreadyExists)
            {
                if (loggingLevel >= LoggingLevel.Warnings)
                {
                    string fullMethodName = $"{command.MethodData.DeclaringType.FullName}.{command.MethodData.Name}";
                    Debug.LogWarning($"Quantum Processor Warning: Could not add {fullMethodName} to the table as another method with the same alias and parameter count, {key}, already exists.");
                }

                return false;
            }

            Interlocked.Increment(ref _loadedCommandCount);
            return true;
        }

        /// <summary>
        /// Removes an existing command.
        /// </summary>
        /// <param name="command">The command to remove.</param>
        /// <returns>If the removal was successful.</returns>
        public static bool TryRemoveCommand(CommandData command)
        {
            string key = GenerateCommandKey(command);
            if (_commandTable.TryRemove(key, out _))
            {
                Interlocked.Decrement(ref _loadedCommandCount);
                return true;
            }

            return false;
        }
        #endregion

        #region Command Invocation
        /// <summary>Invokes a command on the QuantumConsoleProcessor.</summary>
        /// <returns>Return value of the invocation.</returns>
        /// <param name="commandString">The command to invoke.</param>
        public static object InvokeCommand(string commandString)
        {
            GenerateCommandTable();

            commandString = commandString.Trim();
            commandString = _preprocessor.Process(commandString);

            if (string.IsNullOrWhiteSpace(commandString)) { throw new ArgumentException("Cannot parse an empty string."); }
            string[] commandParts = commandString.SplitScoped(' ');
            commandParts = commandParts.Where(x => !string.IsNullOrWhiteSpace(x)).ToArray();

            string commandName = commandParts[0];
            string[] commandParams = commandParts.SubArray(1, commandParts.Length - 1);
            int paramCount = commandParams.Length;

            string[] commandNameParts = commandName.Split(new[] { '<' }, 2);
            string genericSignature = commandNameParts.Length > 1 ? $"<{commandNameParts[1]}" : "";
            commandName = commandNameParts[0];

            string keyName = $"{commandName}({paramCount})";
            if (!_commandTable.ContainsKey(keyName))
            {
                bool overloadExists = _commandTable.Keys.Any(key => key.Contains($"{commandName}(") && _commandTable[key].CommandName == commandName);
                if (overloadExists) { throw new ArgumentException($"No overload of '{commandName}' with {paramCount} parameters could be found."); }
                else { throw new ArgumentException($"Command '{commandName}' could not be found."); }
            }
            CommandData command = _commandTable[keyName];

            Type[] genericTypes = Array.Empty<Type>();
            if (command.IsGeneric)
            {
                int expectedArgCount = command.GenericParamTypes.Length;
                string[] genericArgNames = genericSignature.ReduceScope('<', '>').SplitScoped(',');
                if (genericArgNames.Length == expectedArgCount)
                {
                    genericTypes = new Type[genericArgNames.Length];
                    for (int i = 0; i < genericTypes.Length; i++)
                    {
                        genericTypes[i] = QuantumParser.ParseType(genericArgNames[i]);
                    }
                }
                else
                {
                    throw new ArgumentException($"Generic command '{commandName}' requires {expectedArgCount} generic parameter{(expectedArgCount == 1 ? "" : "s")} but was supplied with {genericArgNames.Length}.");
                }
            }
            else if (genericSignature != string.Empty)
            {
                throw new ArgumentException($"Command '{commandName}' is not a generic command and cannot be invoked as such.");
            }

#if !UNITY_EDITOR && ENABLE_IL2CPP
            if (genericTypes.Any((Type x) => x.IsValueType))
            {
                throw new NotSupportedException("Value types in generic commands are not currently supported by Unity in IL2CPP");
            }
#endif

            object[] parsedCommandParams = ParseParamData(command.MakeGenericArguments(genericTypes), commandParams);
            return command.Invoke(parsedCommandParams, genericTypes);
        }

        private static object[] ParseParamData(Type[] paramTypes, string[] paramData)
        {
            object[] parsedData = new object[paramData.Length];
            for (int i = 0; i < parsedData.Length; i++)
            {
                parsedData[i] = _parser.Parse(paramData[i], paramTypes[i]);
            }

            return parsedData;
        }
        #endregion

        /// <summary>Gets suggestions for possible commands given the currently entered command fragment.</summary>
        /// <returns>All commands suggested for the provided fragment.</returns>
        /// <param name="incompleteCommandName">Incomplete command name to base the search off of.</param>
        /// <param name="fuzzy">If fuzzy search is disabled, then your current search must match the beginning of the command to be suggested (foo*). If fuzzy search is enabled, it can be anywhere within the command name to be suggested (*foo*).</param>
        /// <param name="caseSensitive">If the search should be case sensitive or not.</param>
        /// <param name="includeOverloads">If multiple overloads of the same command should be included.</param>
        public static IEnumerable<CommandData> GetCommandSuggestions(string incompleteCommandName, bool fuzzy = false, bool caseSensitive = true, bool includeOverloads = true)
        {
            if (string.IsNullOrWhiteSpace(incompleteCommandName))
            {
                return Enumerable.Empty<CommandData>();
            }

            HashSet<string> foundNames = includeOverloads ? null : new HashSet<string>();
            List<CommandData> foundCommands = new List<CommandData>();

            bool MatchFound(string incompleteCommand, string commandSuggestion)
            {
                if (commandSuggestion.Length < incompleteCommand.Length) { return false; }

                if (fuzzy)
                {
                    if (caseSensitive) { return commandSuggestion.Contains(incompleteCommand); }
                    else { return commandSuggestion.ContainsCaseInsensitive(incompleteCommand); }
                }
                else
                {
                    return commandSuggestion.StartsWith(incompleteCommand, !caseSensitive, null);
                }
            }

            foreach (CommandData command in _commandTable.Values)
            {
                if (includeOverloads || !foundNames.Contains(command.CommandName))
                {
                    if (MatchFound(incompleteCommandName, command.CommandName))
                    {
                        if (!includeOverloads) { foundNames.Add(command.CommandName); }
                        foundCommands.Add(command);
                    }
                }
            }

            IOrderedEnumerable<CommandData> sortedSuggestions;

            if (includeOverloads)
            {
                sortedSuggestions = foundCommands.OrderBy(x => x.ParamCount)
                                                 .OrderBy(x => x.CommandName)
                                                 .OrderBy(x => x.CommandName.Length);
            }
            else
            {
                sortedSuggestions = foundCommands.OrderBy(x => x.CommandName)
                                                 .OrderBy(x => x.CommandName.Length);
            }

            if (fuzzy)
            {
                if (caseSensitive)
                {
                    sortedSuggestions = sortedSuggestions.OrderBy(x => x.CommandName.IndexOf(incompleteCommandName, StringComparison.CurrentCulture));
                }
                else
                {
                    sortedSuggestions = sortedSuggestions.OrderBy(x => x.CommandName.IndexOf(incompleteCommandName, StringComparison.CurrentCultureIgnoreCase));
                }
            }

            return sortedSuggestions;
        }
    }
}