OOCollectionExtractors.m File Reference

import "OOCocoa.h"
import "OOStringParsing.h"
import "OOCollectionExtractors.h"
#include <limits.h>
import "OOMaths.h"

Include dependency graph for OOCollectionExtractors.m:

Go to the source code of this file.

Macros
#define	PEEK()

Functions
static NSSet *	SetForObject (id object, NSSet *defaultValue)
static NSString *	StringForObject (id object, NSString *defaultValue)
long long	OOLongLongFromObject (id object, long long defaultValue)
unsigned long long	OOUnsignedLongLongFromObject (id object, unsigned long long defaultValue)
static BOOL	IsSpaceOrTab (int value)
static BOOL	IsZeroString (NSString *string)
static BOOL	BooleanFromString (NSString *string, BOOL defaultValue)
static float	FuzzyBooleanProbabilityFromString (NSString *string, float defaultValue)
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)

Macro Definition Documentation

PEEK

#define PEEK

(

)

Value:

((i >= count) ? -1 : [string characterAtIndex:i])

Referenced by IsZeroString().

Function Documentation

BooleanFromString()

static BOOL BooleanFromString ( NSString * string, BOOL defaultValue )

static

Definition at line 1255 of file OOCollectionExtractors.m.

{
    if (NSOrderedSame == [string caseInsensitiveCompare:@"yes"] ||
        NSOrderedSame == [string caseInsensitiveCompare:@"true"] ||
        NSOrderedSame == [string caseInsensitiveCompare:@"on"] ||
        [string doubleValue] != 0.0)    // Floating point is used so values like @"0.1" are treated as nonzero.
    {
        return YES;
    }
    else if (NSOrderedSame == [string caseInsensitiveCompare:@"no"] ||
             NSOrderedSame == [string caseInsensitiveCompare:@"false"] ||
             NSOrderedSame == [string caseInsensitiveCompare:@"off"] ||
             IsZeroString(string))
    {
        return NO;
    }
    return defaultValue;
}

References IsZeroString().

Referenced by OOBooleanFromObject().

Here is the call graph for this function:

Here is the caller graph for this function:

FuzzyBooleanProbabilityFromString()

static float FuzzyBooleanProbabilityFromString ( NSString * string, float defaultValue )

static

Definition at line 1276 of file OOCollectionExtractors.m.

{
    if (NSOrderedSame == [string caseInsensitiveCompare:@"yes"] ||
        NSOrderedSame == [string caseInsensitiveCompare:@"true"] ||
        NSOrderedSame == [string caseInsensitiveCompare:@"on"] ||
        [string doubleValue] != 0.0)    // Floating point is used so values like @"0.1" are treated as nonzero.
    {
        return 1.0f;
    }
    else if (NSOrderedSame == [string caseInsensitiveCompare:@"no"] ||
             NSOrderedSame == [string caseInsensitiveCompare:@"false"] ||
             NSOrderedSame == [string caseInsensitiveCompare:@"off"] ||
             IsZeroString(string))
    {
        return 0.0f;
    }
    return defaultValue;
}

References IsZeroString().

Referenced by OOFuzzyBooleanFromObject().

Here is the call graph for this function:

Here is the caller graph for this function:

IsSpaceOrTab()

static BOOL IsSpaceOrTab ( int value )

inlinestatic

Definition at line 1228 of file OOCollectionExtractors.m.

{
    return value == ' ' || value == '\t';
}

Referenced by IsZeroString().

Here is the caller graph for this function:

IsZeroString()

static BOOL IsZeroString ( NSString * string )

static

Definition at line 1234 of file OOCollectionExtractors.m.

{
    /*  I don't particularly like regexps, but there are occasions...
     To match NSString's behaviour for intValue etc. with non-zero numbers,
     we need to skip any leading spaces or tabs (but not line breaks), get
     an optional minus sign, then at least one 0. Any trailing junk is
     ignored. It is assumed that this function is called for strings whose
     numerical value has already been determined to be 0.
     */
    
    unsigned long i = 0, count = [string length];
#define PEEK() ((i >= count) ? -1 : [string characterAtIndex:i])
    
    while (IsSpaceOrTab(PEEK()))  ++i;  // Skip spaces and tabs
    if (PEEK() == ' ')  ++i;            // Skip optional hyphen-minus
    return PEEK() == '0';               // If this is a 0, it's a numerical string.
    
#undef PEEK
}

References count, IsSpaceOrTab(), and PEEK.

Referenced by BooleanFromString(), FuzzyBooleanProbabilityFromString(), OODoubleFromObject(), OOFloatFromObject(), and OOFuzzyBooleanFromObject().

Here is the call graph for this function:

Here is the caller graph for this function:

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:

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:

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:

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:

SetForObject()

static NSSet * SetForObject ( id object, NSSet * defaultValue )

static

Definition at line 1549 of file OOCollectionExtractors.m.

{
    if ([object isKindOfClass:[NSArray class]])  return [NSSet setWithArray:object];
    else if ([object isKindOfClass:[NSSet class]])  return [[object copy] autorelease];
    
    return defaultValue;
}

StringForObject()

static NSString * StringForObject ( id object, NSString * defaultValue )

static

Definition at line 1558 of file OOCollectionExtractors.m.

{
    if ([object isKindOfClass:[NSString class]])  return object;
    else if ([object respondsToSelector:@selector(stringValue)])  return [object stringValue];
    
    return defaultValue;
}