SCConfigFile.h

Go to the documentation of this file.

//
//  SCConfigFile.h
//  sclmac
//
//  Created by Viacheslav Smolensky on 05.06.14.
//  Copyright (c) 2007 - 2014 by Samond Development Corporation. All rights reserved.
//

#import <scl/SCConfig.h>

#define SCConfigFileClass       @"SCConfigFile"         ///< SCConfigFile class name

#pragma mark -
#pragma mark Configuration file supporing types

enum _SCConfigFileStatus {
        SCConfigFileOK                          = 0,    
        SCConfigFileReadError       = 11,       
        SCConfigFileWriteError          = 12,   
};

typedef SCUInteger SCConfigFileStatus;

@interface SCConfigFile : SCConfig {
        BOOL             fLoaded;                       // Determines whether a configuration file is loaded
        SCArray         *fAllowedComments;      // Supported comments list
        NSString        *fCommentPrefix;        // Record comments prefix
        SCStrings       *fComments;                     // Configuration file comments
}
#pragma mark -
#pragma mark Class properties
#if (__MAC_OS_X_VERSION_MIN_REQUIRED > 1040) || IOS_TARGET
// Configuration loaded flag property
@property (assign, readonly, getter=isLoaded) BOOL isLoaded;
// Configuration file path property
@property (retain, getter=path, setter=setPath:) NSString *path;
// Record comments prefix
@property (retain, getter=commentPrefix, setter=setCommentPrefix:) NSString *commentPrefix;
// Configuration file comments
@property (retain, getter=comments, setter=setComments:) SCStrings *comments;
#endif

#pragma mark -
#pragma mark Creating and Initializing Configurations

+ (SCConfigFile *)configFileWithCoder:(NSCoder *)coder;
+ (SCConfigFile *)configFileWithContentsOfSerializedFile:(NSString *)path;
+ (SCConfigFile *)configFileWithDataDictionary:(NSDictionary *)dictionary;
+ (SCConfigFile *)configFileWithDataDictionaryFromFile:(NSString *)path;
+ (SCConfigFile *)configFileWithStream:(SCStream *)stream;
+ (SCConfigFile *)configFileWithFileStream:(NSString *)path;

//+ (SCConfigFile *)configFileWithPath:(NSString *)path
//                                                      delegate:(id<SCConfigDelegate>)delegate
//                                                        unique:(BOOL)unique
//                                       caseInsensitive:(BOOL)caseInsensitive
//                                              ignoreErrors:(BOOL)ignoreErrors;
//+ (SCConfigFile *)configFileWithPath:(NSString *)path delegate:(id<SCConfigDelegate)delegate;
//+ (SCConfigFile *)configFileWithPath:(NSString *)path;
//+ (SCConfigFile *)configFileWithTextStream:(SCStream *)stream
//                                                                delegate:(id<SCConfigDelegate)delegate
//                                                                      unique:(BOOL)unique
//                                                 caseInsensitive:(BOOL)caseInsensitive
//                                                        ignoreErrors:(BOOL)ignoreErrors;
//+ (SCConfigFile *)configFileWithTextStream:(SCStream *)stream
//                                                                delegate:(id<SCConfigDelegate)delegate;
//+ (SCConfigFile *)configFileWithTextStream:(SCStream *)stream;
//+ (SCConfigFile *)configFileWithText:(SCStrings *)text
//                                                      delegate:(id<SCConfigDelegate)delegate
//                                                        unique:(BOOL)unique
//                                       caseInsensitive:(BOOL)caseInsensitive
//                                              ignoreErrors:(BOOL)ignoreErrors;
//+ (SCConfigFile *)configFileWithText:(SCStrings *)text delegate:(id<SCConfigDelegate)delegate;
//+ (SCConfigFile *)configFileWithText:(SCStrings *)text;
+ (SCConfigFile *)configFileWithConfig:(SCConfig *)config;
//+ (SCConfigFile *)configFileWithCollection:(id)collection;
+ (SCConfigFile *)configFileWithConfigFile:(SCConfigFile *)configFile;
+ (SCConfigFile *)configFile;

//- (id)initWithPath:(NSString *)path
//                delegate:(id<SCConfigDelegate>)delegate
//                      unique:(BOOL)unique
//   caseInsensitive:(BOOL)caseInsensitive
//        ignoreErrors:(BOOL)ignoreErrors;
//- (id)initWithPath:(NSString *)path delegate:(id<SCConfigDelegate)delegate;
//- (id)initWithPath:(NSString *)path;
//- (id)initWithTextStream:(SCStream *)stream
//                              delegate:(id<SCConfigDelegate)delegate
//                                unique:(BOOL)unique
//               caseInsensitive:(BOOL)caseInsensitive
//                      ignoreErrors:(BOOL)ignoreErrors;
//- (id)initWithTextStream:(SCStream *)stream delegate:(id<SCConfigDelegate)delegate;
//- (id)initWithTextStream:(SCStream *)stream;
//- (id)initWithText:(SCStrings *)text
//                delegate:(id<SCConfigDelegate)delegate
//                      unique:(BOOL)unique
//   caseInsensitive:(BOOL)caseInsensitive
//        ignoreErrors:(BOOL)ignoreErrors;
//- (id)initWithText:(SCStrings *)text delegate:(id<SCConfigDelegate)delegate;
//- (id)initWithText:(SCStrings *)text;
- (id)initWithConfigFile:(SCConfigFile *)configFile;
//- (id)init;

#pragma mark -
#pragma mark Getting and Setting Configuration Properties

- (BOOL)isLoaded;
- (NSString *)description;
- (NSString *)path;
- (NSString *)commentPrefix;
- (SCStrings *)comments;

- (void)setPath:(NSString *)path;
- (void)setCommentPrefix:(NSString *)commentPrefix;
- (void)setComments:(SCStrings *)comments;

#pragma mark -
#pragma mark Setting and Copying Configurations

- (void)setConfigFile:(SCConfigFile *)configFile;
- (void)setConfigFileWithText:(SCStrings *)text;
- (void)setConfigFileWithPath:(NSString *)path;
- (void)setConfigFileWithStream:(SCStream *)stream;

#pragma mark -
#pragma mark Comparing Configurations

//- (BOOL)isEqualToConfigFile:(SCConfigFile *)configFile;
//- (BOOL)isEqualToContentOfConfigFile:(SCConfigFile *)configFile;
//- (BOOL)isEqualTo:(id)object;
//- (BOOL)isEqual:(id)object;

#pragma mark -
#pragma mark Converting Configurations

- (SCConfig *)config;

#pragma mark -
#pragma mark Add Values from Existing Configurations

- (void)addValuesFromConfigFile:(SCConfigFile *)configFile;
- (void)addValuesFromConfigFileWithPath:(NSString *)path;
- (void)addValuesFromStream:(SCStream *)stream;

#pragma mark -
#pragma mark Subconfiguration Access Methods

//- (void)addConfigFile:(SCConfigFile *)configFile forKey:(NSString *)key;
//- (void)addConfigFileWithPath:(NSString *)path forKey:(NSString *)key;
//- (void)addConfigFileWithStream:(SCStream *) forKey:(NSString *)key;

//- (void)setConfigFile:(SCConfigFile *)configFile forKey:(NSString *)key;
//- (void)setConfigFileWithPath:(NSString *)path forKey:(NSString *)key;
//- (void)setConfigFileWithStream:(SCStream *) forKey:(NSString *)key;

//- (SCConfigFile *)configFileForKey:(NSString *)key;
//- (BOOL)writeConfigForKey:(NSString *)key toPath:(NSString *)path;
//- (BOOL)writeConfigForKey:(NSString *)key toStream:(SCStream *)stream;
//- (BOOL)appendConfigForKey:(NSString *)key toPath:(NSString *)path;
//- (BOOL)appendConfigForKey:(NSString *)key toStream:(SCStream *)stream;

#pragma mark -
#pragma mark Configuration File Reading and Writing

- (void)read;
- (void)readConfigFileWithPath:(NSString *)path;
- (void)readConfigFileFromText:(SCStrings *)text;
- (void)readConfigFileFromStream:(SCStream *)stream;
- (void)reload;
//- (void)write;
- (void)writeConfigFileWithPath:(NSString *)path;
- (void)writeConfigFileToText:(SCStrings *)text;
- (void)writeConfigFileToStream:(SCStream *)stream;
- (void)appendConfigFileToPath:(NSString *)path;
- (void)appendConfigFileToText:(SCStrings *)text;
- (void)appendConfigFileToStream:(SCStream *)stream;

#pragma mark -
#pragma mark Configuration File Comments Control

- (BOOL)isComment:(NSString *)string;
- (void)addAllowedComment:(NSString *)comment;
- (void)removeAllowedComment:(NSString *)comment;
- (SCArray *)allowedComments;
- (void)removeAllowedComments;

- (BOOL)haveComments;
- (void)addComment:(NSString *)comment;
- (void)addComments:(SCStrings *)comments;
- (void)setComment:(NSString *)comment;
- (void)removeComment:(NSString *)comment;
- (void)removeComments;
- (void)replaceComment:(NSString *)comment withComment:(NSString *)newComment;

- (SCStrings *)commentsForKey:(NSString *)key;
- (BOOL)haveCommentsForKey:(NSString *)key;
- (void)addComment:(NSString *)comment forKey:(NSString *)key;
- (void)addComments:(SCStrings *)comments forKey:(NSString *)key;
- (void)setComment:(NSString *)comment forKey:(NSString *)key;
- (void)setComments:(SCStrings *)comments forKey:(NSString *)key;
- (void)removeComment:(NSString *)comment forKey:(NSString *)key;
- (void)removeCommentsForKey:(NSString *)key;
- (void)replaceComment:(NSString *)comment
                   withComment:(NSString *)newComment
                                forKey:(NSString *)key;

#pragma mark -
#pragma mark Additional methods

- (void)resetConfigurationFile;

@end