shared/config-parser.h

   1 /*
   2  * Copyright © 2008 Kristian Høgsberg
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and its
   5  * documentation for any purpose is hereby granted without fee, provided that
   6  * the above copyright notice appear in all copies and that both that copyright
   7  * notice and this permission notice appear in supporting documentation, and
   8  * that the name of the copyright holders not be used in advertising or
   9  * publicity pertaining to distribution of the software without specific,
  10  * written prior permission.  The copyright holders make no representations
  11  * about the suitability of this software for any purpose.  It is provided "as
  12  * is" without express or implied warranty.
  13  *
  14  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  15  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  16  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  17  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  18  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  19  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  20  * OF THIS SOFTWARE.
  21  */
  22
  23 #ifndef CONFIGPARSER_H
  24 #define CONFIGPARSER_H
  25
  26 #ifdef  __cplusplus
  27 extern "C" {
  28 #endif
  29
  30 enum config_key_type {
  31         CONFIG_KEY_INTEGER,             /* typeof data = int */
  32         CONFIG_KEY_UNSIGNED_INTEGER,    /* typeof data = unsigned int */
  33         CONFIG_KEY_STRING,              /* typeof data = char* */
  34         CONFIG_KEY_BOOLEAN              /* typeof data = int */
  35 };
  36
  37 struct config_key {
  38         const char *name;
  39         enum config_key_type type;
  40         void *data;
  41 };
  42
  43 struct config_section {
  44         const char *name;
  45         const struct config_key *keys;
  46         int num_keys;
  47         void (*done)(void *data);
  48 };
  49
  50 enum weston_option_type {
  51         WESTON_OPTION_INTEGER,
  52         WESTON_OPTION_UNSIGNED_INTEGER,
  53         WESTON_OPTION_STRING,
  54         WESTON_OPTION_BOOLEAN
  55 };
  56
  57 struct weston_option {
  58         enum weston_option_type type;
  59         const char *name;
  60         int short_name;
  61         void *data;
  62 };
  63
  64 int
  65 parse_options(const struct weston_option *options,
  66               int count, int *argc, char *argv[]);
  67
  68 struct weston_config_section;
  69 struct weston_config;
  70
  71 struct weston_config_section *
  72 weston_config_get_section(struct weston_config *config, const char *section,
  73                           const char *key, const char *value);
  74 int
  75 weston_config_section_get_int(struct weston_config_section *section,
  76                               const char *key,
  77                               int32_t *value, int32_t default_value);
  78 int
  79 weston_config_section_get_uint(struct weston_config_section *section,
  80                                const char *key,
  81                                uint32_t *value, uint32_t default_value);
  82 int
  83 weston_config_section_get_double(struct weston_config_section *section,
  84                                  const char *key,
  85                                  double *value, double default_value);
  86 int
  87 weston_config_section_get_string(struct weston_config_section *section,
  88                                  const char *key,
  89                                  char **value,
  90                                  const char *default_value);
  91 int
  92 weston_config_section_get_bool(struct weston_config_section *section,
  93                                const char *key,
  94                                int *value, int default_value);
  95 const char *
  96 weston_config_get_libexec_dir(void);
  97
  98 struct weston_config *
  99 weston_config_parse(const char *name);
 100
 101 const char *
 102 weston_config_get_full_path(struct weston_config *config);
 103
 104 void
 105 weston_config_destroy(struct weston_config *config);
 106
 107 int weston_config_next_section(struct weston_config *config,
 108                                struct weston_config_section **section,
 109                                const char **name);
 110
 111
 112 #ifdef  __cplusplus
 113 }
 114 #endif
 115
 116 #endif /* CONFIGPARSER_H */
 117