{

#region data

private ScriptObject engineInternal;

private Type accessContext;

private ScriptAccess defaultAccess;

private bool enforceAnonymousTypeAccess;

private bool exposeHostObjectStaticMembers;

private bool marshalEnumAsUnderlyingType;

private bool acceptEnumAsUnderlyingType;

private CustomAttributeLoader customAttributeLoader;

private DocumentSettings documentSettings;

private readonly DocumentSettings defaultDocumentSettings = new();

private static readonly IUniqueNameManager nameManager = new UniqueNameManager();

private static readonly object nullHostObjectProxy = new();

[ThreadStatic] private static ScriptEngine currentEngine;

#endregion

#region constructors

/// <summary>

/// Initializes a new script engine instance.

/// </summary>

/// <param name="name">A name to associate with the instance. Currently, this name is used only as a label in presentation contexts such as debugger user interfaces.</param>

[Obsolete("Use ScriptEngine(string name, string fileNameExtensions) instead.")]

protected ScriptEngine(string name)

: this(name, null)

{

}

/// <summary>

/// Initializes a new script engine instance with the specified list of supported file name extensions.

/// </summary>

/// <param name="name">A name to associate with the instance. Currently, this name is used only as a label in presentation contexts such as debugger user interfaces.</param>

/// <param name="fileNameExtensions">A semicolon-delimited list of supported file name extensions.</param>

protected ScriptEngine(string name, string fileNameExtensions)

{

Name = nameManager.GetUniqueName(name, GetType().GetRootName());

defaultDocumentSettings.FileNameExtensions = fileNameExtensions;

extensionMethodTable = realExtensionMethodTable = new ExtensionMethodTable();

}

#endregion

#region public members

/// <summary>

/// Gets the script engine that is invoking a host member on the current thread.

/// </summary>

/// <remarks>

/// If multiple script engines are invoking host members on the current thread, this

/// property gets the one responsible for the most deeply nested invocation. If no script

/// engines are invoking host members on the current thread, this property returns

/// <c>null</c>.

/// </remarks>

public static ScriptEngine Current => currentEngine;

#endregion

#region IScriptEngine implementation

/// <inheritdoc/>

public string Name { get; }

/// <inheritdoc/>

public abstract string FileNameExtension { get; }

/// <inheritdoc cref="IScriptEngine.AccessContext" />

public Type AccessContext

{

get => accessContext;

set

{

accessContext = value;

OnAccessSettingsChanged();

}

}

/// <inheritdoc cref="IScriptEngine.DefaultAccess" />

public ScriptAccess DefaultAccess

{

get => defaultAccess;

set

{

defaultAccess = value;

OnAccessSettingsChanged();

}

}

/// <inheritdoc/>

public bool EnforceAnonymousTypeAccess

{

get => enforceAnonymousTypeAccess;

set

{

enforceAnonymousTypeAccess = value;

OnAccessSettingsChanged();

}

}

/// <inheritdoc/>

public bool ExposeHostObjectStaticMembers

{

get => exposeHostObjectStaticMembers;

set

{

exposeHostObjectStaticMembers = value;

OnAccessSettingsChanged();

}

}

/// <inheritdoc/>

public bool DisableExtensionMethods

{

get => extensionMethodTable == emptyExtensionMethodTable;

set

{

var newExtensionMethodTable = value ? emptyExtensionMethodTable : realExtensionMethodTable;

if (newExtensionMethodTable != extensionMethodTable)

{

ScriptInvoke(

static ctx =>

{

if (ctx.newExtensionMethodTable != ctx.self.extensionMethodTable)

{

ctx.self.extensionMethodTable = ctx.newExtensionMethodTable;

ctx.self.ClearMethodBindCache();

ctx.self.OnAccessSettingsChanged();

}

},

(self: this, newExtensionMethodTable)

);

}

}

}

/// <inheritdoc/>

public bool FormatCode { get; set; }

/// <inheritdoc/>

public bool AllowReflection { get; set; }

/// <inheritdoc/>

public bool DisableTypeRestriction { get; set; }

/// <inheritdoc/>

public bool DisableListIndexTypeRestriction { get; set; }

/// <inheritdoc/>

public bool EnableNullResultWrapping { get; set; }

/// <inheritdoc/>

public bool DisableFloatNarrowing { get; set; }

/// <inheritdoc/>

public bool DisableDynamicBinding { get; set; }

/// <inheritdoc/>

public bool UseReflectionBindFallback { get; set; }

/// <inheritdoc/>

public bool MarshalEnumAsUnderlyingType {

get => marshalEnumAsUnderlyingType;

set

{

marshalEnumAsUnderlyingType = value;

OnAccessSettingsChanged();

}

}

/// <inheritdoc/>

public bool AcceptEnumAsUnderlyingType

{

get => acceptEnumAsUnderlyingType;

set

{

if (value != acceptEnumAsUnderlyingType)

{

ScriptInvoke(

static ctx =>

{

if (ctx.value != ctx.self.acceptEnumAsUnderlyingType)

{

ctx.self.acceptEnumAsUnderlyingType = ctx.value;

ctx.self.ClearMethodBindCache();

ctx.self.OnAccessSettingsChanged();

}

},

(self: this, value)

);

}

}

}

/// <inheritdoc/>

public bool EnableAutoHostVariables { get; set; }

/// <inheritdoc/>

public object UndefinedImportValue { get; set; } = Undefined.Value;

/// <inheritdoc/>

public object NullImportValue { get; set; }

/// <inheritdoc/>

public object NullExportValue { get; set; }

/// <inheritdoc/>

public object VoidResultValue { get; set; } = VoidResult.Value;

/// <inheritdoc/>

public ContinuationCallback ContinuationCallback { get; set; }

/// <inheritdoc/>

public abstract dynamic Script { get; }

/// <inheritdoc/>

public abstract ScriptObject Global { get; }

/// <inheritdoc/>

public DocumentSettings DocumentSettings

{

get => documentSettings ?? defaultDocumentSettings;

set => documentSettings = value;

}

/// <inheritdoc cref="IScriptEngine.CustomAttributeLoader" />

public CustomAttributeLoader CustomAttributeLoader

{

get => customAttributeLoader;

set

{

customAttributeLoader = value;

OnAccessSettingsChanged();

}

}

/// <inheritdoc/>

public object HostData { get; set; }

/// <inheritdoc/>

public void AddHostObject(string itemName, object target)

{

AddHostObject(itemName, HostItemFlags.None, target);

}

/// <inheritdoc/>

public void AddHostObject(string itemName, HostItemFlags flags, object target)

{

MiscHelpers.VerifyNonNullArgument(target, nameof(target));

AddHostItem(itemName, flags, target);

}

/// <inheritdoc/>

public void AddRestrictedHostObject<T>(string itemName, T target)

{

AddRestrictedHostObject(itemName, HostItemFlags.None, target);

}

/// <inheritdoc/>

public void AddRestrictedHostObject<T>(string itemName, HostItemFlags flags, T target)

{

AddHostItem(itemName, flags, HostItem.Wrap(this, target, typeof(T)));

}

/// <inheritdoc/>

public void AddCOMObject(string itemName, string progID)

{

AddCOMObject(itemName, HostItemFlags.None, progID);

}

/// <inheritdoc/>

public void AddCOMObject(string itemName, string progID, string serverName)

{

AddCOMObject(itemName, HostItemFlags.None, progID, serverName);

}

/// <inheritdoc/>

public void AddCOMObject(string itemName, HostItemFlags flags, string progID)

{

AddCOMObject(itemName, flags, progID, null);

}

/// <inheritdoc/>

public void AddCOMObject(string itemName, HostItemFlags flags, string progID, string serverName)

{

AddHostItem(itemName, flags, MiscHelpers.CreateCOMObject(progID, serverName));

}

/// <inheritdoc/>

public void AddCOMObject(string itemName, Guid clsid)

{

AddCOMObject(itemName, HostItemFlags.None, clsid);

}

/// <inheritdoc/>

public void AddCOMObject(string itemName, Guid clsid, string serverName)

{

AddCOMObject(itemName, HostItemFlags.None, clsid, serverName);

}

/// <inheritdoc/>

public void AddCOMObject(string itemName, HostItemFlags flags, Guid clsid)

{

AddCOMObject(itemName, flags, clsid, null);

}

/// <inheritdoc/>

public void AddCOMObject(string itemName, HostItemFlags flags, Guid clsid, string serverName)

{

AddHostItem(itemName, flags, MiscHelpers.CreateCOMObject(clsid, serverName));

}

/// <inheritdoc/>

public void AddHostType(Type type)

{

AddHostType(HostItemFlags.None, type);

}

/// <inheritdoc/>

public void AddHostType(HostItemFlags flags, Type type)

{

AddHostType(type.GetRootName(), flags, type);

}

/// <inheritdoc/>

public void AddHostType(string itemName, Type type)

{

AddHostType(itemName, HostItemFlags.None, type);

}

/// <inheritdoc/>

public void AddHostType(string itemName, HostItemFlags flags, Type type)

{

MiscHelpers.VerifyNonNullArgument(type, nameof(type));

AddHostItem(itemName, flags, HostType.Wrap(type));

}

/// <inheritdoc/>

public void AddHostType(string itemName, string typeName, params Type[] typeArgs)

{

AddHostType(itemName, HostItemFlags.None, typeName, typeArgs);

}

/// <inheritdoc/>

public void AddHostType(string itemName, HostItemFlags flags, string typeName, params Type[] typeArgs)

{

AddHostItem(itemName, flags, TypeHelpers.ImportType(typeName, null, false, typeArgs));

}

/// <inheritdoc/>

public void AddHostType(string itemName, string typeName, string assemblyName, params Type[] typeArgs)

{

AddHostType(itemName, HostItemFlags.None, typeName, assemblyName, typeArgs);

}

/// <inheritdoc/>

public void AddHostType(string itemName, HostItemFlags flags, string typeName, string assemblyName, params Type[] typeArgs)

{

AddHostItem(itemName, flags, TypeHelpers.ImportType(typeName, assemblyName, true, typeArgs));

}

/// <inheritdoc/>

public void AddHostTypes(params Type[] types)

{

if (types is not null)

{

foreach (var type in types)

{

if (type is not null)

{

AddHostType(type);

}

}

}

}

/// <inheritdoc/>

public void AddCOMType(string itemName, string progID)

{

AddCOMType(itemName, HostItemFlags.None, progID);

}

/// <inheritdoc/>

public void AddCOMType(string itemName, string progID, string serverName)

{

AddCOMType(itemName, HostItemFlags.None, progID, serverName);

}

/// <inheritdoc/>

public void AddCOMType(string itemName, HostItemFlags flags, string progID)

{

AddCOMType(itemName, flags, progID, null);

}

/// <inheritdoc/>

public void AddCOMType(string itemName, HostItemFlags flags, string progID, string serverName)

{

AddHostItem(itemName, flags, HostType.Wrap(MiscHelpers.GetCOMType(progID, serverName)));

}

/// <inheritdoc/>

public void AddCOMType(string itemName, Guid clsid)

{

AddCOMType(itemName, HostItemFlags.None, clsid);

}

/// <inheritdoc/>

public void AddCOMType(string itemName, Guid clsid, string serverName)

{

AddCOMType(itemName, HostItemFlags.None, clsid, serverName);

}

/// <inheritdoc/>

public void AddCOMType(string itemName, HostItemFlags flags, Guid clsid)

{

AddCOMType(itemName, flags, clsid, null);

}

/// <inheritdoc/>

public void AddCOMType(string itemName, HostItemFlags flags, Guid clsid, string serverName)

{

AddHostItem(itemName, flags, HostType.Wrap(MiscHelpers.GetCOMType(clsid, serverName)));

}

/// <inheritdoc/>

public void Execute(string code)

{

Execute(null, code);

}

/// <inheritdoc/>

public void Execute(string documentName, string code)

{

Execute(documentName, false, code);

}

/// <inheritdoc/>

public void Execute(string documentName, bool discard, string code)

{

Execute(new DocumentInfo(documentName) { Flags = discard ? DocumentFlags.IsTransient : DocumentFlags.None }, code);

}

/// <inheritdoc/>

public void Execute(DocumentInfo documentInfo, string code)

{

Execute(documentInfo.MakeUnique(this), code, false);

}

/// <inheritdoc/>

public void ExecuteDocument(string specifier)

{

ExecuteDocument(specifier, null);

}

/// <inheritdoc/>

public void ExecuteDocument(string specifier, DocumentCategory category)

{

ExecuteDocument(specifier, category, null);

}

/// <inheritdoc/>

public void ExecuteDocument(string specifier, DocumentCategory category, DocumentContextCallback contextCallback)

{

MiscHelpers.VerifyNonBlankArgument(specifier, nameof(specifier), "Invalid document specifier");

var document = DocumentSettings.LoadDocument(null, specifier, category, contextCallback);

Execute(document.Info, document.GetTextContents());

}

/// <inheritdoc/>

public virtual string ExecuteCommand(string command)

{

var documentInfo = new DocumentInfo("Command") { Flags = DocumentFlags.IsTransient };

return GetCommandResultString(Evaluate(documentInfo.MakeUnique(this), command, false));

}

/// <inheritdoc/>

public object Evaluate(string code)

{

return Evaluate(null, code);

}

/// <inheritdoc/>

public object Evaluate(string documentName, string code)

{

return Evaluate(documentName, true, code);

}

/// <inheritdoc/>

public object Evaluate(string documentName, bool discard, string code)

{

return Evaluate(new DocumentInfo(documentName) { Flags = discard ? DocumentFlags.IsTransient : DocumentFlags.None }, code);

}

/// <inheritdoc/>

public object Evaluate(DocumentInfo documentInfo, string code)

{

return Evaluate(documentInfo.MakeUnique(this, DocumentFlags.IsTransient), code, true);

}

/// <inheritdoc/>

public object EvaluateDocument(string specifier)

{

return EvaluateDocument(specifier, null);

}

/// <inheritdoc/>

public object EvaluateDocument(string specifier, DocumentCategory category)

{

return EvaluateDocument(specifier, category, null);

}

/// <inheritdoc/>

public object EvaluateDocument(string specifier, DocumentCategory category, DocumentContextCallback contextCallback)

{

MiscHelpers.VerifyNonBlankArgument(specifier, nameof(specifier), "Invalid document specifier");

var document = DocumentSettings.LoadDocument(null, specifier, category, contextCallback);

return Evaluate(document.Info, document.GetTextContents());

}

/// <inheritdoc/>

public object Invoke(string funcName, params object[] args)

{

MiscHelpers.VerifyNonBlankArgument(funcName, nameof(funcName), "Invalid function name");

return Global.InvokeMethod(funcName, args ?? ArrayHelpers.GetEmptyArray<object>());

}

/// <inheritdoc/>

public abstract string GetStackTrace();

/// <inheritdoc/>

public abstract void Interrupt();

/// <inheritdoc/>

public abstract void CollectGarbage(bool exhaustive);

#endregion

#region internal members

internal ScriptObject EngineInternal => engineInternal ?? (engineInternal = (ScriptObject)Global["EngineInternal"]);

internal abstract IUniqueNameManager DocumentNameManager { get; }

internal virtual bool EnumerateInstanceMethods => true;

internal virtual bool EnumerateExtensionMethods => EnumerateInstanceMethods;

internal virtual bool UseCaseInsensitiveMemberBinding => false;

internal abstract void AddHostItem(string itemName, HostItemFlags flags, object item);

internal object PrepareResult<T>(T result, ScriptMemberFlags flags, bool isListIndexResult)

{

return PrepareResult(result, typeof(T), flags, isListIndexResult);

}

internal virtual object PrepareResult(object result, Type type, ScriptMemberFlags flags, bool isListIndexResult)

{

var wrapNull = flags.HasAllFlags(ScriptMemberFlags.WrapNullResult) || EnableNullResultWrapping;

if (wrapNull && (result is null))

{

return HostObject.WrapResult(null, type, true);

}

if (!flags.HasAllFlags(ScriptMemberFlags.ExposeRuntimeType) && !DisableTypeRestriction && (!isListIndexResult || !DisableListIndexTypeRestriction))

{

return HostObject.WrapResult(result, type, wrapNull);

}

return result;

}

internal abstract object MarshalToScript(object obj, HostItemFlags flags);

internal object MarshalToScript(object obj)

{

var hostItem = obj as HostItem;

return MarshalToScript(obj, hostItem?.Flags ?? HostItemFlags.None);

}

internal object[] MarshalToScript(object[] args)

{

return args.Select(MarshalToScript).ToArray();

}

internal abstract object MarshalToHost(object obj, bool preserveHostTarget);

internal object[] MarshalToHost(object[] args, bool preserveHostTargets)

{

return args.Select(arg => MarshalToHost(arg, preserveHostTargets)).ToArray();

}

internal abstract object Execute(UniqueDocumentInfo documentInfo, string code, bool evaluate);

internal abstract object ExecuteRaw(UniqueDocumentInfo documentInfo, string code, bool evaluate);

internal object Evaluate(UniqueDocumentInfo documentInfo, string code, bool marshalResult)

{

var result = Execute(documentInfo, code, true);

if (marshalResult)

{

result = MarshalToHost(result, false);

}

return result;

}

internal string GetCommandResultString(object result)

{

if (result is HostItem hostItem)

{

if (hostItem.Target is IHostVariable)

{

return result.ToString();

}

}

var marshaledResult = MarshalToHost(result, false);

if (marshaledResult is VoidResult)

{

return null;

}

if (marshaledResult is null)

{

return "[null]";

}

if (marshaledResult is Undefined)

{

return marshaledResult.ToString();

}

if (marshaledResult is ScriptItem)

{

return "[ScriptObject]";

}

return result.ToString();

}

internal void RequestInterrupt()

{

// Some script engines don't support IActiveScript::InterruptScriptThread(). This

// method provides an alternate mechanism based on IActiveScriptSiteInterruptPoll.

var tempScriptFrame = CurrentScriptFrame;

if (tempScriptFrame is not null)

{

tempScriptFrame.InterruptRequested = true;

}

}

internal void CheckReflection()

{

if (!AllowReflection)

{

throw new UnauthorizedAccessException("Use of reflection is prohibited in this script engine");

}

}

internal virtual void OnAccessSettingsChanged()

{

ClearConstructorBindCache();

ClearPropertyBindCache();

}

#endregion

#region host-side invocation

internal virtual void HostInvoke(Action action)

{

action();

}

internal virtual void HostInvoke<TArg>(Action<TArg> action, in TArg arg)

{

action(arg);

}

internal virtual TResult HostInvoke<TResult>(Func<TResult> func)

{

return func();

}

internal virtual TResult HostInvoke<TArg, TResult>(Func<TArg, TResult> func, in TArg arg)

{

return func(arg);

}

#endregion

#region script-side invocation

internal ScriptFrame CurrentScriptFrame { get; private set; }

internal ValueScope<ScriptEngine> CreateEngineScope()

{

return ScopeFactory.Create(static engine => MiscHelpers.Exchange(ref currentEngine, engine), static previousEngine => currentEngine = previousEngine, this);

}

internal virtual void ScriptInvoke(Action action)

{

using (CreateEngineScope())

{

ScriptInvokeInternal(action);

}

}

internal virtual void ScriptInvoke<TArg>(Action<TArg> action, in TArg arg)

{

using (CreateEngineScope())

{

ScriptInvokeInternal(action, arg);

}

}

internal virtual TResult ScriptInvoke<TResult>(Func<TResult> func)

{

using (CreateEngineScope())

{

return ScriptInvokeInternal(func);

}

}

internal virtual TResult ScriptInvoke<TArg, TResult>(Func<TArg, TResult> func, in TArg arg)

{

using (CreateEngineScope())

{

return ScriptInvokeInternal(func, arg);

}

}

internal void ScriptInvokeInternal(Action action)

{

var previousScriptFrame = CurrentScriptFrame;

CurrentScriptFrame = new ScriptFrame();

try

{

action();

}

finally

{

CurrentScriptFrame = previousScriptFrame;

}

}

internal void ScriptInvokeInternal<TArg>(Action<TArg> action, in TArg arg)

{

var previousScriptFrame = CurrentScriptFrame;

CurrentScriptFrame = new ScriptFrame();

try

{

action(arg);

}

finally

{

CurrentScriptFrame = previousScriptFrame;

}

}

internal TResult ScriptInvokeInternal<TResult>(Func<TResult> func)

{

var previousScriptFrame = CurrentScriptFrame;

CurrentScriptFrame = new ScriptFrame();

try

{

return func();

}

finally

{

CurrentScriptFrame = previousScriptFrame;

}

}

internal TResult ScriptInvokeInternal<TArg, TResult>(Func<TArg, TResult> func, in TArg arg)

{

var previousScriptFrame = CurrentScriptFrame;

CurrentScriptFrame = new ScriptFrame();

try

{

return func(arg);

}

finally

{

CurrentScriptFrame = previousScriptFrame;

}

}

internal void ThrowScriptError()

{

if (CurrentScriptFrame is not null)

{

ThrowScriptError(CurrentScriptFrame.ScriptError);

}

}

internal static void ThrowScriptError(IScriptEngineException scriptError)

{

if (scriptError is not null)

{

if (scriptError is ScriptInterruptedException)

{

throw new ScriptInterruptedException(scriptError.EngineName, scriptError.Message, scriptError.ErrorDetails, scriptError.HResult, scriptError.IsFatal, scriptError.ExecutionStarted, scriptError.ScriptExceptionAsObject, scriptError.InnerException);

}

throw new ScriptEngineException(scriptError.EngineName, scriptError.Message, scriptError.ErrorDetails, scriptError.HResult, scriptError.IsFatal, scriptError.ExecutionStarted, scriptError.ScriptExceptionAsObject, scriptError.InnerException);

}

}

#endregion

#region synchronized invocation

internal virtual void SyncInvoke(Action action)

{

action();

}

internal virtual T SyncInvoke<T>(Func<T> func)

{

return func();

}

#endregion

#region enumeration settings

internal object EnumerationSettingsToken { get; private set; } = new();

internal void OnEnumerationSettingsChanged()

{

EnumerationSettingsToken = new object();

}

#endregion

#region extension method table

private static readonly ExtensionMethodTable emptyExtensionMethodTable = new();

private readonly ExtensionMethodTable realExtensionMethodTable;

private ExtensionMethodTable extensionMethodTable;

internal void ProcessExtensionMethodType(Type type)

{

if (extensionMethodTable != emptyExtensionMethodTable)

{

if (extensionMethodTable.ProcessType(this, type))

{

ClearMethodBindCache();

}

}

}

internal ExtensionMethodSummary ExtensionMethodSummary => extensionMethodTable.Summary;

internal void RebuildExtensionMethodSummary()

{

if (extensionMethodTable != emptyExtensionMethodTable)

{

extensionMethodTable.RebuildSummary(this);

}

}

#endregion

#region constructor bind cache

private readonly Dictionary<BindSignature, ConstructorInfo> constructorBindCache = new();

internal void CacheConstructorBindResult(BindSignature signature, ConstructorInfo result)

{

constructorBindCache[signature] = result;

}

internal bool TryGetCachedConstructorBindResult(BindSignature signature, out ConstructorInfo result)

{

return constructorBindCache.TryGetValue(signature, out result);

}

private void ClearConstructorBindCache()

{

constructorBindCache.Clear();

}

#endregion

#region method bind cache

private readonly Dictionary<BindSignature, object> methodBindCache = new();

internal void CacheMethodBindResult(BindSignature signature, object result)

{

methodBindCache[signature] = result;

}

internal bool TryGetCachedMethodBindResult(BindSignature signature, out object result)

{

return methodBindCache.TryGetValue(signature, out result);

}

private void ClearMethodBindCache()

{

methodBindCache.Clear();

}

#endregion

#region property bind cache

private readonly Dictionary<BindSignature, MemberInfo> propertyGetBindCache = new();

private readonly Dictionary<BindSignature, MemberInfo> propertySetBindCache = new();

internal void CachePropertyGetBindResult(BindSignature signature, MemberInfo property)

{

propertyGetBindCache[signature] = property;

}

internal bool TryGetCachedPropertyGetBindResult(BindSignature signature, out MemberInfo property)

{

return propertyGetBindCache.TryGetValue(signature, out property);

}

internal void CachePropertySetBindResult(BindSignature signature, MemberInfo property)

{

propertySetBindCache[signature] = property;

}

internal bool TryGetCachedPropertySetBindResult(BindSignature signature, out MemberInfo property)

{

return propertySetBindCache.TryGetValue(signature, out property);

}

private void ClearPropertyBindCache()