src/pool.h

   1 /* PSPP - computes sample statistics.
   2    Copyright (C) 2000 Free Software Foundation, Inc.
   3    Written by Ben Pfaff <blp@gnu.org>.
   4
   5    This program is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU General Public License as
   7    published by the Free Software Foundation; either version 2 of the
   8    License, or (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful, but
  11    WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software
  17    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  18    02111-1307, USA. */
  19
  20 #if !pool_h
  21 #define pool_h 1
  22
  23 #include <stdio.h>
  24
  25 /* Records the state of a pool for later restoration. */
  26 struct pool_mark
  27   {
  28     /* Current block and offset into it. */
  29     struct pool_block *block;
  30     size_t ofs;
  31
  32     /* Current serial number to allow freeing of gizmos. */
  33     long serial;
  34   };
  35
  36 /* General routines. */
  37 struct pool *pool_create (void);
  38 void pool_destroy (struct pool *);
  39 void pool_clear (struct pool *);
  40
  41 /* Suballocation routines. */
  42 void *pool_alloc (struct pool *, size_t);
  43 char *pool_strdup (struct pool *, const char *);
  44 char *pool_strndup (struct pool *, const char *, size_t);
  45 char *pool_strcat (struct pool *, const char *, ...);
  46
  47 /* Standard allocation routines. */
  48 void *pool_malloc (struct pool *, size_t);
  49 void *pool_realloc (struct pool *, void *, size_t);
  50 void pool_free (struct pool *, void *);
  51
  52 /* Gizmo allocations. */
  53 struct pool *pool_create_subpool (struct pool *);
  54 FILE *pool_fopen (struct pool *, const char *, const char *);
  55 int pool_fclose (struct pool *, FILE *);
  56
  57 /* Custom allocations. */
  58 void pool_register (struct pool *, void (*free) (void *), void *p);
  59 int pool_unregister (struct pool *, void *);
  60
  61 /* Partial freeing. */
  62 void pool_mark (struct pool *, struct pool_mark *);
  63 void pool_release (struct pool *, const struct pool_mark *);
  64
  65 #if GLOBAL_DEBUGGING
  66 void pool_dump (const struct pool *, const char *title);
  67 #endif
  68
  69 #endif /* pool.h */