gdb/gdb_obstack.h

   1 /* Obstack wrapper for GDB.
   2
   3    Copyright (C) 2002-2017 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 #if !defined (GDB_OBSTACK_H)
  21 #define GDB_OBSTACK_H 1
  22
  23 #include "obstack.h"
  24
  25 /* Utility macros - wrap obstack alloc into something more robust.  */
  26
  27 #define OBSTACK_ZALLOC(OBSTACK,TYPE) \
  28   ((TYPE *) memset (obstack_alloc ((OBSTACK), sizeof (TYPE)), 0, sizeof (TYPE)))
  29
  30 #define OBSTACK_CALLOC(OBSTACK,NUMBER,TYPE) \
  31   ((TYPE *) memset (obstack_alloc ((OBSTACK), (NUMBER) * sizeof (TYPE)), \
  32                     0, (NUMBER) * sizeof (TYPE)))
  33
  34 /* Unless explicitly specified, GDB obstacks always use xmalloc() and
  35    xfree().  */
  36 /* Note: ezannoni 2004-02-09: One could also specify the allocation
  37    functions using a special init function for each obstack,
  38    obstack_specify_allocation.  However we just use obstack_init and
  39    let these defines here do the job.  While one could argue the
  40    superiority of one approach over the other, we just chose one
  41    throughout.  */
  42
  43 #define obstack_chunk_alloc xmalloc
  44 #define obstack_chunk_free xfree
  45
  46 #define obstack_grow_str(OBSTACK,STRING) \
  47   obstack_grow (OBSTACK, STRING, strlen (STRING))
  48 #define obstack_grow_str0(OBSTACK,STRING) \
  49   obstack_grow0 (OBSTACK, STRING, strlen (STRING))
  50
  51 #define obstack_grow_wstr(OBSTACK, WSTRING) \
  52   obstack_grow (OBSTACK, WSTRING, sizeof (gdb_wchar_t) * gdb_wcslen (WSTRING))
  53
  54 /* Concatenate NULL terminated variable argument list of `const char
  55    *' strings; return the new string.  Space is found in the OBSTACKP.
  56    Argument list must be terminated by a sentinel expression `(char *)
  57    NULL'.  */
  58
  59 extern char *obconcat (struct obstack *obstackp, ...) ATTRIBUTE_SENTINEL;
  60
  61 /* Duplicate STRING, returning an equivalent string that's allocated on the
  62    obstack OBSTACKP.  */
  63
  64 extern char *obstack_strdup (struct obstack *obstackp, const char *string);
  65
  66 /* An obstack that frees itself on scope exit.  */
  67 struct auto_obstack : obstack
  68 {
  69   auto_obstack ()
  70   { obstack_init (this); }
  71
  72   ~auto_obstack ()
  73   { obstack_free (this, NULL); }
  74
  75   /* Free all memory in the obstack but leave it valid for further
  76      allocation.  */
  77   void clear ()
  78   { obstack_free (this, obstack_base (this)); }
  79 };
  80
  81 #endif