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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
|
#import "OFObject.h"
#import "OFString.h"
#import "OFINICategory.h"
OF_ASSUME_NONNULL_BEGIN
@class OFMutableArray OF_GENERIC(ObjectType);
@class OFURL;
@class OFURI;
/**
* @class OFINIFile OFINIFile.h ObjFW/OFINIFile.h
*
* @brief A class for reading, creating and modifying INI files.
*/
OF_SUBCLASSING_RESTRICTED
@interface OFINIFile: OFObject
{
OFMutableArray OF_GENERIC(OFINICategory *) *_categories;
}
/**
* @brief All categories in the INI file.
*/
@property (readonly, nonatomic) OFArray OF_GENERIC(OFINICategory *) *categories;
/**
* @brief Creates a new OFINIFile with the contents of the specified file.
*
* @param URL The URL to the file whose contents the OFINIFile should contain
* @param URI The URI to the file whose contents the OFINIFile should contain
*
* @return A new, autoreleased OFINIFile with the contents of the specified file
* @throw OFInvalidFormatException The format of the specified INI file is
* invalid
* @throw OFInvalidEncodingException The INI file is not in the specified
* encoding
*/
+ (instancetype)fileWithURL: (OFURL *)URL;
+ (instancetype)fileWithURI: (OFURI *)URI;
/**
* @brief Creates a new OFINIFile with the contents of the specified file in
* the specified encoding.
*
* @param URL The URL to the file whose contents the OFINIFile should contain
* @param URI The URI 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
* @throw OFInvalidFormatException The format of the specified INI file is
* invalid
* @throw OFInvalidEncodingException The INI file is not in the specified
* encoding
*/
+ (instancetype)fileWithURL: (OFURL *)URL encoding: (OFStringEncoding)encoding;
+ (instancetype)fileWithURI: (OFURI *)URI encoding: (OFStringEncoding)encoding;
- (instancetype)init OF_UNAVAILABLE;
/**
* @brief Initializes an already allocated OFINIFile with the contents of the
* specified file.
*
* @param URL The URL to the file whose contents the OFINIFile should contain
* @param URI The URI to the file whose contents the OFINIFile should contain
*
* @return An initialized OFINIFile with the contents of the specified file
* @throw OFInvalidFormatException The format of the specified INI file is
* invalid
* @throw OFInvalidEncodingException The INI file is not in the specified
* encoding
*/
- (instancetype)initWithURL: (OFURL *)URL;
- (instancetype)initWithURI: (OFURI *)URI;
/**
* @brief Initializes an already allocated OFINIFile with the contents of the
* specified file in the specified encoding.
*
* @param URL The URL to the file whose contents the OFINIFile should contain
* @param URI The URI 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
* @throw OFInvalidFormatException The format of the specified INI file is
* invalid
* @throw OFInvalidEncodingException The INI file is not in the specified
* encoding
*/
- (instancetype)initWithURL: (OFURL *)URL
- (instancetype)initWithURI: (OFURI *)URI
encoding: (OFStringEncoding)encoding
OF_DESIGNATED_INITIALIZER;
/**
* @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 URL The URL of the file to write to
* @param URI The URI of the file to write to
*/
- (void)writeToURL: (OFURL *)URL;
- (void)writeToURI: (OFURI *)URI;
/**
* @brief Writes the contents of the OFINIFile to a file in the specified
* encoding.
*
* @param URL The URL of the file to write to
* @param URI The URI of the file to write to
* @param encoding The encoding to use
*/
- (void)writeToURL: (OFURL *)URL encoding: (OFStringEncoding)encoding;
- (void)writeToURI: (OFURI *)URI encoding: (OFStringEncoding)encoding;
@end
OF_ASSUME_NONNULL_END
|