OOJSGuiScreenKeyDefinition Class Reference

#include <OOJSGuiScreenKeyDefinition.h>

Inheritance diagram for OOJSGuiScreenKeyDefinition:

Collaboration diagram for OOJSGuiScreenKeyDefinition:

Instance Methods
(NSString *)	- name
(void)	- setName:
(NSDictionary *)	- registerKeys
(void)	- setRegisterKeys:
(jsval)	- callback
(void)	- setCallback:
(JSObject *)	- callbackThis
(void)	- setCallbackThis:
(void)	- runCallback:
(NSComparisonResult)	- interfaceCompare:
(id)	- init [implementation]
(void)	- deleteJSPointers [implementation]
(void)	- dealloc [implementation]
Instance Methods inherited from OOWeakRefObject
(id)	- weakSelf
(id)	- weakRetain [implementation]
(void)	- weakRefDied: [implementation]
Instance Methods inherited from <OOWeakReferenceSupport>
(id)	- OO_RETURNS_RETAINED

Private Attributes
jsval	_callback
JSObject *	_callbackThis
OOJSScript *	_owningScript
NSString *	_name
NSDictionary *	_registerKeys

Additional Inherited Members
Protected Attributes inherited from OOWeakRefObject
OOWeakReference *	weakSelf

Detailed Description

Definition at line 29 of file OOJSGuiScreenKeyDefinition.h.

Method Documentation

callback

- (jsval) callback

Definition at line 99 of file OOJSGuiScreenKeyDefinition.m.

{
    return _callback;
}

References _callback, and callback.

Referenced by callback, and setCallback:.

Here is the call graph for this function:

Here is the caller graph for this function:

callbackThis

- (JSObject *) callbackThis

Definition at line 115 of file OOJSGuiScreenKeyDefinition.m.

{
    return _callbackThis;
}

References _callbackThis, and callbackThis.

Referenced by callbackThis, and setCallbackThis:.

Here is the call graph for this function:

Here is the caller graph for this function:

dealloc

- (void) dealloc

implementation

Reimplemented from OOWeakRefObject.

Definition at line 64 of file OOJSGuiScreenKeyDefinition.m.

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

References dealloc, OOWeakRefObject::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 47 of file OOJSGuiScreenKeyDefinition.m.

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

References _callback, _callbackThis, deleteJSPointers, OOJSAcquireContext(), OOJSRelinquishContext(), and OOJavaScriptEngine::sharedEngine.

Referenced by dealloc, and deleteJSPointers.

Here is the call graph for this function:

Here is the caller graph for this function:

init

- (id) init

implementation

Definition at line 32 of file OOJSGuiScreenKeyDefinition.m.

            {
    self = [super init];
    _callback = JSVAL_VOID;
    _callbackThis = NULL;
 
    _owningScript = [[OOJSScript currentlyRunningScript] weakRetain];
 
    [[NSNotificationCenter defaultCenter] addObserver:self
                                                 selector:@selector(deleteJSPointers)
                                                 name:kOOJavaScriptEngineWillResetNotification
                                               object:[OOJavaScriptEngine sharedEngine]];
 
    return self;
}

References _callback, _callbackThis, _owningScript, OOJSScript::currentlyRunningScript, init, OOJavaScriptEngine::sharedEngine, and OOJSScript::weakRetain.

Referenced by init.

Here is the call graph for this function:

Here is the caller graph for this function:

interfaceCompare:

- (NSComparisonResult) interfaceCompare:

(OOJSGuiScreenKeyDefinition *)

other

Definition at line 155 of file OOJSGuiScreenKeyDefinition.m.

                                      :(OOJSGuiScreenKeyDefinition *)other
{
    return [_name caseInsensitiveCompare:[other name]];
}

References name.

Here is the call graph for this function:

name

- (NSString *) name

Definition at line 73 of file OOJSGuiScreenKeyDefinition.m.

{
    return _name;
}

References _name, and name.

Referenced by interfaceCompare:, and name.

Here is the call graph for this function:

Here is the caller graph for this function:

registerKeys

- (NSDictionary *) registerKeys

Definition at line 86 of file OOJSGuiScreenKeyDefinition.m.

{
    return _registerKeys;
}

References _registerKeys, and registerKeys.

Referenced by PlayerEntity(OOControlsPrivate)::pollGuiArrowKeyControls:, registerKeys, and PlayerEntity::setExtraGuiScreenKeys:definition:.

Here is the call graph for this function:

Here is the caller graph for this function:

runCallback:

- (void) runCallback:

(NSString *)

key

Definition at line 131 of file OOJSGuiScreenKeyDefinition.m.

                   :(NSString *)key
{
    OOJavaScriptEngine *engine = [OOJavaScriptEngine sharedEngine];
    JSContext           *context = OOJSAcquireContext();      
    jsval                   rval = JSVAL_VOID;
 
    jsval         cKey = OOJSValueFromNativeObject(context, key);
 
    OOJSScript *owner = [_owningScript retain]; // local copy needed
    [OOJSScript pushScript:owner];
    
    [engine callJSFunction:_callback
                 forObject:_callbackThis
                      argc:1
                      argv:&cKey
                    result:&rval];
    
    [OOJSScript popScript:owner];
    [owner release];
 
    OOJSRelinquishContext(context);
}

References OOJavaScriptEngine::callJSFunction:forObject:argc:argv:result:, OOJSAcquireContext(), OOJSRelinquishContext(), OOJSValueFromNativeObject(), OOJSScript::popScript:, OOJSScript::pushScript:, and OOJavaScriptEngine::sharedEngine.

Referenced by PlayerEntity(OOControlsPrivate)::pollGuiArrowKeyControls:.

Here is the call graph for this function:

Here is the caller graph for this function:

setCallback:

- (void) setCallback:

(jsval)

callback

Definition at line 105 of file OOJSGuiScreenKeyDefinition.m.

                   :(jsval)callback
{
    JSContext               *context = OOJSAcquireContext();
    JS_RemoveValueRoot(context, &_callback);
    _callback = callback;
    OOJSAddGCValueRoot(context, &_callback, "OOJSGuiScreenKeyDefinition callback function");
    OOJSRelinquishContext(context);
}

References _callback, callback, OOJSAcquireContext(), OOJSAddGCValueRoot, and OOJSRelinquishContext().

Referenced by GlobalSetExtraGuiScreenKeys().

Here is the call graph for this function:

Here is the caller graph for this function:

setCallbackThis:

- (void) setCallbackThis:

(JSObject *)

callbackthis

Definition at line 121 of file OOJSGuiScreenKeyDefinition.m.

                       :(JSObject *)callbackThis
{
    JSContext               *context = OOJSAcquireContext();
    JS_RemoveObjectRoot(context, &_callbackThis);
    _callbackThis = callbackThis;
    OOJSAddGCObjectRoot(context, &_callbackThis, "OOJSGuiScreenKeyDefinition callback this");
    OOJSRelinquishContext(context);
}

References _callbackThis, callbackThis, OOJSAcquireContext(), OOJSAddGCObjectRoot, and OOJSRelinquishContext().

Referenced by GlobalSetExtraGuiScreenKeys().

Here is the call graph for this function:

Here is the caller graph for this function:

setName:

- (void) setName:

(NSString *)

name

Definition at line 79 of file OOJSGuiScreenKeyDefinition.m.

               :(NSString *)name
{
    [_name autorelease];
    _name = [name retain];
}

References _name.

Referenced by GlobalSetExtraGuiScreenKeys().

Here is the caller graph for this function:

setRegisterKeys:

- (void) setRegisterKeys:

(NSDictionary *)

registerKeys

Definition at line 92 of file OOJSGuiScreenKeyDefinition.m.

                       :(NSDictionary *)registerKeys
{
    [_registerKeys release];
    _registerKeys = [registerKeys copy];
}

References _registerKeys.

Referenced by GlobalSetExtraGuiScreenKeys().

Here is the caller graph for this function:

Member Data Documentation

_callback

- (jsval) _callback

private

Definition at line 32 of file OOJSGuiScreenKeyDefinition.h.

Referenced by callback, deleteJSPointers, init, and setCallback:.

_callbackThis

- (JSObject*) _callbackThis

private

Definition at line 33 of file OOJSGuiScreenKeyDefinition.h.

Referenced by callbackThis, deleteJSPointers, init, and setCallbackThis:.

_name

- (NSString*) _name

private

Definition at line 36 of file OOJSGuiScreenKeyDefinition.h.

Referenced by name, and setName:.

_owningScript

- (OOJSScript*) _owningScript

private

Definition at line 34 of file OOJSGuiScreenKeyDefinition.h.

Referenced by init.

_registerKeys

- (NSDictionary*) _registerKeys

private

Definition at line 37 of file OOJSGuiScreenKeyDefinition.h.

Referenced by registerKeys, and setRegisterKeys:.

---

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

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