Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

206 lines (149 sloc) 6.476 kB
strbuf API
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.
An strbuf is NUL terminated for convenience, but no function in the
strbuf API actually relies on the string being free of NULs.
strbufs has some invariants that are very important to keep in mind:
. The `buf` member is never NULL, so it can be used in any usual C
string operations safely. strbuf's _have_ to be initialized either by
`strbuf_init()` or by `= STRBUF_INIT` before the invariants, though.
Do *not* assume anything on what `buf` really is (e.g. if it is
allocated memory or not), use `strbuf_detach()` 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 `free()`.
However, it is totally safe to modify anything in the string pointed by
the `buf` member, between the indices `0` and `len-1` (inclusive).
. The `buf` member is a byte array that has at least `len + 1` bytes
allocated. The extra byte is used to store a `'\0'`, allowing the
`buf` member to be a valid C-string. Every strbuf function ensure this
invariant is preserved.
NOTE: It is OK to "play" with the buffer directly if you work it this
strbuf_grow(sb, SOME_SIZE); <1>
strbuf_setlen(sb, sb->len + SOME_OTHER_SIZE);
<1> Here, the memory array starting at `sb->buf`, and of length
`strbuf_avail(sb)` is all yours, and you can be sure that
`strbuf_avail(sb)` is at least `SOME_SIZE`.
NOTE: `SOME_OTHER_SIZE` must be smaller or equal to `strbuf_avail(sb)`.
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.
WARNING: Do _not_ assume that the area that is yours is of size `alloc
- 1` even if it's true in the current implementation. Alloc is somehow a
"private" member that should not be messed with. Use `strbuf_avail()`
Data structures
* `struct strbuf`
This is the string buffer structure. The `len` member can be used to
determine the current length of the string, and `buf` member provides access to
the string itself.
* Life cycle
Initialize the structure. The second parameter can be zero or a bigger
number to allocate memory, in case you want to prevent further reallocs.
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.
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 `free(3)` when you are done with it.
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.
* Related to the size of the buffer
Determine the amount of allocated but unused memory.
Ensure that at least this amount of unused memory is available after
`len`. 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.
Set the length of the buffer to a given value. This function does *not*
allocate new memory, so you should not perform a `strbuf_setlen()` to a
length that is larger than `len + strbuf_avail()`. `strbuf_setlen()` is
just meant as a 'please fix invariants from this strbuf I just messed
Empty the buffer by setting the size of it to zero.
* Related to the contents of the buffer
Strip whitespace from the end of a string.
* Adding data to the buffer
NOTE: 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 `struct strbuf` was set to `STRBUF_INIT`),
then they will free() it.
Add a single character to the buffer.
Insert data to the given position of the buffer. The remaining contents
will be shifted, not overwritten.
Remove given amount of data from a given position of the buffer.
Remove the bytes between `pos..pos+len` and replace it with the given
Add data of given length to the buffer.
Add a NUL-terminated string to the buffer.
NOTE: This function will *always* be implemented as an inline or a macro
that expands to:
strbuf_add(..., s, strlen(s));
Meaning that this is efficient to write things like:
strbuf_addstr(sb, "immediate string");
Copy the contents of an other buffer at the end of the current one.
Add a formatted string to the buffer.
Read a given size of data from a FILE* pointer to the buffer.
NOTE: The buffer is rewound if the read fails. If -1 is returned,
`errno` must be consulted, like you would do for `read(3)`.
`strbuf_read()`, `strbuf_read_file()` and `strbuf_getline()` has the
same behaviour as well.
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.
Read a line from a FILE *, overwriting the existing contents
of the strbuf. The second argument specifies the line
terminator character, typically `'\n'`.
Reading stops after the terminator or at EOF. The terminator
is removed from the buffer before returning. Returns 0 unless
there was nothing left before EOF, in which case it returns `EOF`.
Copy the contents of the strbuf to the second argument 'buf'.
The number of bytes to be copied is at most the third argument
Jump to Line
Something went wrong with that request. Please try again.