home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 5 / FreshFish_July-August1994.bin / bbs / gnu / libg++-2.5.3.lha / libg++-2.5.3 / include / obstack.h < prev   
C/C++ Source or Header  |  1993-08-09  |  19KB  |  491 lines
  1. /* obstack.h - object stack macros
  2.    Copyright (C) 1988, 1992 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 Library 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 Library General Public License for more details.
  13.  
  14. You should have received a copy of the GNU Library 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 __OBSTACKS__
  104. #define __OBSTACKS__
  105.  
  106. /* We use subtraction of (char *)0 instead of casting to int
  107.    because on word-addressable machines a simple cast to int
  108.    may ignore the byte-within-word field of the pointer.  */
  109.  
  110. #ifndef __PTR_TO_INT
  111. #define __PTR_TO_INT(P) ((P) - (char *)0)
  112. #endif
  113.  
  114. #ifndef __INT_TO_PTR
  115. #define __INT_TO_PTR(P) ((P) + (char *)0)
  116. #endif
  117.  
  118. /* We need the type of the resulting object.  In ANSI C it is ptrdiff_t
  119.    but in traditional C it is usually long.  If we are in ANSI C and
  120.    don't already have ptrdiff_t get it.  */
  121.  
  122. #if defined (__STDC__) && ! defined (offsetof)
  123. #if defined (__GNUC__) && defined (IN_GCC)
  124. /* On Next machine, the system's stddef.h screws up if included
  125.    after we have defined just ptrdiff_t, so include all of gstddef.h.
  126.    Otherwise, define just ptrdiff_t, which is all we need.  */
  127. #ifndef __NeXT__
  128. #define __need_ptrdiff_t
  129. #endif
  130.  
  131. /* While building GCC, the stddef.h that goes with GCC has this name.  */
  132. #include "gstddef.h"
  133. #else
  134. #include <stddef.h>
  135. #endif
  136. #endif
  137.  
  138. #ifdef __STDC__
  139. #define PTR_INT_TYPE ptrdiff_t
  140. #else
  141. #define PTR_INT_TYPE long
  142. #endif
  143.  
  144. struct _obstack_chunk        /* Lives at front of each chunk. */
  145. {
  146.   char  *limit;            /* 1 past end of this chunk */
  147.   struct _obstack_chunk *prev;    /* address of prior chunk or NULL */
  148.   char    contents[4];        /* objects begin here */
  149. };
  150.  
  151. struct obstack        /* control current object in current chunk */
  152. {
  153.   long    chunk_size;        /* preferred size to allocate chunks in */
  154.   struct _obstack_chunk* chunk;    /* address of current struct obstack_chunk */
  155.   char    *object_base;        /* address of object we are building */
  156.   char    *next_free;        /* where to add next char to current object */
  157.   char    *chunk_limit;        /* address of char after current chunk */
  158.   PTR_INT_TYPE temp;        /* Temporary for some macros.  */
  159.   int   alignment_mask;        /* Mask of alignment for each object. */
  160.   struct _obstack_chunk *(*chunkfun) (); /* User's fcn to allocate a chunk.  */
  161.   void (*freefun) ();        /* User's function to free a chunk.  */
  162.   char *extra_arg;        /* first arg for chunk alloc/dealloc funcs */
  163.   unsigned use_extra_arg:1;    /* chunk alloc/dealloc funcs take extra arg */
  164.   unsigned maybe_empty_object:1;/* There is a possibility that the current
  165.                    chunk contains a zero-length object.  This
  166.                    prevents freeing the chunk if we allocate
  167.                    a bigger chunk to replace it. */
  168. };
  169.  
  170. /* Declare the external functions we use; they are in obstack.c.  */
  171.  
  172. #ifdef __STDC__
  173. extern void _obstack_newchunk (struct obstack *, int);
  174. extern void _obstack_free (struct obstack *, void *);
  175. extern void _obstack_begin (struct obstack *, int, int,
  176.                 void *(*) (), void (*) ());
  177. extern void _obstack_begin_1 (struct obstack *, int, int,
  178.                   void *(*) (), void (*) (), void *);
  179. #else
  180. extern void _obstack_newchunk ();
  181. extern void _obstack_free ();
  182. extern void _obstack_begin ();
  183. extern void _obstack_begin_1 ();
  184. #endif
  185.  
  186. #ifdef __STDC__
  187.  
  188. /* Do the function-declarations after the structs
  189.    but before defining the macros.  */
  190.  
  191. void obstack_init (struct obstack *obstack);
  192.  
  193. void * obstack_alloc (struct obstack *obstack, int size);
  194.  
  195. void * obstack_copy (struct obstack *obstack, void *address, int size);
  196. void * obstack_copy0 (struct obstack *obstack, void *address, int size);
  197.  
  198. void obstack_free (struct obstack *obstack, void *block);
  199.  
  200. void obstack_blank (struct obstack *obstack, int size);
  201.  
  202. void obstack_grow (struct obstack *obstack, void *data, int size);
  203. void obstack_grow0 (struct obstack *obstack, void *data, i