OOConstToString.h File Reference

import <Foundation/Foundation.h>
import "OOFunctionAttributes.h"
import "OOTypes.h"

Include dependency graph for OOConstToString.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations
enum	{ kOOCargoTypeDefault = CARGO_NOT_CARGO , kOOEnergyUnitTypeDefault = ENERGY_UNIT_NONE , kOORouteTypeDefault = OPTIMIZED_BY_JUMPS }

Functions
NSString *	JSTypeToString (int type) CONST_FUNC
NSString *	CargoTypeToString (OOCargoType cargo) CONST_FUNC
OOCargoType	StringToCargoType (NSString *string) PURE_FUNC
NSString *	EnergyUnitTypeToString (OOEnergyUnitType unit) CONST_FUNC
OOEnergyUnitType	StringToEnergyUnitType (NSString *string) PURE_FUNC
NSString *	CommodityDisplayNameForSymbolicName (NSString *symbolicName)
NSString *	CommodityDisplayNameForCommodityArray (NSArray *commodityDefinition)
NSString *	DisplayStringForMassUnit (OOMassUnit unit)
NSString *	DisplayStringForMassUnitForCommodity (OOCommodityType commodity)
NSString *	OOStringFromCompassMode (OOCompassMode mode)
OOCompassMode	OOCompassModeFromString (NSString *string)
NSString *	OOStringFromLongRangeChartMode (OOLongRangeChartMode chartMode)
OOLongRangeChartMode	OOLongRangeChartModeFromString (NSString *string)
NSString *	OOStringFromLegalStatusReason (OOLegalStatusReason reason)
NSString *	RouteTypeToString (OORouteType routeType)
OORouteType	StringToRouteType (NSString *string)
NSString *	DockingClearanceStatusToString (OODockingClearanceStatus dockingClearanceStatus) PURE_FUNC
NSString *	OOStringFromGraphicsDetail (OOGraphicsDetail detail)
OOGraphicsDetail	OOGraphicsDetailFromString (NSString *string)

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
kOOCargoTypeDefault
kOOEnergyUnitTypeDefault
kOORouteTypeDefault

Definition at line 36 of file OOConstToString.h.

{
    // Values used for unknown strings.
    kOOCargoTypeDefault         = CARGO_NOT_CARGO,
//  kOOCommodityTypeDefault     = COMMODITY_UNDEFINED,
    kOOEnergyUnitTypeDefault    = ENERGY_UNIT_NONE,
    kOORouteTypeDefault         = OPTIMIZED_BY_JUMPS
};

Function Documentation

CargoTypeToString()

NSString * CargoTypeToString

(

OOCargoType

cargo

)

Definition at line 338 of file OOConstToString.m.

{
    switch (cargo)
    {
        CASE(CARGO_NOT_CARGO);
        CASE(CARGO_SLAVES);
        CASE(CARGO_ALLOY);
        CASE(CARGO_MINERALS);
        CASE(CARGO_THARGOID);
        CASE(CARGO_RANDOM);
        CASE(CARGO_SCRIPTED_ITEM);
        CASE(CARGO_CHARACTER);
    }
    return @"Unknown cargo";
}

References CARGO_ALLOY, CARGO_CHARACTER, CARGO_MINERALS, CARGO_NOT_CARGO, CARGO_RANDOM, CARGO_SCRIPTED_ITEM, CARGO_SLAVES, CARGO_THARGOID, and CASE.

CommodityDisplayNameForCommodityArray()

NSString * CommodityDisplayNameForCommodityArray

(

NSArray *

commodityDefinition

)

Definition at line 513 of file OOConstToString.m.

{
    return CommodityDisplayNameForSymbolicName([commodityDefinition oo_stringAtIndex:MARKET_NAME]);
}

References CommodityDisplayNameForSymbolicName(), and MARKET_NAME.

Here is the call graph for this function:

CommodityDisplayNameForSymbolicName()

NSString * CommodityDisplayNameForSymbolicName

(

NSString *

symbolicName

)

Definition at line 506 of file OOConstToString.m.

{
    NSString *ret = [UNIVERSE descriptionForKey:[@"commodity-name " stringByAppendingString:[symbolicName lowercaseString]]];
    return ret ? ret : symbolicName;
}

Referenced by CommodityDisplayNameForCommodityArray(), and GlobalDisplayNameForCommodity().

Here is the caller graph for this function:

DisplayStringForMassUnit()

NSString * DisplayStringForMassUnit

(

OOMassUnit

unit

)

Definition at line 519 of file OOConstToString.m.

{
    switch (unit)
    {
        case UNITS_TONS:  return DESC(@"cargo-tons-symbol");
        case UNITS_KILOGRAMS:  return DESC(@"cargo-kilograms-symbol");
        case UNITS_GRAMS:  return DESC(@"cargo-grams-symbol");
    }
    
    return @"??";
}

References DESC, UNITS_GRAMS, UNITS_KILOGRAMS, and UNITS_TONS.

Referenced by DisplayStringForMassUnitForCommodity().

Here is the caller graph for this function:

DisplayStringForMassUnitForCommodity()

NSString * DisplayStringForMassUnitForCommodity

(

OOCommodityType

commodity

)

Definition at line 532 of file OOConstToString.m.

{
    return DisplayStringForMassUnit([[UNIVERSE commodityMarket] massUnitForGood:commodity]);
}

References DisplayStringForMassUnit(), and UNIVERSE.

Here is the call graph for this function:

DockingClearanceStatusToString()

NSString * DockingClearanceStatusToString

(

OODockingClearanceStatus

dockingClearanceStatus

)

Definition at line 548 of file OOConstToString.m.

{
    switch (dockingClearanceStatus)
    {
        CASE(DOCKING_CLEARANCE_STATUS_NONE);
        CASE(DOCKING_CLEARANCE_STATUS_REQUESTED);
        CASE(DOCKING_CLEARANCE_STATUS_NOT_REQUIRED);
        CASE(DOCKING_CLEARANCE_STATUS_GRANTED);
        CASE(DOCKING_CLEARANCE_STATUS_TIMING_OUT);
    }
    
    return @"DOCKING_CLEARANCE_STATUS_UNKNOWN";
}

References CASE, DOCKING_CLEARANCE_STATUS_GRANTED, DOCKING_CLEARANCE_STATUS_NONE, DOCKING_CLEARANCE_STATUS_NOT_REQUIRED, DOCKING_CLEARANCE_STATUS_REQUESTED, and DOCKING_CLEARANCE_STATUS_TIMING_OUT.

Referenced by PlayerGetProperty().

Here is the caller graph for this function:

EnergyUnitTypeToString()

NSString * EnergyUnitTypeToString

(

OOEnergyUnitType

unit

)

Definition at line 373 of file OOConstToString.m.

{
    switch (unit)
    {
        CASE(ENERGY_UNIT_NONE);
        CASE(ENERGY_UNIT_NORMAL);
        CASE(ENERGY_UNIT_NAVAL);
        CASE(ENERGY_UNIT_NORMAL_DAMAGED);
        CASE(ENERGY_UNIT_NAVAL_DAMAGED);
            
        case OLD_ENERGY_UNIT_NORMAL:
        case OLD_ENERGY_UNIT_NAVAL:
            break;
    }
    
    return @"Unsupported energy unit";
}

References CASE, ENERGY_UNIT_NAVAL, ENERGY_UNIT_NAVAL_DAMAGED, ENERGY_UNIT_NONE, ENERGY_UNIT_NORMAL, ENERGY_UNIT_NORMAL_DAMAGED, OLD_ENERGY_UNIT_NAVAL, and OLD_ENERGY_UNIT_NORMAL.

JSTypeToString()

NSString * JSTypeToString

(

int

type

)

Definition at line 246 of file OOConstToString.m.

{
    switch ((JSType)type)
    {
        CASE(JSTYPE_VOID);
        CASE(JSTYPE_OBJECT);
        CASE(JSTYPE_FUNCTION);
        CASE(JSTYPE_STRING);
        CASE(JSTYPE_NUMBER);
        CASE(JSTYPE_BOOLEAN);
        CASE(JSTYPE_NULL);
        CASE(JSTYPE_XML);
        CASE(JSTYPE_LIMIT);
    }
    return [NSString stringWithFormat:@"unknown (%u)", type];
}

References CASE.

OOCompassModeFromString()

OOCompassMode OOCompassModeFromString

(

NSString *

string

)

Definition at line 151 of file OOConstToString.m.

{
    #include "OOCompassMode.tbl"
    
    return kOOCompassModeDefault;
}

References kOOCompassModeDefault.

OOGraphicsDetailFromString()

OOGraphicsDetail OOGraphicsDetailFromString

(

NSString *

string

)

Definition at line 577 of file OOConstToString.m.

{
    REVERSE_CASE(DETAIL_LEVEL_MINIMUM);
    REVERSE_CASE(DETAIL_LEVEL_NORMAL);
    REVERSE_CASE(DETAIL_LEVEL_SHADERS);
    REVERSE_CASE(DETAIL_LEVEL_EXTRAS);
    
    return DETAIL_LEVEL_MINIMUM;
}

References DETAIL_LEVEL_EXTRAS, DETAIL_LEVEL_MINIMUM, DETAIL_LEVEL_NORMAL, DETAIL_LEVEL_SHADERS, and REVERSE_CASE.

OOLongRangeChartModeFromString()

OOLongRangeChartMode OOLongRangeChartModeFromString

(

NSString *

string

)

Definition at line 190 of file OOConstToString.m.

{
    #include "OOLongRangeChartMode.tbl"
    
    return kOOLongRangeChartModeDefault;
}

References kOOLongRangeChartModeDefault.

Referenced by PlayerShipSetProperty().

Here is the caller graph for this function:

OOStringFromCompassMode()

NSString * OOStringFromCompassMode

(

OOCompassMode

mode

)

Definition at line 62 of file OOConstToString.m.

{
    switch (value)
    {
        #include "OOCompassMode.tbl"
    }
    
    return @"UNDEFINED";
}

OOStringFromGraphicsDetail()

NSString * OOStringFromGraphicsDetail

(

OOGraphicsDetail

detail

)

Definition at line 563 of file OOConstToString.m.

{
    switch (detail)
    {
        CASE(DETAIL_LEVEL_MINIMUM);
        CASE(DETAIL_LEVEL_NORMAL);
        CASE(DETAIL_LEVEL_SHADERS);
        CASE(DETAIL_LEVEL_EXTRAS);
    }
    
    return @"DETAIL_LEVEL_UNKNOWN";
}

References CASE, DETAIL_LEVEL_EXTRAS, DETAIL_LEVEL_MINIMUM, DETAIL_LEVEL_NORMAL, and DETAIL_LEVEL_SHADERS.

OOStringFromLegalStatusReason()

NSString * OOStringFromLegalStatusReason

(

OOLegalStatusReason

reason

)

Definition at line 125 of file OOConstToString.m.

{
    switch (value)
    {
        #include "OOLegalStatusReason.tbl"
    }
    
    return @"UNDEFINED";
}

OOStringFromLongRangeChartMode()

NSString * OOStringFromLongRangeChartMode

(

OOLongRangeChartMode

chartMode

)

Definition at line 72 of file OOConstToString.m.

{
    switch (value)
    {
        #include "OOLongRangeChartMode.tbl"
    }
 
    return @"UNDEFINED";
}

Referenced by PlayerShipGetProperty().

Here is the caller graph for this function:

RouteTypeToString()

NSString * RouteTypeToString

(

OORouteType

routeType

)

Definition at line 201 of file OOConstToString.m.

{
    switch (routeType)
    {
        CASE(OPTIMIZED_BY_NONE);
        CASE(OPTIMIZED_BY_JUMPS);
        CASE(OPTIMIZED_BY_TIME);
    }
    
    return @"** ROUTE TYPE UNKNOWN **";
}

References CASE, OPTIMIZED_BY_JUMPS, OPTIMIZED_BY_NONE, and OPTIMIZED_BY_TIME.

StringToCargoType()

OOCargoType StringToCargoType

(

NSString *

string

)

Definition at line 355 of file OOConstToString.m.

{
    REVERSE_CASE(CARGO_NOT_CARGO);
    REVERSE_CASE(CARGO_SLAVES);
    REVERSE_CASE(CARGO_ALLOY);
    REVERSE_CASE(CARGO_MINERALS);
    REVERSE_CASE(CARGO_THARGOID);
    REVERSE_CASE(CARGO_RANDOM);
    REVERSE_CASE(CARGO_SCRIPTED_ITEM);
    REVERSE_CASE(CARGO_CHARACTER);
    
    // Backwards compatibility.
    if ([string isEqual:@"CARGO_CARRIED"]) return CARGO_RANDOM;
    
    return kOOCargoTypeDefault;
}

References CARGO_ALLOY, CARGO_CHARACTER, CARGO_MINERALS, CARGO_NOT_CARGO, CARGO_RANDOM, CARGO_SCRIPTED_ITEM, CARGO_SLAVES, CARGO_THARGOID, kOOCargoTypeDefault, and REVERSE_CASE.

StringToEnergyUnitType()

OOEnergyUnitType StringToEnergyUnitType

(

NSString *

string

)

Definition at line 392 of file OOConstToString.m.

{
    REVERSE_CASE(ENERGY_UNIT_NONE);
    REVERSE_CASE(ENERGY_UNIT_NORMAL);
    REVERSE_CASE(ENERGY_UNIT_NAVAL);
    REVERSE_CASE(ENERGY_UNIT_NORMAL_DAMAGED);
    REVERSE_CASE(ENERGY_UNIT_NAVAL_DAMAGED);
    
    return kOOEnergyUnitTypeDefault;
}

References ENERGY_UNIT_NAVAL, ENERGY_UNIT_NAVAL_DAMAGED, ENERGY_UNIT_NONE, ENERGY_UNIT_NORMAL, ENERGY_UNIT_NORMAL_DAMAGED, kOOEnergyUnitTypeDefault, and REVERSE_CASE.

StringToRouteType()

OORouteType StringToRouteType

(

NSString *

string

)

Definition at line 538 of file OOConstToString.m.

{
    REVERSE_CASE(OPTIMIZED_BY_NONE);
    REVERSE_CASE(OPTIMIZED_BY_JUMPS);
    REVERSE_CASE(OPTIMIZED_BY_TIME);
    
    return kOORouteTypeDefault;
}

References kOORouteTypeDefault, OPTIMIZED_BY_JUMPS, OPTIMIZED_BY_NONE, OPTIMIZED_BY_TIME, and REVERSE_CASE.

Referenced by SystemInfoRouteToSystem().

Here is the caller graph for this function: