include/nmem.h

   1 /*
   2  * Copyright (c) 1995-1998, Index Data.
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and
   5  * its documentation, in whole or in part, for any purpose, is hereby granted,
   6  * provided that:
   7  *
   8  * 1. This copyright and permission notice appear in all copies of the
   9  * software and its documentation. Notices of copyright or attribution
  10  * which appear at the beginning of any file must remain unchanged.
  11  *
  12  * 2. The names of Index Data or the individual authors may not be used to
  13  * endorse or promote products derived from this software without specific
  14  * prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  18  * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  19  * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
  20  * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
  21  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
  22  * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
  23  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  24  * OF THIS SOFTWARE.
  25  *
  26  * $Log: nmem.h,v $
  27  * Revision 1.8  1998-07-20 12:35:59  adam
  28  * Added more memory diagnostics (when NMEM_DEBUG is 1).
  29  *
  30  * Revision 1.7  1997/10/31 12:20:08  adam
  31  * Improved memory debugging for xmalloc/nmem.c. References to NMEM
  32  * instead of ODR in n ESPEC-1 handling in source d1_espec.c.
  33  * Bug fix: missing fclose in data1_read_espec1.
  34  *
  35  */
  36
  37 #ifndef NMEM_H
  38 #define NMEM_H
  39 #include <yconfig.h>
  40
  41 #define NMEM_DEBUG 0
  42
  43 #ifndef NMEM_DEBUG
  44 #define NMEM_DEBUG 0
  45 #endif
  46
  47 #ifdef __cplusplus
  48 extern "C" {
  49 #endif
  50
  51 typedef struct nmem_block
  52 {
  53     char *buf;              /* memory allocated in this block */
  54     int size;               /* size of buf */
  55     int top;                /* top of buffer */
  56     struct nmem_block *next;
  57 } nmem_block;
  58
  59 typedef struct nmem_control
  60 {
  61     int total;
  62     nmem_block *blocks;
  63     struct nmem_control *next;
  64 } nmem_control;
  65
  66 typedef struct nmem_control *NMEM;
  67
  68 YAZ_EXPORT void nmem_reset(NMEM n);
  69 YAZ_EXPORT int nmem_total(NMEM n);
  70 YAZ_EXPORT char *nmem_strdup (NMEM mem, const char *src);
  71
  72 #if NMEM_DEBUG
  73
  74 YAZ_EXPORT NMEM nmem_create_f(const char *file, int line);
  75 YAZ_EXPORT void nmem_destroy_f(const char *file, int line, NMEM n);
  76 YAZ_EXPORT void *nmem_malloc_f(const char *file, int line, NMEM n, int size);
  77 #define nmem_create() nmem_create_f(__FILE__, __LINE__)
  78 #define nmem_destroy(x) nmem_destroy_f(__FILE__, __LINE__, (x))
  79 #define nmem_malloc(x, y) nmem_malloc_f(__FILE__, __LINE__, (x), (y))
  80
  81 #else
  82
  83 YAZ_EXPORT NMEM nmem_create(void);
  84 YAZ_EXPORT void nmem_destroy(NMEM n);
  85 YAZ_EXPORT void *nmem_malloc(NMEM n, int size);
  86
  87 #endif
  88
  89 YAZ_EXPORT void nmem_init (void);
  90 YAZ_EXPORT void nmem_exit (void);
  91 #ifdef __cplusplus
  92 }
  93 #endif
  94
  95 #endif