aboutsummaryrefslogtreecommitdiff
path: root/mpiosh/cfgio.h
blob: d58cd3f2ba9bfb1ee1e87de9d64eff13772d7f2b (plain)
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
/* configreader and -writer 
 *
 * Source in ANSI C, except function strdup 
 * needs _BSD_SOURCE or _SVID_SOURCE defined, if compiled ANSI
 * Thomas Buntrock (bunti@tzi.de)
 *
 * Comments in configfile are allowed, but ONLY at the BEGINNING of a line
 * When reading a config then writing the same, all comments will be removed
 *
 * The groupname MUST be put exactly between two square braces, e.g. [Name]. 
 * Any Spaces in between are interpreted as part of the name. 
 *
 * Keys and their value are separated by "=". Leading and following spaces 
 * are removed.
 * Spaces right before and after the "=" are removed. Spaces in the value 
 * will remain.
 * Keys without value are accepted, BUT the "=" is MANDATORY.
 *
 * A config line MUST NOT be longer than _CFG_MAX_LINE_SIZE (default: 256)
 *
 */

#ifndef _CFG_IO_H
#define _CFG_IO_H

#include <stdio.h>
#include <errno.h>
#include <string.h>
#include <stdlib.h>
#include <pwd.h>
#include <sys/types.h>
#include <ctype.h>

#define _CFG_MAX_LINE_SIZE 256

/* define bool */
#ifndef TRUE
#define TRUE 1
#define FALSE 0
#endif

typedef unsigned char bool;

struct _CFG_Key {
  char *name;
  char *value;
  struct _CFG_Key* prev;
  struct _CFG_Key* next;
  struct _CFG_Group* pp;
};

struct _CFG_Group {
  char *name;
  struct _CFG_Group* prev;
  struct _CFG_Group* next;
  struct _CFG_Key* first;
  struct _CFG_Key* last;
  struct _CFG_Handle* pp;
};

struct _CFG_Handle {
  FILE *file;
  char *filename;
  struct _CFG_Group *first;
  struct _CFG_Group *last;
};


typedef struct _CFG_Key CfgKey;
typedef struct _CFG_Group CfgGroup;
typedef struct _CFG_Handle CfgHandle;
typedef int (*cfg_key_func)(CfgKey *key);

char *cfg_resolve_path(const char *filename);

/*
 * files: a list of files 
 * e.g. char *files[] = { ".blarc", ".bla", "blarc", NULL };
 *
 * paths: a list of paths 
 * e.g. char *paths[] = { "~/", "/etc/" "etc/", NULL};
 *
 * select the first path and iterates through the files,
 * then select the next path...
 *
 * returns the first match of: path/file
 */
char *cfg_find_file (char **files, char **paths);

/*
 * Save the config 
 *
 * close: close the file after saving
 *
 * returns 0 on success or -1 on failure
 */
int cfg_save (CfgHandle *handle, int close);

/*
 * Save the config with another filename
 *
 * handle      : the config handle
 * filename    : the new filename
 * reportErrors: 0 does not report errors the stderr
 * close       : close the file after saving
 *
 * returns 0 on success or -1 on failure
 */
int cfg_save_as (CfgHandle *handle, const char* filename, 
		 int reportErrors, int close);
/*
 * Read config file
 * requires the Handle to be associated to a file and being opened
 * 
 * handle: the config handle
 * close : close the file after reading
 * 
 * returns 0 on success or -1 on failure
 */
int cfg_read (CfgHandle *handle, int close);

/*
 * Open a file to read or save 
 *
 * handle      : the config handle
 * reportErrors: write errors to stderr
 * mode        : the mode the file should be opened with (man 3 fopen)
 * 
 * returns 0 on success or -1 on failure
 */
int cfg_open (CfgHandle *handle, int reportErrors, 
	      const char* mode);
/*
 * Open a file in read mode 
 * 
 * handle      : the config handle
 * filename    : the filename of the config file
 * reportErrors: write errors to stderr
 * close       : close the file after reading 
 * 
 * returns 0 on success or -1 on failure
 */
int cfg_open_read (CfgHandle *handle, const char* filename, 
		   int reportErrors, int close);
/*
 * Close the file
 *
 * h: the config handle
 * 
 * returns 0 on success or -1 if the handle was NULL or the was already closed
 */
int cfg_close (CfgHandle *h);

/*
 * Create a new empty file handle
 * 
 * returns the pointer to the new handle
 */
CfgHandle* cfg_handle_new ();

/*
 * Create a new filehandle
 * 
 * filename: the filename of the configfile
 * read    : read the config file 
 * 
 * returns the pointer to the new handle
 */
CfgHandle* cfg_handle_new_with_filename (const char* filename, int read);

/*
 * Change the filename of the config file
 * only the internal filename ist changed, to apply on disk you need to call 
 * cfg_save 
 * 
 * filename: new filename
 * 
 * returns 0 on success or -1 on failure
 */
int cfg_handle_change_filename (CfgHandle *h, const char* filename);

/*
 * Delete the handle
 * An opened file will be closed
 *
 * h: the config handle
 */
void cfg_handle_free (CfgHandle* h);

/*
 * Create a new group within the config
 * 
 * handle: the config handle
 * name  : name of the group
 * 
 * returns 0 on success or -1 on failure
 */
int  cfg_group_new (CfgHandle* handle, const char* name);

/*
 * Delete a group within the config
 * All keys within this group will be delete as well
 *
 * handle: the config handle
 * name  : the name of the group
 */
void cfg_group_free (CfgHandle* handle, const char* name);

/*
 * returns a handle to the group g if found.
 *
 * handle: the config handle
 * name  : the name of the group to search for
 */
CfgGroup* cfg_find_group(CfgHandle* h, const char* g);

/*
 * Create a new key within a group within the config
 * 
 * h  : the config handle
 * g  : name of the group
 * key: name of the key
 * 
 * returns 0 on success or -1 on failure
 */
int  cfg_key_new (CfgHandle* h, const char* g, const char* key);

/*
 * Create a new key within the group within the config and set its value 
 * 
 * h    : the config handle
 * g    : name of the group
 * key  : name of the key
 * value: value for the key
 * 
 * returns 0 on success or -1 on failure
 */
int  cfg_key_new_with_value (CfgHandle* h, const char* g, const char* key, 
			     const char* value);

/*
 * Set the value for a specific key within a group of the config
 * 
 * h    : the config handle
 * g    : name of the group
 * key  : name of the key
 * value: value for the key
 * 
 * returns 0 on success or -1 on failure
 */
int  cfg_key_set_value (CfgHandle* h, const char* g, const char* key, 
			const char* value);

/*
 * Set the value for a specific key within a group of the config
 * 
 * h    : the config handle
 * g    : name of the group
 * key  : name of the key
 * value: value for the key
 * 
 * returns 0 on success or -1 on failure
 */
int  cfg_key_set_uint_value (CfgHandle *h, const char* g, const char* key,
			     unsigned int value);

/*
 * Set the value for a specific key within a group of the config
 * 
 * h    : the config handle
 * g    : name of the group
 * key  : name of the key
 * value: value for the key
 * 
 * returns 0 on success or -1 on failure
 */
int  cfg_key_set_int_value (CfgHandle *h, const char* g, const char* key,
			    int value);

/*
 * Set the value for a specific key within a group of the config
 * 
 * h    : the config handle
 * g    : name of the group
 * key  : name of the key
 * value: value for the key
 * 
 * returns 0 on success or -1 on failure
 */
int  cfg_key_set_double_value (CfgHandle *h, const char* g, const char* key,
			       double value);

/*
 * Set the value for a specific key within a group of the config
 * 
 * h    : the config handle
 * g    : name of the group
 * key  : name of the key
 * value: value for the key
 * 
 * returns 0 on success or -1 on failure
 */
int  cfg_key_set_float_value (CfgHandle *h, const char* g, const char* key,
			      float value);

/*
 * Set the value for a specific key within a group of the config
 * 
 * h    : the config handle
 * g    : name of the group
 * key  : name of the key
 * value: value for the key
 * 
 * returns 0 on success or -1 on failure
 */
int  cfg_key_set_bool_value (CfgHandle *h, const char* g, const char* key,
			     bool value);

/*
 * Set the value for a specific key within a group of the config
 * 
 * h    : the config handle
 * g    : name of the group
 * key  : name of the key
 * value: value for the key
 * 
 * returns 0 on success or -1 on failure
 */
int  cfg_key_set_char_value (CfgHandle *h, const char* g, const char* key,
			     char value);

/*
 * Delete a key of a group within the config
 *
 * h    : the config handle
 * g    : name of the group
 * key  : name of the key
 */
void cfg_key_free (CfgHandle* h, const char* g, const char* key);

/*
 * Get the value of a key within a group of the config
 * 
 * h  : the config handle
 * g  : name of the group
 * key: name of the key
 * res: the result will be stored in this variable
 *
 * returns 0 on success or -1 on failure
 */
int cfg_key_get_value_as_bool (CfgHandle* h, const char* g, const char* key, 
			       bool *res);

/*
 * Get the value of a key within a group of the config
 * 
 * h  : the config handle
 * g  : name of the group
 * key: name of the key
 * res: the result will be stored in this variable
 *
 * returns 0 on success or -1 on failure
 */
int cfg_key_get_value_as_uint (CfgHandle* h, const char* g, const char* key, 
			       unsigned int *res);

/*
 * Get the value of a key within a group of the config
 * 
 * h  : the config handle
 * g  : name of the group
 * key: name of the key
 * res: the result will be stored in this variable
 *
 * returns 0 on success or -1 on failure
 */
int cfg_key_get_value_as_int (CfgHandle* h, const char* g, const char* key, 
			      int *res);

/*
 * Get the value of a key within a group of the config
 * 
 * h  : the config handle
 * g  : name of the group
 * key: name of the key
 * res: the result will be stored in this variable
 *
 * returns 0 on success or -1 on failure
 */
int cfg_key_get_value_as_ushort (CfgHandle* h, const char* g, const char* key, 
				 unsigned short *res);

/*
 * Get the value of a key within a group of the config
 * 
 * h  : the config handle
 * g  : name of the group
 * key: name of the key
 * res: the result will be stored in this variable
 *
 * returns 0 on success or -1 on failure
 */
int cfg_key_get_value_as_short (CfgHandle* h, const char* g, const char* key, 
				short *res);

/*
 * Get the value of a key within a group of the config
 * 
 * h  : the config handle
 * g  : name of the group
 * key: name of the key
 * res: the result will be stored in this variable
 *
 * returns 0 on success or -1 on failure
 */
int cfg_key_get_value_as_double (CfgHandle* h, const char* g, const char* key, 
				 double *res);

/*
 * Get the value of a key within a group of the config
 * 
 * h  : the config handle
 * g  : name of the group
 * key: name of the key
 * res: the result will be stored in this variable
 *
 * returns 0 on success or -1 on failure
 */
int cfg_key_get_value_as_float (CfgHandle* h, const char* g, const char* key, 
				float *res);

/*
 * Get the value of a key within a group of the config
 * 
 * h  : the config handle
 * g  : name of the group
 * key: name of the key
 *
 * returns the value of the key or NULL if empty
 */
const char* cfg_key_get_value (CfgHandle* h, const char* g, const char* key);

/*
 * iterators through key value pairs of a group
 * 
 * h   : the config handle
 * grp : name of the group
 * func: pointer to the function to call with each element
 *
 * returns the value of the key or NULL if empty
 */
void cfg_key_for_each (CfgHandle* h, const char* grp, cfg_key_func func);
#endif /* _CFG_IO_H */