OOJSTimer.m File Reference

import "OOJSTimer.h"
import "OOJavaScriptEngine.h"
import "Universe.h"

Include dependency graph for OOJSTimer.m:

Go to the source code of this file.

Classes
category	OOJSTimer(Private)

Macros
#define	kMinInterval   0.25

Enumerations
enum	{ kTimer_nextTime , kTimer_interval , kTimer_isRunning }

Functions
static JSBool	TimerGetProperty (JSContext *context, JSObject *this, jsid propID, jsval *value)
static JSBool	TimerSetProperty (JSContext *context, JSObject *this, jsid propID, JSBool strict, jsval *value)
static void	TimerFinalize (JSContext *context, JSObject *this)
static JSBool	TimerConstruct (JSContext *context, uintN argc, jsval *vp)
static JSBool	TimerStart (JSContext *context, uintN argc, jsval *vp)
static JSBool	TimerStop (JSContext *context, uintN argc, jsval *vp)
	DEFINE_JS_OBJECT_GETTER (JSTimerGetTimer, &sTimerClass, sTimerPrototype, OOJSTimer)
void	InitOOJSTimer (JSContext *context, JSObject *global)

Variables
static JSObject *	sTimerPrototype
static JSClass	sTimerClass
static JSPropertySpec	sTimerProperties []
static JSFunctionSpec	sTimerMethods []

Macro Definition Documentation

kMinInterval

#define kMinInterval   0.25

Definition at line 32 of file OOJSTimer.m.

Referenced by TimerConstruct().

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
kTimer_nextTime
kTimer_interval
kTimer_isRunning

Definition at line 222 of file OOJSTimer.m.

{
    // Property IDs
    kTimer_nextTime,            // next fire time, double, read/write
    kTimer_interval,            // interval, double, read/write
    kTimer_isRunning            // is scheduled, boolean, read-only
};

Function Documentation

DEFINE_JS_OBJECT_GETTER()

DEFINE_JS_OBJECT_GETTER	(	JSTimerGetTimer	,
		&	sTimerClass,
		sTimerPrototype	,
		OOJSTimer	)

InitOOJSTimer()

void InitOOJSTimer	(	JSContext *	context,
		JSObject *	global )

Definition at line 254 of file OOJSTimer.m.

{
    sTimerPrototype = JS_InitClass(context, global, NULL, &sTimerClass, TimerConstruct, 0, sTimerProperties, sTimerMethods, NULL, NULL);
    OOJSRegisterObjectConverter(&sTimerClass, OOJSBasicPrivateObjectConverter);
}

References OOJSBasicPrivateObjectConverter(), OOJSRegisterObjectConverter(), sTimerClass, sTimerMethods, sTimerProperties, sTimerPrototype, and TimerConstruct().

Here is the call graph for this function:

TimerConstruct()

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

static

Definition at line 358 of file OOJSTimer.m.

{
    OOJS_NATIVE_ENTER(context)
    
    jsval                   function = JSVAL_VOID;
    double                  delay;
    double                  interval = -1.0;
    OOJSTimer               *timer = nil;
    JSObject                *callbackThis = NULL;
    
    if (EXPECT_NOT(!JS_IsConstructing(context, vp)))
    {
        OOJSReportError(context, @"Timer() cannot be called as a function, it must be used as a constructor (as in new Timer(...)).");
        return NO;
    }
    
    if (argc < 3)
    {
        OOJSReportBadArguments(context, nil, @"Timer", argc, OOJS_ARGV, @"Invalid arguments in constructor", @"(object, function, number [, number])");
        return NO;
    }
    
    if (!JSVAL_IS_NULL(OOJS_ARGV[0]) && !JSVAL_IS_VOID(OOJS_ARGV[0]))
    {
        if (!JS_ValueToObject(context, OOJS_ARGV[0], &callbackThis))
        {
            OOJSReportBadArguments(context, nil, @"Timer", 1, OOJS_ARGV, @"Invalid argument in constructor", @"object");
            return NO;
        }
    }
    
    function = OOJS_ARGV[1];
    if (JS_ValueToFunction(context, function) == NULL)
    {
        OOJSReportBadArguments(context, nil, @"Timer", 1, OOJS_ARGV + 1, @"Invalid argument in constructor", @"function");
        return NO;
    }
    
    if (!JS_ValueToNumber(context, OOJS_ARGV[2], &delay) || isnan(delay))
    {
        OOJSReportBadArguments(context, nil, @"Timer", 1, OOJS_ARGV + 2, @"Invalid argument in constructor", @"number");
        return NO;
    }
    
    // Fourth argument is optional.
    if (3 < argc && !JS_ValueToNumber(context, OOJS_ARGV[3], &interval))  interval = -1;
    
    // Ensure interval is not too small.
    if (0.0 < interval && interval < kMinInterval)  interval = kMinInterval;
    
    timer = [[OOJSTimer alloc] initWithDelay:delay
                                    interval:interval
                                     context:context
                                    function:function
                                        this:callbackThis];
    if (EXPECT_NOT(!timer))  return NO;
    
    if (delay >= 0) // Leave in stopped state if delay is negative
    {
        [timer scheduleTimer];
    }
    [timer autorelease];
    OOJS_RETURN_OBJECT(timer);
    
    OOJS_NATIVE_EXIT
}

References EXPECT_NOT, kMinInterval, nil, OOJS_ARGV, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJS_RETURN_OBJECT, OOJSReportBadArguments(), OOJSReportError(), and OOScriptTimer::scheduleTimer.

Referenced by InitOOJSTimer().

Here is the call graph for this function:

Here is the caller graph for this function:

TimerFinalize()

static void TimerFinalize ( JSContext * context, JSObject * this )

static

Definition at line 336 of file OOJSTimer.m.

{
    OOJS_PROFILE_ENTER
    
    // Can't use JSTimerGetTimer() here - potential chicken-and-egg problem manifesting as a crash.
    OOJSTimer *timer = (OOJSTimer *)JS_GetPrivate(context, this);
    
    if (timer != nil)
    {
        if ([timer isScheduled])
        {
            OOLogWARN(@"script.javaScript.unrootedTimer", @"Timer %@ is being garbage-collected while still running. You must keep a reference to all running timers, or they will stop unpredictably!", timer);
        }
        [timer release];
        JS_SetPrivate(context, this, NULL);
    }
    
    OOJS_PROFILE_EXIT_VOID
}

References nil, OOJS_PROFILE_ENTER, OOJS_PROFILE_EXIT_VOID, and OOLogWARN.

TimerGetProperty()

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

static

Definition at line 261 of file OOJSTimer.m.

{
    if (!JSID_IS_INT(propID))  return YES;
    
    OOJS_NATIVE_ENTER(context)
    
    OOJSTimer               *timer = nil;
    
    if (EXPECT_NOT(!JSTimerGetTimer(context, this, &timer))) return NO;
    
    switch (JSID_TO_INT(propID))
    {
        case kTimer_nextTime:
            return JS_NewNumberValue(context, [timer nextTime], value);
            
        case kTimer_interval:
            return JS_NewNumberValue(context, [timer interval], value);
            
        case kTimer_isRunning:
            *value = OOJSValueFromBOOL([timer isScheduled]);
            return YES;
            
        default:
            OOJSReportBadPropertySelector(context, this, propID, sTimerProperties);
            return NO;
    }
    
    OOJS_NATIVE_EXIT
}

References EXPECT_NOT, kTimer_interval, kTimer_isRunning, kTimer_nextTime, nil, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJSReportBadPropertySelector(), OOJSValueFromBOOL(), and sTimerProperties.

Here is the call graph for this function:

TimerSetProperty()

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

static

Definition at line 292 of file OOJSTimer.m.

{
    if (!JSID_IS_INT(propID))  return YES;
    
    OOJS_NATIVE_ENTER(context)
    
    OOJSTimer               *timer = nil;
    double                  fValue;
    
    if (EXPECT_NOT(!JSTimerGetTimer(context, this, &timer))) return NO;
    
    switch (JSID_TO_INT(propID))
    {
        case kTimer_nextTime:
            if (JS_ValueToNumber(context, *value, &fValue))
            {
                if (![timer setNextTime:fValue])
                {
                    OOJSReportWarning(context, @"Ignoring attempt to change next fire time for running timer %@.", timer);
                }
                return YES;
            }
            break;
            
        case kTimer_interval:
            if (JS_ValueToNumber(context, *value, &fValue))
            {
                [timer setInterval:fValue];
                return YES;
            }
            break;
            
        default:
            OOJSReportBadPropertySelector(context, this, propID, sTimerProperties);
            return NO;
    }
    
    OOJSReportBadPropertyValue(context, this, propID, sTimerProperties, *value);
    return NO;
    
    OOJS_NATIVE_EXIT
}

References EXPECT_NOT, kTimer_interval, kTimer_nextTime, nil, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJSReportBadPropertySelector(), OOJSReportBadPropertyValue(), OOJSReportWarning(), OOScriptTimer::setInterval:, and sTimerProperties.

Here is the call graph for this function:

TimerStart()

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

static

Definition at line 429 of file OOJSTimer.m.

{
    OOJS_NATIVE_ENTER(context)
    
    OOJSTimer                   *thisTimer = nil;
    
    if (EXPECT_NOT(!JSTimerGetTimer(context, OOJS_THIS, &thisTimer)))  return NO;
    
    OOJS_RETURN_BOOL([thisTimer scheduleTimer]);
    
    OOJS_NATIVE_EXIT
}

References EXPECT_NOT, nil, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJS_RETURN_BOOL, and OOJS_THIS.

TimerStop()

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

static

Definition at line 444 of file OOJSTimer.m.

{
    OOJS_NATIVE_ENTER(context)
    
    OOJSTimer                   *thisTimer = nil;
    
    if (EXPECT_NOT(!JSTimerGetTimer(context, OOJS_THIS, &thisTimer)))  return NO;
    
    [thisTimer unscheduleTimer];
    OOJS_RETURN_VOID;
    
    OOJS_NATIVE_EXIT
}

Variable Documentation

sTimerClass

static JSClass sTimerClass

static

Initial value:

=
{
    "Timer",
    JSCLASS_HAS_PRIVATE,
    
    JS_PropertyStub,        
    JS_PropertyStub,        
    TimerGetProperty,       
    TimerSetProperty,       
    JS_EnumerateStub,       
    JS_ResolveStub,         
    JS_ConvertStub,         
    TimerFinalize,          
    JSCLASS_NO_OPTIONAL_MEMBERS
}

Definition at line 36 of file OOJSTimer.m.

Referenced by InitOOJSTimer().

sTimerMethods

JSFunctionSpec sTimerMethods[]

static

Initial value:

=
{
    
    { "toString",               OOJSObjectWrapperToString,  0 },
    { "start",                  TimerStart,                 0 },
    { "stop",                   TimerStop,                  0 },
    { 0 }
}

Definition at line 241 of file OOJSTimer.m.

{
    // JS name                  Function                    min args
    { "toString",               OOJSObjectWrapperToString,  0 },
    { "start",                  TimerStart,                 0 },
    { "stop",                   TimerStop,                  0 },
    { 0 }
};

Referenced by InitOOJSTimer().

sTimerProperties

JSPropertySpec sTimerProperties[]

static

Initial value:

=
{
    
    { "interval",               kTimer_interval,            OOJS_PROP_READWRITE_CB },
    { "isRunning",              kTimer_isRunning,           OOJS_PROP_READONLY_CB },
    { "nextTime",               kTimer_nextTime,            OOJS_PROP_READWRITE_CB },
    { 0 }
}

Definition at line 231 of file OOJSTimer.m.

{
    // JS name                  ID                          flags
    { "interval",               kTimer_interval,            OOJS_PROP_READWRITE_CB },
    { "isRunning",              kTimer_isRunning,           OOJS_PROP_READONLY_CB },
    { "nextTime",               kTimer_nextTime,            OOJS_PROP_READWRITE_CB },
    { 0 }
};

Referenced by InitOOJSTimer(), TimerGetProperty(), and TimerSetProperty().

sTimerPrototype

JSObject* sTimerPrototype

static

Definition at line 35 of file OOJSTimer.m.

Referenced by InitOOJSTimer().