checkin of 0.3.0
[pspp-builds.git] / 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
40 /* Suballocation routines. */
41 void *pool_alloc (struct pool *, size_t);
42 char *pool_strdup (struct pool *, const char *);
43 char *pool_strcat (struct pool *, const char *, ...);
44
45 /* Standard allocation routines. */
46 void *pool_malloc (struct pool *, size_t);
47 void *pool_realloc (struct pool *, void *, size_t);
48 void pool_free (struct pool *, void *);
49
50 /* Gizmo allocations. */
51 struct pool *pool_create_subpool (struct pool *);
52 FILE *pool_fopen (struct pool *, const char *, const char *);
53 int pool_fclose (struct pool *, FILE *);
54
55 /* Custom allocations. */
56 void pool_register (struct pool *, void (*free) (void *), void *p);
57 int pool_unregister (struct pool *, void *);
58
59 /* Partial freeing. */
60 void pool_mark (struct pool *, struct pool_mark *);
61 void pool_release (struct pool *, const struct pool_mark *);
62
63 #if GLOBAL_DEBUGGING
64 void pool_dump (const struct pool *, const char *title);
65 #endif
66
67 #endif /* pool.h */