parser/parse.h

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    parse.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 __parse_h
  20 #define __parse_h
  21
  22 #include "version.h"
  23
  24 #include <libxml/parser.h>
  25 #include <glib.h>
  26
  27 G_BEGIN_DECLS
  28
  29 typedef struct _ObParseInst ObParseInst;
  30
  31 typedef void (*ParseCallback)(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
  32                               gpointer data);
  33
  34 ObParseInst* parse_startup();
  35 void parse_shutdown(ObParseInst *inst);
  36
  37 /*! Loads Openbox's rc, from the normal paths
  38   @type The configuration type to load, or NULL to use the default.
  39         e.g. "gnome" would load rc-gnome.xml.
  40  */
  41 gboolean parse_load_rc(const gchar *type, xmlDocPtr *doc, xmlNodePtr *root);
  42 /* Loads an Openbox menu, from the normal paths */
  43 gboolean parse_load_menu(const gchar *file, xmlDocPtr *doc, xmlNodePtr *root);
  44 /* Loads an Openbox theme, from the normal paths */
  45 gboolean parse_load_theme(const gchar *name, xmlDocPtr *doc, xmlNodePtr *root,
  46                           gchar **path);
  47
  48 void parse_register(ObParseInst *inst, const gchar *tag,
  49                     ParseCallback func, gpointer data);
  50 void parse_tree(ObParseInst *inst, xmlDocPtr doc, xmlNodePtr node);
  51
  52
  53 /* open/close */
  54
  55 gboolean parse_load(const gchar *path, const gchar *rootname,
  56                     xmlDocPtr *doc, xmlNodePtr *root);
  57 gboolean parse_load_mem(gpointer data, guint len, const gchar *rootname,
  58                         xmlDocPtr *doc, xmlNodePtr *root);
  59 void parse_close(xmlDocPtr doc);
  60
  61
  62 /* helpers */
  63
  64 xmlNodePtr parse_find_node(const gchar *tag, xmlNodePtr node);
  65
  66 gchar *parse_string(xmlDocPtr doc, xmlNodePtr node);
  67 gint parse_int(xmlDocPtr doc, xmlNodePtr node);
  68 gboolean parse_bool(xmlDocPtr doc, xmlNodePtr node);
  69
  70 gboolean parse_contains(const gchar *val, xmlDocPtr doc, xmlNodePtr node);
  71 gboolean parse_attr_contains(const gchar *val, xmlNodePtr node,
  72                              const gchar *name);
  73
  74 gboolean parse_attr_string(const gchar *name, xmlNodePtr node, gchar **value);
  75 gboolean parse_attr_int(const gchar *name, xmlNodePtr node, gint *value);
  76 gboolean parse_attr_bool(const gchar *name, xmlNodePtr node, gboolean *value);
  77
  78 /* paths */
  79
  80 void parse_paths_startup();
  81 void parse_paths_shutdown();
  82
  83 const gchar* parse_xdg_config_home_path();
  84 const gchar* parse_xdg_data_home_path();
  85 GSList* parse_xdg_config_dir_paths();
  86 GSList* parse_xdg_data_dir_paths();
  87
  88 /*! Expands the ~ character to the home directory throughout the given
  89   string */
  90 gchar *parse_expand_tilde(const gchar *f);
  91 /*! Makes a directory */
  92 gboolean parse_mkdir(const gchar *path, gint mode);
  93 /*! Makes a directory and all its parents */
  94 gboolean parse_mkdir_path(const gchar *path, gint mode);
  95
  96 G_END_DECLS
  97
  98 #endif