Mercurial > hg > th-libs
annotate th_config.h @ 622:6d99150a8f89
Some more slight Doxygenisation.
author | Matti Hamalainen <ccr@tnsp.org> |
---|---|
date | Fri, 17 Jan 2020 04:16:32 +0200 |
parents | e789accfca87 |
children | 893b2deeb5be |
rev | line source |
---|---|
0
bd61a80a6c54
Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
1 /* |
10 | 2 * Very simple configuration file handling |
0
bd61a80a6c54
Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
3 * Programmed and designed by Matti 'ccr' Hamalainen |
553 | 4 * (C) Copyright 2004-2020 Tecnic Software productions (TNSP) |
0
bd61a80a6c54
Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
5 * |
bd61a80a6c54
Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
6 * Please read file 'COPYING' for information on license and distribution. |
bd61a80a6c54
Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
7 */ |
622
6d99150a8f89
Some more slight Doxygenisation.
Matti Hamalainen <ccr@tnsp.org>
parents:
604
diff
changeset
|
8 /// @file |
6d99150a8f89
Some more slight Doxygenisation.
Matti Hamalainen <ccr@tnsp.org>
parents:
604
diff
changeset
|
9 /// @brief Configuration file handling functionality. |
49
598609fb49b0
Change how "config.h" is included, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
22
diff
changeset
|
10 #ifndef TH_CONFIG_H |
598609fb49b0
Change how "config.h" is included, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
22
diff
changeset
|
11 #define TH_CONFIG_H |
0
bd61a80a6c54
Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
12 |
155
23a79bd6c9d6
Use th_llist for th_config module as well instead of duped linked list
Matti Hamalainen <ccr@tnsp.org>
parents:
153
diff
changeset
|
13 #include "th_util.h" |
270
6cfa9bc91ee6
Remember to include th_datastruct.h where needed.
Matti Hamalainen <ccr@tnsp.org>
parents:
203
diff
changeset
|
14 #include "th_datastruct.h" |
153
4cd94649475d
Move header includes before C++ guard.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
15 #include "th_ioctx.h" |
4cd94649475d
Move header includes before C++ guard.
Matti Hamalainen <ccr@tnsp.org>
parents:
152
diff
changeset
|
16 |
0
bd61a80a6c54
Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
17 #ifdef __cplusplus |
bd61a80a6c54
Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
18 extern "C" { |
bd61a80a6c54
Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
19 #endif |
bd61a80a6c54
Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
20 |
604 | 21 // |
22 // Definitions | |
23 // | |
69 | 24 enum ITEM_TYPE |
25 { | |
16 | 26 ITEM_SECTION = 1, |
11 | 27 ITEM_COMMENT, |
496
8c837a33cfb6
Add argument names to some function prototypes.
Matti Hamalainen <ccr@tnsp.org>
parents:
457
diff
changeset
|
28 |
10 | 29 ITEM_STRING, |
30 ITEM_INT, | |
31 ITEM_UINT, | |
457
85fa3d333556
Actually, revert the boolean changes .. meh.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
32 ITEM_BOOL, |
11 | 33 ITEM_FLOAT, |
16 | 34 ITEM_HEX_TRIPLET, |
35 | |
36 ITEM_STRING_LIST, | |
37 ITEM_HEX_TRIPLET_LIST | |
0
bd61a80a6c54
Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
38 }; |
bd61a80a6c54
Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
39 |
bd61a80a6c54
Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
40 |
70
a0e1b29be35d
Refactor configuration file handling module rather thoroughly. The API is
Matti Hamalainen <ccr@tnsp.org>
parents:
69
diff
changeset
|
41 typedef struct _th_cfgitem_t |
a0e1b29be35d
Refactor configuration file handling module rather thoroughly. The API is
Matti Hamalainen <ccr@tnsp.org>
parents:
69
diff
changeset
|
42 { |
500
25fc4ab342d3
Add a comment about struct aliasing.
Matti Hamalainen <ccr@tnsp.org>
parents:
499
diff
changeset
|
43 // th_llist_t must be the first item, as this |
25fc4ab342d3
Add a comment about struct aliasing.
Matti Hamalainen <ccr@tnsp.org>
parents:
499
diff
changeset
|
44 // is used to alias th_cfgitem_t to llist nodes |
155
23a79bd6c9d6
Use th_llist for th_config module as well instead of duped linked list
Matti Hamalainen <ccr@tnsp.org>
parents:
153
diff
changeset
|
45 th_llist_t node; |
23a79bd6c9d6
Use th_llist for th_config module as well instead of duped linked list
Matti Hamalainen <ccr@tnsp.org>
parents:
153
diff
changeset
|
46 |
15 | 47 int type; |
11 | 48 char *name; |
15 | 49 union { |
50 int *val_int; | |
51 unsigned int *val_uint; | |
16 | 52 char **val_str; |
457
85fa3d333556
Actually, revert the boolean changes .. meh.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
53 BOOL *val_bool; |
172
eb2c073d93b3
Adding floating point configuration item support.
Matti Hamalainen <ccr@tnsp.org>
parents:
170
diff
changeset
|
54 float *val_float; |
16 | 55 |
56 void *data; | |
152
b4e1b15a64e1
Rename qlist_t doubly linked list structure to th_llist_t.
Matti Hamalainen <ccr@tnsp.org>
parents:
144
diff
changeset
|
57 th_llist_t **list; |
70
a0e1b29be35d
Refactor configuration file handling module rather thoroughly. The API is
Matti Hamalainen <ccr@tnsp.org>
parents:
69
diff
changeset
|
58 struct _th_cfgitem_t *section; |
22
1ac2449c4df7
ISO C99 compatibility fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
16
diff
changeset
|
59 } v; |
70
a0e1b29be35d
Refactor configuration file handling module rather thoroughly. The API is
Matti Hamalainen <ccr@tnsp.org>
parents:
69
diff
changeset
|
60 } th_cfgitem_t; |
0
bd61a80a6c54
Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
61 |
bd61a80a6c54
Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
62 |
604 | 63 // |
64 // Functions | |
65 // | |
499 | 66 int th_cfg_read(th_ioctx *fh, th_cfgitem_t *cfg /*, TODO XXX const int flags (for controlling things like "error out on unknown items or ignore" etc */); |
496
8c837a33cfb6
Add argument names to some function prototypes.
Matti Hamalainen <ccr@tnsp.org>
parents:
457
diff
changeset
|
67 void th_cfg_free(th_cfgitem_t *cfg); |
499 | 68 int th_cfg_write(th_ioctx *fh, const th_cfgitem_t *cfg); |
70
a0e1b29be35d
Refactor configuration file handling module rather thoroughly. The API is
Matti Hamalainen <ccr@tnsp.org>
parents:
69
diff
changeset
|
69 |
a0e1b29be35d
Refactor configuration file handling module rather thoroughly. The API is
Matti Hamalainen <ccr@tnsp.org>
parents:
69
diff
changeset
|
70 int th_cfg_add_comment(th_cfgitem_t **cfg, const char *comment); |
499 | 71 int th_cfg_add_section(th_cfgitem_t **cfg, const char *name, th_cfgitem_t *sect); |
0
bd61a80a6c54
Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
72 |
170 | 73 int th_cfg_add_int(th_cfgitem_t **cfg, const char *name, int *data, int defValue); |
74 int th_cfg_add_uint(th_cfgitem_t **cfg, const char *name, unsigned int *data, unsigned int defValue); | |
75 int th_cfg_add_float(th_cfgitem_t **cfg, const char *name, float *data, float defValue); | |
76 int th_cfg_add_string(th_cfgitem_t **cfg, const char *name, char **data, char *defValue); | |
457
85fa3d333556
Actually, revert the boolean changes .. meh.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
77 int th_cfg_add_bool(th_cfgitem_t **cfg, const char *name, BOOL *data, BOOL defValue); |
170 | 78 int th_cfg_add_float(th_cfgitem_t **cfg, const char *name, float *data, float defValue); |
498
1dbd9259c3b8
Change hexvalue type to unsigned.
Matti Hamalainen <ccr@tnsp.org>
parents:
496
diff
changeset
|
79 int th_cfg_add_hexvalue(th_cfgitem_t **cfg, const char *name, unsigned int *data, unsigned int defValue); |
152
b4e1b15a64e1
Rename qlist_t doubly linked list structure to th_llist_t.
Matti Hamalainen <ccr@tnsp.org>
parents:
144
diff
changeset
|
80 int th_cfg_add_string_list(th_cfgitem_t **cfg, const char *name, th_llist_t **list); |
15 | 81 |
83
50006067bcd1
Add new function, th_cfg_find().
Matti Hamalainen <ccr@tnsp.org>
parents:
70
diff
changeset
|
82 th_cfgitem_t *th_cfg_find(th_cfgitem_t *cfg, const char *section, const char *name, const int type); |
0
bd61a80a6c54
Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
83 |
bd61a80a6c54
Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
84 #ifdef __cplusplus |
bd61a80a6c54
Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
85 } |
bd61a80a6c54
Initial import into Mercurial repository. Discarding old cvs/svn history
Matti Hamalainen <ccr@tnsp.org>
parents:
diff
changeset
|
86 #endif |
129 | 87 #endif // TH_CONFIG_H |