DynamicLoadingFunctions.cs

/*----------------------------------------------------------
This Source Code Form is subject to the terms of the 
Mozilla Public License, v.2.0. If a copy of the MPL 
was not distributed with this file, You can obtain one 
at http://mozilla.org/MPL/2.0/.
----------------------------------------------------------*/

using OneScript.Commons;
using OneScript.Compilation;
using OneScript.Contexts;
using OneScript.Exceptions;
using OneScript.Execution;
using OneScript.Language;
using OneScript.Localization;
using OneScript.StandardLibrary.Collections;
using OneScript.StandardLibrary.NativeApi;
using ScriptEngine;
using ScriptEngine.Machine;
using ScriptEngine.Machine.Contexts;
using System;

namespace OneScript.StandardLibrary
{
    /// <summary>
    /// Динамическое подключение сценариев
    /// </summary>
    [GlobalContext(ManualRegistration = true, Category = "Динамическое подключение сценариев")]
    public class DynamicLoadingFunctions : GlobalContextBase<DynamicLoadingFunctions>
    {
        private readonly ScriptingEngine _engine;

        public DynamicLoadingFunctions(ScriptingEngine engine)
        {
            _engine = engine;
        }
        
        /// <summary>
        /// Подключает сторонний файл сценария к текущей системе типов.
        /// Подключенный сценарий выступает как самостоятельный класс, создаваемый оператором Новый
        /// </summary>
        /// <param name="path">Путь к подключаемому сценарию</param>
        /// <param name="typeName">Имя типа, которое будет иметь новый класс. Экземпляры класса создаются оператором Новый. </param>
        /// <example>ПодключитьСценарий("C:\file.os", "МойОбъект");
        /// А = Новый МойОбъект();</example>
        [ContextMethod("ПодключитьСценарий", "AttachScript")]
        public void AttachScript(IBslProcess process, string path, string typeName)
        {
            var compiler = _engine.GetCompilerService();
            try
            {
                _engine.AttachedScriptsFactory.AttachByPath(compiler, path, typeName, process);
            }
            catch (Exception e) when (e is SyntaxErrorException || e is CompilerException)
            {
                throw ScriptCompilingException(e);
            }
        }

        /// <summary>
        /// Создает экземпляр объекта на основании стороннего файла сценария.
        /// Загруженный сценарий возвращается как самостоятельный объект. 
        /// Экспортные свойства и методы скрипта доступны для вызова.
        /// </summary>
        /// <param name="process"></param>
        /// <param name="code">Текст сценария</param>
        /// <param name="externalContext">Структура. Глобальные свойства, которые будут инжектированы в область видимости загружаемого скрипта. (Необязательный)</param>
        /// <example>
        /// Контекст = Новый Структура("ЧислоПи", 3.1415); // 4 знака хватит всем
        /// ЗагрузитьСценарийИзСтроки("Сообщить(ЧислоПи);", Контекст);</example>
        [ContextMethod("ЗагрузитьСценарийИзСтроки", "LoadScriptFromString")]
        public UserScriptContextInstance LoadScriptFromString(IBslProcess process,
            string code,
            StructureImpl externalContext = null)
        {
            var compiler = _engine.GetCompilerService();
            try
            {
                if (externalContext == null)
                    return _engine.AttachedScriptsFactory.LoadFromString(compiler, code, process);

                var extData = CreateContextData(externalContext);
                return _engine.AttachedScriptsFactory.LoadFromString(compiler, code, process, extData);
            }
            catch (Exception e) when (e is SyntaxErrorException || e is CompilerException)
            {
                throw ScriptCompilingException(e);
            }
        }

        /// <summary>
        /// Создает экземпляр объекта на основании стороннего файла сценария.
        /// Загруженный сценарий возвращается как самостоятельный объект. 
        /// Экспортные свойства и методы скрипта доступны для вызова.
        /// </summary>
        /// <param name="path">Путь к подключаемому сценарию</param>
        /// <param name="process"></param>
        /// <param name="externalContext">Структура. Глобальные свойства, которые будут инжектированы в область видимости загружаемого скрипта. (Необязательный)</param>
        /// <example>
        /// Контекст = Новый Структура("ЧислоПи", 3.1415); // 4 знака хватит
        /// // В коде скрипта somescript.os будет доступна глобальная переменная "ЧислоПи"
        /// Объект = ЗагрузитьСценарий("somescript.os", Контекст);</example>
        [ContextMethod("ЗагрузитьСценарий", "LoadScript")]
        public UserScriptContextInstance LoadScript(IBslProcess process, string path, StructureImpl externalContext = null)
        {
            var compiler = _engine.GetCompilerService();
            try
            {
                if(externalContext == null)
                    return _engine.AttachedScriptsFactory.LoadFromPath(compiler, path, process);

                var extData = CreateContextData(externalContext);
                return _engine.AttachedScriptsFactory.LoadFromPath(compiler, path, extData, process);
            }
            catch (Exception e) when (e is SyntaxErrorException || e is CompilerException)
            {
                throw ScriptCompilingException(e);
            }
        }

        private static ExternalContextData CreateContextData(StructureImpl externalContext)
        {
            if (externalContext == null)
                return null;

            ExternalContextData extData = new ExternalContextData();

            foreach (var item in externalContext)
            {
                extData.Add(item.Key.ToString()!, item.Value);
            }

            return extData;
        }

        /// <summary>
        /// Подключает внешнюю сборку среды .NET (*.dll) и регистрирует классы 1Script, объявленные в этой сборке.
        /// Публичные классы, отмеченные в dll атрибутом ContextClass, будут импортированы аналогично встроенным классам 1Script.
        /// Загружаемая сборка должна ссылаться на сборку ScriptEngine.dll
        ///
        /// Также подключает внешние компоненты, разработанные по технологии Native API,
        /// поставляемые в виде отдельных DLL или упакованные в ZIP-архив.
        ///
        /// </summary>
        /// <param name="dllPath">Путь к внешней компоненте</param>
        /// <param name="name">Символическое имя подключаемой внешней компоненты (только для Native API)</param>
        /// <param name="type">Тип подключаемой внешней компоненты (для совместимости, необязательно)</param>
        /// <example>
        /// //Подключает внешнюю сборку среды .NET (*.dll)
        /// ПодключитьВнешнююКомпоненту("C:\MyAssembly.dll");
        /// КлассИзКомпоненты = Новый КлассИзКомпоненты(); // тип объявлен внутри компоненты
        ///
        /// //Подключает вншение компонеты Native API, упакованные в ZIP-архив
        /// ПодключитьВнешнююКомпоненту("C:\AddInNative.zip", "AddInNative");
        /// ЭкземплярВнешнейКомпоненты = Новый ("AddIn.AddInNative.NativeComponent", ТипВнешнейКомпоненты.Native);
        ///
        /// //Подключает вншение компонеты Native API в виде отдельных DLL-файлов
        /// ПодключитьВнешнююКомпоненту("C:\AddInNative.dll", "SimpleAddIn", ТипВнешнейКомпоненты.Native);
        /// ЭкземплярВнешнейКомпоненты = Новый ("AddIn.SimpleAddIn.SimpleComponent");
        /// </example>        
        [ContextMethod("ПодключитьВнешнююКомпоненту", "AttachAddIn")]
        public bool AttachAddIn(string dllPath, string name = "", NativeApiEnums type = NativeApiEnums.OneScript)
        {
            if (type == NativeApiEnums.OneScript)
            {
                var assembly = System.Reflection.Assembly.LoadFrom(dllPath);
                _engine.AttachExternalAssembly(assembly);
                return true;
            }
            else
            {
                if (!Utils.IsValidIdentifier(name))
                {
                    throw RuntimeException.InvalidArgumentValue(name);
                }
                return NativeApiFactory.Register(dllPath, name, _engine.TypeManager);
            }
        }

        private static RuntimeException ScriptCompilingException(Exception e)
        {
            return new RuntimeException(BilingualString.Localize(
                "Ошибка компиляции подключаемого сценария:\n",
                "Error compiling attached script:\n") + e.Message, e);
        }
    }
}