obstack.h

Go to the documentation of this file.

/* obstack.h - object stack macros
   Copyright (C) 1988, 89, 90, 91, 92, 93, 94, 95, 96 Free Software Foundation, Inc.

This program is free software; you can redistribute it and/or modify it
under the terms of the GNU Library General Public License as published by the
Free Software Foundation; either version 2, or (at your option) any
later version.

This program 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 Library General Public License for more details.

You should have received a copy of the GNU Library General Public License
along with this program; if not, write to the Free Software
Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */

/* Don't do the contents of this file more than once.  */

#ifndef __OBSTACK_H__
#define __OBSTACK_H__


#ifndef __PTR_TO_INT

#define __PTR_TO_INT(P) ((P) - (char *)0)
#endif

#ifndef __INT_TO_PTR

#define __INT_TO_PTR(P) ((P) + (char *)0)
#endif

/* CodeWarrior C++ does not define __STDC__ even though it should? */
#if ( defined(__MWERKS__) && defined(__cplusplus) )
#define __STDC__        TRUE    
#endif

/* We need the type of the resulting object.  In ANSI C it is ptrdiff_t
   but in traditional C it is usually long.  If we are in ANSI C and
   don't already have ptrdiff_t get it.  */

#if defined (__STDC__) && ! defined (offsetof)
#if defined (__GNUC__) && defined (IN_GCC)
/* On Next machine, the system's stddef.h screws up if included
   after we have defined just ptrdiff_t, so include all of stddef.h.
   Otherwise, define just ptrdiff_t, which is all we need.  */
#ifndef __NeXT__
#define __need_ptrdiff_t
#endif
#endif

#include <stddef.h>
#endif

#ifdef __STDC__
#define PTR_INT_TYPE ptrdiff_t
#else
#define PTR_INT_TYPE long
#endif

struct _obstack_chunk           /* Lives at front of each chunk. */
{
  char  *limit;                                 
  struct _obstack_chunk *prev;  
  char  contents[4];                    
};

struct obstack                                                  /* control current object in current chunk */
{
  long  chunk_size;                                                     
  struct _obstack_chunk* chunk;                         
  char  *object_base;                                           
  char  *next_free;                                             
  char  *chunk_limit;                                   
  PTR_INT_TYPE temp;                                            
  int   alignment_mask;                                         
  struct _obstack_chunk *(*chunkfun) (int);     
  void (*freefun) (void *);                                     
  char *extra_arg;                                              
  unsigned use_extra_arg:1;                                     
  unsigned maybe_empty_object:1;                        
  unsigned alloc_failed:1;                                              
};

/* Declare the external functions we use; they are in obstack.c.  */

#ifdef __STDC__

extern void _obstack_newchunk (struct obstack *, int);
extern void _obstack_free (struct obstack *, void *);
extern int _obstack_begin (struct obstack *, int, int,
                            void *(*) (int), void (*) (void *));
extern int _obstack_begin_1 (struct obstack *, int, int,
                              void *(*) (int), void (*) (void *), void *);
extern int _obstack_memory_used (struct obstack *);
#else
extern void _obstack_newchunk ();
extern void _obstack_free ();
extern int _obstack_begin ();
extern int _obstack_begin_1 ();
extern int _obstack_memory_used ();
#endif

#ifdef __STDC__

/* Do the function-declarations after the structs
   but before defining the macros.  */

void obstack_init (struct obstack *obstack);

void * obstack_alloc (struct obstack *obstack, int size);

void * obstack_copy (struct obstack *obstack, void *address, int size);
void * obstack_copy0 (struct obstack *obstack, void *address, int size);

void obstack_free (struct obstack *obstack, void *block);

void obstack_blank (struct obstack *obstack, int size);

void obstack_grow (struct obstack *obstack, void *data, int size);
void obstack_grow0 (struct obstack *obstack, void *data, int size);

void obstack_1grow (struct obstack *obstack, int data_char);
void obstack_ptr_grow (struct obstack *obstack, void *data);
void obstack_int_grow (struct obstack *obstack, int data);

void * obstack_finish (struct obstack *obstack);

int obstack_object_size (struct obstack *obstack);

int obstack_room (struct obstack *obstack);
void obstack_1grow_fast (struct obstack *obstack, int data_char);
void obstack_ptr_grow_fast (struct obstack *obstack, void *data);
void obstack_int_grow_fast (struct obstack *obstack, int data);
void obstack_blank_fast (struct obstack *obstack, int size);

void * obstack_base (struct obstack *obstack);
void * obstack_next_free (struct obstack *obstack);
int obstack_alignment_mask (struct obstack *obstack);
int obstack_chunk_size (struct obstack *obstack);
int obstack_memory_used (struct obstack *obstack);

#endif /* __STDC__ */

/* Non-ANSI C cannot really support alternative functions for these macros,
   so we do not declare them.  */

#define obstack_base(h) ((h)->alloc_failed ? 0 : (h)->object_base)

#define obstack_chunk_size(h) ((h)->chunk_size)

#define obstack_next_free(h)    ((h)->alloc_failed ? 0 : (h)->next_free)

#define obstack_alignment_mask(h) ((h)->alignment_mask)

#define obstack_init(h) \
  _obstack_begin ((h), 0, 0, \
                  (void *(*) ()) obstack_chunk_alloc, (void (*) ()) obstack_chunk_free)

#define obstack_begin(h, size) \
  _obstack_begin ((h), (size), 0, \
                  (void *(*) (int)) obstack_chunk_alloc, (void (*) (void *)) obstack_chunk_free)

#define obstack_specify_allocation(h, size, alignment, chunkfun, freefun) \
  _obstack_begin ((h), (size), (alignment), \
                    (void *(*) ()) (chunkfun), (void (*) ()) (freefun))

#define obstack_specify_allocation_with_arg(h, size, alignment, chunkfun, freefun, arg) \
  _obstack_begin_1 ((h), (size), (alignment), \
                    (void *(*) ()) (chunkfun), (void (*) ()) (freefun), (arg))

#define obstack_chunkfun(h, newchunkfun) \
  ((h) -> chunkfun = (struct _obstack_chunk *(*)()) (newchunkfun))

#define obstack_freefun(h, newfreefun) \
  ((h) -> freefun = (void (*)()) (newfreefun))

#define obstack_1grow_fast(h,achar) (*((h)->next_free)++ = achar)

#define obstack_blank_fast(h,n) ((h)->next_free += (n))

#define obstack_memory_used(h) _obstack_memory_used (h)

#if defined (__GNUC__) && defined (__STDC__)
#if __GNUC__ < 2
#define __extension__
#endif

/* For GNU C, if not -traditional,
   we can define these macros to compute all args only once
   without using a global variable.
   Also, we can avoid using the `temp' slot, to make faster code.  */

#define obstack_object_size(OBSTACK)                                    \
  __extension__                                                         \
  ({ struct obstack *__o = (OBSTACK);                                   \
     __o->alloc_failed ? 0 :                                            \
     (unsigned) (__o->next_free - __o->object_base); })

#define obstack_room(OBSTACK)                                           \
  __extension__                                                         \
  ({ struct obstack *__o = (OBSTACK);                                   \
     (unsigned) (__o->chunk_limit - __o->next_free); })

#define obstack_grow(OBSTACK,where,length)                              \
__extension__                                                           \
({ struct obstack *__o = (OBSTACK);                                     \
   int __len = (length);                                                \
   if (__o->next_free + __len > __o->chunk_limit)                       \
     _obstack_newchunk (__o, __len);                                    \
   if (!__o->alloc_failed)                                              \
     {                                                                  \
        bcopy (where, __o->next_free, __len);                           \
        __o->next_free += __len;                                        \
     }                                                                  \
   (void) 0; })

#define obstack_grow0(OBSTACK,where,length)                             \
__extension__                                                           \
({ struct obstack *__o = (OBSTACK);                                     \
   int __len = (length);                                                \
   if (__o->next_free + __len + 1 > __o->chunk_limit)                   \
     _obstack_newchunk (__o, __len + 1);                                \
   if (!__o->alloc_failed)                                              \
     {                                                                  \
       bcopy (where, __o->next_free, __len);                            \
       __o->next_free += __len;                                         \
       *(__o->next_free)++ = 0;                                         \
     }                                                                  \
   (void) 0; })

#define obstack_1grow(OBSTACK,datum)                                    \
__extension__                                                           \
({ struct obstack *__o = (OBSTACK);                                     \
   if (__o->next_free + 1 > __o->chunk_limit)                           \
     _obstack_newchunk (__o, 1);                                        \
   if (!__o->alloc_failed)                                              \
     *(__o->next_free)++ = (datum);                                     \
   (void) 0; })

/* These assume that the obstack alignment is good enough for pointers or ints,
   and that the data added so far to the current object
   shares that much alignment.  */
   
#define obstack_ptr_grow(OBSTACK,datum)                                 \
__extension__                                                           \
({ struct obstack *__o = (OBSTACK);                                     \
   if (__o->next_free + sizeof (void *) > __o->chunk_limit)             \
     _obstack_newchunk (__o, sizeof (void *));                          \
   if (!__o->alloc_failed)                                              \
     *((void **)__o->next_free)++ = ((void *)datum);                    \
   (void) 0; })

#define obstack_int_grow(OBSTACK,datum)                                 \
__extension__                                                           \
({ struct obstack *__o = (OBSTACK);                                     \
   if (__o->next_free + sizeof (int) > __o->chunk_limit)                \
     _obstack_newchunk (__o, sizeof (int));                             \
   if (!__o->alloc_failed)                                              \
     *((int *)__o->next_free)++ = ((int)datum);                         \
   (void) 0; })

#define obstack_ptr_grow_fast(h,aptr) (*((void **)(h)->next_free)++ = (void *)aptr)
#define obstack_int_grow_fast(h,aint) (*((int *)(h)->next_free)++ = (int)aint)

#define obstack_blank(OBSTACK,length)                                   \
__extension__                                                           \
({ struct obstack *__o = (OBSTACK);                                     \
   int __len = (length);                                                \
   if (__o->chunk_limit - __o->next_free < __len)                       \
     _obstack_newchunk (__o, __len);                                    \
   if (!__o->alloc_failed)                                              \
     __o->next_free += __len;                                           \
   (void) 0; })

#define obstack_alloc(OBSTACK,length)                                   \
__extension__                                                           \
({ struct obstack *__h = (OBSTACK);                                     \
   obstack_blank (__h, (length));                                       \
   obstack_finish (__h); })

#define obstack_copy(OBSTACK,where,length)                              \
__extension__                                                           \
({ struct obstack *__h = (OBSTACK);                                     \
   obstack_grow (__h, (where), (length));                               \
   obstack_finish (__h); })

#define obstack_copy0(OBSTACK,where,length)                             \
__extension__                                                           \
({ struct obstack *__h = (OBSTACK);                                     \
   obstack_grow0 (__h, (where), (length));                              \
   obstack_finish (__h); })

/* The local variable is named __o1 to avoid a name conflict
   when obstack_blank is called.  */
#define obstack_finish(OBSTACK)                                         \
__extension__                                                           \
({ struct obstack *__o1 = (OBSTACK);                                    \
   void *value;                                                         \
   if (__o1->alloc_failed)                                              \
     value = 0;                                                         \
   else                                                                 \
     {                                                                  \
       value = (void *) __o1->object_base;                              \
       if (__o1->next_free == value)                                    \
         __o1->maybe_empty_object = 1;                                  \
       __o1->next_free                                                  \
         = __INT_TO_PTR ((__PTR_TO_INT (__o1->next_free)+__o1->alignment_mask)\
                         & ~ (__o1->alignment_mask));                   \
       if (__o1->next_free - (char *)__o1->chunk                        \
           > __o1->chunk_limit - (char *)__o1->chunk)                   \
         __o1->next_free = __o1->chunk_limit;                           \
       __o1->object_base = __o1->next_free;                             \
      }                                                                 \
   value; })

#define obstack_free(OBSTACK, OBJ)                                      \
__extension__                                                           \
({ struct obstack *__o = (OBSTACK);                                     \
   void *__obj = (OBJ);                                                 \
   if (__obj > (void *)__o->chunk && __obj < (void *)__o->chunk_limit)  \
     __o->next_free = __o->object_base = (char *)__obj;                 \
   else (obstack_free) (__o, __obj); })

#else /* not __GNUC__ or not __STDC__ */

#define obstack_object_size(h) \
 (unsigned) ((h)->alloc_failed ? 0 : (h)->next_free - (h)->object_base)

#define obstack_room(h)         \
 (unsigned) ((h)->chunk_limit - (h)->next_free)

/* Note that the call to _obstack_newchunk is enclosed in (..., 0)
   so that we can avoid having void expressions
   in the arms of the conditional expression.
   Casting the third operand to void was tried before,
   but some compilers won't accept it.  */

#define obstack_grow(h,where,length)                                    \
( (h)->temp = (length),                                                 \
  (((h)->next_free + (h)->temp > (h)->chunk_limit)                      \
   ? (_obstack_newchunk ((h), (h)->temp), 0) : 0),                      \
  ((h)->alloc_failed ? 0 :                                              \
  (bcopy (where, (h)->next_free, (h)->temp),                            \
  (h)->next_free += (h)->temp)))

#define obstack_grow0(h,where,length)                                   \
( (h)->temp = (length),                                                 \
  (((h)->next_free + (h)->temp + 1 > (h)->chunk_limit)                  \
   ? (_obstack_newchunk ((h), (h)->temp + 1), 0) : 0),                  \
  ((h)->alloc_failed ? 0 :                                              \
  (bcopy (where, (h)->next_free, (h)->temp),                            \
  (h)->next_free += (h)->temp,                                          \
  *((h)->next_free)++ = 0)))

#define obstack_1grow(h,datum)                                          \
( (((h)->next_free + 1 > (h)->chunk_limit)                              \
   ? (_obstack_newchunk ((h), 1), 0) : 0),                              \
 ((h)->alloc_failed ? 0 :                                               \
  (*((h)->next_free)++ = (datum))))

#define obstack_ptr_grow(h,datum)                                       \
( (((h)->next_free + sizeof (char *) > (h)->chunk_limit)                \
   ? (_obstack_newchunk ((h), sizeof (char *)), 0) : 0),                \
  ((h)->alloc_failed ? 0 :                                              \
  (*((char **)(((h)->next_free+=sizeof(char *))-sizeof(char *))) = ((char *)datum))))

#define obstack_int_grow(h,datum)                                       \
( (((h)->next_free + sizeof (int) > (h)->chunk_limit)                   \
   ? (_obstack_newchunk ((h), sizeof (int)), 0) : 0),                   \
  ((h)->alloc_failed ? 0 :                                              \
  (*((int *)(((h)->next_free+=sizeof(int))-sizeof(int))) = ((int)datum))))

#define obstack_ptr_grow_fast(h,aptr) (*((char **)(h)->next_free)++ = (char *)aptr)
#define obstack_int_grow_fast(h,aint) (*((int *)(h)->next_free)++ = (int)aint)

#define obstack_blank(h,length)                                         \
( (h)->temp = (length),                                                 \
  (((h)->chunk_limit - (h)->next_free < (h)->temp)                      \
   ? (_obstack_newchunk ((h), (h)->temp), 0) : 0),                      \
  ((h)->alloc_failed ? 0 :                                              \
  ((h)->next_free += (h)->temp)))

#define obstack_alloc(h,length)                                         \
 (obstack_blank ((h), (length)), obstack_finish ((h)))

#define obstack_copy(h,where,length)                                    \
 (obstack_grow ((h), (where), (length)), obstack_finish ((h)))

#define obstack_copy0(h,where,length)                                   \
 (obstack_grow0 ((h), (where), (length)), obstack_finish ((h)))

#define obstack_finish(h)                                               \
( (h)->alloc_failed ? 0 :                                               \
  (((h)->next_free == (h)->object_base                                  \
   ? (((h)->maybe_empty_object = 1), 0)                                 \
   : 0),                                                                \
  (h)->temp = __PTR_TO_INT ((h)->object_base),                          \
  (h)->next_free                                                        \
    = __INT_TO_PTR ((__PTR_TO_INT ((h)->next_free)+(h)->alignment_mask) \
                    & ~ ((h)->alignment_mask)),                         \
  (((h)->next_free - (char *)(h)->chunk                                 \
    > (h)->chunk_limit - (char *)(h)->chunk)                            \
   ? ((h)->next_free = (h)->chunk_limit) : 0),                          \
  (h)->object_base = (h)->next_free,                                    \
  __INT_TO_PTR ((h)->temp)))

#ifdef __STDC__
#define obstack_free(h,obj)                                             \
( (h)->temp = (char *)(obj) - (char *) (h)->chunk,                      \
  (((h)->temp > 0 && (h)->temp < (h)->chunk_limit - (char *) (h)->chunk)\
   ? (int) ((h)->next_free = (h)->object_base                           \
            = (h)->temp + (char *) (h)->chunk)                          \
   : (((obstack_free) ((h), (h)->temp + (char *) (h)->chunk), 0), 0)))
#else
#define obstack_free(h,obj)                                             \
( (h)->temp = (char *)(obj) - (char *) (h)->chunk,                      \
  (((h)->temp > 0 && (h)->temp < (h)->chunk_limit - (char *) (h)->chunk)\
   ? (int) ((h)->next_free = (h)->object_base                           \
            = (h)->temp + (char *) (h)->chunk)                          \
   : (_obstack_free ((h), (h)->temp + (char *) (h)->chunk), 0)))
#endif

#endif /* not __GNUC__ or not __STDC__ */

#endif /* not __OBSTACK_H__ */

---