Open Broadcaster Software
Free, open source software for live streaming and recording
config-file.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013 Hugh Bailey <obs.jim@gmail.com>
3  *
4  * Permission to use, copy, modify, and distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16 
17 #pragma once
18 
19 #include "c99defs.h"
20 
21 /*
22  * Generic ini-style config file functions
23  *
24  * NOTE: It is highly recommended to use the default value functions (bottom of
25  * the file) before reading any variables from config files.
26  */
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
32 struct config_data;
33 typedef struct config_data config_t;
34 
35 #define CONFIG_SUCCESS 0
36 #define CONFIG_FILENOTFOUND -1
37 #define CONFIG_ERROR -2
38 
42 };
43 
44 EXPORT config_t *config_create(const char *file);
45 EXPORT int config_open(config_t **config, const char *file,
46  enum config_open_type open_type);
47 EXPORT int config_open_string(config_t **config, const char *str);
48 EXPORT int config_save(config_t *config);
49 EXPORT int config_save_safe(config_t *config, const char *temp_ext,
50  const char *backup_ext);
51 EXPORT void config_close(config_t *config);
52 
53 EXPORT size_t config_num_sections(config_t *config);
54 EXPORT const char *config_get_section(config_t *config, size_t idx);
55 
56 EXPORT void config_set_string(config_t *config, const char *section,
57  const char *name, const char *value);
58 EXPORT void config_set_int(config_t *config, const char *section,
59  const char *name, int64_t value);
60 EXPORT void config_set_uint(config_t *config, const char *section,
61  const char *name, uint64_t value);
62 EXPORT void config_set_bool(config_t *config, const char *section,
63  const char *name, bool value);
64 EXPORT void config_set_double(config_t *config, const char *section,
65  const char *name, double value);
66 
67 EXPORT const char *config_get_string(config_t *config, const char *section,
68  const char *name);
69 EXPORT int64_t config_get_int(config_t *config, const char *section,
70  const char *name);
71 EXPORT uint64_t config_get_uint(config_t *config, const char *section,
72  const char *name);
73 EXPORT bool config_get_bool(config_t *config, const char *section,
74  const char *name);
75 EXPORT double config_get_double(config_t *config, const char *section,
76  const char *name);
77 
78 EXPORT bool config_remove_value(config_t *config, const char *section,
79  const char *name);
80 
81 /*
82  * DEFAULT VALUES
83  *
84  * The following functions are used to set what values will return if they do
85  * not exist. Call these functions *once* for each known value before reading
86  * any of them anywhere else.
87  *
88  * These do *not* actually set any values, they only set what values will be
89  * returned for config_get_* if the specified variable does not exist.
90  *
91  * You can initialize the defaults programmatically using config_set_default_*
92  * functions (recommended for most cases), or you can initialize it via a file
93  * with config_open_defaults.
94  */
95 EXPORT int config_open_defaults(config_t *config, const char *file);
96 
97 EXPORT void config_set_default_string(config_t *config, const char *section,
98  const char *name, const char *value);
99 EXPORT void config_set_default_int(config_t *config, const char *section,
100  const char *name, int64_t value);
101 EXPORT void config_set_default_uint(config_t *config, const char *section,
102  const char *name, uint64_t value);
103 EXPORT void config_set_default_bool(config_t *config, const char *section,
104  const char *name, bool value);
105 EXPORT void config_set_default_double(config_t *config, const char *section,
106  const char *name, double value);
107 
108 /* These functions allow you to get the current default values rather than get
109  * the actual values. Probably almost never really needed */
110 EXPORT const char *config_get_default_string(config_t *config,
111  const char *section,
112  const char *name);
113 EXPORT int64_t config_get_default_int(config_t *config, const char *section,
114  const char *name);
115 EXPORT uint64_t config_get_default_uint(config_t *config, const char *section,
116  const char *name);
117 EXPORT bool config_get_default_bool(config_t *config, const char *section,
118  const char *name);
119 EXPORT double config_get_default_double(config_t *config, const char *section,
120  const char *name);
121 
122 EXPORT bool config_has_user_value(config_t *config, const char *section,
123  const char *name);
124 EXPORT bool config_has_default_value(config_t *config, const char *section,
125  const char *name);
126 
127 #ifdef __cplusplus
128 }
129 #endif
config_has_user_value
EXPORT bool config_has_user_value(config_t *config, const char *section, const char *name)
config_get_double
EXPORT double config_get_double(config_t *config, const char *section, const char *name)
config_set_uint
EXPORT void config_set_uint(config_t *config, const char *section, const char *name, uint64_t value)
config_set_default_string
EXPORT void config_set_default_string(config_t *config, const char *section, const char *name, const char *value)
config_remove_value
EXPORT bool config_remove_value(config_t *config, const char *section, const char *name)
config_set_default_uint
EXPORT void config_set_default_uint(config_t *config, const char *section, const char *name, uint64_t value)
config_get_default_bool
EXPORT bool config_get_default_bool(config_t *config, const char *section, const char *name)
config_get_int
EXPORT int64_t config_get_int(config_t *config, const char *section, const char *name)
config_num_sections
EXPORT size_t config_num_sections(config_t *config)
EXPORT
#define EXPORT
Definition: c99defs.h:37
config_create
EXPORT config_t * config_create(const char *file)
config_set_default_int
EXPORT void config_set_default_int(config_t *config, const char *section, const char *name, int64_t value)
config_set_bool
EXPORT void config_set_bool(config_t *config, const char *section, const char *name, bool value)
config_get_section
const EXPORT char * config_get_section(config_t *config, size_t idx)
config_get_default_uint
EXPORT uint64_t config_get_default_uint(config_t *config, const char *section, const char *name)
c99defs.h
config_t
struct config_data config_t
Definition: config-file.h:33
config_set_default_bool
EXPORT void config_set_default_bool(config_t *config, const char *section, const char *name, bool value)
config_has_default_value
EXPORT bool config_has_default_value(config_t *config, const char *section, const char *name)
config_close
EXPORT void config_close(config_t *config)
config_get_default_string
const EXPORT char * config_get_default_string(config_t *config, const char *section, const char *name)
config_open_type
config_open_type
Definition: config-file.h:39
config_open_defaults
EXPORT int config_open_defaults(config_t *config, const char *file)
config_get_bool
EXPORT bool config_get_bool(config_t *config, const char *section, const char *name)
config_get_uint
EXPORT uint64_t config_get_uint(config_t *config, const char *section, const char *name)
CONFIG_OPEN_EXISTING
@ CONFIG_OPEN_EXISTING
Definition: config-file.h:40
config_set_string
EXPORT void config_set_string(config_t *config, const char *section, const char *name, const char *value)
config_open_string
EXPORT int config_open_string(config_t **config, const char *str)
config_save
EXPORT int config_save(config_t *config)
CONFIG_OPEN_ALWAYS
@ CONFIG_OPEN_ALWAYS
Definition: config-file.h:41
config_save_safe
EXPORT int config_save_safe(config_t *config, const char *temp_ext, const char *backup_ext)
config_set_default_double
EXPORT void config_set_default_double(config_t *config, const char *section, const char *name, double value)
config_set_double
EXPORT void config_set_double(config_t *config, const char *section, const char *name, double value)
config_get_string
const EXPORT char * config_get_string(config_t *config, const char *section, const char *name)
config_open
EXPORT int config_open(config_t **config, const char *file, enum config_open_type open_type)
config_set_int
EXPORT void config_set_int(config_t *config, const char *section, const char *name, int64_t value)
config_get_default_int
EXPORT int64_t config_get_default_int(config_t *config, const char *section, const char *name)
config_get_default_double
EXPORT double config_get_default_double(config_t *config, const char *section, const char *name)