OOJavaScriptEngine(Private) Category Reference

Instance Methods
(BOOL)	- lookUpStandardClassPointers
(void)	- registerStandardObjectConverters
(void)	- createMainThreadContext
(void)	- destroyMainThreadContext

Detailed Description

Definition at line 121 of file OOJavaScriptEngine.m.

Method Documentation

createMainThreadContext

- (void) createMainThreadContext

Extends class OOJavaScriptEngine.

Definition at line 2531 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.");
}

destroyMainThreadContext

- (void) destroyMainThreadContext

Extends class OOJavaScriptEngine.

Definition at line 2531 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;
    }
}

lookUpStandardClassPointers

- (BOOL) lookUpStandardClassPointers

Extends class OOJavaScriptEngine.

Definition at line 2531 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;
}

registerStandardObjectConverters

- (void) registerStandardObjectConverters

Extends class OOJavaScriptEngine.

Definition at line 2531 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);
}

---

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

• src/Core/Scripting/OOJavaScriptEngine.m