2 /*-------------------------------------------------------------------------*/
7 @version $Revision: 2.14 $
8 @brief Parser for ini files.
10 /*--------------------------------------------------------------------------*/
13 $Id: iniparser.c,v 2.14 2002/12/12 10:49:01 ndevilla Exp $
15 $Date: 2002/12/12 10:49:01 $
19 /*---------------------------------------------------------------------------
21 ---------------------------------------------------------------------------*/
23 #include "iniparser.h"
26 #define ASCIILINESZ 1024
27 #define INI_INVALID_KEY ((char*)-1)
29 /*---------------------------------------------------------------------------
30 Private to this module
31 ---------------------------------------------------------------------------*/
33 /* Private: add an entry to the dictionary */
34 static void iniparser_add_entry(
40 char longkey
[2*ASCIILINESZ
+1];
42 /* Make a key as section:keyword */
44 sprintf(longkey
, "%s:%s", sec
, key
);
49 /* Add (key,val) to dictionary */
50 dictionary_set(d
, longkey
, val
);
55 /*-------------------------------------------------------------------------*/
57 @brief Get number of sections in a dictionary
58 @param d Dictionary to examine
59 @return int Number of sections found in dictionary
61 This function returns the number of sections found in a dictionary.
62 The test to recognize sections is done on the string stored in the
63 dictionary: a section name is given as "section" whereas a key is
64 stored as "section:key", thus the test looks for entries that do not
67 This clearly fails in the case a section name contains a colon, but
68 this should simply be avoided.
70 This function returns -1 in case of error.
72 /*--------------------------------------------------------------------------*/
74 int iniparser_getnsec(dictionary
* d
)
79 if (d
==NULL
) return -1 ;
81 for (i
=0 ; i
<d
->size
; i
++) {
84 if (strchr(d
->key
[i
], ':')==NULL
) {
92 /*-------------------------------------------------------------------------*/
94 @brief Get name for section n in a dictionary.
95 @param d Dictionary to examine
96 @param n Section number (from 0 to nsec-1).
97 @return Pointer to char string
99 This function locates the n-th section in a dictionary and returns
100 its name as a pointer to a string statically allocated inside the
101 dictionary. Do not free or modify the returned string!
103 This function returns NULL in case of error.
105 /*--------------------------------------------------------------------------*/
107 char * iniparser_getsecname(dictionary
* d
, int n
)
112 if (d
==NULL
|| n
<0) return NULL
;
114 for (i
=0 ; i
<d
->size
; i
++) {
117 if (strchr(d
->key
[i
], ':')==NULL
) {
130 /*-------------------------------------------------------------------------*/
132 @brief Dump a dictionary to an opened file pointer.
133 @param d Dictionary to dump.
134 @param f Opened file pointer to dump to.
137 This function prints out the contents of a dictionary, one element by
138 line, onto the provided file pointer. It is OK to specify @c stderr
139 or @c stdout as output files. This function is meant for debugging
142 /*--------------------------------------------------------------------------*/
143 void iniparser_dump(dictionary
* d
, FILE * f
)
147 if (d
==NULL
|| f
==NULL
) return ;
148 for (i
=0 ; i
<d
->size
; i
++) {
151 if (d
->val
[i
]!=NULL
) {
152 fprintf(f
, "[%s]=[%s]\n", d
->key
[i
], d
->val
[i
]);
154 fprintf(f
, "[%s]=UNDEF\n", d
->key
[i
]);
160 /*-------------------------------------------------------------------------*/
162 @brief Save a dictionary to a loadable ini file
163 @param d Dictionary to dump
164 @param f Opened file pointer to dump to
167 This function dumps a given dictionary into a loadable ini file.
168 It is Ok to specify @c stderr or @c stdout as output files.
170 /*--------------------------------------------------------------------------*/
172 void iniparser_dump_ini(dictionary
* d
, FILE * f
)
175 char keym
[ASCIILINESZ
+1];
180 if (d
==NULL
|| f
==NULL
) return ;
182 nsec
= iniparser_getnsec(d
);
184 /* No section in file: dump all keys as they are */
185 for (i
=0 ; i
<d
->size
; i
++) {
188 fprintf(f
, "%s = %s\n", d
->key
[i
], d
->val
[i
]);
192 for (i
=0 ; i
<nsec
; i
++) {
193 secname
= iniparser_getsecname(d
, i
) ;
194 seclen
= (int)strlen(secname
);
195 fprintf(f
, "\n[%s]\n", secname
);
196 sprintf(keym
, "%s:", secname
);
197 for (j
=0 ; j
<d
->size
; j
++) {
200 if (!strncmp(d
->key
[j
], keym
, seclen
+1)) {
204 d
->val
[j
] ? d
->val
[j
] : "");
215 /*-------------------------------------------------------------------------*/
217 @brief Get the string associated to a key, return NULL if not found
218 @param d Dictionary to search
219 @param key Key string to look for
220 @return pointer to statically allocated character string, or NULL.
222 This function queries a dictionary for a key. A key as read from an
223 ini file is given as "section:key". If the key cannot be found,
225 The returned char pointer is pointing to a string allocated in
226 the dictionary, do not free or modify it.
228 This function is only provided for backwards compatibility with
229 previous versions of iniparser. It is recommended to use
230 iniparser_getstring() instead.
232 /*--------------------------------------------------------------------------*/
233 char * iniparser_getstr(dictionary
* d
, const char * key
)
235 return iniparser_getstring(d
, key
, NULL
);
239 /*-------------------------------------------------------------------------*/
241 @brief Get the string associated to a key
242 @param d Dictionary to search
243 @param key Key string to look for
244 @param def Default value to return if key not found.
245 @return pointer to statically allocated character string
247 This function queries a dictionary for a key. A key as read from an
248 ini file is given as "section:key". If the key cannot be found,
249 the pointer passed as 'def' is returned.
250 The returned char pointer is pointing to a string allocated in
251 the dictionary, do not free or modify it.
253 /*--------------------------------------------------------------------------*/
254 char * iniparser_getstring(dictionary
* d
, const char * key
, char * def
)
259 if (d
==NULL
|| key
==NULL
)
262 if (!(lc_key
= strdup(strlwc(key
)))) {
265 sval
= dictionary_get(d
, lc_key
, def
);
272 /*-------------------------------------------------------------------------*/
274 @brief Get the string associated to a key, convert to an int
275 @param d Dictionary to search
276 @param key Key string to look for
277 @param notfound Value to return in case of error
280 This function queries a dictionary for a key. A key as read from an
281 ini file is given as "section:key". If the key cannot be found,
282 the notfound value is returned.
284 /*--------------------------------------------------------------------------*/
285 int iniparser_getint(dictionary
* d
, const char * key
, int notfound
)
289 str
= iniparser_getstring(d
, key
, INI_INVALID_KEY
);
290 if (str
==INI_INVALID_KEY
) return notfound
;
295 /*-------------------------------------------------------------------------*/
297 @brief Get the string associated to a key, convert to a double
298 @param d Dictionary to search
299 @param key Key string to look for
300 @param notfound Value to return in case of error
303 This function queries a dictionary for a key. A key as read from an
304 ini file is given as "section:key". If the key cannot be found,
305 the notfound value is returned.
307 /*--------------------------------------------------------------------------*/
308 double iniparser_getdouble(dictionary
* d
, char * key
, double notfound
)
312 str
= iniparser_getstring(d
, key
, INI_INVALID_KEY
);
313 if (str
==INI_INVALID_KEY
) return notfound
;
319 /*-------------------------------------------------------------------------*/
321 @brief Get the string associated to a key, convert to a boolean
322 @param d Dictionary to search
323 @param key Key string to look for
324 @param notfound Value to return in case of error
327 This function queries a dictionary for a key. A key as read from an
328 ini file is given as "section:key". If the key cannot be found,
329 the notfound value is returned.
331 A true boolean is found if one of the following is matched:
333 - A string starting with 'y'
334 - A string starting with 'Y'
335 - A string starting with 't'
336 - A string starting with 'T'
337 - A string starting with '1'
339 A false boolean is found if one of the following is matched:
341 - A string starting with 'n'
342 - A string starting with 'N'
343 - A string starting with 'f'
344 - A string starting with 'F'
345 - A string starting with '0'
347 The notfound value returned if no boolean is identified, does not
348 necessarily have to be 0 or 1.
350 /*--------------------------------------------------------------------------*/
351 int iniparser_getboolean(dictionary
* d
, const char * key
, int notfound
)
356 c
= iniparser_getstring(d
, key
, INI_INVALID_KEY
);
357 if (c
==INI_INVALID_KEY
) return notfound
;
358 if (c
[0]=='y' || c
[0]=='Y' || c
[0]=='1' || c
[0]=='t' || c
[0]=='T') {
360 } else if (c
[0]=='n' || c
[0]=='N' || c
[0]=='0' || c
[0]=='f' || c
[0]=='F') {
369 /*-------------------------------------------------------------------------*/
371 @brief Finds out if a given entry exists in a dictionary
372 @param ini Dictionary to search
373 @param entry Name of the entry to look for
374 @return integer 1 if entry exists, 0 otherwise
376 Finds out if a given entry exists in the dictionary. Since sections
377 are stored as keys with NULL associated values, this is the only way
378 of querying for the presence of sections in a dictionary.
380 /*--------------------------------------------------------------------------*/
382 int iniparser_find_entry(
388 if (iniparser_getstring(ini
, entry
, INI_INVALID_KEY
)!=INI_INVALID_KEY
) {
396 /*-------------------------------------------------------------------------*/
398 @brief Set an entry in a dictionary.
399 @param ini Dictionary to modify.
400 @param entry Entry to modify (entry name)
401 @param val New value to associate to the entry.
402 @return int 0 if Ok, -1 otherwise.
404 If the given entry can be found in the dictionary, it is modified to
405 contain the provided value. If it cannot be found, -1 is returned.
406 It is Ok to set val to NULL.
408 /*--------------------------------------------------------------------------*/
410 int iniparser_setstr(dictionary
* ini
, char * entry
, char * val
)
412 dictionary_set(ini
, strlwc(entry
), val
);
416 /*-------------------------------------------------------------------------*/
418 @brief Delete an entry in a dictionary
419 @param ini Dictionary to modify
420 @param entry Entry to delete (entry name)
423 If the given entry can be found, it is deleted from the dictionary.
425 /*--------------------------------------------------------------------------*/
426 void iniparser_unset(dictionary
* ini
, char * entry
)
428 dictionary_unset(ini
, strlwc(entry
));
432 /*-------------------------------------------------------------------------*/
434 @brief Parse an ini file and return an allocated dictionary object
435 @param ininame Name of the ini file to read.
436 @return Pointer to newly allocated dictionary
438 This is the parser for ini files. This function is called, providing
439 the name of the file to be read. It returns a dictionary object that
440 should not be accessed directly, but through accessor functions
443 The returned dictionary must be freed using iniparser_freedict().
445 /*--------------------------------------------------------------------------*/
447 dictionary
* iniparser_load(const char * ininame
)
450 char lin
[ASCIILINESZ
+1];
451 char sec
[ASCIILINESZ
+1];
452 char key
[ASCIILINESZ
+1];
453 char val
[ASCIILINESZ
+1];
458 if ((ini
=fopen(ininame
, "r"))==NULL
) {
465 * Initialize a new dictionary entry
467 if (!(d
= dictionary_new(0))) {
472 while (fgets(lin
, ASCIILINESZ
, ini
)!=NULL
) {
474 where
= strskp(lin
); /* Skip leading spaces */
475 if (*where
==';' || *where
=='#' || *where
==0)
476 continue ; /* Comment lines */
478 if (sscanf(where
, "[%[^]]", sec
)==1) {
479 /* Valid section name */
480 strcpy(sec
, strlwc(sec
));
481 iniparser_add_entry(d
, sec
, NULL
, NULL
);
482 } else if (sscanf (where
, "%[^=] = \"%[^\"]\"", key
, val
) == 2
483 || sscanf (where
, "%[^=] = '%[^\']'", key
, val
) == 2
484 || sscanf (where
, "%[^=] = %[^;#]", key
, val
) == 2) {
485 strcpy(key
, strlwc(strcrop(key
)));
487 * sscanf cannot handle "" or '' as empty value,
490 if (!strcmp(val
, "\"\"") || !strcmp(val
, "''")) {
493 strcpy(val
, strcrop(val
));
495 iniparser_add_entry(d
, sec
, key
, val
);
505 /*-------------------------------------------------------------------------*/
507 @brief Free all memory associated to an ini dictionary
508 @param d Dictionary to free
511 Free all memory associated to an ini dictionary.
512 It is mandatory to call this function before the dictionary object
513 gets out of the current context.
515 /*--------------------------------------------------------------------------*/
517 void iniparser_freedict(dictionary
* d
)
522 /* vim: set ts=4 et sw=4 tw=75 */