annotate m_option.h @ 29942:9b90e1052b32

Use a fallback to make sure the basic OpenGL functions are available instead of initializing them which does not work well with reinitializations.
author reimar
date Wed, 09 Dec 2009 17:50:07 +0000
parents 0f1b5b68af32
children c1a3f1bbba26
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
26029
4129c8cfa742 Add MPLAYER_ prefix to multiple inclusion guards.
diego
parents: 25229
diff changeset
1 #ifndef MPLAYER_M_OPTION_H
4129c8cfa742 Add MPLAYER_ prefix to multiple inclusion guards.
diego
parents: 25229
diff changeset
2 #define MPLAYER_M_OPTION_H
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
3
26131
83c95bd31aab Add necessary #includes to pass 'make checkheaders'.
diego
parents: 26029
diff changeset
4 #include <string.h>
83c95bd31aab Add necessary #includes to pass 'make checkheaders'.
diego
parents: 26029
diff changeset
5
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
6 /// \defgroup Options
18283
67d35fe89c8d Fix most of the mistakes pointed out by Diego.
albeu
parents: 18258
diff changeset
7 /// m_option allows to parse, print and copy data of various types.
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
8 /// It is the base of the \ref OptionsStruct, \ref Config and
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
9 /// \ref Properties APIs.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
10 ///@{
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
11
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
12 /// \file m_option.h
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
13
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
14 /// \ingroup OptionTypes
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
15 typedef struct m_option_type m_option_type_t;
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
16 typedef struct m_option m_option_t;
9793
b2bf632d37b5 10L forgot to fix the forward declaration too.
albeu
parents: 9791
diff changeset
17 struct m_struct_st;
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
18
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
19 /// \defgroup OptionTypes Options types
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
20 /// \ingroup Options
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
21 ///@{
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
22
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
23 ///////////////////////////// Options types declarations ////////////////////////////
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
24
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
25 // Simple types
24966
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
26 extern const m_option_type_t m_option_type_flag;
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
27 extern const m_option_type_t m_option_type_int;
28759
af274aef6b81 Add a 64 bit integer type to the suboption parser.
reimar
parents: 26408
diff changeset
28 extern const m_option_type_t m_option_type_int64;
24966
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
29 extern const m_option_type_t m_option_type_float;
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
30 extern const m_option_type_t m_option_type_double;
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
31 extern const m_option_type_t m_option_type_string;
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
32 extern const m_option_type_t m_option_type_string_list;
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
33 extern const m_option_type_t m_option_type_position;
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
34 extern const m_option_type_t m_option_type_time;
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
35 extern const m_option_type_t m_option_type_time_size;
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
36
24966
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
37 extern const m_option_type_t m_option_type_print;
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
38 extern const m_option_type_t m_option_type_print_indirect;
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
39 extern const m_option_type_t m_option_type_print_func;
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
40 extern const m_option_type_t m_option_type_subconfig;
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
41 extern const m_option_type_t m_option_type_imgfmt;
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
42 extern const m_option_type_t m_option_type_afmt;
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
43
18316
b3be7df634b0 spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents: 18283
diff changeset
44 // Func-based types
24966
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
45 extern const m_option_type_t m_option_type_func_full;
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
46 extern const m_option_type_t m_option_type_func_param;
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
47 extern const m_option_type_t m_option_type_func;
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
48
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
49 /// Callback used to reset func options.
24966
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
50 typedef void (*m_opt_default_func_t)(const m_option_t *, const char*);
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
51
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
52 /// Callback used by m_option_type_func_full options.
24966
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
53 typedef int (*m_opt_func_full_t)(const m_option_t *, const char *, char *);
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
54
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
55 /// Callback used by m_option_type_func_param options.
24966
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
56 typedef int (*m_opt_func_param_t)(const m_option_t *, const char *);
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
57
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
58 /// Callback used by m_option_type_func options.
24966
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
59 typedef int (*m_opt_func_t)(const m_option_t *);
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
60
18316
b3be7df634b0 spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents: 18283
diff changeset
61 // Backwards compatibility
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
62 typedef m_opt_default_func_t cfg_default_func_t;
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
63 typedef m_opt_func_full_t cfg_func_arg_param_t;
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
64 typedef m_opt_func_param_t cfg_func_param_t;
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
65 typedef m_opt_func_t cfg_func_t;
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
66
19973
02a18c52a42a after a long time, finally i could add -endpos option to mplayer executable.
ptt
parents: 19053
diff changeset
67 #define END_AT_NONE 0
02a18c52a42a after a long time, finally i could add -endpos option to mplayer executable.
ptt
parents: 19053
diff changeset
68 #define END_AT_TIME 1
02a18c52a42a after a long time, finally i could add -endpos option to mplayer executable.
ptt
parents: 19053
diff changeset
69 #define END_AT_SIZE 2
02a18c52a42a after a long time, finally i could add -endpos option to mplayer executable.
ptt
parents: 19053
diff changeset
70 typedef struct {
02a18c52a42a after a long time, finally i could add -endpos option to mplayer executable.
ptt
parents: 19053
diff changeset
71 double pos;
02a18c52a42a after a long time, finally i could add -endpos option to mplayer executable.
ptt
parents: 19053
diff changeset
72 int type;
02a18c52a42a after a long time, finally i could add -endpos option to mplayer executable.
ptt
parents: 19053
diff changeset
73 } m_time_size_t;
02a18c52a42a after a long time, finally i could add -endpos option to mplayer executable.
ptt
parents: 19053
diff changeset
74
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
75 /// Extra definition needed for \ref m_option_type_obj_settings_list options.
9593
e9a2af584986 Add the new -vf option wich is the same as vop in reverse order.
albeu
parents: 8736
diff changeset
76 typedef struct {
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
77 /// Pointer to an array of pointer to some object type description struct.
9593
e9a2af584986 Add the new -vf option wich is the same as vop in reverse order.
albeu
parents: 8736
diff changeset
78 void** list;
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
79 /// Offset of the object type name (char*) in the description struct.
9593
e9a2af584986 Add the new -vf option wich is the same as vop in reverse order.
albeu
parents: 8736
diff changeset
80 void* name_off;
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
81 /// Offset of the object type info string (char*) in the description struct.
9593
e9a2af584986 Add the new -vf option wich is the same as vop in reverse order.
albeu
parents: 8736
diff changeset
82 void* info_off;
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
83 /// \brief Offset of the object type parameter description (\ref m_struct_st)
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
84 /// in the description struct.
9593
e9a2af584986 Add the new -vf option wich is the same as vop in reverse order.
albeu
parents: 8736
diff changeset
85 void* desc_off;
e9a2af584986 Add the new -vf option wich is the same as vop in reverse order.
albeu
parents: 8736
diff changeset
86 } m_obj_list_t;
e9a2af584986 Add the new -vf option wich is the same as vop in reverse order.
albeu
parents: 8736
diff changeset
87
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
88 /// The data type used by \ref m_option_type_obj_settings_list.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
89 typedef struct m_obj_settings {
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
90 /// Type of the object.
9593
e9a2af584986 Add the new -vf option wich is the same as vop in reverse order.
albeu
parents: 8736
diff changeset
91 char* name;
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
92 /// NULL terminated array of parameter/value pairs.
9593
e9a2af584986 Add the new -vf option wich is the same as vop in reverse order.
albeu
parents: 8736
diff changeset
93 char** attribs;
e9a2af584986 Add the new -vf option wich is the same as vop in reverse order.
albeu
parents: 8736
diff changeset
94 } m_obj_settings_t;
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
95
18316
b3be7df634b0 spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents: 18283
diff changeset
96 /// A parser to set up a list of objects.
18283
67d35fe89c8d Fix most of the mistakes pointed out by Diego.
albeu
parents: 18258
diff changeset
97 /** It creates a NULL terminated array \ref m_obj_settings. The option priv
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
98 * field (\ref m_option::priv) must point to a \ref m_obj_list_t describing
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
99 * the available object types.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
100 */
24966
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
101 extern const m_option_type_t m_option_type_obj_settings_list;
9593
e9a2af584986 Add the new -vf option wich is the same as vop in reverse order.
albeu
parents: 8736
diff changeset
102
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
103 /// Extra definition needed for \ref m_option_type_obj_presets options.
9593
e9a2af584986 Add the new -vf option wich is the same as vop in reverse order.
albeu
parents: 8736
diff changeset
104 typedef struct {
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
105 /// Description of the struct holding the presets.
9791
c5b63e88253d Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents: 9593
diff changeset
106 struct m_struct_st* in_desc;
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
107 /// Description of the struct that should be set by the presets.
9791
c5b63e88253d Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents: 9593
diff changeset
108 struct m_struct_st* out_desc;
18316
b3be7df634b0 spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents: 18283
diff changeset
109 /// Pointer to an array of structs defining the various presets.
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
110 void* presets;
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
111 /// Offset of the preset's name inside the in_struct.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
112 void* name_off;
9593
e9a2af584986 Add the new -vf option wich is the same as vop in reverse order.
albeu
parents: 8736
diff changeset
113 } m_obj_presets_t;
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
114
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
115 /// Set several fields in a struct at once.
18283
67d35fe89c8d Fix most of the mistakes pointed out by Diego.
albeu
parents: 18258
diff changeset
116 /** For this two struct descriptions are used. One for the struct holding the
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
117 * preset and one for the struct beeing set. Every field present in both
18316
b3be7df634b0 spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents: 18283
diff changeset
118 * structs will be copied from the preset struct to the destination one.
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
119 * The option priv field (\ref m_option::priv) must point to a correctly
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
120 * filled \ref m_obj_presets_t.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
121 */
24966
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
122 extern const m_option_type_t m_option_type_obj_presets;
9593
e9a2af584986 Add the new -vf option wich is the same as vop in reverse order.
albeu
parents: 8736
diff changeset
123
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
124 /// Parse an URL into a struct.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
125 /** The option priv field (\ref m_option::priv) must point to a
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
126 * \ref m_struct_st describing which fields of the URL must be used.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
127 */
24966
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
128 extern const m_option_type_t m_option_type_custom_url;
9791
c5b63e88253d Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents: 9593
diff changeset
129
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
130 /// Extra definition needed for \ref m_option_type_obj_params options.
9791
c5b63e88253d Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents: 9593
diff changeset
131 typedef struct {
18283
67d35fe89c8d Fix most of the mistakes pointed out by Diego.
albeu
parents: 18258
diff changeset
132 /// Field descriptions.
24966
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
133 const struct m_struct_st* desc;
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
134 /// Field separator to use.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
135 char separator;
9791
c5b63e88253d Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents: 9593
diff changeset
136 } m_obj_params_t;
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
137
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
138 /// Parse a set of parameters.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
139 /** Parameters are separated by the given separator and each one
18283
67d35fe89c8d Fix most of the mistakes pointed out by Diego.
albeu
parents: 18258
diff changeset
140 * successively sets a field from the struct. The option priv field
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
141 * (\ref m_option::priv) must point to a \ref m_obj_params_t.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
142 */
24966
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
143 extern const m_option_type_t m_option_type_obj_params;
9791
c5b63e88253d Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents: 9593
diff changeset
144
c5b63e88253d Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents: 9593
diff changeset
145 typedef struct {
c5b63e88253d Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents: 9593
diff changeset
146 int start;
c5b63e88253d Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents: 9593
diff changeset
147 int end;
c5b63e88253d Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents: 9593
diff changeset
148 } m_span_t;
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
149 /// Ready made settings to parse a \ref m_span_t with a start-end syntax.
24966
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
150 extern const m_obj_params_t m_span_params_def;
9791
c5b63e88253d Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents: 9593
diff changeset
151
c5b63e88253d Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents: 9593
diff changeset
152
10594
57bdcdb061d7 Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents: 10590
diff changeset
153 // FIXME: backward compatibility
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
154 #define CONF_TYPE_FLAG (&m_option_type_flag)
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
155 #define CONF_TYPE_INT (&m_option_type_int)
28759
af274aef6b81 Add a 64 bit integer type to the suboption parser.
reimar
parents: 26408
diff changeset
156 #define CONF_TYPE_INT64 (&m_option_type_int64)
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
157 #define CONF_TYPE_FLOAT (&m_option_type_float)
11947
3ccd5dcf447c m_option_type_double
michael
parents: 10595
diff changeset
158 #define CONF_TYPE_DOUBLE (&m_option_type_double)
10594
57bdcdb061d7 Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents: 10590
diff changeset
159 #define CONF_TYPE_STRING (&m_option_type_string)
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
160 #define CONF_TYPE_FUNC (&m_option_type_func)
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
161 #define CONF_TYPE_FUNC_PARAM (&m_option_type_func_param)
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
162 #define CONF_TYPE_PRINT (&m_option_type_print)
8736
michael
parents: 8168
diff changeset
163 #define CONF_TYPE_PRINT_INDIRECT (&m_option_type_print_indirect)
17470
21123e349463 New option type to print help text with a function.
albeu
parents: 17456
diff changeset
164 #define CONF_TYPE_PRINT_FUNC (&m_option_type_print_func)
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
165 #define CONF_TYPE_FUNC_FULL (&m_option_type_func_full)
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
166 #define CONF_TYPE_SUBCONFIG (&m_option_type_subconfig)
10594
57bdcdb061d7 Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents: 10590
diff changeset
167 #define CONF_TYPE_STRING_LIST (&m_option_type_string_list)
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
168 #define CONF_TYPE_POSITION (&m_option_type_position)
10594
57bdcdb061d7 Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents: 10590
diff changeset
169 #define CONF_TYPE_IMGFMT (&m_option_type_imgfmt)
14246
474a40917f73 CONF_TYPE_AFMT similar to CONF_TYPE_IMGFMT
alex
parents: 11947
diff changeset
170 #define CONF_TYPE_AFMT (&m_option_type_afmt)
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
171 #define CONF_TYPE_SPAN (&m_option_type_span)
9593
e9a2af584986 Add the new -vf option wich is the same as vop in reverse order.
albeu
parents: 8736
diff changeset
172 #define CONF_TYPE_OBJ_SETTINGS_LIST (&m_option_type_obj_settings_list)
10594
57bdcdb061d7 Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents: 10590
diff changeset
173 #define CONF_TYPE_OBJ_PRESETS (&m_option_type_obj_presets)
57bdcdb061d7 Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents: 10590
diff changeset
174 #define CONF_TYPE_CUSTOM_URL (&m_option_type_custom_url)
57bdcdb061d7 Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents: 10590
diff changeset
175 #define CONF_TYPE_OBJ_PARAMS (&m_option_type_obj_params)
22312
cca9ff25bed2 Move parsing of the -ss option to the option code.
uau
parents: 19973
diff changeset
176 #define CONF_TYPE_TIME (&m_option_type_time)
19973
02a18c52a42a after a long time, finally i could add -endpos option to mplayer executable.
ptt
parents: 19053
diff changeset
177 #define CONF_TYPE_TIME_SIZE (&m_option_type_time_size)
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
178
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
179 /////////////////////////////////////////////////////////////////////////////////////////////
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
180
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
181 /// Option type description
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
182 struct m_option_type {
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
183 char* name;
18316
b3be7df634b0 spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents: 18283
diff changeset
184 /// Syntax description, etc
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
185 char* comments;
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
186 /// Size needed for the data.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
187 unsigned int size;
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
188 /// See \ref OptionTypeFlags.
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
189 unsigned int flags;
29263
0f1b5b68af32 whitespace cosmetics: Remove all trailing whitespace.
diego
parents: 28759
diff changeset
190
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
191 /// Parse the data from a string.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
192 /** It is the only required function, all others can be NULL.
29263
0f1b5b68af32 whitespace cosmetics: Remove all trailing whitespace.
diego
parents: 28759
diff changeset
193 *
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
194 * \param opt The option that is parsed.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
195 * \param name The full option name.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
196 * \param param The parameter to parse.
18283
67d35fe89c8d Fix most of the mistakes pointed out by Diego.
albeu
parents: 18258
diff changeset
197 * \param dst Pointer to the memory where the data should be written.
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
198 * If NULL the parameter validity should still be checked.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
199 * \param src Source of the option, see \ref OptionParserModes.
18283
67d35fe89c8d Fix most of the mistakes pointed out by Diego.
albeu
parents: 18258
diff changeset
200 * \return On error a negative value is returned, on success the number of arguments
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
201 * consumed. For details see \ref OptionParserReturn.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
202 */
24966
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
203 int (*parse)(const m_option_t* opt,const char *name, char *param, void* dst, int src);
29263
0f1b5b68af32 whitespace cosmetics: Remove all trailing whitespace.
diego
parents: 28759
diff changeset
204
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
205 /// Print back a value in string form.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
206 /** \param opt The option to print.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
207 * \param val Pointer to the memory holding the data to be printed.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
208 * \return An allocated string containing the text value or (void*)-1
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
209 * on error.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
210 */
25229
4f611a555224 Option print functions may not and do not modify value
reimar
parents: 24966
diff changeset
211 char* (*print)(const m_option_t* opt, const void* val);
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
212
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
213 /** \name
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
214 * These functions are called to save/set/restore the status of the
18283
67d35fe89c8d Fix most of the mistakes pointed out by Diego.
albeu
parents: 18258
diff changeset
215 * variables. The difference between the 3 only matters for types like
18316
b3be7df634b0 spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents: 18283
diff changeset
216 * \ref m_option_type_func where 'setting' needs to do more than just
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
217 * copying some data.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
218 */
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
219 //@{
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
220
18316
b3be7df634b0 spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents: 18283
diff changeset
221 /// Update a save slot (dst) from the current value in the program (src).
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
222 /** \param opt The option to copy.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
223 * \param dst Pointer to the destination memory.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
224 * \param src Pointer to the source memory.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
225 */
24966
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
226 void (*save)(const m_option_t* opt,void* dst, void* src);
29263
0f1b5b68af32 whitespace cosmetics: Remove all trailing whitespace.
diego
parents: 28759
diff changeset
227
18316
b3be7df634b0 spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents: 18283
diff changeset
228 /// Set the value in the program (dst) from a save slot.
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
229 /** \param opt The option to copy.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
230 * \param dst Pointer to the destination memory.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
231 * \param src Pointer to the source memory.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
232 */
24966
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
233 void (*set)(const m_option_t* opt,void* dst, void* src);
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
234
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
235 /// Copy the data between two save slots. If NULL and size is > 0 a memcpy will be used.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
236 /** \param opt The option to copy.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
237 * \param dst Pointer to the destination memory.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
238 * \param src Pointer to the source memory.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
239 */
24966
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
240 void (*copy)(const m_option_t* opt,void* dst, void* src);
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
241 //@}
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
242
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
243 /// Free the data allocated for a save slot.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
244 /** This is only needed for dynamic types like strings.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
245 * \param dst Pointer to the data, usually a pointer that should be freed and
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
246 * set to NULL.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
247 */
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
248 void (*free)(void* dst);
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
249 };
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
250
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
251 ///@}
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
252
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
253 /// Option description
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
254 /** \ingroup Options
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
255 */
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
256 struct m_option {
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
257 /// Option name.
24966
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
258 const char *name;
29263
0f1b5b68af32 whitespace cosmetics: Remove all trailing whitespace.
diego
parents: 28759
diff changeset
259
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
260 /// Reserved for higher level APIs, it shouldn't be used by parsers.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
261 /** The suboption parser and func types do use it. They should instead
18283
67d35fe89c8d Fix most of the mistakes pointed out by Diego.
albeu
parents: 18258
diff changeset
262 * use the priv field but this was inherited from older versions of the
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
263 * config code.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
264 */
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
265 void *p;
29263
0f1b5b68af32 whitespace cosmetics: Remove all trailing whitespace.
diego
parents: 28759
diff changeset
266
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
267 /// Option type.
24966
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
268 const m_option_type_t* type;
29263
0f1b5b68af32 whitespace cosmetics: Remove all trailing whitespace.
diego
parents: 28759
diff changeset
269
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
270 /// See \ref OptionFlags.
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
271 unsigned int flags;
29263
0f1b5b68af32 whitespace cosmetics: Remove all trailing whitespace.
diego
parents: 28759
diff changeset
272
18283
67d35fe89c8d Fix most of the mistakes pointed out by Diego.
albeu
parents: 18258
diff changeset
273 /// \brief Mostly useful for numeric types, the \ref M_OPT_MIN flags must
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
274 /// also be set.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
275 double min;
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
276
18283
67d35fe89c8d Fix most of the mistakes pointed out by Diego.
albeu
parents: 18258
diff changeset
277 /// \brief Mostly useful for numeric types, the \ref M_OPT_MAX flags must
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
278 /// also be set.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
279 double max;
29263
0f1b5b68af32 whitespace cosmetics: Remove all trailing whitespace.
diego
parents: 28759
diff changeset
280
18316
b3be7df634b0 spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents: 18283
diff changeset
281 /// Type dependent data (for all kinds of extended settings).
b3be7df634b0 spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents: 18283
diff changeset
282 /** This used to be a function pointer to hold a 'reverse to defaults' func.
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
283 * Now it can be used to pass any type of extra args needed by the parser.
18316
b3be7df634b0 spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents: 18283
diff changeset
284 * Passing a 'default func' is still valid for all func based option types.
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
285 */
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
286 void* priv;
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
287 };
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
288
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
289
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
290 /// \defgroup OptionFlags Option flags
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
291 ///@{
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
292
18283
67d35fe89c8d Fix most of the mistakes pointed out by Diego.
albeu
parents: 18258
diff changeset
293 /// The option has a minimum set in \ref m_option::min.
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
294 #define M_OPT_MIN (1<<0)
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
295
18283
67d35fe89c8d Fix most of the mistakes pointed out by Diego.
albeu
parents: 18258
diff changeset
296 /// The option has a maximum set in \ref m_option::max.
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
297 #define M_OPT_MAX (1<<1)
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
298
18283
67d35fe89c8d Fix most of the mistakes pointed out by Diego.
albeu
parents: 18258
diff changeset
299 /// The option has a minimum and maximum in \ref m_option::min and \ref m_option::max.
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
300 #define M_OPT_RANGE (M_OPT_MIN|M_OPT_MAX)
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
301
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
302 /// The option is forbidden in config files.
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
303 #define M_OPT_NOCFG (1<<2)
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
304
18283
67d35fe89c8d Fix most of the mistakes pointed out by Diego.
albeu
parents: 18258
diff changeset
305 /// The option is forbidden on the command line.
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
306 #define M_OPT_NOCMD (1<<3)
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
307
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
308 /// The option is global in the \ref Config.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
309 /** It won't be saved on push and the command line parser will set it when
18316
b3be7df634b0 spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents: 18283
diff changeset
310 * it's parsed (i.e. it won't be set later)
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
311 * e.g options : -v, -quiet
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
312 */
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
313 #define M_OPT_GLOBAL (1<<4)
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
314
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
315 /// The \ref Config won't save this option on push.
18283
67d35fe89c8d Fix most of the mistakes pointed out by Diego.
albeu
parents: 18258
diff changeset
316 /** It won't be saved on push but the command line parser will add it with
18316
b3be7df634b0 spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents: 18283
diff changeset
317 * its entry (i.e. it may be set later)
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
318 * e.g options : -include
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
319 */
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
320 #define M_OPT_NOSAVE (1<<5)
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
321
18316
b3be7df634b0 spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents: 18283
diff changeset
322 /// \brief The \ref Config will emulate the old behavior by pushing the
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
323 /// option only if it was set by the user.
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
324 #define M_OPT_OLD (1<<6)
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
325
26408
7a36d5941fd8 Replace the trivial command line preparser with a more robust version
albeu
parents: 26131
diff changeset
326 /// The option should be set during command line pre-parsing
7a36d5941fd8 Replace the trivial command line preparser with a more robust version
albeu
parents: 26131
diff changeset
327 #define M_OPT_PRE_PARSE (1<<7)
7a36d5941fd8 Replace the trivial command line preparser with a more robust version
albeu
parents: 26131
diff changeset
328
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
329 /// \defgroup OldOptionFlags Backward compatibility
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
330 ///
18316
b3be7df634b0 spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents: 18283
diff changeset
331 /// These are kept for compatibility with older code.
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
332 /// @{
10594
57bdcdb061d7 Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents: 10590
diff changeset
333 #define CONF_MIN M_OPT_MIN
57bdcdb061d7 Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents: 10590
diff changeset
334 #define CONF_MAX M_OPT_MAX
57bdcdb061d7 Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents: 10590
diff changeset
335 #define CONF_RANGE M_OPT_RANGE
57bdcdb061d7 Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents: 10590
diff changeset
336 #define CONF_NOCFG M_OPT_NOCFG
57bdcdb061d7 Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents: 10590
diff changeset
337 #define CONF_NOCMD M_OPT_NOCMD
57bdcdb061d7 Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents: 10590
diff changeset
338 #define CONF_GLOBAL M_OPT_GLOBAL
57bdcdb061d7 Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents: 10590
diff changeset
339 #define CONF_NOSAVE M_OPT_NOSAVE
57bdcdb061d7 Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents: 10590
diff changeset
340 #define CONF_OLD M_OPT_OLD
26408
7a36d5941fd8 Replace the trivial command line preparser with a more robust version
albeu
parents: 26131
diff changeset
341 #define CONF_PRE_PARSE M_OPT_PRE_PARSE
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
342 ///@}
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
343
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
344 ///@}
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
345
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
346 /// \defgroup OptionTypeFlags Option type flags
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
347 /// \ingroup OptionTypes
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
348 ///
18316
b3be7df634b0 spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents: 18283
diff changeset
349 /// These flags are used to describe special parser capabilities or behavior.
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
350 ///
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
351 ///@{
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
352
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
353 /// Suboption parser flag.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
354 /** When this flag is set, m_option::p should point to another m_option
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
355 * array. Only the parse function will be called. If dst is set, it should
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
356 * create/update an array of char* containg opt/val pairs. The options in
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
357 * the child array will then be set automatically by the \ref Config.
18283
67d35fe89c8d Fix most of the mistakes pointed out by Diego.
albeu
parents: 18258
diff changeset
358 * Also note that suboptions may be directly accessed by using
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
359 * -option:subopt blah.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
360 */
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
361 #define M_OPT_TYPE_HAS_CHILD (1<<0)
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
362
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
363 /// Wildcard matching flag.
18316
b3be7df634b0 spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents: 18283
diff changeset
364 /** If set the option type has a use for option names ending with a *
18283
67d35fe89c8d Fix most of the mistakes pointed out by Diego.
albeu
parents: 18258
diff changeset
365 * (used for -aa*), this only affects the option name matching.
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
366 */
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
367 #define M_OPT_TYPE_ALLOW_WILDCARD (1<<1)
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
368
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
369 /// Dynamic data type.
18316
b3be7df634b0 spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents: 18283
diff changeset
370 /** This flag indicates that the data is dynamically allocated (m_option::p
b3be7df634b0 spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents: 18283
diff changeset
371 * points to a pointer). It enables a little hack in the \ref Config wich
b3be7df634b0 spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents: 18283
diff changeset
372 * replaces the initial value of such variables with a dynamic copy in case
b3be7df634b0 spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents: 18283
diff changeset
373 * the initial value is statically allocated (pretty common with strings).
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
374 */
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
375 #define M_OPT_TYPE_DYNAMIC (1<<2)
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
376
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
377 /// Indirect option type.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
378 /** If this is set the parse function doesn't directly return
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
379 * the wanted thing. Options use this if for some reasons they have to wait
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
380 * until the set call to be able to correctly set the target var.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
381 * So for those types new values must first be parsed, then set to the target
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
382 * var. If this flag isn't set then new values can be parsed directly to the
18316
b3be7df634b0 spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents: 18283
diff changeset
383 * target var. It's used by the callback-based options as the callback call
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
384 * may append later on.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
385 */
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
386 #define M_OPT_TYPE_INDIRECT (1<<3)
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
387
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
388 ///@}
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
389
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
390 ///////////////////////////// Parser flags ////////////////////////////////////////
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
391
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
392 /// \defgroup OptionParserModes Option parser modes
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
393 /// \ingroup Options
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
394 ///
18316
b3be7df634b0 spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents: 18283
diff changeset
395 /// Some parsers behave differently depending on the mode passed in the src
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
396 /// parameter of m_option_type::parse. For example the flag type doesn't take
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
397 /// an argument when parsing from the command line.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
398 ///@{
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
399
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
400 /// Set when parsing from a config file.
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
401 #define M_CONFIG_FILE 0
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
402 /// Set when parsing command line arguments.
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
403 #define M_COMMAND_LINE 1
26408
7a36d5941fd8 Replace the trivial command line preparser with a more robust version
albeu
parents: 26131
diff changeset
404 /// Set when pre-parsing the command line
7a36d5941fd8 Replace the trivial command line preparser with a more robust version
albeu
parents: 26131
diff changeset
405 #define M_COMMAND_LINE_PRE_PARSE 2
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
406
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
407 ///@}
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
408
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
409 /// \defgroup OptionParserReturn Option parser return code
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
410 /// \ingroup Options
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
411 ///
18283
67d35fe89c8d Fix most of the mistakes pointed out by Diego.
albeu
parents: 18258
diff changeset
412 /// On success parsers return the number of arguments consumed: 0 or 1.
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
413 ///
18283
67d35fe89c8d Fix most of the mistakes pointed out by Diego.
albeu
parents: 18258
diff changeset
414 /// To indicate that MPlayer should exit without playing anything,
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
415 /// parsers return M_OPT_EXIT minus the number of parameters they
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
416 /// consumed: \ref M_OPT_EXIT or \ref M_OPT_EXIT-1.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
417 ///
18283
67d35fe89c8d Fix most of the mistakes pointed out by Diego.
albeu
parents: 18258
diff changeset
418 /// On error one of the following (negative) error codes is returned:
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
419 ///@{
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
420
18283
67d35fe89c8d Fix most of the mistakes pointed out by Diego.
albeu
parents: 18258
diff changeset
421 /// For use by higher level APIs when the option name is invalid.
10595
522afd56703c 100l to albeu for his english grammar, and 10l to me becouse I noticed that lately (my backward compatibilty macro uses M_OPT_UNKNOWN)
alex
parents: 10594
diff changeset
422 #define M_OPT_UNKNOWN -1
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
423
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
424 /// Returned when a parameter is needed but wasn't provided.
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
425 #define M_OPT_MISSING_PARAM -2
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
426
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
427 /// Returned when the given parameter couldn't be parsed.
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
428 #define M_OPT_INVALID -3
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
429
29263
0f1b5b68af32 whitespace cosmetics: Remove all trailing whitespace.
diego
parents: 28759
diff changeset
430 /// \brief Returned if the value is "out of range". The exact meaning may
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
431 /// vary from type to type.
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
432 #define M_OPT_OUT_OF_RANGE -4
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
433
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
434 /// Returned if the parser failed for any other reason than a bad parameter.
10594
57bdcdb061d7 Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents: 10590
diff changeset
435 #define M_OPT_PARSER_ERR -5
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
436
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
437 /// Returned when MPlayer should exit. Used by various help stuff.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
438 /** M_OPT_EXIT must be the lowest number on this list.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
439 */
9791
c5b63e88253d Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents: 9593
diff changeset
440 #define M_OPT_EXIT -6
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
441
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
442 /// \defgroup OldOptionParserReturn Backward compatibility
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
443 ///
18283
67d35fe89c8d Fix most of the mistakes pointed out by Diego.
albeu
parents: 18258
diff changeset
444 /// These are kept for compatibility with older code.
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
445 ///
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
446 ///@{
10594
57bdcdb061d7 Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents: 10590
diff changeset
447 #define ERR_NOT_AN_OPTION M_OPT_UNKNOWN
57bdcdb061d7 Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents: 10590
diff changeset
448 #define ERR_MISSING_PARAM M_OPT_MISSING_PARAM
57bdcdb061d7 Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents: 10590
diff changeset
449 #define ERR_OUT_OF_RANGE M_OPT_OUT_OF_RANGE
57bdcdb061d7 Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents: 10590
diff changeset
450 #define ERR_FUNC_ERR M_OPT_PARSER_ERR
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
451 ///@}
10594
57bdcdb061d7 Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents: 10590
diff changeset
452
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
453 ///@}
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
454
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
455 /// Find the option matching the given name in the list.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
456 /** \ingroup Options
18283
67d35fe89c8d Fix most of the mistakes pointed out by Diego.
albeu
parents: 18258
diff changeset
457 * This function takes the possible wildcards into account (see
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
458 * \ref M_OPT_TYPE_ALLOW_WILDCARD).
29263
0f1b5b68af32 whitespace cosmetics: Remove all trailing whitespace.
diego
parents: 28759
diff changeset
459 *
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
460 * \param list Pointer to an array of \ref m_option.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
461 * \param name Name of the option.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
462 * \return The matching option or NULL.
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
463 */
24966
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
464 const m_option_t* m_option_list_find(const m_option_t* list,const char* name);
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
465
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
466 /// Helper to parse options, see \ref m_option_type::parse.
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
467 inline static int
24966
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
468 m_option_parse(const m_option_t* opt,const char *name, char *param, void* dst, int src) {
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
469 return opt->type->parse(opt,name,param,dst,src);
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
470 }
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
471
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
472 /// Helper to print options, see \ref m_option_type::print.
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
473 inline static char*
25229
4f611a555224 Option print functions may not and do not modify value
reimar
parents: 24966
diff changeset
474 m_option_print(const m_option_t* opt, const void* val_ptr) {
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
475 if(opt->type->print)
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
476 return opt->type->print(opt,val_ptr);
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
477 else
8168
ff6a98628e6c Fix the Gui with NEW_CONFIG
albeu
parents: 8164
diff changeset
478 return (char*)-1;
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
479 }
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
480
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
481 /// Helper around \ref m_option_type::save.
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
482 inline static void
24966
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
483 m_option_save(const m_option_t* opt,void* dst, void* src) {
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
484 if(opt->type->save)
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
485 opt->type->save(opt,dst,src);
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
486 }
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
487
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
488 /// Helper around \ref m_option_type::set.
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
489 inline static void
24966
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
490 m_option_set(const m_option_t* opt,void* dst, void* src) {
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
491 if(opt->type->set)
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
492 opt->type->set(opt,dst,src);
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
493 }
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
494
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
495 /// Helper around \ref m_option_type::copy.
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
496 inline static void
24966
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
497 m_option_copy(const m_option_t* opt,void* dst, void* src) {
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
498 if(opt->type->copy)
17456
b8ce59172e6a 100L m_option_copy should use the copy callback and not the set one.
albeu
parents: 16345
diff changeset
499 opt->type->copy(opt,dst,src);
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
500 else if(opt->type->size > 0)
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
501 memcpy(dst,src,opt->type->size);
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
502 }
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
503
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
504 /// Helper around \ref m_option_type::free.
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
505 inline static void
24966
cc170348a763 correct const usage in the option handling code so that tables can be
rfelker
parents: 23689
diff changeset
506 m_option_free(const m_option_t* opt,void* dst) {
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
507 if(opt->type->free)
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
508 opt->type->free(dst);
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
509 }
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
510
18258
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
511 /*@}*/
96568be4bfdc Doxygen attack!
albeu
parents: 17470
diff changeset
512
26029
4129c8cfa742 Add MPLAYER_ prefix to multiple inclusion guards.
diego
parents: 25229
diff changeset
513 #endif /* MPLAYER_M_OPTION_H */