X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=include%2Fyaz%2Fxmalloc.h;h=f96cdd5d476af1725ee06e15e69f812d1b559b19;hp=ae159d1b875a2029ae034be027630cfa1137ae1c;hb=7d7e192def2fef342d235ea894eddb1e89edd714;hpb=d9ee01635f03f9095a66f71b73580560d48798e8 diff --git a/include/yaz/xmalloc.h b/include/yaz/xmalloc.h index ae159d1..f96cdd5 100644 --- a/include/yaz/xmalloc.h +++ b/include/yaz/xmalloc.h @@ -1,111 +1,152 @@ -/* - * Copyright (c) 1995-1999, Index Data. - * - * Permission to use, copy, modify, distribute, and sell this software and - * its documentation, in whole or in part, for any purpose, is hereby granted, - * provided that: - * - * 1. This copyright and permission notice appear in all copies of the - * software and its documentation. Notices of copyright or attribution - * which appear at the beginning of any file must remain unchanged. - * - * 2. The names of Index Data or the individual authors may not be used to - * endorse or promote products derived from this software without specific - * prior written permission. - * - * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND, - * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY - * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. - * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL, - * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR - * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF - * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE - * OF THIS SOFTWARE. - * - * $Log: xmalloc.h,v $ - * Revision 1.1 1999-11-30 13:47:11 adam - * Improved installation. Moved header files to include/yaz. - * - * Revision 1.6 1999/07/13 13:24:53 adam - * Updated memory debugging memory allocatation routines. - * - * Revision 1.5 1998/07/20 12:36:22 adam - * Minor changes. - * - * Revision 1.4 1997/10/31 12:20:08 adam - * Improved memory debugging for xmalloc/nmem.c. References to NMEM - * instead of ODR in n ESPEC-1 handling in source d1_espec.c. - * Bug fix: missing fclose in data1_read_espec1. - * - * Revision 1.3 1997/09/01 08:49:54 adam - * New windows NT/95 port using MSV5.0. To export DLL functions the - * YAZ_EXPORT modifier was added. Defined in yconfig.h. - * - * Revision 1.2 1997/05/14 06:53:53 adam - * C++ support. - * - * Revision 1.1 1995/11/01 11:55:41 quinn - * Added xmalloc.c - * - * Revision 1.8 1995/10/16 14:03:07 quinn - * Changes to support element set names and espec1 - * - * Revision 1.7 1994/10/05 10:15:18 quinn - * Added xrealloc. - * - * Revision 1.6 1994/09/26 16:31:24 adam - * Minor changes. xmalloc declares xcalloc now. - * - * Revision 1.5 1994/09/19 15:46:34 quinn - * Added stdlib.h - * - * Revision 1.4 1994/08/18 08:22:27 adam - * Res.h modified. xmalloc now declares xstrdup. - * - * Revision 1.3 1994/08/17 15:34:15 adam - * Initial version of resource manager. - * - * Revision 1.2 1994/08/17 14:09:48 quinn - * Small changes - * - * Revision 1.1 1994/08/17 13:39:07 adam - * Added xmalloc header. - * - * Revision 1.1 1994/08/16 16:16:02 adam - * bfile header created. +/* This file is part of the YAZ toolkit. + * Copyright (C) 1995-2011 Index Data. + * All rights reserved. + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * * Neither the name of Index Data nor the names of its contributors + * may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY + * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY + * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** + * \file xmalloc.h + * \brief Header for memory handling functions. * + * This is a set of wrapper functions for the memory allocation routines + * from stdlib.h.. Such as malloc, free, realloc etc. + * These functions calls exit if memory allocation fails. */ #ifndef XMALLOC_H #define XMALLOC_H -#include -#include +#include #include -#ifdef __cplusplus -extern "C" { -#endif +YAZ_BEGIN_CDECL +/** \brief utility macro which calls xrealloc_f */ #define xrealloc(o, x) xrealloc_f(o, x, __FILE__, __LINE__) +/** \brief utility macro which calls malloc_f */ #define xmalloc(x) xmalloc_f(x, __FILE__, __LINE__) +/** \brief utility macro which calls xcalloc_f */ #define xcalloc(x,y) xcalloc_f(x,y, __FILE__, __LINE__) +/** \brief utility macro which calls xfree_f */ #define xfree(x) xfree_f(x, __FILE__, __LINE__) +/** \brief utility macro which calls xstrdup_f */ #define xstrdup(s) xstrdup_f(s, __FILE__, __LINE__) +/** \brief utility macro which calls xstrndup_f */ +#define xstrndup(s, n) xstrndup_f(s, n, __FILE__, __LINE__) +/** \brief utility macro which calls malloc_trav_f */ #define xmalloc_trav(s) xmalloc_trav_f(s, __FILE__, __LINE__) -YAZ_EXPORT void *xrealloc_f (void *o, size_t size, const char *file, int line); -YAZ_EXPORT void *xmalloc_f (size_t size, const char *file, int line); -YAZ_EXPORT void *xcalloc_f (size_t nmemb, size_t size, - const char *file, int line); -YAZ_EXPORT char *xstrdup_f (const char *p, const char *file, int line); -YAZ_EXPORT void xfree_f (void *p, const char *file, int line); +/** \brief realloc + \param o buffer to be reallocated + \param size size of buffer to be allocated + \param file fname location of use + \param line line location of use + \returns buffer + + This function is invoked via macro xrealloc in which file and line are set + automatically. +*/ + +YAZ_EXPORT void *xrealloc_f(void *o, size_t size, const char *file, int line); +/** \brief malloc + \param size size of buffer to be allocated + \param file fname location of use + \param line line location of use + \returns buffer + + This function is invoked via macro xmalloc in which file and line are set + automatically. +*/ +YAZ_EXPORT void *xmalloc_f(size_t size, const char *file, int line); + +/** \brief calloc + \param nmemb number of members + \param size size of member + \param file fname location of use + \param line line location of use + \returns buffer + + This function is invoked via macro xcalloc in which file and line are set + automatically. +*/ +YAZ_EXPORT void *xcalloc_f(size_t nmemb, size_t size, + const char *file, int line); +/** \brief strdup + \param p string to be cloned + \param file fname location of use + \param line line location of use + \returns resulting string + + This function is invoked via macro xstrdup in which file and line are set + automatically. +*/ +YAZ_EXPORT char *xstrdup_f(const char *p, const char *file, int line); + +/** \brief strndup + \param p string to be cloned + \param n max size of resulting string (excluding 0) + \param file fname location of use + \param line line location of use + \returns resulting string + + This function is invoked via macro xstrndup in which file and line are set + automatically. +*/ +YAZ_EXPORT char *xstrndup_f(const char *p, size_t n, + const char *file, int line); + +/** \brief free + \param p string to be freed (might be NULL) + \param file fname location of use + \param line line location of use + + This function is invoked via macro xfree in which file and line are set + automatically. +*/ +YAZ_EXPORT void xfree_f(void *p, const char *file, int line); + +/** \brief logs all xmalloc buffers + \param s not used + \param file fname location of use + \param line line location of use + + This function is invoked via macro xmalloc_trav in which file and line + are set automatically. Only if TRACE_XMALLOC > 1 this function + does any real work! +*/ YAZ_EXPORT void xmalloc_trav_f(const char *s, const char *file, int line); -#ifdef __cplusplus -} -#endif +YAZ_END_CDECL #endif +/* + * Local variables: + * c-basic-offset: 4 + * c-file-style: "Stroustrup" + * indent-tabs-mode: nil + * End: + * vim: shiftwidth=4 tabstop=8 expandtab + */ +