OOJSOolite.m File Reference

import "OOJSOolite.h"
import "OOJavaScriptEngine.h"
import "OOStringParsing.h"
import "OOJSPlayer.h"
import "ResourceManager.h"
import "MyOpenGLView.h"
import "OOConstToString.h"

Include dependency graph for OOJSOolite.m:

Go to the source code of this file.

Enumerations
enum	{   kOolite_version , kOolite_versionString , kOolite_jsVersion , kOolite_jsVersionString ,   kOolite_gameSettings , kOolite_resourcePaths , kOolite_colorSaturation , kOolite_postFX ,   kOolite_hdrToneMapper , kOolite_sdrToneMapper , kOolite_timeAccelerationFactor }

Functions
static JSBool	OoliteGetProperty (JSContext *context, JSObject *this, jsid propID, jsval *value)
static JSBool	OoliteSetProperty (JSContext *context, JSObject *this, jsid propID, JSBool strict, jsval *value)
static NSString *	VersionString (void)
static NSArray *	VersionComponents (void)
static JSBool	OoliteCompareVersion (JSContext *context, uintN argc, jsval *vp)
void	InitOOJSOolite (JSContext *context, JSObject *global)

Variables
static JSClass	sOoliteClass
static JSPropertySpec	sOoliteProperties []
static JSFunctionSpec	sOoliteMethods []

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
kOolite_version
kOolite_versionString
kOolite_jsVersion
kOolite_jsVersionString
kOolite_gameSettings
kOolite_resourcePaths
kOolite_colorSaturation
kOolite_postFX
kOolite_hdrToneMapper
kOolite_sdrToneMapper
kOolite_timeAccelerationFactor

Definition at line 63 of file OOJSOolite.m.

{
    // Property IDs
    kOolite_version,            // version number components, array, read-only
    kOolite_versionString,      // version number as string, string, read-only
    kOolite_jsVersion,          // JavaScript version, integer, read-only
    kOolite_jsVersionString,    // JavaScript version as string, string, read-only
    kOolite_gameSettings,       // Various game settings, object, read-only
    kOolite_resourcePaths,      // Paths containing resources, built-in plus oxp/oxz, read-only
    kOolite_colorSaturation,    // Color saturation, integer, read/write
    kOolite_postFX,             // current post processing effect, integer, read/write
    kOolite_hdrToneMapper,      // currently active HDR tone mapper, string, read/write
    kOolite_sdrToneMapper,      // currently active SDR tone mapper, string, read/write
#ifndef NDEBUG
    kOolite_timeAccelerationFactor, // time acceleration, float, read/write
#endif
};

Function Documentation

InitOOJSOolite()

void InitOOJSOolite	(	JSContext *	context,
		JSObject *	global )

Definition at line 110 of file OOJSOolite.m.

{
    JSObject *oolitePrototype = JS_InitClass(context, global, NULL, &sOoliteClass, OOJSUnconstructableConstruct, 0, sOoliteProperties, sOoliteMethods, NULL, NULL);
    JS_DefineObject(context, global, "oolite", &sOoliteClass, oolitePrototype, OOJS_PROP_READONLY);
}

References OOJS_PROP_READONLY, OOJSUnconstructableConstruct(), sOoliteClass, sOoliteMethods, and sOoliteProperties.

Referenced by OOJavaScriptEngine(Private)::createMainThreadContext.

Here is the call graph for this function:

Here is the caller graph for this function:

OoliteCompareVersion()

JSBool OoliteCompareVersion ( JSContext * context, uintN argc, jsval * vp )

static

Definition at line 297 of file OOJSOolite.m.

{
    OOJS_NATIVE_ENTER(context)
    
    id                      components = nil;
    NSEnumerator            *componentEnum = nil;
    id                      component = nil;
    
    if (argc == 0)  OOJS_RETURN_VOID;   // Backwards-compatibility: be overly lenient.
    
    components = OOJSNativeObjectFromJSValue(context, OOJS_ARGV[0]);
    if ([components isKindOfClass:[NSArray class]])
    {
        // Require each element to be a number
        for (componentEnum = [components objectEnumerator]; (component = [componentEnum nextObject]); )
        {
            if (![component isKindOfClass:[NSNumber class]])
            {
                components = nil;
                break;
            }
        }
    }
    else if ([components isKindOfClass:[NSString class]])
    {
        components = ComponentsFromVersionString(components);
    }
    else  components = nil;
    
    if (components != nil)
    {
        OOJS_RETURN_INT((int32_t)CompareVersions(components, VersionComponents()));
    }
    else
    {
        OOJS_RETURN_VOID;
    }
    
    OOJS_NATIVE_EXIT
}

References CompareVersions(), ComponentsFromVersionString(), nil, OOJS_ARGV, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJS_RETURN_INT, OOJS_RETURN_VOID, OOJSNativeObjectFromJSValue(), and VersionComponents().

Here is the call graph for this function:

OoliteGetProperty()

JSBool OoliteGetProperty ( JSContext * context, JSObject * this, jsid propID, jsval * value )

static

Definition at line 117 of file OOJSOolite.m.

{
    if (!JSID_IS_INT(propID))  return YES;
    
    OOJS_NATIVE_ENTER(context)
    
    id                      result = nil;
    MyOpenGLView            *gameView = [UNIVERSE gameView];
    
    switch (JSID_TO_INT(propID))
    {
        case kOolite_version:
            result = VersionComponents();
            break;
        
        case kOolite_versionString:
            result = VersionString();
            break;
        
        case kOolite_jsVersion:
            *value = INT_TO_JSVAL(JS_GetVersion(context));
            return YES;
        
        case kOolite_jsVersionString:
            *value = STRING_TO_JSVAL(JS_NewStringCopyZ(context, JS_VersionToString(JS_GetVersion(context))));
            return YES;
        
        case kOolite_gameSettings:
            result = [UNIVERSE gameSettings];
            break;
            
        case kOolite_resourcePaths:
            // user name in displayed paths masked for privacy - remember that the console can be run remotely too
            result = [ResourceManager maskUserNameInPathArray:[ResourceManager paths]];
            break;
            
        case kOolite_colorSaturation:
            return JS_NewNumberValue(context, [gameView colorSaturation], value);
            
        case kOolite_postFX:
            *value = INT_TO_JSVAL([UNIVERSE currentPostFX]);
            return YES;
            
        case kOolite_hdrToneMapper:
        {
            NSString *toneMapperStr = @"OOHDR_TONEMAPPER_UNDEFINED";
#if OOLITE_WINDOWS
            if ([gameView hdrOutput])
            {
                toneMapperStr = OOStringFromHDRToneMapper([gameView hdrToneMapper]);
            }
#endif
            result = toneMapperStr;
            break;
        }
        
        case kOolite_sdrToneMapper:
        {
            NSString *toneMapperStr = @"OOSDR_TONEMAPPER_UNDEFINED";
            if (![gameView hdrOutput])
            {
                toneMapperStr = OOStringFromSDRToneMapper([gameView sdrToneMapper]);
            }
            result = toneMapperStr;
            break;
        }
            
#ifndef NDEBUG
        case kOolite_timeAccelerationFactor:
            return JS_NewNumberValue(context, [UNIVERSE timeAccelerationFactor], value);
#endif
        
        default:
            OOJSReportBadPropertySelector(context, this, propID, sOoliteProperties);
            return NO;
    }
    
    *value = OOJSValueFromNativeObject(context, result);
    return YES;
    
    OOJS_NATIVE_EXIT
}

References kOolite_colorSaturation, kOolite_gameSettings, kOolite_hdrToneMapper, kOolite_jsVersion, kOolite_jsVersionString, kOolite_postFX, kOolite_resourcePaths, kOolite_sdrToneMapper, kOolite_timeAccelerationFactor, kOolite_version, kOolite_versionString, ResourceManager::maskUserNameInPathArray:, nil, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJSReportBadPropertySelector(), OOJSValueFromNativeObject(), OOStringFromHDRToneMapper(), OOStringFromSDRToneMapper(), ResourceManager::paths, sOoliteProperties, UNIVERSE, VersionComponents(), and VersionString().

Here is the call graph for this function:

OoliteSetProperty()

JSBool OoliteSetProperty ( JSContext * context, JSObject * this, jsid propID, JSBool strict, jsval * value )

static

Definition at line 201 of file OOJSOolite.m.

{
    if (!JSID_IS_INT(propID))  return YES;
    
    OOJS_NATIVE_ENTER(context)
    
    jsdouble                fValue;
    int32                   iValue;
    NSString                *sValue = nil;
    MyOpenGLView            *gameView = [UNIVERSE gameView];
    
    switch (JSID_TO_INT(propID))
    {
        case kOolite_colorSaturation:
            if (JS_ValueToNumber(context, *value, &fValue))
            {
                float currentColorSaturation = [gameView colorSaturation];
                [gameView adjustColorSaturation:fValue - currentColorSaturation];
                return YES;
            }
            break;
            
        case kOolite_postFX:
            if (JS_ValueToInt32(context, *value, &iValue))
            {
                iValue = MAX(iValue, 0);
                [UNIVERSE setCurrentPostFX:iValue];
                return YES;
            }
            break;
            
        case kOolite_hdrToneMapper:
            if (!JSVAL_IS_STRING(*value))  break; // non-string is not allowed
            sValue = OOStringFromJSValue(context,*value);
            if (sValue != nil)
            {
#if OOLITE_WINDOWS
                if ([gameView hdrOutput])  [gameView setHDRToneMapper:OOHDRToneMapperFromString(sValue)];
                else  OOJSReportWarning(context, @"hdrToneMapper cannot be set if not running in HDR mode");
#endif
                return YES;
            }
            break;
            
        case kOolite_sdrToneMapper:
            if (!JSVAL_IS_STRING(*value))  break; // non-string is not allowed
            sValue = OOStringFromJSValue(context,*value);
            if (sValue != nil)
            {
                if (![gameView hdrOutput])  [gameView setSDRToneMapper:OOSDRToneMapperFromString(sValue)];
                else  OOJSReportWarning(context, @"sdrToneMapper cannot be set if not running in SDR mode");
                return YES;
            }
            break;
            
#ifndef NDEBUG
        case kOolite_timeAccelerationFactor:
            if (JS_ValueToNumber(context, *value, &fValue))
            {
                [UNIVERSE setTimeAccelerationFactor:fValue];
                return YES;
            }
            break;
#endif
            
        default:
            OOJSReportBadPropertySelector(context, this, propID, sOoliteProperties);
            return NO;
    }
    
    OOJSReportBadPropertyValue(context, this, propID, sOoliteProperties, *value);
    return NO;
    
    OOJS_NATIVE_EXIT
}

References MyOpenGLView::adjustColorSaturation:, MyOpenGLView::colorSaturation, kOolite_colorSaturation, kOolite_hdrToneMapper, kOolite_postFX, kOolite_sdrToneMapper, kOolite_timeAccelerationFactor, MAX, nil, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJSReportBadPropertySelector(), OOJSReportBadPropertyValue(), OOJSReportWarning(), OOStringFromJSValue(), MyOpenGLView::setSDRToneMapper:, and sOoliteProperties.

Here is the call graph for this function:

VersionComponents()

NSArray * VersionComponents ( void )

static

Definition at line 284 of file OOJSOolite.m.

{
    return ComponentsFromVersionString(VersionString());
}

References ComponentsFromVersionString(), and VersionString().

Referenced by OoliteCompareVersion(), and OoliteGetProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

VersionString()

NSString * VersionString ( void )

static

Definition at line 278 of file OOJSOolite.m.

{
    return [[[NSBundle mainBundle] infoDictionary] objectForKey:@"CFBundleVersion"];
}

Referenced by OoliteGetProperty(), and VersionComponents().

Here is the caller graph for this function:

Variable Documentation

sOoliteClass

JSClass sOoliteClass

static

Initial value:

=
{
    "Oolite",
    0,
    
    JS_PropertyStub,
    JS_PropertyStub,
    OoliteGetProperty,
    OoliteSetProperty,
    
    JS_EnumerateStub,
    JS_ResolveStub,
    JS_ConvertStub,
    JS_FinalizeStub
}

Definition at line 46 of file OOJSOolite.m.

{
    "Oolite",
    0,
    
    JS_PropertyStub,
    JS_PropertyStub,
    OoliteGetProperty,
    OoliteSetProperty,
    //JS_StrictPropertyStub,
    JS_EnumerateStub,
    JS_ResolveStub,
    JS_ConvertStub,
    JS_FinalizeStub
};

Referenced by InitOOJSOolite().

sOoliteMethods

JSFunctionSpec sOoliteMethods[]

static

Initial value:

=
{
    
    { "compareVersion",         OoliteCompareVersion,       1 },
    { 0 }
}

Definition at line 102 of file OOJSOolite.m.

{
    // JS name                  Function                    min args
    { "compareVersion",         OoliteCompareVersion,       1 },
    { 0 }
};

Referenced by InitOOJSOolite().

sOoliteProperties

JSPropertySpec sOoliteProperties[]

static

Initial value:

=
{
    
    { "gameSettings",           kOolite_gameSettings,       OOJS_PROP_READONLY_CB },
    { "jsVersion",              kOolite_jsVersion,          OOJS_PROP_READONLY_CB },
    { "jsVersionString",        kOolite_jsVersionString,    OOJS_PROP_READONLY_CB },
    { "version",                kOolite_version,            OOJS_PROP_READONLY_CB },
    { "versionString",          kOolite_versionString,      OOJS_PROP_READONLY_CB },
    { "resourcePaths",          kOolite_resourcePaths,      OOJS_PROP_READONLY_CB },
    { "colorSaturation",        kOolite_colorSaturation,    OOJS_PROP_READWRITE_CB },
    { "postFX",                 kOolite_postFX,             OOJS_PROP_READWRITE_CB },
    { "hdrToneMapper",          kOolite_hdrToneMapper,      OOJS_PROP_READWRITE_CB },
    { "sdrToneMapper",          kOolite_sdrToneMapper,      OOJS_PROP_READWRITE_CB },
 
    { "timeAccelerationFactor", kOolite_timeAccelerationFactor, OOJS_PROP_READWRITE_CB },
 
    { 0 }
}

Definition at line 82 of file OOJSOolite.m.

{
    // JS name                  ID                          flags
    { "gameSettings",           kOolite_gameSettings,       OOJS_PROP_READONLY_CB },
    { "jsVersion",              kOolite_jsVersion,          OOJS_PROP_READONLY_CB },
    { "jsVersionString",        kOolite_jsVersionString,    OOJS_PROP_READONLY_CB },
    { "version",                kOolite_version,            OOJS_PROP_READONLY_CB },
    { "versionString",          kOolite_versionString,      OOJS_PROP_READONLY_CB },
    { "resourcePaths",          kOolite_resourcePaths,      OOJS_PROP_READONLY_CB },
    { "colorSaturation",        kOolite_colorSaturation,    OOJS_PROP_READWRITE_CB },
    { "postFX",                 kOolite_postFX,             OOJS_PROP_READWRITE_CB },
    { "hdrToneMapper",          kOolite_hdrToneMapper,      OOJS_PROP_READWRITE_CB },
    { "sdrToneMapper",          kOolite_sdrToneMapper,      OOJS_PROP_READWRITE_CB },
#ifndef NDEBUG
    { "timeAccelerationFactor", kOolite_timeAccelerationFactor, OOJS_PROP_READWRITE_CB },
#endif
    { 0 }
};

Referenced by InitOOJSOolite(), OoliteGetProperty(), and OoliteSetProperty().