buffer.h 2.59 KB
Newer Older
1
2
3
4
5
6
7
/* buffer.h
 *
 * A bare-bones string stream.
 */

/* nettle, low-level cryptographics library
 *
Niels Möller's avatar
Niels Möller committed
8
 * Copyright (C) 2002 Niels Möller
9
10
11
12
13
14
15
16
17
18
19
20
21
 *  
 * The nettle library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or (at your
 * option) any later version.
 * 
 * The nettle library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with the nettle library; see the file COPYING.LIB.  If not, write to
22
23
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02111-1301, USA.
24
25
26
27
28
 */
 
#ifndef NETTLE_BUFFER_H_INCLUDED
#define NETTLE_BUFFER_H_INCLUDED

29
#include "realloc.h"
30

Niels Möller's avatar
Niels Möller committed
31
32
33
34
#ifdef __cplusplus
extern "C" {
#endif

35
36
37
38
struct nettle_buffer
{
  uint8_t *contents;
  /* Allocated size */
39
  size_t alloc;
40
41

  void *realloc_ctx;
42
  nettle_realloc_func *realloc;
43
44

  /* Current size */
45
  size_t size;
46
47
48
49
50
51
};

/* Initializes a buffer that uses plain realloc */
void
nettle_buffer_init(struct nettle_buffer *buffer);

52
53
54
void
nettle_buffer_init_realloc(struct nettle_buffer *buffer,
			   void *realloc_ctx,
55
			   nettle_realloc_func *realloc);
56

57
58
59
/* Initializes a buffer of fix size */
void
nettle_buffer_init_size(struct nettle_buffer *buffer,
60
			size_t length, uint8_t *space);
61
62
63
64

void
nettle_buffer_clear(struct nettle_buffer *buffer);

65
66
67
68
/* Resets the buffer, without freeing the buffer space. */
void
nettle_buffer_reset(struct nettle_buffer *buffer);

69
70
int
nettle_buffer_grow(struct nettle_buffer *buffer,
71
		   size_t length);
72
73

#define NETTLE_BUFFER_PUTC(buffer, c) \
74
( (((buffer)->size < (buffer)->alloc) || nettle_buffer_grow((buffer), 1)) \
75
76
77
78
  && ((buffer)->contents[(buffer)->size++] = (c), 1) )

int
nettle_buffer_write(struct nettle_buffer *buffer,
79
		    size_t length, const uint8_t *data);
80
81
82
83
84
85
86

/* Like nettle_buffer_write, but instead of copying data to the
 * buffer, it returns a pointer to the area where the caller can copy
 * the data. The pointer is valid only until the next call that can
 * reallocate the buffer. */
uint8_t *
nettle_buffer_space(struct nettle_buffer *buffer,
87
		    size_t length);
88

89
90
91
92
93
/* Copy the contents of SRC to the end of DST. */
int
nettle_buffer_copy(struct nettle_buffer *dst,
		   const struct nettle_buffer *src);

Niels Möller's avatar
Niels Möller committed
94
95
96
97
#ifdef __cplusplus
}
#endif

98
#endif /* NETTLE_BUFFER_H_INCLUDED */