buffer.c 11.9 KB
Newer Older
Vicent Marti committed
1
/*
Edward Thomson committed
2
 * Copyright (C) the libgit2 contributors. All rights reserved.
Vicent Marti committed
3 4 5 6
 *
 * This file is part of libgit2, distributed under the GNU GPL v2 with
 * a Linking Exception. For full terms see the included COPYING file.
 */
7 8
#include "buffer.h"
#include "posix.h"
9
#include "git2/buffer.h"
10
#include <ctype.h>
11

12 13 14
/* Used as default value for git_buf->ptr so that people can always
 * assume ptr is non-NULL and zero terminated even for new git_bufs.
 */
15
char git_buf__initbuf[1];
16

17
char git_buf__oom[1];
18

19
#define ENSURE_SIZE(b, d) \
20 21
	if ((d) > buf->asize && git_buf_grow(b, (d)) < 0)\
		return -1;
22

23

24 25 26 27
void git_buf_init(git_buf *buf, size_t initial_size)
{
	buf->asize = 0;
	buf->size = 0;
28
	buf->ptr = git_buf__initbuf;
29 30 31 32 33

	if (initial_size)
		git_buf_grow(buf, initial_size);
}

34 35
int git_buf_try_grow(
	git_buf *buf, size_t target_size, bool mark_oom, bool preserve_external)
36
{
37
	char *new_ptr;
38
	size_t new_size;
39

40
	if (buf->ptr == git_buf__oom)
41
		return -1;
42

43 44 45
	if (!target_size)
		target_size = buf->size;

46
	if (target_size <= buf->asize)
47
		return 0;
48

49 50 51 52
	if (buf->asize == 0) {
		new_size = target_size;
		new_ptr = NULL;
	} else {
53
		new_size = buf->asize;
54 55
		new_ptr = buf->ptr;
	}
56 57 58

	/* grow the buffer size by 1.5, until it's big enough
	 * to fit our target size */
59 60
	while (new_size < target_size)
		new_size = (new_size << 1) - (new_size >> 1);
61

62
	/* round allocation up to multiple of 8 */
63
	new_size = (new_size + 7) & ~7;
64

65
	new_ptr = git__realloc(new_ptr, new_size);
66 67

	if (!new_ptr) {
68 69
		if (mark_oom) {
			if (buf->ptr) git__free(buf->ptr);
70
			buf->ptr = git_buf__oom;
71
		}
72
		return -1;
73
	}
74

75 76 77
	if (preserve_external && !buf->asize && buf->ptr != NULL && buf->size > 0)
		memcpy(new_ptr, buf->ptr, min(buf->size, new_size));

78 79 80 81 82 83 84 85
	buf->asize = new_size;
	buf->ptr   = new_ptr;

	/* truncate the existing buffer size if necessary */
	if (buf->size >= buf->asize)
		buf->size = buf->asize - 1;
	buf->ptr[buf->size] = '\0';

86
	return 0;
87 88
}

89 90 91 92 93
int git_buf_grow(git_buf *buffer, size_t target_size)
{
	return git_buf_try_grow(buffer, target_size, true, true);
}

94 95 96 97
void git_buf_free(git_buf *buf)
{
	if (!buf) return;

98
	if (buf->asize > 0 && buf->ptr != NULL && buf->ptr != git_buf__oom)
99 100 101 102 103
		git__free(buf->ptr);

	git_buf_init(buf, 0);
}

104 105 106 107 108 109 110 111
void git_buf_sanitize(git_buf *buf)
{
	if (buf->ptr == NULL) {
		assert (buf->size == 0 && buf->asize == 0);
		buf->ptr = git_buf__initbuf;
	}
}

112 113 114
void git_buf_clear(git_buf *buf)
{
	buf->size = 0;
115 116 117 118

	if (!buf->ptr)
		buf->ptr = git_buf__initbuf;

119 120 121 122
	if (buf->asize > 0)
		buf->ptr[0] = '\0';
}

123
int git_buf_set(git_buf *buf, const void *data, size_t len)
124 125 126 127
{
	if (len == 0 || data == NULL) {
		git_buf_clear(buf);
	} else {
128 129 130 131
		if (data != buf->ptr) {
			ENSURE_SIZE(buf, len + 1);
			memmove(buf->ptr, data, len);
		}
132
		buf->size = len;
133
		buf->ptr[buf->size] = '\0';
134
	}
135
	return 0;
136 137
}

138
int git_buf_sets(git_buf *buf, const char *string)
139
{
140
	return git_buf_set(buf, string, string ? strlen(string) : 0);
141 142
}

143
int git_buf_putc(git_buf *buf, char c)
144
{
145
	ENSURE_SIZE(buf, buf->size + 2);
146
	buf->ptr[buf->size++] = c;
147
	buf->ptr[buf->size] = '\0';
148
	return 0;
149 150
}

151
int git_buf_put(git_buf *buf, const char *data, size_t len)
152
{
153
	ENSURE_SIZE(buf, buf->size + len + 1);
154
	memmove(buf->ptr + buf->size, data, len);
155
	buf->size += len;
156
	buf->ptr[buf->size] = '\0';
157
	return 0;
158 159
}

160
int git_buf_puts(git_buf *buf, const char *string)
161
{
162
	assert(string);
163
	return git_buf_put(buf, string, strlen(string));
164 165
}

Linquize committed
166
static const char b64str[] =
167 168 169 170 171 172 173 174
	"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";

int git_buf_put_base64(git_buf *buf, const char *data, size_t len)
{
	size_t extra = len % 3;
	uint8_t *write, a, b, c;
	const uint8_t *read = (const uint8_t *)data;

175
	ENSURE_SIZE(buf, buf->size + 4 * ((len / 3) + !!extra) + 1);
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
	write = (uint8_t *)&buf->ptr[buf->size];

	/* convert each run of 3 bytes into 4 output bytes */
	for (len -= extra; len > 0; len -= 3) {
		a = *read++;
		b = *read++;
		c = *read++;

		*write++ = b64str[a >> 2];
		*write++ = b64str[(a & 0x03) << 4 | b >> 4];
		*write++ = b64str[(b & 0x0f) << 2 | c >> 6];
		*write++ = b64str[c & 0x3f];
	}

	if (extra > 0) {
		a = *read++;
		b = (extra > 1) ? *read++ : 0;

		*write++ = b64str[a >> 2];
		*write++ = b64str[(a & 0x03) << 4 | b >> 4];
		*write++ = (extra > 1) ? b64str[(b & 0x0f) << 2] : '=';
		*write++ = '=';
	}

	buf->size = ((char *)write) - buf->ptr;
	buf->ptr[buf->size] = '\0';

	return 0;
}

206
int git_buf_vprintf(git_buf *buf, const char *format, va_list ap)
207 208
{
	int len;
209
	const size_t expected_size = buf->size + (strlen(format) * 2);
210

211
	ENSURE_SIZE(buf, expected_size);
212 213

	while (1) {
214 215 216 217 218 219 220 221
		va_list args;
		va_copy(args, ap);

		len = p_vsnprintf(
			buf->ptr + buf->size,
			buf->asize - buf->size,
			format, args
		);
222

223 224
		va_end(args);

225
		if (len < 0) {
226
			git__free(buf->ptr);
227
			buf->ptr = git_buf__oom;
228
			return -1;
229 230
		}

231
		if ((size_t)len + 1 <= buf->asize - buf->size) {
232
			buf->size += len;
233
			break;
234 235 236 237
		}

		ENSURE_SIZE(buf, buf->size + len + 1);
	}
238

239
	return 0;
240 241
}

242 243 244 245 246 247 248 249 250 251 252 253
int git_buf_printf(git_buf *buf, const char *format, ...)
{
	int r;
	va_list ap;

	va_start(ap, format);
	r = git_buf_vprintf(buf, format, ap);
	va_end(ap);

	return r;
}

254
void git_buf_copy_cstr(char *data, size_t datasize, const git_buf *buf)
255 256 257
{
	size_t copylen;

258
	assert(data && datasize && buf);
259 260 261 262 263 264 265 266 267 268 269

	data[0] = '\0';

	if (buf->size == 0 || buf->asize <= 0)
		return;

	copylen = buf->size;
	if (copylen > datasize - 1)
		copylen = datasize - 1;
	memmove(data, buf->ptr, copylen);
	data[copylen] = '\0';
270 271
}

272 273
void git_buf_consume(git_buf *buf, const char *end)
{
274 275 276 277
	if (end > buf->ptr && end <= buf->ptr + buf->size) {
		size_t consumed = end - buf->ptr;
		memmove(buf->ptr, end, buf->size - consumed);
		buf->size -= consumed;
278
		buf->ptr[buf->size] = '\0';
279 280 281
	}
}

282
void git_buf_truncate(git_buf *buf, size_t len)
283
{
284
	if (len < buf->size) {
285 286 287 288 289
		buf->size = len;
		buf->ptr[buf->size] = '\0';
	}
}

290 291 292 293 294 295 296 297 298
void git_buf_shorten(git_buf *buf, size_t amount)
{
	if (amount > buf->size)
		amount = buf->size;

	buf->size = buf->size - amount;
	buf->ptr[buf->size] = '\0';
}

299 300
void git_buf_rtruncate_at_char(git_buf *buf, char separator)
{
301 302
	ssize_t idx = git_buf_rfind_next(buf, separator);
	git_buf_truncate(buf, idx < 0 ? 0 : (size_t)idx);
303 304
}

305 306 307 308 309
void git_buf_swap(git_buf *buf_a, git_buf *buf_b)
{
	git_buf t = *buf_a;
	*buf_a = *buf_b;
	*buf_b = t;
310
}
311

312
char *git_buf_detach(git_buf *buf)
313
{
314
	char *data = buf->ptr;
315

316
	if (buf->asize == 0 || buf->ptr == git_buf__oom)
317 318
		return NULL;

319
	git_buf_init(buf, 0);
320 321 322 323

	return data;
}

324
void git_buf_attach(git_buf *buf, char *ptr, size_t asize)
325
{
326 327 328 329 330 331 332 333 334 335 336 337 338
	git_buf_free(buf);

	if (ptr) {
		buf->ptr = ptr;
		buf->size = strlen(ptr);
		if (asize)
			buf->asize = (asize < buf->size) ? buf->size + 1 : asize;
		else /* pass 0 to fall back on strlen + 1 */
			buf->asize = buf->size + 1;
	} else {
		git_buf_grow(buf, asize);
	}
}
339

340 341
int git_buf_join_n(git_buf *buf, char separator, int nbuf, ...)
{
342
	va_list ap;
343
	int i;
344 345
	size_t total_size = 0, original_size = buf->size;
	char *out, *original = buf->ptr;
346 347 348 349

	if (buf->size > 0 && buf->ptr[buf->size - 1] != separator)
		++total_size; /* space for initial separator */

350 351
	/* Make two passes to avoid multiple reallocation */

352 353 354
	va_start(ap, nbuf);
	for (i = 0; i < nbuf; ++i) {
		const char* segment;
355
		size_t segment_len;
356 357 358 359 360 361 362 363 364 365 366 367

		segment = va_arg(ap, const char *);
		if (!segment)
			continue;

		segment_len = strlen(segment);
		total_size += segment_len;
		if (segment_len == 0 || segment[segment_len - 1] != separator)
			++total_size; /* space for separator */
	}
	va_end(ap);

368
	/* expand buffer if needed */
369 370 371
	if (total_size == 0)
		return 0;
	if (git_buf_grow(buf, buf->size + total_size + 1) < 0)
372
		return -1;
373 374 375 376 377 378 379 380 381 382

	out = buf->ptr + buf->size;

	/* append separator to existing buf if needed */
	if (buf->size > 0 && out[-1] != separator)
		*out++ = separator;

	va_start(ap, nbuf);
	for (i = 0; i < nbuf; ++i) {
		const char* segment;
383
		size_t segment_len;
384 385 386 387 388

		segment = va_arg(ap, const char *);
		if (!segment)
			continue;

389 390 391 392 393 394 395 396 397
		/* deal with join that references buffer's original content */
		if (segment >= original && segment < original + original_size) {
			size_t offset = (segment - original);
			segment = buf->ptr + offset;
			segment_len = original_size - offset;
		} else {
			segment_len = strlen(segment);
		}

398 399
		/* skip leading separators */
		if (out > buf->ptr && out[-1] == separator)
400 401 402 403
			while (segment_len > 0 && *segment == separator) {
				segment++;
				segment_len--;
			}
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418

		/* copy over next buffer */
		if (segment_len > 0) {
			memmove(out, segment, segment_len);
			out += segment_len;
		}

		/* append trailing separator (except for last item) */
		if (i < nbuf - 1 && out > buf->ptr && out[-1] != separator)
			*out++ = separator;
	}
	va_end(ap);

	/* set size based on num characters actually written */
	buf->size = out - buf->ptr;
419
	buf->ptr[buf->size] = '\0';
420

421
	return 0;
422 423
}

424
int git_buf_join(
425 426 427 428 429
	git_buf *buf,
	char separator,
	const char *str_a,
	const char *str_b)
{
430
	size_t strlen_a = str_a ? strlen(str_a) : 0;
431 432
	size_t strlen_b = strlen(str_b);
	int need_sep = 0;
433 434 435
	ssize_t offset_a = -1;

	/* not safe to have str_b point internally to the buffer */
436
	assert(str_b < buf->ptr || str_b >= buf->ptr + buf->size);
437 438 439 440 441 442

	/* figure out if we need to insert a separator */
	if (separator && strlen_a) {
		while (*str_b == separator) { str_b++; strlen_b--; }
		if (str_a[strlen_a - 1] != separator)
			need_sep = 1;
443 444
	}

445 446 447 448
	/* str_a could be part of the buffer */
	if (str_a >= buf->ptr && str_a < buf->ptr + buf->size)
		offset_a = str_a - buf->ptr;

449 450
	if (git_buf_grow(buf, strlen_a + strlen_b + need_sep + 1) < 0)
		return -1;
451
	assert(buf->ptr);
452

453 454 455 456 457
	/* fix up internal pointers */
	if (offset_a >= 0)
		str_a = buf->ptr + offset_a;

	/* do the actual copying */
458
	if (offset_a != 0 && str_a)
459
		memmove(buf->ptr, str_a, strlen_a);
460 461
	if (need_sep)
		buf->ptr[strlen_a] = separator;
462
	memcpy(buf->ptr + strlen_a + need_sep, str_b, strlen_b);
463

464
	buf->size = strlen_a + strlen_b + need_sep;
465
	buf->ptr[buf->size] = '\0';
466

467
	return 0;
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
int git_buf_join3(
	git_buf *buf,
	char separator,
	const char *str_a,
	const char *str_b,
	const char *str_c)
{
	size_t len_a = strlen(str_a), len_b = strlen(str_b), len_c = strlen(str_c);
	int sep_a = 0, sep_b = 0;
	char *tgt;

	/* for this function, disallow pointers into the existing buffer */
	assert(str_a < buf->ptr || str_a >= buf->ptr + buf->size);
	assert(str_b < buf->ptr || str_b >= buf->ptr + buf->size);
	assert(str_c < buf->ptr || str_c >= buf->ptr + buf->size);

	if (separator) {
		if (len_a > 0) {
			while (*str_b == separator) { str_b++; len_b--; }
			sep_a = (str_a[len_a - 1] != separator);
		}
		if (len_a > 0 || len_b > 0)
			while (*str_c == separator) { str_c++; len_c--; }
		if (len_b > 0)
			sep_b = (str_b[len_b - 1] != separator);
	}

	if (git_buf_grow(buf, len_a + sep_a + len_b + sep_b + len_c + 1) < 0)
		return -1;

	tgt = buf->ptr;

	if (len_a) {
		memcpy(tgt, str_a, len_a);
		tgt += len_a;
	}
	if (sep_a)
		*tgt++ = separator;
	if (len_b) {
		memcpy(tgt, str_b, len_b);
		tgt += len_b;
	}
	if (sep_b)
		*tgt++ = separator;
	if (len_c)
		memcpy(tgt, str_c, len_c);

	buf->size = len_a + sep_a + len_b + sep_b + len_c;
	buf->ptr[buf->size] = '\0';

	return 0;
}

523 524 525
void git_buf_rtrim(git_buf *buf)
{
	while (buf->size > 0) {
526
		if (!git__isspace(buf->ptr[buf->size - 1]))
527 528 529 530
			break;

		buf->size--;
	}
531 532

	buf->ptr[buf->size] = '\0';
533
}
534 535 536 537 538 539 540

int git_buf_cmp(const git_buf *a, const git_buf *b)
{
	int result = memcmp(a->ptr, b->ptr, min(a->size, b->size));
	return (result != 0) ? result :
		(a->size < b->size) ? -1 : (a->size > b->size) ? 1 : 0;
}
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
int git_buf_splice(
	git_buf *buf,
	size_t where,
	size_t nb_to_remove,
	const char *data,
	size_t nb_to_insert)
{
	assert(buf &&
		where <= git_buf_len(buf) &&
		where + nb_to_remove <= git_buf_len(buf));

	/* Ported from git.git
	 * https://github.com/git/git/blob/16eed7c/strbuf.c#L159-176
	 */
	if (git_buf_grow(buf, git_buf_len(buf) + nb_to_insert - nb_to_remove) < 0)
		return -1;

	memmove(buf->ptr + where + nb_to_insert,
			buf->ptr + where + nb_to_remove,
			buf->size - where - nb_to_remove);

	memcpy(buf->ptr + where, data, nb_to_insert);

	buf->size = buf->size + nb_to_insert - nb_to_remove;
	buf->ptr[buf->size] = '\0';
	return 0;
}