OOJSShipGroup.m File Reference

import "OOShipGroup.h"
import "OOJavaScriptEngine.h"
import "Universe.h"

Include dependency graph for OOJSShipGroup.m:

Go to the source code of this file.

Enumerations
enum	{ kShipGroup_ships , kShipGroup_leader , kShipGroup_name , kShipGroup_count }

Functions
static JSBool	ShipGroupGetProperty (JSContext *context, JSObject *this, jsid propID, jsval *value)
static JSBool	ShipGroupSetProperty (JSContext *context, JSObject *this, jsid propID, JSBool strict, jsval *value)
static JSBool	ShipGroupConstruct (JSContext *context, uintN argc, jsval *vp)
static JSBool	ShipGroupAddShip (JSContext *context, uintN argc, jsval *vp)
static JSBool	ShipGroupRemoveShip (JSContext *context, uintN argc, jsval *vp)
static JSBool	ShipGroupContainsShip (JSContext *context, uintN argc, jsval *vp)
	DEFINE_JS_OBJECT_GETTER (JSShipGroupGetShipGroup, &sShipGroupClass, sShipGroupPrototype, OOShipGroup)
void	InitOOJSShipGroup (JSContext *context, JSObject *global)

Variables
static JSObject *	sShipGroupPrototype
static JSClass	sShipGroupClass
static JSPropertySpec	sShipGroupProperties []
static JSFunctionSpec	sShipGroupMethods []

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
kShipGroup_ships
kShipGroup_leader
kShipGroup_name
kShipGroup_count

Definition at line 62 of file OOJSShipGroup.m.

{
    // Property IDs
    kShipGroup_ships,           // array of ships, double, read-only
    kShipGroup_leader,          // leader, Ship, read/write
    kShipGroup_name,            // name, string, read/write
    kShipGroup_count,           // number of ships, integer, read-only
};

Function Documentation

DEFINE_JS_OBJECT_GETTER()

DEFINE_JS_OBJECT_GETTER	(	JSShipGroupGetShipGroup	,
		&	sShipGroupClass,
		sShipGroupPrototype	,
		OOShipGroup	)

InitOOJSShipGroup()

void InitOOJSShipGroup	(	JSContext *	context,
		JSObject *	global )

Definition at line 97 of file OOJSShipGroup.m.

{
    sShipGroupPrototype = JS_InitClass(context, global, NULL, &sShipGroupClass, ShipGroupConstruct, 0, sShipGroupProperties, sShipGroupMethods, NULL, NULL);
    OOJSRegisterObjectConverter(&sShipGroupClass, OOJSBasicPrivateObjectConverter);
}

References OOJSBasicPrivateObjectConverter(), OOJSRegisterObjectConverter(), ShipGroupConstruct(), sShipGroupClass, sShipGroupMethods, sShipGroupProperties, and sShipGroupPrototype.

Here is the call graph for this function:

ShipGroupAddShip()

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

static

Definition at line 258 of file OOJSShipGroup.m.

{
    OOJS_NATIVE_ENTER(context)
    
    OOShipGroup             *thisGroup = nil;
    ShipEntity              *ship = nil;
    BOOL                    OK = YES;
    
    if (EXPECT_NOT(!JSShipGroupGetShipGroup(context, OOJS_THIS, &thisGroup)))  return NO;
    
    if (argc > 0)  ship = OOJSNativeObjectOfClassFromJSValue(context, OOJS_ARGV[0], [ShipEntity class]);
    if (ship == nil)
    {
        if (argc > 0 && JSVAL_IS_NULL(OOJS_ARGV[0]))  OOJS_RETURN_VOID; // OK, do nothing for null ship.
        
        OOJSReportBadArguments(context, @"ShipGroup", @"addShip", MIN(argc, 1U), OOJS_ARGV, nil, @"ship");
        return NO;
    }
    
    if ([thisGroup containsShip:ship])
    {
        // nothing to do...
        OOJS_RETURN_VOID;
    }
    else
    {
        ShipEntity              *thisGroupLeader = [thisGroup leader];
        
        if ([thisGroupLeader escortGroup] == thisGroup) // escort group!
        {
            if ([thisGroup count] > 1) // already with some escorts
            {
                OOShipGroup         *thatGroup = [ship group];
                if ([thatGroup count] > 1 && [[thatGroup leader] escortGroup] == thatGroup) // new escort already escorting!
                {
                    OOJSReportWarningForCaller(context, @"ShipGroup", @"addShip", @"Ship %@ cannot be assigned to two escort groups, ignoring.", ship);
                    OK = NO;
                }
                else
                {
                    OK = [thisGroupLeader acceptAsEscort:ship];
                }
            }
            else // [thisGroup count] == 1, default unescorted ship?
            {
                if ([thisGroupLeader escortGroup] == [thisGroupLeader group])
                {
                    // Default unescorted, unescortable, ship. Create new group and use that instead.
                    [thisGroupLeader setGroup:[[OOShipGroup alloc] initWithName:@"ship group"]];
                    thisGroup = [thisGroupLeader group];
                }
                else
                {
                    // Unescorted ship with custom group. See if it accepts escorts.
                    OK = [thisGroupLeader acceptAsEscort:ship];
                }
            }
        }
        if (OK)
        {
            OOJS_RETURN_BOOL([thisGroup addShip:ship]); // if ship is there already, noop & YES
        }
        else  OOJS_RETURN_BOOL(NO);
    }
    
    OOJS_NATIVE_EXIT
}

References ShipEntity::acceptAsEscort:, count, EXPECT_NOT, ShipEntity::group, OOShipGroup::leader, MIN, nil, OOJS_ARGV, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJS_RETURN_BOOL, OOJS_RETURN_VOID, OOJS_THIS, OOJSNativeObjectOfClassFromJSValue(), OOJSReportBadArguments(), OOJSReportWarningForCaller(), and ShipEntity::setGroup:.

Here is the call graph for this function:

ShipGroupConstruct()

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

static

Definition at line 186 of file OOJSShipGroup.m.

{
    OOJS_NATIVE_ENTER(context)
    
    if (EXPECT_NOT(!JS_IsConstructing(context, vp)))
    {
        OOJSReportError(context, @"ShipGroup() cannot be called as a function, it must be used as a constructor (as in new ShipGroup(...)).");
        return NO;
    }
    
    NSString                *name = nil;
    ShipEntity              *leader = nil;
    
    if (argc >= 1)
    {
        if (!JSVAL_IS_STRING(OOJS_ARGV[0]))
        {
            OOJSReportBadArguments(context, nil, @"ShipGroup()", 1, OOJS_ARGV, @"Could not create ShipGroup", @"group name");
            return NO;
        }
        name = OOStringFromJSValue(context, OOJS_ARGV[0]);
    }
    
    if (argc >= 2)
    {
        leader = OOJSNativeObjectOfClassFromJSValue(context, OOJS_ARGV[1], [ShipEntity class]);
        if (leader == nil && !JSVAL_IS_NULL(OOJS_ARGV[1]))
        {
            OOJSReportBadArguments(context, nil, @"ShipGroup()", 1, OOJS_ARGV + 1, @"Could not create ShipGroup", @"ship");
            return NO;
        }
    }
    
    OOJS_RETURN_OBJECT([OOShipGroup groupWithName:name leader:leader]);
    
    OOJS_NATIVE_EXIT
}

References EXPECT_NOT, nil, OOJS_ARGV, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJS_RETURN_OBJECT, OOJSNativeObjectOfClassFromJSValue(), OOJSReportBadArguments(), OOJSReportError(), and OOStringFromJSValue().

Referenced by InitOOJSShipGroup().

Here is the call graph for this function:

Here is the caller graph for this function:

ShipGroupContainsShip()

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

static

Definition at line 353 of file OOJSShipGroup.m.

{
    OOJS_NATIVE_ENTER(context)
    
    OOShipGroup             *thisGroup = nil;
    ShipEntity              *ship = nil;
    
    if (EXPECT_NOT(!JSShipGroupGetShipGroup(context, OOJS_THIS, &thisGroup)))  return NO;
    
    if (argc > 0)  ship = OOJSNativeObjectOfClassFromJSValue(context, OOJS_ARGV[0], [ShipEntity class]);
    if (ship == nil)
    {
        if (argc > 0 && JSVAL_IS_NULL(OOJS_ARGV[0]))  OOJS_RETURN_BOOL(NO); // OK, return false for null ship.
        
        OOJSReportBadArguments(context, @"ShipGroup", @"containsShip", MIN(argc, 1U), OOJS_ARGV, nil, @"ship");
        return NO;
    }
    
    OOJS_RETURN_BOOL([thisGroup containsShip:ship]);
    
    OOJS_NATIVE_EXIT
}

ShipGroupGetProperty()

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

static

Definition at line 104 of file OOJSShipGroup.m.

{
    if (!JSID_IS_INT(propID))  return YES;
    
    OOJS_NATIVE_ENTER(context)
    
    OOShipGroup             *group = nil;
    id                      result = nil;
    
    if (EXPECT_NOT(!JSShipGroupGetShipGroup(context, this, &group)))  return NO;
    
    switch (JSID_TO_INT(propID))
    {
        case kShipGroup_ships:
            result = [group memberArray];
            if (result == nil)  result = [NSArray array];
            break;
            
        case kShipGroup_leader:
            result = [group leader];
            break;
            
        case kShipGroup_name:
            result = [group name];
            if (result == nil)  result = [NSNull null];
            break;
            
        case kShipGroup_count:
            return JS_NewNumberValue(context, [group count], value);
            
        default:
            OOJSReportBadPropertySelector(context, this, propID, sShipGroupProperties);
            return NO;
    }
    
    *value = OOJSValueFromNativeObject(context, result);
    return YES;
    
    OOJS_NATIVE_EXIT
}

References count, EXPECT_NOT, kShipGroup_count, kShipGroup_leader, kShipGroup_name, kShipGroup_ships, OOShipGroup::leader, OOShipGroup::memberArray, OOShipGroup::name, nil, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJSReportBadPropertySelector(), OOJSValueFromNativeObject(), and sShipGroupProperties.

Here is the call graph for this function:

ShipGroupRemoveShip()

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

static

Definition at line 328 of file OOJSShipGroup.m.

{
    OOJS_NATIVE_ENTER(context)
    
    OOShipGroup             *thisGroup = nil;
    ShipEntity              *ship = nil;
    
    if (EXPECT_NOT(!JSShipGroupGetShipGroup(context, OOJS_THIS, &thisGroup)))  return NO;
    
    if (argc > 0)  ship = OOJSNativeObjectOfClassFromJSValue(context, OOJS_ARGV[0], [ShipEntity class]);
    if (ship == nil)
    {
        if (argc > 0 && JSVAL_IS_NULL(OOJS_ARGV[0]))  OOJS_RETURN_VOID; // OK, do nothing for null ship.
        
        OOJSReportBadArguments(context, @"ShipGroup", @"removeShip", MIN(argc, 1U), OOJS_ARGV, nil, @"ship");
        return NO;
    }
    
    OOJS_RETURN_BOOL([thisGroup removeShip:ship]);
    
    OOJS_NATIVE_EXIT
}

References EXPECT_NOT, MIN, nil, OOJS_ARGV, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJS_RETURN_BOOL, OOJS_RETURN_VOID, OOJS_THIS, OOJSNativeObjectOfClassFromJSValue(), and OOJSReportBadArguments().

Here is the call graph for this function:

ShipGroupSetProperty()

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

static

Definition at line 146 of file OOJSShipGroup.m.

{
    if (!JSID_IS_INT(propID))  return YES;
    
    OOJS_NATIVE_ENTER(context)
    
    OOShipGroup             *group = nil;
    ShipEntity              *shipValue = nil;
    
    if (EXPECT_NOT(!JSShipGroupGetShipGroup(context, this, &group)))  return NO;
    
    switch (JSID_TO_INT(propID))
    {
        case kShipGroup_leader:
            shipValue = OOJSNativeObjectOfClassFromJSValue(context, *value, [ShipEntity class]);
            if (shipValue != nil || JSVAL_IS_NULL(*value))
            {
                [group setLeader:shipValue];
                return YES;
            }
            break;
            
        case kShipGroup_name:
            [group setName:OOStringFromJSValueEvenIfNull(context, *value)];
            return YES;
            break;
            
        default:
            OOJSReportBadPropertySelector(context, this, propID, sShipGroupProperties);
            return NO;
    }
    
    OOJSReportBadPropertyValue(context, this, propID, sShipGroupProperties, *value);
    return NO;
    
    OOJS_NATIVE_EXIT
}

References EXPECT_NOT, kShipGroup_leader, kShipGroup_name, nil, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJSNativeObjectOfClassFromJSValue(), OOJSReportBadPropertySelector(), OOJSReportBadPropertyValue(), OOShipGroup::setLeader:, OOShipGroup::setName:, and sShipGroupProperties.

Here is the call graph for this function:

Variable Documentation

sShipGroupClass

JSClass sShipGroupClass

static

Initial value:

=
{
    "ShipGroup",
    JSCLASS_HAS_PRIVATE,
    
    JS_PropertyStub,        
    JS_PropertyStub,        
    ShipGroupGetProperty,   
    ShipGroupSetProperty,   
    JS_EnumerateStub,       
    JS_ResolveStub,         
    JS_ConvertStub,         
    OOJSObjectWrapperFinalize,
    JSCLASS_NO_OPTIONAL_MEMBERS
}

Definition at line 45 of file OOJSShipGroup.m.

{
    "ShipGroup",
    JSCLASS_HAS_PRIVATE,
    
    JS_PropertyStub,        // addProperty
    JS_PropertyStub,        // delProperty
    ShipGroupGetProperty,   // getProperty
    ShipGroupSetProperty,   // setProperty
    JS_EnumerateStub,       // enumerate
    JS_ResolveStub,         // resolve
    JS_ConvertStub,         // convert
    OOJSObjectWrapperFinalize,// finalize
    JSCLASS_NO_OPTIONAL_MEMBERS
};

Referenced by InitOOJSShipGroup().

sShipGroupMethods

JSFunctionSpec sShipGroupMethods[]

static

Initial value:

=
{
    
    { "toString",               OOJSObjectWrapperToString,  0 },
    { "addShip",                ShipGroupAddShip,           1 },
    { "containsShip",           ShipGroupContainsShip,      1 },
    { "removeShip",             ShipGroupRemoveShip,        1 },
    { 0 }
}

Definition at line 83 of file OOJSShipGroup.m.

{
    // JS name                  Function                    min args
    { "toString",               OOJSObjectWrapperToString,  0 },
    { "addShip",                ShipGroupAddShip,           1 },
    { "containsShip",           ShipGroupContainsShip,      1 },
    { "removeShip",             ShipGroupRemoveShip,        1 },
    { 0 }
};

Referenced by InitOOJSShipGroup().

sShipGroupProperties

JSPropertySpec sShipGroupProperties[]

static

Initial value:

=
{
    
    { "count",                  kShipGroup_count,           OOJS_PROP_READONLY_CB },
    { "leader",                 kShipGroup_leader,          OOJS_PROP_READWRITE_CB },
    { "name",                   kShipGroup_name,            OOJS_PROP_READWRITE_CB },
    { "ships",                  kShipGroup_ships,           OOJS_PROP_READONLY_CB },
    { 0 }
}

Definition at line 72 of file OOJSShipGroup.m.

{
    // JS name                  ID                          flags
    { "count",                  kShipGroup_count,           OOJS_PROP_READONLY_CB },
    { "leader",                 kShipGroup_leader,          OOJS_PROP_READWRITE_CB },
    { "name",                   kShipGroup_name,            OOJS_PROP_READWRITE_CB },
    { "ships",                  kShipGroup_ships,           OOJS_PROP_READONLY_CB },
    { 0 }
};

Referenced by InitOOJSShipGroup(), ShipGroupGetProperty(), and ShipGroupSetProperty().

sShipGroupPrototype

JSObject* sShipGroupPrototype

static

Definition at line 32 of file OOJSShipGroup.m.

Referenced by InitOOJSShipGroup().