bus/config-parser.h

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* config-parser.h  XML-library-agnostic configuration file parser
   3  *
   4  * Copyright (C) 2003 Red Hat, Inc.
   5  *
   6  * Licensed under the Academic Free License version 1.2
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  */
  23
  24 #ifndef BUS_CONFIG_PARSER_H
  25 #define BUS_CONFIG_PARSER_H
  26
  27 #include <config.h>
  28
  29 #include <dbus/dbus.h>
  30 #include <dbus/dbus-string.h>
  31 #include <dbus/dbus-list.h>
  32
  33 /* Whatever XML library we're using just pushes data into this API */
  34
  35 typedef struct BusConfigParser BusConfigParser;
  36
  37 BusConfigParser* bus_config_parser_new           (const DBusString  *basedir);
  38 void             bus_config_parser_ref           (BusConfigParser   *parser);
  39 void             bus_config_parser_unref         (BusConfigParser   *parser);
  40 dbus_bool_t      bus_config_parser_check_doctype (BusConfigParser   *parser,
  41                                                   const char        *doctype,
  42                                                   DBusError         *error);
  43 dbus_bool_t      bus_config_parser_start_element (BusConfigParser   *parser,
  44                                                   const char        *element_name,
  45                                                   const char       **attribute_names,
  46                                                   const char       **attribute_values,
  47                                                   DBusError         *error);
  48 dbus_bool_t      bus_config_parser_end_element   (BusConfigParser   *parser,
  49                                                   const char        *element_name,
  50                                                   DBusError         *error);
  51 dbus_bool_t      bus_config_parser_content       (BusConfigParser   *parser,
  52                                                   const DBusString  *content,
  53                                                   DBusError         *error);
  54 dbus_bool_t      bus_config_parser_finished      (BusConfigParser   *parser,
  55                                                   DBusError         *error);
  56
  57 /* Functions for extracting the parse results */
  58 const char* bus_config_parser_get_user         (BusConfigParser *parser);
  59 const char* bus_config_parser_get_type         (BusConfigParser *parser);
  60 DBusList**  bus_config_parser_get_addresses    (BusConfigParser *parser);
  61 DBusList**  bus_config_parser_get_mechanisms   (BusConfigParser *parser);
  62 dbus_bool_t bus_config_parser_get_fork         (BusConfigParser *parser);
  63 DBusList**  bus_config_parser_get_service_dirs (BusConfigParser *parser);
  64
  65 /* Loader functions (backended off one of the XML parsers).  Returns a
  66  * finished ConfigParser.
  67  */
  68 BusConfigParser* bus_config_load (const DBusString *file,
  69                                   DBusError        *error);
  70
  71
  72 #endif /* BUS_CONFIG_PARSER_H */