1
2
3
4
5
6
7
8
9
10
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
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
// This file was shamelessly copied from mozilla/xpinstall/wizard/unix/src2
#ifndef nsINIParser_h__
#define nsINIParser_h__
#ifdef MOZILLA_INTERNAL_API
# define nsINIParser nsINIParser_internal
#endif
#include "nscore.h"
#include "nsClassHashtable.h"
#include "mozilla/UniquePtr.h"
#include <stdio.h>
class nsIFile;
class nsINIParser {
public:
nsINIParser() {}
~nsINIParser() = default;
/**
* Initialize the INIParser with a nsIFile. If this method fails, no
* other methods should be called. This method reads and parses the file,
* the class does not hold a file handle open. An instance must only be
* initialized once.
*/
nsresult Init(nsIFile* aFile);
nsresult InitFromString(const nsCString& aStr);
/**
* Enumerate the sections within the INI file.
*
* The callback takes the section name as an argument, and can can return
* false to stop enumeration.
*/
nsresult GetSections(std::function<bool(const char*)>&& aCallback);
/**
* Enumerate the strings within a section. If the section does not exist, this
* function will silently return.
*
* The callback takes the key and value strings as arguments, and can return
* false to stop enumeration.
*/
nsresult GetStrings(
const char* aSection,
std::function<bool(const char*, const char*)>&& aCallback);
/**
* Get the value of the specified key in the specified section
* of the INI file represented by this instance.
*
* @param aSection section name
* @param aKey key name
* @param aResult the value found
* @throws NS_ERROR_FAILURE if the specified section/key could not be
* found.
*/
nsresult GetString(const char* aSection, const char* aKey,
nsACString& aResult);
/**
* Alternate signature of GetString that uses a pre-allocated buffer
* instead of a nsACString (for use in the standalone glue before
* the glue is initialized).
*
* @throws NS_ERROR_LOSS_OF_SIGNIFICANT_DATA if the aResult buffer is not
* large enough for the data. aResult will be filled with as
* much data as possible.
*
* @see GetString [1]
*/
nsresult GetString(const char* aSection, const char* aKey, char* aResult,
uint32_t aResultLen);
/**
* Sets the value of the specified key in the specified section. The section
* is created if it does not already exist.
*
* @oaram aSection section name
* @param aKey key name
* @param aValue the value to set
*/
nsresult SetString(const char* aSection, const char* aKey,
const char* aValue);
/**
* Deletes the value of the specified key in the specified section.
*
* @param aSection section name
* @param aKey key name
*
* @throws NS_ERROR_FAILURE if the string was not set.
*/
nsresult DeleteString(const char* aSection, const char* aKey);
/**
* Deletes the specified section.
*
* @param aSection section name
*
* @throws NS_ERROR_FAILURE if the section did not exist.
*/
nsresult DeleteSection(const char* aSection);
/**
* Renames the specified section.
*
* @param aSection section name
* @param aNewName new section name
*
* @throws NS_ERROR_FAILURE if the section did not exist.
* @throws NS_ERROR_ILLEGAL_VALUE if the new section name already exists.
*/
nsresult RenameSection(const char* aSection, const char* aNewName);
/**
* Writes the ini data to disk.
* @param aFile the file to write to
* @throws NS_ERROR_FAILURE on failure.
*/
nsresult WriteToFile(nsIFile* aFile);
void WriteToString(nsACString& aOutput);
private:
struct INIValue {
INIValue(const char* aKey, const char* aValue)
: key(strdup(aKey)), value(strdup(aValue)) {}
~INIValue() {
delete key;
delete value;
}
void SetValue(const char* aValue) {
delete value;
value = strdup(aValue);
}
const char* key;
const char* value;
mozilla::UniquePtr<INIValue> next;
};
nsClassHashtable<nsCharPtrHashKey, INIValue> mSections;
bool IsValidSection(const char* aSection);
bool IsValidKey(const char* aKey);
bool IsValidValue(const char* aValue);
};
#endif /* nsINIParser_h__ */
|
