* gdbtypes.c (check_typedef): Document that this function can
[platform/upstream/binutils.git] / gdb / gdb_obstack.h
1 /* Obstack wrapper for GDB.
2
3    Copyright (C) 2002, 2007, 2008, 2009, 2010, 2011
4    Free Software Foundation, Inc.
5
6    This file is part of GDB.
7
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 3 of the License, or
11    (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, see <http://www.gnu.org/licenses/>.  */
20
21 #if !defined (GDB_OBSTACK_H)
22 #define GDB_OBSTACK_H 1
23
24 #include "obstack.h"
25
26 /* Utility macros - wrap obstack alloc into something more robust.  */
27
28 #define OBSTACK_ZALLOC(OBSTACK,TYPE) \
29   (memset (obstack_alloc ((OBSTACK), sizeof (TYPE)), 0, sizeof (TYPE)))
30
31 #define OBSTACK_CALLOC(OBSTACK,NUMBER,TYPE) \
32   (memset (obstack_alloc ((OBSTACK), (NUMBER) * sizeof (TYPE)), \
33            0, (NUMBER) * sizeof (TYPE)))
34
35 /* Unless explicitly specified, GDB obstacks always use xmalloc() and
36    xfree().  */
37 /* Note: ezannoni 2004-02-09: One could also specify the allocation
38    functions using a special init function for each obstack,
39    obstack_specify_allocation.  However we just use obstack_init and
40    let these defines here do the job.  While one could argue the
41    superiority of one approach over the other, we just chose one
42    throughout.  */
43
44 #define obstack_chunk_alloc xmalloc
45 #define obstack_chunk_free xfree
46
47 #define obstack_grow_str(OBSTACK,STRING) \
48   obstack_grow (OBSTACK, STRING, strlen (STRING))
49 #define obstack_grow_str0(OBSTACK,STRING) \
50   obstack_grow0 (OBSTACK, STRING, strlen (STRING))
51
52 #define obstack_grow_wstr(OBSTACK, WSTRING) \
53   obstack_grow (OBSTACK, WSTRING, sizeof (gdb_wchar_t) * gdb_wcslen (WSTRING))
54
55 #endif