src/buffer.h

   1 /*
   2  * Copyright (C) 2009-2011 the libgit2 contributors
   3  *
   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.
   6  */
   7 #ifndef INCLUDE_buffer_h__
   8 #define INCLUDE_buffer_h__
   9
  10 #include "common.h"
  11
  12 typedef struct {
  13         char *ptr;
  14         ssize_t asize, size;
  15 } git_buf;
  16
  17 extern char git_buf_initbuf[];
  18
  19 #define GIT_BUF_INIT { git_buf_initbuf, 0, 0 }
  20
  21 void git_buf_init(git_buf *buf, size_t initial_size);
  22 int git_buf_grow(git_buf *buf, size_t target_size);
  23 void git_buf_free(git_buf *buf);
  24 void git_buf_swap(git_buf *buf_a, git_buf *buf_b);
  25
  26 /**
  27  * Any function that writes to a git_buf can fail due to memory allocation
  28  * issues.  If one fails, the git_buf will be marked with an OOM error and
  29  * further calls to modify the buffer will fail.  You just check
  30  * git_buf_oom() at the end of your sequence and it will be true if you ran
  31  * out of memory at any point with that buffer.
  32  */
  33 int git_buf_oom(const git_buf *buf);
  34
  35 void git_buf_set(git_buf *buf, const char *data, size_t len);
  36 void git_buf_sets(git_buf *buf, const char *string);
  37 void git_buf_putc(git_buf *buf, char c);
  38 void git_buf_put(git_buf *buf, const char *data, size_t len);
  39 void git_buf_puts(git_buf *buf, const char *string);
  40 void git_buf_printf(git_buf *buf, const char *format, ...) GIT_FORMAT_PRINTF(2, 3);
  41 void git_buf_clear(git_buf *buf);
  42 void git_buf_consume(git_buf *buf, const char *end);
  43 void git_buf_join_n(git_buf *buf, char separator, int nbuf, ...);
  44 void git_buf_join(git_buf *buf, char separator, const char *str_a, const char *str_b);
  45
  46 const char *git_buf_cstr(git_buf *buf);
  47 char *git_buf_take_cstr(git_buf *buf);
  48 void git_buf_copy_cstr(char *data, size_t datasize, git_buf *buf);
  49
  50 #define git_buf_PUTS(buf, str) git_buf_put(buf, str, sizeof(str) - 1)
  51
  52 #endif