closes EvilBeaver#860 Обработчик нажатия Ctrl+C в консоли

Обработчик прерывания консольного приложения по Ctrl+C

Author: EvilBeaver

src/OneScript.StandardLibrary/Tasks/BackgroundTasksManager.cs

@@ -47,13 +47,10 @@ public BackgroundTask Execute(IRuntimeContextInstance target, string methodName,
             var task = new BackgroundTask(target, methodName, parameters);
             _tasks.Add(task);
 
-            var eventProcessor = MachineInstance.Current.EventProcessor;
-
             var taskCreationOptions = longRunning ? TaskCreationOptions.LongRunning : TaskCreationOptions.None;
             var worker = new Task(() =>
             {
                 MachineInstance.Current.SetMemory(_runtimeContext);
-                MachineInstance.Current.EventProcessor = eventProcessor;
                 var debugger = _runtimeContext.Services.TryResolve<IDebugController>();
                 debugger?.AttachToThread();
                 try

src/OneScript.StandardLibrary/Text/ConsoleContext.cs

@@ -19,10 +19,44 @@ namespace OneScript.StandardLibrary.Text
     /// <summary>
     /// Класс представляет собой инструмент доступа к системной консоли.
     /// Предназначен для низкоуровнего манипулирования выводом в консоль.
+    ///
+    /// Поддерживается регистрация обработчика для нажатия Ctrl+C.
+    /// Обработчик регистрируется для события с именем CancelKeyPressed. Стоит учитывать, что обработчик вызывается
+    /// в отдельном потоке и необходимо помнить о потокобезопасности общих данных.
+    /// 
     /// </summary>
+    /// <example>
+    ///    Перем Хватит;
+    /// 
+    ///    Процедура Обработчик(Отказ)
+    ///        Сообщить("Обработчик остановки вызван", СтатусСообщения.Важное);
+    ///        Отказ = Истина; // не даем системе убить процесс
+    ///        Хватит = Истина; // выставим свой флаг завершения цикла
+    ///    КонецПроцедуры
+    ///
+    ///    Хватит = Ложь;
+    ///    ДобавитьОбработчик Консоль.CancelKeyPressed, Обработчик;
+    ///
+    ///    Пока Не Хватит Цикл
+    ///        Сообщить("Пинг", СтатусСообщения.Информация);
+    ///        Приостановить(1000);
+    ///        Сообщить("Понг", СтатусСообщения.Информация);
+    ///        Приостановить(1000);
+    ///    КонецЦикла;
+    ///
+    ///    Сообщить("Мягкая остановка процесса", СтатусСообщения.Информация);
+    /// </example>
     [ContextClass("Консоль", "Console")]
     public class ConsoleContext : AutoContext<ConsoleContext>
     {
+        private readonly ExecutionContext _executionContext;
+
+        public ConsoleContext(ExecutionContext executionContext)
+        {
+            _executionContext = executionContext;
+            Console.CancelKeyPress += ConsoleOnCancelKeyPress;
+        }
+
         [ContextProperty("НажатаКлавиша", "KeyPressed")]
         public bool HasKey => Console.KeyAvailable;
 
@@ -244,5 +278,31 @@ public void SetError(IValue target)
             var writer = new StreamWriter(stream.GetUnderlyingStream());
             Console.SetError(writer);
         }
+
+        public const string ConsoleCancelKeyEvent = "CancelKeyPressed";
+
+        private void ConsoleOnCancelKeyPress(object sender, ConsoleCancelEventArgs e)
+        {
+            if (e.SpecialKey != ConsoleSpecialKey.ControlC) 
+                return;
+            
+            // Сначала проверим, что события вообще включены
+            var eventProcessor = _executionContext.Services.TryResolve<IEventProcessor>();
+            if (eventProcessor == null)
+                return;
+                
+            MachineInstance.Current.SetMemory(_executionContext);
+            var debugger = _executionContext.Services.TryResolve<IDebugController>();
+            debugger?.AttachToThread();
+
+            var cancelVar = Variable.Create(BslBooleanValue.False, "Cancel");
+            var reference = Variable.CreateReference(cancelVar, "Cancel");
+            var args = new IValue[] { reference };
+
+            // Вызываем обработчик. Исключение в обработчике никак отдельно не обрабатываем.
+            eventProcessor.HandleEvent(this, ConsoleCancelKeyEvent, args);
+
+            e.Cancel = reference.Value.AsBoolean();
+        }
     }
 }

src/OneScript.StandardLibrary/Text/ConsoleProvider.cs

@@ -7,6 +7,8 @@ This Source Code Form is subject to the terms of the
 
 using System;
 using OneScript.Contexts;
+using OneScript.DependencyInjection;
+using OneScript.Types;
 using ScriptEngine.Machine;
 using ScriptEngine.Machine.Contexts;
 
@@ -15,10 +17,11 @@ namespace OneScript.StandardLibrary.Text
     [GlobalContext(Category = "Работа с консолью")]
     public class ConsoleProvider : GlobalContextBase<ConsoleProvider>
     {
-        private readonly ConsoleContext _console = new ConsoleContext();
+        private readonly ConsoleContext _console;
 
-        private ConsoleProvider()
+        private ConsoleProvider(ExecutionContext executionContext)
         {
+            _console = new ConsoleContext(executionContext);
         }
 
         public override void OnAttach(out IVariable[] variables, out BslMethodInfo[] methods)
@@ -45,9 +48,9 @@ public override void SetPropValue(int propNum, IValue newVal)
             }
         }
 
-        public static ConsoleProvider CreateInstance()
+        public static ConsoleProvider CreateInstance(ExecutionContext executionContext)
         {
-            return new ConsoleProvider();
+            return new ConsoleProvider(executionContext);
         }
     }
 }

src/ScriptEngine.HostedScript/DefaultEventProcessor.cs

@@ -26,7 +26,7 @@ private struct Handler
 
         private class HandlersList : IEnumerable<Handler>
         {
-            private List<Handler> _handlers = new List<Handler>();
+            private readonly List<Handler> _handlers = new List<Handler>();
 
             public void Add(ScriptDrivenObject target, string methodName)
             {
@@ -58,7 +58,10 @@ IEnumerator IEnumerable.GetEnumerator()
             }
         }
 
-        private Dictionary<IRuntimeContextInstance, Dictionary<string, HandlersList>> _registeredHandlers = new Dictionary<IRuntimeContextInstance, Dictionary<string, HandlersList>>();
+        private readonly Dictionary<IRuntimeContextInstance, Dictionary<string, HandlersList>> _registeredHandlers 
+            = new Dictionary<IRuntimeContextInstance, Dictionary<string, HandlersList>>();
+
+        private readonly object _subscriptionLock = new object();
 
         public void AddHandler(
             IRuntimeContextInstance eventSource,
@@ -68,19 +71,23 @@ public void AddHandler(
         {
             if (!(handlerTarget is ScriptDrivenObject handlerScript))
                 throw RuntimeException.InvalidArgumentType("handlerTarget");
-            
-            if (!_registeredHandlers.TryGetValue(eventSource, out var handlers))
+
+            lock (_subscriptionLock)
             {
-                handlers = new Dictionary<string, HandlersList>();
-                _registeredHandlers[eventSource] = handlers;
-            }
-            
-            if (!handlers.TryGetValue(eventName, out var handlersList)) {
-                handlersList = new HandlersList();
-                handlers[eventName] = handlersList;
+                if (!_registeredHandlers.TryGetValue(eventSource, out var handlers))
+                {
+                    handlers = new Dictionary<string, HandlersList>();
+                    _registeredHandlers[eventSource] = handlers;
+                }
+
+                if (!handlers.TryGetValue(eventName, out var handlersList))
+                {
+                    handlersList = new HandlersList();
+                    handlers[eventName] = handlersList;
+                }
+
+                handlersList.Add(handlerScript, handlerMethod);
             }
-            
-            handlersList.Add(handlerScript, handlerMethod);
         }
 
         public void RemoveHandler(
@@ -92,26 +99,37 @@ public void RemoveHandler(
             if (!(handlerTarget is ScriptDrivenObject handlerScript))
                 throw RuntimeException.InvalidArgumentType("handlerTarget");
 
-            if (!_registeredHandlers.TryGetValue(eventSource, out var handlers))
+            lock (_subscriptionLock)
             {
-                return;
-            }
-            
-            if (handlers.TryGetValue(eventName, out var handlersList)) {
-                handlersList.Remove(handlerScript, handlerMethod);
+                if (!_registeredHandlers.TryGetValue(eventSource, out var handlers))
+                {
+                    return;
+                }
+
+                if (handlers.TryGetValue(eventName, out var handlersList))
+                {
+                    handlersList.Remove(handlerScript, handlerMethod);
+                }
             }
         }
 
         public void HandleEvent(IRuntimeContextInstance eventSource, string eventName, IValue[] eventArgs)
         {
-            if (!_registeredHandlers.TryGetValue(eventSource, out var handlers)) 
-                return;
-            
-            if (!handlers.TryGetValue(eventName, out var handlersList)) {
-                return;
+            HandlersList handlersLocalCopy;
+
+            lock (_subscriptionLock)
+            {
+
+                if (!_registeredHandlers.TryGetValue(eventSource, out var handlers))
+                    return;
+
+                if (!handlers.TryGetValue(eventName, out handlersLocalCopy))
+                {
+                    return;
+                }
             }
-            
-            foreach (var handler in handlersList)
+
+            foreach (var handler in handlersLocalCopy)
             {
                 handler.Method(eventArgs);
             }

src/ScriptEngine.HostedScript/Extensions/EngineBuilderExtensions.cs

@@ -124,5 +124,11 @@ public static IEngineBuilder UseNativeRuntime(this IEngineBuilder builder)
 
             return builder;
         }
+
+        public static IEngineBuilder UseEventHandlers(this IEngineBuilder builder)
+        {
+            builder.Services.RegisterSingleton<IEventProcessor, DefaultEventProcessor>();
+            return builder;
+        }
     }
 }

src/ScriptEngine.HostedScript/HostedScriptEngine.cs

@@ -12,6 +12,7 @@ This Source Code Form is subject to the terms of the
 using OneScript.Commons;
 using OneScript.Compilation;
 using OneScript.Contexts;
+using OneScript.DependencyInjection;
 using OneScript.Execution;
 using OneScript.StandardLibrary;
 using OneScript.StandardLibrary.Tasks;
@@ -127,6 +128,8 @@ private void DefineConstants(ICompilerFrontend compilerSvc)
             }
         }
 
+        public IServiceContainer Services => _engine.Services;
+
         public void SetGlobalEnvironment(IHostApplication host, SourceCode src)
         {
             _globalCtx.ApplicationHost = host;

src/ScriptEngine.HostedScript/Process.cs

@@ -30,7 +30,6 @@ public int Start()
 
             try
             {
-                MachineInstance.Current.EventProcessor = new DefaultEventProcessor();
                 _engine.UpdateContexts();
                 _engine.NewObject(_module);
                 exitCode = 0;

src/ScriptEngine/Machine/Contexts/UserScriptContextInstance.cs

@@ -255,7 +255,7 @@ protected override void CallOwnProcedure(int index, IValue[] arguments)
             if (eventArgs == null)
                 eventArgs = new IValue[0];
 
-            MachineInstance.Current.EventProcessor?.HandleEvent(this, eventName, eventArgs);
+            MachineInstance.Current.Memory.Services.TryResolve<IEventProcessor>()?.HandleEvent(this, eventName, eventArgs);
         }
 
         protected override int GetOwnVariableCount()

src/ScriptEngine/Machine/MachineInstance.cs

@@ -12,6 +12,7 @@ This Source Code Form is subject to the terms of the
 using System.Linq;
 using System.Reflection;
 using System.Runtime.CompilerServices;
+using System.Threading;
 using System.Threading.Tasks;
 using OneScript.Commons;
 using OneScript.Compilation.Binding;
@@ -45,11 +46,17 @@ public class MachineInstance
         // актуален в момент останова машины
         private IList<ExecutionFrameInfo> _fullCallstackCache;
         private ScriptInformationContext _debugInfo;
+        
+        // кешированный обработчик событий
+        private readonly Lazy<IEventProcessor> _eventProcessor;
 
         private MachineInstance() 
         {
             InitCommands();
             Reset();
+
+            _eventProcessor = new Lazy<IEventProcessor>(() => _mem.Services.TryResolve<IEventProcessor>(),
+                LazyThreadSafetyMode.None);
         }
 
         public event EventHandler<MachineStoppedEventArgs> MachineStopped;
@@ -68,6 +75,7 @@ public void SetMemory(ExecutionContext memory)
             _codeStatCollector = _mem.Services.TryResolve<ICodeStatCollector>();
             _globalContexts = _mem.GlobalNamespace.AttachedContexts.Select(x => new AttachedContext(x))
                 .ToArray();
+            
         }
 
         public void UpdateGlobals() 
@@ -302,11 +310,8 @@ private StackRuntimeModule CompileCached(string code, Func<string, StackRuntimeM
         }
 
         #endregion
-
-        /// <summary>
-        /// Обработчик событий, генерируемых классами прикладной логики.
-        /// </summary>
-        public IEventProcessor EventProcessor { get; set; }
+        
+        private IEventProcessor EventProcessor => _eventProcessor.Value ?? throw new InvalidOperationException("Host does not support events");
 
         private ScriptInformationContext CurrentScript
         {
@@ -2521,7 +2526,7 @@ private static ExecutionFrameInfo FrameInfo(StackRuntimeModule module, Execution
         // multithreaded instance
         [ThreadStatic]
         private static MachineInstance _currentThreadWorker;
-
+        
         private static void SetCurrentMachineInstance(MachineInstance current)
             => _currentThreadWorker = current;
 

src/oscript/ConsoleHostBuilder.cs

@@ -51,7 +51,7 @@ private static void BuildUpWithIoC(IEngineBuilder builder)
                 .UseImports()
                 .UseFileSystemLibraries()
                 .UseNativeRuntime()
-                ;
+                .UseEventHandlers();
         }
     }
 }