137e3ff70f34e4c63dc70152e68e50ae390aab78
[gnulib.git] / lib / obstack.h
1 /* obstack.h - object stack macros
2    Copyright (C) 1988, 89, 90, 91, 92, 93, 94 Free Software Foundation, Inc.
3
4 This program is free software; you can redistribute it and/or modify it
5 under the terms of the GNU General Public License as published by the
6 Free Software Foundation; either version 2, or (at your option) any
7 later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 GNU General Public License for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
17
18 /* Summary:
19
20 All the apparent functions defined here are macros. The idea
21 is that you would use these pre-tested macros to solve a
22 very specific set of problems, and they would run fast.
23 Caution: no side-effects in arguments please!! They may be
24 evaluated MANY times!!
25
26 These macros operate a stack of objects.  Each object starts life
27 small, and may grow to maturity.  (Consider building a word syllable
28 by syllable.)  An object can move while it is growing.  Once it has
29 been "finished" it never changes address again.  So the "top of the
30 stack" is typically an immature growing object, while the rest of the
31 stack is of mature, fixed size and fixed address objects.
32
33 These routines grab large chunks of memory, using a function you
34 supply, called `obstack_chunk_alloc'.  On occasion, they free chunks,
35 by calling `obstack_chunk_free'.  You must define them and declare
36 them before using any obstack macros.
37
38 Each independent stack is represented by a `struct obstack'.
39 Each of the obstack macros expects a pointer to such a structure
40 as the first argument.
41
42 One motivation for this package is the problem of growing char strings
43 in symbol tables.  Unless you are "fascist pig with a read-only mind"
44 --Gosper's immortal quote from HAKMEM item 154, out of context--you
45 would not like to put any arbitrary upper limit on the length of your
46 symbols.
47
48 In practice this often means you will build many short symbols and a
49 few long symbols.  At the time you are reading a symbol you don't know
50 how long it is.  One traditional method is to read a symbol into a
51 buffer, realloc()ating the buffer every time you try to read a symbol
52 that is longer than the buffer.  This is beaut, but you still will
53 want to copy the symbol from the buffer to a more permanent
54 symbol-table entry say about half the time.
55
56 With obstacks, you can work differently.  Use one obstack for all symbol
57 names.  As you read a symbol, grow the name in the obstack gradually.
58 When the name is complete, finalize it.  Then, if the symbol exists already,
59 free the newly read name.
60
61 The way we do this is to take a large chunk, allocating memory from
62 low addresses.  When you want to build a symbol in the chunk you just
63 add chars above the current "high water mark" in the chunk.  When you
64 have finished adding chars, because you got to the end of the symbol,
65 you know how long the chars are, and you can create a new object.
66 Mostly the chars will not burst over the highest address of the chunk,
67 because you would typically expect a chunk to be (say) 100 times as
68 long as an average object.
69
70 In case that isn't clear, when we have enough chars to make up
71 the object, THEY ARE ALREADY CONTIGUOUS IN THE CHUNK (guaranteed)
72 so we just point to it where it lies.  No moving of chars is
73 needed and this is the second win: potentially long strings need
74 never be explicitly shuffled. Once an object is formed, it does not
75 change its address during its lifetime.
76
77 When the chars burst over a chunk boundary, we allocate a larger
78 chunk, and then copy the partly formed object from the end of the old
79 chunk to the beginning of the new larger chunk.  We then carry on
80 accreting characters to the end of the object as we normally would.
81
82 A special macro is provided to add a single char at a time to a
83 growing object.  This allows the use of register variables, which
84 break the ordinary 'growth' macro.
85
86 Summary:
87         We allocate large chunks.
88         We carve out one object at a time from the current chunk.
89         Once carved, an object never moves.
90         We are free to append data of any size to the currently
91           growing object.
92         Exactly one object is growing in an obstack at any one time.
93         You can run one obstack per control block.
94         You may have as many control blocks as you dare.
95         Because of the way we do it, you can `unwind' an obstack
96           back to a previous state. (You may remove objects much
97           as you would with a stack.)
98 */
99
100
101 /* Don't do the contents of this file more than once.  */
102
103 #ifndef __OBSTACK_H__
104 #define __OBSTACK_H__
105 \f
106 #ifdef HAVE_CONFIG_H
107 # include <config.h>
108 #endif
109
110 /* We use subtraction of (char *)0 instead of casting to int
111    because on word-addressable machines a simple cast to int
112    may ignore the byte-within-word field of the pointer.  */
113
114 #ifndef __PTR_TO_INT
115 #define __PTR_TO_INT(P) ((P) - (char *)0)
116 #endif
117
118 #ifndef __INT_TO_PTR
119 #define __INT_TO_PTR(P) ((P) + (char *)0)
120 #endif
121
122 /* We need the type of the resulting object.  In ANSI C it is ptrdiff_t
123    but in traditional C it is usually long.  If we are in ANSI C and
124    don't already have ptrdiff_t get it.  */
125
126 #if defined (__STDC__) && __STDC__ && ! defined (offsetof)
127 #if defined (__GNUC__) && defined (IN_GCC)
128 /* On Next machine, the system's stddef.h screws up if included
129    after we have defined just ptrdiff_t, so include all of stddef.h.
130    Otherwise, define just ptrdiff_t, which is all we need.  */
131 #ifndef __NeXT__
132 #define __need_ptrdiff_t
133 #endif
134 #endif
135
136 #include <stddef.h>
137 #endif
138
139 #if defined (__STDC__) && __STDC__
140 #define PTR_INT_TYPE ptrdiff_t
141 #else
142 #define PTR_INT_TYPE long
143 #endif
144
145 #if HAVE_STRING_H || STDC_HEADERS
146 # include <string.h>
147 # ifndef bcopy
148 #  define bcopy(s, d, n) memcpy ((d), (s), (n))
149 # endif
150 #else /* HAVE_STRING_H || STDC_HEADERS */
151 # include <strings.h>
152 #endif   /* not (HAVE_STRING_H || STDC_HEADERS) */
153
154 struct _obstack_chunk           /* Lives at front of each chunk. */
155 {
156   char  *limit;                 /* 1 past end of this chunk */
157   struct _obstack_chunk *prev;  /* address of prior chunk or NULL */
158   char  contents[4];            /* objects begin here */
159 };
160
161 struct obstack          /* control current object in current chunk */
162 {
163   long  chunk_size;             /* preferred size to allocate chunks in */
164   struct _obstack_chunk* chunk; /* address of current struct obstack_chunk */
165   char  *object_base;           /* address of object we are building */
166   char  *next_free;             /* where to add next char to current object */
167   char  *chunk_limit;           /* address of char after current chunk */
168   PTR_INT_TYPE temp;            /* Temporary for some macros.  */
169   int   alignment_mask;         /* Mask of alignment for each object. */
170   struct _obstack_chunk *(*chunkfun) (); /* User's fcn to allocate a chunk.  */
171   void (*freefun) ();           /* User's function to free a chunk.  */
172   char *extra_arg;              /* first arg for chunk alloc/dealloc funcs */
173   unsigned use_extra_arg:1;     /* chunk alloc/dealloc funcs take extra arg */
174   unsigned maybe_empty_object:1;/* There is a possibility that the current
175                                    chunk contains a zero-length object.  This
176                                    prevents freeing the chunk if we allocate
177                                    a bigger chunk to replace it. */
178   unsigned alloc_failed:1;      /* chunk alloc func returned 0 */
179 };
180
181 /* Declare the external functions we use; they are in obstack.c.  */
182
183 #if defined (__STDC__) && __STDC__
184 extern void _obstack_newchunk (struct obstack *, int);
185 extern void _obstack_free (struct obstack *, void *);
186 extern int _obstack_begin (struct obstack *, int, int,
187                             void *(*) (), void (*) ());
188 extern int _obstack_begin_1 (struct obstack *, int, int,
189                               void *(*) (), void (*) (), void *);
190 #else
191 extern void _obstack_newchunk ();
192 extern void _obstack_free ();
193 extern int _obstack_begin ();
194 extern int _obstack_begin_1 ();
195 #endif
196 \f
197 #if defined (__STDC__) && __STDC__
198
199 /* Do the function-declarations after the structs
200    but before defining the macros.  */
201
202 void obstack_init (struct obstack *obstack);
203
204 void * obstack_alloc (struct obstack *obstack, int size);
205
206 void * obstack_copy (struct obstack *obstack, void *address, int size);
207 void * obstack_copy0 (struct obstack *obstack, void *address, int size);
208
209 void obstack_free (struct obstack *obstack, void *block);
210
211 void obstack_blank (struct obstack *obstack, int size);
212
213 void obstack_grow (struct obstack *obstack, void *data, int size);
214 void obstack_grow0 (struct obstack *obstack, void *data, int size);
215
216 void obstack_1grow (struct obstack *obstack, int data_char);
217 void obstack_ptr_grow (struct obstack *obstack, void *data);
218 void obstack_int_grow (struct obstack *obstack, int data);
219
220 void * obstack_finish (struct obstack *obstack);
221
222 int obstack_object_size (struct obstack *obstack);
223
224 int obstack_room (struct obstack *obstack);
225 void obstack_1grow_fast (struct obstack *obstack, int data_char);
226 void obstack_ptr_grow_fast (struct obstack *obstack, void *data);
227 void obstack_int_grow_fast (struct obstack *obstack, int data);
228 void obstack_blank_fast (struct obstack *obstack, int size);
229
230 void * obstack_base (struct obstack *obstack);
231 void * obstack_next_free (struct obstack *obstack);
232 int obstack_alignment_mask (struct obstack *obstack);
233 int obstack_chunk_size (struct obstack *obstack);
234
235 #endif /* __STDC__ */
236
237 /* Non-ANSI C cannot really support alternative functions for these macros,
238    so we do not declare them.  */
239 \f
240 /* Pointer to beginning of object being allocated or to be allocated next.
241    Note that this might not be the final address of the object
242    because a new chunk might be needed to hold the final size.  */
243
244 #define obstack_base(h) ((h)->alloc_failed ? 0 : (h)->object_base)
245
246 /* Size for allocating ordinary chunks.  */
247
248 #define obstack_chunk_size(h) ((h)->chunk_size)
249
250 /* Pointer to next byte not yet allocated in current chunk.  */
251
252 #define obstack_next_free(h)    ((h)->alloc_failed ? 0 : (h)->next_free)
253
254 /* Mask specifying low bits that should be clear in address of an object.  */
255
256 #define obstack_alignment_mask(h) ((h)->alignment_mask)
257
258 #define obstack_init(h) \
259   _obstack_begin ((h), 0, 0, \
260                   (void *(*) ()) obstack_chunk_alloc, (void (*) ()) obstack_chunk_free)
261
262 #define obstack_begin(h, size) \
263   _obstack_begin ((h), (size), 0, \
264                   (void *(*) ()) obstack_chunk_alloc, (void (*) ()) obstack_chunk_free)
265
266 #define obstack_specify_allocation(h, size, alignment, chunkfun, freefun) \
267   _obstack_begin ((h), (size), (alignment), \
268                     (void *(*) ()) (chunkfun), (void (*) ()) (freefun))
269
270 #define obstack_specify_allocation_with_arg(h, size, alignment, chunkfun, freefun, arg) \
271   _obstack_begin_1 ((h), (size), (alignment), \
272                     (void *(*) ()) (chunkfun), (void (*) ()) (freefun), (arg))
273
274 #define obstack_chunkfun(h, newchunkfun) \
275   ((h) -> chunkfun = (struct _obstack_chunk *(*)()) (newchunkfun))
276
277 #define obstack_freefun(h, newfreefun) \
278   ((h) -> freefun = (void (*)()) (newfreefun))
279
280 #define obstack_1grow_fast(h,achar) (*((h)->next_free)++ = achar)
281
282 #define obstack_blank_fast(h,n) ((h)->next_free += (n))
283 \f
284 #if defined (__GNUC__) && defined (__STDC__)
285 /* NextStep 2.0 cc is really gcc 1.93 but it defines __GNUC__ = 2 and
286    does not implement __extension__.  But that compiler doesn't define
287    __GNUC_MINOR__.  */
288 #if __GNUC__ < 2 || (__NeXT__ && !__GNUC_MINOR__)
289 #define __extension__
290 #endif
291
292 /* For GNU C, if not -traditional,
293    we can define these macros to compute all args only once
294    without using a global variable.
295    Also, we can avoid using the `temp' slot, to make faster code.  */
296
297 #define obstack_object_size(OBSTACK)                                    \
298   __extension__                                                         \
299   ({ struct obstack *__o = (OBSTACK);                                   \
300      __o->alloc_failed ? 0 :                                            \
301      (unsigned) (__o->next_free - __o->object_base); })
302
303 #define obstack_room(OBSTACK)                                           \
304   __extension__                                                         \
305   ({ struct obstack *__o = (OBSTACK);                                   \
306      (unsigned) (__o->chunk_limit - __o->next_free); })
307
308 #define obstack_grow(OBSTACK,where,length)                              \
309 __extension__                                                           \
310 ({ struct obstack *__o = (OBSTACK);                                     \
311    int __len = (length);                                                \
312    if (__o->next_free + __len > __o->chunk_limit)                       \
313      _obstack_newchunk (__o, __len);                                    \
314    if (!__o->alloc_failed)                                              \
315      {                                                                  \
316         bcopy ((char *) (where), __o->next_free, __len);                \
317         __o->next_free += __len;                                        \
318      }                                                                  \
319    (void) 0; })
320
321 #define obstack_grow0(OBSTACK,where,length)                             \
322 __extension__                                                           \
323 ({ struct obstack *__o = (OBSTACK);                                     \
324    int __len = (length);                                                \
325    if (__o->next_free + __len + 1 > __o->chunk_limit)                   \
326      _obstack_newchunk (__o, __len + 1);                                \
327    if (!__o->alloc_failed)                                              \
328      {                                                                  \
329        bcopy ((char *) (where), __o->next_free, __len);                 \
330        __o->next_free += __len;                                         \
331        *(__o->next_free)++ = 0;                                         \
332      }                                                                  \
333    (void) 0; })
334
335 #define obstack_1grow(OBSTACK,datum)                                    \
336 __extension__                                                           \
337 ({ struct obstack *__o = (OBSTACK);                                     \
338    if (__o->next_free + 1 > __o->chunk_limit)                           \
339      _obstack_newchunk (__o, 1);                                        \
340    if (!__o->alloc_failed)                                              \
341      *(__o->next_free)++ = (datum);                                     \
342    (void) 0; })
343
344 /* These assume that the obstack alignment is good enough for pointers or ints,
345    and that the data added so far to the current object
346    shares that much alignment.  */
347
348 #define obstack_ptr_grow(OBSTACK,datum)                                 \
349 __extension__                                                           \
350 ({ struct obstack *__o = (OBSTACK);                                     \
351    if (__o->next_free + sizeof (void *) > __o->chunk_limit)             \
352      _obstack_newchunk (__o, sizeof (void *));                          \
353    if (!__o->alloc_failed)                                              \
354      *((void **)__o->next_free)++ = ((void *)datum);                    \
355    (void) 0; })
356
357 #define obstack_int_grow(OBSTACK,datum)                                 \
358 __extension__                                                           \
359 ({ struct obstack *__o = (OBSTACK);                                     \
360    if (__o->next_free + sizeof (int) > __o->chunk_limit)                \
361      _obstack_newchunk (__o, sizeof (int));                             \
362    if (!__o->alloc_failed)                                              \
363      *((int *)__o->next_free)++ = ((int)datum);                         \
364    (void) 0; })
365
366 #define obstack_ptr_grow_fast(h,aptr) (*((void **)(h)->next_free)++ = (void *)aptr)
367 #define obstack_int_grow_fast(h,aint) (*((int *)(h)->next_free)++ = (int)aint)
368
369 #define obstack_blank(OBSTACK,length)                                   \
370 __extension__                                                           \
371 ({ struct obstack *__o = (OBSTACK);                                     \
372    int __len = (length);                                                \
373    if (__o->chunk_limit - __o->next_free < __len)                       \
374      _obstack_newchunk (__o, __len);                                    \
375    if (!__o->alloc_failed)                                              \
376      __o->next_free += __len;                                           \
377    (void) 0; })
378
379 #define obstack_alloc(OBSTACK,length)                                   \
380 __extension__                                                           \
381 ({ struct obstack *__h = (OBSTACK);                                     \
382    obstack_blank (__h, (length));                                       \
383    obstack_finish (__h); })
384
385 #define obstack_copy(OBSTACK,where,length)                              \
386 __extension__                                                           \
387 ({ struct obstack *__h = (OBSTACK);                                     \
388    obstack_grow (__h, (where), (length));                               \
389    obstack_finish (__h); })
390
391 #define obstack_copy0(OBSTACK,where,length)                             \
392 __extension__                                                           \
393 ({ struct obstack *__h = (OBSTACK);                                     \
394    obstack_grow0 (__h, (where), (length));                              \
395    obstack_finish (__h); })
396
397 /* The local variable is named __o1 to avoid a name conflict
398    when obstack_blank is called.  */
399 #define obstack_finish(OBSTACK)                                         \
400 __extension__                                                           \
401 ({ struct obstack *__o1 = (OBSTACK);                                    \
402    void *value;                                                         \
403    if (__o1->alloc_failed)                                              \
404      value = 0;                                                         \
405    else                                                                 \
406      {                                                                  \
407        value = (void *) __o1->object_base;                              \
408        if (__o1->next_free == value)                                    \
409          __o1->maybe_empty_object = 1;                                  \
410        __o1->next_free                                                  \
411          = __INT_TO_PTR ((__PTR_TO_INT (__o1->next_free)+__o1->alignment_mask)\
412                          & ~ (__o1->alignment_mask));                   \
413        if (__o1->next_free - (char *)__o1->chunk                        \
414            > __o1->chunk_limit - (char *)__o1->chunk)                   \
415          __o1->next_free = __o1->chunk_limit;                           \
416        __o1->object_base = __o1->next_free;                             \
417       }                                                                 \
418    value; })
419
420 #define obstack_free(OBSTACK, OBJ)                                      \
421 __extension__                                                           \
422 ({ struct obstack *__o = (OBSTACK);                                     \
423    void *__obj = (OBJ);                                                 \
424    if (__obj > (void *)__o->chunk && __obj < (void *)__o->chunk_limit)  \
425      __o->next_free = __o->object_base = __obj;                         \
426    else (obstack_free) (__o, __obj); })
427 \f
428 #else /* not __GNUC__ or not __STDC__ */
429
430 #define obstack_object_size(h) \
431  (unsigned) ((h)->alloc_failed ? 0 : (h)->next_free - (h)->object_base)
432
433 #define obstack_room(h)         \
434  (unsigned) ((h)->chunk_limit - (h)->next_free)
435
436 /* Note that the call to _obstack_newchunk is enclosed in (..., 0)
437    so that we can avoid having void expressions
438    in the arms of the conditional expression.
439    Casting the third operand to void was tried before,
440    but some compilers won't accept it.  */
441
442 #define obstack_grow(h,where,length)                                    \
443 ( (h)->temp = (length),                                                 \
444   (((h)->next_free + (h)->temp > (h)->chunk_limit)                      \
445    ? (_obstack_newchunk ((h), (h)->temp), 0) : 0),                      \
446   ((h)->alloc_failed ? 0 :                                              \
447   (bcopy ((char *) (where), (h)->next_free, (h)->temp),                 \
448   (h)->next_free += (h)->temp)))
449
450 #define obstack_grow0(h,where,length)                                   \
451 ( (h)->temp = (length),                                                 \
452   (((h)->next_free + (h)->temp + 1 > (h)->chunk_limit)                  \
453    ? (_obstack_newchunk ((h), (h)->temp + 1), 0) : 0),                  \
454   ((h)->alloc_failed ? 0 :                                              \
455   (bcopy ((char *) (where), (h)->next_free, (h)->temp),                 \
456   (h)->next_free += (h)->temp,                                          \
457   *((h)->next_free)++ = 0)))
458
459 #define obstack_1grow(h,datum)                                          \
460 ( (((h)->next_free + 1 > (h)->chunk_limit)                              \
461    ? (_obstack_newchunk ((h), 1), 0) : 0),                              \
462  ((h)->alloc_failed ? 0 :                                               \
463   (*((h)->next_free)++ = (datum))))
464
465 #define obstack_ptr_grow(h,datum)                                       \
466 ( (((h)->next_free + sizeof (char *) > (h)->chunk_limit)                \
467    ? (_obstack_newchunk ((h), sizeof (char *)), 0) : 0),                \
468   ((h)->alloc_failed ? 0 :                                              \
469   (*((char **)(((h)->next_free+=sizeof(char *))-sizeof(char *))) = ((char *)datum))))
470
471 #define obstack_int_grow(h,datum)                                       \
472 ( (((h)->next_free + sizeof (int) > (h)->chunk_limit)                   \
473    ? (_obstack_newchunk ((h), sizeof (int)), 0) : 0),                   \
474   ((h)->alloc_failed ? 0 :                                              \
475   (*((int *)(((h)->next_free+=sizeof(int))-sizeof(int))) = ((int)datum))))
476
477 #define obstack_ptr_grow_fast(h,aptr) (*((char **)(h)->next_free)++ = (char *)aptr)
478 #define obstack_int_grow_fast(h,aint) (*((int *)(h)->next_free)++ = (int)aint)
479
480 #define obstack_blank(h,length)                                         \
481 ( (h)->temp = (length),                                                 \
482   (((h)->chunk_limit - (h)->next_free < (h)->temp)                      \
483    ? (_obstack_newchunk ((h), (h)->temp), 0) : 0),                      \
484   ((h)->alloc_failed ? 0 :                                              \
485   ((h)->next_free += (h)->temp)))
486
487 #define obstack_alloc(h,length)                                         \
488  (obstack_blank ((h), (length)), obstack_finish ((h)))
489
490 #define obstack_copy(h,where,length)                                    \
491  (obstack_grow ((h), (where), (length)), obstack_finish ((h)))
492
493 #define obstack_copy0(h,where,length)                                   \
494  (obstack_grow0 ((h), (where), (length)), obstack_finish ((h)))
495
496 #define obstack_finish(h)                                               \
497 ( (h)->alloc_failed ? 0 :                                               \
498   (((h)->next_free == (h)->object_base                                  \
499    ? (((h)->maybe_empty_object = 1), 0)                                 \
500    : 0),                                                                \
501   (h)->temp = __PTR_TO_INT ((h)->object_base),                          \
502   (h)->next_free                                                        \
503     = __INT_TO_PTR ((__PTR_TO_INT ((h)->next_free)+(h)->alignment_mask) \
504                     & ~ ((h)->alignment_mask)),                         \
505   (((h)->next_free - (char *)(h)->chunk                                 \
506     > (h)->chunk_limit - (char *)(h)->chunk)                            \
507    ? ((h)->next_free = (h)->chunk_limit) : 0),                          \
508   (h)->object_base = (h)->next_free,                                    \
509   __INT_TO_PTR ((h)->temp)))
510
511 #if defined (__STDC__) && __STDC__
512 #define obstack_free(h,obj)                                             \
513 ( (h)->temp = (char *)(obj) - (char *) (h)->chunk,                      \
514   (((h)->temp > 0 && (h)->temp < (h)->chunk_limit - (char *) (h)->chunk)\
515    ? (int) ((h)->next_free = (h)->object_base                           \
516             = (h)->temp + (char *) (h)->chunk)                          \
517    : (((obstack_free) ((h), (h)->temp + (char *) (h)->chunk), 0), 0)))
518 #else
519 #define obstack_free(h,obj)                                             \
520 ( (h)->temp = (char *)(obj) - (char *) (h)->chunk,                      \
521   (((h)->temp > 0 && (h)->temp < (h)->chunk_limit - (char *) (h)->chunk)\
522    ? (int) ((h)->next_free = (h)->object_base                           \
523             = (h)->temp + (char *) (h)->chunk)                          \
524    : (_obstack_free ((h), (h)->temp + (char *) (h)->chunk), 0)))
525 #endif
526
527 #endif /* not __GNUC__ or not __STDC__ */
528
529 #endif /* not __OBSTACK_H__ */