src/pulsecore/conf-parser.h

   1 #ifndef fooconfparserhfoo
   2 #define fooconfparserhfoo
   3
   4 /***
   5   This file is part of PulseAudio.
   6
   7   Copyright 2004-2006 Lennart Poettering
   8
   9   PulseAudio is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU Lesser General Public License as published
  11   by the Free Software Foundation; either version 2.1 of the License,
  12   or (at your option) any later version.
  13
  14   PulseAudio is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with PulseAudio; if not, write to the Free Software
  21   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  22   USA.
  23 ***/
  24
  25 #include <stdio.h>
  26
  27 /* An abstract parser for simple, line based, shallow configuration
  28  * files consisting of variable assignments only. */
  29
  30 typedef int (*pa_config_parser_cb_t)(const char *filename, unsigned line, const char *section, const char *lvalue, const char *rvalue, void *data, void *userdata);
  31
  32 /* Wraps info for parsing a specific configuration variable */
  33 typedef struct pa_config_item {
  34     const char *lvalue; /* name of the variable */
  35     pa_config_parser_cb_t parse; /* Function that is called to parse the variable's value */
  36     void *data; /* Where to store the variable's data */
  37     const char *section;
  38 } pa_config_item;
  39
  40 /* The configuration file parsing routine. Expects a table of
  41  * pa_config_items in *t that is terminated by an item where lvalue is
  42  * NULL */
  43 int pa_config_parse(const char *filename, FILE *f, const pa_config_item *t, void *userdata);
  44
  45 /* Generic parsers for integers, size_t, booleans and strings */
  46 int pa_config_parse_int(const char *filename, unsigned line, const char *section, const char *lvalue, const char *rvalue, void *data, void *userdata);
  47 int pa_config_parse_unsigned(const char *filename, unsigned line, const char *section, const char *lvalue, const char *rvalue, void *data, void *userdata);
  48 int pa_config_parse_size(const char *filename, unsigned line, const char *section, const char *lvalue, const char *rvalue, void *data, void *userdata);
  49 int pa_config_parse_bool(const char *filename, unsigned line, const char *section, const char *lvalue, const char *rvalue, void *data, void *userdata);
  50 int pa_config_parse_not_bool(const char *filename, unsigned line, const char *section, const char *lvalue, const char *rvalue, void *data, void *userdata);
  51 int pa_config_parse_string(const char *filename, unsigned line, const char *section, const char *lvalue, const char *rvalue, void *data, void *userdata);
  52
  53 #endif