include/yaz/nmem.h

   1 /*
   2  * Copyright (C) 1995-2005, Index Data ApS
   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  * $Id: nmem.h,v 1.19 2006-05-03 13:04:46 adam Exp $
  27  */
  28
  29 /**
  30  * \file nmem.h
  31  * \brief Header for Nibble Memory functions
  32  *
  33  * This is a simple and fairly wasteful little module for nibble memory
  34  * allocation. Evemtually we'll put in something better.
  35  */
  36 #ifndef NMEM_H
  37 #define NMEM_H
  38
  39 #include <stddef.h>
  40 #include <yaz/yconfig.h>
  41
  42 #define NMEM_DEBUG 0
  43
  44 #ifndef NMEM_DEBUG
  45 #define NMEM_DEBUG 0
  46 #endif
  47
  48 YAZ_BEGIN_CDECL
  49
  50 typedef struct nmem_block nmem_block;
  51
  52 typedef struct nmem_control nmem_control;
  53
  54 typedef struct nmem_mutex *NMEM_MUTEX;
  55 YAZ_EXPORT void nmem_mutex_create(NMEM_MUTEX *);
  56 YAZ_EXPORT void nmem_mutex_enter(NMEM_MUTEX);
  57 YAZ_EXPORT void nmem_mutex_leave(NMEM_MUTEX);
  58 YAZ_EXPORT void nmem_mutex_destroy(NMEM_MUTEX *);
  59
  60 typedef struct nmem_control *NMEM;
  61
  62 YAZ_EXPORT void nmem_reset(NMEM n);
  63 YAZ_EXPORT int nmem_total(NMEM n);
  64 YAZ_EXPORT char *nmem_strdup (NMEM mem, const char *src);
  65 YAZ_EXPORT char *nmem_strdup_null (NMEM mem, const char *src);
  66 YAZ_EXPORT char *nmem_strdupn (NMEM mem, const char *src, size_t n);
  67 YAZ_EXPORT void nmem_strsplit_blank(NMEM nmem, const char *dstr,
  68                                     char ***darray, int *num);
  69 YAZ_EXPORT void nmem_strsplit(NMEM nmem, const char *delim,
  70                               const char *dstr,
  71                               char ***darray, int *num);
  72 YAZ_EXPORT char *nmem_text_node_cdata(const void *ptr_cdata, NMEM nmem);
  73
  74 YAZ_EXPORT int *nmem_intdup (NMEM mem, int v);
  75 YAZ_EXPORT void nmem_transfer (NMEM dst, NMEM src);
  76
  77 YAZ_EXPORT void nmem_critical_enter (void);
  78 YAZ_EXPORT void nmem_critical_leave (void);
  79
  80 #if NMEM_DEBUG
  81
  82 YAZ_EXPORT NMEM nmem_create_f(const char *file, int line);
  83 YAZ_EXPORT void nmem_destroy_f(const char *file, int line, NMEM n);
  84 YAZ_EXPORT void *nmem_malloc_f(const char *file, int line, NMEM n, int size);
  85 #define nmem_create() nmem_create_f(__FILE__, __LINE__)
  86 #define nmem_destroy(x) nmem_destroy_f(__FILE__, __LINE__, (x))
  87 #define nmem_malloc(x, y) nmem_malloc_f(__FILE__, __LINE__, (x), (y))
  88
  89 YAZ_EXPORT void nmem_print_list (void);
  90 YAZ_EXPORT void nmem_print_list_l (int level);
  91
  92 #else
  93
  94 YAZ_EXPORT NMEM nmem_create(void);
  95 YAZ_EXPORT void nmem_destroy(NMEM n);
  96 YAZ_EXPORT void *nmem_malloc(NMEM n, int size);
  97
  98 #define nmem_print_list()
  99
 100 #endif
 101
 102 YAZ_EXPORT void nmem_init (void);
 103 YAZ_EXPORT void nmem_exit (void);
 104 YAZ_EXPORT int yaz_errno (void);
 105 YAZ_EXPORT void yaz_set_errno (int v);
 106 YAZ_EXPORT void yaz_strerror(char *buf, int max);
 107
 108 YAZ_END_CDECL
 109
 110 #endif
 111 /*
 112  * Local variables:
 113  * c-basic-offset: 4
 114  * indent-tabs-mode: nil
 115  * End:
 116  * vim: shiftwidth=4 tabstop=8 expandtab
 117  */
 118