]>
git.proxmox.com Git - libgit2.git/blob - src/buffer.h
2 * Copyright (C) the libgit2 contributors. All rights reserved.
4 * This file is part of libgit2, distributed under the GNU GPL v2 with
5 * a Linking Exception. For full terms see the included COPYING file.
7 #ifndef INCLUDE_buffer_h__
8 #define INCLUDE_buffer_h__
11 #include "git2/strarray.h"
12 #include "git2/buffer.h"
23 GIT_BUF_BOM_UTF16_LE
= 2,
24 GIT_BUF_BOM_UTF16_BE
= 3,
25 GIT_BUF_BOM_UTF32_LE
= 4,
26 GIT_BUF_BOM_UTF32_BE
= 5
30 git_buf_bom_t bom
; /* BOM found at head of text */
31 unsigned int nul
, cr
, lf
, crlf
; /* NUL, CR, LF and CRLF counts */
32 unsigned int printable
, nonprintable
; /* These are just approximations! */
35 extern char git_buf__initbuf
[];
36 extern char git_buf__oom
[];
38 /* Use to initialize buffer structure when git_buf is on stack */
39 #define GIT_BUF_INIT { git_buf__initbuf, 0, 0 }
42 * Static initializer for git_buf from static buffer
44 #ifdef GIT_DEPRECATE_HARD
45 # define GIT_BUF_INIT_CONST(STR,LEN) { (char *)(STR), 0, (size_t)(LEN) }
48 GIT_INLINE(bool) git_buf_is_allocated(const git_buf
*buf
)
50 return (buf
->ptr
!= NULL
&& buf
->asize
> 0);
54 * Initialize a git_buf structure.
56 * For the cases where GIT_BUF_INIT cannot be used to do static
59 extern int git_buf_init(git_buf
*buf
, size_t initial_size
);
61 #ifdef GIT_DEPRECATE_HARD
64 * Resize the buffer allocation to make more space.
66 * This will attempt to grow the buffer to accommodate the target size.
68 * If the buffer refers to memory that was not allocated by libgit2 (i.e.
69 * the `asize` field is zero), then `ptr` will be replaced with a newly
70 * allocated block of data. Be careful so that memory allocated by the
71 * caller is not lost. As a special variant, if you pass `target_size` as
72 * 0 and the memory is not allocated by libgit2, this will allocate a new
73 * buffer of size `size` and copy the external data into it.
75 * Currently, this will never shrink a buffer, only expand it.
77 * If the allocation fails, this will return an error and the buffer will be
78 * marked as invalid for future operations, invaliding the contents.
80 * @param buffer The buffer to be resized; may or may not be allocated yet
81 * @param target_size The desired available size
82 * @return 0 on success, -1 on allocation failure
84 int git_buf_grow(git_buf
*buffer
, size_t target_size
);
89 * Resize the buffer allocation to make more space.
91 * This will attempt to grow the buffer to accommodate the additional size.
92 * It is similar to `git_buf_grow`, but performs the new size calculation,
93 * checking for overflow.
95 * Like `git_buf_grow`, if this is a user-supplied buffer, this will allocate
98 extern int git_buf_grow_by(git_buf
*buffer
, size_t additional_size
);
101 * Attempt to grow the buffer to hold at least `target_size` bytes.
103 * If the allocation fails, this will return an error. If `mark_oom` is true,
104 * this will mark the buffer as invalid for future operations; if false,
105 * existing buffer content will be preserved, but calling code must handle
106 * that buffer was not expanded. If `preserve_external` is true, then any
107 * existing data pointed to be `ptr` even if `asize` is zero will be copied
108 * into the newly allocated buffer.
110 extern int git_buf_try_grow(
111 git_buf
*buf
, size_t target_size
, bool mark_oom
);
114 * Sanitizes git_buf structures provided from user input. Users of the
115 * library, when providing git_buf's, may wish to provide a NULL ptr for
116 * ease of handling. The buffer routines, however, expect a non-NULL ptr
117 * always. This helper method simply handles NULL input, converting to a
118 * git_buf__initbuf. If a buffer with a non-NULL ptr is passed in, this method
119 * assures that the buffer is '\0'-terminated.
121 extern int git_buf_sanitize(git_buf
*buf
);
123 extern void git_buf_swap(git_buf
*buf_a
, git_buf
*buf_b
);
124 extern char *git_buf_detach(git_buf
*buf
);
125 extern int git_buf_attach(git_buf
*buf
, char *ptr
, size_t asize
);
127 /* Populates a `git_buf` where the contents are not "owned" by the
128 * buffer, and calls to `git_buf_dispose` will not free the given buf.
130 extern void git_buf_attach_notowned(
131 git_buf
*buf
, const char *ptr
, size_t size
);
134 * Test if there have been any reallocation failures with this git_buf.
136 * Any function that writes to a git_buf can fail due to memory allocation
137 * issues. If one fails, the git_buf will be marked with an OOM error and
138 * further calls to modify the buffer will fail. Check git_buf_oom() at the
139 * end of your sequence and it will be true if you ran out of memory at any
140 * point with that buffer.
142 * @return false if no error, true if allocation error
144 GIT_INLINE(bool) git_buf_oom(const git_buf
*buf
)
146 return (buf
->ptr
== git_buf__oom
);
150 * Functions below that return int value error codes will return 0 on
151 * success or -1 on failure (which generally means an allocation failed).
152 * Using a git_buf where the allocation has failed with result in -1 from
153 * all further calls using that buffer. As a result, you can ignore the
154 * return code of these functions and call them in a series then just call
155 * git_buf_oom at the end.
158 #ifdef GIT_DEPRECATE_HARD
159 int git_buf_set(git_buf
*buffer
, const void *data
, size_t datalen
);
162 int git_buf_sets(git_buf
*buf
, const char *string
);
163 int git_buf_putc(git_buf
*buf
, char c
);
164 int git_buf_putcn(git_buf
*buf
, char c
, size_t len
);
165 int git_buf_put(git_buf
*buf
, const char *data
, size_t len
);
166 int git_buf_puts(git_buf
*buf
, const char *string
);
167 int git_buf_printf(git_buf
*buf
, const char *format
, ...) GIT_FORMAT_PRINTF(2, 3);
168 int git_buf_vprintf(git_buf
*buf
, const char *format
, va_list ap
);
169 void git_buf_clear(git_buf
*buf
);
170 void git_buf_consume_bytes(git_buf
*buf
, size_t len
);
171 void git_buf_consume(git_buf
*buf
, const char *end
);
172 void git_buf_truncate(git_buf
*buf
, size_t len
);
173 void git_buf_shorten(git_buf
*buf
, size_t amount
);
174 void git_buf_truncate_at_char(git_buf
*buf
, char separator
);
175 void git_buf_rtruncate_at_char(git_buf
*path
, char separator
);
177 /** General join with separator */
178 int git_buf_join_n(git_buf
*buf
, char separator
, int nbuf
, ...);
179 /** Fast join of two strings - first may legally point into `buf` data */
180 int git_buf_join(git_buf
*buf
, char separator
, const char *str_a
, const char *str_b
);
181 /** Fast join of three strings - cannot reference `buf` data */
182 int git_buf_join3(git_buf
*buf
, char separator
, const char *str_a
, const char *str_b
, const char *str_c
);
185 * Join two strings as paths, inserting a slash between as needed.
186 * @return 0 on success, -1 on failure
188 GIT_INLINE(int) git_buf_joinpath(git_buf
*buf
, const char *a
, const char *b
)
190 return git_buf_join(buf
, '/', a
, b
);
193 GIT_INLINE(const char *) git_buf_cstr(const git_buf
*buf
)
198 GIT_INLINE(size_t) git_buf_len(const git_buf
*buf
)
203 int git_buf_copy_cstr(char *data
, size_t datasize
, const git_buf
*buf
);
205 #define git_buf_PUTS(buf, str) git_buf_put(buf, str, sizeof(str) - 1)
207 GIT_INLINE(ssize_t
) git_buf_rfind_next(const git_buf
*buf
, char ch
)
209 ssize_t idx
= (ssize_t
)buf
->size
- 1;
210 while (idx
>= 0 && buf
->ptr
[idx
] == ch
) idx
--;
211 while (idx
>= 0 && buf
->ptr
[idx
] != ch
) idx
--;
215 GIT_INLINE(ssize_t
) git_buf_rfind(const git_buf
*buf
, char ch
)
217 ssize_t idx
= (ssize_t
)buf
->size
- 1;
218 while (idx
>= 0 && buf
->ptr
[idx
] != ch
) idx
--;
222 GIT_INLINE(ssize_t
) git_buf_find(const git_buf
*buf
, char ch
)
224 void *found
= memchr(buf
->ptr
, ch
, buf
->size
);
225 return found
? (ssize_t
)((const char *)found
- buf
->ptr
) : -1;
228 /* Remove whitespace from the end of the buffer */
229 void git_buf_rtrim(git_buf
*buf
);
231 int git_buf_cmp(const git_buf
*a
, const git_buf
*b
);
233 /* Quote and unquote a buffer as specified in
234 * http://marc.info/?l=git&m=112927316408690&w=2
236 int git_buf_quote(git_buf
*buf
);
237 int git_buf_unquote(git_buf
*buf
);
239 /* Write data as base64 encoded in buffer */
240 int git_buf_encode_base64(git_buf
*buf
, const char *data
, size_t len
);
241 /* Decode the given bas64 and write the result to the buffer */
242 int git_buf_decode_base64(git_buf
*buf
, const char *base64
, size_t len
);
244 /* Write data as "base85" encoded in buffer */
245 int git_buf_encode_base85(git_buf
*buf
, const char *data
, size_t len
);
246 /* Decode the given "base85" and write the result to the buffer */
247 int git_buf_decode_base85(git_buf
*buf
, const char *base64
, size_t len
, size_t output_len
);
249 /* Decode the given percent-encoded string and write the result to the buffer */
250 int git_buf_decode_percent(git_buf
*buf
, const char *str
, size_t len
);
253 * Insert, remove or replace a portion of the buffer.
255 * @param buf The buffer to work with
257 * @param where The location in the buffer where the transformation
260 * @param nb_to_remove The number of chars to be removed. 0 to not
261 * remove any character in the buffer.
263 * @param data A pointer to the data which should be inserted.
265 * @param nb_to_insert The number of chars to be inserted. 0 to not
266 * insert any character from the buffer.
268 * @return 0 or an error code.
275 size_t nb_to_insert
);
278 * Append string to buffer, prefixing each character from `esc_chars` with
281 * @param buf Buffer to append data to
282 * @param string String to escape and append
283 * @param esc_chars Characters to be escaped
284 * @param esc_with String to insert in from of each found character
285 * @return 0 on success, <0 on failure (probably allocation problem)
287 extern int git_buf_puts_escaped(
290 const char *esc_chars
,
291 const char *esc_with
);
294 * Append string escaping characters that are regex special
296 GIT_INLINE(int) git_buf_puts_escape_regex(git_buf
*buf
, const char *string
)
298 return git_buf_puts_escaped(buf
, string
, "^.[]$()|*+?{}\\", "\\");
302 * Unescape all characters in a buffer in place
304 * I.e. remove backslashes
306 extern void git_buf_unescape(git_buf
*buf
);
309 * Replace all \r\n with \n.
311 * @return 0 on success, -1 on memory error
313 extern int git_buf_crlf_to_lf(git_buf
*tgt
, const git_buf
*src
);
316 * Replace all \n with \r\n. Does not modify existing \r\n.
318 * @return 0 on success, -1 on memory error
320 extern int git_buf_lf_to_crlf(git_buf
*tgt
, const git_buf
*src
);
323 * Fill buffer with the common prefix of a array of strings
325 * Buffer will be set to empty if there is no common prefix
327 extern int git_buf_common_prefix(git_buf
*buf
, char *const *const strings
, size_t count
);
330 * Check if a buffer begins with a UTF BOM
332 * @param bom Set to the type of BOM detected or GIT_BOM_NONE
333 * @param buf Buffer in which to check the first bytes for a BOM
334 * @return Number of bytes of BOM data (or 0 if no BOM found)
336 extern int git_buf_detect_bom(git_buf_bom_t
*bom
, const git_buf
*buf
);
339 * Gather stats for a piece of text
341 * Fill the `stats` structure with counts of unreadable characters, carriage
342 * returns, etc, so it can be used in heuristics. This automatically skips
343 * a trailing EOF (\032 character). Also it will look for a BOM at the
344 * start of the text and can be told to skip that as well.
346 * @param stats Structure to be filled in
347 * @param buf Text to process
348 * @param skip_bom Exclude leading BOM from stats if true
349 * @return Does the buffer heuristically look like binary data
351 extern bool git_buf_gather_text_stats(
352 git_buf_text_stats
*stats
, const git_buf
*buf
, bool skip_bom
);
354 #ifdef GIT_DEPRECATE_HARD
357 * Check quickly if buffer looks like it contains binary data
359 * @param buf Buffer to check
360 * @return 1 if buffer looks like non-text data
362 int git_buf_is_binary(const git_buf
*buf
);
365 * Check quickly if buffer contains a NUL byte
367 * @param buf Buffer to check
368 * @return 1 if buffer contains a NUL byte
370 int git_buf_contains_nul(const git_buf
*buf
);