OOCollectionExtractors.h File Reference

import <Foundation/Foundation.h>
import "OOFunctionAttributes.h"
#include <limits.h>
import "OOMaths.h"

Include dependency graph for OOCollectionExtractors.h:

Go to the source code of this file.

Classes
category	NSArray(OOExtractor)
category	NSDictionary(OOExtractor)
category	NSUserDefaults(OOExtractor)
category	NSMutableArray(OOInserter)
category	NSMutableDictionary(OOInserter)
category	NSMutableSet(OOInserter)

Macros
#define	OO_DEFINE_CLAMP(type, typeName, min, max)
#define	OO_DEFINE_CLAMP_PAIR(type, typeName, minMaxSymb)
#define	OO_ALIAS_CLAMP_LONG_LONG(type, typeName)
#define	OO_ALIAS_CLAMP_PAIR_LONG_LONG(type, typeName)

Functions
BOOL	OOBooleanFromObject (id object, BOOL defaultValue)
BOOL	OOFuzzyBooleanFromObject (id object, float defaultValue)
float	OOFloatFromObject (id object, float defaultValue)
double	OODoubleFromObject (id object, double defaultValue)
float	OONonNegativeFloatFromObject (id object, float defaultValue)
double	OONonNegativeDoubleFromObject (id object, double defaultValue)
Vector	OOVectorFromObject (id object, Vector defaultValue)
HPVector	OOHPVectorFromObject (id object, HPVector defaultValue)
Quaternion	OOQuaternionFromObject (id object, Quaternion defaultValue)
NSDictionary *	OOPropertyListFromVector (Vector value)
NSDictionary *	OOPropertyListFromHPVector (HPVector value)
NSDictionary *	OOPropertyListFromQuaternion (Quaternion value)
OOINLINE long long	OOClampInteger (long long value, long long minValue, long long maxValue) ALWAYS_INLINE_FUNC
long long	OOLongLongFromObject (id object, long long defaultValue)
unsigned long long	OOUnsignedLongLongFromObject (id object, unsigned long long defaultValue)
OOINLINE NSInteger	OOIntegerFromObject (id object, NSInteger defaultValue)
OOINLINE NSInteger	OOUIntegerFromObject (id object, NSUInteger defaultValue)

Macro Definition Documentation

OO_ALIAS_CLAMP_LONG_LONG

#define OO_ALIAS_CLAMP_LONG_LONG	(		type,
			typeName )

Value:

static inline type OO##typeName##FromObject(id object, type defaultValue) \
{ \
    return OOLongLongFromObject(object, defaultValue); \
}

Definition at line 444 of file OOCollectionExtractors.h.

#define OO_ALIAS_CLAMP_LONG_LONG(type, typeName) \
static inline type OO##typeName##FromObject(id object, type defaultValue) \
{ \
    return OOLongLongFromObject(object, defaultValue); \
}

OO_ALIAS_CLAMP_PAIR_LONG_LONG

#define OO_ALIAS_CLAMP_PAIR_LONG_LONG	(		type,
			typeName )

Value:

OO_ALIAS_CLAMP_LONG_LONG(type, typeName) \
OO_ALIAS_CLAMP_LONG_LONG(unsigned type, Unsigned##typeName)

Definition at line 449 of file OOCollectionExtractors.h.

#define OO_ALIAS_CLAMP_PAIR_LONG_LONG(type, typeName) \
OO_ALIAS_CLAMP_LONG_LONG(type, typeName) \
OO_ALIAS_CLAMP_LONG_LONG(unsigned type, Unsigned##typeName)

OO_DEFINE_CLAMP

#define OO_DEFINE_CLAMP	(		type,
			typeName,
			min,
			max )

Value:

    OOINLINE type OO ## typeName ## FromObject(id object, type defaultValue) \
    { \
        return (type)OOClampInteger(OOLongLongFromObject(object, defaultValue), min, max); \
    }

Definition at line 424 of file OOCollectionExtractors.h.

#define OO_DEFINE_CLAMP(type, typeName, min, max) \
    OOINLINE type OO ## typeName ## FromObject(id object, type defaultValue) \
    { \
        return (type)OOClampInteger(OOLongLongFromObject(object, defaultValue), min, max); \
    }

OO_DEFINE_CLAMP_PAIR

#define OO_DEFINE_CLAMP_PAIR	(		type,
			typeName,
			minMaxSymb )

Value:

    OO_DEFINE_CLAMP(type, typeName, minMaxSymb ## _MIN, minMaxSymb ## _MAX) \
    OO_DEFINE_CLAMP(unsigned type, Unsigned ## typeName, 0, U ## minMaxSymb ## _MAX)

Definition at line 430 of file OOCollectionExtractors.h.

#define OO_DEFINE_CLAMP_PAIR(type, typeName, minMaxSymb) \
    OO_DEFINE_CLAMP(type, typeName, minMaxSymb ## _MIN, minMaxSymb ## _MAX) \
    OO_DEFINE_CLAMP(unsigned type, Unsigned ## typeName, 0, U ## minMaxSymb ## _MAX)

Function Documentation

OOBooleanFromObject()

BOOL OOBooleanFromObject	(	id	object,
		BOOL	defaultValue )

Definition at line 1297 of file OOCollectionExtractors.m.

{
    BOOL result;
    
    if ([object isKindOfClass:[NSString class]])
    {
        result = BooleanFromString(object, defaultValue);
    }
    else
    {
        if ([object respondsToSelector:@selector(boolValue)])  result = [object boolValue];
        else if ([object respondsToSelector:@selector(intValue)])  result = [object intValue] != 0;
        else result = defaultValue;
    }
    
    return result;
}

References BooleanFromString().

Referenced by Verify_Boolean(), and Verify_FuzzyBoolean().

Here is the call graph for this function:

Here is the caller graph for this function:

OOClampInteger()

OOINLINE long long OOClampInteger	(	long long	value,
		long long	minValue,
		long long	maxValue )

Definition at line 402 of file OOCollectionExtractors.h.

{
    return (minValue < value) ? ((value < maxValue) ? value : maxValue) : minValue;
}

OODoubleFromObject()

double OODoubleFromObject	(	id	object,
		double	defaultValue )

Definition at line 1363 of file OOCollectionExtractors.m.

{
    double result;
    
    if ([object respondsToSelector:@selector(doubleValue)])
    {
        result = [object doubleValue];
        if (result == 0.0 && [object isKindOfClass:[NSString class]] && !IsZeroString(object))  result = defaultValue;
    }
    else if ([object respondsToSelector:@selector(floatValue)])  result = [object floatValue];
    else if ([object respondsToSelector:@selector(intValue)])  result = [object intValue];
    else result = defaultValue;
    
    return result;
}

References IsZeroString().

Referenced by Verify_Float(), Verify_FuzzyBoolean(), and Verify_PositiveFloat().

Here is the call graph for this function:

Here is the caller graph for this function:

OOFloatFromObject()

float OOFloatFromObject	(	id	object,
		float	defaultValue )

Definition at line 1346 of file OOCollectionExtractors.m.

{
    float result;
    
    if ([object respondsToSelector:@selector(floatValue)])
    {
        result = [object floatValue];
        if (result == 0.0f && [object isKindOfClass:[NSString class]] && !IsZeroString(object))  result = defaultValue;
    }
    else if ([object respondsToSelector:@selector(doubleValue)])  result = [object doubleValue];
    else if ([object respondsToSelector:@selector(intValue)])  result = [object intValue];
    else result = defaultValue;
    
    return result;
}

References IsZeroString().

Referenced by OOFuzzyBooleanFromObject().

Here is the call graph for this function:

Here is the caller graph for this function:

OOFuzzyBooleanFromObject()

BOOL OOFuzzyBooleanFromObject	(	id	object,
		float	defaultValue )

Definition at line 1317 of file OOCollectionExtractors.m.

{
    float probability;
    
    if ([object isKindOfClass:[NSString class]])
    {
        probability = [object floatValue];
        
        // If our string represents zero, it might be erroneous input or simply yes/no,
        // true/false or on/off valid boolean strings. Act on it.
        if (probability == 0.0f && !IsZeroString(object))
        {
            probability = FuzzyBooleanProbabilityFromString(object, defaultValue);
        }
    }
    else
    {
        probability = OOFloatFromObject(object, defaultValue);
    }
    
    /*  This will always be NO for negative values and YES for values
        greater than 1, as expected. randf() is always less than 1, so
        < is the correct operator here.
    */
    return randf() < probability;
}

References FuzzyBooleanProbabilityFromString(), IsZeroString(), OOFloatFromObject(), and randf().

Here is the call graph for this function:

OOHPVectorFromObject()

HPVector OOHPVectorFromObject	(	id	object,
		HPVector	defaultValue )

Definition at line 1445 of file OOCollectionExtractors.m.

{
    HPVector                result = defaultValue;
    NSDictionary        *dict = nil;
    
    if ([object isKindOfClass:[NSString class]])
    {
        // This will only write result if a valid vector is found, and will write an error message otherwise.
        ScanHPVectorFromString(object, &result);
    }
    else if ([object isKindOfClass:[NSArray class]] && [object count] == 3)
    {
        result.x = [object oo_doubleAtIndex:0];
        result.y = [object oo_doubleAtIndex:1];
        result.z = [object oo_doubleAtIndex:2];
    }
    else if ([object isKindOfClass:[NSDictionary class]])
    {
        dict = object;
        // Require at least one of the keys x, y, or z
        if ([dict objectForKey:@"x"] != nil ||
            [dict objectForKey:@"y"] != nil ||
            [dict objectForKey:@"z"] != nil)
        {
            // Note: uses 0 for unknown components rather than components of defaultValue.
            result.x = [dict oo_doubleForKey:@"x" defaultValue:0.0];
            result.y = [dict oo_doubleForKey:@"y" defaultValue:0.0];
            result.z = [dict oo_doubleForKey:@"z" defaultValue:0.0];
        }
    }
    
    return result;
}

References count, nil, and ScanHPVectorFromString().

Here is the call graph for this function:

OOIntegerFromObject()

OOINLINE NSInteger OOIntegerFromObject	(	id	object,
		NSInteger	defaultValue )

Definition at line 478 of file OOCollectionExtractors.h.

{
    return OOLongFromObject(object, defaultValue);
}

OOLongLongFromObject()

long long OOLongLongFromObject	(	id	object,
		long long	defaultValue )

Definition at line 1201 of file OOCollectionExtractors.m.

{
    long long llValue;
    
    if ([object respondsToSelector:@selector(longLongValue)])  llValue = [object longLongValue];
    else if ([object respondsToSelector:@selector(longValue)])  llValue = [object longValue];
    else if ([object respondsToSelector:@selector(intValue)])  llValue = [object intValue];
    else llValue = defaultValue;
    
    return llValue;
}

Referenced by Verify_Integer().

Here is the caller graph for this function:

OONonNegativeDoubleFromObject()

double OONonNegativeDoubleFromObject	(	id	object,
		double	defaultValue )

Definition at line 1393 of file OOCollectionExtractors.m.

{
    double result;
    
    if ([object respondsToSelector:@selector(doubleValue)])  result = [object doubleValue];
    else if ([object respondsToSelector:@selector(floatValue)])  result = [object floatValue];
    else if ([object respondsToSelector:@selector(intValue)])  result = [object intValue];
    else return defaultValue;   // Don't clamp default
    
    return fmax(result, 0.0);
}

OONonNegativeFloatFromObject()

float OONonNegativeFloatFromObject	(	id	object,
		float	defaultValue )

Definition at line 1380 of file OOCollectionExtractors.m.

{
    float result;
    
    if ([object respondsToSelector:@selector(floatValue)])  result = [object floatValue];
    else if ([object respondsToSelector:@selector(doubleValue)])  result = [object doubleValue];
    else if ([object respondsToSelector:@selector(intValue)])  result = [object intValue];
    else return defaultValue;   // Don't clamp default
    
    return fmax(result, 0.0f);
}

OOPropertyListFromHPVector()

NSDictionary * OOPropertyListFromHPVector

(

HPVector

value

)

Definition at line 1527 of file OOCollectionExtractors.m.

{
    return [NSDictionary dictionaryWithObjectsAndKeys:
            [NSNumber numberWithDouble:value.x], @"x",
            [NSNumber numberWithDouble:value.y], @"y",
            [NSNumber numberWithDouble:value.z], @"z",
            nil];
}

OOPropertyListFromQuaternion()

NSDictionary * OOPropertyListFromQuaternion

(

Quaternion

value

)

Definition at line 1537 of file OOCollectionExtractors.m.

{
    return [NSDictionary dictionaryWithObjectsAndKeys:
            [NSNumber numberWithFloat:value.w], @"w",
            [NSNumber numberWithFloat:value.x], @"x",
            [NSNumber numberWithFloat:value.y], @"y",
            [NSNumber numberWithFloat:value.z], @"z",
            nil];
}

OOPropertyListFromVector()

NSDictionary * OOPropertyListFromVector

(

Vector

value

)

Definition at line 1518 of file OOCollectionExtractors.m.

{
    return [NSDictionary dictionaryWithObjectsAndKeys:
            [NSNumber numberWithFloat:value.x], @"x",
            [NSNumber numberWithFloat:value.y], @"y",
            [NSNumber numberWithFloat:value.z], @"z",
            nil];
}

OOQuaternionFromObject()

Quaternion OOQuaternionFromObject	(	id	object,
		Quaternion	defaultValue )

Definition at line 1480 of file OOCollectionExtractors.m.

{
    Quaternion          result = defaultValue;
    NSDictionary        *dict = nil;
    
    if ([object isKindOfClass:[NSString class]])
    {
        // This will only write result if a valid quaternion is found, and will write an error message otherwise.
        ScanQuaternionFromString(object, &result);
    }
    else if ([object isKindOfClass:[NSArray class]] && [object count] == 4)
    {
        result.w = [object oo_floatAtIndex:0];
        result.x = [object oo_floatAtIndex:1];
        result.y = [object oo_floatAtIndex:2];
        result.z = [object oo_floatAtIndex:3];
    }
    else if ([object isKindOfClass:[NSDictionary class]])
    {
        dict = object;
        // Require at least one of the keys w, x, y, or z
        if ([dict objectForKey:@"w"] != nil ||
            [dict objectForKey:@"x"] != nil ||
            [dict objectForKey:@"y"] != nil ||
            [dict objectForKey:@"z"] != nil)
        {
            // Note: uses 0 for unknown components rather than components of defaultValue.
            result.w = [dict oo_floatForKey:@"w" defaultValue:0.0f];
            result.x = [dict oo_floatForKey:@"x" defaultValue:0.0f];
            result.y = [dict oo_floatForKey:@"y" defaultValue:0.0f];
            result.z = [dict oo_floatForKey:@"z" defaultValue:0.0f];
        }
    }
    
    return result;
}

References count, nil, and ScanQuaternionFromString().

Referenced by Verify_Quaternion().

Here is the call graph for this function:

Here is the caller graph for this function:

OOUIntegerFromObject()

OOINLINE NSInteger OOUIntegerFromObject	(	id	object,
		NSUInteger	defaultValue )

Definition at line 483 of file OOCollectionExtractors.h.

{
    return OOUnsignedLongFromObject(object, defaultValue);
}

OOUnsignedLongLongFromObject()

unsigned long long OOUnsignedLongLongFromObject	(	id	object,
		unsigned long long	defaultValue )

Definition at line 1214 of file OOCollectionExtractors.m.

{
    unsigned long long ullValue;
    
    if ([object respondsToSelector:@selector(unsignedLongLongValue)])  ullValue = [object unsignedLongLongValue];
    else if ([object respondsToSelector:@selector(unsignedLongValue)])  ullValue = [object unsignedLongValue];
    else if ([object respondsToSelector:@selector(unsignedIntValue)])  ullValue = [object unsignedIntValue];
    else if ([object respondsToSelector:@selector(intValue)])  ullValue = [object intValue];
    else ullValue = defaultValue;
    
    return ullValue;
}

Referenced by PlayerEntity(LoadSave)::addScenarioModel:, and Verify_PositiveInteger().

Here is the caller graph for this function:

OOVectorFromObject()

Vector OOVectorFromObject	(	id	object,
		Vector	defaultValue )

Definition at line 1407 of file OOCollectionExtractors.m.

{
    Vector              result = defaultValue;
    NSDictionary        *dict = nil;
    
    if ([object isKindOfClass:[OONativeVector class]])
    {
        result = [object getVector];
    }
    else if ([object isKindOfClass:[NSString class]])
    {
        // This will only write result if a valid vector is found, and will write an error message otherwise.
        ScanVectorFromString(object, &result);
    }
    else if ([object isKindOfClass:[NSArray class]] && [object count] == 3)
    {
        result.x = [object oo_floatAtIndex:0];
        result.y = [object oo_floatAtIndex:1];
        result.z = [object oo_floatAtIndex:2];
    }
    else if ([object isKindOfClass:[NSDictionary class]])
    {
        dict = object;
        // Require at least one of the keys x, y, or z
        if ([dict objectForKey:@"x"] != nil ||
            [dict objectForKey:@"y"] != nil ||
            [dict objectForKey:@"z"] != nil)
        {
            // Note: uses 0 for unknown components rather than components of defaultValue.
            result.x = [dict oo_floatForKey:@"x" defaultValue:0.0f];
            result.y = [dict oo_floatForKey:@"y" defaultValue:0.0f];
            result.z = [dict oo_floatForKey:@"z" defaultValue:0.0f];
        }
    }
    
    return result;
}

References count, nil, and ScanVectorFromString().

Referenced by Verify_Vector().

Here is the call graph for this function:

Here is the caller graph for this function: