forked from git/git
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathapi-strbuf.html
More file actions
777 lines (740 loc) · 18.3 KB
/
api-strbuf.html
File metadata and controls
777 lines (740 loc) · 18.3 KB
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
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.2.5" />
<style type="text/css">
/* Debug borders */
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
/*
border: 1px solid red;
*/
}
body {
margin: 1em 5% 1em 5%;
}
a {
color: blue;
text-decoration: underline;
}
a:visited {
color: fuchsia;
}
em {
font-style: italic;
}
strong {
font-weight: bold;
}
tt {
color: navy;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
font-family: sans-serif;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1, h2, h3 {
border-bottom: 2px solid silver;
}
h2 {
padding-top: 0.5em;
}
h3 {
float: left;
}
h3 + * {
clear: left;
}
div.sectionbody {
font-family: serif;
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
pre {
padding: 0;
margin: 0;
}
span#author {
color: #527bbd;
font-family: sans-serif;
font-weight: bold;
font-size: 1.1em;
}
span#email {
}
span#revision {
font-family: sans-serif;
}
div#footer {
font-family: sans-serif;
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
div#footer-text {
float: left;
padding-bottom: 0.5em;
}
div#footer-badges {
float: right;
padding-bottom: 0.5em;
}
div#preamble,
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-right: 10%;
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.5em;
margin-bottom: 2.5em;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
font-family: sans-serif;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.listingblock {
margin-right: 0%;
}
div.listingblock > div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock > div.content {
padding-left: 2.0em;
}
div.attribution {
text-align: right;
}
div.verseblock + div.attribution {
text-align: left;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 2px solid silver;
}
div.exampleblock > div.content {
border-left: 2px solid silver;
padding: 0.5em;
}
div.verseblock div.content {
white-space: pre;
}
div.imageblock div.content { padding-left: 0; }
div.imageblock img { border: 1px solid silver; }
span.image img { border-style: none; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: italic;
}
dd > *:first-child {
margin-top: 0;
}
ul, ol {
list-style-position: outside;
}
div.olist2 ol {
list-style-type: lower-alpha;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead {
font-family: sans-serif;
font-weight: bold;
}
tfoot {
font-weight: bold;
}
div.hlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
div.hlist td {
padding-bottom: 5px;
}
td.hlist1 {
vertical-align: top;
font-style: italic;
padding-right: 0.8em;
}
td.hlist2 {
vertical-align: top;
}
@media print {
div#footer-badges { display: none; }
}
div#toctitle {
color: #527bbd;
font-family: sans-serif;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
font-size: 0.9em;
}
div.toclevel3 {
margin-left: 4em;
font-size: 0.9em;
}
div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
/* Workarounds for IE6's broken and incomplete CSS2. */
div.sidebar-content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.sidebar-title, div.image-title {
font-family: sans-serif;
font-weight: bold;
margin-top: 0.0em;
margin-bottom: 0.5em;
}
div.listingblock div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock-content {
padding-left: 2.0em;
}
div.exampleblock-content {
border-left: 2px solid silver;
padding-left: 0.5em;
}
/* IE6 sets dynamically generated links as visited. */
div#toc a:visited { color: blue; }
</style>
<title>strbuf API</title>
</head>
<body>
<div id="header">
<h1>strbuf API</h1>
</div>
<div id="preamble">
<div class="sectionbody">
<div class="para"><p>strbuf's are meant to be used with all the usual C string and memory
APIs. Given that the length of the buffer is known, it's often better to
use the mem* functions than a str* one (memchr vs. strchr e.g.).
Though, one has to be careful about the fact that str* functions often
stop on NULs and that strbufs may have embedded NULs.</p></div>
<div class="para"><p>An strbuf is NUL terminated for convenience, but no function in the
strbuf API actually relies on the string being free of NULs.</p></div>
<div class="para"><p>strbufs has some invariants that are very important to keep in mind:</p></div>
<div class="olist"><ol>
<li>
<p>
The <tt>buf</tt> member is never NULL, so it can be used in any usual C
string operations safely. strbuf's _have_ to be initialized either by
<tt>strbuf_init()</tt> or by <tt>= STRBUF_INIT</tt> before the invariants, though.
</p>
<div class="para"><p>Do <strong>not</strong> assume anything on what <tt>buf</tt> really is (e.g. if it is
allocated memory or not), use <tt>strbuf_detach()</tt> to unwrap a memory
buffer from its strbuf shell in a safe way. That is the sole supported
way. This will give you a malloced buffer that you can later <tt>free()</tt>.</p></div>
<div class="para"><p>However, it is totally safe to modify anything in the string pointed by
the <tt>buf</tt> member, between the indices <tt>0</tt> and <tt>len-1</tt> (inclusive).</p></div>
</li>
<li>
<p>
The <tt>buf</tt> member is a byte array that has at least <tt>len + 1</tt> bytes
allocated. The extra byte is used to store a <tt><em>\0</em></tt>, allowing the
<tt>buf</tt> member to be a valid C-string. Every strbuf function ensure this
invariant is preserved.
</p>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">It is OK to "play" with the buffer directly if you work it this
way:</td>
</tr></table>
</div>
<div class="listingblock">
<div class="content">
<pre><tt>strbuf_grow(sb, SOME_SIZE); <b>(1)</b>
strbuf_setlen(sb, sb->len + SOME_OTHER_SIZE);</tt></pre>
</div></div>
<div class="colist"><ol>
<li>
<p>
Here, the memory array starting at <tt>sb->buf</tt>, and of length
<tt>strbuf_avail(sb)</tt> is all yours, and you can be sure that
<tt>strbuf_avail(sb)</tt> is at least <tt>SOME_SIZE</tt>.
</p>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content"><tt>SOME_OTHER_SIZE</tt> must be smaller or equal to <tt>strbuf_avail(sb)</tt>.</td>
</tr></table>
</div>
<div class="para"><p>Doing so is safe, though if it has to be done in many places, adding the
missing API to the strbuf module is the way to go.</p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Warning</div>
</td>
<td class="content">Do _not_ assume that the area that is yours is of size <tt>alloc
- 1</tt> even if it's true in the current implementation. Alloc is somehow a
"private" member that should not be messed with. Use <tt>strbuf_avail()</tt>
instead.</td>
</tr></table>
</div>
</li>
</ol></div>
</li>
</ol></div>
</div>
</div>
<h2 id="_data_structures">Data structures</h2>
<div class="sectionbody">
<div class="ilist"><ul>
<li>
<p>
<tt>struct strbuf</tt>
</p>
</li>
</ul></div>
<div class="para"><p>This is the string buffer structure. The <tt>len</tt> member can be used to
determine the current length of the string, and <tt>buf</tt> member provides access to
the string itself.</p></div>
</div>
<h2 id="_functions">Functions</h2>
<div class="sectionbody">
<div class="ilist"><ul>
<li>
<p>
Life cycle
</p>
<div class="vlist"><dl>
<dt>
<tt>strbuf_init</tt>
</dt>
<dd>
<p>
Initialize the structure. The second parameter can be zero or a bigger
number to allocate memory, in case you want to prevent further reallocs.
</p>
</dd>
<dt>
<tt>strbuf_release</tt>
</dt>
<dd>
<p>
Release a string buffer and the memory it used. You should not use the
string buffer after using this function, unless you initialize it again.
</p>
</dd>
<dt>
<tt>strbuf_detach</tt>
</dt>
<dd>
<p>
Detach the string from the strbuf and returns it; you now own the
storage the string occupies and it is your responsibility from then on
to release it with <tt>free(3)</tt> when you are done with it.
</p>
</dd>
<dt>
<tt>strbuf_attach</tt>
</dt>
<dd>
<p>
Attach a string to a buffer. You should specify the string to attach,
the current length of the string and the amount of allocated memory.
The amount must be larger than the string length, because the string you
pass is supposed to be a NUL-terminated string. This string _must_ be
malloc()ed, and after attaching, the pointer cannot be relied upon
anymore, and neither be free()d directly.
</p>
</dd>
<dt>
<tt>strbuf_swap</tt>
</dt>
<dd>
<p>
Swap the contents of two string buffers.
</p>
</dd>
</dl></div>
</li>
<li>
<p>
Related to the size of the buffer
</p>
<div class="vlist"><dl>
<dt>
<tt>strbuf_avail</tt>
</dt>
<dd>
<p>
Determine the amount of allocated but unused memory.
</p>
</dd>
<dt>
<tt>strbuf_grow</tt>
</dt>
<dd>
<p>
Ensure that at least this amount of unused memory is available after
<tt>len</tt>. This is used when you know a typical size for what you will add
and want to avoid repetitive automatic resizing of the underlying buffer.
This is never a needed operation, but can be critical for performance in
some cases.
</p>
</dd>
<dt>
<tt>strbuf_setlen</tt>
</dt>
<dd>
<p>
Set the length of the buffer to a given value. This function does <strong>not</strong>
allocate new memory, so you should not perform a <tt>strbuf_setlen()</tt> to a
length that is larger than <tt>len + strbuf_avail()</tt>. <tt>strbuf_setlen()</tt> is
just meant as a <em>please fix invariants from this strbuf I just messed
with</em>.
</p>
</dd>
<dt>
<tt>strbuf_reset</tt>
</dt>
<dd>
<p>
Empty the buffer by setting the size of it to zero.
</p>
</dd>
</dl></div>
</li>
<li>
<p>
Related to the contents of the buffer
</p>
<div class="vlist"><dl>
<dt>
<tt>strbuf_rtrim</tt>
</dt>
<dd>
<p>
Strip whitespace from the end of a string.
</p>
</dd>
<dt>
<tt>strbuf_cmp</tt>
</dt>
<dd>
<p>
Compare two buffers. Returns an integer less than, equal to, or greater
than zero if the first buffer is found, respectively, to be less than,
to match, or be greater than the second buffer.
</p>
</dd>
</dl></div>
</li>
<li>
<p>
Adding data to the buffer
</p>
</li>
</ul></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">All of the functions in this section will grow the buffer as necessary.
If they fail for some reason other than memory shortage and the buffer hadn't
been allocated before (i.e. the <tt>struct strbuf</tt> was set to <tt>STRBUF_INIT</tt>),
then they will free() it.</td>
</tr></table>
</div>
<div class="vlist"><dl>
<dt>
<tt>strbuf_addch</tt>
</dt>
<dd>
<p>
Add a single character to the buffer.
</p>
</dd>
<dt>
<tt>strbuf_insert</tt>
</dt>
<dd>
<p>
Insert data to the given position of the buffer. The remaining contents
will be shifted, not overwritten.
</p>
</dd>
<dt>
<tt>strbuf_remove</tt>
</dt>
<dd>
<p>
Remove given amount of data from a given position of the buffer.
</p>
</dd>
<dt>
<tt>strbuf_splice</tt>
</dt>
<dd>
<p>
Remove the bytes between <tt>pos..pos+len</tt> and replace it with the given
data.
</p>
</dd>
<dt>
<tt>strbuf_add</tt>
</dt>
<dd>
<p>
Add data of given length to the buffer.
</p>
</dd>
<dt>
<tt>strbuf_addstr</tt>
</dt>
<dd>
<p>
Add a NUL-terminated string to the buffer.
</p>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">This function will <strong>always</strong> be implemented as an inline or a macro
that expands to:</td>
</tr></table>
</div>
<div class="listingblock">
<div class="content">
<pre><tt>strbuf_add(..., s, strlen(s));</tt></pre>
</div></div>
<div class="para"><p>Meaning that this is efficient to write things like:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt>strbuf_addstr(sb, "immediate string");</tt></pre>
</div></div>
</dd>
<dt>
<tt>strbuf_addbuf</tt>
</dt>
<dd>
<p>
Copy the contents of an other buffer at the end of the current one.
</p>
</dd>
<dt>
<tt>strbuf_adddup</tt>
</dt>
<dd>
<p>
Copy part of the buffer from a given position till a given length to the
end of the buffer.
</p>
</dd>
<dt>
<tt>strbuf_expand</tt>
</dt>
<dd>
<p>
This function can be used to expand a format string containing
placeholders. To that end, it parses the string and calls the specified
function for every percent sign found.
</p>
<div class="para"><p>The callback function is given a pointer to the character after the <tt>%</tt>
and a pointer to the struct strbuf. It is expected to add the expanded
version of the placeholder to the strbuf, e.g. to add a newline
character if the letter <tt>n</tt> appears after a <tt>%</tt>. The function returns
the length of the placeholder recognized and <tt>strbuf_expand()</tt> skips
over it.</p></div>
<div class="para"><p>The format <tt>%%</tt> is automatically expanded to a single <tt>%</tt> as a quoting
mechanism; callers do not need to handle the <tt>%</tt> placeholder themselves,
and the callback function will not be invoked for this placeholder.</p></div>
<div class="para"><p>All other characters (non-percent and not skipped ones) are copied
verbatim to the strbuf. If the callback returned zero, meaning that the
placeholder is unknown, then the percent sign is copied, too.</p></div>
<div class="para"><p>In order to facilitate caching and to make it possible to give
parameters to the callback, <tt>strbuf_expand()</tt> passes a context pointer,
which can be used by the programmer of the callback as she sees fit.</p></div>
</dd>
<dt>
<tt>strbuf_expand_dict_cb</tt>
</dt>
<dd>
<p>
Used as callback for <tt>strbuf_expand()</tt>, expects an array of
struct strbuf_expand_dict_entry as context, i.e. pairs of
placeholder and replacement string. The array needs to be
terminated by an entry with placeholder set to NULL.
</p>
</dd>
<dt>
<tt>strbuf_addbuf_percentquote</tt>
</dt>
<dd>
<p>
Append the contents of one strbuf to another, quoting any
percent signs ("%") into double-percents ("%%") in the
destination. This is useful for literal data to be fed to either
strbuf_expand or to the *printf family of functions.
</p>
</dd>
<dt>
<tt>strbuf_addf</tt>
</dt>
<dd>
<p>
Add a formatted string to the buffer.
</p>
</dd>
<dt>
<tt>strbuf_fread</tt>
</dt>
<dd>
<p>
Read a given size of data from a FILE* pointer to the buffer.
</p>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">The buffer is rewound if the read fails. If -1 is returned,
<tt>errno</tt> must be consulted, like you would do for <tt>read(3)</tt>.
<tt>strbuf_read()</tt>, <tt>strbuf_read_file()</tt> and <tt>strbuf_getline()</tt> has the
same behaviour as well.</td>
</tr></table>
</div>
</dd>
<dt>
<tt>strbuf_read</tt>
</dt>
<dd>
<p>
Read the contents of a given file descriptor. The third argument can be
used to give a hint about the file size, to avoid reallocs.
</p>
</dd>
<dt>
<tt>strbuf_read_file</tt>
</dt>
<dd>
<p>
Read the contents of a file, specified by its path. The third argument
can be used to give a hint about the file size, to avoid reallocs.
</p>
</dd>
<dt>
<tt>strbuf_readlink</tt>
</dt>
<dd>
<p>
Read the target of a symbolic link, specified by its path. The third
argument can be used to give a hint about the size, to avoid reallocs.
</p>
</dd>
<dt>
<tt>strbuf_getline</tt>
</dt>
<dd>
<p>
Read a line from a FILE* pointer. The second argument specifies the line
terminator character, typically <tt><em>\n</em></tt>.
</p>
</dd>
<dt>
<tt>stripspace</tt>
</dt>
<dd>
<p>
Strip whitespace from a buffer. The second parameter controls if
comments are considered contents to be removed or not.
</p>
</dd>
<dt>
<tt>launch_editor</tt>
</dt>
<dd>
<p>
Launch the user preferred editor to edit a file and fill the buffer
with the file's contents upon the user completing their editing. The
third argument can be used to set the environment which the editor is
run in. If the buffer is NULL the editor is launched as usual but the
file's contents are not read into the buffer upon completion.
</p>
</dd>
</dl></div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2010-09-18 23:57:15 UTC
</div>
</div>
</body>
</html>