OOConvertSystemDescriptions.h

Go to the documentation of this file.

/*
 
OOConvertSystemDescriptions.m
Oolite
 
Functions to convert system descriptions between dictionary and array
formats.
 
The array format is used in descriptions.plist. Each set of strings is an
array, the sets are stored in a master array, and cross-references are
indices into the master array.
 
The dictionary format is more human-friendly, with string sets identified
by name and cross-references using names.
 
The indicesToKeys parameter is optional; if it is nil or incomplete,
indices or (index-based) keys will be synthesized.
 
 
Copyright (C) 2008 Jens Ayton
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 
*/
 
 
#import <Foundation/Foundation.h>
 
 
NSArray *OOConvertSystemDescriptionsToArrayFormat(NSDictionary *descriptionsInDictionaryFormat, NSDictionary *indicesToKeys);
NSDictionary *OOConvertSystemDescriptionsToDictionaryFormat(NSArray *descriptionsInArrayFormat, NSDictionary *indicesToKeys);
 
NSString *OOStringifySystemDescriptionLine(NSString *line, NSDictionary *indicesToKeys, BOOL useFallback);
 
//  Higher-level functions to drive the entire conversion.
void CompileSystemDescriptions(BOOL asXML);
void ExportSystemDescriptions(BOOL asXML);