Added the EmbedHostObject method (embeds a instance of simple class, structure or delegate to script code)

Author: Taritsyn

src/JavaScriptEngineSwitcher.Core/Helpers/ValidationHelpers.cs

@@ -17,6 +17,18 @@ public static class ValidationHelpers
 			typeof(Undefined), typeof(Boolean), typeof(Int32), typeof(Double), typeof(String)
 		};
 
+		/// <summary>
+		/// List of primitive type codes
+		/// </summary>
+		private static readonly TypeCode[] _primitiveTypeCodes = new[]
+		{
+			TypeCode.Boolean,
+			TypeCode.SByte, TypeCode.Byte,
+			TypeCode.Int16, TypeCode.UInt16, TypeCode.Int32, TypeCode.UInt32, TypeCode.Int64, TypeCode.UInt64,
+			TypeCode.Single, TypeCode.Double, TypeCode.Decimal,
+			TypeCode.Char, TypeCode.String
+		};
+
 		/// <summary>
 		/// Regular expression for working with JS-names
 		/// </summary>
@@ -35,6 +47,19 @@ public static bool IsSupportedType(Type type)
 			return result;
 		}
 
+		/// <summary>
+		/// Checks whether .NET type is primitive
+		/// </summary>
+		/// <param name="type">.NET type</param>
+		/// <returns>Result of check (true - is primitive; false - is not primitive)</returns>
+		public static bool IsPrimitiveType(Type type)
+		{
+			TypeCode typeCode = Type.GetTypeCode(type);
+			bool result = _primitiveTypeCodes.Contains(typeCode);
+
+			return result;
+		}
+
 		/// <summary>
 		/// Checks a format of the name
 		/// </summary>

src/JavaScriptEngineSwitcher.Core/IJsEngine.cs

@@ -119,5 +119,13 @@ string Version
 		/// </summary>
 		/// <param name="variableName">Variable name</param>
 		void RemoveVariable(string variableName);
+
+		/// <summary>
+		/// Embeds a host object to script code
+		/// </summary>
+		/// <param name="itemName">The name for the new global variable or function that will represent the object</param>
+		/// <param name="value">The object to expose</param>
+		/// <remarks>Allows to embed instances of simple classes (or structures) and delegates.</remarks>
+		void EmbedHostObject(string itemName, object value);
 	}
 }

src/JavaScriptEngineSwitcher.Core/JsEngineBase.cs

@@ -47,6 +47,11 @@ protected void VerifyNotDisposed()
 
 		protected abstract void InnerRemoveVariable(string variableName);
 
+		protected virtual void InnerEmbedHostObject(string itemName, object value)
+		{
+			throw new NotImplementedException();
+		}
+
 		#region IJsEngine implementation
 
 		public abstract string Name
@@ -361,6 +366,42 @@ public virtual void RemoveVariable(string variableName)
 			InnerRemoveVariable(variableName);
 		}
 
+		public virtual void EmbedHostObject(string itemName, object value)
+		{
+			VerifyNotDisposed();
+
+			if (string.IsNullOrWhiteSpace(itemName))
+			{
+				throw new ArgumentException(
+					string.Format(Strings.Common_ArgumentIsEmpty, "itemName"), "itemName");
+			}
+
+			if (!ValidationHelpers.CheckNameFormat(itemName))
+			{
+				throw new FormatException(
+					string.Format(Strings.Runtime_InvalidScriptItemNameFormat, itemName));
+			}
+
+			if (value != null)
+			{
+				Type itemType = value.GetType();
+
+				if (ValidationHelpers.IsPrimitiveType(itemType)
+					|| itemType == typeof(Undefined)
+					|| itemType == typeof(DateTime))
+				{
+					throw new NotSupportedTypeException(
+						string.Format(Strings.Runtime_EmbeddedHostObjectTypeNotSupported, itemType.FullName));
+				}
+			}
+			else
+			{
+				throw new ArgumentNullException("value", string.Format(Strings.Common_ArgumentIsNull, "value"));
+			}
+
+			InnerEmbedHostObject(itemName, value);
+		}
+
 		#endregion
 
 		#region IDisposable implementation

src/JavaScriptEngineSwitcher.Core/Resources/Strings.Designer.cs

@@ -183,6 +183,9 @@
   <data name="Resources_ResourceIsNull" xml:space="preserve">
     <value>Resource with name '{0}' is null.</value>
   </data>
+  <data name="Runtime_EmbeddedHostObjectTypeNotSupported" xml:space="preserve">
+    <value>The embedded host object '{0}' has a type `{1}`, which is not supported.</value>
+  </data>
   <data name="Runtime_FunctionNameIsForbidden" xml:space="preserve">
     <value>The function name '{0}' is forbidden, as is contained in the list of reserved words of JavaScript language.</value>
   </data>
@@ -195,6 +198,9 @@
   <data name="Runtime_InvalidFunctionNameFormat" xml:space="preserve">
     <value>The function name '{0}' has incorrect format.</value>
   </data>
+  <data name="Runtime_InvalidScriptItemNameFormat" xml:space="preserve">
+    <value>The script item name '{0}' has incorrect format.</value>
+  </data>
   <data name="Runtime_InvalidVariableNameFormat" xml:space="preserve">
     <value>The variable name '{0}' has incorrect format.</value>
   </data>

src/JavaScriptEngineSwitcher.Core/Resources/Strings.resx

@@ -183,6 +183,9 @@
   <data name="Resources_ResourceIsNull" xml:space="preserve">
     <value>Ресурс с именем "{0}" содержит значение равное null!</value>
   </data>
+  <data name="Runtime_EmbeddedHostObjectTypeNotSupported" xml:space="preserve">
+    <value>Встраиваемый объекта хоста "{0}" имеет тип `{1}`, который не поддерживается!</value>
+  </data>
   <data name="Runtime_FunctionNameIsForbidden" xml:space="preserve">
     <value>Имя функции "{0}" запрещено, т.к. входит в список зарезервированных слов JavaScript!</value>
   </data>
@@ -195,6 +198,9 @@
   <data name="Runtime_InvalidFunctionNameFormat" xml:space="preserve">
     <value>Имя функции "{0}" имеет некорректный формат!</value>
   </data>
+  <data name="Runtime_InvalidScriptItemNameFormat" xml:space="preserve">
+    <value>Имя скриптового элемента "{0}" имеет некорректный формат!</value>
+  </data>
   <data name="Runtime_InvalidVariableNameFormat" xml:space="preserve">
     <value>Имя переменной "{0}" имеет некорректный формат!</value>
   </data>

src/JavaScriptEngineSwitcher.Core/Resources/Strings.ru-ru.resx

@@ -414,6 +414,20 @@ protected override void InnerRemoveVariable(string variableName)
 			InnerSetVariableValue(variableName, Undefined.Value);
 		}
 
+		protected override void InnerEmbedHostObject(string itemName, object value)
+		{
+			OriginalJsValue processedValue = MapToJintType(value);
+
+			try
+			{
+				_jsEngine.SetValue(itemName, processedValue);
+			}
+			catch (OriginalJsException e)
+			{
+				throw ConvertJavaScriptExceptionToJsRuntimeException(e);
+			}
+		}
+
 		#endregion
 
 		#region IDisposable implementation

src/JavaScriptEngineSwitcher.Jint/JintJsEngine.cs

@@ -281,6 +281,28 @@ protected override void InnerRemoveVariable(string variableName)
 			InnerSetVariableValue(variableName, Undefined.Value);
 		}
 
+		protected override void InnerEmbedHostObject(string itemName, object value)
+		{
+			object processedValue = MapToJurassicType(value);
+
+			try
+			{
+				var delegateValue = processedValue as Delegate;
+				if (delegateValue != null)
+				{
+					_jsEngine.SetGlobalFunction(itemName, delegateValue);
+				}
+				else
+				{
+					_jsEngine.SetGlobalValue(itemName, processedValue);
+				}
+			}
+			catch (OriginalJsException e)
+			{
+				throw ConvertJavascriptExceptionToJsRuntimeException(e);
+			}
+		}
+
 		public override void ExecuteFile(string path, Encoding encoding = null)
 		{
 			VerifyNotDisposed();

src/JavaScriptEngineSwitcher.Jurassic/JurassicJsEngine.cs

@@ -45,8 +45,8 @@
     </ProjectReference>
   </ItemGroup>
   <ItemGroup>
-    <Reference Include="MsieJavaScriptEngine, Version=1.6.0.0, Culture=neutral, PublicKeyToken=a3a2846a37ac0d3e, processorArchitecture=MSIL">
-      <HintPath>..\..\packages\MsieJavaScriptEngine.1.6.0\lib\net40\MsieJavaScriptEngine.dll</HintPath>
+    <Reference Include="MsieJavaScriptEngine, Version=1.7.0.0, Culture=neutral, PublicKeyToken=a3a2846a37ac0d3e, processorArchitecture=MSIL">
+      <HintPath>..\..\packages\MsieJavaScriptEngine.1.7.0-alpha1\lib\net40\MsieJavaScriptEngine.dll</HintPath>
       <Private>True</Private>
     </Reference>
     <Reference Include="System" />

src/JavaScriptEngineSwitcher.Msie/JavaScriptEngineSwitcher.Msie.csproj

@@ -283,6 +283,20 @@ protected override void InnerRemoveVariable(string variableName)
 			}
 		}
 
+		protected override void InnerEmbedHostObject(string itemName, object value)
+		{
+			object processedValue = MapToMsieType(value);
+
+			try
+			{
+				_jsEngine.EmbedHostObject(itemName, processedValue);
+			}
+			catch (OriginalJsRuntimeException e)
+			{
+				throw ConvertMsieJsRuntimeExceptionToJsRuntimeException(e);
+			}
+		}
+
 		#endregion
 
 		#region IDisposable implementation