OOPListParsing.m File Reference

import "OOPListParsing.h"
import "OOLogging.h"
import "OOStringParsing.h"
import "NSDataOOExtensions.h"
#include <ctype.h>
#include <string.h>

Include dependency graph for OOPListParsing.m:

Go to the source code of this file.

Macros
#define	NO_DYNAMIC_PLIST_DTD_CHANGE

Functions
static NSData *	CopyDataFromFile (NSString *path)
static id	ValueIfClass (id value, Class class)
id	OOPropertyListFromData (NSData *data, NSString *whereFrom)
id	OOPropertyListFromFile (NSString *path)
NSDictionary *	OODictionaryFromData (NSData *data, NSString *whereFrom)
NSDictionary *	OODictionaryFromFile (NSString *path)
NSArray *	OOArrayFromData (NSData *data, NSString *whereFrom)
NSArray *	OOArrayFromFile (NSString *path)

Variables
static NSString *const	kOOLogPListFoundationParseError = @"plist.parse.failed"
static NSString *const	kOOLogPListWrongType = @"plist.wrongType"

Macro Definition Documentation

NO_DYNAMIC_PLIST_DTD_CHANGE

#define NO_DYNAMIC_PLIST_DTD_CHANGE

Definition at line 35 of file OOPListParsing.m.

Function Documentation

CopyDataFromFile()

static NSData * CopyDataFromFile ( NSString * path )

static

Definition at line 173 of file OOPListParsing.m.

{
    return [[NSData oo_dataWithOXZFile:path] retain];
#if 0
// without OXZ extension. Code to be deleted once everything is working
#if OOLITE_MAC_OS_X
    return [[NSData alloc] initWithContentsOfMappedFile:path];
#else
    NSFileManager   *fmgr = [NSFileManager defaultManager];
    BOOL            dir;
    
    if ([fmgr fileExistsAtPath:path isDirectory:&dir])
    {
        if (!dir)
        {
            return [[NSData alloc] initWithContentsOfMappedFile:path];
        }
        else
        {
            OOLog(kOOLogFileNotFound, @"Expected property list but found directory at %@", path);
        }
    }
    
    return nil;
#endif
#endif
}

References kOOLogFileNotFound, nil, and OOLog.

Referenced by OOPropertyListFromFile().

Here is the caller graph for this function:

OOArrayFromData()

NSArray * OOArrayFromData	(	NSData *	data,
		NSString *	whereFrom )

Definition at line 215 of file OOPListParsing.m.

{
    id result = OOPropertyListFromData(data, whereFrom);
    return ValueIfClass(result, [NSArray class]);
}

References OOPropertyListFromData(), and ValueIfClass().

Here is the call graph for this function:

OOArrayFromFile()

NSArray * OOArrayFromFile

(

NSString *

path

)

Definition at line 222 of file OOPListParsing.m.

{
    id result = OOPropertyListFromFile(path);
    return ValueIfClass(result, [NSArray class]);
}

References OOPropertyListFromFile(), and ValueIfClass().

Referenced by OOScript::descriptionComponents.

Here is the call graph for this function:

Here is the caller graph for this function:

OODictionaryFromData()

NSDictionary * OODictionaryFromData	(	NSData *	data,
		NSString *	whereFrom )

Definition at line 201 of file OOPListParsing.m.

{
    id result = OOPropertyListFromData(data, whereFrom);
    return ValueIfClass(result, [NSDictionary class]);
}

References OOPropertyListFromData(), and ValueIfClass().

Here is the call graph for this function:

OODictionaryFromFile()

NSDictionary * OODictionaryFromFile

(

NSString *

path

)

Definition at line 208 of file OOPListParsing.m.

{
    id result = OOPropertyListFromFile(path);
    return ValueIfClass(result, [NSDictionary class]);
}

References OOPropertyListFromFile(), and ValueIfClass().

Referenced by NSFileManager(OOExtensions)::commanderContentsOfPath:, and LoadExplicitSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

OOPropertyListFromData()

id OOPropertyListFromData	(	NSData *	data,
		NSString *	whereFrom )

Definition at line 51 of file OOPListParsing.m.

{
    id          result = nil;
    NSString    *error = nil;
    
    if (data != nil)
    {
#ifndef NO_DYNAMIC_PLIST_DTD_CHANGE
        data = ChangeDTDIfApplicable(data);
#endif
        
        result = [NSPropertyListSerialization propertyListFromData:data mutabilityOption:NSPropertyListImmutable format:NULL errorDescription:&error];
        if (result == nil)  // Foundation parser failed
        {   
#if OOLITE_RELEASE_PLIST_ERROR_STRINGS
            [error autorelease];
#endif
            // Ensure we can say something sensible...
            if (error == nil) error = @"<no error message>";
            if (whereFrom == nil) whereFrom = @"<data in memory>";
            
            OOLog(kOOLogPListFoundationParseError, @"Failed to parse %@ as a property list.\n%@", whereFrom, error);
        }
    }
    
    return result;
}

References kOOLogPListFoundationParseError, nil, and OOLog.

Referenced by OOArrayFromData(), OODictionaryFromData(), and OOPropertyListFromFile().

Here is the caller graph for this function:

OOPropertyListFromFile()

id OOPropertyListFromFile

(

NSString *

path

)

Definition at line 80 of file OOPListParsing.m.

{
    id          result = nil;
    NSData      *data = nil;
    
    if (path != nil)
    {
        // Load file, if it exists...
        data = CopyDataFromFile(path);
        if (data != nil)
        {
            // ...and parse it
            result = OOPropertyListFromData(data, path);
            [data release];
        }
        // Non-existent file is not an error.
    }
    
    return result;
}

References CopyDataFromFile(), nil, and OOPropertyListFromData().

Referenced by OOArrayFromFile(), and OODictionaryFromFile().

Here is the call graph for this function:

Here is the caller graph for this function:

ValueIfClass()

static id ValueIfClass ( id value, Class class )

static

Definition at line 230 of file OOPListParsing.m.

{
    if (value != nil && ![value isKindOfClass:class])
    {
        OOLog(kOOLogPListWrongType, @"Property list is wrong type - expected %@, got %@.", class, [value class]);
        value = nil;
    }
    return value;
}

References kOOLogPListWrongType, nil, and OOLog.

Referenced by OOArrayFromData(), OOArrayFromFile(), OODictionaryFromData(), and OODictionaryFromFile().

Here is the caller graph for this function:

Variable Documentation

kOOLogPListFoundationParseError

NSString* const kOOLogPListFoundationParseError = @"plist.parse.failed"

static

Definition at line 39 of file OOPListParsing.m.

Referenced by OOPropertyListFromData().

kOOLogPListWrongType

NSString* const kOOLogPListWrongType = @"plist.wrongType"

static

Definition at line 40 of file OOPListParsing.m.

Referenced by ValueIfClass().