Differences From Artifact [d3236d0058]:
- File
src/OFINIFile.h
— part of check-in
[12c5b7ee91]
at
2014-06-12 13:43:41
on branch trunk
— OFINIFile: Add support for quoted keys / values
This is a much more logical way to handle leading and trailing
whitespaces and also seems to be used by a few other INI
implementations.Additionally, this imports OFINICategory.h in OFINIFile.h so that
importing OFINIFile.h is enough - this should be less confusing - and
allows opening non-existant files, treating them like an empty file. (user: js, size: 1936) [annotate] [blame] [check-ins using]
To Artifact [ad0922c06d]:
- File src/OFINIFile.h — part of check-in [44de69ef31] at 2014-06-14 09:44:45 on branch trunk — OFINIFile: Add support for different encodings (user: js, size: 3071) [annotate] [blame] [check-ins using]
| ︙ | ︙ | |||
11 12 13 14 15 16 17 18 19 20 | * Alternatively, it may be distributed under the terms of the GNU General * Public License, either version 2 or 3, which can be found in the file * LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this * file. */ #import "OFObject.h" #import "OFINICategory.h" @class OFMutableArray; | > < > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
* Alternatively, it may be distributed under the terms of the GNU General
* Public License, either version 2 or 3, which can be found in the file
* LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
* file.
*/
#import "OFObject.h"
#import "OFString.h"
#import "OFINICategory.h"
@class OFMutableArray;
/*!
* @class OFINIFile OFINIFile.h ObjFW/OFINIFile.h
*
* @brief A class for reading, creating and modifying INI files.
*/
@interface OFINIFile: OFObject
{
OFMutableArray *_categories;
}
/*!
* @brief Creates a new OFINIFile with the contents of the specified file.
*
* @param path The path to the file whose contents the OFINIFile should contain
*
* @return A new, autoreleased OFINIFile with the contents of the specified file
*/
+ (instancetype)fileWithPath: (OFString*)path;
/*!
* @brief Creates a new OFINIFile with the contents of the specified file in
* the specified encoding.
*
* @param path The path to the file whose contents the OFINIFile should contain
* @param encoding The encoding of the specified file
*
* @return A new, autoreleased OFINIFile with the contents of the specified file
*/
+ (instancetype)fileWithPath: (OFString*)path
encoding: (of_string_encoding_t)encoding;
/*!
* @brief Initializes an already allocated OFINIFile with the contents of the
* specified file.
*
* @param path The path to the file whose contents the OFINIFile should contain
*
* @return An initialized OFINIFile with the contents of the specified file
*/
- initWithPath: (OFString*)path;
/*!
* @brief Initializes an already allocated OFINIFile with the contents of the
* specified file in the specified encoding.
*
* @param path The path to the file whose contents the OFINIFile should contain
* @param encoding The encoding of the specified file
*
* @return An initialized OFINIFile with the contents of the specified file
*/
- initWithPath: (OFString*)path
encoding: (of_string_encoding_t)encoding;
/*!
* @brief Returns an @ref OFINICategory for the category with the specified
* name.
*
* @param name The name of the category for which an @ref OFINICategory should
* be returned
*
* @return An @ref OFINICategory for the category with the specified name
*/
- (OFINICategory*)categoryForName: (OFString*)name;
/*!
* @brief Writes the contents of the OFINIFile to a file.
*
* @param path The path of the file to write to
*/
- (void)writeToFile: (OFString*)path;
/*!
* @brief Writes the contents of the OFINIFile to a file in the specified
* encoding.
*
* @param path The path of the file to write to
* @param encoding The encoding to use
*/
- (void)writeToFile: (OFString*)path
encoding: (of_string_encoding_t)encoding;
@end
|