xref: /dragonfly/contrib/gdb-7/gdb/common/buffer.h (revision ef5ccd6c)
1 /* A simple growing buffer for GDB.
2 
3    Copyright (C) 2009-2013 Free Software Foundation, Inc.
4 
5    This file is part of GDB.
6 
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11 
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16 
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
19 
20 #ifndef BUFFER_H
21 #define BUFFER_H
22 
23 #include <stddef.h>
24 #include <string.h>
25 #include "ansidecl.h"
26 
27 struct buffer
28 {
29   char *buffer;
30   size_t buffer_size; /* allocated size */
31   size_t used_size; /* actually used size */
32 };
33 
34 /* Append DATA of size SIZE to the end of BUFFER.  Grows the buffer to
35    accommodate the new data.  */
36 void buffer_grow (struct buffer *buffer, const char *data, size_t size);
37 
38 /* Release any memory held by BUFFER.  */
39 void buffer_free (struct buffer *buffer);
40 
41 /* Initialize BUFFER.  BUFFER holds no memory afterwards.  */
42 void buffer_init (struct buffer *buffer);
43 
44 /* Return a pointer into BUFFER data, effectivelly transfering
45    ownership of the buffer memory to the caller.  Calling buffer_free
46    afterwards has no effect on the returned data.  */
47 char* buffer_finish (struct buffer *buffer);
48 
49 /* Simple printf to buffer function.  Current implemented formatters:
50    %s - grow an xml escaped text in BUFFER.
51    %d - grow an signed integer in BUFFER.
52    %u - grow an unsigned integer in BUFFER.
53    %x - grow an unsigned integer formatted in hexadecimal in BUFFER.
54    %o - grow an unsigned integer formatted in octal in BUFFER.  */
55 void buffer_xml_printf (struct buffer *buffer, const char *format, ...)
56   ATTRIBUTE_PRINTF (2, 3);
57 
58 #define buffer_grow_str(BUFFER,STRING)		\
59   buffer_grow (BUFFER, STRING, strlen (STRING))
60 #define buffer_grow_str0(BUFFER,STRING)			\
61   buffer_grow (BUFFER, STRING, strlen (STRING) + 1)
62 
63 #endif
64