OOJSClock.m File Reference

import "OOJSClock.h"
import "OOJavaScriptEngine.h"
import "Universe.h"
import "OOJSPlayer.h"
import "PlayerEntity.h"
import "PlayerEntityScriptMethods.h"
import "OOStringParsing.h"
import "OODebugStandards.h"

Include dependency graph for OOJSClock.m:

Go to the source code of this file.

Enumerations
enum	{   kClock_absoluteSeconds , kClock_seconds , kClock_minutes , kClock_hours ,   kClock_days , kClock_secondsComponent , kClock_minutesComponent , kClock_hoursComponent ,   kClock_daysComponent , kClock_clockString , kClock_isAdjusting , kClock_adjustedSeconds ,   kClock_legacy_scriptTimer }

Functions
static JSBool	ClockGetProperty (JSContext *context, JSObject *this, jsid propID, jsval *value)
static JSBool	JSClockToString (JSContext *context, uintN argc, jsval *vp)
static JSBool	ClockClockStringForTime (JSContext *context, uintN argc, jsval *vp)
static JSBool	ClockAddSeconds (JSContext *context, uintN argc, jsval *vp)
void	InitOOJSClock (JSContext *context, JSObject *global)

Variables
static JSClass	sClockClass
static JSPropertySpec	sClockProperties []
static JSFunctionSpec	sClockMethods []

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
kClock_absoluteSeconds
kClock_seconds
kClock_minutes
kClock_hours
kClock_days
kClock_secondsComponent
kClock_minutesComponent
kClock_hoursComponent
kClock_daysComponent
kClock_clockString
kClock_isAdjusting
kClock_adjustedSeconds
kClock_legacy_scriptTimer

Definition at line 60 of file OOJSClock.m.

{
    // Property IDs
    kClock_absoluteSeconds,     // game real time clock, double, read-only
    kClock_seconds,             // game clock time, double, read-only
    kClock_minutes,             // game clock time minutes (rounded down), integer double, read-only
    kClock_hours,               // game clock time hours (rounded down), integer double, read-only
    kClock_days,                // game clock time days (rounded down), int, read-only
    kClock_secondsComponent,    // second component of game clock time, double, read-only
    kClock_minutesComponent,    // minute component of game clock time (rounded down), int, read-only
    kClock_hoursComponent,      // hour component of game clock time (rounded down), int, read-only
    kClock_daysComponent,       // day component of game clock time (rounded down), int, read-only
    kClock_clockString,         // game clock time as display string, string, read-only
    kClock_isAdjusting,         // clock is adjusting, boolean, read-only
    kClock_adjustedSeconds, // game clock time, including adjustments, double, read-only
    kClock_legacy_scriptTimer   // legacy scriptTimer_number, double, read-only
};

Function Documentation

ClockAddSeconds()

static JSBool ClockAddSeconds ( JSContext * context, uintN argc, jsval * vp )

static

Definition at line 218 of file OOJSClock.m.

{
    OOJS_NATIVE_ENTER(context)
    
    double                      time;
    const double                kMaxTime = 30.0 * 24.0 * 3600.0;    // 30 days
    
    if (EXPECT_NOT(argc < 1 || !JS_ValueToNumber(context, OOJS_ARGV[0], &time)))
    {
        jsval arg = JSVAL_VOID;
        if (argc > 0)  arg = OOJS_ARGV[0];
        OOJSReportBadArguments(context, @"Clock", @"addSeconds", 1, &arg, nil, @"number");
        return NO;
    }
    
    if (time > kMaxTime || time < 1.0 || !isfinite(time))
    {
        OOJS_RETURN_BOOL(NO);
    }
    
    [OOPlayerForScripting() addToAdjustTime:time];
    
    OOJS_RETURN_BOOL(YES);
    
    OOJS_NATIVE_EXIT
}

References EXPECT_NOT, nil, OOJS_ARGV, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJS_RETURN_BOOL, and OOJSReportBadArguments().

Here is the call graph for this function:

ClockClockStringForTime()

static JSBool ClockClockStringForTime ( JSContext * context, uintN argc, jsval * vp )

static

Definition at line 197 of file OOJSClock.m.

{
    OOJS_NATIVE_ENTER(context)
    
    double                      time;
    
    if (EXPECT_NOT(argc < 1 || !JS_ValueToNumber(context, OOJS_ARGV[0], &time)))
    {
        jsval arg = JSVAL_VOID;
        if (argc > 0)  arg = OOJS_ARGV[0];
        OOJSReportBadArguments(context, @"Clock", @"clockStringForTime", 1, &arg, nil, @"number");
        return NO;
    }
    
    OOJS_RETURN_OBJECT(ClockToString(time, NO));
    
    OOJS_NATIVE_EXIT
}

References ClockToString(), EXPECT_NOT, nil, OOJS_ARGV, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJS_RETURN_OBJECT, and OOJSReportBadArguments().

Here is the call graph for this function:

ClockGetProperty()

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

static

Definition at line 116 of file OOJSClock.m.

{
    if (!JSID_IS_INT(propID))  return YES;
    
    OOJS_NATIVE_ENTER(context)
    
    PlayerEntity                *player = OOPlayerForScripting();
    double                      clockTime;
    
    clockTime = [player clockTime];
    
    switch (JSID_TO_INT(propID))
    {
        case kClock_absoluteSeconds:
            return JS_NewNumberValue(context, [UNIVERSE getTime], value);
            
        case kClock_seconds:
            return JS_NewNumberValue(context, clockTime, value);
            
        case kClock_minutes:
            return JS_NewNumberValue(context, floor(clockTime / 60.0), value);
            
        case kClock_hours:
            return JS_NewNumberValue(context, floor(clockTime /3600.0), value);
            return YES;
            
        case kClock_secondsComponent:
            *value = INT_TO_JSVAL(fmod(clockTime, 60.0));
            return YES;
            
        case kClock_minutesComponent:
            *value = INT_TO_JSVAL(fmod(floor(clockTime / 60.0), 60.0));
            return YES;
            
        case kClock_hoursComponent:
            *value = INT_TO_JSVAL(fmod(floor(clockTime / 3600.0), 24.0));
            return YES;
            
        case kClock_days:
        case kClock_daysComponent:
            *value = INT_TO_JSVAL(floor(clockTime / 86400.0));
            return YES;
            
        case kClock_clockString:
            *value = OOJSValueFromNativeObject(context, [player dial_clock]);
            return YES;
            
        case kClock_isAdjusting:
            *value = OOJSValueFromBOOL([player clockAdjusting]);
            return YES;
            
        case kClock_adjustedSeconds:
            return JS_NewNumberValue(context, [player clockTimeAdjusted], value);
 
        case kClock_legacy_scriptTimer:
            OOStandardsDeprecated(@"The legacy_scriptTimer property is deprecated");
            return JS_NewNumberValue(context, [player scriptTimer], value);
            
        default:
            OOJSReportBadPropertySelector(context, this, propID, sClockProperties);
            return NO;
    }
    
    OOJS_NATIVE_EXIT
}

References PlayerEntity::clockTime, kClock_absoluteSeconds, kClock_adjustedSeconds, kClock_clockString, kClock_days, kClock_daysComponent, kClock_hours, kClock_hoursComponent, kClock_isAdjusting, kClock_legacy_scriptTimer, kClock_minutes, kClock_minutesComponent, kClock_seconds, kClock_secondsComponent, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJSReportBadPropertySelector(), OOJSValueFromBOOL(), OOJSValueFromNativeObject(), OOPlayerForScripting(), OOStandardsDeprecated(), sClockProperties, and UNIVERSE.

Here is the call graph for this function:

InitOOJSClock()

void InitOOJSClock	(	JSContext *	context,
		JSObject *	global )

Definition at line 109 of file OOJSClock.m.

{
    JSObject *clockPrototype = JS_InitClass(context, global, NULL, &sClockClass, OOJSUnconstructableConstruct, 0, sClockProperties, sClockMethods, NULL, NULL);
    JS_DefineObject(context, global, "clock", &sClockClass, clockPrototype, OOJS_PROP_READONLY);
}

References OOJS_PROP_READONLY, OOJSUnconstructableConstruct(), sClockClass, sClockMethods, and sClockProperties.

Here is the call graph for this function:

JSClockToString()

static JSBool JSClockToString ( JSContext * context, uintN argc, jsval * vp )

static

Definition at line 186 of file OOJSClock.m.

{
    OOJS_NATIVE_ENTER(context)
    
    OOJS_RETURN_OBJECT([OOPlayerForScripting() dial_clock]);
    
    OOJS_NATIVE_EXIT
}

References OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJS_RETURN_OBJECT, and OOPlayerForScripting().

Here is the call graph for this function:

Variable Documentation

sClockClass

JSClass sClockClass

static

Initial value:

=
{
    "Clock",
    JSCLASS_HAS_PRIVATE,
    
    JS_PropertyStub,        
    JS_PropertyStub,        
    ClockGetProperty,       
    JS_StrictPropertyStub,  
    JS_EnumerateStub,       
    JS_ResolveStub,         
    JS_ConvertStub,         
    JS_FinalizeStub,        
    JSCLASS_NO_OPTIONAL_MEMBERS
}

Definition at line 43 of file OOJSClock.m.

{
    "Clock",
    JSCLASS_HAS_PRIVATE,
    
    JS_PropertyStub,        // addProperty
    JS_PropertyStub,        // delProperty
    ClockGetProperty,       // getProperty
    JS_StrictPropertyStub,  // setProperty
    JS_EnumerateStub,       // enumerate
    JS_ResolveStub,         // resolve
    JS_ConvertStub,         // convert
    JS_FinalizeStub,        // finalize
    JSCLASS_NO_OPTIONAL_MEMBERS
};

Referenced by InitOOJSClock().

sClockMethods

JSFunctionSpec sClockMethods[]

static

Initial value:

=
{
    
    { "toString",               JSClockToString,            0 },
    { "clockStringForTime",     ClockClockStringForTime,    1 },
    { "addSeconds",             ClockAddSeconds,            1 },
    { 0 }
}

Definition at line 99 of file OOJSClock.m.

{
    // JS name                      Function                        min args
    { "toString",               JSClockToString,            0 },
    { "clockStringForTime",     ClockClockStringForTime,    1 },
    { "addSeconds",             ClockAddSeconds,            1 },
    { 0 }
};

Referenced by InitOOJSClock().

sClockProperties

JSPropertySpec sClockProperties[]

static

Initial value:

=
{
    
    { "absoluteSeconds",        kClock_absoluteSeconds,     OOJS_PROP_READONLY_CB },
    { "seconds",                kClock_seconds,             OOJS_PROP_READONLY_CB },
    { "minutes",                kClock_minutes,             OOJS_PROP_READONLY_CB },
    { "hours",                  kClock_hours,               OOJS_PROP_READONLY_CB },
    { "days",                   kClock_days,                OOJS_PROP_READONLY_CB },
    { "secondsComponent",       kClock_secondsComponent,    OOJS_PROP_READONLY_CB },
    { "minutesComponent",       kClock_minutesComponent,    OOJS_PROP_READONLY_CB },
    { "hoursComponent",         kClock_hoursComponent,      OOJS_PROP_READONLY_CB },
    { "daysComponent",          kClock_daysComponent,       OOJS_PROP_READONLY_CB },
    { "clockString",            kClock_clockString,         OOJS_PROP_READONLY_CB },
    { "isAdjusting",            kClock_isAdjusting,         OOJS_PROP_READONLY_CB },
    { "adjustedSeconds",            kClock_adjustedSeconds,         OOJS_PROP_READONLY_CB },
    { "legacy_scriptTimer",     kClock_legacy_scriptTimer,  OOJS_PROP_READONLY_CB },
    { 0 }
}

Definition at line 79 of file OOJSClock.m.

{
    // JS name                  ID                          flags
    { "absoluteSeconds",        kClock_absoluteSeconds,     OOJS_PROP_READONLY_CB },
    { "seconds",                kClock_seconds,             OOJS_PROP_READONLY_CB },
    { "minutes",                kClock_minutes,             OOJS_PROP_READONLY_CB },
    { "hours",                  kClock_hours,               OOJS_PROP_READONLY_CB },
    { "days",                   kClock_days,                OOJS_PROP_READONLY_CB },
    { "secondsComponent",       kClock_secondsComponent,    OOJS_PROP_READONLY_CB },
    { "minutesComponent",       kClock_minutesComponent,    OOJS_PROP_READONLY_CB },
    { "hoursComponent",         kClock_hoursComponent,      OOJS_PROP_READONLY_CB },
    { "daysComponent",          kClock_daysComponent,       OOJS_PROP_READONLY_CB },
    { "clockString",            kClock_clockString,         OOJS_PROP_READONLY_CB },
    { "isAdjusting",            kClock_isAdjusting,         OOJS_PROP_READONLY_CB },
    { "adjustedSeconds",            kClock_adjustedSeconds,         OOJS_PROP_READONLY_CB },
    { "legacy_scriptTimer",     kClock_legacy_scriptTimer,  OOJS_PROP_READONLY_CB },
    { 0 }
};

Referenced by ClockGetProperty(), and InitOOJSClock().