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 void obt_xml_new_file(ObtXmlInst *i,
121 const gchar *root_node)
125 g_assert(i->doc == NULL); /* another doc isn't open already? */
127 i->doc = xmlNewDoc((xmlChar*)"1.0");
128 i->root = xmlNewDocRawNode(i->doc, NULL, (xmlChar*)root_node, NULL);
129 old = xmlDocSetRootElement(i->doc, i->root);
130 if (old) xmlFreeNode(old);
133 static gboolean load_file(ObtXmlInst *i,
135 const gchar *filename,
136 const gchar *root_node,
142 g_assert(i->doc == NULL); /* another doc isn't open already? */
144 for (it = paths; !r && it; it = g_slist_next(it)) {
148 if (!domain && !filename) /* given a full path to the file */
149 path = g_strdup(it->data);
151 path = g_build_filename(it->data, domain, filename, NULL);
153 if (stat(path, &s) >= 0) {
154 /* XML_PARSE_BLANKS is needed apparently, or the tree can end up
155 with extra nodes in it. */
156 i->doc = xmlReadFile(path, NULL, (XML_PARSE_NOBLANKS |
158 xmlXIncludeProcessFlags(i->doc, (XML_PARSE_NOBLANKS |
161 i->root = xmlDocGetRootElement(i->doc);
165 g_message("%s is an empty XML document", path);
167 else if (xmlStrcmp(i->root->name,
168 (const xmlChar*)root_node)) {
172 g_message("XML document %s is of wrong type. Root "
173 "node is not '%s'", path, root_node);
176 i->path = g_strdup(path);
188 gboolean obt_xml_load_file(ObtXmlInst *i,
190 const gchar *root_node)
195 paths = g_slist_append(NULL, g_strdup(path));
197 r = load_file(i, NULL, NULL, root_node, paths);
201 paths = g_slist_delete_link(paths, paths);
206 gboolean obt_xml_load_config_file(ObtXmlInst *i,
208 const gchar *filename,
209 const gchar *root_node)
211 GSList *it, *paths = NULL;
214 for (it = obt_paths_config_dirs(i->xdg_paths); it; it = g_slist_next(it))
215 paths = g_slist_append(paths, g_strdup(it->data));
217 r = load_file(i, domain, filename, root_node, paths);
221 paths = g_slist_delete_link(paths, paths);
226 gboolean obt_xml_load_data_file(ObtXmlInst *i,
228 const gchar *filename,
229 const gchar *root_node)
231 GSList *it, *paths = NULL;
234 for (it = obt_paths_data_dirs(i->xdg_paths); it; it = g_slist_next(it))
235 paths = g_slist_append(paths, g_strdup(it->data));
237 r = load_file(i, domain, filename, root_node, paths);
241 paths = g_slist_delete_link(paths, paths);
246 gboolean obt_xml_load_theme_file(ObtXmlInst *i,
249 const gchar *filename,
250 const gchar *root_node)
252 GSList *it, *paths = NULL;
255 /* use ~/.themes for backwards compatibility */
256 paths = g_slist_append
257 (paths, g_build_filename(g_get_home_dir(), ".themes", theme, NULL));
259 for (it = obt_paths_data_dirs(i->xdg_paths); it; it = g_slist_next(it))
260 paths = g_slist_append
261 (paths, g_build_filename(it->data, "themes", theme, NULL));
263 r = load_file(i, domain, filename, root_node, paths);
267 paths = g_slist_delete_link(paths, paths);
273 gboolean obt_xml_load_mem(ObtXmlInst *i,
274 gpointer data, guint len, const gchar *root_node)
278 g_assert(i->doc == NULL); /* another doc isn't open already? */
280 i->doc = xmlParseMemory(data, len);
282 i->root = xmlDocGetRootElement(i->doc);
286 g_message("Given memory is an empty document");
288 else if (xmlStrcmp(i->root->name, (const xmlChar*)root_node)) {
292 g_message("XML Document in given memory is of wrong "
293 "type. Root node is not '%s'\n", root_node);
301 gboolean obt_xml_save_file(ObtXmlInst *inst,
305 return xmlSaveFormatFile(path, inst->doc, pretty) != -1;
308 void obt_xml_close(ObtXmlInst *i)
319 void obt_xml_tree(ObtXmlInst *i, xmlNodePtr node)
321 g_assert(i->doc); /* a doc is open? */
325 struct Callback *c = g_hash_table_lookup(i->callbacks, node->name);
326 if (c) c->func(node, c->data);
332 void obt_xml_tree_from_root(ObtXmlInst *i)
334 obt_xml_tree(i, i->root->children);
337 gchar *obt_xml_node_string(xmlNodePtr node)
339 xmlChar *c = xmlNodeGetContent(node);
341 if (c) g_strstrip((char*)c); /* strip leading/trailing whitespace */
342 s = g_strdup(c ? (gchar*)c : "");
347 gint obt_xml_node_int(xmlNodePtr node)
349 xmlChar *c = xmlNodeGetContent(node);
351 if (c) g_strstrip((char*)c); /* strip leading/trailing whitespace */
352 i = c ? atoi((gchar*)c) : 0;
357 gboolean obt_xml_node_bool(xmlNodePtr node)
359 xmlChar *c = xmlNodeGetContent(node);
361 if (c) g_strstrip((char*)c); /* strip leading/trailing whitespace */
362 if (c && !xmlStrcasecmp(c, (const xmlChar*) "true"))
364 else if (c && !xmlStrcasecmp(c, (const xmlChar*) "yes"))
366 else if (c && !xmlStrcasecmp(c, (const xmlChar*) "on"))
372 gboolean obt_xml_node_contains(xmlNodePtr node, const gchar *val)
374 xmlChar *c = xmlNodeGetContent(node);
376 if (c) g_strstrip((char*)c); /* strip leading/trailing whitespace */
377 r = !xmlStrcasecmp(c, (const xmlChar*) val);
382 xmlNodePtr obt_xml_find_sibling(xmlNodePtr node, const gchar *tag)
385 if (!xmlStrcmp(node->name, (const xmlChar*) tag))
392 gboolean obt_xml_attr_bool(xmlNodePtr node, const gchar *name,
395 xmlChar *c = xmlGetProp(node, (const xmlChar*) name);
398 g_strstrip((char*)c); /* strip leading/trailing whitespace */
399 if (!xmlStrcasecmp(c, (const xmlChar*) "true"))
400 *value = TRUE, r = TRUE;
401 else if (!xmlStrcasecmp(c, (const xmlChar*) "yes"))
402 *value = TRUE, r = TRUE;
403 else if (!xmlStrcasecmp(c, (const xmlChar*) "on"))
404 *value = TRUE, r = TRUE;
405 else if (!xmlStrcasecmp(c, (const xmlChar*) "false"))
406 *value = FALSE, r = TRUE;
407 else if (!xmlStrcasecmp(c, (const xmlChar*) "no"))
408 *value = FALSE, r = TRUE;
409 else if (!xmlStrcasecmp(c, (const xmlChar*) "off"))
410 *value = FALSE, r = TRUE;
416 gboolean obt_xml_attr_int(xmlNodePtr node, const gchar *name, gint *value)
418 xmlChar *c = xmlGetProp(node, (const xmlChar*) name);
421 g_strstrip((char*)c); /* strip leading/trailing whitespace */
422 *value = atoi((gchar*)c);
429 gboolean obt_xml_attr_string(xmlNodePtr node, const gchar *name,
432 xmlChar *c = xmlGetProp(node, (const xmlChar*) name);
435 g_strstrip((char*)c); /* strip leading/trailing whitespace */
436 *value = g_strdup((gchar*)c);
443 gboolean obt_xml_attr_contains(xmlNodePtr node, const gchar *name,
446 xmlChar *c = xmlGetProp(node, (const xmlChar*) name);
449 g_strstrip((char*)c); /* strip leading/trailing whitespace */
450 r = !xmlStrcasecmp(c, (const xmlChar*) val);
456 xmlNodePtr obt_xml_path_get_node(xmlNodePtr subtree, const gchar *path,
457 const gchar *default_value)
463 g_return_val_if_fail(subtree != NULL, NULL);
467 nodes = g_strsplit(path, "/", 0);
468 for (it = nodes; *it; it = next) {
472 attrs = g_strsplit(*it, ":", 0);
475 /* match attributes */
476 c = obt_xml_find_sibling(n->children, attrs[0]);
481 for (i = 1; attrs[i]; ++i) {
482 gchar **eq = g_strsplit(attrs[i], "=", 2);
483 if (eq[1] && !obt_xml_attr_contains(c, eq[0], eq[1]))
488 c = obt_xml_find_sibling(c->next, attrs[0]);
494 c = xmlNewTextChild(n, NULL, (xmlChar*)attrs[0],
495 *next ? NULL : (xmlChar*)default_value);
497 for (i = 1; attrs[i]; ++i) {
498 gchar **eq = g_strsplit(attrs[i], "=", 2);
500 xmlNewProp(c, (xmlChar*)eq[0], (xmlChar*)eq[1]);
514 void obt_xml_path_delete_node(xmlNodePtr subtree, const gchar *path)
518 n = obt_xml_path_get_node(subtree, path, NULL);