1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
/*
* This file is part of MPlayer.
*
* MPlayer is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* MPlayer is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with MPlayer; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef MPLAYER_M_CONFIG_H
#define MPLAYER_M_CONFIG_H
/// \defgroup Config Config manager
///
/// m_config provides an API to manipulate the config variables in MPlayer.
/// It makes use of the \ref Options API to provide a context stack that
/// allows saving and later restoring the state of all variables.
///@{
/// \file
typedef struct m_config_option m_config_option_t;
typedef struct m_config_save_slot m_config_save_slot_t;
/// \ingroup ConfigProfiles
typedef struct m_profile m_profile_t;
struct m_option;
struct m_option_type;
/// Config option save slot
struct m_config_save_slot {
/// Previous level slot.
m_config_save_slot_t* prev;
/// Level at which the save was made.
int lvl;
// We have to store other datatypes in this as well,
// so make sure we get properly aligned addresses.
unsigned char data[0] __attribute__ ((aligned (8)));
};
/// Config option
struct m_config_option {
m_config_option_t* next;
/// Full name (ie option:subopt).
char* name;
/// Option description.
const struct m_option* opt;
/// Save slot stack.
m_config_save_slot_t* slots;
/// See \ref ConfigOptionFlags.
unsigned int flags;
};
/// \defgroup ConfigProfiles Config profiles
/// \ingroup Config
///
/// Profiles allow to predefine some sets of options that can then
/// be applied later on with the internal -profile option.
///
///@{
/// Config profile
struct m_profile {
m_profile_t* next;
char* name;
char* desc;
int num_opts;
/// Option/value pair array.
char** opts;
};
///@}
/// Config object
/** \ingroup Config */
typedef struct m_config {
/// Registered options.
/** This contains all options and suboptions.
*/
m_config_option_t* opts;
/// Current stack level.
int lvl;
/// \ref OptionParserModes
int mode;
/// List of defined profiles.
m_profile_t* profiles;
/// Depth when recursively including profiles.
int profile_depth;
void *optstruct; // struct mpopts or other
} m_config_t;
/// \defgroup ConfigOptionFlags Config option flags
/// \ingroup Config
///@{
/// Set if an option has been set at the current level.
#define M_CFG_OPT_SET (1<<0)
/// Set if another option already uses the same variable.
#define M_CFG_OPT_ALIAS (1<<1)
///@}
/// Create a new config object.
/** \ingroup Config
*/
m_config_t*
m_config_new(void *optstruct,
int includefunc(struct m_option *conf, char *filename));
/// Free a config object.
void
m_config_free(m_config_t* config);
/// Push a new context.
/** \param config The config object.
*/
void
m_config_push(m_config_t* config);
/// Pop the current context restoring the previous context state.
/** \param config The config object.
*/
void
m_config_pop(m_config_t* config);
/// Register some options to be used.
/** \param config The config object.
* \param args An array of \ref m_option struct.
* \return 1 on success, 0 on failure.
*/
int
m_config_register_options(m_config_t *config, const struct m_option *args);
/// Set an option.
/** \param config The config object.
* \param arg The option's name.
* \param param The value of the option, can be NULL.
* \return See \ref OptionParserReturn.
*/
int
m_config_set_option(m_config_t *config, char* arg, char* param);
/// Check if an option setting is valid.
/** \param config The config object.
* \param arg The option's name.
* \param param The value of the option, can be NULL.
* \return See \ref OptionParserReturn.
*/
int
m_config_check_option(m_config_t *config, char* arg, char* param);
/// Get the option matching the given name.
/** \param config The config object.
* \param arg The option's name.
*/
const struct m_option*
m_config_get_option(m_config_t *config, char* arg);
/// Print a list of all registered options.
/** \param config The config object.
*/
void
m_config_print_option_list(m_config_t *config);
/// \addtogroup ConfigProfiles
///@{
/// Find the profile with the given name.
/** \param config The config object.
* \param arg The profile's name.
* \return The profile object or NULL.
*/
m_profile_t*
m_config_get_profile(m_config_t* config, char* name);
/// Get the profile with the given name, creating it if necessary.
/** \param config The config object.
* \param arg The profile's name.
* \return The profile object.
*/
m_profile_t*
m_config_add_profile(m_config_t* config, char* name);
/// Set the description of a profile.
/** Used by the config file parser when defining a profile.
*
* \param p The profile object.
* \param arg The profile's name.
*/
void
m_profile_set_desc(m_profile_t* p, char* desc);
/// Add an option to a profile.
/** Used by the config file parser when defining a profile.
*
* \param config The config object.
* \param p The profile object.
* \param name The option's name.
* \param val The option's value.
*/
int
m_config_set_profile_option(m_config_t* config, m_profile_t* p,
char* name, char* val);
/// Enables profile usage
/** Used by the config file parser when loading a profile.
*
* \param config The config object.
* \param p The profile object.
*/
void
m_config_set_profile(m_config_t* config, m_profile_t* p);
///@}
///@}
#endif /* MPLAYER_M_CONFIG_H */
|
