Google Git
Sign in
chromium / external / gitster / git-htmldocs / 4604fe5609a48fc240d1a88a15c642c9883363c7 / . / technical / api-strbuf.html
blob: ff256285e907e6fd0de2ace051b8e627f0d36512 [file] [log] [blame]
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]6<meta name="generator" content="AsciiDoc 8.2.5" />
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]7<style type="text/css">
8/* Debug borders */
9p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
10/*
11 border: 1px solid red;
12*/
13}
14
15body {
16 margin: 1em 5% 1em 5%;
17}
18
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]19a {
20 color: blue;
21 text-decoration: underline;
22}
23a:visited {
24 color: fuchsia;
25}
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]26
27em {
28 font-style: italic;
29}
30
31strong {
32 font-weight: bold;
33}
34
35tt {
36 color: navy;
37}
38
39h1, h2, h3, h4, h5, h6 {
40 color: #527bbd;
41 font-family: sans-serif;
42 margin-top: 1.2em;
43 margin-bottom: 0.5em;
44 line-height: 1.3;
45}
46
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]47h1, h2, h3 {
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]48 border-bottom: 2px solid silver;
49}
50h2 {
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]51 padding-top: 0.5em;
52}
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]53h3 {
54 float: left;
55}
56h3 + * {
57 clear: left;
58}
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]59
60div.sectionbody {
61 font-family: serif;
62 margin-left: 0;
63}
64
65hr {
66 border: 1px solid silver;
67}
68
69p {
70 margin-top: 0.5em;
71 margin-bottom: 0.5em;
72}
73
74pre {
75 padding: 0;
76 margin: 0;
77}
78
79span#author {
80 color: #527bbd;
81 font-family: sans-serif;
82 font-weight: bold;
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]83 font-size: 1.1em;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]84}
85span#email {
86}
87span#revision {
88 font-family: sans-serif;
89}
90
91div#footer {
92 font-family: sans-serif;
93 font-size: small;
94 border-top: 2px solid silver;
95 padding-top: 0.5em;
96 margin-top: 4.0em;
97}
98div#footer-text {
99 float: left;
100 padding-bottom: 0.5em;
101}
102div#footer-badges {
103 float: right;
104 padding-bottom: 0.5em;
105}
106
107div#preamble,
108div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
109div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
110div.admonitionblock {
111 margin-right: 10%;
112 margin-top: 1.5em;
113 margin-bottom: 1.5em;
114}
115div.admonitionblock {
116 margin-top: 2.5em;
117 margin-bottom: 2.5em;
118}
119
120div.content { /* Block element content. */
121 padding: 0;
122}
123
124/* Block element titles. */
125div.title, caption.title {
126 font-family: sans-serif;
127 font-weight: bold;
128 text-align: left;
129 margin-top: 1.0em;
130 margin-bottom: 0.5em;
131}
132div.title + * {
133 margin-top: 0;
134}
135
136td div.title:first-child {
137 margin-top: 0.0em;
138}
139div.content div.title:first-child {
140 margin-top: 0.0em;
141}
142div.content + div.title {
143 margin-top: 0.0em;
144}
145
146div.sidebarblock > div.content {
147 background: #ffffee;
148 border: 1px solid silver;
149 padding: 0.5em;
150}
151
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]152div.listingblock {
153 margin-right: 0%;
154}
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]155div.listingblock > div.content {
156 border: 1px solid silver;
157 background: #f4f4f4;
158 padding: 0.5em;
159}
160
161div.quoteblock > div.content {
162 padding-left: 2.0em;
163}
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]164
165div.attribution {
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]166 text-align: right;
167}
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]168div.verseblock + div.attribution {
169 text-align: left;
170}
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]171
172div.admonitionblock .icon {
173 vertical-align: top;
174 font-size: 1.1em;
175 font-weight: bold;
176 text-decoration: underline;
177 color: #527bbd;
178 padding-right: 0.5em;
179}
180div.admonitionblock td.content {
181 padding-left: 0.5em;
182 border-left: 2px solid silver;
183}
184
185div.exampleblock > div.content {
186 border-left: 2px solid silver;
187 padding: 0.5em;
188}
189
190div.verseblock div.content {
191 white-space: pre;
192}
193
194div.imageblock div.content { padding-left: 0; }
195div.imageblock img { border: 1px solid silver; }
196span.image img { border-style: none; }
197
198dl {
199 margin-top: 0.8em;
200 margin-bottom: 0.8em;
201}
202dt {
203 margin-top: 0.5em;
204 margin-bottom: 0;
205 font-style: italic;
206}
207dd > *:first-child {
208 margin-top: 0;
209}
210
211ul, ol {
212 list-style-position: outside;
213}
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]214div.olist2 ol {
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]215 list-style-type: lower-alpha;
216}
217
218div.tableblock > table {
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]219 border: 3px solid #527bbd;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]220}
221thead {
222 font-family: sans-serif;
223 font-weight: bold;
224}
225tfoot {
226 font-weight: bold;
227}
228
229div.hlist {
230 margin-top: 0.8em;
231 margin-bottom: 0.8em;
232}
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]233div.hlist td {
234 padding-bottom: 5px;
235}
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]236td.hlist1 {
237 vertical-align: top;
238 font-style: italic;
239 padding-right: 0.8em;
240}
241td.hlist2 {
242 vertical-align: top;
243}
244
245@media print {
246 div#footer-badges { display: none; }
247}
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]248
249div#toctitle {
250 color: #527bbd;
251 font-family: sans-serif;
252 font-size: 1.1em;
253 font-weight: bold;
254 margin-top: 1.0em;
255 margin-bottom: 0.1em;
256}
257
258div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
259 margin-top: 0;
260 margin-bottom: 0;
261}
262div.toclevel2 {
263 margin-left: 2em;
264 font-size: 0.9em;
265}
266div.toclevel3 {
267 margin-left: 4em;
268 font-size: 0.9em;
269}
270div.toclevel4 {
271 margin-left: 6em;
272 font-size: 0.9em;
273}
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]274/* Workarounds for IE6's broken and incomplete CSS2. */
275
276div.sidebar-content {
277 background: #ffffee;
278 border: 1px solid silver;
279 padding: 0.5em;
280}
281div.sidebar-title, div.image-title {
282 font-family: sans-serif;
283 font-weight: bold;
284 margin-top: 0.0em;
285 margin-bottom: 0.5em;
286}
287
288div.listingblock div.content {
289 border: 1px solid silver;
290 background: #f4f4f4;
291 padding: 0.5em;
292}
293
294div.quoteblock-content {
295 padding-left: 2.0em;
296}
297
298div.exampleblock-content {
299 border-left: 2px solid silver;
300 padding-left: 0.5em;
301}
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]302
303/* IE6 sets dynamically generated links as visited. */
304div#toc a:visited { color: blue; }
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]305</style>
306<title>strbuf API</title>
307</head>
308<body>
309<div id="header">
310<h1>strbuf API</h1>
311</div>
312<div id="preamble">
313<div class="sectionbody">
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]314<div class="para"><p>strbuf's are meant to be used with all the usual C string and memory
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]315APIs. Given that the length of the buffer is known, it's often better to
316use the mem* functions than a str* one (memchr vs. strchr e.g.).
317Though, one has to be careful about the fact that str* functions often
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]318stop on NULs and that strbufs may have embedded NULs.</p></div>
319<div class="para"><p>An strbuf is NUL terminated for convenience, but no function in the
320strbuf API actually relies on the string being free of NULs.</p></div>
321<div class="para"><p>strbufs has some invariants that are very important to keep in mind:</p></div>
322<div class="olist"><ol>
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]323<li>
324<p>
325The <tt>buf</tt> member is never NULL, so you it can be used in any usual C
326string operations safely. strbuf's _have_ to be initialized either by
327<tt>strbuf_init()</tt> or by <tt>= STRBUF_INIT</tt> before the invariants, though.
328</p>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]329<div class="para"><p>Do <strong>not</strong> assume anything on what <tt>buf</tt> really is (e.g. if it is
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]330allocated memory or not), use <tt>strbuf_detach()</tt> to unwrap a memory
331buffer from its strbuf shell in a safe way. That is the sole supported
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]332way. This will give you a malloced buffer that you can later <tt>free()</tt>.</p></div>
333<div class="para"><p>However, it it totally safe to modify anything in the string pointed by
334the <tt>buf</tt> member, between the indices <tt>0</tt> and <tt>len-1</tt> (inclusive).</p></div>
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]335</li>
336<li>
337<p>
338The <tt>buf</tt> member is a byte array that has at least <tt>len + 1</tt> bytes
339 allocated. The extra byte is used to store a <tt><em>\0</em></tt>, allowing the
340 <tt>buf</tt> member to be a valid C-string. Every strbuf function ensure this
341 invariant is preserved.
342</p>
343<div class="admonitionblock">
344<table><tr>
345<td class="icon">
346<div class="title">Note</div>
347</td>
348<td class="content">It is OK to "play" with the buffer directly if you work it this
349 way:</td>
350</tr></table>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]351</div>
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]352<div class="listingblock">
353<div class="content">
354<pre><tt>strbuf_grow(sb, SOME_SIZE); <b>(1)</b>
355strbuf_setlen(sb, sb-&gt;len + SOME_OTHER_SIZE);</tt></pre>
356</div></div>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]357<div class="colist"><ol>
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]358<li>
359<p>
360Here, the memory array starting at <tt>sb-&gt;buf</tt>, and of length
361<tt>strbuf_avail(sb)</tt> is all yours, and you can be sure that
362<tt>strbuf_avail(sb)</tt> is at least <tt>SOME_SIZE</tt>.
363</p>
364<div class="admonitionblock">
365<table><tr>
366<td class="icon">
367<div class="title">Note</div>
368</td>
369<td class="content"><tt>SOME_OTHER_SIZE</tt> must be smaller or equal to <tt>strbuf_avail(sb)</tt>.</td>
370</tr></table>
371</div>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]372<div class="para"><p>Doing so is safe, though if it has to be done in many places, adding the
373missing API to the strbuf module is the way to go.</p></div>
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]374<div class="admonitionblock">
375<table><tr>
376<td class="icon">
377<div class="title">Warning</div>
378</td>
379<td class="content">Do _not_ assume that the area that is yours is of size <tt>alloc
380- 1</tt> even if it's true in the current implementation. Alloc is somehow a
381"private" member that should not be messed with. Use <tt>strbuf_avail()</tt>
382instead.</td>
383</tr></table>
384</div>
385</li>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]386</ol></div>
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]387</li>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]388</ol></div>
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]389</div>
390</div>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]391<h2 id="_data_structures">Data structures</h2>
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]392<div class="sectionbody">
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]393<div class="ilist"><ul>
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]394<li>
395<p>
396<tt>struct strbuf</tt>
397</p>
398</li>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]399</ul></div>
400<div class="para"><p>This is string buffer structure. The <tt>len</tt> member can be used to
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]401determine the current length of the string, and <tt>buf</tt> member provides access to
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]402the string itself.</p></div>
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]403</div>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]404<h2 id="_functions">Functions</h2>
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]405<div class="sectionbody">
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]406<div class="ilist"><ul>
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]407<li>
408<p>
409Life cycle
410</p>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]411<div class="vlist"><dl>
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]412<dt>
413<tt>strbuf_init</tt>
414</dt>
415<dd>
416<p>
417 Initialize the structure. The second parameter can be zero or a bigger
418 number to allocate memory, in case you want to prevent further reallocs.
419</p>
420</dd>
421<dt>
422<tt>strbuf_release</tt>
423</dt>
424<dd>
425<p>
426 Release a string buffer and the memory it used. You should not use the
427 string buffer after using this function, unless you initialize it again.
428</p>
429</dd>
430<dt>
431<tt>strbuf_detach</tt>
432</dt>
433<dd>
434<p>
435 Detach the string from the strbuf and returns it; you now own the
436 storage the string occupies and it is your responsibility from then on
437 to release it with <tt>free(3)</tt> when you are done with it.
438</p>
439</dd>
440<dt>
441<tt>strbuf_attach</tt>
442</dt>
443<dd>
444<p>
445 Attach a string to a buffer. You should specify the string to attach,
446 the current length of the string and the amount of allocated memory.
447 The amount must be larger than the string length, because the string you
448 pass is supposed to be a NUL-terminated string. This string _must_ be
449 malloc()ed, and after attaching, the pointer cannot be relied upon
450 anymore, and neither be free()d directly.
451</p>
452</dd>
453<dt>
454<tt>strbuf_swap</tt>
455</dt>
456<dd>
457<p>
458 Swap the contents of two string buffers.
459</p>
460</dd>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]461</dl></div>
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]462</li>
463<li>
464<p>
465Related to the size of the buffer
466</p>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]467<div class="vlist"><dl>
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]468<dt>
469<tt>strbuf_avail</tt>
470</dt>
471<dd>
472<p>
473 Determine the amount of allocated but unused memory.
474</p>
475</dd>
476<dt>
477<tt>strbuf_grow</tt>
478</dt>
479<dd>
480<p>
481 Ensure that at least this amount of unused memory is available after
482 <tt>len</tt>. This is used when you know a typical size for what you will add
483 and want to avoid repetitive automatic resizing of the underlying buffer.
484 This is never a needed operation, but can be critical for performance in
485 some cases.
486</p>
487</dd>
488<dt>
489<tt>strbuf_setlen</tt>
490</dt>
491<dd>
492<p>
493 Set the length of the buffer to a given value. This function does <strong>not</strong>
494 allocate new memory, so you should not perform a <tt>strbuf_setlen()</tt> to a
495 length that is larger than <tt>len + strbuf_avail()</tt>. <tt>strbuf_setlen()</tt> is
496 just meant as a <em>please fix invariants from this strbuf I just messed
497 with</em>.
498</p>
499</dd>
500<dt>
501<tt>strbuf_reset</tt>
502</dt>
503<dd>
504<p>
505 Empty the buffer by setting the size of it to zero.
506</p>
507</dd>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]508</dl></div>
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]509</li>
510<li>
511<p>
512Related to the contents of the buffer
513</p>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]514<div class="vlist"><dl>
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]515<dt>
516<tt>strbuf_rtrim</tt>
517</dt>
518<dd>
519<p>
520 Strip whitespace from the end of a string.
521</p>
522</dd>
523<dt>
524<tt>strbuf_cmp</tt>
525</dt>
526<dd>
527<p>
528 Compare two buffers. Returns an integer less than, equal to, or greater
529 than zero if the first buffer is found, respectively, to be less than,
530 to match, or be greater than the second buffer.
531</p>
532</dd>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]533</dl></div>
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]534</li>
535<li>
536<p>
537Adding data to the buffer
538</p>
539</li>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]540</ul></div>
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]541<div class="admonitionblock">
542<table><tr>
543<td class="icon">
544<div class="title">Note</div>
545</td>
546<td class="content">All of these functions in this section will grow the buffer as
547 necessary.</td>
548</tr></table>
549</div>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]550<div class="vlist"><dl>
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]551<dt>
552<tt>strbuf_addch</tt>
553</dt>
554<dd>
555<p>
556 Add a single character to the buffer.
557</p>
558</dd>
559<dt>
560<tt>strbuf_insert</tt>
561</dt>
562<dd>
563<p>
564 Insert data to the given position of the buffer. The remaining contents
565 will be shifted, not overwritten.
566</p>
567</dd>
568<dt>
569<tt>strbuf_remove</tt>
570</dt>
571<dd>
572<p>
573 Remove given amount of data from a given position of the buffer.
574</p>
575</dd>
576<dt>
577<tt>strbuf_splice</tt>
578</dt>
579<dd>
580<p>
581 Remove the bytes between <tt>pos..pos+len</tt> and replace it with the given
582 data.
583</p>
584</dd>
585<dt>
586<tt>strbuf_add</tt>
587</dt>
588<dd>
589<p>
590 Add data of given length to the buffer.
591</p>
592</dd>
593<dt>
594<tt>strbuf_addstr</tt>
595</dt>
596<dd>
597<p>
598Add a NUL-terminated string to the buffer.
599</p>
600<div class="admonitionblock">
601<table><tr>
602<td class="icon">
603<div class="title">Note</div>
604</td>
605<td class="content">This function will <strong>always</strong> be implemented as an inline or a macro
606that expands to:</td>
607</tr></table>
608</div>
609<div class="listingblock">
610<div class="content">
611<pre><tt>strbuf_add(..., s, strlen(s));</tt></pre>
612</div></div>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]613<div class="para"><p>Meaning that this is efficient to write things like:</p></div>
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]614<div class="listingblock">
615<div class="content">
616<pre><tt>strbuf_addstr(sb, "immediate string");</tt></pre>
617</div></div>
618</dd>
619<dt>
620<tt>strbuf_addbuf</tt>
621</dt>
622<dd>
623<p>
624 Copy the contents of an other buffer at the end of the current one.
625</p>
626</dd>
627<dt>
628<tt>strbuf_adddup</tt>
629</dt>
630<dd>
631<p>
632 Copy part of the buffer from a given position till a given length to the
633 end of the buffer.
634</p>
635</dd>
636<dt>
637<tt>strbuf_expand</tt>
638</dt>
639<dd>
640<p>
641 This function can be used to expand a format string containing
642 placeholders. To that end, it parses the string and calls the specified
643 function for every percent sign found.
644</p>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]645<div class="para"><p>The callback function is given a pointer to the character after the <tt>%</tt>
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]646and a pointer to the struct strbuf. It is expected to add the expanded
647version of the placeholder to the strbuf, e.g. to add a newline
648character if the letter <tt>n</tt> appears after a <tt>%</tt>. The function returns
649the length of the placeholder recognized and <tt>strbuf_expand()</tt> skips
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]650over it.</p></div>
651<div class="para"><p>All other characters (non-percent and not skipped ones) are copied
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]652verbatim to the strbuf. If the callback returned zero, meaning that the
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]653placeholder is unknown, then the percent sign is copied, too.</p></div>
654<div class="para"><p>In order to facilitate caching and to make it possible to give
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]655parameters to the callback, <tt>strbuf_expand()</tt> passes a context pointer,
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]656which can be used by the programmer of the callback as she sees fit.</p></div>
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]657</dd>
658<dt>
659<tt>strbuf_addf</tt>
660</dt>
661<dd>
662<p>
663 Add a formatted string to the buffer.
664</p>
665</dd>
666<dt>
667<tt>strbuf_fread</tt>
668</dt>
669<dd>
670<p>
671 Read a given size of data from a FILE* pointer to the buffer.
672</p>
673<div class="admonitionblock">
674<table><tr>
675<td class="icon">
676<div class="title">Note</div>
677</td>
678<td class="content">The buffer is rewinded if the read fails. If -1 is returned,
679<tt>errno</tt> must be consulted, like you would do for <tt>read(3)</tt>.
680<tt>strbuf_read()</tt>, <tt>strbuf_read_file()</tt> and <tt>strbuf_getline()</tt> has the
681same behaviour as well.</td>
682</tr></table>
683</div>
684</dd>
685<dt>
686<tt>strbuf_read</tt>
687</dt>
688<dd>
689<p>
690 Read the contents of a given file descriptor. The third argument can be
691 used to give a hint about the file size, to avoid reallocs.
692</p>
693</dd>
694<dt>
695<tt>strbuf_read_file</tt>
696</dt>
697<dd>
698<p>
699 Read the contents of a file, specified by its path. The third argument
700 can be used to give a hint about the file size, to avoid reallocs.
701</p>
702</dd>
703<dt>
704<tt>strbuf_getline</tt>
705</dt>
706<dd>
707<p>
708 Read a line from a FILE* pointer. The second argument specifies the line
709 terminator character, typically <tt><em>\n</em></tt>.
710</p>
711</dd>
712<dt>
713<tt>stripspace</tt>
714</dt>
715<dd>
716<p>
717 Strip whitespace from a buffer. The second parameter controls if
718 comments are considered contents to be removed or not.
719</p>
720</dd>
721<dt>
722<tt>launch_editor</tt>
723</dt>
724<dd>
Junio C Hamano14ccc602008-06-04 23:09:21[diff] [blame]725</dd>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]726</dl></div>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]727</div>
728<div id="footer">
729<div id="footer-text">
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame^]730Last updated 2008-09-19 06:33:33 UTC
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]731</div>
732</div>
733</body>
734</html>