From discussion in dev mailing ( http://www.wireshark.org/lists/wireshark-dev/201105...
[obnox/wireshark/wip.git] / wiretap / buffer.h
1 /* buffer.h
2  *
3  * $Id$
4  *
5  * Wiretap Library
6  * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  */
23
24 #ifndef __W_BUFFER_H__
25 #define __W_BUFFER_H__
26
27 #define SOME_FUNCTIONS_ARE_DEFINES
28
29 typedef struct Buffer {
30         guchar  *data;
31         gsize   allocated;
32         gsize   start;
33         gsize   first_free;
34 } Buffer;
35
36 void buffer_init(Buffer* buffer, gsize space);
37 void buffer_free(Buffer* buffer);
38 void buffer_assure_space(Buffer* buffer, gsize space);
39 void buffer_append(Buffer* buffer, guchar *from, gsize bytes);
40 void buffer_remove_start(Buffer* buffer, gsize bytes);
41
42 #ifdef SOME_FUNCTIONS_ARE_DEFINES
43 # define buffer_clean(buffer) buffer_remove_start((buffer), buffer_length(buffer))
44 # define buffer_increase_length(buffer,bytes) (buffer)->first_free += (bytes)
45 # define buffer_length(buffer) ((buffer)->first_free - (buffer)->start)
46 # define buffer_start_ptr(buffer) ((buffer)->data + (buffer)->start)
47 # define buffer_end_ptr(buffer) ((buffer)->data + (buffer)->first_free)
48 # define buffer_append_buffer(buffer,src_buffer) buffer_append((buffer), buffer_start_ptr(src_buffer), buffer_length(src_buffer))
49 #else
50  void buffer_clean(Buffer* buffer);
51  void buffer_increase_length(Buffer* buffer, unsigned int bytes);
52  unsigned int buffer_length(Buffer* buffer);
53  guchar* buffer_start_ptr(Buffer* buffer);
54  guchar* buffer_end_ptr(Buffer* buffer);
55  void buffer_append_buffer(Buffer* buffer, Buffer* src_buffer);
56 #endif
57
58 #endif