[mLib] / alloc.h

/* -*-c-*-
 *
 * $Id: alloc.h,v 1.2 1999/05/05 18:50:31 mdw Exp $
 *
 * Memory allocation functions
 *
 * (c) 1998 Straylight/Edgeware
 */

/*----- Licensing notice --------------------------------------------------* 
 *
 * This file is part of the mLib utilities library.
 *
 * mLib is free software; you can redistribute it and/or modify
 * 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 --------------------------------------------------*
 *
 * $Log: alloc.h,v $
 * Revision 1.2  1999/05/05 18:50:31  mdw
 * Change licensing conditions to LGPL.
 *
 * Revision 1.1.1.1  1998/06/17 23:44:42  mdw
 * Initial version of mLib
 *
 */

#ifndef ALLOC_H
#define ALLOC_H

#ifdef __cplusplus
  extern "C" {
#endif

#include <stddef.h>

/*----- Functions provided ------------------------------------------------*/

/* --- @xmalloc@ --- *
 *
 * Arguments:	@size_t sz@ = size of block to allocate
 *
 * Returns:	Pointer to allocated block.
 *
 * Use:		Allocates memory.  If there's not enough memory, the
 *		exception @EXC_NOMEM@ is thrown.
 */

extern void *xmalloc(size_t /*sz*/);

/* --- @xstrdup@ --- *
 *
 * Arguments:	@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.
 */

extern char *xstrdup(const char */*s*/);

/* --- @xrealloc@ --- *
 *
 * Arguments:	@void *p@ = pointer to a block of memory
 *		@size_t sz@ = new size desired for the 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.
 */

extern void *xrealloc(void */*p*/, size_t /*sz*/);

/*----- That's all, folks -------------------------------------------------*/

#ifdef __cplusplus
  }
#endif

#endif
Commit	Line	Data
0875b58f	1	/* --c--
0875b58f	2	*
c846879c	3	* $Id: alloc.h,v 1.2 1999/05/05 18:50:31 mdw Exp $
0875b58f	4	*
	5	* Memory allocation functions
	6	*
	7	* (c) 1998 Straylight/Edgeware
	8	*/
	9
c846879c	10	/----- Licensing notice --------------------------------------------------
0875b58f	11	*
	12	* This file is part of the mLib utilities library.
	13	*
	14	* mLib is free software; you can redistribute it and/or modify
c846879c	15	* it under the terms of the GNU Library General Public License as
	16	* published by the Free Software Foundation; either version 2 of the
	17	* License, or (at your option) any later version.
	18	*
0875b58f	19	* mLib is distributed in the hope that it will be useful,
	20	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	21	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
c846879c	22	* GNU Library General Public License for more details.
	23	*
	24	* You should have received a copy of the GNU Library General Public
	25	* License along with mLib; if not, write to the Free Software
	26	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
0875b58f	27	*/
	28
	29	/----- Revision history --------------------------------------------------
	30	*
	31	* $Log: alloc.h,v $
c846879c	32	* Revision 1.2 1999/05/05 18:50:31 mdw
	33	* Change licensing conditions to LGPL.
	34	*
	35	* Revision 1.1.1.1 1998/06/17 23:44:42 mdw
	36	* Initial version of mLib
0875b58f	37	*
	38	*/
	39
	40	#ifndef ALLOC_H
	41	#define ALLOC_H
	42
	43	#ifdef __cplusplus
	44	extern "C" {
	45	#endif
	46
	47	#include <stddef.h>
	48
	49	/----- Functions provided ------------------------------------------------/
	50
	51	/* --- @xmalloc@ --- *
	52	*
	53	* Arguments: @size_t sz@ = size of block to allocate
	54	*
	55	* Returns: Pointer to allocated block.
	56	*
	57	* Use: Allocates memory. If there's not enough memory, the
	58	* exception @EXC_NOMEM@ is thrown.
	59	*/
	60
	61	extern void xmalloc(size_t /sz*/);
	62
	63	/* --- @xstrdup@ --- *
	64	*
	65	* Arguments: @const char *s@ = pointer to a string
	66	*
	67	* Returns: Pointer to a copy of the string.
	68	*
	69	* Use: Copies a string (like @strdup@ would, if it existed). If
	70	* there's not enough memory, the exception @EXC_NOMEM@ is
	71	* thrown.
	72	*/
	73
	74	extern char xstrdup(const char /s/);
	75
	76	/* --- @xrealloc@ --- *
	77	*
	78	* Arguments: @void *p@ = pointer to a block of memory
	79	* @size_t sz@ = new size desired for the block
	80	*
	81	* Returns: Pointer to the resized memory block (which is almost
	82	* certainly not in the same place any more).
	83	*
	84	* Use: Resizes a memory block. If there's not enough memory, the
	85	* exception @EXC_NOMEM@ is thrown.
	86	*/
	87
	88	extern void xrealloc(void /p/, size_t /sz/);
	89
	90	/----- That's all, folks -------------------------------------------------/
	91
	92	#ifdef __cplusplus
	93	}
	94	#endif
	95
	96	#endif