2 parse.c : irssi configuration - parse configuration file
4 Copyright (C) 1999 Timo Sirainen
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 static int g_istr_equal(gconstpointer v, gconstpointer v2)
25 return g_strcasecmp((const char *) v, (const char *) v2) == 0;
28 /* a char* hash function from ASU */
29 static unsigned int g_istr_hash(gconstpointer v)
31 const char *s = (const char *) v;
32 unsigned int h = 0, g;
35 h = (h << 4) + i_toupper(*s);
36 if ((g = h & 0xf0000000UL)) {
46 int config_error(CONFIG_REC *rec, const char *msg)
48 g_free_and_null(rec->last_error);
49 rec->last_error = g_strdup(msg);
53 static int node_add_comment(CONFIG_NODE *parent, const char *str)
57 g_return_val_if_fail(parent != NULL, -1);
59 if (!is_node_list(parent))
62 node = g_new0(CONFIG_NODE, 1);
63 node->type = NODE_TYPE_COMMENT;
64 node->value = str == NULL ? NULL : g_strdup(str);
66 parent->value = g_slist_append(parent->value, node);
70 /* same as g_scanner_get_next_token() except skips and reads the comments */
71 static void config_parse_get_token(GScanner *scanner, CONFIG_NODE *node)
73 int prev_empty = FALSE;
76 g_scanner_get_next_token(scanner);
78 if (scanner->token == G_TOKEN_COMMENT_SINGLE)
79 node_add_comment(node, scanner->value.v_string);
80 else if (scanner->token == '\n') {
81 if (prev_empty) node_add_comment(node, NULL);
83 if (scanner->token == G_TOKEN_INT) {
84 scanner->token = G_TOKEN_STRING;
85 scanner->value.v_string = g_strdup_printf("%lu", scanner->value.v_int);
94 /* same as g_scanner_peek_next_token() except skips and reads the comments */
95 static void config_parse_peek_token(GScanner *scanner, CONFIG_NODE *node)
97 int prev_empty = FALSE;
100 g_scanner_peek_next_token(scanner);
102 if (scanner->next_token == G_TOKEN_COMMENT_SINGLE)
103 node_add_comment(node, scanner->next_value.v_string);
104 else if (scanner->next_token == '\n') {
105 if (prev_empty) node_add_comment(node, NULL);
110 g_scanner_get_next_token(scanner);
114 /* get optional token, optionally warn if it's missing */
115 static void config_parse_warn_missing(CONFIG_REC *rec, CONFIG_NODE *node,
116 GTokenType expected_token, int print_warning)
118 config_parse_peek_token(rec->scanner, node);
119 if (rec->scanner->next_token == expected_token) {
120 g_scanner_get_next_token(rec->scanner);
125 g_scanner_warn(rec->scanner, "Warning: missing '%c'", expected_token);
128 static void config_parse_loop(CONFIG_REC *rec, CONFIG_NODE *node, GTokenType expect);
130 static GTokenType config_parse_symbol(CONFIG_REC *rec, CONFIG_NODE *node)
132 CONFIG_NODE *newnode;
133 GTokenType last_char;
137 g_return_val_if_fail(rec != NULL, G_TOKEN_ERROR);
138 g_return_val_if_fail(node != NULL, G_TOKEN_ERROR);
140 config_parse_get_token(rec->scanner, node);
142 last_char = (GTokenType) (node->type == NODE_TYPE_LIST ? ',' : ';');
146 if (node->type != NODE_TYPE_LIST &&
147 (rec->scanner->token == G_TOKEN_STRING)) {
148 key = g_strdup(rec->scanner->value.v_string);
150 config_parse_warn_missing(rec, node, '=', TRUE);
151 config_parse_get_token(rec->scanner, node);
154 switch (rec->scanner->token) {
157 config_node_set_str(rec, node, key, rec->scanner->value.v_string);
158 g_free_not_null(key);
160 print_warning = TRUE;
161 if (node->type == NODE_TYPE_LIST) {
162 /* if it's last item it doesn't need comma */
163 config_parse_peek_token(rec->scanner, node);
164 if (rec->scanner->next_token == ')')
165 print_warning = FALSE;
168 config_parse_warn_missing(rec, node, last_char, print_warning);
173 if (key == NULL && node->type != NODE_TYPE_LIST)
174 return G_TOKEN_ERROR;
176 newnode = config_node_section(node, key, NODE_TYPE_BLOCK);
177 config_parse_loop(rec, newnode, (GTokenType) '}');
178 g_free_not_null(key);
180 config_parse_get_token(rec->scanner, node);
181 if (rec->scanner->token != '}')
182 return (GTokenType) '}';
184 config_parse_warn_missing(rec, node, last_char, FALSE);
190 return G_TOKEN_ERROR;
191 newnode = config_node_section(node, key, NODE_TYPE_LIST);
192 config_parse_loop(rec, newnode, (GTokenType) ')');
193 g_free_not_null(key);
195 config_parse_get_token(rec->scanner, node);
196 if (rec->scanner->token != ')')
197 return (GTokenType) ')';
199 config_parse_warn_missing(rec, node, last_char, FALSE);
204 g_free_not_null(key);
205 return G_TOKEN_STRING;
211 static void config_parse_loop(CONFIG_REC *rec, CONFIG_NODE *node, GTokenType expect)
213 GTokenType expected_token;
215 g_return_if_fail(rec != NULL);
216 g_return_if_fail(node != NULL);
219 config_parse_peek_token(rec->scanner, node);
220 if (rec->scanner->next_token == expect ||
221 rec->scanner->next_token == G_TOKEN_EOF) break;
223 expected_token = config_parse_symbol(rec, node);
224 if (expected_token != G_TOKEN_NONE) {
225 if (expected_token == G_TOKEN_ERROR)
226 expected_token = G_TOKEN_NONE;
227 g_scanner_unexp_token(rec->scanner, expected_token, NULL, "symbol", NULL, NULL, TRUE);
232 static void config_parse_error_func(GScanner *scanner, char *message, int is_error)
234 CONFIG_REC *rec = scanner->user_data;
237 old = rec->last_error;
238 rec->last_error = g_strdup_printf("%s%s:%d: %s%s\n",
239 old == NULL ? "" : old,
240 scanner->input_name, scanner->line,
241 is_error ? "error: " : "",
243 g_free_not_null(old);
246 void config_parse_init(CONFIG_REC *rec, const char *name)
250 g_free_and_null(rec->last_error);
251 config_nodes_remove_all(rec);
253 rec->scanner = scanner = g_scanner_new(NULL);
254 scanner->config->skip_comment_single = FALSE;
255 scanner->config->cset_identifier_first = G_CSET_a_2_z"_0123456789"G_CSET_A_2_Z;
256 scanner->config->cset_skip_characters = " \t";
257 scanner->config->scan_binary = FALSE;
258 scanner->config->scan_octal = FALSE;
259 scanner->config->scan_float = FALSE;
260 scanner->config->scan_string_sq = TRUE;
261 scanner->config->scan_string_dq = TRUE;
262 scanner->config->scan_identifier_1char = TRUE;
263 scanner->config->identifier_2_string = TRUE;
265 scanner->user_data = rec;
266 scanner->input_name = name;
267 scanner->msg_handler = (GScannerMsgFunc) config_parse_error_func;
270 /* Parse configuration file */
271 int config_parse(CONFIG_REC *rec)
273 g_return_val_if_fail(rec != NULL, -1);
274 g_return_val_if_fail(rec->fname != NULL, -1);
276 rec->handle = open(rec->fname, O_RDONLY);
277 if (rec->handle == -1)
278 return config_error(rec, g_strerror(errno));
280 config_parse_init(rec, rec->fname);
281 g_scanner_input_file(rec->scanner, rec->handle);
282 config_parse_loop(rec, rec->mainnode, G_TOKEN_EOF);
283 g_scanner_destroy(rec->scanner);
288 return rec->last_error == NULL ? 0 : -1;
291 /* Parse configuration found from `data'. `input_name' is specifies the
292 "configuration name" which is displayed in error messages. */
293 int config_parse_data(CONFIG_REC *rec, const char *data, const char *input_name)
295 config_parse_init(rec, input_name);
296 g_scanner_input_text(rec->scanner, data, strlen(data));
297 config_parse_loop(rec, rec->mainnode, G_TOKEN_EOF);
298 g_scanner_destroy(rec->scanner);
300 return rec->last_error == NULL ? 0 : -1;
303 /* Open configuration. The file is created if it doesn't exist, unless
304 `create_mode' is -1. `fname' can be NULL if you just want to use
305 config_parse_data() */
306 CONFIG_REC *config_open(const char *fname, int create_mode)
312 f = open(fname, O_RDONLY | (create_mode != -1 ? O_CREAT : 0), create_mode);
313 if (f == -1) return NULL;
317 rec = g_new0(CONFIG_REC, 1);
318 rec->fname = fname == NULL ? NULL : g_strdup(fname);
320 rec->create_mode = create_mode;
321 rec->mainnode = g_new0(CONFIG_NODE, 1);
322 rec->mainnode->type = NODE_TYPE_BLOCK;
323 rec->cache = g_hash_table_new((GHashFunc) g_istr_hash, (GCompareFunc) g_istr_equal);
324 rec->cache_nodes = g_hash_table_new((GHashFunc) g_direct_hash, (GCompareFunc) g_direct_equal);
329 /* Release all memory used by configuration */
330 void config_close(CONFIG_REC *rec)
332 g_return_if_fail(rec != NULL);
334 config_nodes_remove_all(rec);
335 g_free(rec->mainnode);
337 if (rec->handle != -1) close(rec->handle);
338 g_hash_table_foreach(rec->cache, (GHFunc) g_free, NULL);
339 g_hash_table_destroy(rec->cache);
340 g_hash_table_destroy(rec->cache_nodes);
341 g_free_not_null(rec->last_error);
342 g_free_not_null(rec->fname);
346 /* Change file name of config file */
347 void config_change_file_name(CONFIG_REC *rec, const char *fname, int create_mode)
349 g_return_if_fail(rec != NULL);
350 g_return_if_fail(fname != NULL);
352 g_free_not_null(rec->fname);
353 rec->fname = g_strdup(fname);
355 if (create_mode != -1)
356 rec->create_mode = create_mode;