| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 |
<html> |
| 3 |
<head> |
| 4 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| 5 |
<title>prelude-option: libprelude Reference Manual</title> |
| 6 |
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> |
| 7 |
<link rel="home" href="index.html" title="libprelude Reference Manual"> |
| 8 |
<link rel="up" href="ch01.html" title="[Insert title here]"> |
| 9 |
<link rel="prev" href="libprelude-prelude-msg.html" title="prelude-msg"> |
| 10 |
<link rel="next" href="libprelude-prelude-connection.html" title="prelude-connection"> |
| 11 |
<meta name="generator" content="GTK-Doc V1.28 (XML mode)"> |
| 12 |
<link rel="stylesheet" href="style.css" type="text/css"> |
| 13 |
</head> |
| 14 |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| 15 |
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> |
| 16 |
<td width="100%" align="left" class="shortcuts"> |
| 17 |
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> |
| 18 |
<a href="#libprelude-prelude-option.description" class="shortcut">Description</a></span> |
| 19 |
</td> |
| 20 |
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> |
| 21 |
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
| 22 |
<td><a accesskey="p" href="libprelude-prelude-msg.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| 23 |
<td><a accesskey="n" href="libprelude-prelude-connection.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| 24 |
</tr></table> |
| 25 |
<div class="refentry"> |
| 26 |
<a name="libprelude-prelude-option"></a><div class="titlepage"></div> |
| 27 |
<div class="refnamediv"><table width="100%"><tr> |
| 28 |
<td valign="top"> |
| 29 |
<h2><span class="refentrytitle"><a name="libprelude-prelude-option.top_of_page"></a>prelude-option</span></h2> |
| 30 |
<p>prelude-option</p> |
| 31 |
</td> |
| 32 |
<td class="gallery_image" valign="top" align="right"></td> |
| 33 |
</tr></table></div> |
| 34 |
<div class="refsect1"> |
| 35 |
<a name="libprelude-prelude-option.functions"></a><h2>Functions</h2> |
| 36 |
<div class="informaltable"><table width="100%" border="0"> |
| 37 |
<colgroup> |
| 38 |
<col width="150px" class="functions_return"> |
| 39 |
<col class="functions_name"> |
| 40 |
</colgroup> |
| 41 |
<tbody> |
| 42 |
<tr> |
| 43 |
<td class="function_type"> |
| 44 |
<span class="returnvalue">int</span> |
| 45 |
</td> |
| 46 |
<td class="function_name"> |
| 47 |
<span class="c_punctuation">(</span><a class="link" href="libprelude-prelude-option.html#prelude-option-destroy-callback-t" title="prelude_option_destroy_callback_t ()">*prelude_option_destroy_callback_t</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> |
| 48 |
</td> |
| 49 |
</tr> |
| 50 |
<tr> |
| 51 |
<td class="function_type"> |
| 52 |
<span class="returnvalue">int</span> |
| 53 |
</td> |
| 54 |
<td class="function_name"> |
| 55 |
<span class="c_punctuation">(</span><a class="link" href="libprelude-prelude-option.html#prelude-option-commit-callback-t" title="prelude_option_commit_callback_t ()">*prelude_option_commit_callback_t</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> |
| 56 |
</td> |
| 57 |
</tr> |
| 58 |
<tr> |
| 59 |
<td class="function_type"> |
| 60 |
<span class="returnvalue">int</span> |
| 61 |
</td> |
| 62 |
<td class="function_name"> |
| 63 |
<span class="c_punctuation">(</span><a class="link" href="libprelude-prelude-option.html#prelude-option-get-callback-t" title="prelude_option_get_callback_t ()">*prelude_option_get_callback_t</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> |
| 64 |
</td> |
| 65 |
</tr> |
| 66 |
<tr> |
| 67 |
<td class="function_type"> |
| 68 |
<span class="returnvalue">int</span> |
| 69 |
</td> |
| 70 |
<td class="function_name"> |
| 71 |
<span class="c_punctuation">(</span><a class="link" href="libprelude-prelude-option.html#prelude-option-set-callback-t" title="prelude_option_set_callback_t ()">*prelude_option_set_callback_t</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> |
| 72 |
</td> |
| 73 |
</tr> |
| 74 |
<tr> |
| 75 |
<td class="function_type"> |
| 76 |
<span class="returnvalue">void</span> |
| 77 |
</td> |
| 78 |
<td class="function_name"> |
| 79 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-set-priority" title="prelude_option_set_priority ()">prelude_option_set_priority</a> <span class="c_punctuation">()</span> |
| 80 |
</td> |
| 81 |
</tr> |
| 82 |
<tr> |
| 83 |
<td class="function_type"> |
| 84 |
<span class="returnvalue">void</span> |
| 85 |
</td> |
| 86 |
<td class="function_name"> |
| 87 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-print" title="prelude_option_print ()">prelude_option_print</a> <span class="c_punctuation">()</span> |
| 88 |
</td> |
| 89 |
</tr> |
| 90 |
<tr> |
| 91 |
<td class="function_type"> |
| 92 |
<span class="returnvalue">int</span> |
| 93 |
</td> |
| 94 |
<td class="function_name"> |
| 95 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-wide-send-msg" title="prelude_option_wide_send_msg ()">prelude_option_wide_send_msg</a> <span class="c_punctuation">()</span> |
| 96 |
</td> |
| 97 |
</tr> |
| 98 |
<tr> |
| 99 |
<td class="function_type"> |
| 100 |
<span class="returnvalue">void</span> |
| 101 |
</td> |
| 102 |
<td class="function_name"> |
| 103 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-destroy" title="prelude_option_destroy ()">prelude_option_destroy</a> <span class="c_punctuation">()</span> |
| 104 |
</td> |
| 105 |
</tr> |
| 106 |
<tr> |
| 107 |
<td class="function_type"> |
| 108 |
<span class="returnvalue">int</span> |
| 109 |
</td> |
| 110 |
<td class="function_name"> |
| 111 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-read" title="prelude_option_read ()">prelude_option_read</a> <span class="c_punctuation">()</span> |
| 112 |
</td> |
| 113 |
</tr> |
| 114 |
<tr> |
| 115 |
<td class="function_type"> |
| 116 |
<span class="returnvalue">int</span> |
| 117 |
</td> |
| 118 |
<td class="function_name"> |
| 119 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-add" title="prelude_option_add ()">prelude_option_add</a> <span class="c_punctuation">()</span> |
| 120 |
</td> |
| 121 |
</tr> |
| 122 |
<tr> |
| 123 |
<td class="function_type"> |
| 124 |
<span class="returnvalue">void</span> |
| 125 |
</td> |
| 126 |
<td class="function_name"> |
| 127 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-set-type" title="prelude_option_set_type ()">prelude_option_set_type</a> <span class="c_punctuation">()</span> |
| 128 |
</td> |
| 129 |
</tr> |
| 130 |
<tr> |
| 131 |
<td class="function_type"> |
| 132 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-type-t" title="enum prelude_option_type_t"><span class="returnvalue">prelude_option_type_t</span></a> |
| 133 |
</td> |
| 134 |
<td class="function_name"> |
| 135 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-get-type" title="prelude_option_get_type ()">prelude_option_get_type</a> <span class="c_punctuation">()</span> |
| 136 |
</td> |
| 137 |
</tr> |
| 138 |
<tr> |
| 139 |
<td class="function_type"> |
| 140 |
<span class="returnvalue">void</span> |
| 141 |
</td> |
| 142 |
<td class="function_name"> |
| 143 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-set-warnings" title="prelude_option_set_warnings ()">prelude_option_set_warnings</a> <span class="c_punctuation">()</span> |
| 144 |
</td> |
| 145 |
</tr> |
| 146 |
<tr> |
| 147 |
<td class="function_type"> |
| 148 |
<span class="returnvalue">char</span> |
| 149 |
</td> |
| 150 |
<td class="function_name"> |
| 151 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-get-shortname" title="prelude_option_get_shortname ()">prelude_option_get_shortname</a> <span class="c_punctuation">()</span> |
| 152 |
</td> |
| 153 |
</tr> |
| 154 |
<tr> |
| 155 |
<td class="function_type">const <span class="returnvalue">char</span> * |
| 156 |
</td> |
| 157 |
<td class="function_name"> |
| 158 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-get-longname" title="prelude_option_get_longname ()">prelude_option_get_longname</a> <span class="c_punctuation">()</span> |
| 159 |
</td> |
| 160 |
</tr> |
| 161 |
<tr> |
| 162 |
<td class="function_type"> |
| 163 |
<span class="returnvalue">void</span> |
| 164 |
</td> |
| 165 |
<td class="function_name"> |
| 166 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-set-data" title="prelude_option_set_data ()">prelude_option_set_data</a> <span class="c_punctuation">()</span> |
| 167 |
</td> |
| 168 |
</tr> |
| 169 |
<tr> |
| 170 |
<td class="function_type"> |
| 171 |
<span class="returnvalue">void</span> * |
| 172 |
</td> |
| 173 |
<td class="function_name"> |
| 174 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-get-data" title="prelude_option_get_data ()">prelude_option_get_data</a> <span class="c_punctuation">()</span> |
| 175 |
</td> |
| 176 |
</tr> |
| 177 |
<tr> |
| 178 |
<td class="function_type"> |
| 179 |
<span class="returnvalue">void</span> * |
| 180 |
</td> |
| 181 |
<td class="function_name"> |
| 182 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-context-get-data" title="prelude_option_context_get_data ()">prelude_option_context_get_data</a> <span class="c_punctuation">()</span> |
| 183 |
</td> |
| 184 |
</tr> |
| 185 |
<tr> |
| 186 |
<td class="function_type"> |
| 187 |
<span class="returnvalue">void</span> |
| 188 |
</td> |
| 189 |
<td class="function_name"> |
| 190 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-context-set-data" title="prelude_option_context_set_data ()">prelude_option_context_set_data</a> <span class="c_punctuation">()</span> |
| 191 |
</td> |
| 192 |
</tr> |
| 193 |
<tr> |
| 194 |
<td class="function_type"> |
| 195 |
<span class="returnvalue">int</span> |
| 196 |
</td> |
| 197 |
<td class="function_name"> |
| 198 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-invoke-commit" title="prelude_option_invoke_commit ()">prelude_option_invoke_commit</a> <span class="c_punctuation">()</span> |
| 199 |
</td> |
| 200 |
</tr> |
| 201 |
<tr> |
| 202 |
<td class="function_type"> |
| 203 |
<span class="returnvalue">int</span> |
| 204 |
</td> |
| 205 |
<td class="function_name"> |
| 206 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-invoke-set" title="prelude_option_invoke_set ()">prelude_option_invoke_set</a> <span class="c_punctuation">()</span> |
| 207 |
</td> |
| 208 |
</tr> |
| 209 |
<tr> |
| 210 |
<td class="function_type"> |
| 211 |
<span class="returnvalue">int</span> |
| 212 |
</td> |
| 213 |
<td class="function_name"> |
| 214 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-invoke-get" title="prelude_option_invoke_get ()">prelude_option_invoke_get</a> <span class="c_punctuation">()</span> |
| 215 |
</td> |
| 216 |
</tr> |
| 217 |
<tr> |
| 218 |
<td class="function_type"> |
| 219 |
<span class="returnvalue">int</span> |
| 220 |
</td> |
| 221 |
<td class="function_name"> |
| 222 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-invoke-destroy" title="prelude_option_invoke_destroy ()">prelude_option_invoke_destroy</a> <span class="c_punctuation">()</span> |
| 223 |
</td> |
| 224 |
</tr> |
| 225 |
<tr> |
| 226 |
<td class="function_type"> |
| 227 |
<span class="returnvalue">int</span> |
| 228 |
</td> |
| 229 |
<td class="function_name"> |
| 230 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-new-root" title="prelude_option_new_root ()">prelude_option_new_root</a> <span class="c_punctuation">()</span> |
| 231 |
</td> |
| 232 |
</tr> |
| 233 |
<tr> |
| 234 |
<td class="function_type"> |
| 235 |
<span class="returnvalue">int</span> |
| 236 |
</td> |
| 237 |
<td class="function_name"> |
| 238 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-new" title="prelude_option_new ()">prelude_option_new</a> <span class="c_punctuation">()</span> |
| 239 |
</td> |
| 240 |
</tr> |
| 241 |
<tr> |
| 242 |
<td class="function_type"> |
| 243 |
<span class="returnvalue">void</span> |
| 244 |
</td> |
| 245 |
<td class="function_name"> |
| 246 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-set-longopt" title="prelude_option_set_longopt ()">prelude_option_set_longopt</a> <span class="c_punctuation">()</span> |
| 247 |
</td> |
| 248 |
</tr> |
| 249 |
<tr> |
| 250 |
<td class="function_type">const <span class="returnvalue">char</span> * |
| 251 |
</td> |
| 252 |
<td class="function_name"> |
| 253 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-get-longopt" title="prelude_option_get_longopt ()">prelude_option_get_longopt</a> <span class="c_punctuation">()</span> |
| 254 |
</td> |
| 255 |
</tr> |
| 256 |
<tr> |
| 257 |
<td class="function_type"> |
| 258 |
<span class="returnvalue">void</span> |
| 259 |
</td> |
| 260 |
<td class="function_name"> |
| 261 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-set-description" title="prelude_option_set_description ()">prelude_option_set_description</a> <span class="c_punctuation">()</span> |
| 262 |
</td> |
| 263 |
</tr> |
| 264 |
<tr> |
| 265 |
<td class="function_type">const <span class="returnvalue">char</span> * |
| 266 |
</td> |
| 267 |
<td class="function_name"> |
| 268 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-get-description" title="prelude_option_get_description ()">prelude_option_get_description</a> <span class="c_punctuation">()</span> |
| 269 |
</td> |
| 270 |
</tr> |
| 271 |
<tr> |
| 272 |
<td class="function_type"> |
| 273 |
<span class="returnvalue">void</span> |
| 274 |
</td> |
| 275 |
<td class="function_name"> |
| 276 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-set-has-arg" title="prelude_option_set_has_arg ()">prelude_option_set_has_arg</a> <span class="c_punctuation">()</span> |
| 277 |
</td> |
| 278 |
</tr> |
| 279 |
<tr> |
| 280 |
<td class="function_type"> |
| 281 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-argument-t" title="enum prelude_option_argument_t"><span class="returnvalue">prelude_option_argument_t</span></a> |
| 282 |
</td> |
| 283 |
<td class="function_name"> |
| 284 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-get-has-arg" title="prelude_option_get_has_arg ()">prelude_option_get_has_arg</a> <span class="c_punctuation">()</span> |
| 285 |
</td> |
| 286 |
</tr> |
| 287 |
<tr> |
| 288 |
<td class="function_type"> |
| 289 |
<span class="returnvalue">void</span> |
| 290 |
</td> |
| 291 |
<td class="function_name"> |
| 292 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-set-value" title="prelude_option_set_value ()">prelude_option_set_value</a> <span class="c_punctuation">()</span> |
| 293 |
</td> |
| 294 |
</tr> |
| 295 |
<tr> |
| 296 |
<td class="function_type">const <span class="returnvalue">char</span> * |
| 297 |
</td> |
| 298 |
<td class="function_name"> |
| 299 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-get-value" title="prelude_option_get_value ()">prelude_option_get_value</a> <span class="c_punctuation">()</span> |
| 300 |
</td> |
| 301 |
</tr> |
| 302 |
<tr> |
| 303 |
<td class="function_type"> |
| 304 |
<span class="returnvalue">void</span> |
| 305 |
</td> |
| 306 |
<td class="function_name"> |
| 307 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-set-help" title="prelude_option_set_help ()">prelude_option_set_help</a> <span class="c_punctuation">()</span> |
| 308 |
</td> |
| 309 |
</tr> |
| 310 |
<tr> |
| 311 |
<td class="function_type">const <span class="returnvalue">char</span> * |
| 312 |
</td> |
| 313 |
<td class="function_name"> |
| 314 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-get-help" title="prelude_option_get_help ()">prelude_option_get_help</a> <span class="c_punctuation">()</span> |
| 315 |
</td> |
| 316 |
</tr> |
| 317 |
<tr> |
| 318 |
<td class="function_type"> |
| 319 |
<span class="returnvalue">void</span> |
| 320 |
</td> |
| 321 |
<td class="function_name"> |
| 322 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-set-input-validation-regex" title="prelude_option_set_input_validation_regex ()">prelude_option_set_input_validation_regex</a> <span class="c_punctuation">()</span> |
| 323 |
</td> |
| 324 |
</tr> |
| 325 |
<tr> |
| 326 |
<td class="function_type">const <span class="returnvalue">char</span> * |
| 327 |
</td> |
| 328 |
<td class="function_name"> |
| 329 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-get-input-validation-regex" title="prelude_option_get_input_validation_regex ()">prelude_option_get_input_validation_regex</a> <span class="c_punctuation">()</span> |
| 330 |
</td> |
| 331 |
</tr> |
| 332 |
<tr> |
| 333 |
<td class="function_type"> |
| 334 |
<span class="returnvalue">void</span> |
| 335 |
</td> |
| 336 |
<td class="function_name"> |
| 337 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-set-input-type" title="prelude_option_set_input_type ()">prelude_option_set_input_type</a> <span class="c_punctuation">()</span> |
| 338 |
</td> |
| 339 |
</tr> |
| 340 |
<tr> |
| 341 |
<td class="function_type"> |
| 342 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-input-type-t" title="enum prelude_option_input_type_t"><span class="returnvalue">prelude_option_input_type_t</span></a> |
| 343 |
</td> |
| 344 |
<td class="function_name"> |
| 345 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-get-input-type" title="prelude_option_get_input_type ()">prelude_option_get_input_type</a> <span class="c_punctuation">()</span> |
| 346 |
</td> |
| 347 |
</tr> |
| 348 |
<tr> |
| 349 |
<td class="function_type"> |
| 350 |
<a class="link" href="libprelude-prelude-list.html#prelude-list-t" title="prelude_list_t"><span class="returnvalue">prelude_list_t</span></a> * |
| 351 |
</td> |
| 352 |
<td class="function_name"> |
| 353 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-get-optlist" title="prelude_option_get_optlist ()">prelude_option_get_optlist</a> <span class="c_punctuation">()</span> |
| 354 |
</td> |
| 355 |
</tr> |
| 356 |
<tr> |
| 357 |
<td class="function_type"> |
| 358 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="returnvalue">prelude_option_t</span></a> * |
| 359 |
</td> |
| 360 |
<td class="function_name"> |
| 361 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-get-next" title="prelude_option_get_next ()">prelude_option_get_next</a> <span class="c_punctuation">()</span> |
| 362 |
</td> |
| 363 |
</tr> |
| 364 |
<tr> |
| 365 |
<td class="function_type"> |
| 366 |
<a class="link" href="libprelude-prelude-inttypes.html#prelude-bool-t" title="enum prelude_bool_t"><span class="returnvalue">prelude_bool_t</span></a> |
| 367 |
</td> |
| 368 |
<td class="function_name"> |
| 369 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-has-optlist" title="prelude_option_has_optlist ()">prelude_option_has_optlist</a> <span class="c_punctuation">()</span> |
| 370 |
</td> |
| 371 |
</tr> |
| 372 |
<tr> |
| 373 |
<td class="function_type"> |
| 374 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="returnvalue">prelude_option_t</span></a> * |
| 375 |
</td> |
| 376 |
<td class="function_name"> |
| 377 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-get-parent" title="prelude_option_get_parent ()">prelude_option_get_parent</a> <span class="c_punctuation">()</span> |
| 378 |
</td> |
| 379 |
</tr> |
| 380 |
<tr> |
| 381 |
<td class="function_type"> |
| 382 |
<span class="returnvalue">void</span> |
| 383 |
</td> |
| 384 |
<td class="function_name"> |
| 385 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-set-destroy-callback" title="prelude_option_set_destroy_callback ()">prelude_option_set_destroy_callback</a> <span class="c_punctuation">()</span> |
| 386 |
</td> |
| 387 |
</tr> |
| 388 |
<tr> |
| 389 |
<td class="function_type"> |
| 390 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-destroy-callback-t" title="prelude_option_destroy_callback_t ()"><span class="returnvalue">prelude_option_destroy_callback_t</span></a> |
| 391 |
</td> |
| 392 |
<td class="function_name"> |
| 393 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-get-destroy-callback" title="prelude_option_get_destroy_callback ()">prelude_option_get_destroy_callback</a> <span class="c_punctuation">()</span> |
| 394 |
</td> |
| 395 |
</tr> |
| 396 |
<tr> |
| 397 |
<td class="function_type"> |
| 398 |
<span class="returnvalue">void</span> |
| 399 |
</td> |
| 400 |
<td class="function_name"> |
| 401 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-set-set-callback" title="prelude_option_set_set_callback ()">prelude_option_set_set_callback</a> <span class="c_punctuation">()</span> |
| 402 |
</td> |
| 403 |
</tr> |
| 404 |
<tr> |
| 405 |
<td class="function_type"> |
| 406 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-set-callback-t" title="prelude_option_set_callback_t ()"><span class="returnvalue">prelude_option_set_callback_t</span></a> |
| 407 |
</td> |
| 408 |
<td class="function_name"> |
| 409 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-get-set-callback" title="prelude_option_get_set_callback ()">prelude_option_get_set_callback</a> <span class="c_punctuation">()</span> |
| 410 |
</td> |
| 411 |
</tr> |
| 412 |
<tr> |
| 413 |
<td class="function_type"> |
| 414 |
<span class="returnvalue">void</span> |
| 415 |
</td> |
| 416 |
<td class="function_name"> |
| 417 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-set-get-callback" title="prelude_option_set_get_callback ()">prelude_option_set_get_callback</a> <span class="c_punctuation">()</span> |
| 418 |
</td> |
| 419 |
</tr> |
| 420 |
<tr> |
| 421 |
<td class="function_type"> |
| 422 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-get-callback-t" title="prelude_option_get_callback_t ()"><span class="returnvalue">prelude_option_get_callback_t</span></a> |
| 423 |
</td> |
| 424 |
<td class="function_name"> |
| 425 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-get-get-callback" title="prelude_option_get_get_callback ()">prelude_option_get_get_callback</a> <span class="c_punctuation">()</span> |
| 426 |
</td> |
| 427 |
</tr> |
| 428 |
<tr> |
| 429 |
<td class="function_type"> |
| 430 |
<span class="returnvalue">void</span> |
| 431 |
</td> |
| 432 |
<td class="function_name"> |
| 433 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-set-commit-callback" title="prelude_option_set_commit_callback ()">prelude_option_set_commit_callback</a> <span class="c_punctuation">()</span> |
| 434 |
</td> |
| 435 |
</tr> |
| 436 |
<tr> |
| 437 |
<td class="function_type"> |
| 438 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-commit-callback-t" title="prelude_option_commit_callback_t ()"><span class="returnvalue">prelude_option_commit_callback_t</span></a> |
| 439 |
</td> |
| 440 |
<td class="function_name"> |
| 441 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-get-commit-callback" title="prelude_option_get_commit_callback ()">prelude_option_get_commit_callback</a> <span class="c_punctuation">()</span> |
| 442 |
</td> |
| 443 |
</tr> |
| 444 |
<tr> |
| 445 |
<td class="function_type"> |
| 446 |
<span class="returnvalue">void</span> |
| 447 |
</td> |
| 448 |
<td class="function_name"> |
| 449 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-set-default-context" title="prelude_option_set_default_context ()">prelude_option_set_default_context</a> <span class="c_punctuation">()</span> |
| 450 |
</td> |
| 451 |
</tr> |
| 452 |
<tr> |
| 453 |
<td class="function_type"> |
| 454 |
<span class="returnvalue">int</span> |
| 455 |
</td> |
| 456 |
<td class="function_name"> |
| 457 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-new-context" title="prelude_option_new_context ()">prelude_option_new_context</a> <span class="c_punctuation">()</span> |
| 458 |
</td> |
| 459 |
</tr> |
| 460 |
<tr> |
| 461 |
<td class="function_type"> |
| 462 |
<span class="returnvalue">void</span> |
| 463 |
</td> |
| 464 |
<td class="function_name"> |
| 465 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-context-destroy" title="prelude_option_context_destroy ()">prelude_option_context_destroy</a> <span class="c_punctuation">()</span> |
| 466 |
</td> |
| 467 |
</tr> |
| 468 |
<tr> |
| 469 |
<td class="function_type"> |
| 470 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="returnvalue">prelude_option_t</span></a> * |
| 471 |
</td> |
| 472 |
<td class="function_name"> |
| 473 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-search" title="prelude_option_search ()">prelude_option_search</a> <span class="c_punctuation">()</span> |
| 474 |
</td> |
| 475 |
</tr> |
| 476 |
<tr> |
| 477 |
<td class="function_type"> |
| 478 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-context-t" title="prelude_option_context_t"><span class="returnvalue">prelude_option_context_t</span></a> * |
| 479 |
</td> |
| 480 |
<td class="function_name"> |
| 481 |
<a class="link" href="libprelude-prelude-option.html#prelude-option-search-context" title="prelude_option_search_context ()">prelude_option_search_context</a> <span class="c_punctuation">()</span> |
| 482 |
</td> |
| 483 |
</tr> |
| 484 |
</tbody> |
| 485 |
</table></div> |
| 486 |
</div> |
| 487 |
<div class="refsect1"> |
| 488 |
<a name="libprelude-prelude-option.other"></a><h2>Types and Values</h2> |
| 489 |
<div class="informaltable"><table width="100%" border="0"> |
| 490 |
<colgroup> |
| 491 |
<col width="150px" class="name"> |
| 492 |
<col class="description"> |
| 493 |
</colgroup> |
| 494 |
<tbody> |
| 495 |
<tr> |
| 496 |
<td class="datatype_keyword">enum</td> |
| 497 |
<td class="function_name"><a class="link" href="libprelude-prelude-option.html#prelude-option-type-t" title="enum prelude_option_type_t">prelude_option_type_t</a></td> |
| 498 |
</tr> |
| 499 |
<tr> |
| 500 |
<td class="datatype_keyword">enum</td> |
| 501 |
<td class="function_name"><a class="link" href="libprelude-prelude-option.html#prelude-option-input-type-t" title="enum prelude_option_input_type_t">prelude_option_input_type_t</a></td> |
| 502 |
</tr> |
| 503 |
<tr> |
| 504 |
<td class="typedef_keyword">typedef</td> |
| 505 |
<td class="function_name"><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t">prelude_option_t</a></td> |
| 506 |
</tr> |
| 507 |
<tr> |
| 508 |
<td class="typedef_keyword">typedef</td> |
| 509 |
<td class="function_name"><a class="link" href="libprelude-prelude-option.html#prelude-option-context-t" title="prelude_option_context_t">prelude_option_context_t</a></td> |
| 510 |
</tr> |
| 511 |
<tr> |
| 512 |
<td class="datatype_keyword">enum</td> |
| 513 |
<td class="function_name"><a class="link" href="libprelude-prelude-option.html#prelude-option-argument-t" title="enum prelude_option_argument_t">prelude_option_argument_t</a></td> |
| 514 |
</tr> |
| 515 |
<tr> |
| 516 |
<td class="datatype_keyword">enum</td> |
| 517 |
<td class="function_name"><a class="link" href="libprelude-prelude-option.html#prelude-option-priority-t" title="enum prelude_option_priority_t">prelude_option_priority_t</a></td> |
| 518 |
</tr> |
| 519 |
<tr> |
| 520 |
<td class="datatype_keyword">enum</td> |
| 521 |
<td class="function_name"><a class="link" href="libprelude-prelude-option.html#prelude-option-warning-t" title="enum prelude_option_warning_t">prelude_option_warning_t</a></td> |
| 522 |
</tr> |
| 523 |
</tbody> |
| 524 |
</table></div> |
| 525 |
</div> |
| 526 |
<div class="refsect1"> |
| 527 |
<a name="libprelude-prelude-option.description"></a><h2>Description</h2> |
| 528 |
</div> |
| 529 |
<div class="refsect1"> |
| 530 |
<a name="libprelude-prelude-option.functions_details"></a><h2>Functions</h2> |
| 531 |
<div class="refsect2"> |
| 532 |
<a name="prelude-option-destroy-callback-t"></a><h3>prelude_option_destroy_callback_t ()</h3> |
| 533 |
<pre class="programlisting"><span class="returnvalue">int</span> |
| 534 |
<span class="c_punctuation">(</span>*prelude_option_destroy_callback_t<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>, |
| 535 |
<em class="parameter"><code><a class="link" href="libprelude-prelude-string.html#prelude-string-t" title="prelude_string_t"><span class="type">prelude_string_t</span></a> *out</code></em>, |
| 536 |
<em class="parameter"><code><span class="type">void</span> *context</code></em>);</pre> |
| 537 |
</div> |
| 538 |
<hr> |
| 539 |
<div class="refsect2"> |
| 540 |
<a name="prelude-option-commit-callback-t"></a><h3>prelude_option_commit_callback_t ()</h3> |
| 541 |
<pre class="programlisting"><span class="returnvalue">int</span> |
| 542 |
<span class="c_punctuation">(</span>*prelude_option_commit_callback_t<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>, |
| 543 |
<em class="parameter"><code><a class="link" href="libprelude-prelude-string.html#prelude-string-t" title="prelude_string_t"><span class="type">prelude_string_t</span></a> *out</code></em>, |
| 544 |
<em class="parameter"><code><span class="type">void</span> *context</code></em>);</pre> |
| 545 |
</div> |
| 546 |
<hr> |
| 547 |
<div class="refsect2"> |
| 548 |
<a name="prelude-option-get-callback-t"></a><h3>prelude_option_get_callback_t ()</h3> |
| 549 |
<pre class="programlisting"><span class="returnvalue">int</span> |
| 550 |
<span class="c_punctuation">(</span>*prelude_option_get_callback_t<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>, |
| 551 |
<em class="parameter"><code><a class="link" href="libprelude-prelude-string.html#prelude-string-t" title="prelude_string_t"><span class="type">prelude_string_t</span></a> *out</code></em>, |
| 552 |
<em class="parameter"><code><span class="type">void</span> *context</code></em>);</pre> |
| 553 |
</div> |
| 554 |
<hr> |
| 555 |
<div class="refsect2"> |
| 556 |
<a name="prelude-option-set-callback-t"></a><h3>prelude_option_set_callback_t ()</h3> |
| 557 |
<pre class="programlisting"><span class="returnvalue">int</span> |
| 558 |
<span class="c_punctuation">(</span>*prelude_option_set_callback_t<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>, |
| 559 |
<em class="parameter"><code>const <span class="type">char</span> *optarg</code></em>, |
| 560 |
<em class="parameter"><code><a class="link" href="libprelude-prelude-string.html#prelude-string-t" title="prelude_string_t"><span class="type">prelude_string_t</span></a> *err</code></em>, |
| 561 |
<em class="parameter"><code><span class="type">void</span> *context</code></em>);</pre> |
| 562 |
</div> |
| 563 |
<hr> |
| 564 |
<div class="refsect2"> |
| 565 |
<a name="prelude-option-set-priority"></a><h3>prelude_option_set_priority ()</h3> |
| 566 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 567 |
prelude_option_set_priority (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *option</code></em>, |
| 568 |
<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-priority-t" title="enum prelude_option_priority_t"><span class="type">prelude_option_priority_t</span></a> priority</code></em>);</pre> |
| 569 |
<p>prelude_option_set_priority() can be used to associate a priority |
| 570 |
with an option. This can be used to solve dependancies problem within |
| 571 |
differents options.</p> |
| 572 |
<p>A priority of -1 mean an option will always be executed last (with |
| 573 |
all other option with a -1 priority).</p> |
| 574 |
<p>The default priority for an option is 0, the caller is responssible |
| 575 |
for the way it assign priority (knowing that highest priority are always |
| 576 |
executed first).</p> |
| 577 |
<div class="refsect3"> |
| 578 |
<a name="prelude-option-set-priority.parameters"></a><h4>Parameters</h4> |
| 579 |
<div class="informaltable"><table width="100%" border="0"> |
| 580 |
<colgroup> |
| 581 |
<col width="150px" class="parameters_name"> |
| 582 |
<col class="parameters_description"> |
| 583 |
<col width="200px" class="parameters_annotations"> |
| 584 |
</colgroup> |
| 585 |
<tbody> |
| 586 |
<tr> |
| 587 |
<td class="parameter_name"><p>option</p></td> |
| 588 |
<td class="parameter_description"><p>Pointer on an option object.</p></td> |
| 589 |
<td class="parameter_annotations"> </td> |
| 590 |
</tr> |
| 591 |
<tr> |
| 592 |
<td class="parameter_name"><p>priority</p></td> |
| 593 |
<td class="parameter_description"><p>Priority of the option object.</p></td> |
| 594 |
<td class="parameter_annotations"> </td> |
| 595 |
</tr> |
| 596 |
</tbody> |
| 597 |
</table></div> |
| 598 |
</div> |
| 599 |
</div> |
| 600 |
<hr> |
| 601 |
<div class="refsect2"> |
| 602 |
<a name="prelude-option-print"></a><h3>prelude_option_print ()</h3> |
| 603 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 604 |
prelude_option_print (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>, |
| 605 |
<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-type-t" title="enum prelude_option_type_t"><span class="type">prelude_option_type_t</span></a> type</code></em>, |
| 606 |
<em class="parameter"><code><span class="type">int</span> descoff</code></em>, |
| 607 |
<em class="parameter"><code><span class="type">FILE</span> *fd</code></em>);</pre> |
| 608 |
<p>Dump option available in <em class="parameter"><code>opt</code></em> |
| 609 |
and hooked to the given types. |
| 610 |
If <em class="parameter"><code>opt</code></em> |
| 611 |
is NULL, then the root of the option list is used.</p> |
| 612 |
<div class="refsect3"> |
| 613 |
<a name="prelude-option-print.parameters"></a><h4>Parameters</h4> |
| 614 |
<div class="informaltable"><table width="100%" border="0"> |
| 615 |
<colgroup> |
| 616 |
<col width="150px" class="parameters_name"> |
| 617 |
<col class="parameters_description"> |
| 618 |
<col width="200px" class="parameters_annotations"> |
| 619 |
</colgroup> |
| 620 |
<tbody> |
| 621 |
<tr> |
| 622 |
<td class="parameter_name"><p>opt</p></td> |
| 623 |
<td class="parameter_description"><p>Option(s) to print out.</p></td> |
| 624 |
<td class="parameter_annotations"> </td> |
| 625 |
</tr> |
| 626 |
<tr> |
| 627 |
<td class="parameter_name"><p>type</p></td> |
| 628 |
<td class="parameter_description"><p>Only option with specified types will be printed.</p></td> |
| 629 |
<td class="parameter_annotations"> </td> |
| 630 |
</tr> |
| 631 |
<tr> |
| 632 |
<td class="parameter_name"><p>descoff</p></td> |
| 633 |
<td class="parameter_description"><p>offset from the begining of the line where the description should start.</p></td> |
| 634 |
<td class="parameter_annotations"> </td> |
| 635 |
</tr> |
| 636 |
<tr> |
| 637 |
<td class="parameter_name"><p>fd</p></td> |
| 638 |
<td class="parameter_description"><p>File descriptor where the option should be dumped.</p></td> |
| 639 |
<td class="parameter_annotations"> </td> |
| 640 |
</tr> |
| 641 |
</tbody> |
| 642 |
</table></div> |
| 643 |
</div> |
| 644 |
</div> |
| 645 |
<hr> |
| 646 |
<div class="refsect2"> |
| 647 |
<a name="prelude-option-wide-send-msg"></a><h3>prelude_option_wide_send_msg ()</h3> |
| 648 |
<pre class="programlisting"><span class="returnvalue">int</span> |
| 649 |
prelude_option_wide_send_msg (<em class="parameter"><code><a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-t" title="prelude_msgbuf_t"><span class="type">prelude_msgbuf_t</span></a> *msgbuf</code></em>, |
| 650 |
<em class="parameter"><code><span class="type">void</span> *context</code></em>);</pre> |
| 651 |
</div> |
| 652 |
<hr> |
| 653 |
<div class="refsect2"> |
| 654 |
<a name="prelude-option-destroy"></a><h3>prelude_option_destroy ()</h3> |
| 655 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 656 |
prelude_option_destroy (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *option</code></em>);</pre> |
| 657 |
<p>Destroy a <a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> object and all data associated |
| 658 |
with it (including all suboption).</p> |
| 659 |
<div class="refsect3"> |
| 660 |
<a name="prelude-option-destroy.parameters"></a><h4>Parameters</h4> |
| 661 |
<div class="informaltable"><table width="100%" border="0"> |
| 662 |
<colgroup> |
| 663 |
<col width="150px" class="parameters_name"> |
| 664 |
<col class="parameters_description"> |
| 665 |
<col width="200px" class="parameters_annotations"> |
| 666 |
</colgroup> |
| 667 |
<tbody><tr> |
| 668 |
<td class="parameter_name"><p>option</p></td> |
| 669 |
<td class="parameter_description"><p>Pointer on an option object.</p></td> |
| 670 |
<td class="parameter_annotations"> </td> |
| 671 |
</tr></tbody> |
| 672 |
</table></div> |
| 673 |
</div> |
| 674 |
</div> |
| 675 |
<hr> |
| 676 |
<div class="refsect2"> |
| 677 |
<a name="prelude-option-read"></a><h3>prelude_option_read ()</h3> |
| 678 |
<pre class="programlisting"><span class="returnvalue">int</span> |
| 679 |
prelude_option_read (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *option</code></em>, |
| 680 |
<em class="parameter"><code>const <span class="type">char</span> **filename</code></em>, |
| 681 |
<em class="parameter"><code><span class="type">int</span> *argc</code></em>, |
| 682 |
<em class="parameter"><code><span class="type">char</span> **argv</code></em>, |
| 683 |
<em class="parameter"><code><a class="link" href="libprelude-prelude-string.html#prelude-string-t" title="prelude_string_t"><span class="type">prelude_string_t</span></a> **err</code></em>, |
| 684 |
<em class="parameter"><code><span class="type">void</span> *context</code></em>);</pre> |
| 685 |
<p>prelude_option_read(), parse the given argument and try to |
| 686 |
match them against option in <em class="parameter"><code>option</code></em> |
| 687 |
. If an option match, it's associated |
| 688 |
callback function is called with the eventual option argument if any.</p> |
| 689 |
<p>Option not matched on the command line are searched in the configuration file |
| 690 |
specified by <em class="parameter"><code>filename</code></em> |
| 691 |
.</p> |
| 692 |
<p>if <em class="parameter"><code>option</code></em> |
| 693 |
is NULL, all system option will be matched against argc, and argv.</p> |
| 694 |
<div class="refsect3"> |
| 695 |
<a name="prelude-option-read.parameters"></a><h4>Parameters</h4> |
| 696 |
<div class="informaltable"><table width="100%" border="0"> |
| 697 |
<colgroup> |
| 698 |
<col width="150px" class="parameters_name"> |
| 699 |
<col class="parameters_description"> |
| 700 |
<col width="200px" class="parameters_annotations"> |
| 701 |
</colgroup> |
| 702 |
<tbody> |
| 703 |
<tr> |
| 704 |
<td class="parameter_name"><p>option</p></td> |
| 705 |
<td class="parameter_description"><p>A pointer on an option (list).</p></td> |
| 706 |
<td class="parameter_annotations"> </td> |
| 707 |
</tr> |
| 708 |
<tr> |
| 709 |
<td class="parameter_name"><p>filename</p></td> |
| 710 |
<td class="parameter_description"><p>Pointer to the config filename.</p></td> |
| 711 |
<td class="parameter_annotations"> </td> |
| 712 |
</tr> |
| 713 |
<tr> |
| 714 |
<td class="parameter_name"><p>argc</p></td> |
| 715 |
<td class="parameter_description"><p>Number of argument.</p></td> |
| 716 |
<td class="parameter_annotations"> </td> |
| 717 |
</tr> |
| 718 |
<tr> |
| 719 |
<td class="parameter_name"><p>argv</p></td> |
| 720 |
<td class="parameter_description"><p>Argument list.</p></td> |
| 721 |
<td class="parameter_annotations"> </td> |
| 722 |
</tr> |
| 723 |
<tr> |
| 724 |
<td class="parameter_name"><p>err</p></td> |
| 725 |
<td class="parameter_description"><p>Pointer to a <a class="link" href="libprelude-prelude-string.html#prelude-string-t" title="prelude_string_t"><span class="type">prelude_string_t</span></a> object where to store an error string.</p></td> |
| 726 |
<td class="parameter_annotations"> </td> |
| 727 |
</tr> |
| 728 |
<tr> |
| 729 |
<td class="parameter_name"><p>context</p></td> |
| 730 |
<td class="parameter_description"><p>Pointer to an optional option context.</p></td> |
| 731 |
<td class="parameter_annotations"> </td> |
| 732 |
</tr> |
| 733 |
</tbody> |
| 734 |
</table></div> |
| 735 |
</div> |
| 736 |
<div class="refsect3"> |
| 737 |
<a name="prelude-option-read.returns"></a><h4>Returns</h4> |
| 738 |
<p> The index of the first unhandled parameter if option parsing succeeded, |
| 739 |
or a negative value if an error occured.</p> |
| 740 |
</div> |
| 741 |
</div> |
| 742 |
<hr> |
| 743 |
<div class="refsect2"> |
| 744 |
<a name="prelude-option-add"></a><h3>prelude_option_add ()</h3> |
| 745 |
<pre class="programlisting"><span class="returnvalue">int</span> |
| 746 |
prelude_option_add (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *parent</code></em>, |
| 747 |
<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> **retopt</code></em>, |
| 748 |
<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-type-t" title="enum prelude_option_type_t"><span class="type">prelude_option_type_t</span></a> type</code></em>, |
| 749 |
<em class="parameter"><code><span class="type">char</span> shortopt</code></em>, |
| 750 |
<em class="parameter"><code>const <span class="type">char</span> *longopt</code></em>, |
| 751 |
<em class="parameter"><code>const <span class="type">char</span> *desc</code></em>, |
| 752 |
<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-argument-t" title="enum prelude_option_argument_t"><span class="type">prelude_option_argument_t</span></a> has_arg</code></em>, |
| 753 |
<em class="parameter"><code><span class="type">int</span> (*set) (prelude_option_t *opt, const char *optarg, prelude_string_t *err, void *context)</code></em>, |
| 754 |
<em class="parameter"><code><span class="type">int</span> (*get) (prelude_option_t *opt, prelude_string_t *out, void *context)</code></em>);</pre> |
| 755 |
<p>prelude_option_add() create a new option. The option is set to be the child |
| 756 |
of <em class="parameter"><code>parent</code></em> |
| 757 |
, unless it is NULL. In this case the option is a root option.</p> |
| 758 |
<p>The <em class="parameter"><code>type</code></em> |
| 759 |
parameters can be set to PRELUDE_OPTION_TYPE_CLI (telling the |
| 760 |
option may be searched on the command line), PRELUDE_OPTION_TYPE_CFG (telling |
| 761 |
the option may be searched in the configuration file) or both.</p> |
| 762 |
<div class="refsect3"> |
| 763 |
<a name="prelude-option-add.parameters"></a><h4>Parameters</h4> |
| 764 |
<div class="informaltable"><table width="100%" border="0"> |
| 765 |
<colgroup> |
| 766 |
<col width="150px" class="parameters_name"> |
| 767 |
<col class="parameters_description"> |
| 768 |
<col width="200px" class="parameters_annotations"> |
| 769 |
</colgroup> |
| 770 |
<tbody> |
| 771 |
<tr> |
| 772 |
<td class="parameter_name"><p>parent</p></td> |
| 773 |
<td class="parameter_description"><p>Pointer on a parent option.</p></td> |
| 774 |
<td class="parameter_annotations"> </td> |
| 775 |
</tr> |
| 776 |
<tr> |
| 777 |
<td class="parameter_name"><p>retopt</p></td> |
| 778 |
<td class="parameter_description"><p>Pointer where to store the created option.</p></td> |
| 779 |
<td class="parameter_annotations"> </td> |
| 780 |
</tr> |
| 781 |
<tr> |
| 782 |
<td class="parameter_name"><p>type</p></td> |
| 783 |
<td class="parameter_description"><p>bitfields.</p></td> |
| 784 |
<td class="parameter_annotations"> </td> |
| 785 |
</tr> |
| 786 |
<tr> |
| 787 |
<td class="parameter_name"><p>shortopt</p></td> |
| 788 |
<td class="parameter_description"><p>Short option name.</p></td> |
| 789 |
<td class="parameter_annotations"> </td> |
| 790 |
</tr> |
| 791 |
<tr> |
| 792 |
<td class="parameter_name"><p>longopt</p></td> |
| 793 |
<td class="parameter_description"><p>Long option name.</p></td> |
| 794 |
<td class="parameter_annotations"> </td> |
| 795 |
</tr> |
| 796 |
<tr> |
| 797 |
<td class="parameter_name"><p>desc</p></td> |
| 798 |
<td class="parameter_description"><p>Description of the option.</p></td> |
| 799 |
<td class="parameter_annotations"> </td> |
| 800 |
</tr> |
| 801 |
<tr> |
| 802 |
<td class="parameter_name"><p>has_arg</p></td> |
| 803 |
<td class="parameter_description"><p>Define if the option has argument.</p></td> |
| 804 |
<td class="parameter_annotations"> </td> |
| 805 |
</tr> |
| 806 |
<tr> |
| 807 |
<td class="parameter_name"><p>set</p></td> |
| 808 |
<td class="parameter_description"><p>Callback to be called when the value for this option change.</p></td> |
| 809 |
<td class="parameter_annotations"> </td> |
| 810 |
</tr> |
| 811 |
<tr> |
| 812 |
<td class="parameter_name"><p>get</p></td> |
| 813 |
<td class="parameter_description"><p>Callback to be called to get the value for this option.</p></td> |
| 814 |
<td class="parameter_annotations"> </td> |
| 815 |
</tr> |
| 816 |
</tbody> |
| 817 |
</table></div> |
| 818 |
</div> |
| 819 |
<div class="refsect3"> |
| 820 |
<a name="prelude-option-add.returns"></a><h4>Returns</h4> |
| 821 |
<p> Pointer on the option object, or NULL if an error occured.</p> |
| 822 |
</div> |
| 823 |
</div> |
| 824 |
<hr> |
| 825 |
<div class="refsect2"> |
| 826 |
<a name="prelude-option-set-type"></a><h3>prelude_option_set_type ()</h3> |
| 827 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 828 |
prelude_option_set_type (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>, |
| 829 |
<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-type-t" title="enum prelude_option_type_t"><span class="type">prelude_option_type_t</span></a> type</code></em>);</pre> |
| 830 |
</div> |
| 831 |
<hr> |
| 832 |
<div class="refsect2"> |
| 833 |
<a name="prelude-option-get-type"></a><h3>prelude_option_get_type ()</h3> |
| 834 |
<pre class="programlisting"><a class="link" href="libprelude-prelude-option.html#prelude-option-type-t" title="enum prelude_option_type_t"><span class="returnvalue">prelude_option_type_t</span></a> |
| 835 |
prelude_option_get_type (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>);</pre> |
| 836 |
</div> |
| 837 |
<hr> |
| 838 |
<div class="refsect2"> |
| 839 |
<a name="prelude-option-set-warnings"></a><h3>prelude_option_set_warnings ()</h3> |
| 840 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 841 |
prelude_option_set_warnings (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-warning-t" title="enum prelude_option_warning_t"><span class="type">prelude_option_warning_t</span></a> new_warnings</code></em>, |
| 842 |
<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-warning-t" title="enum prelude_option_warning_t"><span class="type">prelude_option_warning_t</span></a> *old_warnings</code></em>);</pre> |
| 843 |
</div> |
| 844 |
<hr> |
| 845 |
<div class="refsect2"> |
| 846 |
<a name="prelude-option-get-shortname"></a><h3>prelude_option_get_shortname ()</h3> |
| 847 |
<pre class="programlisting"><span class="returnvalue">char</span> |
| 848 |
prelude_option_get_shortname (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>);</pre> |
| 849 |
</div> |
| 850 |
<hr> |
| 851 |
<div class="refsect2"> |
| 852 |
<a name="prelude-option-get-longname"></a><h3>prelude_option_get_longname ()</h3> |
| 853 |
<pre class="programlisting">const <span class="returnvalue">char</span> * |
| 854 |
prelude_option_get_longname (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>);</pre> |
| 855 |
</div> |
| 856 |
<hr> |
| 857 |
<div class="refsect2"> |
| 858 |
<a name="prelude-option-set-data"></a><h3>prelude_option_set_data ()</h3> |
| 859 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 860 |
prelude_option_set_data (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>, |
| 861 |
<em class="parameter"><code><span class="type">void</span> *data</code></em>);</pre> |
| 862 |
</div> |
| 863 |
<hr> |
| 864 |
<div class="refsect2"> |
| 865 |
<a name="prelude-option-get-data"></a><h3>prelude_option_get_data ()</h3> |
| 866 |
<pre class="programlisting"><span class="returnvalue">void</span> * |
| 867 |
prelude_option_get_data (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>);</pre> |
| 868 |
</div> |
| 869 |
<hr> |
| 870 |
<div class="refsect2"> |
| 871 |
<a name="prelude-option-context-get-data"></a><h3>prelude_option_context_get_data ()</h3> |
| 872 |
<pre class="programlisting"><span class="returnvalue">void</span> * |
| 873 |
prelude_option_context_get_data (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-context-t" title="prelude_option_context_t"><span class="type">prelude_option_context_t</span></a> *oc</code></em>);</pre> |
| 874 |
</div> |
| 875 |
<hr> |
| 876 |
<div class="refsect2"> |
| 877 |
<a name="prelude-option-context-set-data"></a><h3>prelude_option_context_set_data ()</h3> |
| 878 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 879 |
prelude_option_context_set_data (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-context-t" title="prelude_option_context_t"><span class="type">prelude_option_context_t</span></a> *oc</code></em>, |
| 880 |
<em class="parameter"><code><span class="type">void</span> *data</code></em>);</pre> |
| 881 |
</div> |
| 882 |
<hr> |
| 883 |
<div class="refsect2"> |
| 884 |
<a name="prelude-option-invoke-commit"></a><h3>prelude_option_invoke_commit ()</h3> |
| 885 |
<pre class="programlisting"><span class="returnvalue">int</span> |
| 886 |
prelude_option_invoke_commit (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>, |
| 887 |
<em class="parameter"><code>const <span class="type">char</span> *ctname</code></em>, |
| 888 |
<em class="parameter"><code><a class="link" href="libprelude-prelude-string.html#prelude-string-t" title="prelude_string_t"><span class="type">prelude_string_t</span></a> *value</code></em>, |
| 889 |
<em class="parameter"><code><span class="type">void</span> *context</code></em>);</pre> |
| 890 |
</div> |
| 891 |
<hr> |
| 892 |
<div class="refsect2"> |
| 893 |
<a name="prelude-option-invoke-set"></a><h3>prelude_option_invoke_set ()</h3> |
| 894 |
<pre class="programlisting"><span class="returnvalue">int</span> |
| 895 |
prelude_option_invoke_set (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>, |
| 896 |
<em class="parameter"><code>const <span class="type">char</span> *ctname</code></em>, |
| 897 |
<em class="parameter"><code><a class="link" href="libprelude-prelude-string.html#prelude-string-t" title="prelude_string_t"><span class="type">prelude_string_t</span></a> *value</code></em>, |
| 898 |
<em class="parameter"><code><span class="type">void</span> **context</code></em>);</pre> |
| 899 |
</div> |
| 900 |
<hr> |
| 901 |
<div class="refsect2"> |
| 902 |
<a name="prelude-option-invoke-get"></a><h3>prelude_option_invoke_get ()</h3> |
| 903 |
<pre class="programlisting"><span class="returnvalue">int</span> |
| 904 |
prelude_option_invoke_get (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>, |
| 905 |
<em class="parameter"><code>const <span class="type">char</span> *ctname</code></em>, |
| 906 |
<em class="parameter"><code><a class="link" href="libprelude-prelude-string.html#prelude-string-t" title="prelude_string_t"><span class="type">prelude_string_t</span></a> *value</code></em>, |
| 907 |
<em class="parameter"><code><span class="type">void</span> *context</code></em>);</pre> |
| 908 |
</div> |
| 909 |
<hr> |
| 910 |
<div class="refsect2"> |
| 911 |
<a name="prelude-option-invoke-destroy"></a><h3>prelude_option_invoke_destroy ()</h3> |
| 912 |
<pre class="programlisting"><span class="returnvalue">int</span> |
| 913 |
prelude_option_invoke_destroy (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>, |
| 914 |
<em class="parameter"><code>const <span class="type">char</span> *ctname</code></em>, |
| 915 |
<em class="parameter"><code><a class="link" href="libprelude-prelude-string.html#prelude-string-t" title="prelude_string_t"><span class="type">prelude_string_t</span></a> *value</code></em>, |
| 916 |
<em class="parameter"><code><span class="type">void</span> *context</code></em>);</pre> |
| 917 |
</div> |
| 918 |
<hr> |
| 919 |
<div class="refsect2"> |
| 920 |
<a name="prelude-option-new-root"></a><h3>prelude_option_new_root ()</h3> |
| 921 |
<pre class="programlisting"><span class="returnvalue">int</span> |
| 922 |
prelude_option_new_root (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> **retopt</code></em>);</pre> |
| 923 |
</div> |
| 924 |
<hr> |
| 925 |
<div class="refsect2"> |
| 926 |
<a name="prelude-option-new"></a><h3>prelude_option_new ()</h3> |
| 927 |
<pre class="programlisting"><span class="returnvalue">int</span> |
| 928 |
prelude_option_new (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *parent</code></em>, |
| 929 |
<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> **retopt</code></em>);</pre> |
| 930 |
</div> |
| 931 |
<hr> |
| 932 |
<div class="refsect2"> |
| 933 |
<a name="prelude-option-set-longopt"></a><h3>prelude_option_set_longopt ()</h3> |
| 934 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 935 |
prelude_option_set_longopt (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>, |
| 936 |
<em class="parameter"><code>const <span class="type">char</span> *longopt</code></em>);</pre> |
| 937 |
</div> |
| 938 |
<hr> |
| 939 |
<div class="refsect2"> |
| 940 |
<a name="prelude-option-get-longopt"></a><h3>prelude_option_get_longopt ()</h3> |
| 941 |
<pre class="programlisting">const <span class="returnvalue">char</span> * |
| 942 |
prelude_option_get_longopt (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>);</pre> |
| 943 |
</div> |
| 944 |
<hr> |
| 945 |
<div class="refsect2"> |
| 946 |
<a name="prelude-option-set-description"></a><h3>prelude_option_set_description ()</h3> |
| 947 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 948 |
prelude_option_set_description (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>, |
| 949 |
<em class="parameter"><code>const <span class="type">char</span> *description</code></em>);</pre> |
| 950 |
</div> |
| 951 |
<hr> |
| 952 |
<div class="refsect2"> |
| 953 |
<a name="prelude-option-get-description"></a><h3>prelude_option_get_description ()</h3> |
| 954 |
<pre class="programlisting">const <span class="returnvalue">char</span> * |
| 955 |
prelude_option_get_description (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>);</pre> |
| 956 |
</div> |
| 957 |
<hr> |
| 958 |
<div class="refsect2"> |
| 959 |
<a name="prelude-option-set-has-arg"></a><h3>prelude_option_set_has_arg ()</h3> |
| 960 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 961 |
prelude_option_set_has_arg (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>, |
| 962 |
<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-argument-t" title="enum prelude_option_argument_t"><span class="type">prelude_option_argument_t</span></a> has_arg</code></em>);</pre> |
| 963 |
</div> |
| 964 |
<hr> |
| 965 |
<div class="refsect2"> |
| 966 |
<a name="prelude-option-get-has-arg"></a><h3>prelude_option_get_has_arg ()</h3> |
| 967 |
<pre class="programlisting"><a class="link" href="libprelude-prelude-option.html#prelude-option-argument-t" title="enum prelude_option_argument_t"><span class="returnvalue">prelude_option_argument_t</span></a> |
| 968 |
prelude_option_get_has_arg (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>);</pre> |
| 969 |
</div> |
| 970 |
<hr> |
| 971 |
<div class="refsect2"> |
| 972 |
<a name="prelude-option-set-value"></a><h3>prelude_option_set_value ()</h3> |
| 973 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 974 |
prelude_option_set_value (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>, |
| 975 |
<em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre> |
| 976 |
</div> |
| 977 |
<hr> |
| 978 |
<div class="refsect2"> |
| 979 |
<a name="prelude-option-get-value"></a><h3>prelude_option_get_value ()</h3> |
| 980 |
<pre class="programlisting">const <span class="returnvalue">char</span> * |
| 981 |
prelude_option_get_value (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>);</pre> |
| 982 |
</div> |
| 983 |
<hr> |
| 984 |
<div class="refsect2"> |
| 985 |
<a name="prelude-option-set-help"></a><h3>prelude_option_set_help ()</h3> |
| 986 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 987 |
prelude_option_set_help (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>, |
| 988 |
<em class="parameter"><code>const <span class="type">char</span> *help</code></em>);</pre> |
| 989 |
</div> |
| 990 |
<hr> |
| 991 |
<div class="refsect2"> |
| 992 |
<a name="prelude-option-get-help"></a><h3>prelude_option_get_help ()</h3> |
| 993 |
<pre class="programlisting">const <span class="returnvalue">char</span> * |
| 994 |
prelude_option_get_help (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>);</pre> |
| 995 |
</div> |
| 996 |
<hr> |
| 997 |
<div class="refsect2"> |
| 998 |
<a name="prelude-option-set-input-validation-regex"></a><h3>prelude_option_set_input_validation_regex ()</h3> |
| 999 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 1000 |
prelude_option_set_input_validation_regex |
| 1001 |
(<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>, |
| 1002 |
<em class="parameter"><code>const <span class="type">char</span> *regex</code></em>);</pre> |
| 1003 |
</div> |
| 1004 |
<hr> |
| 1005 |
<div class="refsect2"> |
| 1006 |
<a name="prelude-option-get-input-validation-regex"></a><h3>prelude_option_get_input_validation_regex ()</h3> |
| 1007 |
<pre class="programlisting">const <span class="returnvalue">char</span> * |
| 1008 |
prelude_option_get_input_validation_regex |
| 1009 |
(<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>);</pre> |
| 1010 |
</div> |
| 1011 |
<hr> |
| 1012 |
<div class="refsect2"> |
| 1013 |
<a name="prelude-option-set-input-type"></a><h3>prelude_option_set_input_type ()</h3> |
| 1014 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 1015 |
prelude_option_set_input_type (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>, |
| 1016 |
<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-input-type-t" title="enum prelude_option_input_type_t"><span class="type">prelude_option_input_type_t</span></a> input_type</code></em>);</pre> |
| 1017 |
</div> |
| 1018 |
<hr> |
| 1019 |
<div class="refsect2"> |
| 1020 |
<a name="prelude-option-get-input-type"></a><h3>prelude_option_get_input_type ()</h3> |
| 1021 |
<pre class="programlisting"><a class="link" href="libprelude-prelude-option.html#prelude-option-input-type-t" title="enum prelude_option_input_type_t"><span class="returnvalue">prelude_option_input_type_t</span></a> |
| 1022 |
prelude_option_get_input_type (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>);</pre> |
| 1023 |
</div> |
| 1024 |
<hr> |
| 1025 |
<div class="refsect2"> |
| 1026 |
<a name="prelude-option-get-optlist"></a><h3>prelude_option_get_optlist ()</h3> |
| 1027 |
<pre class="programlisting"><a class="link" href="libprelude-prelude-list.html#prelude-list-t" title="prelude_list_t"><span class="returnvalue">prelude_list_t</span></a> * |
| 1028 |
prelude_option_get_optlist (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>);</pre> |
| 1029 |
</div> |
| 1030 |
<hr> |
| 1031 |
<div class="refsect2"> |
| 1032 |
<a name="prelude-option-get-next"></a><h3>prelude_option_get_next ()</h3> |
| 1033 |
<pre class="programlisting"><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="returnvalue">prelude_option_t</span></a> * |
| 1034 |
prelude_option_get_next (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *start</code></em>, |
| 1035 |
<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *cur</code></em>);</pre> |
| 1036 |
</div> |
| 1037 |
<hr> |
| 1038 |
<div class="refsect2"> |
| 1039 |
<a name="prelude-option-has-optlist"></a><h3>prelude_option_has_optlist ()</h3> |
| 1040 |
<pre class="programlisting"><a class="link" href="libprelude-prelude-inttypes.html#prelude-bool-t" title="enum prelude_bool_t"><span class="returnvalue">prelude_bool_t</span></a> |
| 1041 |
prelude_option_has_optlist (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>);</pre> |
| 1042 |
</div> |
| 1043 |
<hr> |
| 1044 |
<div class="refsect2"> |
| 1045 |
<a name="prelude-option-get-parent"></a><h3>prelude_option_get_parent ()</h3> |
| 1046 |
<pre class="programlisting"><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="returnvalue">prelude_option_t</span></a> * |
| 1047 |
prelude_option_get_parent (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>);</pre> |
| 1048 |
</div> |
| 1049 |
<hr> |
| 1050 |
<div class="refsect2"> |
| 1051 |
<a name="prelude-option-set-destroy-callback"></a><h3>prelude_option_set_destroy_callback ()</h3> |
| 1052 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 1053 |
prelude_option_set_destroy_callback (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>, |
| 1054 |
<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-destroy-callback-t" title="prelude_option_destroy_callback_t ()"><span class="type">prelude_option_destroy_callback_t</span></a> destroy</code></em>);</pre> |
| 1055 |
</div> |
| 1056 |
<hr> |
| 1057 |
<div class="refsect2"> |
| 1058 |
<a name="prelude-option-get-destroy-callback"></a><h3>prelude_option_get_destroy_callback ()</h3> |
| 1059 |
<pre class="programlisting"><a class="link" href="libprelude-prelude-option.html#prelude-option-destroy-callback-t" title="prelude_option_destroy_callback_t ()"><span class="returnvalue">prelude_option_destroy_callback_t</span></a> |
| 1060 |
prelude_option_get_destroy_callback (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>);</pre> |
| 1061 |
</div> |
| 1062 |
<hr> |
| 1063 |
<div class="refsect2"> |
| 1064 |
<a name="prelude-option-set-set-callback"></a><h3>prelude_option_set_set_callback ()</h3> |
| 1065 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 1066 |
prelude_option_set_set_callback (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>, |
| 1067 |
<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-set-callback-t" title="prelude_option_set_callback_t ()"><span class="type">prelude_option_set_callback_t</span></a> set</code></em>);</pre> |
| 1068 |
</div> |
| 1069 |
<hr> |
| 1070 |
<div class="refsect2"> |
| 1071 |
<a name="prelude-option-get-set-callback"></a><h3>prelude_option_get_set_callback ()</h3> |
| 1072 |
<pre class="programlisting"><a class="link" href="libprelude-prelude-option.html#prelude-option-set-callback-t" title="prelude_option_set_callback_t ()"><span class="returnvalue">prelude_option_set_callback_t</span></a> |
| 1073 |
prelude_option_get_set_callback (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>);</pre> |
| 1074 |
</div> |
| 1075 |
<hr> |
| 1076 |
<div class="refsect2"> |
| 1077 |
<a name="prelude-option-set-get-callback"></a><h3>prelude_option_set_get_callback ()</h3> |
| 1078 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 1079 |
prelude_option_set_get_callback (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>, |
| 1080 |
<em class="parameter"><code><span class="type">int</span> (*get) (prelude_option_t *opt, prelude_string_t *out, void *context)</code></em>);</pre> |
| 1081 |
</div> |
| 1082 |
<hr> |
| 1083 |
<div class="refsect2"> |
| 1084 |
<a name="prelude-option-get-get-callback"></a><h3>prelude_option_get_get_callback ()</h3> |
| 1085 |
<pre class="programlisting"><a class="link" href="libprelude-prelude-option.html#prelude-option-get-callback-t" title="prelude_option_get_callback_t ()"><span class="returnvalue">prelude_option_get_callback_t</span></a> |
| 1086 |
prelude_option_get_get_callback (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>);</pre> |
| 1087 |
</div> |
| 1088 |
<hr> |
| 1089 |
<div class="refsect2"> |
| 1090 |
<a name="prelude-option-set-commit-callback"></a><h3>prelude_option_set_commit_callback ()</h3> |
| 1091 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 1092 |
prelude_option_set_commit_callback (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>, |
| 1093 |
<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-commit-callback-t" title="prelude_option_commit_callback_t ()"><span class="type">prelude_option_commit_callback_t</span></a> commit</code></em>);</pre> |
| 1094 |
</div> |
| 1095 |
<hr> |
| 1096 |
<div class="refsect2"> |
| 1097 |
<a name="prelude-option-get-commit-callback"></a><h3>prelude_option_get_commit_callback ()</h3> |
| 1098 |
<pre class="programlisting"><a class="link" href="libprelude-prelude-option.html#prelude-option-commit-callback-t" title="prelude_option_commit_callback_t ()"><span class="returnvalue">prelude_option_commit_callback_t</span></a> |
| 1099 |
prelude_option_get_commit_callback (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>);</pre> |
| 1100 |
</div> |
| 1101 |
<hr> |
| 1102 |
<div class="refsect2"> |
| 1103 |
<a name="prelude-option-set-default-context"></a><h3>prelude_option_set_default_context ()</h3> |
| 1104 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 1105 |
prelude_option_set_default_context (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>, |
| 1106 |
<em class="parameter"><code><span class="type">void</span> *context</code></em>);</pre> |
| 1107 |
</div> |
| 1108 |
<hr> |
| 1109 |
<div class="refsect2"> |
| 1110 |
<a name="prelude-option-new-context"></a><h3>prelude_option_new_context ()</h3> |
| 1111 |
<pre class="programlisting"><span class="returnvalue">int</span> |
| 1112 |
prelude_option_new_context (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>, |
| 1113 |
<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-context-t" title="prelude_option_context_t"><span class="type">prelude_option_context_t</span></a> **ctx</code></em>, |
| 1114 |
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>, |
| 1115 |
<em class="parameter"><code><span class="type">void</span> *data</code></em>);</pre> |
| 1116 |
</div> |
| 1117 |
<hr> |
| 1118 |
<div class="refsect2"> |
| 1119 |
<a name="prelude-option-context-destroy"></a><h3>prelude_option_context_destroy ()</h3> |
| 1120 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 1121 |
prelude_option_context_destroy (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-context-t" title="prelude_option_context_t"><span class="type">prelude_option_context_t</span></a> *oc</code></em>);</pre> |
| 1122 |
</div> |
| 1123 |
<hr> |
| 1124 |
<div class="refsect2"> |
| 1125 |
<a name="prelude-option-search"></a><h3>prelude_option_search ()</h3> |
| 1126 |
<pre class="programlisting"><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="returnvalue">prelude_option_t</span></a> * |
| 1127 |
prelude_option_search (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *parent</code></em>, |
| 1128 |
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>, |
| 1129 |
<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-type-t" title="enum prelude_option_type_t"><span class="type">prelude_option_type_t</span></a> type</code></em>, |
| 1130 |
<em class="parameter"><code><a class="link" href="libprelude-prelude-inttypes.html#prelude-bool-t" title="enum prelude_bool_t"><span class="type">prelude_bool_t</span></a> walk_children</code></em>);</pre> |
| 1131 |
</div> |
| 1132 |
<hr> |
| 1133 |
<div class="refsect2"> |
| 1134 |
<a name="prelude-option-search-context"></a><h3>prelude_option_search_context ()</h3> |
| 1135 |
<pre class="programlisting"><a class="link" href="libprelude-prelude-option.html#prelude-option-context-t" title="prelude_option_context_t"><span class="returnvalue">prelude_option_context_t</span></a> * |
| 1136 |
prelude_option_search_context (<em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>, |
| 1137 |
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre> |
| 1138 |
</div> |
| 1139 |
</div> |
| 1140 |
<div class="refsect1"> |
| 1141 |
<a name="libprelude-prelude-option.other_details"></a><h2>Types and Values</h2> |
| 1142 |
<div class="refsect2"> |
| 1143 |
<a name="prelude-option-type-t"></a><h3>enum prelude_option_type_t</h3> |
| 1144 |
<div class="refsect3"> |
| 1145 |
<a name="prelude-option-type-t.members"></a><h4>Members</h4> |
| 1146 |
<div class="informaltable"><table width="100%" border="0"> |
| 1147 |
<colgroup> |
| 1148 |
<col width="300px" class="enum_members_name"> |
| 1149 |
<col class="enum_members_description"> |
| 1150 |
<col width="200px" class="enum_members_annotations"> |
| 1151 |
</colgroup> |
| 1152 |
<tbody> |
| 1153 |
<tr> |
| 1154 |
<td class="enum_member_name"><p><a name="PRELUDE-OPTION-TYPE-CLI:CAPS"></a>PRELUDE_OPTION_TYPE_CLI</p></td> |
| 1155 |
<td> </td> |
| 1156 |
<td> </td> |
| 1157 |
</tr> |
| 1158 |
<tr> |
| 1159 |
<td class="enum_member_name"><p><a name="PRELUDE-OPTION-TYPE-CFG:CAPS"></a>PRELUDE_OPTION_TYPE_CFG</p></td> |
| 1160 |
<td> </td> |
| 1161 |
<td> </td> |
| 1162 |
</tr> |
| 1163 |
<tr> |
| 1164 |
<td class="enum_member_name"><p><a name="PRELUDE-OPTION-TYPE-WIDE:CAPS"></a>PRELUDE_OPTION_TYPE_WIDE</p></td> |
| 1165 |
<td> </td> |
| 1166 |
<td> </td> |
| 1167 |
</tr> |
| 1168 |
<tr> |
| 1169 |
<td class="enum_member_name"><p><a name="PRELUDE-OPTION-TYPE-CONTEXT:CAPS"></a>PRELUDE_OPTION_TYPE_CONTEXT</p></td> |
| 1170 |
<td> </td> |
| 1171 |
<td> </td> |
| 1172 |
</tr> |
| 1173 |
<tr> |
| 1174 |
<td class="enum_member_name"><p><a name="PRELUDE-OPTION-TYPE-ROOT:CAPS"></a>PRELUDE_OPTION_TYPE_ROOT</p></td> |
| 1175 |
<td> </td> |
| 1176 |
<td> </td> |
| 1177 |
</tr> |
| 1178 |
<tr> |
| 1179 |
<td class="enum_member_name"><p><a name="PRELUDE-OPTION-TYPE-DESTROY:CAPS"></a>PRELUDE_OPTION_TYPE_DESTROY</p></td> |
| 1180 |
<td> </td> |
| 1181 |
<td> </td> |
| 1182 |
</tr> |
| 1183 |
</tbody> |
| 1184 |
</table></div> |
| 1185 |
</div> |
| 1186 |
</div> |
| 1187 |
<hr> |
| 1188 |
<div class="refsect2"> |
| 1189 |
<a name="prelude-option-input-type-t"></a><h3>enum prelude_option_input_type_t</h3> |
| 1190 |
<div class="refsect3"> |
| 1191 |
<a name="prelude-option-input-type-t.members"></a><h4>Members</h4> |
| 1192 |
<div class="informaltable"><table width="100%" border="0"> |
| 1193 |
<colgroup> |
| 1194 |
<col width="300px" class="enum_members_name"> |
| 1195 |
<col class="enum_members_description"> |
| 1196 |
<col width="200px" class="enum_members_annotations"> |
| 1197 |
</colgroup> |
| 1198 |
<tbody> |
| 1199 |
<tr> |
| 1200 |
<td class="enum_member_name"><p><a name="PRELUDE-OPTION-INPUT-TYPE-STRING:CAPS"></a>PRELUDE_OPTION_INPUT_TYPE_STRING</p></td> |
| 1201 |
<td> </td> |
| 1202 |
<td> </td> |
| 1203 |
</tr> |
| 1204 |
<tr> |
| 1205 |
<td class="enum_member_name"><p><a name="PRELUDE-OPTION-INPUT-TYPE-INTEGER:CAPS"></a>PRELUDE_OPTION_INPUT_TYPE_INTEGER</p></td> |
| 1206 |
<td> </td> |
| 1207 |
<td> </td> |
| 1208 |
</tr> |
| 1209 |
<tr> |
| 1210 |
<td class="enum_member_name"><p><a name="PRELUDE-OPTION-INPUT-TYPE-BOOLEAN:CAPS"></a>PRELUDE_OPTION_INPUT_TYPE_BOOLEAN</p></td> |
| 1211 |
<td> </td> |
| 1212 |
<td> </td> |
| 1213 |
</tr> |
| 1214 |
</tbody> |
| 1215 |
</table></div> |
| 1216 |
</div> |
| 1217 |
</div> |
| 1218 |
<hr> |
| 1219 |
<div class="refsect2"> |
| 1220 |
<a name="prelude-option-t"></a><h3>prelude_option_t</h3> |
| 1221 |
<pre class="programlisting">typedef struct prelude_option prelude_option_t; |
| 1222 |
</pre> |
| 1223 |
</div> |
| 1224 |
<hr> |
| 1225 |
<div class="refsect2"> |
| 1226 |
<a name="prelude-option-context-t"></a><h3>prelude_option_context_t</h3> |
| 1227 |
<pre class="programlisting">typedef struct prelude_option_context prelude_option_context_t; |
| 1228 |
</pre> |
| 1229 |
</div> |
| 1230 |
<hr> |
| 1231 |
<div class="refsect2"> |
| 1232 |
<a name="prelude-option-argument-t"></a><h3>enum prelude_option_argument_t</h3> |
| 1233 |
<div class="refsect3"> |
| 1234 |
<a name="prelude-option-argument-t.members"></a><h4>Members</h4> |
| 1235 |
<div class="informaltable"><table width="100%" border="0"> |
| 1236 |
<colgroup> |
| 1237 |
<col width="300px" class="enum_members_name"> |
| 1238 |
<col class="enum_members_description"> |
| 1239 |
<col width="200px" class="enum_members_annotations"> |
| 1240 |
</colgroup> |
| 1241 |
<tbody> |
| 1242 |
<tr> |
| 1243 |
<td class="enum_member_name"><p><a name="PRELUDE-OPTION-ARGUMENT-REQUIRED:CAPS"></a>PRELUDE_OPTION_ARGUMENT_REQUIRED</p></td> |
| 1244 |
<td> </td> |
| 1245 |
<td> </td> |
| 1246 |
</tr> |
| 1247 |
<tr> |
| 1248 |
<td class="enum_member_name"><p><a name="PRELUDE-OPTION-ARGUMENT-OPTIONAL:CAPS"></a>PRELUDE_OPTION_ARGUMENT_OPTIONAL</p></td> |
| 1249 |
<td> </td> |
| 1250 |
<td> </td> |
| 1251 |
</tr> |
| 1252 |
<tr> |
| 1253 |
<td class="enum_member_name"><p><a name="PRELUDE-OPTION-ARGUMENT-NONE:CAPS"></a>PRELUDE_OPTION_ARGUMENT_NONE</p></td> |
| 1254 |
<td> </td> |
| 1255 |
<td> </td> |
| 1256 |
</tr> |
| 1257 |
</tbody> |
| 1258 |
</table></div> |
| 1259 |
</div> |
| 1260 |
</div> |
| 1261 |
<hr> |
| 1262 |
<div class="refsect2"> |
| 1263 |
<a name="prelude-option-priority-t"></a><h3>enum prelude_option_priority_t</h3> |
| 1264 |
<div class="refsect3"> |
| 1265 |
<a name="prelude-option-priority-t.members"></a><h4>Members</h4> |
| 1266 |
<div class="informaltable"><table width="100%" border="0"> |
| 1267 |
<colgroup> |
| 1268 |
<col width="300px" class="enum_members_name"> |
| 1269 |
<col class="enum_members_description"> |
| 1270 |
<col width="200px" class="enum_members_annotations"> |
| 1271 |
</colgroup> |
| 1272 |
<tbody> |
| 1273 |
<tr> |
| 1274 |
<td class="enum_member_name"><p><a name="PRELUDE-OPTION-PRIORITY-IMMEDIATE:CAPS"></a>PRELUDE_OPTION_PRIORITY_IMMEDIATE</p></td> |
| 1275 |
<td> </td> |
| 1276 |
<td> </td> |
| 1277 |
</tr> |
| 1278 |
<tr> |
| 1279 |
<td class="enum_member_name"><p><a name="PRELUDE-OPTION-PRIORITY-FIRST:CAPS"></a>PRELUDE_OPTION_PRIORITY_FIRST</p></td> |
| 1280 |
<td> </td> |
| 1281 |
<td> </td> |
| 1282 |
</tr> |
| 1283 |
<tr> |
| 1284 |
<td class="enum_member_name"><p><a name="PRELUDE-OPTION-PRIORITY-NONE:CAPS"></a>PRELUDE_OPTION_PRIORITY_NONE</p></td> |
| 1285 |
<td> </td> |
| 1286 |
<td> </td> |
| 1287 |
</tr> |
| 1288 |
<tr> |
| 1289 |
<td class="enum_member_name"><p><a name="PRELUDE-OPTION-PRIORITY-LAST:CAPS"></a>PRELUDE_OPTION_PRIORITY_LAST</p></td> |
| 1290 |
<td> </td> |
| 1291 |
<td> </td> |
| 1292 |
</tr> |
| 1293 |
</tbody> |
| 1294 |
</table></div> |
| 1295 |
</div> |
| 1296 |
</div> |
| 1297 |
<hr> |
| 1298 |
<div class="refsect2"> |
| 1299 |
<a name="prelude-option-warning-t"></a><h3>enum prelude_option_warning_t</h3> |
| 1300 |
<div class="refsect3"> |
| 1301 |
<a name="prelude-option-warning-t.members"></a><h4>Members</h4> |
| 1302 |
<div class="informaltable"><table width="100%" border="0"> |
| 1303 |
<colgroup> |
| 1304 |
<col width="300px" class="enum_members_name"> |
| 1305 |
<col class="enum_members_description"> |
| 1306 |
<col width="200px" class="enum_members_annotations"> |
| 1307 |
</colgroup> |
| 1308 |
<tbody> |
| 1309 |
<tr> |
| 1310 |
<td class="enum_member_name"><p><a name="PRELUDE-OPTION-WARNING-OPTION:CAPS"></a>PRELUDE_OPTION_WARNING_OPTION</p></td> |
| 1311 |
<td> </td> |
| 1312 |
<td> </td> |
| 1313 |
</tr> |
| 1314 |
<tr> |
| 1315 |
<td class="enum_member_name"><p><a name="PRELUDE-OPTION-WARNING-ARG:CAPS"></a>PRELUDE_OPTION_WARNING_ARG</p></td> |
| 1316 |
<td> </td> |
| 1317 |
<td> </td> |
| 1318 |
</tr> |
| 1319 |
</tbody> |
| 1320 |
</table></div> |
| 1321 |
</div> |
| 1322 |
</div> |
| 1323 |
</div> |
| 1324 |
</div> |
| 1325 |
<div class="footer"> |
| 1326 |
<hr>Generated by GTK-Doc V1.28</div> |
| 1327 |
</body> |
| 1328 |
</html> |