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