OOJSManifest.m File Reference

import "OOJSManifest.h"
import "OOJavaScriptEngine.h"
import "PlayerEntity.h"
import "PlayerEntityScriptMethods.h"
import "PlayerEntityContracts.h"
import "Universe.h"
import "OOJSPlayer.h"
import "OOJSPlayerShip.h"
import "OOIsNumberLiteral.h"

Include dependency graph for OOJSManifest.m:

Go to the source code of this file.

Classes
class	OOManifest

Enumerations
enum	{ kManifest_list }

Functions
static JSBool	ManifestComment (JSContext *context, uintN argc, jsval *vp)
static JSBool	ManifestSetComment (JSContext *context, uintN argc, jsval *vp)
static JSBool	ManifestShortComment (JSContext *context, uintN argc, jsval *vp)
static JSBool	ManifestSetShortComment (JSContext *context, uintN argc, jsval *vp)
static JSBool	ManifestDeleteProperty (JSContext *context, JSObject *this, jsid propID, jsval *value)
static JSBool	ManifestGetProperty (JSContext *context, JSObject *this, jsid propID, jsval *value)
static JSBool	ManifestSetProperty (JSContext *context, JSObject *this, jsid propID, JSBool strict, jsval *value)
void	InitOOJSManifest (JSContext *context, JSObject *global)

Variables
static JSObject *	sManifestPrototype
static JSObject *	sManifestObject
static JSClass	sManifestClass
static JSPropertySpec	sManifestProperties []
static JSFunctionSpec	sManifestMethods []

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
kManifest_list

Definition at line 67 of file OOJSManifest.m.

{
    kManifest_list              // manifest list, array of commodities: name, unit, quantity, displayName - read-only   
};

Function Documentation

InitOOJSManifest()

void InitOOJSManifest	(	JSContext *	context,
		JSObject *	global )

Definition at line 129 of file OOJSManifest.m.

{
    sManifestPrototype = JS_InitClass(context, global, NULL, &sManifestClass, OOJSUnconstructableConstruct, 0, sManifestProperties, sManifestMethods, NULL, NULL);
    OOJSRegisterObjectConverter(&sManifestClass, OOJSBasicPrivateObjectConverter);
    
    // Create manifest object as a property of the player.ship object.
    sManifestObject = JS_DefineObject(context, JSPlayerShipObject(), "manifest", &sManifestClass, sManifestPrototype, OOJS_PROP_READONLY);
    JS_SetPrivate(context, sManifestObject, NULL);
    
    // Also define manifest object as a property of the global object.
    // Wait, what? Why? Oh well, too late now. Deprecate for EMMSTRAN? -- Ahruman 2011-02-10
    JS_DefineObject(context, global, "manifest", &sManifestClass, sManifestPrototype, OOJS_PROP_READONLY);
    
}

References JSPlayerShipObject(), OOJS_PROP_READONLY, OOJSBasicPrivateObjectConverter(), OOJSRegisterObjectConverter(), OOJSUnconstructableConstruct(), sManifestClass, sManifestMethods, sManifestObject, sManifestProperties, and sManifestPrototype.

Here is the call graph for this function:

ManifestComment()

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

static

Definition at line 232 of file OOJSManifest.m.

{
    OOJS_NATIVE_ENTER(context)
 
    OOCommodityType good = nil;
    NSString *      information = nil;
 
    if (argc > 0)
    {
        good = OOStringFromJSValue(context, OOJS_ARGV[0]);
    }
    if (good == nil)
    {
        OOJSReportBadArguments(context, @"Manifest", @"comment", MIN(argc, 1U), OOJS_ARGV, nil, @"good");
        return NO;
    }
 
    information = [[PLAYER shipCommodityData] commentForGood:good];
 
    OOJS_RETURN_OBJECT(information);
    
    OOJS_NATIVE_EXIT
}

References MIN, nil, OOJS_ARGV, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJS_RETURN_OBJECT, OOJSReportBadArguments(), and OOStringFromJSValue().

Here is the call graph for this function:

ManifestDeleteProperty()

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

static

Definition at line 145 of file OOJSManifest.m.

{
    jsval v = JSVAL_VOID;
    return ManifestSetProperty(context, this, propID, NO, &v);
}

References ManifestSetProperty().

Here is the call graph for this function:

ManifestGetProperty()

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

static

Definition at line 152 of file OOJSManifest.m.

{
    OOJS_NATIVE_ENTER(context)
    
    id                          result = nil;
    PlayerEntity                *entity = OOPlayerForScripting();
    
    if (JSID_IS_INT(propID))
    {
        switch (JSID_TO_INT(propID))
        {
            case kManifest_list:
                result = [entity cargoListForScripting];
                break;
                
            default:
                OOJSReportBadPropertySelector(context, this, propID, sManifestProperties);
                return NO;
        }
    }
    else if (JSID_IS_STRING(propID))
    {
        /* 'list' property is hard-coded
         * others map to the commodity keys in trade-goods.plist
         * compatible-ish with 1.80 and earlier except that
         * alienItems and similar aliases don't work */
        NSString *key = OOStringFromJSString(context, JSID_TO_STRING(propID));
        if ([[UNIVERSE commodities] goodDefined:key])
        {
            *value = INT_TO_JSVAL([entity cargoQuantityForType:key]);
            return YES;
        }
        else
        {
            return YES;
        }
    }
    
    *value = OOJSValueFromNativeObject(context, result);
    return YES;
    
    OOJS_NATIVE_EXIT
}

References PlayerEntity::cargoListForScripting, kManifest_list, nil, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJSReportBadPropertySelector(), OOJSValueFromNativeObject(), OOPlayerForScripting(), OOStringFromJSString(), sManifestProperties, and UNIVERSE.

Here is the call graph for this function:

ManifestSetComment()

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

static

Definition at line 257 of file OOJSManifest.m.

{
    OOJS_NATIVE_ENTER(context)
 
    BOOL            OK;
    OOCommodityType good = nil;
    NSString *      information = nil;
 
    if (argc > 1)
    {
        good = OOStringFromJSValue(context, OOJS_ARGV[0]);
        information = OOStringFromJSValue(context, OOJS_ARGV[1]);
    }
    if (good == nil || information == nil)
    {
        OOJSReportBadArguments(context, @"Manifest", @"setComment", MIN(argc, 2U), OOJS_ARGV, nil, @"good and information text");
        return NO;
    }
 
    OK = [[PLAYER shipCommodityData] setComment:information forGood:good];
 
    OOJS_RETURN_BOOL(OK);
    
    OOJS_NATIVE_EXIT
}

References MIN, nil, OOJS_ARGV, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJS_RETURN_BOOL, OOJSReportBadArguments(), and OOStringFromJSValue().

Here is the call graph for this function:

ManifestSetProperty()

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

static

Definition at line 197 of file OOJSManifest.m.

{
    OOJS_NATIVE_ENTER(context)
    
    PlayerEntity                *entity = OOPlayerForScripting();
    int32                       iValue;
    
    if (JSID_IS_STRING(propID))
    {
        NSString *key = OOStringFromJSString(context, JSID_TO_STRING(propID));
 
        OOMassUnit unit = [[UNIVERSE commodityMarket] massUnitForGood:key];
        // we can always change gold, platinum & gem-stones quantities, even with special cargo
        if (unit == UNITS_TONS && [entity specialCargo])
        {
            OOJSReportWarning(context, @"PlayerShip.manifest['foo'] - cannot modify cargo tonnage when Special Cargo is in use.");
            return YES;
        }
    
        if (JS_ValueToInt32(context, *value, &iValue))
        {
            if (iValue < 0)  iValue = 0;
            [entity setCargoQuantityForType:key amount:iValue];
        }
        else
        {
            OOJSReportBadPropertyValue(context, this, propID, sManifestProperties, *value);
        }
    }
    return YES;
    
    OOJS_NATIVE_EXIT
}

References OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJSReportBadPropertyValue(), OOJSReportWarning(), OOPlayerForScripting(), OOStringFromJSString(), PlayerEntity::setCargoQuantityForType:amount:, sManifestProperties, and UNITS_TONS.

Referenced by ManifestDeleteProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

ManifestSetShortComment()

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

static

Definition at line 309 of file OOJSManifest.m.

{
    OOJS_NATIVE_ENTER(context)
 
    BOOL            OK;
    OOCommodityType good = nil;
    NSString *      information = nil;
 
    if (argc > 1)
    {
        good = OOStringFromJSValue(context, OOJS_ARGV[0]);
        information = OOStringFromJSValue(context, OOJS_ARGV[1]);
    }
    if (good == nil || information == nil)
    {
        OOJSReportBadArguments(context, @"Manifest", @"setShortComment", MIN(argc, 2U), OOJS_ARGV, nil, @"good and information text");
        return NO;
    }
 
    OK = [[PLAYER shipCommodityData] setShortComment:information forGood:good];
 
    OOJS_RETURN_BOOL(OK);
    
    OOJS_NATIVE_EXIT
}

ManifestShortComment()

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

static

Definition at line 284 of file OOJSManifest.m.

{
    OOJS_NATIVE_ENTER(context)
 
    OOCommodityType good = nil;
    NSString *      information = nil;
 
    if (argc > 0)
    {
        good = OOStringFromJSValue(context, OOJS_ARGV[0]);
    }
    if (good == nil)
    {
        OOJSReportBadArguments(context, @"Manifest", @"shortComment", MIN(argc, 1U), OOJS_ARGV, nil, @"good");
        return NO;
    }
 
    information = [[PLAYER shipCommodityData] shortCommentForGood:good];
 
    OOJS_RETURN_OBJECT(information);
    
    OOJS_NATIVE_EXIT
}

References MIN, nil, OOJS_ARGV, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJS_RETURN_OBJECT, OOJSReportBadArguments(), and OOStringFromJSValue().

Here is the call graph for this function:

Variable Documentation

sManifestClass

JSClass sManifestClass

static

Initial value:

=
{
    "Manifest",
    JSCLASS_HAS_PRIVATE,
    
    JS_PropertyStub,
    ManifestDeleteProperty,
    ManifestGetProperty,
    ManifestSetProperty,
    JS_EnumerateStub,
    JS_ResolveStub,
    JS_ConvertStub,
    OOJSObjectWrapperFinalize,
    JSCLASS_NO_OPTIONAL_MEMBERS
}

Definition at line 50 of file OOJSManifest.m.

{
    "Manifest",
    JSCLASS_HAS_PRIVATE,
    
    JS_PropertyStub,
    ManifestDeleteProperty,
    ManifestGetProperty,
    ManifestSetProperty,
    JS_EnumerateStub,
    JS_ResolveStub,
    JS_ConvertStub,
    OOJSObjectWrapperFinalize,
    JSCLASS_NO_OPTIONAL_MEMBERS
};

Referenced by InitOOJSManifest().

sManifestMethods

JSFunctionSpec sManifestMethods[]

static

Initial value:

=
{
    
    { "shortComment",           ManifestShortComment,               1 },
    { "setShortComment",        ManifestSetShortComment,            2 },
    { "comment",                ManifestComment,        1 },
    { "setComment",             ManifestSetComment,     2 },
    { 0 }
}

Definition at line 81 of file OOJSManifest.m.

{
    // JS name                  Function                    min args
    { "shortComment",           ManifestShortComment,               1 },
    { "setShortComment",        ManifestSetShortComment,            2 },
    { "comment",                ManifestComment,        1 },
    { "setComment",             ManifestSetComment,     2 },
    { 0 }
};

Referenced by InitOOJSManifest().

sManifestObject

JSObject* sManifestObject

static

Definition at line 37 of file OOJSManifest.m.

Referenced by InitOOJSManifest().

sManifestProperties

JSPropertySpec sManifestProperties[]

static

Initial value:

=
{
    
    { "list",               kManifest_list,             OOJS_PROP_READONLY_CB },
    { 0 }
}

Definition at line 73 of file OOJSManifest.m.

{
    // JS name                  ID                          flags
    { "list",               kManifest_list,             OOJS_PROP_READONLY_CB },
    { 0 }
};

Referenced by InitOOJSManifest(), ManifestGetProperty(), and ManifestSetProperty().

sManifestPrototype

JSObject* sManifestPrototype

static

Definition at line 36 of file OOJSManifest.m.

Referenced by InitOOJSManifest().