1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libfuse: include/fuse_opt.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libfuse
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">fuse_opt.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a href="include_2fuse__opt_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfuse__opt.html">fuse_opt</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfuse__args.html">fuse_args</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a371d830a8aedd9e3f96d9bb31876a8f1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse__opt_8h.html#a371d830a8aedd9e3f96d9bb31876a8f1">FUSE_OPT_KEY</a>(templ, key)   { templ, -1U, key }</td></tr>
<tr class="separator:a371d830a8aedd9e3f96d9bb31876a8f1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aca35962e17d189ceb5447f8eea11bd33"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse__opt_8h.html#aca35962e17d189ceb5447f8eea11bd33">FUSE_OPT_END</a>   { NULL, 0, 0 }</td></tr>
<tr class="separator:aca35962e17d189ceb5447f8eea11bd33"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9bea40fe56b18be9aa110185ab7387ed"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse__opt_8h.html#a9bea40fe56b18be9aa110185ab7387ed">FUSE_ARGS_INIT</a>(argc, argv)   { argc, argv, 0 }</td></tr>
<tr class="separator:a9bea40fe56b18be9aa110185ab7387ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a48cb1aea482de904a848651360117748"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse__opt_8h.html#a48cb1aea482de904a848651360117748">FUSE_OPT_KEY_OPT</a>   -1</td></tr>
<tr class="separator:a48cb1aea482de904a848651360117748"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a632b025441794a4e6fe59b7ab53bbfc4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse__opt_8h.html#a632b025441794a4e6fe59b7ab53bbfc4">FUSE_OPT_KEY_NONOPT</a>   -2</td></tr>
<tr class="separator:a632b025441794a4e6fe59b7ab53bbfc4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8533ff341f910c1bd05f10c8fcc35a04"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse__opt_8h.html#a8533ff341f910c1bd05f10c8fcc35a04">FUSE_OPT_KEY_KEEP</a>   -3</td></tr>
<tr class="separator:a8533ff341f910c1bd05f10c8fcc35a04"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6e97b6ce492f1baaaf0a4eb4970c9a2f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse__opt_8h.html#a6e97b6ce492f1baaaf0a4eb4970c9a2f">FUSE_OPT_KEY_DISCARD</a>   -4</td></tr>
<tr class="separator:a6e97b6ce492f1baaaf0a4eb4970c9a2f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a3d2ab809528d409b0ee91cee400c07c2"><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse__opt_8h.html#a3d2ab809528d409b0ee91cee400c07c2">fuse_opt_proc_t</a>) (void *data, const char *arg, int key, struct <a class="el" href="structfuse__args.html">fuse_args</a> *outargs)</td></tr>
<tr class="separator:a3d2ab809528d409b0ee91cee400c07c2"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a539ef1f571c34f516c60c4cbe2901c0e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse__opt_8h.html#a539ef1f571c34f516c60c4cbe2901c0e">fuse_opt_parse</a> (struct <a class="el" href="structfuse__args.html">fuse_args</a> *args, void *data, const struct <a class="el" href="structfuse__opt.html">fuse_opt</a> opts[], <a class="el" href="include_2fuse__opt_8h.html#a3d2ab809528d409b0ee91cee400c07c2">fuse_opt_proc_t</a> proc)</td></tr>
<tr class="separator:a539ef1f571c34f516c60c4cbe2901c0e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaae525d5e959c5394bc323be0c1d02b0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse__opt_8h.html#aaae525d5e959c5394bc323be0c1d02b0">fuse_opt_add_opt</a> (char **opts, const char *opt)</td></tr>
<tr class="separator:aaae525d5e959c5394bc323be0c1d02b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a51a00d087d08bef250a53b9e4979b1cd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse__opt_8h.html#a51a00d087d08bef250a53b9e4979b1cd">fuse_opt_add_opt_escaped</a> (char **opts, const char *opt)</td></tr>
<tr class="separator:a51a00d087d08bef250a53b9e4979b1cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a21602e6a0fff64fc9c7b642d12382094"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse__opt_8h.html#a21602e6a0fff64fc9c7b642d12382094">fuse_opt_add_arg</a> (struct <a class="el" href="structfuse__args.html">fuse_args</a> *args, const char *arg)</td></tr>
<tr class="separator:a21602e6a0fff64fc9c7b642d12382094"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adb2922444d67f58e4233d21320386bc0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse__opt_8h.html#adb2922444d67f58e4233d21320386bc0">fuse_opt_insert_arg</a> (struct <a class="el" href="structfuse__args.html">fuse_args</a> *args, int pos, const char *arg)</td></tr>
<tr class="separator:adb2922444d67f58e4233d21320386bc0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2cdf272429ab3869a5162976141b287d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse__opt_8h.html#a2cdf272429ab3869a5162976141b287d">fuse_opt_free_args</a> (struct <a class="el" href="structfuse__args.html">fuse_args</a> *args)</td></tr>
<tr class="separator:a2cdf272429ab3869a5162976141b287d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af16c684bd2b10b7ac0ae299afa1e0e06"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2fuse__opt_8h.html#af16c684bd2b10b7ac0ae299afa1e0e06">fuse_opt_match</a> (const struct <a class="el" href="structfuse__opt.html">fuse_opt</a> opts[], const char *opt)</td></tr>
<tr class="separator:af16c684bd2b10b7ac0ae299afa1e0e06"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This file defines the option parsing interface of FUSE </p>
<p class="definition">Definition in file <a class="el" href="include_2fuse__opt_8h_source.html">fuse_opt.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a9bea40fe56b18be9aa110185ab7387ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9bea40fe56b18be9aa110185ab7387ed">◆ </a></span>FUSE_ARGS_INIT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FUSE_ARGS_INIT</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">argc, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">argv </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   { argc, argv, 0 }</td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializer for 'struct <a class="el" href="structfuse__args.html">fuse_args</a>' </p>
<p class="definition">Definition at line <a class="el" href="include_2fuse__opt_8h_source.html#l00123">123</a> of file <a class="el" href="include_2fuse__opt_8h_source.html">fuse_opt.h</a>.</p>
</div>
</div>
<a id="aca35962e17d189ceb5447f8eea11bd33"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca35962e17d189ceb5447f8eea11bd33">◆ </a></span>FUSE_OPT_END</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FUSE_OPT_END   { NULL, 0, 0 }</td>
</tr>
</table>
</div><div class="memdoc">
<p>Last option. An array of 'struct <a class="el" href="structfuse__opt.html">fuse_opt</a>' must end with a NULL template value </p>
<p class="definition">Definition at line <a class="el" href="include_2fuse__opt_8h_source.html#l00104">104</a> of file <a class="el" href="include_2fuse__opt_8h_source.html">fuse_opt.h</a>.</p>
</div>
</div>
<a id="a371d830a8aedd9e3f96d9bb31876a8f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a371d830a8aedd9e3f96d9bb31876a8f1">◆ </a></span>FUSE_OPT_KEY</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FUSE_OPT_KEY</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">templ, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">key </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   { templ, -1U, key }</td>
</tr>
</table>
</div><div class="memdoc">
<p>Key option. In case of a match, the processing function will be called with the specified key. </p>
<p class="definition">Definition at line <a class="el" href="include_2fuse__opt_8h_source.html#l00098">98</a> of file <a class="el" href="include_2fuse__opt_8h_source.html">fuse_opt.h</a>.</p>
</div>
</div>
<a id="a6e97b6ce492f1baaaf0a4eb4970c9a2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e97b6ce492f1baaaf0a4eb4970c9a2f">◆ </a></span>FUSE_OPT_KEY_DISCARD</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FUSE_OPT_KEY_DISCARD   -4</td>
</tr>
</table>
</div><div class="memdoc">
<p>Special key value for options to discard</p>
<p>Argument is not passed to processing function, but behave as if the processing function returned zero </p>
<p class="definition">Definition at line <a class="el" href="include_2fuse__opt_8h_source.html#l00153">153</a> of file <a class="el" href="include_2fuse__opt_8h_source.html">fuse_opt.h</a>.</p>
</div>
</div>
<a id="a8533ff341f910c1bd05f10c8fcc35a04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8533ff341f910c1bd05f10c8fcc35a04">◆ </a></span>FUSE_OPT_KEY_KEEP</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FUSE_OPT_KEY_KEEP   -3</td>
</tr>
</table>
</div><div class="memdoc">
<p>Special key value for options to keep</p>
<p>Argument is not passed to processing function, but behave as if the processing function returned 1 </p>
<p class="definition">Definition at line <a class="el" href="include_2fuse__opt_8h_source.html#l00145">145</a> of file <a class="el" href="include_2fuse__opt_8h_source.html">fuse_opt.h</a>.</p>
</div>
</div>
<a id="a632b025441794a4e6fe59b7ab53bbfc4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a632b025441794a4e6fe59b7ab53bbfc4">◆ </a></span>FUSE_OPT_KEY_NONOPT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FUSE_OPT_KEY_NONOPT   -2</td>
</tr>
</table>
</div><div class="memdoc">
<p>Key value passed to the processing function for all non-options</p>
<p>Non-options are the arguments beginning with a character other than '-' or all arguments after the special '–' option </p>
<p class="definition">Definition at line <a class="el" href="include_2fuse__opt_8h_source.html#l00137">137</a> of file <a class="el" href="include_2fuse__opt_8h_source.html">fuse_opt.h</a>.</p>
</div>
</div>
<a id="a48cb1aea482de904a848651360117748"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48cb1aea482de904a848651360117748">◆ </a></span>FUSE_OPT_KEY_OPT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FUSE_OPT_KEY_OPT   -1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Key value passed to the processing function if an option did not match any template </p>
<p class="definition">Definition at line <a class="el" href="include_2fuse__opt_8h_source.html#l00129">129</a> of file <a class="el" href="include_2fuse__opt_8h_source.html">fuse_opt.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a3d2ab809528d409b0ee91cee400c07c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d2ab809528d409b0ee91cee400c07c2">◆ </a></span>fuse_opt_proc_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int(* fuse_opt_proc_t) (void *data, const char *arg, int key, struct <a class="el" href="structfuse__args.html">fuse_args</a> *outargs)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Processing function</p>
<p>This function is called if</p><ul>
<li>option did not match any 'struct <a class="el" href="structfuse__opt.html">fuse_opt</a>'</li>
<li>argument is a non-option</li>
<li>option did match and offset was set to -1</li>
</ul>
<p>The 'arg' parameter will always contain the whole argument or option including the parameter if exists. A two-argument option ("-x foo") is always converted to single argument option of the form "-xfoo" before this function is called.</p>
<p>Options of the form '-ofoo' are passed to this function without the '-o' prefix.</p>
<p>The return value of this function determines whether this argument is to be inserted into the output argument vector, or discarded.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>is the user data passed to the <a class="el" href="fuse-3_813_80_2include_2fuse__opt_8h.html#a539ef1f571c34f516c60c4cbe2901c0e">fuse_opt_parse()</a> function </td></tr>
<tr><td class="paramname">arg</td><td>is the whole argument or option </td></tr>
<tr><td class="paramname">key</td><td>determines why the processing function was called </td></tr>
<tr><td class="paramname">outargs</td><td>the current output argument list </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>-1 on error, 0 if arg is to be discarded, 1 if arg should be kept </dd></dl>
<p class="definition">Definition at line <a class="el" href="include_2fuse__opt_8h_source.html#l00180">180</a> of file <a class="el" href="include_2fuse__opt_8h_source.html">fuse_opt.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a21602e6a0fff64fc9c7b642d12382094"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21602e6a0fff64fc9c7b642d12382094">◆ </a></span>fuse_opt_add_arg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fuse_opt_add_arg </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structfuse__args.html">fuse_args</a> * </td>
<td class="paramname"><em>args</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add an argument to a NULL terminated argument vector</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">args</td><td>is the structure containing the current argument list </td></tr>
<tr><td class="paramname">arg</td><td>is the new argument to add </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>-1 on allocation error, 0 on success </dd></dl>
<p class="definition">Definition at line <a class="el" href="fuse-3_813_80_2lib_2fuse__opt_8c_source.html#l00055">55</a> of file <a class="el" href="fuse-3_813_80_2lib_2fuse__opt_8c_source.html">fuse_opt.c</a>.</p>
</div>
</div>
<a id="aaae525d5e959c5394bc323be0c1d02b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaae525d5e959c5394bc323be0c1d02b0">◆ </a></span>fuse_opt_add_opt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fuse_opt_add_opt </td>
<td>(</td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>opts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>opt</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add an option to a comma separated option list</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">opts</td><td>is a pointer to an option list, may point to a NULL value </td></tr>
<tr><td class="paramname">opt</td><td>is the option to add </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>-1 on allocation error, 0 on success </dd></dl>
<p class="definition">Definition at line <a class="el" href="fuse-3_813_80_2lib_2fuse__opt_8c_source.html#l00139">139</a> of file <a class="el" href="fuse-3_813_80_2lib_2fuse__opt_8c_source.html">fuse_opt.c</a>.</p>
</div>
</div>
<a id="a51a00d087d08bef250a53b9e4979b1cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51a00d087d08bef250a53b9e4979b1cd">◆ </a></span>fuse_opt_add_opt_escaped()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fuse_opt_add_opt_escaped </td>
<td>(</td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>opts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>opt</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add an option, escaping commas, to a comma separated option list</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">opts</td><td>is a pointer to an option list, may point to a NULL value </td></tr>
<tr><td class="paramname">opt</td><td>is the option to add </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>-1 on allocation error, 0 on success </dd></dl>
<p class="definition">Definition at line <a class="el" href="fuse-3_813_80_2lib_2fuse__opt_8c_source.html#l00144">144</a> of file <a class="el" href="fuse-3_813_80_2lib_2fuse__opt_8c_source.html">fuse_opt.c</a>.</p>
</div>
</div>
<a id="a2cdf272429ab3869a5162976141b287d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2cdf272429ab3869a5162976141b287d">◆ </a></span>fuse_opt_free_args()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fuse_opt_free_args </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structfuse__args.html">fuse_args</a> * </td>
<td class="paramname"><em>args</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free the contents of argument list</p>
<p>The structure itself is not freed</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">args</td><td>is the structure containing the argument list </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="fuse-3_813_80_2lib_2fuse__opt_8c_source.html#l00034">34</a> of file <a class="el" href="fuse-3_813_80_2lib_2fuse__opt_8c_source.html">fuse_opt.c</a>.</p>
</div>
</div>
<a id="adb2922444d67f58e4233d21320386bc0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb2922444d67f58e4233d21320386bc0">◆ </a></span>fuse_opt_insert_arg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fuse_opt_insert_arg </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structfuse__args.html">fuse_args</a> * </td>
<td class="paramname"><em>args</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>pos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add an argument at the specified position in a NULL terminated argument vector</p>
<p>Adds the argument to the N-th position. This is useful for adding options at the beginning of the array which must not come after the special '–' option.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">args</td><td>is the structure containing the current argument list </td></tr>
<tr><td class="paramname">pos</td><td>is the position at which to add the argument </td></tr>
<tr><td class="paramname">arg</td><td>is the new argument to add </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>-1 on allocation error, 0 on success </dd></dl>
<p class="definition">Definition at line <a class="el" href="fuse-3_813_80_2lib_2fuse__opt_8c_source.html#l00095">95</a> of file <a class="el" href="fuse-3_813_80_2lib_2fuse__opt_8c_source.html">fuse_opt.c</a>.</p>
</div>
</div>
<a id="af16c684bd2b10b7ac0ae299afa1e0e06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af16c684bd2b10b7ac0ae299afa1e0e06">◆ </a></span>fuse_opt_match()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fuse_opt_match </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structfuse__opt.html">fuse_opt</a> </td>
<td class="paramname"><em>opts</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>opt</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if an option matches</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">opts</td><td>is the option description array </td></tr>
<tr><td class="paramname">opt</td><td>is the option to match </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if a match is found, 0 if not </dd></dl>
</div>
</div>
<a id="a539ef1f571c34f516c60c4cbe2901c0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a539ef1f571c34f516c60c4cbe2901c0e">◆ </a></span>fuse_opt_parse()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fuse_opt_parse </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structfuse__args.html">fuse_args</a> * </td>
<td class="paramname"><em>args</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const struct <a class="el" href="structfuse__opt.html">fuse_opt</a> </td>
<td class="paramname"><em>opts</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="include_2fuse__opt_8h.html#a3d2ab809528d409b0ee91cee400c07c2">fuse_opt_proc_t</a> </td>
<td class="paramname"><em>proc</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Option parsing function</p>
<p>If 'args' was returned from a previous call to <a class="el" href="fuse-3_813_80_2include_2fuse__opt_8h.html#a539ef1f571c34f516c60c4cbe2901c0e">fuse_opt_parse()</a> or it was constructed from</p>
<p>A NULL 'args' is equivalent to an empty argument vector</p>
<p>A NULL 'opts' is equivalent to an 'opts' array containing a single end marker</p>
<p>A NULL 'proc' is equivalent to a processing function always returning '1'</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">args</td><td>is the input and output argument list </td></tr>
<tr><td class="paramname">data</td><td>is the user data </td></tr>
<tr><td class="paramname">opts</td><td>is the option description array </td></tr>
<tr><td class="paramname">proc</td><td>is the processing function </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>-1 on error, 0 on success </dd></dl>
<p class="definition">Definition at line <a class="el" href="fuse-3_813_80_2lib_2fuse__opt_8c_source.html#l00398">398</a> of file <a class="el" href="fuse-3_813_80_2lib_2fuse__opt_8c_source.html">fuse_opt.c</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
|
