Added a ability to interrupt execution of the script

Author: Taritsyn

NuGet/MsieJavaScriptEngine.nuspec

@@ -12,9 +12,7 @@
 		<requireLicenseAcceptance>false</requireLicenseAcceptance>
 		<description>This library is a .NET wrapper for working with the JavaScript engines of Internet Explorer and Edge (JsRT versions of Chakra, ActiveScript version of Chakra and Classic JavaScript Engine). Project was based on the code of SassAndCoffee.JavaScript (http://github.com/paulcbetts/SassAndCoffee), Chakra Sample Hosts (http://github.com/panopticoncentral/chakra-host) and jsrt-dotnet (http://github.com/robpaveza/jsrt-dotnet).</description>
 		<summary>This library is a .NET wrapper for working with the JavaScript engines of Internet Explorer and Edge (JsRT versions of Chakra, ActiveScript version of Chakra and Classic JavaScript Engine).</summary>
-		<releaseNotes>1. In ActiveScript modes now are uses the short names of error categories;
-2. In `Classic` mode during debugging now script error contains a full stack trace;
-3. In JsRT modes the compilation error messages now contains a information about the error location.</releaseNotes>
+		<releaseNotes>Added a ability to interrupt execution of the script.</releaseNotes>
 		<copyright>Copyright (c) 2012-2017 Andrey Taritsyn - http://www.taritsyn.ru</copyright>
 		<language>en-US</language>
 		<tags>JavaScript ECMAScript MSIE IE Edge Chakra</tags>

NuGet/readme.txt

@@ -21,11 +21,7 @@
    =============
    RELEASE NOTES
    =============
-   1. In ActiveScript modes now are uses the short names of error categories;
-   2. In `Classic` mode during debugging now script error contains a full stack
-      trace;
-   3. In JsRT modes the compilation error messages now contains a information about
-      the error location.
+   Added a ability to interrupt execution of the script.
 
    ============
    PROJECT SITE

src/MsieJavaScriptEngine.Net4/MsieJavaScriptEngine.Net40.csproj

@@ -255,9 +255,15 @@
     <Compile Include="..\MsieJavaScriptEngine\ActiveScript\IActiveScriptSite.cs">
       <Link>ActiveScript\IActiveScriptSite.cs</Link>
     </Compile>
+    <Compile Include="..\MsieJavaScriptEngine\ActiveScript\IActiveScriptSiteInterruptPoll.cs">
+      <Link>ActiveScript\IActiveScriptSiteInterruptPoll.cs</Link>
+    </Compile>
     <Compile Include="..\MsieJavaScriptEngine\ActiveScript\IActiveScriptWrapper.cs">
       <Link>ActiveScript\IActiveScriptWrapper.cs</Link>
     </Compile>
+    <Compile Include="..\MsieJavaScriptEngine\ActiveScript\JsErrorNumber.cs">
+      <Link>ActiveScript\JsErrorNumber.cs</Link>
+    </Compile>
     <Compile Include="..\MsieJavaScriptEngine\ActiveScript\ScriptGCType.cs">
       <Link>ActiveScript\ScriptGCType.cs</Link>
     </Compile>
@@ -285,6 +291,9 @@
     <Compile Include="..\MsieJavaScriptEngine\ActiveScript\ScriptTextFlags.cs">
       <Link>ActiveScript\ScriptTextFlags.cs</Link>
     </Compile>
+    <Compile Include="..\MsieJavaScriptEngine\ActiveScript\ScriptThreadId.cs">
+      <Link>ActiveScript\ScriptThreadId.cs</Link>
+    </Compile>
     <Compile Include="..\MsieJavaScriptEngine\ActiveScript\ScriptThreadState.cs">
       <Link>ActiveScript\ScriptThreadState.cs</Link>
     </Compile>
@@ -483,6 +492,9 @@
     <Compile Include="..\MsieJavaScriptEngine\JsRuntimeException.cs">
       <Link>JsRuntimeException.cs</Link>
     </Compile>
+    <Compile Include="..\MsieJavaScriptEngine\JsScriptInterruptedException.cs">
+      <Link>JsScriptInterruptedException.cs</Link>
+    </Compile>
     <Compile Include="..\MsieJavaScriptEngine\MsieJsEngine.cs">
       <Link>MsieJsEngine.cs</Link>
     </Compile>

src/MsieJavaScriptEngine/ActiveScript/ActiveScriptException.cs

@@ -9,7 +9,7 @@ namespace MsieJavaScriptEngine.ActiveScript
 	public sealed class ActiveScriptException : Exception
 	{
 		/// <summary>
-		/// Error code
+		/// The HRESULT of the error
 		/// </summary>
 		private int _errorCode;
 
@@ -44,7 +44,7 @@ public sealed class ActiveScriptException : Exception
 		private string _sourceFragment = string.Empty;
 
 		/// <summary>
-		/// Gets or sets a error code
+		/// Gets or sets a HRESULT of the error
 		/// </summary>
 		public int ErrorCode
 		{

src/MsieJavaScriptEngine/ActiveScript/ActiveScriptJsEngineBase.ScriptSite.cs

@@ -12,17 +12,16 @@
 using MsieJavaScriptEngine.Resources;
 using MsieJavaScriptEngine.Utilities;
 
-using HResultHelpers = MsieJavaScriptEngine.Helpers.ComHelpers.HResult;
-
 namespace MsieJavaScriptEngine.ActiveScript
 {
 	/// <summary>
 	/// Active Script site
 	/// </summary>
 	internal abstract partial class ActiveScriptJsEngineBase
 	{
-		private sealed class ScriptSite : IActiveScriptSite, IActiveScriptSiteDebug32, IActiveScriptSiteDebug64,
-			IActiveScriptSiteDebugEx, ICustomQueryInterface
+		private sealed class ScriptSite : IActiveScriptSite, IActiveScriptSiteInterruptPoll,
+			IActiveScriptSiteDebug32, IActiveScriptSiteDebug64, IActiveScriptSiteDebugEx,
+			ICustomQueryInterface
 		{
 			/// <summary>
 			/// Instance of Active Script engine
@@ -40,6 +39,25 @@ public ScriptSite(ActiveScriptJsEngineBase jsEngine)
 			}
 
 
+			/// <summary>
+			/// Processes a Active Script error
+			/// </summary>
+			/// <param name="error">Instance of <see cref="IActiveScriptError"/></param>
+			private void ProcessActiveScriptError(IActiveScriptError error)
+			{
+				var activeScriptException = CreateActiveScriptException(error);
+				if (_jsEngine._engineMode == JsEngineMode.Classic
+					&& activeScriptException.ErrorCode == ComErrorCode.E_ABORT)
+				{
+					// Script execution was interrupted explicitly. At this point the script
+					// engine might be in an odd state; the following call seems to get it back
+					// to normal.
+					_jsEngine._activeScriptWrapper.SetScriptState(ScriptState.Started);
+				}
+
+				_jsEngine._lastException = activeScriptException;
+			}
+
 			/// <summary>
 			/// Creates a instance of <see cref="ActiveScriptException"/>
 			/// </summary>
@@ -51,10 +69,19 @@ private ActiveScriptException CreateActiveScriptException(IActiveScriptError err
 				error.GetExceptionInfo(out exceptionInfo);
 
 				int hResult = exceptionInfo.scode;
-				int errorCode = HResultHelpers.GetCode(hResult);
 				bool isSyntaxError = IsSyntaxError(hResult);
-				string category = exceptionInfo.bstrSource;
-				string description = exceptionInfo.bstrDescription;
+				string category;
+				string description;
+				if (hResult == ComErrorCode.E_ABORT)
+				{
+					category = string.Empty;
+					description = CommonStrings.Runtime_ScriptInterrupted;
+				}
+				else
+				{
+					category = _jsEngine.ShortenErrorCategoryName(exceptionInfo.bstrSource);
+					description = exceptionInfo.bstrDescription;
+				}
 				string helpLink = string.Empty;
 				if (!string.IsNullOrWhiteSpace(exceptionInfo.bstrHelpFile))
 				{
@@ -84,7 +111,7 @@ private ActiveScriptException CreateActiveScriptException(IActiveScriptError err
 
 				var activeScriptException = new ActiveScriptException(message)
 				{
-					ErrorCode = errorCode,
+					ErrorCode = hResult,
 					Category = category,
 					Description = description,
 					SourceContext = sourceContext,
@@ -106,10 +133,11 @@ private static bool IsSyntaxError(int hResult)
 			{
 				bool isSyntaxError = false;
 
-				if (HResultHelpers.GetFacility(hResult) == HResultHelpers.FACILITY_CONTROL)
+				if (ComHelpers.HResult.GetFacility(hResult) == ComErrorCode.FACILITY_CONTROL)
 				{
-					int errorCode = HResultHelpers.GetCode(hResult);
-					isSyntaxError = errorCode >= 1002 && errorCode <= 1035;
+					int errorNumber = ComHelpers.HResult.GetCode(hResult);
+					isSyntaxError = errorNumber >= (int)JsErrorNumber.SyntaxError
+						&& errorNumber <= (int)JsErrorNumber.ThrowMustBeFollowedByExpressionOnSameSourceLine;
 				}
 
 				return isSyntaxError;
@@ -129,8 +157,11 @@ private string GetErrorDetails(string category, string description, bool isSynta
 				uint sourceContext, uint lineNumber, int columnNumber)
 			{
 				var errorBuilder = new StringBuilder();
-				errorBuilder.AppendFormatLine("{0}: {1}",
-					_jsEngine.ShortenErrorCategoryName(category), description);
+				if (!string.IsNullOrWhiteSpace(category))
+				{
+					errorBuilder.AppendFormat("{0}: ", category);
+				}
+				errorBuilder.AppendLine(description);
 
 				if (_jsEngine._processDebugManagerWrapper != null)
 				{
@@ -312,7 +343,7 @@ public void GetItemInfo(string name, ScriptInfoFlags mask, ref IntPtr pUnkItem,
 				if (item == null)
 				{
 					throw new COMException(
-						string.Format(NetFrameworkStrings.Runtime_ItemNotFound, name), ComErrorCode.ElementNotFound);
+						string.Format(NetFrameworkStrings.Runtime_ItemNotFound, name), ComErrorCode.E_ELEMENT_NOT_FOUND);
 				}
 
 				if (mask.HasFlag(ScriptInfoFlags.IUnknown))
@@ -339,7 +370,7 @@ public void OnStateChange(ScriptState state)
 
 			public void OnScriptError(IActiveScriptError error)
 			{
-				_jsEngine._lastException = CreateActiveScriptException(error);
+				ProcessActiveScriptError(error);
 			}
 
 			public void OnEnterScript()
@@ -350,6 +381,35 @@ public void OnLeaveScript()
 
 			#endregion
 
+			#region IActiveScriptSiteInterruptPoll implementation
+
+			public uint QueryContinue()
+			{
+				int hResult;
+
+				if (_jsEngine._engineMode == JsEngineMode.ChakraActiveScript
+					&& _jsEngine._interruptRequested)
+				{
+					hResult = ComErrorCode.E_ABORT;
+					var activeScriptException = new ActiveScriptException(
+						CommonStrings.Runtime_ScriptInterrupted)
+					{
+						ErrorCode = hResult,
+						Description = CommonStrings.Runtime_ScriptInterrupted
+					};
+
+					_jsEngine._lastException = activeScriptException;
+				}
+				else
+				{
+					hResult = ComErrorCode.S_OK;
+				}
+
+				return NumericHelpers.SignedAsUnsigned(hResult);
+			}
+
+			#endregion
+
 			#region IActiveScriptSiteDebug32 and IActiveScriptSiteDebug64 implementation
 
 			public void GetRootApplicationNode(out IDebugApplicationNode node)
@@ -363,7 +423,7 @@ public void OnScriptErrorDebug(IActiveScriptErrorDebug errorDebug, out bool ente
 				var error = errorDebug as IActiveScriptError;
 				if (error != null)
 				{
-					_jsEngine._lastException = CreateActiveScriptException(error);
+					ProcessActiveScriptError(error);
 				}
 
 				enterDebugger = true;