1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
3 obt/xml.c for the Openbox window manager
4 Copyright (c) 2003-2007 Dana Jansens
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 See the COPYING file for a copy of the GNU General Public License.
20 #include "obt/paths.h"
22 #include <libxml/xinclude.h>
28 #ifdef HAVE_SYS_STAT_H
29 # include <sys/stat.h>
31 #ifdef HAVE_SYS_TYPES_H
32 # include <sys/types.h>
47 GHashTable *callbacks;
53 static void destfunc(struct Callback *c)
56 g_slice_free(struct Callback, c);
59 ObtXmlInst* obt_xml_instance_new(void)
61 ObtXmlInst *i = g_slice_new(ObtXmlInst);
63 i->xdg_paths = obt_paths_new();
64 i->callbacks = g_hash_table_new_full(g_str_hash, g_str_equal, NULL,
65 (GDestroyNotify)destfunc);
72 void obt_xml_instance_ref(ObtXmlInst *i)
77 void obt_xml_instance_unref(ObtXmlInst *i)
79 if (i && --i->ref == 0) {
80 obt_paths_unref(i->xdg_paths);
81 g_hash_table_destroy(i->callbacks);
82 g_slice_free(ObtXmlInst, i);
86 xmlDocPtr obt_xml_doc(ObtXmlInst *i)
88 g_assert(i->doc); /* a doc is open? */
92 xmlNodePtr obt_xml_root(ObtXmlInst *i)
94 g_assert(i->doc); /* a doc is open? */
98 void obt_xml_register(ObtXmlInst *i, const gchar *tag,
99 ObtXmlCallback func, gpointer data)
103 if (g_hash_table_lookup(i->callbacks, tag)) {
104 g_error("Tag '%s' already registered", tag);
108 c = g_slice_new(struct Callback);
109 c->tag = g_strdup(tag);
112 g_hash_table_insert(i->callbacks, c->tag, c);
115 void obt_xml_unregister(ObtXmlInst *i, const gchar *tag)
117 g_hash_table_remove(i->callbacks, tag);
120 static gboolean load_file(ObtXmlInst *i,
122 const gchar *filename,
123 const gchar *root_node,
129 g_assert(i->doc == NULL); /* another doc isn't open already? */
131 for (it = paths; !r && it; it = g_slist_next(it)) {
135 if (!domain && !filename) /* given a full path to the file */
136 path = g_strdup(it->data);
138 path = g_build_filename(it->data, domain, filename, NULL);
140 if (stat(path, &s) >= 0) {
141 /* XML_PARSE_BLANKS is needed apparently, or the tree can end up
142 with extra nodes in it. */
143 i->doc = xmlReadFile(path, NULL, (XML_PARSE_NOBLANKS |
145 xmlXIncludeProcessFlags(i->doc, (XML_PARSE_NOBLANKS |
148 i->root = xmlDocGetRootElement(i->doc);
152 g_message("%s is an empty XML document", path);
154 else if (xmlStrcmp(i->root->name,
155 (const xmlChar*)root_node)) {
159 g_message("XML document %s is of wrong type. Root "
160 "node is not '%s'", path, root_node);
163 i->path = g_strdup(path);
175 gboolean obt_xml_load_file(ObtXmlInst *i,
177 const gchar *root_node)
182 paths = g_slist_append(NULL, g_strdup(path));
184 r = load_file(i, NULL, NULL, root_node, paths);
188 paths = g_slist_delete_link(paths, paths);
193 gboolean obt_xml_load_config_file(ObtXmlInst *i,
195 const gchar *filename,
196 const gchar *root_node)
198 GSList *it, *paths = NULL;
201 for (it = obt_paths_config_dirs(i->xdg_paths); it; it = g_slist_next(it))
202 paths = g_slist_append(paths, g_strdup(it->data));
204 r = load_file(i, domain, filename, root_node, paths);
208 paths = g_slist_delete_link(paths, paths);
213 gboolean obt_xml_load_data_file(ObtXmlInst *i,
215 const gchar *filename,
216 const gchar *root_node)
218 GSList *it, *paths = NULL;
221 for (it = obt_paths_data_dirs(i->xdg_paths); it; it = g_slist_next(it))
222 paths = g_slist_append(paths, g_strdup(it->data));
224 r = load_file(i, domain, filename, root_node, paths);
228 paths = g_slist_delete_link(paths, paths);
233 gboolean obt_xml_load_theme_file(ObtXmlInst *i,
236 const gchar *filename,
237 const gchar *root_node)
239 GSList *it, *paths = NULL;
242 /* use ~/.themes for backwards compatibility */
243 paths = g_slist_append
244 (paths, g_build_filename(g_get_home_dir(), ".themes", theme, NULL));
246 for (it = obt_paths_data_dirs(i->xdg_paths); it; it = g_slist_next(it))
247 paths = g_slist_append
248 (paths, g_build_filename(it->data, "themes", theme, NULL));
250 r = load_file(i, domain, filename, root_node, paths);
254 paths = g_slist_delete_link(paths, paths);
260 gboolean obt_xml_load_mem(ObtXmlInst *i,
261 gpointer data, guint len, const gchar *root_node)
265 g_assert(i->doc == NULL); /* another doc isn't open already? */
267 i->doc = xmlParseMemory(data, len);
269 i->root = xmlDocGetRootElement(i->doc);
273 g_message("Given memory is an empty document");
275 else if (xmlStrcmp(i->root->name, (const xmlChar*)root_node)) {
279 g_message("XML Document in given memory is of wrong "
280 "type. Root node is not '%s'\n", root_node);
288 gboolean obt_xml_save_file(ObtXmlInst *inst,
292 return xmlSaveFormatFile(path, inst->doc, pretty) != -1;
295 void obt_xml_close(ObtXmlInst *i)
306 void obt_xml_tree(ObtXmlInst *i, xmlNodePtr node)
308 g_assert(i->doc); /* a doc is open? */
312 struct Callback *c = g_hash_table_lookup(i->callbacks, node->name);
313 if (c) c->func(node, c->data);
319 void obt_xml_tree_from_root(ObtXmlInst *i)
321 obt_xml_tree(i, i->root->children);
324 gchar *obt_xml_node_string_unstripped(xmlNodePtr node)
326 xmlChar *c = xmlNodeGetContent(node);
328 s = g_strdup(c ? (gchar*)c : "");
333 gchar *obt_xml_node_string(xmlNodePtr node)
335 gchar* result = obt_xml_node_string_unstripped(node);
336 g_strstrip(result); /* strip leading/trailing whitespace */
340 gint obt_xml_node_int(xmlNodePtr node)
342 xmlChar *c = xmlNodeGetContent(node);
344 if (c) g_strstrip((char*)c); /* strip leading/trailing whitespace */
345 i = c ? atoi((gchar*)c) : 0;
350 gboolean obt_xml_node_bool(xmlNodePtr node)
352 xmlChar *c = xmlNodeGetContent(node);
354 if (c) g_strstrip((char*)c); /* strip leading/trailing whitespace */
355 if (c && !xmlStrcasecmp(c, (const xmlChar*) "true"))
357 else if (c && !xmlStrcasecmp(c, (const xmlChar*) "yes"))
359 else if (c && !xmlStrcasecmp(c, (const xmlChar*) "on"))
365 gboolean obt_xml_node_contains(xmlNodePtr node, const gchar *val)
367 xmlChar *c = xmlNodeGetContent(node);
369 if (c) g_strstrip((char*)c); /* strip leading/trailing whitespace */
370 r = !xmlStrcasecmp(c, (const xmlChar*) val);
375 xmlNodePtr obt_xml_find_node(xmlNodePtr node, const gchar *tag)
378 if (!xmlStrcmp(node->name, (const xmlChar*) tag))
385 gboolean obt_xml_attr_bool(xmlNodePtr node, const gchar *name,
388 xmlChar *c = xmlGetProp(node, (const xmlChar*) name);
391 g_strstrip((char*)c); /* strip leading/trailing whitespace */
392 if (!xmlStrcasecmp(c, (const xmlChar*) "true"))
393 *value = TRUE, r = TRUE;
394 else if (!xmlStrcasecmp(c, (const xmlChar*) "yes"))
395 *value = TRUE, r = TRUE;
396 else if (!xmlStrcasecmp(c, (const xmlChar*) "on"))
397 *value = TRUE, r = TRUE;
398 else if (!xmlStrcasecmp(c, (const xmlChar*) "false"))
399 *value = FALSE, r = TRUE;
400 else if (!xmlStrcasecmp(c, (const xmlChar*) "no"))
401 *value = FALSE, r = TRUE;
402 else if (!xmlStrcasecmp(c, (const xmlChar*) "off"))
403 *value = FALSE, r = TRUE;
409 gboolean obt_xml_attr_int(xmlNodePtr node, const gchar *name, gint *value)
411 xmlChar *c = xmlGetProp(node, (const xmlChar*) name);
414 g_strstrip((char*)c); /* strip leading/trailing whitespace */
415 *value = atoi((gchar*)c);
422 gboolean obt_xml_attr_string_unstripped(xmlNodePtr node, const gchar *name,
425 xmlChar *c = xmlGetProp(node, (const xmlChar*) name);
428 *value = g_strdup((gchar*)c);
435 gboolean obt_xml_attr_string(xmlNodePtr node, const gchar *name,
438 gboolean result = obt_xml_attr_string_unstripped(node, name, value);
440 g_strstrip(*value); /* strip leading/trailing whitespace */
444 gboolean obt_xml_attr_contains(xmlNodePtr node, const gchar *name,
447 xmlChar *c = xmlGetProp(node, (const xmlChar*) name);
450 g_strstrip((char*)c); /* strip leading/trailing whitespace */
451 r = !xmlStrcasecmp(c, (const xmlChar*) val);