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"
27 #ifdef HAVE_SYS_STAT_H
28 # include <sys/stat.h>
30 #ifdef HAVE_SYS_TYPES_H
31 # include <sys/types.h>
46 GHashTable *callbacks;
52 static void destfunc(struct Callback *c)
55 g_slice_free(struct Callback, c);
58 ObtXmlInst* obt_xml_instance_new(void)
60 ObtXmlInst *i = g_slice_new(ObtXmlInst);
62 i->xdg_paths = obt_paths_new();
63 i->callbacks = g_hash_table_new_full(g_str_hash, g_str_equal, NULL,
64 (GDestroyNotify)destfunc);
71 void obt_xml_instance_ref(ObtXmlInst *i)
76 void obt_xml_instance_unref(ObtXmlInst *i)
78 if (i && --i->ref == 0) {
79 obt_paths_unref(i->xdg_paths);
80 g_hash_table_destroy(i->callbacks);
81 g_slice_free(ObtXmlInst, i);
85 xmlDocPtr obt_xml_doc(ObtXmlInst *i)
87 g_assert(i->doc); /* a doc is open? */
91 xmlNodePtr obt_xml_root(ObtXmlInst *i)
93 g_assert(i->doc); /* a doc is open? */
97 void obt_xml_register(ObtXmlInst *i, const gchar *tag,
98 ObtXmlCallback func, gpointer data)
102 if (g_hash_table_lookup(i->callbacks, tag)) {
103 g_error("Tag '%s' already registered", tag);
107 c = g_slice_new(struct Callback);
108 c->tag = g_strdup(tag);
111 g_hash_table_insert(i->callbacks, c->tag, c);
114 static gboolean load_file(ObtXmlInst *i,
116 const gchar *filename,
117 const gchar *root_node,
123 g_assert(i->doc == NULL); /* another doc isn't open already? */
125 for (it = paths; !r && it; it = g_slist_next(it)) {
129 if (!domain && !filename) /* given a full path to the file */
130 path = g_strdup(it->data);
132 path = g_build_filename(it->data, domain, filename, NULL);
134 if (stat(path, &s) >= 0) {
135 /* XML_PARSE_BLANKS is needed apparently, or the tree can end up
136 with extra nodes in it. */
137 i->doc = xmlReadFile(path, NULL, (XML_PARSE_NOBLANKS |
140 i->root = xmlDocGetRootElement(i->doc);
144 g_message("%s is an empty XML document", path);
146 else if (xmlStrcmp(i->root->name,
147 (const xmlChar*)root_node)) {
151 g_message("XML document %s is of wrong type. Root "
152 "node is not '%s'", path, root_node);
155 i->path = g_strdup(path);
167 gboolean obt_xml_load_file(ObtXmlInst *i,
169 const gchar *root_node)
174 paths = g_slist_append(NULL, g_strdup(path));
176 r = load_file(i, NULL, NULL, root_node, paths);
180 paths = g_slist_delete_link(paths, paths);
185 gboolean obt_xml_load_config_file(ObtXmlInst *i,
187 const gchar *filename,
188 const gchar *root_node)
190 GSList *it, *paths = NULL;
193 for (it = obt_paths_config_dirs(i->xdg_paths); it; it = g_slist_next(it))
194 paths = g_slist_append(paths, g_strdup(it->data));
196 r = load_file(i, domain, filename, root_node, paths);
200 paths = g_slist_delete_link(paths, paths);
205 gboolean obt_xml_load_data_file(ObtXmlInst *i,
207 const gchar *filename,
208 const gchar *root_node)
210 GSList *it, *paths = NULL;
213 for (it = obt_paths_data_dirs(i->xdg_paths); it; it = g_slist_next(it))
214 paths = g_slist_append(paths, g_strdup(it->data));
216 r = load_file(i, domain, filename, root_node, paths);
220 paths = g_slist_delete_link(paths, paths);
225 gboolean obt_xml_load_theme_file(ObtXmlInst *i,
228 const gchar *filename,
229 const gchar *root_node)
231 GSList *it, *paths = NULL;
234 /* use ~/.themes for backwards compatibility */
235 paths = g_slist_append
236 (paths, g_build_filename(g_get_home_dir(), ".themes", theme, NULL));
238 for (it = obt_paths_data_dirs(i->xdg_paths); it; it = g_slist_next(it))
239 paths = g_slist_append
240 (paths, g_build_filename(it->data, "themes", theme, NULL));
242 r = load_file(i, domain, filename, root_node, paths);
246 paths = g_slist_delete_link(paths, paths);
252 gboolean obt_xml_load_mem(ObtXmlInst *i,
253 gpointer data, guint len, const gchar *root_node)
257 g_assert(i->doc == NULL); /* another doc isn't open already? */
259 i->doc = xmlParseMemory(data, len);
261 i->root = xmlDocGetRootElement(i->doc);
265 g_message("Given memory is an empty document");
267 else if (xmlStrcmp(i->root->name, (const xmlChar*)root_node)) {
271 g_message("XML Document in given memory is of wrong "
272 "type. Root node is not '%s'\n", root_node);
280 gboolean obt_xml_save_file(ObtXmlInst *inst,
284 return xmlSaveFormatFile(path, inst->doc, pretty) != -1;
287 void obt_xml_close(ObtXmlInst *i)
298 void obt_xml_tree(ObtXmlInst *i, xmlNodePtr node)
300 g_assert(i->doc); /* a doc is open? */
304 struct Callback *c = g_hash_table_lookup(i->callbacks, node->name);
305 if (c) c->func(node, c->data);
311 void obt_xml_tree_from_root(ObtXmlInst *i)
313 obt_xml_tree(i, i->root->children);
316 gchar *obt_xml_node_string(xmlNodePtr node)
318 xmlChar *c = xmlNodeGetContent(node);
320 if (c) g_strstrip((char*)c); /* strip leading/trailing whitespace */
321 s = g_strdup(c ? (gchar*)c : "");
326 gint obt_xml_node_int(xmlNodePtr node)
328 xmlChar *c = xmlNodeGetContent(node);
330 if (c) g_strstrip((char*)c); /* strip leading/trailing whitespace */
331 i = c ? atoi((gchar*)c) : 0;
336 gboolean obt_xml_node_bool(xmlNodePtr node)
338 xmlChar *c = xmlNodeGetContent(node);
340 if (c) g_strstrip((char*)c); /* strip leading/trailing whitespace */
341 if (c && !xmlStrcasecmp(c, (const xmlChar*) "true"))
343 else if (c && !xmlStrcasecmp(c, (const xmlChar*) "yes"))
345 else if (c && !xmlStrcasecmp(c, (const xmlChar*) "on"))
351 gboolean obt_xml_node_contains(xmlNodePtr node, const gchar *val)
353 xmlChar *c = xmlNodeGetContent(node);
355 if (c) g_strstrip((char*)c); /* strip leading/trailing whitespace */
356 r = !xmlStrcasecmp(c, (const xmlChar*) val);
361 xmlNodePtr obt_xml_find_node(xmlNodePtr node, const gchar *tag)
364 if (!xmlStrcmp(node->name, (const xmlChar*) tag))
371 gboolean obt_xml_attr_bool(xmlNodePtr node, const gchar *name,
374 xmlChar *c = xmlGetProp(node, (const xmlChar*) name);
377 g_strstrip((char*)c); /* strip leading/trailing whitespace */
378 if (!xmlStrcasecmp(c, (const xmlChar*) "true"))
379 *value = TRUE, r = TRUE;
380 else if (!xmlStrcasecmp(c, (const xmlChar*) "yes"))
381 *value = TRUE, r = TRUE;
382 else if (!xmlStrcasecmp(c, (const xmlChar*) "on"))
383 *value = TRUE, r = TRUE;
384 else if (!xmlStrcasecmp(c, (const xmlChar*) "false"))
385 *value = FALSE, r = TRUE;
386 else if (!xmlStrcasecmp(c, (const xmlChar*) "no"))
387 *value = FALSE, r = TRUE;
388 else if (!xmlStrcasecmp(c, (const xmlChar*) "off"))
389 *value = FALSE, r = TRUE;
395 gboolean obt_xml_attr_int(xmlNodePtr node, const gchar *name, gint *value)
397 xmlChar *c = xmlGetProp(node, (const xmlChar*) name);
400 g_strstrip((char*)c); /* strip leading/trailing whitespace */
401 *value = atoi((gchar*)c);
408 gboolean obt_xml_attr_string(xmlNodePtr node, const gchar *name,
411 xmlChar *c = xmlGetProp(node, (const xmlChar*) name);
414 g_strstrip((char*)c); /* strip leading/trailing whitespace */
415 *value = g_strdup((gchar*)c);
422 gboolean obt_xml_attr_contains(xmlNodePtr node, const gchar *name,
425 xmlChar *c = xmlGetProp(node, (const xmlChar*) name);
428 g_strstrip((char*)c); /* strip leading/trailing whitespace */
429 r = !xmlStrcasecmp(c, (const xmlChar*) val);