common/membuf.h

   1 /* membuf.h - A simple implementation of a dynamic buffer
   2  *      Copyright (C) 2001, 2003 Free Software Foundation, Inc.
   3  *
   4  * This file is part of GnuPG.
   5  *
   6  * GnuPG is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * GnuPG is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef GNUPG_COMMON_MEMBUF_H
  21 #define GNUPG_COMMON_MEMBUF_H
  22
  23 /* The definition of the structure is private, we only need it here,
  24    so it can be allocated on the stack. */
  25 struct private_membuf_s
  26 {
  27   size_t len;
  28   size_t size;
  29   char *buf;
  30   int out_of_core;
  31 };
  32
  33 typedef struct private_membuf_s membuf_t;
  34
  35 /* Return the current length of the membuf.  */
  36 #define get_membuf_len(a)  ((a)->len)
  37 #define is_membuf_ready(a) ((a)->buf || (a)->out_of_core)
  38 #define MEMBUF_ZERO        { 0, 0, NULL, 0}
  39
  40 void init_membuf (membuf_t *mb, int initiallen);
  41 void init_membuf_secure (membuf_t *mb, int initiallen);
  42 void put_membuf  (membuf_t *mb, const void *buf, size_t len);
  43 void put_membuf_str (membuf_t *mb, const char *string);
  44 void *get_membuf (membuf_t *mb, size_t *len);
  45
  46
  47 #endif /*GNUPG_COMMON_MEMBUF_H*/