OOConvertSystemDescriptions.m File Reference

import "Universe.h"
import "OOConvertSystemDescriptions.h"
import "OldSchoolPropertyListWriting.h"
import "OOCollectionExtractors.h"
import "ResourceManager.h"

Include dependency graph for OOConvertSystemDescriptions.m:

Go to the source code of this file.

Functions
static NSMutableDictionary *	InitKeyToIndexDict (NSDictionary *dict, NSMutableSet **outUsedIndices)
static NSString *	IndexToKey (NSUInteger index, NSDictionary *indicesToKeys, BOOL useFallback)
static NSArray *	ConvertIndicesToKeys (NSArray *entry, NSDictionary *indicesToKeys)
static NSNumber *	KeyToIndex (NSString *key, NSMutableDictionary *ioKeysToIndices, NSMutableSet *ioUsedIndicies, NSUInteger *ioSlotCache)
static NSArray *	ConvertKeysToIndices (NSArray *entry, NSMutableDictionary *ioKeysToIndices, NSMutableSet *ioUsedIndicies, NSUInteger *ioSlotCache)
static NSUInteger	HighestIndex (NSMutableDictionary *sparseArray)
void	CompileSystemDescriptions (BOOL asXML)
void	ExportSystemDescriptions (BOOL asXML)
NSArray *	OOConvertSystemDescriptionsToArrayFormat (NSDictionary *descriptionsInDictionaryFormat, NSDictionary *indicesToKeys)
NSDictionary *	OOConvertSystemDescriptionsToDictionaryFormat (NSArray *descriptionsInArrayFormat, NSDictionary *indicesToKeys)
NSString *	OOStringifySystemDescriptionLine (NSString *line, NSDictionary *indicesToKeys, BOOL useFallback)

Function Documentation

CompileSystemDescriptions()

void CompileSystemDescriptions

(

BOOL

asXML

)

Definition at line 47 of file OOConvertSystemDescriptions.m.

{
    NSDictionary        *sysDescDict = nil;
    NSArray             *sysDescArray = nil;
    NSDictionary        *keyMap = nil;
    NSData              *data = nil;
    NSString            *error = nil;
    
    sysDescDict = [ResourceManager dictionaryFromFilesNamed:@"sysdesc.plist"
                                                   inFolder:@"Config"
                                                   andMerge:NO];
    if (sysDescDict == nil)
    {
        OOLog(@"sysdesc.compile.failed.fileNotFound", @"%@", @"Could not load a dictionary from sysdesc.plist, ignoring --compile-sysdesc option.");
        return;
    }
    
    keyMap = [ResourceManager dictionaryFromFilesNamed:@"sysdesc_key_table.plist"
                                              inFolder:@"Config"
                                              andMerge:NO];
    // keyMap is optional, so no nil check
    
    sysDescArray = OOConvertSystemDescriptionsToArrayFormat(sysDescDict, keyMap);
    if (sysDescArray == nil)
    {
        OOLog(@"sysdesc.compile.failed.conversion", @"%@", @"Could not convert sysdesc.plist to descriptions.plist format for some reason.");
        return;
    }
    
    sysDescDict = [NSDictionary dictionaryWithObject:sysDescArray forKey:@"system_description"];
    
    if (asXML)
    {
        data = [NSPropertyListSerialization dataFromPropertyList:sysDescDict
                                                          format:NSPropertyListXMLFormat_v1_0
                                                errorDescription:&error];
    }
    else
    {
        data = [sysDescDict oldSchoolPListFormatWithErrorDescription:&error];
    }
    
    if (data == nil)
    {
        OOLog(@"sysdesc.compile.failed.XML", @"Could not convert translated sysdesc.plist to property list: %@.", error);
        return;
    }
    
    if ([ResourceManager writeDiagnosticData:data toFileNamed:@"sysdesc-compiled.plist"])
    {
        OOLog(@"sysdesc.compile.success", @"%@", @"Wrote translated sysdesc.plist to sysdesc-compiled.plist.");
    }
    else
    {
        OOLog(@"sysdesc.compile.failed.writeFailure", @"%@", @"Could not write translated sysdesc.plist to sysdesc-compiled.plist.");
    }
}

References ResourceManager::dictionaryFromFilesNamed:inFolder:andMerge:, nil, OOConvertSystemDescriptionsToArrayFormat(), and OOLog.

Here is the call graph for this function:

ConvertIndicesToKeys()

static NSArray * ConvertIndicesToKeys ( NSArray * entry, NSDictionary * indicesToKeys )

static

Definition at line 297 of file OOConvertSystemDescriptions.m.

{
    NSEnumerator            *lineEnum = nil;
    NSString                *line = nil;
    NSMutableArray          *result = nil;
    
    result = [NSMutableArray arrayWithCapacity:[entry count]];
    
    for (lineEnum = [entry objectEnumerator]; (line = [lineEnum nextObject]); )
    {
        [result addObject:OOStringifySystemDescriptionLine(line, indicesToKeys, YES)];
    }
    
    return result;
}

References nil.

Referenced by OOConvertSystemDescriptionsToDictionaryFormat().

Here is the caller graph for this function:

ConvertKeysToIndices()

static NSArray * ConvertKeysToIndices ( NSArray * entry, NSMutableDictionary * ioKeysToIndices, NSMutableSet * ioUsedIndicies, NSUInteger * ioSlotCache )

static

Definition at line 339 of file OOConvertSystemDescriptions.m.

{
    NSEnumerator            *lineEnum = nil;
    NSString                *line = nil;
    NSUInteger              p1, p2;
    NSRange                 searchRange;
    NSMutableArray          *result = nil;
    NSString                *before = nil, *after = nil, *middle = nil;
    
    result = [NSMutableArray arrayWithCapacity:[entry count]];
    
    for (lineEnum = [entry objectEnumerator]; (line = [lineEnum nextObject]); )
    {
        searchRange.location = 0;
        searchRange.length = [line length];
        
        while ([line rangeOfString:@"[" options:NSLiteralSearch range:searchRange].location != NSNotFound)
        {
            p1 = [line rangeOfString:@"[" options:NSLiteralSearch range:searchRange].location;
            p2 = [line rangeOfString:@"]" options:NSLiteralSearch range:searchRange].location + 1;
            
            before = [line substringWithRange:NSMakeRange(0, p1)];
            after = [line substringWithRange:NSMakeRange(p2,[line length] - p2)];
            middle = [line substringWithRange:NSMakeRange(p1 + 1 , p2 - p1 - 2)];
            
            if ([middle length] > 1 && [middle hasPrefix:@"#"])
            {
                // Found [] around key
                line = [NSString stringWithFormat:@"%@[%@]%@", before, KeyToIndex([middle substringFromIndex:1], ioKeysToIndices, ioUsedIndicies, ioSlotCache), after];
            }
            
            searchRange.length -= p2 - searchRange.location;
            searchRange.location = [line length] - searchRange.length;
        }
        
        [result addObject:line];
    }
    
    return result;
}

References nil.

Referenced by OOConvertSystemDescriptionsToArrayFormat().

Here is the caller graph for this function:

ExportSystemDescriptions()

void ExportSystemDescriptions

(

BOOL

asXML

)

Definition at line 106 of file OOConvertSystemDescriptions.m.

{
    NSArray             *sysDescArray = nil;
    NSDictionary        *sysDescDict = nil;
    NSDictionary        *keyMap = nil;
    NSData              *data = nil;
    NSString            *error = nil;
    
    sysDescArray = [[UNIVERSE descriptions] oo_arrayForKey:@"system_description"];
    
    keyMap = [ResourceManager dictionaryFromFilesNamed:@"sysdesc_key_table.plist"
                                              inFolder:@"Config"
                                              andMerge:NO];
    // keyMap is optional, so no nil check
    
    sysDescDict = OOConvertSystemDescriptionsToDictionaryFormat(sysDescArray, keyMap);
    if (sysDescArray == nil)
    {
        OOLog(@"sysdesc.export.failed.conversion", @"%@", @"Could not convert system_description do sysdesc.plist format for some reason.");
        return;
    }
    
    if (asXML)
    {
        data = [NSPropertyListSerialization dataFromPropertyList:sysDescDict
                                                          format:NSPropertyListXMLFormat_v1_0
                                                errorDescription:&error];
    }
    else
    {
        data = [sysDescDict oldSchoolPListFormatWithErrorDescription:&error];
    }
    
    if (data == nil)
    {
        OOLog(@"sysdesc.export.failed.XML", @"Could not convert translated system_description to XML property list: %@.", error);
        return;
    }
    
    if ([ResourceManager writeDiagnosticData:data toFileNamed:@"sysdesc.plist"])
    {
        OOLog(@"sysdesc.export.success", @"%@", @"Wrote translated system_description to sysdesc.plist.");
    }
    else
    {
        OOLog(@"sysdesc.export.failed.writeFailure", @"%@", @"Could not write translated system_description to sysdesc.plist.");
    }
}

References ResourceManager::dictionaryFromFilesNamed:inFolder:andMerge:, nil, OOConvertSystemDescriptionsToDictionaryFormat(), and OOLog.

Here is the call graph for this function:

HighestIndex()

static NSUInteger HighestIndex ( NSMutableDictionary * sparseArray )

static

Definition at line 381 of file OOConvertSystemDescriptions.m.

{
    NSEnumerator            *keyEnum = nil;
    NSNumber                *key = nil;
    NSUInteger              curr, highest = 0;
    
    for (keyEnum = [sparseArray keyEnumerator]; (key = [keyEnum nextObject]); )
    {
        curr = [key intValue];
        if (highest < curr)  highest = curr;
    }
    
    return highest;
}

References nil.

Referenced by OOConvertSystemDescriptionsToArrayFormat().

Here is the caller graph for this function:

IndexToKey()

static NSString * IndexToKey ( NSUInteger index, NSDictionary * indicesToKeys, BOOL useFallback )

static

Definition at line 288 of file OOConvertSystemDescriptions.m.

{
    NSString *result = [indicesToKeys objectForKey:[NSString stringWithFormat:@"%lu", index]];
    if (result == nil && useFallback)  result = [NSString stringWithFormat:@"block_%lu", index];
    
    return result;
}

References nil.

Referenced by OOConvertSystemDescriptionsToDictionaryFormat(), and OOStringifySystemDescriptionLine().

Here is the caller graph for this function:

InitKeyToIndexDict()

static NSMutableDictionary * InitKeyToIndexDict ( NSDictionary * dict, NSMutableSet ** outUsedIndices )

static

Definition at line 262 of file OOConvertSystemDescriptions.m.

{
    NSEnumerator            *keyEnum = nil;
    NSString                *key = nil;
    NSNumber                *number = nil;
    NSMutableDictionary     *result = nil;
    NSMutableSet            *used = nil;
    
    assert(outUsedIndices != NULL);
    
    result = [NSMutableDictionary dictionaryWithCapacity:[dict count]];
    used = [NSMutableSet setWithCapacity:[dict count]];
    
    for (keyEnum = [dict keyEnumerator]; (key = [keyEnum nextObject]); )
    {
        // Convert keys of dict to array indices
        number = [NSNumber numberWithInt:[key intValue]];
        [result setObject:number forKey:[dict objectForKey:key]];
        [used addObject:number];
    }
    
    *outUsedIndices = used;
    return result;
}

References nil.

Referenced by OOConvertSystemDescriptionsToArrayFormat().

Here is the caller graph for this function:

KeyToIndex()

static NSNumber * KeyToIndex ( NSString * key, NSMutableDictionary * ioKeysToIndices, NSMutableSet * ioUsedIndicies, NSUInteger * ioSlotCache )

static

Definition at line 314 of file OOConvertSystemDescriptions.m.

{
    NSNumber                *result = nil;
    
    assert(ioSlotCache != NULL);
    
    result = [ioKeysToIndices objectForKey:key];
    if (result == nil)
    {
        // Search for free index
        do
        {
            result = [NSNumber numberWithUnsignedInteger:(*ioSlotCache)++];
        }
        while ([ioUsedIndicies containsObject:result]);
        
        [ioKeysToIndices setObject:result forKey:key];
        [ioUsedIndicies addObject:result];
        OOLog(@"sysdesc.compile.unknownKey", @"Assigning key \"%@\" to index %@.", key, result);
    }
    
    return result;
}

References nil, and OOLog.

Referenced by OOConvertSystemDescriptionsToArrayFormat().

Here is the caller graph for this function:

OOConvertSystemDescriptionsToArrayFormat()

NSArray * OOConvertSystemDescriptionsToArrayFormat	(	NSDictionary *	descriptionsInDictionaryFormat,
		NSDictionary *	indicesToKeys )

Definition at line 156 of file OOConvertSystemDescriptions.m.

{
    NSMutableDictionary     *result = nil;
    NSAutoreleasePool       *pool = nil;
    NSString                *key = nil;
    NSArray                 *entry = nil;
    NSEnumerator            *keyEnum = nil;
    NSMutableDictionary     *keysToIndices = nil;
    NSMutableSet            *usedIndices = nil;
    NSUInteger              slotCache = 0;
    NSNumber                *index = nil;
    NSUInteger              i, count;
    NSMutableArray          *realResult = nil;
    
    pool = [[NSAutoreleasePool alloc] init];
    
    // Use a dictionary as a sparse array.
    result = [NSMutableDictionary dictionaryWithCapacity:[descriptionsInDictionaryFormat count]];
    
    keysToIndices = InitKeyToIndexDict(indicesToKeys, &usedIndices);
    
    for (keyEnum = [descriptionsInDictionaryFormat keyEnumerator]; (key = [keyEnum nextObject]); )
    {
        entry = ConvertKeysToIndices([descriptionsInDictionaryFormat objectForKey:key], keysToIndices, usedIndices, &slotCache);
        index = KeyToIndex(key, keysToIndices, usedIndices, &slotCache);
        
        [result setObject:entry forKey:index];
    }
    
    count = HighestIndex(result);
    realResult = [NSMutableArray arrayWithCapacity:count];
    for (i = 0; i < count; i++)
    {
        entry = [result objectForKey:[NSNumber numberWithUnsignedInteger:i]];
        if (entry == nil)  entry = [NSArray array];
        [realResult addObject:entry];
    }
    
    [realResult retain];
    [pool release];
    return [realResult autorelease];
}

References ConvertKeysToIndices(), count, HighestIndex(), InitKeyToIndexDict(), KeyToIndex(), and nil.

Referenced by CompileSystemDescriptions().

Here is the call graph for this function:

Here is the caller graph for this function:

OOConvertSystemDescriptionsToDictionaryFormat()

NSDictionary * OOConvertSystemDescriptionsToDictionaryFormat	(	NSArray *	descriptionsInArrayFormat,
		NSDictionary *	indicesToKeys )

Definition at line 200 of file OOConvertSystemDescriptions.m.

{
    NSMutableDictionary     *result = nil;
    NSAutoreleasePool       *pool = nil;
    NSArray                 *entry = nil;
    NSEnumerator            *entryEnum = nil;
    NSString                *key = nil;
    NSUInteger              i = 0;
    
    result = [NSMutableDictionary dictionaryWithCapacity:[descriptionsInArrayFormat count]];
    pool = [[NSAutoreleasePool alloc] init];
    
    for (entryEnum = [descriptionsInArrayFormat objectEnumerator]; (entry = [entryEnum nextObject]); )
    {
        entry = ConvertIndicesToKeys(entry, indicesToKeys);
        key = IndexToKey(i, indicesToKeys, YES);
        ++i;
        
        [result setObject:entry forKey:key];
    }
    
    [pool release];
    return result;
}

References ConvertIndicesToKeys(), IndexToKey(), and nil.

Referenced by ExportSystemDescriptions().

Here is the call graph for this function:

Here is the caller graph for this function:

OOStringifySystemDescriptionLine()

NSString * OOStringifySystemDescriptionLine	(	NSString *	line,
		NSDictionary *	indicesToKeys,
		BOOL	useFallback )

Definition at line 226 of file OOConvertSystemDescriptions.m.

{
    NSUInteger              p1, p2;
    NSRange                 searchRange;
    NSString                *before = nil, *after = nil, *middle = nil;
    NSString                *key = nil;
    
    searchRange.location = 0;
    searchRange.length = [line length];
    
    while ([line rangeOfString:@"[" options:NSLiteralSearch range:searchRange].location != NSNotFound)
    {
        p1 = [line rangeOfString:@"[" options:NSLiteralSearch range:searchRange].location;
        p2 = [line rangeOfString:@"]" options:NSLiteralSearch range:searchRange].location + 1;
        
        before = [line substringWithRange:NSMakeRange(0, p1)];
        after = [line substringWithRange:NSMakeRange(p2,[line length] - p2)];
        middle = [line substringWithRange:NSMakeRange(p1 + 1 , p2 - p1 - 2)];
        
        if ([[middle stringByTrimmingCharactersInSet:[NSCharacterSet characterSetWithCharactersInString:@"0123456789"]] isEqual:@""] && ![middle isEqual:@""])
        {
            // Found [] around integers only
            key = IndexToKey([middle intValue], indicesToKeys, useFallback);
            if (key != nil)
            {
                line = [NSString stringWithFormat:@"%@[#%@]%@", before, key, after];
            }
        }
        
        searchRange.length -= p2 - searchRange.location;
        searchRange.location = [line length] - searchRange.length;
    }
    return line;
}

References IndexToKey(), and nil.

Here is the call graph for this function: