Implements the Scope for the Script Engine. More...

Inheritance diagram for BadScript2.Runtime.BadScope:

Public Member Functions

BadScope (string name, BadInteropExtensionProvider provider, BadScope? caller=null, BadScopeFlags flags=BadScopeFlags.RootScope)

Creates a new Scope.

BadScope (string name, BadInteropExtensionProvider provider, BadTable locals, BadScope? caller=null, BadScopeFlags flags=BadScopeFlags.RootScope)

Creates a new Scope.

void Dispose ()

Disposes the Scope and calls all finalizers.

BadArray GetMemberInfos ()

void AddFinalizer (Action finalizer)

Adds a Finalizer to the Scope.

void SetCaller (BadScope? caller)

Sets the Caller of the Scope.

BadScope GetRootScope ()

Returns the Root Scope of the Scope.

void AddSingleton< T > (T instance)

Adds a Singleton to the Scope.

T? GetSingleton< T > ()

Gets a Singleton from the Scope.

T GetSingleton< T > (bool createNew)

Gets a Singleton from the Scope.

override BadClassPrototype GetPrototype ()

Returns the Class Prototype for the Scope.

void SetFlags (BadScopeFlags flags)

Sets the Scope Flags.

string GetStackTrace ()

Returns the Stack Trace of the Current scope.

IEnumerable< BadScope > GetStackTraceEnumerable ()

BadScope GetFirstTracableOrRoot ()

void SetBreak ()

Sets the break keyword inside this scope.

void SetContinue ()

Sets the continue keyword inside this scope.

BadObject GetExports ()

Returns the exported key value pairs of the scope.

void SetExports (BadExecutionContext ctx, BadObject exports)

void AddExport (string key, BadObject value)

Sets an exported key value pair in the scope.

void SetReturnValue (BadObject? value)

Sets the Return value of this scope.

BadTable GetTable ()

Returns the Variable Table of the current scope.

BadScope CreateChild (string name, BadScope? caller, bool? useVisibility, BadScopeFlags flags=BadScopeFlags.RootScope)

Creates a subscope of the current scope.

void DefineProperty (string name, BadClassPrototype type, BadExpression getAccessor, BadExpression? setAccessor, BadExecutionContext caller, BadObject[] attributes)

void DefineVariable (string name, BadObject value, BadScope? caller=null, BadPropertyInfo? info=null, BadObject[]? attributes=null)

Defines a new Variable in the current scope.

BadPropertyInfo GetVariableInfo (string name)

Returns the variable info of the specified variable.

bool IsVisibleParentOf (BadScope scope)

Returns true if the specified scope is visible to the current scope.

BadObjectReference GetVariable (string name, BadScope caller)

Returns the variable reference of the specified variable.

BadObjectReference GetVariable (string name)

Returns a variable reference of the specified variable.

bool HasLocal (string name, BadScope caller, bool useExtensions=true)

returns true if the specified variable is defined in the current scope

bool HasVariable (string name, BadScope caller)

returns true if the specified variable is defined in the current scope or any parent scope

override BadObjectReference GetProperty (string propName, BadScope? caller=null)

Returns a Reference to the Property with the given Name.

Parameters

propName	The Property Name
caller	The caller Scope

Returns: The Property Reference

override bool HasProperty (string propName, BadScope? caller=null)

Returns true if the object contains a given property or there exists an extension for the current Instance.

Parameters

propName	The Property Name
caller	The caller Scope

Returns: True if the Property or an Extension with that name exists

override string ToSafeString (List< BadObject > done)

Public Member Functions inherited from BadScript2.Runtime.Objects.BadObject

BadClassPrototype GetPrototype ()

Returns the Prototype of this Object.

string ToSafeString (List< BadObject > done)

Returns a String Representation of this Object. This function is recursion proof and supports circular references.

override string ToString ()

Returns a String Representation of this Object.

Static Public Member Functions
static BadPropertyVisibility	GetPropertyVisibility (string propName)
	Returns the visibility of the specified property.

Static Public Member Functions inherited from BadScript2.Runtime.Objects.BadObject
static bool	CanWrap (object? o)
	Returns true if the given object cam be wrapped.

static BadObject	Wrap< T > (T obj, bool allowNative=true)
	Wraps the given object into a BadObject Instance.

static implicit	operator BadObject (bool b)
	Implicit Converstion from Boolean to BadObject.

static implicit	operator BadObject (BadNullable< bool > b)
	Converts the given object to a BadObject Instance.

static implicit	operator BadObject (DateTimeOffset d)

static implicit	operator BadObject (TimeSpan t)

static implicit	operator BadObject (decimal d)
	Implicit Converstion from Number to BadObject.

static implicit	operator BadObject (BadNullable< decimal > b)
	Converts the given object to a BadObject Instance.

static implicit	operator BadObject (string s)
	Implicit Converstion from String to BadObject.

static implicit	operator BadObject (BadNullable< string > b)
	Converts the given object to a BadObject Instance.

Package Functions
void	SetRegisteredApi (string api)
	Registers an API.

void	OnChanged (string name, BadObject oldValue, BadObject newValue)

bool	OnChange (string name, BadObject oldValue, BadObject newValue)

IEnumerable< BadObject >	InitializeAttributes ()

Properties
IReadOnlyDictionary< string, BadObject[]>	Attributes `[get]`

IReadOnlyCollection< string >	RegisteredApis `[get]`
	A List of Registered APIs.

BadInteropExtensionProvider	Provider `[get]`
	The Extension Provider.

BadClass?	ClassObject `[get, set]`
	The Class Object of the Scope.

BadFunction?	FunctionObject `[get, set]`
	The Function Object of the Scope.

BadScope?	Parent `[get]`
	The Parent Scope.

string	Name `[get]`
	The Name of the Scope (for Debugging)

BadScopeFlags	Flags `[get, private set]`
	The Scope Flags.

bool	CountInStackTrace `[get]`
	Indicates if the Scope should count towards the Stack Trace.

bool	IsBreak `[get, private set]`
	Is true if the Break Keyword was set.

bool	IsContinue `[get, private set]`
	Is true if the Continue Keyword was set.

BadObject?	ReturnValue `[get, private set]`
	The Return value of the scope.

static BadClassPrototype	Prototype `[get]`
	A Class Prototype for the Scope.

Private Member Functions
	BadScope (BadScope parent, BadScope? caller, string name, BadScopeFlags flags=BadScopeFlags.RootScope, bool useVisibility=false)
	Creates a new Scope.

Static Private Member Functions
static BadScope	CreateScope (BadExecutionContext ctx, string name, BadTable? locals=null)
	Creates a Root Scope with the given name.

static string	GetStackTrace (BadScope scope)
	Returns the Stack Trace of the given Scope.

static IEnumerable< BadScope >	GetStackTraceEnumerable (BadScope scope)

static BadScopeFlags	ClearCaptures (BadScopeFlags flags)
	Clears all Capture Flags from the given Flags.

Private Attributes
readonly Dictionary< string, BadObject[]>	m_Attributes = new Dictionary<string, BadObject[]>()

readonly List< Action >	m_Finalizers = new List<Action>()
	The Finalizer List of the Scope.

readonly BadInteropExtensionProvider	m_Provider
	The Extension Provider.

readonly List< string >	m_RegisteredApis = new List<string>()
	A List of Registered APIs.

readonly BadTable	m_ScopeVariables = new BadTable()
	The Scope Variables.

readonly Dictionary< Type, object >	m_SingletonCache = new Dictionary<Type, object>()
	The Singleton Cache.

readonly bool	m_UseVisibility
	Indicates if the Scope uses the visibility subsystem.

BadScope?	m_Caller
	The Caller of the Current Scope.

BadObject?	m_Exports
	Contains the exported variables of the scope.

bool	m_IsDisposed

Additional Inherited Members
Static Public Attributes inherited from BadScript2.Runtime.Objects.BadObject
static readonly BadObject	Null = new BadNullObject()
	The Null Value for the BadScript Language.

static readonly BadObject	True = new BadBoolean(true)
	The True Value for the BadScript Language.

static readonly BadObject	False = new BadBoolean(false)
	The False Value for the BadScript Language.

Detailed Description

Implements the Scope for the Script Engine.

Definition at line 15 of file BadScope.cs.

Constructor & Destructor Documentation

◆ BadScope() [1/3]

BadScript2.Runtime.BadScope.BadScope	(	string	name,
		BadInteropExtensionProvider	provider,
		BadScope?	caller = `null`,
		BadScopeFlags	flags = `BadScopeFlags::RootScope`
	)

Creates a new Scope.

Parameters

name	The Name of the Scope
provider	The Extension Provider of the Runtime
caller	The Caller of the Scope
flags	The Flags of the Scope

Definition at line 68 of file BadScope.cs.

    {
        Name = name;
        Flags = flags;
        m_Caller = caller;
        m_Provider = provider;
        m_ScopeVariables.SetChangeInterceptor(OnChange);
        m_ScopeVariables.OnChangedProperty += OnChanged;
    }

◆ BadScope() [2/3]

BadScript2.Runtime.BadScope.BadScope	(	string	name,
		BadInteropExtensionProvider	provider,
		BadTable	locals,
		BadScope?	caller = `null`,
		BadScopeFlags	flags = `BadScopeFlags::RootScope`
	)

Creates a new Scope.

Parameters

name	The Name of the Scope
provider	The Extension Provider of the Runtime
locals	The Local Variables
caller	The Caller of the Scope
flags	The Flags of the Scope

Definition at line 89 of file BadScope.cs.

    {
        Name = name;
        Flags = flags;
        m_Caller = caller;
        m_ScopeVariables = locals;
        m_Provider = provider;
        m_ScopeVariables.SetChangeInterceptor(OnChange);
        m_ScopeVariables.OnChangedProperty += OnChanged;
    }

◆ BadScope() [3/3]

BadScript2.Runtime.BadScope.BadScope	(	BadScope	parent,
		BadScope?	caller,
		string	name,
		BadScopeFlags	flags = `BadScopeFlags::RootScope`,
		bool	useVisibility = `false`
	)

private

Creates a new Scope.

Parameters

parent	The Parent Scope
caller	The Caller of the Scope
name	The Name of the Scope
flags	The Flags of the Scope
useVisibility	Does the Scope use the Visibility Subsystem

Definition at line 112 of file BadScope.cs.

                                                 : this(name,
                                                        parent.Provider,
                                                        caller,
                                                        ClearCaptures(parent.Flags) | flags
                                                       )
    {
        m_UseVisibility = useVisibility;
        Parent = parent;
    }

Member Function Documentation

◆ AddExport()

void BadScript2.Runtime.BadScope.AddExport	(	string	key,
		BadObject	value
	)

Sets an exported key value pair in the scope.

Parameters

key	The Key
value	The Value

Definition at line 542 of file BadScope.cs.

    {
        if (Parent != null)
        {
            Parent.AddExport(key, value);
        }
        else
        {
            if (m_Exports == null)
            {
                m_Exports = new BadTable();
            }
 
            m_Exports.SetProperty(key, value);
        }
    }

◆ AddFinalizer()

void BadScript2.Runtime.BadScope.AddFinalizer ( Action finalizer )

Adds a Finalizer to the Scope.

Parameters

finalizer The Finalizer

Exceptions

BadRuntimeException Gets raised if the Scope is already disposed

Definition at line 281 of file BadScope.cs.

    {
        if (m_IsDisposed)
        {
            throw BadRuntimeException.Create(this, "Scope is already disposed");
        }
 
        m_Finalizers.Add(finalizer);
    }

◆ AddSingleton< T >()

void BadScript2.Runtime.BadScope.AddSingleton< T > ( T instance )

Adds a Singleton to the Scope.

Parameters

instance

Template Parameters

T

Exceptions

BadRuntimeException

Type Constraints

T

:

class

Definition at line 315 of file BadScope.cs.

                                                    : class
    {
        if (instance == null)
        {
            throw new BadRuntimeException("Cannot add null as singleton");
        }
 
        m_SingletonCache.Add(typeof(T), instance);
    }

◆ ClearCaptures()

static BadScopeFlags BadScript2.Runtime.BadScope.ClearCaptures ( BadScopeFlags flags )

staticprivate

Clears all Capture Flags from the given Flags.

Parameters

flags The Flags to be cleared

Returns: Cleared Flags

Definition at line 471 of file BadScope.cs.

    {
        return flags &
               ~(BadScopeFlags.CaptureReturn |
                 BadScopeFlags.CaptureBreak |
                 BadScopeFlags.CaptureContinue |
                 BadScopeFlags.CaptureThrow);
    }

◆ CreateChild()

BadScope BadScript2.Runtime.BadScope.CreateChild	(	string	name,
		BadScope?	caller,
		bool?	useVisibility,
		BadScopeFlags	flags = `BadScopeFlags::RootScope`
	)

Creates a subscope of the current scope.

Parameters

name	Scope Name
caller	The Caller
useVisibility	Specifies if the scope is part of a class structure(if visibility flags are used)
flags	Scope Flags

Returns: New BadScope Instance

Definition at line 597 of file BadScope.cs.

    {
        BadScope sc = new BadScope(this, caller, name, flags, useVisibility ?? m_UseVisibility)
        {
            ClassObject = ClassObject, FunctionObject = FunctionObject,
        };
 
        return sc;
    }

◆ CreateScope()

static BadScope BadScript2.Runtime.BadScope.CreateScope	(	BadExecutionContext	ctx,
		string	name,
		BadTable?	locals = `null`
	)

staticprivate

Creates a Root Scope with the given name.

Parameters

ctx	The Calling Context
name	Scope Name
locals	The Local Variables of the new Scope

Returns: New Scope Instance

Definition at line 391 of file BadScope.cs.

    {
        BadScope s = locals != null
                         ? new BadScope(name, ctx.Scope.Provider, locals)
                         : new BadScope(name, ctx.Scope.Provider);
 
        foreach (KeyValuePair<Type, object> kvp in ctx.Scope.GetRootScope()
                                                      .m_SingletonCache)
        {
            s.m_SingletonCache.Add(kvp.Key, kvp.Value);
        }
 
        return s;
    }

◆ DefineProperty()

void BadScript2.Runtime.BadScope.DefineProperty	(	string	name,
		BadClassPrototype	type,
		BadExpression	getAccessor,
		BadExpression?	setAccessor,
		BadExecutionContext	caller,
		BadObject[]	attributes
	)

Definition at line 713 of file BadScope.cs.

    {
        if (HasLocal(name, caller.Scope, false))
        {
            throw new BadRuntimeException($"Property {name} is already defined");
        }
 
        Action<BadObject, BadSourcePosition?, BadPropertyInfo?>? setter = null;
 
        if (setAccessor != null)
        {
            setter = (value, p, pi) =>
            {
                BadExecutionContext? setCtx =
                    new BadExecutionContext(caller.Scope.CreateChild($"set {name}", caller.Scope, null));
 
                setCtx.Scope.DefineVariable("value",
                                            value,
                                            setCtx.Scope,
                                            new BadPropertyInfo(BadAnyPrototype.Instance, true)
                                           );
 
                foreach (BadObject o in setCtx.Execute(setAccessor))
                {
                    //Execute
                }
            };
        }
 
        m_ScopeVariables.PropertyInfos.Add(name, new BadPropertyInfo(type, setter == null));
 
        m_ScopeVariables.InnerTable.Add(name,
                                        BadObjectReference.Make($"property {name}",
                                                                (p) =>
                                                                {
                                                                    BadExecutionContext? getCtx =
                                                                        new BadExecutionContext(caller.Scope
                                                                                .CreateChild($"get {name}",
                                                                                     caller.Scope,
                                                                                     null
                                                                                    )
                                                                            );
                                                                    BadObject? get = Null;
 
                                                                    foreach (BadObject o in getCtx.Execute(getAccessor))
                                                                    {
                                                                        get = o;
                                                                    }
 
                                                                    return get.Dereference(p);
                                                                },
                                                                setter
                                                               )
                                       );
 
        m_Attributes[name] = attributes;
    }

◆ DefineVariable()

void BadScript2.Runtime.BadScope.DefineVariable	(	string	name,
		BadObject	value,
		BadScope?	caller = `null`,
		BadPropertyInfo?	info = `null`,
		BadObject?[]	attributes = `null`
	)

Defines a new Variable in the current scope.

Parameters

name	Variable Name
value	Variable Value
caller	The Caller of the Scope
info	Variable Info

Exceptions

BadRuntimeException Gets raised if the specified variable is already defined.

Definition at line 784 of file BadScope.cs.

    {
        if (HasLocal(name, caller ?? this, false))
        {
            throw new BadRuntimeException($"Variable {name} is already defined");
        }
 
        m_Attributes[name] = attributes ?? [];
 
        m_ScopeVariables.GetProperty(name, false, caller ?? this)
                        .Set(value, null, info, true);
    }

◆ Dispose()

void BadScript2.Runtime.BadScope.Dispose ( )

Disposes the Scope and calls all finalizers.

Definition at line 231 of file BadScope.cs.

    {
        if (m_IsDisposed)
        {
            return;
        }
 
        m_IsDisposed = true;
 
        foreach (Action finalizer in m_Finalizers)
        {
            finalizer();
        }
 
        m_Finalizers.Clear();
    }

◆ GetExports()

BadObject BadScript2.Runtime.BadScope.GetExports ( )

Returns the exported key value pairs of the scope.

Returns: BadTable with all exported variables

Definition at line 522 of file BadScope.cs.

    {
        return m_Exports ?? Null;
    }

◆ GetFirstTracableOrRoot()

BadScope BadScript2.Runtime.BadScope.GetFirstTracableOrRoot ( )

◆ GetMemberInfos()

BadArray BadScript2.Runtime.BadScope.GetMemberInfos ( )

Definition at line 250 of file BadScope.cs.

    {
        return new BadArray(m_ScopeVariables.InnerTable.Keys.Select(x => (BadObject)new BadMemberInfo(x, this))
                                            .ToList()
                           );
    }

◆ GetProperty()

override BadObjectReference BadScript2.Runtime.BadScope.GetProperty	(	string	propName,
		BadScope?	caller = `null`
	)

virtual

Returns a Reference to the Property with the given Name.

Parameters

propName	The Property Name
caller	The caller Scope

Returns: The Property Reference

Reimplemented from BadScript2.Runtime.Objects.BadObject.

Definition at line 943 of file BadScope.cs.

    {
        return HasVariable(propName, caller ?? this)
                   ? GetVariable(propName, caller ?? this)
                   : base.GetProperty(propName, caller);
    }

◆ GetPropertyVisibility()

static BadPropertyVisibility BadScript2.Runtime.BadScope.GetPropertyVisibility ( string propName )

static

Returns the visibility of the specified property.

Parameters

propName The Property Name

Returns: The Visibility of the Property

Definition at line 827 of file BadScope.cs.

    {
        char first = propName[0];
        char second = propName.Length > 1 ? propName[1] : '\0';
 
        return second switch
        {
            '_' => first == '_' ? BadPropertyVisibility.Private : BadPropertyVisibility.Public,
            _   => first == '_' ? BadPropertyVisibility.Protected : BadPropertyVisibility.Public,
        };
    }

◆ GetPrototype()

override BadClassPrototype BadScript2.Runtime.BadScope.GetPrototype ( )

Returns the Class Prototype for the Scope.

Returns: BadClassPrototype

Definition at line 379 of file BadScope.cs.

    {
        return Prototype;
    }

◆ GetRootScope()

BadScope BadScript2.Runtime.BadScope.GetRootScope ( )

Returns the Root Scope of the Scope.

Returns: The Root Scope

Definition at line 304 of file BadScope.cs.

    {
        return Parent?.GetRootScope() ?? this;
    }

◆ GetSingleton< T >() [1/2]

T? BadScript2.Runtime.BadScope.GetSingleton< T > ( )

Gets a Singleton from the Scope.

Template Parameters

T	Type of the Singleton

Returns: The Singleton

Definition at line 330 of file BadScope.cs.

    {
        if (Parent != null)
        {
            return Parent.GetSingleton<T>();
        }
 
        if (m_SingletonCache.TryGetValue(typeof(T), out object? value))
        {
            return (T)value;
        }
 
        return default;
    }

◆ GetSingleton< T >() [2/2]

T BadScript2.Runtime.BadScope.GetSingleton< T > ( bool createNew )

Gets a Singleton from the Scope.

Parameters

createNew Should a new instance be created if the singleton does not exist

Template Parameters

T	Type of the Singleton

Returns: The Singleton

Exceptions

Exception Gets raised if the singleton does not exist and createNew is false

Type Constraints

T

:

new()

Definition at line 352 of file BadScope.cs.

                                                     : new()
    {
        if (Parent != null)
        {
            return Parent.GetSingleton<T>(createNew);
        }
 
        if (m_SingletonCache.ContainsKey(typeof(T)))
        {
            return (T)m_SingletonCache[typeof(T)];
        }
 
        if (!createNew)
        {
            throw new Exception("Singleton not found");
        }
 
        T v = new T();
        m_SingletonCache[typeof(T)] = v;
 
        return v;
    }

◆ GetStackTrace() [1/2]

string BadScript2.Runtime.BadScope.GetStackTrace ( )

Returns the Stack Trace of the Current scope.

Returns: Stack Trace

Definition at line 419 of file BadScope.cs.

    {
        return GetStackTrace(this);
    }

◆ GetStackTrace() [2/2]

static string BadScript2.Runtime.BadScope.GetStackTrace ( BadScope scope )

staticprivate

Returns the Stack Trace of the given Scope.

Parameters

scope The Scope

Returns: Stack Trace

Definition at line 429 of file BadScope.cs.

    {
        BadScope? current = scope;
        List<BadScope> stack = new List<BadScope>();
 
        while (current != null)
        {
            if (current.CountInStackTrace)
            {
                stack.Add(current);
            }
 
            current = current.m_Caller ?? current.Parent;
        }
 
        return string.Join("\n", stack.Select(s => s.Name));
    }

◆ GetStackTraceEnumerable() [1/2]

IEnumerable< BadScope > BadScript2.Runtime.BadScope.GetStackTraceEnumerable ( )

◆ GetStackTraceEnumerable() [2/2]

static IEnumerable< BadScope > BadScript2.Runtime.BadScope.GetStackTraceEnumerable ( BadScope scope )

staticprivate

Definition at line 447 of file BadScope.cs.

    {
        BadScope? current = scope;
 
        while (current != null)
        {
            if (current.CountInStackTrace)
            {
                yield return current;
            }
 
            current = current.m_Caller ?? current.Parent;
        }
    }

◆ GetTable()

BadTable BadScript2.Runtime.BadScope.GetTable ( )

Returns the Variable Table of the current scope.

Returns: BadTable with all local variables

Definition at line 583 of file BadScope.cs.

    {
        return m_ScopeVariables;
    }

◆ GetVariable() [1/2]

BadObjectReference BadScript2.Runtime.BadScope.GetVariable ( string name )

Returns a variable reference of the specified variable.

Parameters

name	Variable Name

Returns: Variable Reference

Exceptions

BadRuntimeException Gets raised if the variable can not be found

Definition at line 911 of file BadScope.cs.

    {
        return GetVariable(name, this);
    }

◆ GetVariable() [2/2]

BadObjectReference BadScript2.Runtime.BadScope.GetVariable	(	string	name,
		BadScope	caller
	)

Returns the variable reference of the specified variable.

Parameters

name	Variable Name
caller	The Calling Scope

Returns: Variable Reference

Exceptions

BadRuntimeException Gets raised if the variable can not be found or is not visible

Definition at line 878 of file BadScope.cs.

    {
        if (m_UseVisibility)
        {
            BadPropertyVisibility vis = IsVisibleParentOf(caller)
                                            ? BadPropertyVisibility.All
                                            : BadPropertyVisibility.Public;
 
            if ((GetPropertyVisibility(name) & vis) == 0)
            {
                throw BadRuntimeException.Create(caller, $"Variable '{name}' is not visible to {caller}");
            }
        }
 
        if (HasLocal(name, caller))
        {
            return m_ScopeVariables.GetProperty(name, caller);
        }
 
        if (Parent == null)
        {
            throw BadRuntimeException.Create(caller, $"Variable '{name}' is not defined");
        }
 
        return Parent!.GetVariable(name, caller);
    }

◆ GetVariableInfo()

BadPropertyInfo BadScript2.Runtime.BadScope.GetVariableInfo ( string name )

Returns the variable info of the specified variable.

Parameters

name	Variable Name

Returns: Variable Info

Exceptions

BadRuntimeException Gets raised if the variable can not be found

Definition at line 807 of file BadScope.cs.

    {
        if (HasLocal(name, this))
        {
            return m_ScopeVariables.GetPropertyInfo(name);
        }
 
        if (Parent == null)
        {
            throw new BadRuntimeException($"Variable '{name}' is not defined");
        }
 
        return Parent!.GetVariableInfo(name);
    }

◆ HasLocal()

bool BadScript2.Runtime.BadScope.HasLocal	(	string	name,
		BadScope	caller,
		bool	useExtensions = `true`
	)

returns true if the specified variable is defined in the current scope

Parameters

name	The Name
caller	The Caller of the Scope
useExtensions	Should the Extension Subsystem be searched for the property

Returns: true if the variable is defined

Definition at line 923 of file BadScope.cs.

    {
        return !useExtensions
                   ? m_ScopeVariables.InnerTable.ContainsKey(name)
                   : m_ScopeVariables.HasProperty(name, caller);
    }

◆ HasProperty()

override bool BadScript2.Runtime.BadScope.HasProperty	(	string	propName,
		BadScope?	caller = `null`
	)

virtual

Returns true if the object contains a given property or there exists an extension for the current Instance.

Parameters

propName	The Property Name
caller	The caller Scope

Returns: True if the Property or an Extension with that name exists

Reimplemented from BadScript2.Runtime.Objects.BadObject.

Definition at line 951 of file BadScope.cs.

    {
        return HasVariable(propName, caller ?? this) || base.HasProperty(propName, caller);
    }

◆ HasVariable()

bool BadScript2.Runtime.BadScope.HasVariable	(	string	name,
		BadScope	caller
	)

returns true if the specified variable is defined in the current scope or any parent scope

Parameters

name	The Name
caller	The Caller of the Scope

Returns: true if the variable is defined

Definition at line 936 of file BadScope.cs.

    {
        return HasLocal(name, caller) || (Parent != null && Parent.HasVariable(name, caller));
    }

◆ InitializeAttributes()

IEnumerable< BadObject > BadScript2.Runtime.BadScope.InitializeAttributes ( )

package

Definition at line 683 of file BadScope.cs.

    {
        if (ClassObject == null)
        {
            throw new BadRuntimeException("Scope is not a class scope");
        }
 
        foreach (KeyValuePair<string, BadObject[]> kvp in m_Attributes)
        {
            BadMemberInfo? member = new BadMemberInfo(kvp.Key, this);
 
            foreach (BadClass attribute in kvp.Value.OfType<BadClass>())
            {
                if (attribute.InheritsFrom(BadNativeClassBuilder.InitializeAttribute))
                {
                    BadFunction? invoke = (BadFunction)attribute.GetProperty("Initialize")
                                                                .Dereference(null);
 
                    foreach (BadObject o in invoke.Invoke(new BadObject[] { ClassObject!, member },
                                                          new BadExecutionContext(this)
                                                         ))
                    {
                        //Execute
                        yield return o;
                    }
                }
            }
        }
    }

◆ IsVisibleParentOf()

bool BadScript2.Runtime.BadScope.IsVisibleParentOf ( BadScope scope )

Returns true if the specified scope is visible to the current scope.

Parameters

scope The Scope

Returns: true if the scope is visible

Definition at line 844 of file BadScope.cs.

    {
        if (scope == this)
        {
            return true;
        }
 
        BadScope? current = scope.Parent;
 
        while (current != null)
        {
            if (!current.m_UseVisibility)
            {
                return false;
            }
 
            if (current == this)
            {
                return true;
            }
 
            current = current.Parent;
        }
 
        return false;
    }

◆ OnChange()

bool BadScript2.Runtime.BadScope.OnChange	(	string	name,
		BadObject	oldValue,
		BadObject	newValue
	)

package

Definition at line 642 of file BadScope.cs.

    {
        if (ClassObject == null)
        {
            return false;
        }
 
        if (m_Attributes.TryGetValue(name, out BadObject[]? attributes))
        {
            BadMemberInfo? member = new BadMemberInfo(name, this);
 
            foreach (BadClass attribute in attributes.OfType<BadClass>())
            {
                if (attribute.InheritsFrom(BadNativeClassBuilder.ChangeAttribute))
                {
                    BadFunction? invoke = (BadFunction)attribute.GetProperty("OnChange")
                                                                .Dereference(null);
 
                    BadMemberChangingEvent? eventObj =
                        new BadMemberChangingEvent(ClassObject!, member, oldValue, newValue);
                    BadObject? obj = Null;
 
                    foreach (BadObject o in invoke.Invoke(new BadObject[] { eventObj },
                                                          new BadExecutionContext(this)
                                                         ))
                    {
                        //Execute
                        obj = o;
                    }
 
                    if (eventObj.Cancel)
                    {
                        return true;
                    }
                }
            }
        }
 
        return false;
    }

◆ OnChanged()

void BadScript2.Runtime.BadScope.OnChanged	(	string	name,
		BadObject	oldValue,
		BadObject	newValue
	)

package

Definition at line 610 of file BadScope.cs.

    {
        if (ClassObject == null)
        {
            return;
        }
 
        if (m_Attributes.TryGetValue(name, out BadObject[]? attributes))
        {
            BadMemberInfo? member = new BadMemberInfo(name, this);
 
            foreach (BadClass attribute in attributes.OfType<BadClass>())
            {
                if (attribute.InheritsFrom(BadNativeClassBuilder.ChangedAttribute))
                {
                    BadFunction? invoke = (BadFunction)attribute.GetProperty("OnChanged")
                                                                .Dereference(null);
 
                    BadMemberChangedEvent? eventObj =
                        new BadMemberChangedEvent(ClassObject!, member, oldValue, newValue);
 
                    foreach (BadObject o in invoke.Invoke(new BadObject[] { eventObj },
                                                          new BadExecutionContext(this)
                                                         ))
                    {
                        //Execute
                    }
                }
            }
        }
    }

◆ SetBreak()

void BadScript2.Runtime.BadScope.SetBreak ( )

Sets the break keyword inside this scope.

Exceptions

BadRuntimeException Gets raised if the current scope does not allow the Break Keyword

Definition at line 484 of file BadScope.cs.

    {
        if ((Flags & BadScopeFlags.AllowBreak) == 0)
        {
            throw new BadRuntimeException("Break not allowed in this scope");
        }
 
        IsBreak = true;
 
        if ((Flags & BadScopeFlags.CaptureBreak) == 0)
        {
            Parent?.SetBreak();
        }
    }

◆ SetCaller()

void BadScript2.Runtime.BadScope.SetCaller ( BadScope? caller )

Sets the Caller of the Scope.

Parameters

caller The Caller

Definition at line 295 of file BadScope.cs.

    {
        m_Caller = caller;
    }

◆ SetContinue()

void BadScript2.Runtime.BadScope.SetContinue ( )

Sets the continue keyword inside this scope.

Exceptions

BadRuntimeException Gets raised if the current scope does not allow the continue Keyword

Definition at line 503 of file BadScope.cs.

    {
        if ((Flags & BadScopeFlags.AllowContinue) == 0)
        {
            throw new BadRuntimeException("Continue not allowed in this scope");
        }
 
        IsContinue = true;
 
        if ((Flags & BadScopeFlags.CaptureContinue) == 0)
        {
            Parent?.SetContinue();
        }
    }

◆ SetExports()

void BadScript2.Runtime.BadScope.SetExports	(	BadExecutionContext	ctx,
		BadObject	exports
	)

Definition at line 527 of file BadScope.cs.

    {
        if (m_Exports != null)
        {
            throw BadRuntimeException.Create(ctx.Scope, "Exports are already set");
        }
 
        m_Exports = exports;
    }

◆ SetFlags()

void BadScript2.Runtime.BadScope.SetFlags ( BadScopeFlags flags )

Sets the Scope Flags.

Parameters

flags Scope Flags

Definition at line 410 of file BadScope.cs.

    {
        Flags = flags;
    }

◆ SetRegisteredApi()

void BadScript2.Runtime.BadScope.SetRegisteredApi ( string api )

package

Registers an API.

Parameters

api

Definition at line 261 of file BadScope.cs.

    {
        if (Parent != null)
        {
            Parent.SetRegisteredApi(api);
 
            return;
        }
 
        if (!m_RegisteredApis.Contains(api))
        {
            m_RegisteredApis.Add(api);
        }
    }

◆ SetReturnValue()

void BadScript2.Runtime.BadScope.SetReturnValue ( BadObject? value )

Sets the Return value of this scope.

Parameters

value The Return Value

Exceptions

BadRuntimeException Gets Raised if the Scope does not allow returning

Definition at line 564 of file BadScope.cs.

    {
        if ((Flags & BadScopeFlags.AllowReturn) == 0)
        {
            throw new BadRuntimeException("Return not allowed in this scope");
        }
 
        ReturnValue = value;
 
        if ((Flags & BadScopeFlags.CaptureReturn) == 0)
        {
            Parent?.SetReturnValue(value);
        }
    }

◆ ToSafeString()

override string BadScript2.Runtime.BadScope.ToSafeString ( List< BadObject > done )

Definition at line 958 of file BadScope.cs.

    {
        done.Add(this);
 
        return m_ScopeVariables.ToSafeString(done);
    }

Member Data Documentation

◆ m_Attributes

readonly Dictionary<string, BadObject[]> BadScript2.Runtime.BadScope.m_Attributes = new Dictionary<string, BadObject[]>()

private

Definition at line 17 of file BadScope.cs.

◆ m_Caller

BadScope? BadScript2.Runtime.BadScope.m_Caller

private

The Caller of the Current Scope.

Definition at line 52 of file BadScope.cs.

◆ m_Exports

BadObject? BadScript2.Runtime.BadScope.m_Exports

private

Contains the exported variables of the scope.

Definition at line 57 of file BadScope.cs.

◆ m_Finalizers

readonly List<Action> BadScript2.Runtime.BadScope.m_Finalizers = new List<Action>()

private

The Finalizer List of the Scope.

Definition at line 22 of file BadScope.cs.

◆ m_IsDisposed

bool BadScript2.Runtime.BadScope.m_IsDisposed

private

Definition at line 59 of file BadScope.cs.

◆ m_Provider

readonly BadInteropExtensionProvider BadScript2.Runtime.BadScope.m_Provider

private

The Extension Provider.

Definition at line 27 of file BadScope.cs.

◆ m_RegisteredApis

readonly List<string> BadScript2.Runtime.BadScope.m_RegisteredApis = new List<string>()

private

A List of Registered APIs.

Definition at line 32 of file BadScope.cs.

◆ m_ScopeVariables

readonly BadTable BadScript2.Runtime.BadScope.m_ScopeVariables = new BadTable()

private

The Scope Variables.

Definition at line 37 of file BadScope.cs.

◆ m_SingletonCache

readonly Dictionary<Type, object> BadScript2.Runtime.BadScope.m_SingletonCache = new Dictionary<Type, object>()

private

The Singleton Cache.

Definition at line 42 of file BadScope.cs.

◆ m_UseVisibility

readonly bool BadScript2.Runtime.BadScope.m_UseVisibility

private

Indicates if the Scope uses the visibility subsystem.

Definition at line 47 of file BadScope.cs.

Property Documentation

◆ Attributes

IReadOnlyDictionary<string, BadObject[]> BadScript2.Runtime.BadScope.Attributes

get

Definition at line 126 of file BadScope.cs.

◆ ClassObject

BadClass? BadScript2.Runtime.BadScope.ClassObject

getset

The Class Object of the Scope.

Definition at line 141 of file BadScope.cs.

141{ get; internal set; }

◆ CountInStackTrace

bool BadScript2.Runtime.BadScope.CountInStackTrace

getprivate

Indicates if the Scope should count towards the Stack Trace.

Definition at line 167 of file BadScope.cs.

◆ Flags

BadScopeFlags BadScript2.Runtime.BadScope.Flags

getprivate set

The Scope Flags.

Definition at line 162 of file BadScope.cs.

162{ get; private set; }

◆ FunctionObject

BadFunction? BadScript2.Runtime.BadScope.FunctionObject

getset

The Function Object of the Scope.

Definition at line 146 of file BadScope.cs.

146{ get; internal set; }

◆ IsBreak

bool BadScript2.Runtime.BadScope.IsBreak

getprivate set

Is true if the Break Keyword was set.

Definition at line 172 of file BadScope.cs.

172{ get; private set; }

◆ IsContinue

bool BadScript2.Runtime.BadScope.IsContinue

getprivate set

Is true if the Continue Keyword was set.

Definition at line 177 of file BadScope.cs.

177{ get; private set; }

◆ Name

string BadScript2.Runtime.BadScope.Name

get

The Name of the Scope (for Debugging)

Definition at line 157 of file BadScope.cs.

157{ get; }

◆ Parent

BadScope? BadScript2.Runtime.BadScope.Parent

get

The Parent Scope.

Definition at line 152 of file BadScope.cs.

152{ get; }

◆ Prototype

BadClassPrototype BadScript2.Runtime.BadScope.Prototype

staticget

A Class Prototype for the Scope.

Definition at line 188 of file BadScope.cs.

188{ get; } = new BadNativeClassPrototype<BadScope>("Scope",

BadScript2.Runtime.Objects.Types.BadNativeClassPrototype

Implements a Native Class Prototype.

Definition BadNativeClassPrototype.cs:11

◆ Provider

BadInteropExtensionProvider BadScript2.Runtime.BadScope.Provider

get

The Extension Provider.

Definition at line 136 of file BadScope.cs.

◆ RegisteredApis

IReadOnlyCollection<string> BadScript2.Runtime.BadScope.RegisteredApis

get

A List of Registered APIs.

Definition at line 131 of file BadScope.cs.

◆ ReturnValue

BadObject? BadScript2.Runtime.BadScope.ReturnValue

getprivate set

The Return value of the scope.

Definition at line 182 of file BadScope.cs.

182{ get; private set; }

The documentation for this class was generated from the following file:

src/BadScript2/Runtime/BadScope.cs

Public Member Functions

Static Public Member Functions

Package Functions

Properties

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BadScope() [1/3]

◆ BadScope() [2/3]

◆ BadScope() [3/3]

Member Function Documentation

◆ AddExport()

◆ AddFinalizer()

◆ AddSingleton< T >()

◆ ClearCaptures()

◆ CreateChild()

◆ CreateScope()

◆ DefineProperty()

◆ DefineVariable()

◆ Dispose()

◆ GetExports()

◆ GetFirstTracableOrRoot()

◆ GetMemberInfos()

◆ GetProperty()

◆ GetPropertyVisibility()

◆ GetPrototype()

◆ GetRootScope()

◆ GetSingleton< T >() [1/2]

◆ GetSingleton< T >() [2/2]

◆ GetStackTrace() [1/2]

◆ GetStackTrace() [2/2]

◆ GetStackTraceEnumerable() [1/2]

◆ GetStackTraceEnumerable() [2/2]

◆ GetTable()

◆ GetVariable() [1/2]

◆ GetVariable() [2/2]

◆ GetVariableInfo()

◆ HasLocal()

◆ HasProperty()

◆ HasVariable()

◆ InitializeAttributes()

◆ IsVisibleParentOf()

◆ OnChange()

◆ OnChanged()

◆ SetBreak()

◆ SetCaller()

◆ SetContinue()

◆ SetExports()

◆ SetFlags()

◆ SetRegisteredApi()

◆ SetReturnValue()

◆ ToSafeString()

Member Data Documentation

◆ m_Attributes

◆ m_Caller

◆ m_Exports

◆ m_Finalizers

◆ m_IsDisposed

◆ m_Provider

◆ m_RegisteredApis

◆ m_ScopeVariables

◆ m_SingletonCache

◆ m_UseVisibility

Property Documentation

◆ Attributes

◆ ClassObject

◆ CountInStackTrace

◆ Flags

◆ FunctionObject

◆ IsBreak

◆ IsContinue

◆ Name

◆ Parent

◆ Prototype

◆ Provider

◆ RegisteredApis

◆ ReturnValue