OOJSTimer Class Reference

#include <OOJSTimer.h>

Inheritance diagram for OOJSTimer:

Collaboration diagram for OOJSTimer:

Instance Methods
(id)	- initWithDelay:interval:context:function:this: [implementation]
(void)	- deleteJSPointers [implementation]
(void)	- dealloc [implementation]
(NSString *)	- descriptionComponents [implementation]
(NSString *)	- oo_jsClassName [implementation]
(void)	- timerFired [implementation]
(jsval)	- oo_jsValueInContext: [implementation]
Instance Methods inherited from OOScriptTimer
(id)	- initWithNextTime:interval:
(id)	- initOneShotTimerWithDelay:
(OOTimeAbsolute)	- nextTime
(BOOL)	- setNextTime:
(OOTimeDelta)	- interval
(void)	- setInterval:
(BOOL)	- scheduleTimer
(void)	- unscheduleTimer
(BOOL)	- isScheduled
(BOOL)	- isValidForScheduling
(NSComparisonResult)	- compareByNextFireTime:

Private Attributes
jsval	_function
JSObject *	_jsThis
OOJSScript *	_owningScript
JSObject *	_jsSelf

Additional Inherited Members
Class Methods inherited from OOScriptTimer
(void)	+ updateTimers
(void)	+ noteGameReset

Detailed Description

Definition at line 33 of file OOJSTimer.h.

Method Documentation

dealloc

- (void) dealloc

implementation

Reimplemented from OOScriptTimer.

Definition at line 113 of file OOJSTimer.m.

{
    [_owningScript release];
    
    [self deleteJSPointers];
    
    [super dealloc];
}

References dealloc, OOScriptTimer::dealloc, and deleteJSPointers.

Referenced by dealloc.

Here is the call graph for this function:

Here is the caller graph for this function:

deleteJSPointers

- (void) deleteJSPointers

implementation

Definition at line 92 of file OOJSTimer.m.

{
    [self unscheduleTimer];
    
    if (_jsThis != NULL)
    {
        _jsThis = NULL;
        _function = JSVAL_VOID;
        
        JSContext *context = OOJSAcquireContext();
        JS_RemoveObjectRoot(context, &_jsThis);
        JS_RemoveValueRoot(context, &_function);
        OOJSRelinquishContext(context);
        
        [[NSNotificationCenter defaultCenter] removeObserver:self
                                                        name:kOOJavaScriptEngineWillResetNotification
                                                      object:[OOJavaScriptEngine sharedEngine]];
    }
}

References _function, _jsThis, deleteJSPointers, OOJSAcquireContext(), OOJSRelinquishContext(), OOJavaScriptEngine::sharedEngine, and OOScriptTimer::unscheduleTimer.

Referenced by dealloc, and deleteJSPointers.

Here is the call graph for this function:

Here is the caller graph for this function:

descriptionComponents

- (NSString *) descriptionComponents

implementation

Reimplemented from OOScriptTimer.

Definition at line 123 of file OOJSTimer.m.

{
    NSString                *funcName = nil;
    JSContext               *context = NULL;
    
    if (JSVAL_IS_VOID(_function) || JSVAL_IS_NULL(_function))
    {
        return @"invalid";
    }
    
    context = OOJSAcquireContext();
    funcName = OOStringFromJSString(context, JS_GetFunctionId(JS_ValueToFunction(context, _function)));
    OOJSRelinquishContext(context);
    
    if (funcName == nil)
    {
        funcName = @"anonymous";
    }
    
    return [NSString stringWithFormat:@"%@, function: %@", [super descriptionComponents], funcName];
}

References _function, descriptionComponents, OOScriptTimer::descriptionComponents, nil, OOJSAcquireContext(), OOJSRelinquishContext(), and OOStringFromJSString().

Referenced by descriptionComponents.

Here is the call graph for this function:

Here is the caller graph for this function:

initWithDelay:interval:context:function:this:

- (id) initWithDelay: (OOTimeAbsolute) delay interval: (OOTimeDelta) interval context: (JSContext *) context function: (jsval) function this: (JSObject *) jsThis

implementation

Provided by category OOJSTimer(Private).

Definition at line 52 of file OOJSTimer.m.

                    :(OOTimeAbsolute)delay
            interval:(OOTimeDelta)interval
             context:(JSContext *)context
            function:(jsval)function
                this:(JSObject *)jsThis
{
    self = [super initWithNextTime:[UNIVERSE getTime] + delay interval:interval];
    if (self != nil)
    {
        NSAssert(OOJSValueIsFunction(context, function), @"Attempt to init OOJSTimer with a function that isn't.");
        
        _jsThis = jsThis;
        OOJSAddGCObjectRoot(context, &_jsThis, "OOJSTimer this");
        
        _function = function;
        OOJSAddGCValueRoot(context, &_function, "OOJSTimer function");
        
        _jsSelf = JS_NewObject(context, &sTimerClass, sTimerPrototype, NULL);
        if (_jsSelf != NULL)
        {
            if (!JS_SetPrivate(context, _jsSelf, [self retain]))  _jsSelf = NULL;
        }
        if (_jsSelf == NULL)
        {
            [self release];
            return nil;
        }
        
        _owningScript = [[OOJSScript currentlyRunningScript] weakRetain];
        
        [[NSNotificationCenter defaultCenter] addObserver:self
                                                 selector:@selector(deleteJSPointers)
                                                     name:kOOJavaScriptEngineWillResetNotification
                                                   object:[OOJavaScriptEngine sharedEngine]];
    }
    
    return self;
}

References OOJSScript::currentlyRunningScript, OOScriptTimer::initWithNextTime:interval:, nil, OOJSAddGCObjectRoot, OOJSAddGCValueRoot, OOJSValueIsFunction(), OOJavaScriptEngine::sharedEngine, sTimerClass, sTimerPrototype, and OOJSScript::weakRetain.

Here is the call graph for this function:

oo_jsClassName

- (NSString *) oo_jsClassName

implementation

Definition at line 146 of file OOJSTimer.m.

{
    return @"Timer";
}

References oo_jsClassName.

Referenced by oo_jsClassName.

Here is the call graph for this function:

Here is the caller graph for this function:

oo_jsValueInContext:

- (jsval) oo_jsValueInContext: (JSContext *) context

implementation

Definition at line 187 of file OOJSTimer.m.

                             :(JSContext *)context
{
    return OBJECT_TO_JSVAL(_jsSelf);
}

References _jsSelf.

timerFired

- (void) timerFired

implementation

Reimplemented from OOScriptTimer.

Definition at line 152 of file OOJSTimer.m.

{
    jsval                   rval = JSVAL_VOID;
    NSString                *description = nil;
    
    OOJavaScriptEngine *engine = [OOJavaScriptEngine sharedEngine];
    JSContext *context = OOJSAcquireContext();
    
    // stop and remove the timer if _jsThis (the first parameter in the constructor) dies.
    id object = OOJSNativeObjectFromJSObject(context, _jsThis);
    if (object != nil)
    {
        description = [object oo_jsDescription];
        if (description == nil)  description = [object description];
    }
    
    if (description == nil)
    {
        [self unscheduleTimer];
        OOJSRelinquishContext(context);
        return;
    }
    
    [OOJSScript pushScript:_owningScript];
    [engine callJSFunction:_function
                 forObject:_jsThis
                      argc:0
                      argv:NULL
                    result:&rval];
    [OOJSScript popScript:_owningScript];
    
    OOJSRelinquishContext(context);
}

References _jsThis, OOJavaScriptEngine::callJSFunction:forObject:argc:argv:result:, nil, OOJSAcquireContext(), OOJSNativeObjectFromJSObject(), OOJSRelinquishContext(), OOJSScript::popScript:, OOJSScript::pushScript:, OOJavaScriptEngine::sharedEngine, timerFired, and OOScriptTimer::unscheduleTimer.

Referenced by timerFired.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

_function

- (jsval) _function

private

Definition at line 36 of file OOJSTimer.h.

Referenced by deleteJSPointers, and descriptionComponents.

_jsSelf

- (JSObject*) _jsSelf

private

Definition at line 41 of file OOJSTimer.h.

Referenced by oo_jsValueInContext:.

_jsThis

- (JSObject*) _jsThis

private

Definition at line 37 of file OOJSTimer.h.

Referenced by deleteJSPointers, and timerFired.

_owningScript

- (OOJSScript*) _owningScript

private

Definition at line 39 of file OOJSTimer.h.

---

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

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