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
|
#include "hashmap.h"
#include <stdbool.h>
#include <stdint.h>
struct commands;
/**
* The type of setting value.
*/
enum setting_type {
/** String setting. */
Setting_String = 0,
/** Number setting (a signed 64 bit integer). */
Setting_Number,
/** Boolean setting. */
Setting_Bool,
};
/**
* Value for a setting.
*/
struct setting_value {
/** Type of setting. */
enum setting_type type;
union {
/** String setting. */
char *string_value;
/** Real number setting. */
int64_t number_value;
/** Boolean setting value. */
bool bool_value;
};
};
/**
* A single setting.
*
* A setting has a "path", denoted by a string
* containing a number (0-) of dots.
* Example: editor.tab-width.
*/
struct setting {
/** Path of the setting. */
char path[128];
/** Value of the setting. */
struct setting_value value;
};
HASHMAP_ENTRY_TYPE(setting_entry, struct setting);
/**
* A collection of settings.
*/
struct settings {
HASHMAP(struct setting_entry) settings;
};
/**
* Initialize the global collection of settings.
*
* @param initial_capacity Initial capacity of the settings collection.
* @returns Nothing, the settings collection is a global instance.
*/
void settings_init(uint32_t initial_capacity);
/**
* Destroy the global collection of settings.
*/
void settings_destroy();
/**
* Register a new setting.
*
* @param path The path of the new setting on
* the form <category>.<sub-category>.<setting-name>.
* @param default_value The default value for the setting.
* All settings are required to declare a default value.
*/
void settings_register_setting(const char *path,
struct setting_value default_value);
/**
* Retrieve a single setting by path.
*
* @param path The exact path of the setting on
* the form <category>.<sub-category>.<setting-name>.
* @returns A pointer to the setting if found, NULL otherwise.
*/
struct setting *settings_get(const char *path);
/**
* Retrieve a collection of settings by prefix
*
* @param prefix Path prefix for the settings to retrieve.
* @param settings_out Pointer to an array that will be modified to point to the
* result.
* @param nsettings_out Pointer to an integer that will be set to the number of
* settings pointers in the result.
*/
void settings_get_prefix(const char *prefix, struct setting **settings_out[],
uint32_t *nsettings_out);
/**
* Set a value for a setting.
*
* @param path The exact path of the setting on
* the form <category>.<sub-category>.<setting-name>.
* @param value The new value of the setting. The type has to match the declared
* type for the setting. If not, the new value is ignored.
*/
void settings_set(const char *path, struct setting_value value);
/**
* Set a value for a setting.
*
* @param setting Pointer to a setting to set.
* @param value The new value of the setting. The type has to match the declared
* type for the setting. If not, the new value is ignored.
*/
void setting_set_value(struct setting *setting, struct setting_value val);
/**
* Create a string representation for a setting.
*
* @param setting Pointer to a setting to turn into a string.
* @param buf Character buffer to store resulting string in.
* @param n Size in bytes of @ref buf.
*/
void setting_to_string(struct setting *setting, char *buf, size_t n);
/**
* Parse settings from a string in TOML format.
*
* @param toml Pointer to a NULL-terminated string containing TOML settings.
* @param errmsgs Pointer to a string array where error messages will be placed.
* These messages must be freed after use.
* @returns 0 on success, n > 0 where n denotes the number of error messages in
* @ref errmsgs
*/
int32_t settings_from_string(const char *toml, char **errmsgs[]);
/**
* Parse settings from a file in TOML format.
*
* @param toml Pointer to a NULL-terminated string describing a path to a TOML
* file with settings.
* @param errmsgs Pointer to a string array where error messages will be placed.
* These messages must be freed after use.
* @returns 0 on success, n > 0 where n denotes the number of error messages in
* @ref errmsgs
*/
int32_t settings_from_file(const char *path, char **errmsgs[]);
|
