obt/xml.h

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    obt/xml.h for the Openbox window manager
   4    Copyright (c) 2003-2007   Dana Jansens
   5
   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.
  10
  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.
  15
  16    See the COPYING file for a copy of the GNU General Public License.
  17 */
  18
  19 #ifndef __obt_xml_h
  20 #define __obt_xml_h
  21
  22 #include <libxml/parser.h>
  23 #include <glib.h>
  24
  25 G_BEGIN_DECLS
  26
  27 typedef struct _ObtXmlInst ObtXmlInst;
  28
  29 typedef void (*ObtXmlCallback)(xmlNodePtr node, gpointer data);
  30
  31 ObtXmlInst* obt_xml_instance_new(void);
  32 void obt_xml_instance_ref(ObtXmlInst *inst);
  33 void obt_xml_instance_unref(ObtXmlInst *inst);
  34
  35 void obt_xml_new_file(ObtXmlInst *inst,
  36                       const gchar *root_node);
  37
  38 gboolean obt_xml_load_file(ObtXmlInst *inst,
  39                            const gchar *path,
  40                            const gchar *root_node);
  41 gboolean obt_xml_load_config_file(ObtXmlInst *inst,
  42                                   const gchar *domain,
  43                                   const gchar *filename,
  44                                   const gchar *root_node);
  45 gboolean obt_xml_load_data_file(ObtXmlInst *inst,
  46                                 const gchar *domain,
  47                                 const gchar *filename,
  48                                 const gchar *root_node);
  49 gboolean obt_xml_load_theme_file(ObtXmlInst *inst,
  50                                  const gchar *theme,
  51                                  const gchar *domain,
  52                                  const gchar *filename,
  53                                  const gchar *root_node);
  54 gboolean obt_xml_load_mem(ObtXmlInst *inst,
  55                           gpointer data, guint len, const gchar *root_node);
  56
  57 gboolean obt_xml_save_file(ObtXmlInst *inst,
  58                            const gchar *path,
  59                            gboolean pretty);
  60
  61 xmlDocPtr obt_xml_doc(ObtXmlInst *inst);
  62 xmlNodePtr obt_xml_root(ObtXmlInst *inst);
  63
  64 void obt_xml_close(ObtXmlInst *inst);
  65
  66 void obt_xml_register(ObtXmlInst *inst, const gchar *tag,
  67                       ObtXmlCallback func, gpointer data);
  68 void obt_xml_unregister(ObtXmlInst *inst, const gchar *tag);
  69 void obt_xml_tree(ObtXmlInst *i, xmlNodePtr node);
  70 void obt_xml_tree_from_root(ObtXmlInst *i);
  71
  72
  73 /* helpers */
  74
  75 xmlNodePtr obt_xml_find_sibling(xmlNodePtr node, const gchar *name);
  76
  77 gboolean obt_xml_node_contains (xmlNodePtr node, const gchar *val);
  78 gchar   *obt_xml_node_string   (xmlNodePtr node);
  79 gint     obt_xml_node_int      (xmlNodePtr node);
  80 gboolean obt_xml_node_bool     (xmlNodePtr node);
  81
  82 gboolean obt_xml_attr_contains (xmlNodePtr node, const gchar *name,
  83                                 const gchar *val);
  84 gboolean obt_xml_attr_string   (xmlNodePtr node, const gchar *name,
  85                                 gchar **value);
  86 gboolean obt_xml_attr_int      (xmlNodePtr node, const gchar *name,
  87                                 gint *value);
  88 gboolean obt_xml_attr_bool     (xmlNodePtr node, const gchar *name,
  89                                 gboolean *value);
  90
  91 /* path based operations */
  92
  93 /*! Returns the node in the given @subtree, at the given @path.  If the node is
  94   not found, it is created, along with any parents.
  95
  96   The path has a structure follows.
  97   - <name> - specifies a child of the current position in the subtree
  98   - :foo=bar - specifies an attribute and its value.  this can be appended to
  99     a <name> or to another attribute
 100   - / - specifies to move one level deeper in the tree
 101
 102   An example:
 103   - theme/font:place=ActiveWindow/size refers to the size node at this
 104     position:
 105     - <theme><font place="ActiveWindow"><size /></font></theme>
 106
 107   @subtree The root of the search.
 108   @path A string specifying the search path.
 109   @default_value If the node is not found, it is created with this value
 110     contained within.
 111 */
 112 xmlNodePtr obt_xml_path_get_node(xmlNodePtr subtree, const gchar *path,
 113                                  const gchar *default_value);
 114 /*! Removes a specified node from the tree. */
 115 void obt_xml_path_delete_node(xmlNodePtr subtree, const gchar *path);
 116
 117
 118 G_END_DECLS
 119
 120 #endif