OOJavaScriptEngine Class Reference

#include <OOJavaScriptEngine.h>

Inheritance diagram for OOJavaScriptEngine:

Collaboration diagram for OOJavaScriptEngine:

Instance Methods
(JSObject *)	- globalObject
(void)	- runMissionCallback
(BOOL)	- reset
(BOOL)	- callJSFunction:forObject:argc:argv:result:
(void)	- removeGCObjectRoot:
(void)	- removeGCValueRoot:
(void)	- garbageCollectionOpportunity:
(BOOL)	- showErrorLocations
(void)	- setShowErrorLocations:
(JSClass *)	- objectClass
(JSClass *)	- stringClass
(JSClass *)	- arrayClass
(JSClass *)	- numberClass
(JSClass *)	- booleanClass
(BOOL)	- dumpStackForErrors
(void)	- setDumpStackForErrors:
(BOOL)	- dumpStackForWarnings
(void)	- setDumpStackForWarnings:
(void)	- enableDebuggerStatement
(id)	- init [implementation]
(void)	- createMainThreadContext [implementation]
(void)	- destroyMainThreadContext [implementation]
(void)	- dealloc [implementation]
(BOOL)	- lookUpStandardClassPointers [implementation]
(void)	- registerStandardObjectConverters [implementation]
(void)	- setMonitor: [implementation]
(void)	- sendMonitorError:withMessage:inContext: [implementation]
(void)	- sendMonitorLogMessage:withMessageClass:inContext: [implementation]
(void)	- sendMonitorLogMessage:withMessageClass:inContext: [implementation]
(void)	- watchdogTimerThread [implementation]

Class Methods
(OOJavaScriptEngine *)	+ sharedEngine
(static JSTrapStatus)	+ DebuggerHook [implementation]

Private Attributes
JSRuntime *	_runtime
JSObject *	_globalObject
BOOL	_showErrorLocations
JSClass *	_objectClass
JSClass *	_stringClass
JSClass *	_arrayClass
JSClass *	_numberClass
JSClass *	_booleanClass
BOOL	_dumpStackForErrors
BOOL	_dumpStackForWarnings

Detailed Description

Definition at line 42 of file OOJavaScriptEngine.h.

Method Documentation

arrayClass

- (JSClass *) arrayClass

Definition at line 568 of file OOJavaScriptEngine.m.

{
    return _arrayClass;
}

References _arrayClass, and arrayClass.

Referenced by arrayClass.

Here is the call graph for this function:

Here is the caller graph for this function:

booleanClass

- (JSClass *) booleanClass

Definition at line 580 of file OOJavaScriptEngine.m.

{
    return _booleanClass;
}

References _booleanClass, and booleanClass.

Referenced by booleanClass.

Here is the call graph for this function:

Here is the caller graph for this function:

callJSFunction:forObject:argc:argv:result:

- (BOOL) callJSFunction:		(jsval)	function
forObject:		(JSObject *)	jsThis
argc:		(uintN)	argc
argv:		(jsval *)	argv
result:		(jsval *)	outResult

Definition at line 489 of file OOJavaScriptEngine.m.

                       :(jsval)function
              forObject:(JSObject *)jsThis
                   argc:(uintN)argc
                   argv:(jsval *)argv
                 result:(jsval *)outResult
{
    JSContext                   *context = NULL;
    BOOL                        result;
    
    NSParameterAssert(OOJSValueIsFunction(context, function));
    
    context = OOJSAcquireContext();
    
    OOJSStartTimeLimiter();
    result = JS_CallFunctionValue(context, jsThis, function, argc, argv, outResult);
    OOJSStopTimeLimiter();
    
    JS_ReportPendingException(context);
    OOJSRelinquishContext(context);
    
    return result;
}

References OOJSAcquireContext(), OOJSRelinquishContext(), OOJSStartTimeLimiter, OOJSStopTimeLimiter, and OOJSValueIsFunction().

Referenced by MissionRunCallback(), OOJSGuiScreenKeyDefinition::runCallback:, OOJSInterfaceDefinition::runCallback:, OOJSPopulatorDefinition::runCallback:, and OOJSTimer::timerFired.

Here is the call graph for this function:

Here is the caller graph for this function:

createMainThreadContext

- (void) createMainThreadContext

implementation

Provided by category OOJavaScriptEngine(Private).

Definition at line 301 of file OOJavaScriptEngine.m.

{
    NSAssert(gOOJSMainThreadContext == NULL, @"-[OOJavaScriptEngine createMainThreadContext] called while the main thread context exists.");
    
    // create a context and associate it with the JS runtime.
    gOOJSMainThreadContext = JS_NewContext(_runtime, OOJS_STACK_SIZE);
    
    // if context creation failed, end the program here.
    if (gOOJSMainThreadContext == NULL)
    {
        OOLog(@"script.javaScript.init.error", @"%@", @"***** FATAL ERROR: failed to create JavaScript context.");
        exit(1);
    }
    
    JS_BeginRequest(gOOJSMainThreadContext);
    
    JS_SetOptions(gOOJSMainThreadContext, OOJSENGINE_CONTEXT_OPTIONS);
    JS_SetVersion(gOOJSMainThreadContext, OOJSENGINE_JSVERSION);
    
#if JS_GC_ZEAL
    uint8_t gcZeal = [[NSUserDefaults standardUserDefaults]  oo_unsignedCharForKey:@"js-gc-zeal"];
    if (gcZeal > 0)
    {
        // Useful js-gc-zeal values are 0 (off), 1 and 2.
        OOLog(@"script.javaScript.debug.gcZeal", @"Setting JavaScript garbage collector zeal to %u.", gcZeal);
        JS_SetGCZeal(gOOJSMainThreadContext, gcZeal);
    }
#endif
    
    JS_SetErrorReporter(gOOJSMainThreadContext, ReportJSError);
    
    // Create the global object.
    CreateOOJSGlobal(gOOJSMainThreadContext, &_globalObject);
    
    // Initialize the built-in JS objects and the global object.
    JS_InitStandardClasses(gOOJSMainThreadContext, _globalObject);
    if (![self lookUpStandardClassPointers])
    {
        OOLog(@"script.javaScript.init.error", @"%@", @"***** FATAL ERROR: failed to look up standard JavaScript classes.");
        exit(1);
    }
    [self registerStandardObjectConverters];
    
    SetUpOOJSGlobal(gOOJSMainThreadContext, _globalObject);
    OOConstToJSStringInit(gOOJSMainThreadContext);
    
    // Initialize Oolite classes.
    InitOOJSMissionVariables(gOOJSMainThreadContext, _globalObject);
    InitOOJSMission(gOOJSMainThreadContext, _globalObject);
    InitOOJSOolite(gOOJSMainThreadContext, _globalObject);
    InitOOJSVector(gOOJSMainThreadContext, _globalObject);
    InitOOJSQuaternion(gOOJSMainThreadContext, _globalObject);
    InitOOJSSystem(gOOJSMainThreadContext, _globalObject);
    InitOOJSEntity(gOOJSMainThreadContext, _globalObject);
    InitOOJSShip(gOOJSMainThreadContext, _globalObject);
    InitOOJSStation(gOOJSMainThreadContext, _globalObject);
    InitOOJSDock(gOOJSMainThreadContext, _globalObject);
    InitOOJSVisualEffect(gOOJSMainThreadContext, _globalObject);
    InitOOJSExhaustPlume(gOOJSMainThreadContext, _globalObject);
    InitOOJSFlasher(gOOJSMainThreadContext, _globalObject);
    InitOOJSWormhole(gOOJSMainThreadContext, _globalObject);
    InitOOJSWaypoint(gOOJSMainThreadContext, _globalObject);
    InitOOJSPlayer(gOOJSMainThreadContext, _globalObject);
    InitOOJSPlayerShip(gOOJSMainThreadContext, _globalObject);
    InitOOJSManifest(gOOJSMainThreadContext, _globalObject);
    InitOOJSSun(gOOJSMainThreadContext, _globalObject);
    InitOOJSPlanet(gOOJSMainThreadContext, _globalObject);
    InitOOJSScript(gOOJSMainThreadContext, _globalObject);
    InitOOJSTimer(gOOJSMainThreadContext, _globalObject);
    InitOOJSClock(gOOJSMainThreadContext, _globalObject);
    InitOOJSWorldScripts(gOOJSMainThreadContext, _globalObject);
    InitOOJSSound(gOOJSMainThreadContext, _globalObject);
    InitOOJSSoundSource(gOOJSMainThreadContext, _globalObject);
    InitOOJSSpecialFunctions(gOOJSMainThreadContext, _globalObject);
    InitOOJSSystemInfo(gOOJSMainThreadContext, _globalObject);
    InitOOJSEquipmentInfo(gOOJSMainThreadContext, _globalObject);
    InitOOJSShipGroup(gOOJSMainThreadContext, _globalObject);
    InitOOJSFrameCallbacks(gOOJSMainThreadContext, _globalObject);
    InitOOJSFont(gOOJSMainThreadContext, _globalObject);
    
    // Run prefix scripts.
    [OOJSScript jsScriptFromFileNamed:@"oolite-global-prefix.js"
                           properties:[NSDictionary dictionaryWithObject:JSSpecialFunctionsObjectWrapper(gOOJSMainThreadContext)
                                                                  forKey:@"special"]];
    
    JS_EndRequest(gOOJSMainThreadContext);
    
    OOLog(@"script.javaScript.init.success", @"%@", @"Set up JavaScript context.");
}

References OOJavaScriptEngine(Private)::createMainThreadContext, CreateOOJSGlobal(), gOOJSMainThreadContext, InitOOJSClock(), InitOOJSDock(), InitOOJSEntity(), InitOOJSEquipmentInfo(), InitOOJSExhaustPlume(), InitOOJSFlasher(), InitOOJSFont(), InitOOJSFrameCallbacks(), InitOOJSManifest(), InitOOJSMission(), InitOOJSMissionVariables(), InitOOJSOolite(), InitOOJSPlanet(), InitOOJSPlayer(), InitOOJSPlayerShip(), InitOOJSQuaternion(), InitOOJSScript(), InitOOJSShip(), InitOOJSShipGroup(), InitOOJSSound(), InitOOJSSoundSource(), InitOOJSSpecialFunctions(), InitOOJSStation(), InitOOJSSun(), InitOOJSSystem(), InitOOJSSystemInfo(), InitOOJSTimer(), InitOOJSVector(), InitOOJSVisualEffect(), InitOOJSWaypoint(), InitOOJSWorldScripts(), InitOOJSWormhole(), JS_BeginRequest, JS_EndRequest, OOScript::jsScriptFromFileNamed:properties:, OOJavaScriptEngine(Private)::lookUpStandardClassPointers, OOConstToJSStringInit(), OOJS_STACK_SIZE, OOJSENGINE_CONTEXT_OPTIONS, OOJSENGINE_JSVERSION, OOLog, registerStandardObjectConverters, ReportJSError(), and SetUpOOJSGlobal().

Referenced by OOJavaScriptEngine(Private)::createMainThreadContext, init, and reset.

Here is the call graph for this function:

Here is the caller graph for this function:

dealloc

- (void) dealloc

implementation

Definition at line 470 of file OOJavaScriptEngine.m.

{
    sSharedEngine = nil;
    
    OOJSFrameCallbacksRemoveAll();
    
    [self destroyMainThreadContext];
    JS_DestroyRuntime(_runtime);
    
    [super dealloc];
}

References _runtime, dealloc, destroyMainThreadContext, nil, OOJSFrameCallbacksRemoveAll(), and sSharedEngine.

Referenced by dealloc.

Here is the call graph for this function:

Here is the caller graph for this function:

DebuggerHook

+ (static JSTrapStatus) DebuggerHook (JSContext *) context (JSScript *) script (jsbytecode *) pc (jsval *) rval (void *) closure

implementation

Definition at line 622 of file OOJavaScriptEngine.m.

{
    OOJSPauseTimeLimiter();
    
    OOLog(@"script.javaScript.debugger", @"debugger invoked during %@:", [[OOJSScript currentlyRunningScript] displayName]);
    OOJSDumpStack(context);
    
    OOJSResumeTimeLimiter();
    
    return JSTRAP_CONTINUE;
}

References OOJSDumpStack(), OOJSPauseTimeLimiter(), OOJSResumeTimeLimiter(), and OOLog.

Referenced by enableDebuggerStatement.

Here is the call graph for this function:

Here is the caller graph for this function:

destroyMainThreadContext

- (void) destroyMainThreadContext

implementation

Provided by category OOJavaScriptEngine(Private).

Definition at line 392 of file OOJavaScriptEngine.m.

{
    if (gOOJSMainThreadContext != NULL)
    {
        JSContext *context = OOJSAcquireContext();
        JS_ClearScope(gOOJSMainThreadContext, _globalObject);
        
        _globalObject = NULL;
        _objectClass = NULL;
        _stringClass = NULL;
        _arrayClass = NULL;
        _numberClass = NULL;
        _booleanClass = NULL;
        
        UnregisterObjectConverters();
        UnregisterSubclasses();
        OOConstToJSStringDestroy();
        
        OOJSRelinquishContext(context);
        
        _globalObject = NULL;
        JS_DestroyContext(gOOJSMainThreadContext);    // Forces unconditional GC.
        gOOJSMainThreadContext = NULL;
    }
}

References OOJavaScriptEngine(Private)::destroyMainThreadContext, gOOJSMainThreadContext, OOConstToJSStringDestroy(), OOJSAcquireContext(), OOJSRelinquishContext(), UnregisterObjectConverters(), and UnregisterSubclasses().

Referenced by dealloc, OOJavaScriptEngine(Private)::destroyMainThreadContext, and reset.

Here is the call graph for this function:

Here is the caller graph for this function:

dumpStackForErrors

- (BOOL) dumpStackForErrors

Definition at line 635 of file OOJavaScriptEngine.m.

{
    return _dumpStackForErrors;
}

References _dumpStackForErrors, and dumpStackForErrors.

Referenced by dumpStackForErrors, and ReportJSError().

Here is the call graph for this function:

Here is the caller graph for this function:

dumpStackForWarnings

- (BOOL) dumpStackForWarnings

Definition at line 647 of file OOJavaScriptEngine.m.

{
    return _dumpStackForWarnings;
}

References _dumpStackForWarnings, and dumpStackForWarnings.

Referenced by dumpStackForWarnings, and ReportJSError().

Here is the call graph for this function:

Here is the caller graph for this function:

enableDebuggerStatement

- (void) enableDebuggerStatement

Definition at line 659 of file OOJavaScriptEngine.m.

{
    JS_SetDebuggerHandler(_runtime, DebuggerHook, self);
}

References _runtime, DebuggerHook, and enableDebuggerStatement.

Referenced by enableDebuggerStatement, and OOInitDebugSupport().

Here is the call graph for this function:

Here is the caller graph for this function:

garbageCollectionOpportunity:

- (void) garbageCollectionOpportunity:

(BOOL)

force

Definition at line 529 of file OOJavaScriptEngine.m.

                                     :(BOOL)force
{
    JSContext *context = OOJSAcquireContext();
    if (force)
    {
        JS_GC(context);
    }
    else
    {
        JS_MaybeGC(context);
    }
    OOJSRelinquishContext(context);
}

References OOJSAcquireContext(), and OOJSRelinquishContext().

Referenced by PlayerEntity::docked, PlayerEntity::leaveWitchspace, PlayerEntity(LoadSave)::loadPlayerFromFile:asNew:, reset, and Universe::update:.

Here is the call graph for this function:

Here is the caller graph for this function:

globalObject

- (JSObject *) globalObject

Definition at line 483 of file OOJavaScriptEngine.m.

{
    return _globalObject;
}

References _globalObject, and globalObject.

Referenced by globalObject, OOJSFunction::initWithName:scope:code:argumentCount:argumentNames:fileName:lineNumber:context:, OOStringFromDeciCredits(), and OODebugMonitor(Private)::setUpDebugConsoleScript.

Here is the call graph for this function:

Here is the caller graph for this function:

init

- (id) init

implementation

Definition at line 259 of file OOJavaScriptEngine.m.

{
    NSAssert(sSharedEngine == nil, @"Attempt to create multiple OOJavaScriptEngines.");
    
    if (!(self = [super init]))  return nil;
    sSharedEngine = self;
    
    JS_SetCStringsAreUTF8();
    
    NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
#ifndef NDEBUG
    /*  Set stack trace preferences from preferences. These will be overriden
        by the debug OXP script if installed, but being able to enable traces
        without setting up the debug console could be useful for debugging
        users' problems.
    */
    [self setDumpStackForErrors:[defaults boolForKey:@"dump-stack-for-errors"]];
    [self setDumpStackForWarnings:[defaults boolForKey:@"dump-stack-for-warnings"]];
#endif
    
    assert(sizeof(jschar) == sizeof(unichar));
    
    // initialize the JS run time, and return result in runtime.
    uint32_t jsRuntimeInMiB = [defaults oo_intForKey:@"jsruntime-size-mib" defaultValue:OOJS_RUNTIME_SIZE_MiB];
    _runtime = JS_NewRuntime(jsRuntimeInMiB * 1024L * 1024L);
    
    // if runtime creation failed, end the program here.
    if (_runtime == NULL)
    {
        OOLog(@"script.javaScript.init.error", @"***** FATAL ERROR: failed to create JavaScript runtime with size %uMiB.", jsRuntimeInMiB);
        exit(1);
    }
    
    // OOJSTimeManagementInit() must be called before any context is created!
    OOJSTimeManagementInit(self, _runtime);
    
    [self createMainThreadContext];
    
    return self;
}

References _runtime, createMainThreadContext, init, nil, OOJSTimeManagementInit(), OOLog, setDumpStackForErrors:, setDumpStackForWarnings:, and sSharedEngine.

Referenced by init.

Here is the call graph for this function:

Here is the caller graph for this function:

lookUpStandardClassPointers

- (BOOL) lookUpStandardClassPointers

implementation

Provided by category OOJavaScriptEngine(Private).

Definition at line 586 of file OOJavaScriptEngine.m.

{
    JSObject                *templateObject = NULL;
    
    templateObject = JS_NewObject(gOOJSMainThreadContext, NULL, NULL, NULL);
    if (EXPECT_NOT(templateObject == NULL))  return NO;
    _objectClass = OOJSGetClass(gOOJSMainThreadContext, templateObject);
    
    if (EXPECT_NOT(!JS_ValueToObject(gOOJSMainThreadContext, JS_GetEmptyStringValue(gOOJSMainThreadContext), &templateObject)))  return NO;
    _stringClass = OOJSGetClass(gOOJSMainThreadContext, templateObject);
    
    templateObject = JS_NewArrayObject(gOOJSMainThreadContext, 0, NULL);
    if (EXPECT_NOT(templateObject == NULL))  return NO;
    _arrayClass = OOJSGetClass(gOOJSMainThreadContext, templateObject);
    
    if (EXPECT_NOT(!JS_ValueToObject(gOOJSMainThreadContext, INT_TO_JSVAL(0), &templateObject)))  return NO;
    _numberClass = OOJSGetClass(gOOJSMainThreadContext, templateObject);
    
    if (EXPECT_NOT(!JS_ValueToObject(gOOJSMainThreadContext, JSVAL_FALSE, &templateObject)))  return NO;
    _booleanClass = OOJSGetClass(gOOJSMainThreadContext, templateObject);
    
    return YES;
}

References EXPECT_NOT, gOOJSMainThreadContext, OOJavaScriptEngine(Private)::lookUpStandardClassPointers, and OOJSGetClass().

Referenced by OOJavaScriptEngine(Private)::createMainThreadContext, and OOJavaScriptEngine(Private)::lookUpStandardClassPointers.

Here is the call graph for this function:

Here is the caller graph for this function:

numberClass

- (JSClass *) numberClass

Definition at line 574 of file OOJavaScriptEngine.m.

{
    return _numberClass;
}

References _numberClass, and numberClass.

Referenced by numberClass.

Here is the call graph for this function:

Here is the caller graph for this function:

objectClass

- (JSClass *) objectClass

Definition at line 556 of file OOJavaScriptEngine.m.

{
    return _objectClass;
}

References _objectClass, and objectClass.

Referenced by objectClass.

Here is the call graph for this function:

Here is the caller graph for this function:

registerStandardObjectConverters

- (void) registerStandardObjectConverters

implementation

Provided by category OOJavaScriptEngine(Private).

Definition at line 611 of file OOJavaScriptEngine.m.

{
    OOJSRegisterObjectConverter([self objectClass], (OOJSClassConverterCallback)OOJSDictionaryFromJSObject);
    OOJSRegisterObjectConverter([self stringClass], JSStringConverter);
    OOJSRegisterObjectConverter([self arrayClass], JSArrayConverter);
    OOJSRegisterObjectConverter([self numberClass], JSNumberConverter);
    OOJSRegisterObjectConverter([self booleanClass], JSBooleanConverter);
}

References JSArrayConverter(), JSBooleanConverter(), JSNumberConverter(), JSStringConverter(), OOJSDictionaryFromJSObject(), OOJSRegisterObjectConverter(), and OOJavaScriptEngine(Private)::registerStandardObjectConverters.

Referenced by OOJavaScriptEngine(Private)::createMainThreadContext, and OOJavaScriptEngine(Private)::registerStandardObjectConverters.

Here is the call graph for this function:

Here is the caller graph for this function:

removeGCObjectRoot:

- (void) removeGCObjectRoot:

(JSObject **)

rootPtr

Definition at line 513 of file OOJavaScriptEngine.m.

                           :(JSObject **)rootPtr
{
    JSContext *context = OOJSAcquireContext();
    JS_RemoveObjectRoot(context, rootPtr);
    OOJSRelinquishContext(context);
}

References OOJSAcquireContext(), and OOJSRelinquishContext().

Referenced by OODebugMonitor::dealloc.

Here is the call graph for this function:

Here is the caller graph for this function:

removeGCValueRoot:

- (void) removeGCValueRoot:

(jsval *)

rootPtr

Definition at line 521 of file OOJavaScriptEngine.m.

                          :(jsval *)rootPtr
{
    JSContext *context = OOJSAcquireContext();
    JS_RemoveValueRoot(context, rootPtr);
    OOJSRelinquishContext(context);
}

References OOJSAcquireContext(), and OOJSRelinquishContext().

Here is the call graph for this function:

reset

- (BOOL) reset

Definition at line 419 of file OOJavaScriptEngine.m.

{
    NSAssert(gOOJSMainThreadContext != NULL, @"JavaScript engine not active. Can't reset.");
    
    OOJSFrameCallbacksRemoveAll();
    
# if 0
    // deferred JS reset - test harness.
    static int counter = 3;     // loading a savegame with different strict mode calls js reset twice
    if (counter-- == 0) {
    counter = 3;
    OOLog(@"script.javascript.init.error", @"%@", @"JavaScript processes still pending. Can't reset JavaScript engine.");
        return NO;
    }
    else
    {
        OOLog(@"script.javascript.init", @"%@", @"JavaScript reset successful.");
    }
#endif
        
#if JS_THREADSAFE
    //NSAssert(!JS_IsInRequest(gOOJSMainThreadContext), @"JavaScript processes still pending. Can't reset JavaScript engine.");
    
    if (JS_IsInRequest(gOOJSMainThreadContext))
    {
        // some threads are still pending, this should mean timers are still being removed.
        OOLog(@"script.javascript.init.error", @"%@", @"JavaScript processes still pending. Can't reset JavaScript engine.");
        return NO;
    }
    else
    {
        OOLog(@"script.javascript.init", @"%@", @"JavaScript reset successful.");
    }
#endif
    
    JSContext *context = OOJSAcquireContext();
    [[NSNotificationCenter defaultCenter] postNotificationName:kOOJavaScriptEngineWillResetNotification object:self];
    OOJSRelinquishContext(context);
    
    [self destroyMainThreadContext];
    [self createMainThreadContext];
    
    context = OOJSAcquireContext();
    [[NSNotificationCenter defaultCenter] postNotificationName:kOOJavaScriptEngineDidResetNotification object:self];
    OOJSRelinquishContext(context);
    
    [self garbageCollectionOpportunity:YES];
    return YES;
}

References createMainThreadContext, destroyMainThreadContext, garbageCollectionOpportunity:, gOOJSMainThreadContext, JS_IsInRequest, OOJSAcquireContext(), OOJSFrameCallbacksRemoveAll(), OOJSRelinquishContext(), OOLog, and reset.

Referenced by reset.

Here is the call graph for this function:

Here is the caller graph for this function:

runMissionCallback

- (void) runMissionCallback

Definition at line 253 of file OOJavaScriptEngine.m.

{
    MissionRunCallback();
}

References MissionRunCallback(), and runMissionCallback.

Referenced by PlayerEntity(Scripting)::doMissionCallback, and runMissionCallback.

Here is the call graph for this function:

Here is the caller graph for this function:

sendMonitorError:withMessage:inContext:

- (void) sendMonitorError: (JSErrorReport *) errorReport withMessage: (NSString *) message inContext: (JSContext *) context

implementation

Provided by category OOJavaScriptEngine(OOMonitorSupportInternal).

Definition at line 683 of file OOJavaScriptEngine.m.

                         :(JSErrorReport *)errorReport
              withMessage:(NSString *)message
                inContext:(JSContext *)theContext
{
    if ([_monitor respondsToSelector:@selector(jsEngine:context:error:stackSkip:showingLocation:withMessage:)])
    {
        [_monitor jsEngine:self context:theContext error:errorReport stackSkip:sErrorHandlerStackSkip showingLocation:[self showErrorLocations] withMessage:message];
    }
}

Referenced by ReportJSError().

Here is the caller graph for this function:

sendMonitorLogMessage:withMessageClass:inContext: [1/2]

- (void) sendMonitorLogMessage: (NSString *) message withMessageClass: (NSString *) messageClass inContext: (JSContext *) context

implementation

Provided by category OOJavaScriptEngine(OOMonitorSupportInternal).

Definition at line 694 of file OOJavaScriptEngine.m.

                              :(NSString *)message
              withMessageClass:(NSString *)messageClass
                     inContext:(JSContext *)theContext
{
    if ([_monitor respondsToSelector:@selector(jsEngine:context:logMessage:ofClass:)])
    {
        [_monitor jsEngine:self context:theContext logMessage:message ofClass:messageClass];
    }
}

Referenced by GlobalLog().

Here is the caller graph for this function:

sendMonitorLogMessage:withMessageClass:inContext: [2/2]

- (void) sendMonitorLogMessage: (NSString *) message withMessageClass: (NSString *) messageClass inContext: (JSContext *) context

implementation

Provided by category OOJavaScriptEngine(OOMonitorSupportInternal).

setDumpStackForErrors:

- (void) setDumpStackForErrors:

(BOOL)

value

Definition at line 641 of file OOJavaScriptEngine.m.

                              :(BOOL)value
{
    _dumpStackForErrors = !!value;
}

References _dumpStackForErrors.

Referenced by ConsoleSetProperty(), and init.

Here is the caller graph for this function:

setDumpStackForWarnings:

- (void) setDumpStackForWarnings:

(BOOL)

value

Definition at line 653 of file OOJavaScriptEngine.m.

                                :(BOOL)value
{
    _dumpStackForWarnings = !!value;
}

References _dumpStackForWarnings.

Referenced by ConsoleSetProperty(), and init.

Here is the caller graph for this function:

setMonitor:

- (void) setMonitor: (id<OOJavaScriptEngineMonitor>) inMonitor

implementation

Provided by category OOJavaScriptEngine(OOMonitorSupport).

Definition at line 672 of file OOJavaScriptEngine.m.

                   :(id<OOJavaScriptEngineMonitor>)inMonitor
{
    [_monitor autorelease];
    _monitor = [inMonitor retain];
}

Referenced by OODebugMonitor::init.

Here is the caller graph for this function:

setShowErrorLocations:

- (void) setShowErrorLocations:

(BOOL)

value

Definition at line 550 of file OOJavaScriptEngine.m.

                              :(BOOL)value
{
    _showErrorLocations = !!value;
}

References _showErrorLocations.

Referenced by ConsoleSetProperty(), and OOCheckJSSyntaxVerifierStage::run.

Here is the caller graph for this function:

sharedEngine

+ (OOJavaScriptEngine *) sharedEngine

Definition at line 245 of file OOJavaScriptEngine.m.

{
    if (sSharedEngine == nil)  sSharedEngine = [[self alloc] init];
    
    return sSharedEngine;
}

References nil, sharedEngine, and sSharedEngine.

Referenced by ConsoleSetProperty(), OODebugMonitor::dealloc, OOJSScript::dealloc, DebugMonitorToJSConsole(), OOJSGuiScreenKeyDefinition::deleteJSPointers, OOJSInterfaceDefinition::deleteJSPointers, OOJSPopulatorDefinition::deleteJSPointers, OOJSTimer::deleteJSPointers, Entity(OOJavaScriptExtensions)::deleteJSSelf, OOJSFunction::deleteJSValue, OOJSValue::deleteJSValue, DescribeValue(), PlayerEntity::docked, PlayerEntity(Scripting)::doMissionCallback, GlobalLog(), OODebugMonitor::init, OOJSGuiScreenKeyDefinition::init, OOJSInterfaceDefinition::init, OOJSPopulatorDefinition::init, OORegExpMatcher::init, OOJSTimer(Private)::initWithDelay:interval:context:function:this:, OOJSFunction::initWithFunction:context:, OOJSValue::initWithJSValue:inContext:, OOJSFunction::initWithName:scope:code:argumentCount:argumentNames:fileName:lineNumber:context:, OOJSScript::initWithPath:properties:, PlayerEntity(OOJavaScriptExtensions)::javaScriptEngineWillReset:, PlayerEntity::leaveWitchspace, PlayerEntity(LoadSave)::loadPlayerFromFile:asNew:, MissionRunCallback(), Entity(OOJavaScriptExtensions)::oo_jsValueInContext:, OOInitDebugSupport(), OOStringFromDeciCredits(), ReportJSError(), OOCheckJSSyntaxVerifierStage::run, OOJSGuiScreenKeyDefinition::runCallback:, OOJSInterfaceDefinition::runCallback:, OOJSPopulatorDefinition::runCallback:, PlayerEntity(OOJavaScriptExtensions)::setJSSelf:context:, OODebugMonitor(Private)::setUpDebugConsoleScript, sharedEngine, OOJSTimer::timerFired, and Universe::update:.

Here is the call graph for this function:

Here is the caller graph for this function:

showErrorLocations

- (BOOL) showErrorLocations

Definition at line 544 of file OOJavaScriptEngine.m.

{
    return _showErrorLocations;
}

References _showErrorLocations, and showErrorLocations.

Referenced by ReportJSError(), OOJavaScriptEngine(OOMonitorSupportInternal)::sendMonitorError:withMessage:inContext:, and showErrorLocations.

Here is the call graph for this function:

Here is the caller graph for this function:

stringClass

- (JSClass *) stringClass

Definition at line 562 of file OOJavaScriptEngine.m.

{
    return _stringClass;
}

References _stringClass, and stringClass.

Referenced by stringClass.

Here is the call graph for this function:

Here is the caller graph for this function:

watchdogTimerThread

- (void) watchdogTimerThread

implementation

Provided by category OOJavaScriptEngine(WatchdogTimer).

Definition at line 188 of file OOJSEngineTimeManagement.m.

{
    for (;;)
    {
#if OOLITE_WINDOWS
        Sleep(OOJS_TIME_LIMIT * 1000);
#else
        usleep(OOJS_TIME_LIMIT * 1000000);
#endif
        
        if (EXPECT(sLimiterStartDepth == 0 || sLimiterPauseDepth > 0))  continue; // Most of the time, a script isn't running.
        
        // Note: if you add logging here, you need a manual autorelease pool.
        
        OOHighResTimeValue now = OOGetHighResTime();
        OOTimeDelta elapsed = OOHighResTimeDeltaInSeconds(sLimiterStart, now);
        OODisposeHighResTime(now);
        
        if (EXPECT_NOT(elapsed > sLimiterTimeLimit))
        {
            sStop = YES;
            JS_TriggerAllOperationCallbacks(_runtime);
        }
    }
}

Member Data Documentation

_arrayClass

- (JSClass*) _arrayClass

private

Definition at line 51 of file OOJavaScriptEngine.h.

Referenced by arrayClass.

_booleanClass

- (JSClass*) _booleanClass

private

Definition at line 53 of file OOJavaScriptEngine.h.

Referenced by booleanClass.

_dumpStackForErrors

- (BOOL) _dumpStackForErrors

private

Definition at line 56 of file OOJavaScriptEngine.h.

Referenced by dumpStackForErrors, and setDumpStackForErrors:.

_dumpStackForWarnings

- (BOOL) _dumpStackForWarnings

private

Definition at line 57 of file OOJavaScriptEngine.h.

Referenced by dumpStackForWarnings, and setDumpStackForWarnings:.

_globalObject

- (JSObject*) _globalObject

private

Definition at line 46 of file OOJavaScriptEngine.h.

Referenced by globalObject.

_numberClass

- (JSClass*) _numberClass

private

Definition at line 52 of file OOJavaScriptEngine.h.

Referenced by numberClass.

_objectClass

- (JSClass*) _objectClass

private

Definition at line 49 of file OOJavaScriptEngine.h.

Referenced by objectClass.

_runtime

- (JSRuntime*) _runtime

private

Definition at line 45 of file OOJavaScriptEngine.h.

Referenced by dealloc, enableDebuggerStatement, and init.

_showErrorLocations

- (BOOL) _showErrorLocations

private

Definition at line 47 of file OOJavaScriptEngine.h.

Referenced by setShowErrorLocations:, and showErrorLocations.

_stringClass

- (JSClass*) _stringClass

private

Definition at line 50 of file OOJavaScriptEngine.h.

Referenced by stringClass.

---

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

• src/Core/Scripting/OOJavaScriptEngine.h
• src/Core/Scripting/OOJavaScriptEngine.m