cleanup: All the whitespace fixes, all at once.

[mLib] / alloc.h

diff --git a/alloc.h b/alloc.h
index 49e66d76beb16d9ef12117202df54b3043da4958..f55f6e856caf3b812368745994b203582e2a2667 100644 (file)
--- a/alloc.h
+++ b/alloc.h
@@ -1,13 +1,13 @@
 /* -*-c-*-
  *
- * $Id: alloc.h,v 1.4 1999/12/10 23:42:04 mdw Exp $
+ * $Id: alloc.h,v 1.7 2004/04/08 01:36:11 mdw Exp $
  *
  * Memory allocation functions
  *
  * (c) 1998 Straylight/Edgeware
  */
 
-/*----- Licensing notice --------------------------------------------------* 
+/*----- Licensing notice --------------------------------------------------*
  *
  * This file is part of the mLib utilities library.
  *
@@ -15,45 +15,93 @@
  * it under the terms of the GNU Library General Public License as
  * published by the Free Software Foundation; either version 2 of the
  * License, or (at your option) any later version.
- * 
+ *
  * mLib 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 Library General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU Library General Public
  * License along with mLib; if not, write to the Free
  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  * MA 02111-1307, USA.
  */
 
-/*----- Revision history --------------------------------------------------*
+#ifndef MLIB_ALLOC_H
+#define MLIB_ALLOC_H
+
+#ifdef __cplusplus
+  extern "C" {
+#endif
+
+/*----- Required header files ---------------------------------------------*/
+
+#include <stddef.h>
+
+#ifndef MLIB_ARENA_H
+#  include "arena.h"
+#endif
+
+/*----- Functions and macros ----------------------------------------------*/
+
+/* --- @x_alloc@ --- *
  *
- * $Log: alloc.h,v $
- * Revision 1.4  1999/12/10 23:42:04  mdw
- * Change header file guard names.
+ * Arguments:  @arena *a@ = pointer to underlying arena
+ *             @size_t sz@ = size of block to allocate
  *
- * Revision 1.3  1999/05/06 19:51:35  mdw
- * Reformatted the LGPL notice a little bit.
+ * Returns:    Pointer to allocated block.
  *
- * Revision 1.2  1999/05/05 18:50:31  mdw
- * Change licensing conditions to LGPL.
+ * Use:                Allocates memory.  If there's not enough memory, the
+ *             exception @EXC_NOMEM@ is thrown.
+ */
+
+extern void *x_alloc(arena */*a*/, size_t /*sz*/);
+
+/* --- @x_strdup@ --- *
  *
- * Revision 1.1.1.1  1998/06/17 23:44:42  mdw
- * Initial version of mLib
+ * Arguments:  @arena *a@ = pointer to underlying arena
+ *             @const char *s@ = pointer to a string
  *
+ * Returns:    Pointer to a copy of the string.
+ *
+ * Use:                Copies a string (like @strdup@ would, if it existed).  If
+ *             there's not enough memory, the exception @EXC_NOMEM@ is
+ *             thrown.
  */
 
-#ifndef MLIB_ALLOC_H
-#define MLIB_ALLOC_H
+extern char *x_strdup(arena */*a*/, const char */*s*/);
 
-#ifdef __cplusplus
-  extern "C" {
-#endif
+/* --- @x_realloc@ --- *
+ *
+ * Arguments:  @arena *a@ = pointer to underlying arena
+ *             @void *p@ = pointer to a block of memory
+ *             @size_t sz@ = new size desired for the block
+ *             @size_t osz@ = size of the old block
+ *
+ * Returns:    Pointer to the resized memory block (which is almost
+ *             certainly not in the same place any more).
+ *
+ * Use:                Resizes a memory block.  If there's not enough memory, the
+ *             exception @EXC_NOMEM@ is thrown.
+ */
 
-#include <stddef.h>
+extern void *x_realloc(arena */*a*/, void */*p*/,
+                      size_t /*sz*/, size_t /*osz*/);
+
+/* --- @x_free@ --- *
+ *
+ * Arguments:  @arena *a@ = pointer to underlying arena
+ *             @void *p@ = pointer to a block of memory.
+ *
+ * Returns:    ---
+ *
+ * Use:                Frees a block of memory.
+ */
+
+extern void x_free(arena */*a*/, void */*p*/);
+#define x_free(a, p) A_FREE(a, p)
 
-/*----- Functions provided ------------------------------------------------*/
+/*----- Old functions for the standard arena ------------------------------*/
 
 /* --- @xmalloc@ --- *
  *
@@ -66,6 +114,7 @@
  */
 
 extern void *xmalloc(size_t /*sz*/);
+#define xmalloc(sz) x_alloc(arena_global, (sz))
 
 /* --- @xstrdup@ --- *
  *
@@ -79,11 +128,13 @@ extern void *xmalloc(size_t /*sz*/);
  */
 
 extern char *xstrdup(const char */*s*/);
+#define xstrdup(p) x_strdup(arena_global, (p))
 
 /* --- @xrealloc@ --- *
  *
  * Arguments:  @void *p@ = pointer to a block of memory
  *             @size_t sz@ = new size desired for the block
+ *             @size_t osz@ = size of the old block
  *
  * Returns:    Pointer to the resized memory block (which is almost
  *             certainly not in the same place any more).
@@ -92,7 +143,20 @@ extern char *xstrdup(const char */*s*/);
  *             exception @EXC_NOMEM@ is thrown.
  */
 
-extern void *xrealloc(void */*p*/, size_t /*sz*/);
+extern void *xrealloc(void */*p*/, size_t /*sz*/, size_t /*osz*/);
+#define xrealloc(p, sz, osz) x_realloc(arena_global, (p), (sz), (osz))
+
+/* --- @xfree@ --- *
+ *
+ * Arguments:  @void *p@ = pointer to a block of memory.
+ *
+ * Returns:    ---
+ *
+ * Use:                Frees a block of memory.
+ */
+
+extern void xfree(void */*p*/);
+#define xfree(p) x_free(arena_global, (p))
 
 /*----- That's all, folks -------------------------------------------------*/