pool: New function pool_strdup0.
[pspp-builds.git] / src / libpspp / pool.h
index daa866b356110fbc74f4ec313047b1bad8782d14..fc24b2f9e6ff0ae38221a2ac7f9d3bba60aa8fbf 100644 (file)
@@ -1,26 +1,26 @@
-/* PSPP - computes sample statistics.
-   Copyright (C) 2000 Free Software Foundation, Inc.
-   Written by Ben Pfaff <blp@gnu.org>.
+/* PSPP - a program for statistical analysis.
+   Copyright (C) 2000, 2006 Free Software Foundation, Inc.
 
-   This program is free software; you can redistribute it and/or
-   modify it under the terms of the GNU General Public License as
-   published by the Free Software Foundation; either version 2 of the
-   License, or (at your option) any later version.
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 3 of the License, 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
-   General Public License for more details.
+   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 General Public License for more details.
 
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
-   02110-1301, USA. */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
 
 #if !pool_h
 #define pool_h 1
 
+#include <stdarg.h>
 #include <stdio.h>
+#include <stdbool.h>
+#include "compiler.h"
 
 /* Maximum size of a suballocated block.  Larger blocks are allocated
    directly with malloc() to avoid memory wastage at the end of a
@@ -31,7 +31,7 @@
 
 
 /* Records the state of a pool for later restoration. */
-struct pool_mark 
+struct pool_mark
   {
     /* Current block and offset into it. */
     struct pool_block *block;
@@ -62,11 +62,17 @@ void *pool_clone (struct pool *, const void *, size_t) MALLOC_LIKE;
 void *pool_alloc_unaligned (struct pool *, size_t) MALLOC_LIKE;
 void *pool_clone_unaligned (struct pool *, const void *, size_t) MALLOC_LIKE;
 char *pool_strdup (struct pool *, const char *) MALLOC_LIKE;
-char *pool_strcat (struct pool *, const char *, ...) MALLOC_LIKE;
+char *pool_strdup0 (struct pool *, const char *, size_t) MALLOC_LIKE;
+char *pool_vasprintf (struct pool *, const char *, va_list)
+     MALLOC_LIKE PRINTF_FORMAT (2, 0);
+char *pool_asprintf (struct pool *, const char *, ...)
+     MALLOC_LIKE PRINTF_FORMAT (2, 3);
 
 /* Standard allocation routines. */
 void *pool_malloc (struct pool *, size_t) MALLOC_LIKE;
 void *pool_nmalloc (struct pool *, size_t n, size_t s) MALLOC_LIKE;
+void *pool_zalloc (struct pool *, size_t) MALLOC_LIKE;
+void *pool_calloc (struct pool *, size_t n, size_t s) MALLOC_LIKE;
 void *pool_realloc (struct pool *, void *, size_t);
 void *pool_nrealloc (struct pool *, void *, size_t n, size_t s);
 void *pool_2nrealloc (struct pool *, void *, size_t *pn, size_t s);
@@ -78,20 +84,20 @@ void pool_add_subpool (struct pool *, struct pool *subpool);
 
 /* Files. */
 FILE *pool_fopen (struct pool *, const char *, const char *);
-int pool_fclose (struct pool *, FILE *);
+int pool_fclose (struct pool *, FILE *) WARN_UNUSED_RESULT;
 FILE *pool_tmpfile (struct pool *);
 void pool_attach_file (struct pool *, FILE *);
 void pool_detach_file (struct pool *, FILE *);
 
 /* Custom allocations. */
 void pool_register (struct pool *, void (*free) (void *), void *p);
-int pool_unregister (struct pool *, void *);
+bool pool_unregister (struct pool *, void *);
 
 /* Partial freeing. */
 void pool_mark (struct pool *, struct pool_mark *);
 void pool_release (struct pool *, const struct pool_mark *);
 
-#if GLOBAL_DEBUGGING
+#if DEBUGGING
 void pool_dump (const struct pool *, const char *title);
 #endif