OOConstToJSString.m File Reference

#include "OOConstToJSString.h"
#include "OOCompassMode.tbl"
#include "OOEntityStatus.tbl"
#include "OOGalacticHyperspaceBehaviour.tbl"
#include "OOGUIScreenID.tbl"
#include "OOScanClass.tbl"
#include "OOViewID.tbl"
#include "OOShipDamageType.tbl"
#include "OOLegalStatusReason.tbl"
#include "OOLongRangeChartMode.tbl"

Include dependency graph for OOConstToJSString.m:

Go to the source code of this file.

Classes
struct	TableEntry
struct	ConstTable

Macros
#define	TABLE(entries)   { sizeof entries / sizeof *entries, entries }
#define	ENTRY(label, val)   { .value = label, .cString = #label },
#define	GALACTIC_HYPERSPACE_ENTRY(label, val)   { .value = GALACTIC_HYPERSPACE_##label, .cString = #label },
#define	DIFF_STRING_ENTRY(label, string)   { .value = label, .cString = string },

Typedefs
typedef struct ConstTable	ConstTable

Functions
static void	InitTable (JSContext *context, ConstTable *table)
void	OOConstToJSStringInit (JSContext *context)
void	OOConstToJSStringDestroy (void)
static int	CompareEntries (const void *a, const void *b)
JSString *	OOJSStringFromConstantPRIVATE (JSContext *context, NSInteger value, struct ConstTable *table)
NSUInteger	OOConstantFromJSStringPRIVATE (JSContext *context, JSString *string, struct ConstTable *table, NSInteger defaultValue)
NSUInteger	OOConstantFromJSValuePRIVATE (JSContext *context, jsval value, struct ConstTable *table, NSInteger defaultValue)

Variables
static BOOL	sInited = NO
static JSString *	sUndefinedString
static TableEntry	sOOCompassModeTableEntries []
static TableEntry	sOOEntityStatusTableEntries []
static TableEntry	sOOGalacticHyperspaceBehaviourTableEntries []
static TableEntry	sOOGUIScreenIDTableEntries []
static TableEntry	sOOScanClassTableEntries []
static TableEntry	sOOViewIDTableEntries []
static TableEntry	sOOShipDamageTypeTableEntries []
static TableEntry	sOOLegalStatusReasonTableEntries []
static TableEntry	sOOLongRangeChartModeTableEntries []
ConstTable	gOOCompassModeConstTable = TABLE(sOOCompassModeTableEntries)
ConstTable	gOOEntityStatusConstTable = TABLE(sOOEntityStatusTableEntries)
ConstTable	gOOGalacticHyperspaceBehaviourConstTable = TABLE(sOOGalacticHyperspaceBehaviourTableEntries)
ConstTable	gOOGUIScreenIDConstTable = TABLE(sOOGUIScreenIDTableEntries)
ConstTable	gOOScanClassConstTable = TABLE(sOOScanClassTableEntries)
ConstTable	gOOViewIDConstTable = TABLE(sOOViewIDTableEntries)
ConstTable	gOOShipDamageTypeConstTable = TABLE(sOOShipDamageTypeTableEntries)
ConstTable	gOOLegalStatusReasonConstTable = TABLE(sOOLegalStatusReasonTableEntries)
ConstTable	gOOLongRangeChartModeConstTable = TABLE(sOOLongRangeChartModeTableEntries)

Macro Definition Documentation

DIFF_STRING_ENTRY

#define DIFF_STRING_ENTRY	(		label,
			string )   { .value = label, .cString = string },

Definition at line 77 of file OOConstToJSString.m.

ENTRY

#define ENTRY	(		label,
			val )   { .value = label, .cString = #label },

Definition at line 75 of file OOConstToJSString.m.

GALACTIC_HYPERSPACE_ENTRY

#define GALACTIC_HYPERSPACE_ENTRY	(		label,
			val )   { .value = GALACTIC_HYPERSPACE_##label, .cString = #label },

Definition at line 76 of file OOConstToJSString.m.

TABLE

#define TABLE

(

entries

)

{ sizeof entries / sizeof *entries, entries }

Definition at line 60 of file OOConstToJSString.m.

Typedef Documentation

ConstTable

typedef struct ConstTable ConstTable

Function Documentation

CompareEntries()

static int CompareEntries ( const void * a, const void * b )

static

Definition at line 173 of file OOConstToJSString.m.

{
    const TableEntry *entA = a;
    const TableEntry *entB = b;
    
    if (entA->value < entB->value)  return -1;
    if (entA->value > entB->value)  return 1;
    return 0;
}

References TableEntry::value.

Referenced by InitTable().

Here is the caller graph for this function:

InitTable()

static void InitTable ( JSContext * context, ConstTable * table )

static

Definition at line 184 of file OOConstToJSString.m.

{
    NSCParameterAssert(context != NULL && JS_IsInRequest(context) && table != NULL);
    
    NSUInteger i;
    for(i = 0; i < table->count; i++)
    {
        table->entries[i].jsString = JS_InternString(context, table->entries[i].cString);
    }
    
    qsort(table->entries, table->count, sizeof *table->entries, CompareEntries);
}

References CompareEntries(), ConstTable::count, TableEntry::cString, ConstTable::entries, JS_IsInRequest, and TableEntry::jsString.

Referenced by OOConstToJSStringInit().

Here is the call graph for this function:

Here is the caller graph for this function:

OOConstantFromJSStringPRIVATE()

NSUInteger OOConstantFromJSStringPRIVATE	(	JSContext *	context,
		JSString *	string,
		struct ConstTable *	table,
		NSInteger	defaultValue )

Definition at line 232 of file OOConstToJSString.m.

{
    NSCAssert1(sInited, @"%s called before OOConstToJSStringInit().", __PRETTY_FUNCTION__);
    NSCParameterAssert(context != NULL && JS_IsInRequest(context) && table != NULL);
    
    // Quick pass: look for pointer-equal string.
    NSUInteger i, count = table->count;
    for(i = 0; i < count; i++)
    {
        if (table->entries[i].jsString == string)
        {
            return table->entries[i].value;
        }
    }
    
    
    // Slow pass: use string comparison. This is expected to fail.
    if (string != NULL)
    {
        for(i = 0; i < count; i++)
        {
            int32 result;
            if (JS_CompareStrings(context, string, table->entries[i].jsString, &result) && result == 0)
            {
                return table->entries[i].value;
            }
        }
    }
    
    // Fail.
    return defaultValue;
}

References count, ConstTable::count, ConstTable::entries, JS_IsInRequest, TableEntry::jsString, sInited, and TableEntry::value.

Referenced by OOCompassModeFromJSString(), OOConstantFromJSValuePRIVATE(), OOEntityStatusFromJSString(), OOGalacticHyperspaceBehaviourFromJSString(), OOGUIScreenIDFromJSString(), OOScanClassFromJSString(), and OOViewIDFromJSString().

Here is the caller graph for this function:

OOConstantFromJSValuePRIVATE()

NSUInteger OOConstantFromJSValuePRIVATE	(	JSContext *	context,
		jsval	value,
		struct ConstTable *	table,
		NSInteger	defaultValue )

Definition at line 266 of file OOConstToJSString.m.

{
    if (EXPECT(JSVAL_IS_STRING(value)))
    {
        return OOConstantFromJSStringPRIVATE(context, JSVAL_TO_STRING(value), table, defaultValue);
    }
    else
    {
        return defaultValue;
    }
 
}

References EXPECT, and OOConstantFromJSStringPRIVATE().

Referenced by OOCompassModeFromJSValue(), OOEntityStatusFromJSValue(), OOGalacticHyperspaceBehaviourFromJSValue(), OOGUIScreenIDFromJSValue(), OOScanClassFromJSValue(), and OOViewIDFromJSValue().

Here is the call graph for this function:

Here is the caller graph for this function:

OOConstToJSStringDestroy()

void OOConstToJSStringDestroy

(

void

)

Definition at line 165 of file OOConstToJSString.m.

{
    NSCAssert(sInited, @"OOConstToJSStringDestroy() called while not inited.");
    sInited = NO;
    // jsString pointers are now officially junk.
}

References sInited.

OOConstToJSStringInit()

void OOConstToJSStringInit

(

JSContext *

context

)

Definition at line 144 of file OOConstToJSString.m.

{
    NSCAssert(!sInited, @"OOConstToJSStringInit() called while already inited.");
    NSCParameterAssert(context != NULL && JS_IsInRequest(context));
    
    sUndefinedString = JS_InternString(context, "UNDEFINED");
    
    InitTable(context, &gOOEntityStatusConstTable);
    InitTable(context, &gOOCompassModeConstTable);
    InitTable(context, &gOOGalacticHyperspaceBehaviourConstTable);
    InitTable(context, &gOOGUIScreenIDConstTable);
    InitTable(context, &gOOScanClassConstTable);
    InitTable(context, &gOOViewIDConstTable);
    InitTable(context, &gOOShipDamageTypeConstTable);
    InitTable(context, &gOOLegalStatusReasonConstTable);
    InitTable(context, &gOOLongRangeChartModeConstTable);
    
    sInited = YES;
}

References gOOCompassModeConstTable, gOOEntityStatusConstTable, gOOGalacticHyperspaceBehaviourConstTable, gOOGUIScreenIDConstTable, gOOLegalStatusReasonConstTable, gOOLongRangeChartModeConstTable, gOOScanClassConstTable, gOOShipDamageTypeConstTable, gOOViewIDConstTable, InitTable(), JS_IsInRequest, sInited, and sUndefinedString.

Here is the call graph for this function:

OOJSStringFromConstantPRIVATE()

JSString * OOJSStringFromConstantPRIVATE	(	JSContext *	context,
		NSInteger	value,
		struct ConstTable *	table )

Definition at line 200 of file OOConstToJSString.m.

{
    NSCAssert1(sInited, @"%s called before OOConstToJSStringInit().", __PRETTY_FUNCTION__);
    NSCParameterAssert(context != NULL && JS_IsInRequest(context));
    NSCParameterAssert(table != NULL && table->count > 0);
    
    // Binary search.
    NSUInteger min = 0, max = table->count - 1;
    NSInteger current;
    do
    {
        NSUInteger mid = (min + max) / 2;
        current = table->entries[mid].value;
        if (current < value)
        {
            min = mid + 1;
        }
        else if (current > value)
        {
            max = mid - 1;
        }
        else
        {
            return table->entries[mid].jsString;
        }
    }
    while (min <= max);
    
    return sUndefinedString;
}

References ConstTable::count, ConstTable::entries, JS_IsInRequest, TableEntry::jsString, sInited, sUndefinedString, and TableEntry::value.

Referenced by OOJSStringFromCompassMode(), OOJSStringFromEntityStatus(), OOJSStringFromGalacticHyperspaceBehaviour(), OOJSStringFromGUIScreenID(), OOJSStringFromLegalStatusReason(), OOJSStringFromScanClass(), OOJSStringFromShipDamageType(), and OOJSStringFromViewID().

Here is the caller graph for this function:

Variable Documentation

gOOCompassModeConstTable

ConstTable gOOCompassModeConstTable = TABLE(sOOCompassModeTableEntries)

Definition at line 129 of file OOConstToJSString.m.

Referenced by OOCompassModeFromJSString(), OOCompassModeFromJSValue(), OOConstToJSStringInit(), and OOJSStringFromCompassMode().

gOOEntityStatusConstTable

ConstTable gOOEntityStatusConstTable = TABLE(sOOEntityStatusTableEntries)

Definition at line 130 of file OOConstToJSString.m.

Referenced by OOConstToJSStringInit(), OOEntityStatusFromJSString(), OOEntityStatusFromJSValue(), and OOJSStringFromEntityStatus().

gOOGalacticHyperspaceBehaviourConstTable

ConstTable gOOGalacticHyperspaceBehaviourConstTable = TABLE(sOOGalacticHyperspaceBehaviourTableEntries)

Definition at line 131 of file OOConstToJSString.m.

Referenced by OOConstToJSStringInit(), OOGalacticHyperspaceBehaviourFromJSString(), OOGalacticHyperspaceBehaviourFromJSValue(), and OOJSStringFromGalacticHyperspaceBehaviour().

gOOGUIScreenIDConstTable

ConstTable gOOGUIScreenIDConstTable = TABLE(sOOGUIScreenIDTableEntries)

Definition at line 132 of file OOConstToJSString.m.

Referenced by OOConstToJSStringInit(), OOGUIScreenIDFromJSString(), OOGUIScreenIDFromJSValue(), and OOJSStringFromGUIScreenID().

gOOLegalStatusReasonConstTable

ConstTable gOOLegalStatusReasonConstTable = TABLE(sOOLegalStatusReasonTableEntries)

Definition at line 136 of file OOConstToJSString.m.

Referenced by OOConstToJSStringInit(), and OOJSStringFromLegalStatusReason().

gOOLongRangeChartModeConstTable

ConstTable gOOLongRangeChartModeConstTable = TABLE(sOOLongRangeChartModeTableEntries)

Definition at line 137 of file OOConstToJSString.m.

Referenced by OOConstToJSStringInit().

gOOScanClassConstTable

ConstTable gOOScanClassConstTable = TABLE(sOOScanClassTableEntries)

Definition at line 133 of file OOConstToJSString.m.

Referenced by OOConstToJSStringInit(), OOJSStringFromScanClass(), OOScanClassFromJSString(), and OOScanClassFromJSValue().

gOOShipDamageTypeConstTable

ConstTable gOOShipDamageTypeConstTable = TABLE(sOOShipDamageTypeTableEntries)

Definition at line 135 of file OOConstToJSString.m.

Referenced by OOConstToJSStringInit(), and OOJSStringFromShipDamageType().

gOOViewIDConstTable

ConstTable gOOViewIDConstTable = TABLE(sOOViewIDTableEntries)

Definition at line 134 of file OOConstToJSString.m.

Referenced by OOConstToJSStringInit(), OOJSStringFromViewID(), OOViewIDFromJSString(), and OOViewIDFromJSValue().

sInited

BOOL sInited = NO

static

Definition at line 63 of file OOConstToJSString.m.

Referenced by OOConstantFromJSStringPRIVATE(), OOConstToJSStringDestroy(), OOConstToJSStringInit(), and OOJSStringFromConstantPRIVATE().

sOOCompassModeTableEntries

TableEntry sOOCompassModeTableEntries[]

static

Initial value:

=
{
 
}

Definition at line 79 of file OOConstToJSString.m.

{
    #include "OOCompassMode.tbl"
};

sOOEntityStatusTableEntries

TableEntry sOOEntityStatusTableEntries[]

static

Initial value:

=
{
 
}

Definition at line 84 of file OOConstToJSString.m.

{
    #include "OOEntityStatus.tbl"
};

sOOGalacticHyperspaceBehaviourTableEntries

TableEntry sOOGalacticHyperspaceBehaviourTableEntries[]

static

Initial value:

=
{
 
}

Definition at line 89 of file OOConstToJSString.m.

{
    #include "OOGalacticHyperspaceBehaviour.tbl"
};

sOOGUIScreenIDTableEntries

TableEntry sOOGUIScreenIDTableEntries[]

static

Initial value:

=
{
 
}

Definition at line 94 of file OOConstToJSString.m.

{
    #include "OOGUIScreenID.tbl"
};

sOOLegalStatusReasonTableEntries

TableEntry sOOLegalStatusReasonTableEntries[]

static

Initial value:

=
{
 
}

Definition at line 114 of file OOConstToJSString.m.

{
    #include "OOLegalStatusReason.tbl"
};

sOOLongRangeChartModeTableEntries

TableEntry sOOLongRangeChartModeTableEntries[]

static

Initial value:

=
{
 
}

Definition at line 119 of file OOConstToJSString.m.

{
    #include "OOLongRangeChartMode.tbl"
};

sOOScanClassTableEntries

TableEntry sOOScanClassTableEntries[]

static

Initial value:

=
{
 
}

Definition at line 99 of file OOConstToJSString.m.

{
    #include "OOScanClass.tbl"
};

sOOShipDamageTypeTableEntries

TableEntry sOOShipDamageTypeTableEntries[]

static

Initial value:

=
{
 
}

Definition at line 109 of file OOConstToJSString.m.

{
    #include "OOShipDamageType.tbl"
};

sOOViewIDTableEntries

TableEntry sOOViewIDTableEntries[]

static

Initial value:

=
{
 
}

Definition at line 104 of file OOConstToJSString.m.

{
    #include "OOViewID.tbl"
};

sUndefinedString

JSString* sUndefinedString

static

Definition at line 69 of file OOConstToJSString.m.

Referenced by OOConstToJSStringInit(), and OOJSStringFromConstantPRIVATE().