include/yaz/nmem.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2009 Index Data.
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of Index Data nor the names of its contributors
  13  *       may be used to endorse or promote products derived from this
  14  *       software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 /**
  29  * \file
  30  * \brief Header for Nibble Memory functions
  31  *
  32  * This is a simple and fairly wasteful little module for nibble memory
  33  * allocation. Eventually we'll put in something better.
  34  */
  35 #ifndef NMEM_H
  36 #define NMEM_H
  37
  38 #include <stddef.h>
  39 #include <yaz/yconfig.h>
  40
  41 YAZ_BEGIN_CDECL
  42
  43 /** \brief NMEM handle (an opaque pointer to memory) */
  44 typedef struct nmem_control *NMEM;
  45
  46 /** \brief Set to 1 if YAZ BER integer is 64-bit ; 0 otherwise */
  47 #define NMEM_64 0
  48
  49 #if NMEM_64
  50 /** \brief BER/utility integer (64-bit or more) */
  51 typedef long long int nmem_int_t;
  52 /** \brief printf format for nmem_int_t type */
  53 #define NMEM_INT_PRINTF "%lld"
  54 #else
  55 /** \brief BER/utility integer (32-bit on most platforms) */
  56 typedef int nmem_int_t;
  57 /** \brief printf format for nmem_int_t type */
  58 #define NMEM_INT_PRINTF "%d"
  59 #endif
  60
  61 /** \brief BER/utility boolean */
  62 typedef int nmem_bool_t;
  63
  64 /** \brief releases memory associaged with an NMEM handle
  65     \param n NMEM handle
  66 */
  67 YAZ_EXPORT void nmem_reset(NMEM n);
  68
  69 /** \brief returns size in bytes of memory for NMEM handle
  70     \returns number of bytes
  71  */
  72 YAZ_EXPORT int nmem_total(NMEM n);
  73
  74 /** \brief allocates string on NMEM handle (similar strdup)
  75     \param mem HNEM handle
  76     \param src string
  77     \returns duplicated string
  78  */
  79 YAZ_EXPORT char *nmem_strdup(NMEM mem, const char *src);
  80 /** \brief allocates string on NMEM handle - allows NULL ptr buffer
  81     \param mem HNEM handle
  82     \param src string
  83     \returns duplicated string or NULL if src was NULL
  84  */
  85 YAZ_EXPORT char *nmem_strdup_null(NMEM mem, const char *src);
  86
  87 /** \brief allocates string of certain size on NMEM handle
  88     \param mem NMEM handle
  89     \param src string
  90     \param n size of string
  91     \returns duplicated string (0 terminated)
  92  */
  93 YAZ_EXPORT char *nmem_strdupn(NMEM mem, const char *src, size_t n);
  94
  95 /** \brief allocates sub strings out of string using certain delimitors
  96     \param nmem NMEM handle
  97     \param delim delimitor chars (splits on each char in there)
  98     \param dstr string to be split
  99     \param darray result string array for each sub string
 100     \param num number of result strings
 101 */
 102 YAZ_EXPORT void nmem_strsplit(NMEM nmem, const char *delim,
 103                               const char *dstr,
 104                               char ***darray, int *num);
 105
 106 /** \brief splits string into sub strings delimited by blanks
 107     \param nmem NMEM handle
 108     \param dstr string to be split
 109     \param darray result string array for each sub string
 110     \param num number of result strings
 111 */
 112 YAZ_EXPORT void nmem_strsplit_blank(NMEM nmem, const char *dstr,
 113                                     char ***darray, int *num);
 114
 115 /** \brief allocates and sets integer for NMEM
 116     \param nmem NMEM handle
 117     \param v integer value
 118     \returns pointer to created integer
 119 */
 120 YAZ_EXPORT nmem_int_t *nmem_intdup(NMEM nmem, nmem_int_t v);
 121
 122 /** \brief allocates and sets boolean for NMEM
 123     \param nmem NMEM handle
 124     \param v value (0=false, != 0 true)
 125     \returns pointer to created boolean
 126 */
 127 YAZ_EXPORT nmem_bool_t *nmem_booldup(NMEM nmem, nmem_bool_t v);
 128
 129 /** \brief transfers memory from one NMEM handle to another
 130     \param src source NMEM handle
 131     \param dst destination NMEM handle
 132  */
 133 YAZ_EXPORT void nmem_transfer(NMEM dst, NMEM src);
 134
 135 /** \brief returns new NMEM handle
 136     \returns NMEM handle
 137  */
 138 YAZ_EXPORT NMEM nmem_create(void);
 139
 140 /** \brief destroys NMEM handle and memory associated with it
 141     \param n NMEM handle
 142  */
 143 YAZ_EXPORT void nmem_destroy(NMEM n);
 144
 145 /** \brief allocates memory block on NMEM handle
 146     \param n NMEM handle
 147     \param size number of bytes to be allocated
 148     \returns pointer to allocated memory
 149  */
 150 YAZ_EXPORT void *nmem_malloc(NMEM n, int size);
 151
 152 YAZ_END_CDECL
 153
 154 #endif
 155 /*
 156  * Local variables:
 157  * c-basic-offset: 4
 158  * c-file-style: "Stroustrup"
 159  * indent-tabs-mode: nil
 160  * End:
 161  * vim: shiftwidth=4 tabstop=8 expandtab
 162  */
 163