OOJSInterfaceDefinition Class Reference

#include <OOJSInterfaceDefinition.h>

Inheritance diagram for OOJSInterfaceDefinition:

Collaboration diagram for OOJSInterfaceDefinition:

Instance Methods
(NSString *)	- title
(void)	- setTitle:
(NSString *)	- category
(void)	- setCategory:
(NSString *)	- summary
(void)	- setSummary:
(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 *	_title
NSString *	_summary
NSString *	_category

Additional Inherited Members
Protected Attributes inherited from OOWeakRefObject
OOWeakReference *	weakSelf

Detailed Description

Definition at line 29 of file OOJSInterfaceDefinition.h.

Method Documentation

callback

- (jsval) callback

Definition at line 112 of file OOJSInterfaceDefinition.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 128 of file OOJSInterfaceDefinition.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:

category

- (NSString *) category

Definition at line 86 of file OOJSInterfaceDefinition.m.

{
    return _category;
}

References _category, and category.

Referenced by category, interfaceCompare:, and PlayerEntity::setGuiToInterfacesScreen:.

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 OOJSInterfaceDefinition.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 OOJSInterfaceDefinition.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 OOJSInterfaceDefinition.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:

(OOJSInterfaceDefinition *)

other

Definition at line 168 of file OOJSInterfaceDefinition.m.

                                      :(OOJSInterfaceDefinition *)other
{
    NSComparisonResult byCategory = [_category caseInsensitiveCompare:[other category]];
    if (byCategory == NSOrderedSame)
    {
        return [_title caseInsensitiveCompare:[other title]];
    }
    else
    {
        return byCategory;
    }
}

References category, and title.

Here is the call graph for this function:

runCallback:

- (void) runCallback:

(NSString *)

key

Definition at line 144 of file OOJSInterfaceDefinition.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::activateSelectedInterface.

Here is the call graph for this function:

Here is the caller graph for this function:

setCallback:

- (void) setCallback:

(jsval)

callback

Definition at line 118 of file OOJSInterfaceDefinition.m.

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

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

Referenced by StationSetInterface().

Here is the call graph for this function:

Here is the caller graph for this function:

setCallbackThis:

- (void) setCallbackThis:

(JSObject *)

callbackthis

Definition at line 134 of file OOJSInterfaceDefinition.m.

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

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

Referenced by StationSetInterface().

Here is the call graph for this function:

Here is the caller graph for this function:

setCategory:

- (void) setCategory:

(NSString *)

category

Definition at line 92 of file OOJSInterfaceDefinition.m.

                   :(NSString *)category
{
    [_category autorelease];
    _category = [category retain];
}

References _category.

Referenced by StationSetInterface().

Here is the caller graph for this function:

setSummary:

- (void) setSummary:

(NSString *)

summary

Definition at line 105 of file OOJSInterfaceDefinition.m.

                  :(NSString *)summary
{
    [_summary autorelease];
    _summary = [summary retain];
}

References _summary.

Referenced by StationSetInterface().

Here is the caller graph for this function:

setTitle:

- (void) setTitle:

(NSString *)

title

Definition at line 79 of file OOJSInterfaceDefinition.m.

                :(NSString *)title
{
    [_title autorelease];
    _title = [title retain];
}

References _title.

Referenced by StationSetInterface().

Here is the caller graph for this function:

summary

- (NSString *) summary

Definition at line 99 of file OOJSInterfaceDefinition.m.

{
    return _summary;
}

References _summary, and summary.

Referenced by PlayerEntity::showInformationForSelectedInterface, and summary.

Here is the call graph for this function:

Here is the caller graph for this function:

title

- (NSString *) title

Definition at line 73 of file OOJSInterfaceDefinition.m.

{
    return _title;
}

References _title, and title.

Referenced by interfaceCompare:, PlayerEntity::setGuiToInterfacesScreen:, and title.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

_callback

- (jsval) _callback

private

Definition at line 32 of file OOJSInterfaceDefinition.h.

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

_callbackThis

- (JSObject*) _callbackThis

private

Definition at line 33 of file OOJSInterfaceDefinition.h.

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

_category

- (NSString*) _category

private

Definition at line 38 of file OOJSInterfaceDefinition.h.

Referenced by category, and setCategory:.

_owningScript

- (OOJSScript*) _owningScript

private

Definition at line 34 of file OOJSInterfaceDefinition.h.

Referenced by init.

_summary

- (NSString*) _summary

private

Definition at line 37 of file OOJSInterfaceDefinition.h.

Referenced by setSummary:, and summary.

_title

- (NSString*) _title

private

Definition at line 36 of file OOJSInterfaceDefinition.h.

Referenced by setTitle:, and title.

---

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

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