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 releases memory associaged with an NMEM handle
  47     \param n NMEM handle
  48 */
  49 YAZ_EXPORT void nmem_reset(NMEM n);
  50
  51 /** \brief returns size in bytes of memory for NMEM handle
  52     \returns number of bytes
  53  */
  54 YAZ_EXPORT int nmem_total(NMEM n);
  55
  56 /** \brief allocates string on NMEM handle (similar strdup)
  57     \param mem HNEM handle
  58     \param src string
  59     \returns duplicated string
  60  */
  61 YAZ_EXPORT char *nmem_strdup(NMEM mem, const char *src);
  62 /** \brief allocates string on NMEM handle - allows NULL ptr buffer
  63     \param mem HNEM handle
  64     \param src string
  65     \returns duplicated string or NULL if src was NULL
  66  */
  67 YAZ_EXPORT char *nmem_strdup_null(NMEM mem, const char *src);
  68
  69 /** \brief allocates string of certain size on NMEM handle
  70     \param mem NMEM handle
  71     \param src string
  72     \param n size of string
  73     \returns duplicated string (0 terminated)
  74  */
  75 YAZ_EXPORT char *nmem_strdupn(NMEM mem, const char *src, size_t n);
  76
  77 /** \brief allocates sub strings out of string using certain delimitors
  78     \param nmem NMEM handle
  79     \param delim delimitor chars (splits on each char in there)
  80     \param dstr string to be split
  81     \param darray result string array for each sub string
  82     \param num number of result strings
  83 */
  84 YAZ_EXPORT void nmem_strsplit(NMEM nmem, const char *delim,
  85                               const char *dstr,
  86                               char ***darray, int *num);
  87
  88 /** \brief splits string into sub strings delimited by blanks
  89     \param nmem NMEM handle
  90     \param dstr string to be split
  91     \param darray result string array for each sub string
  92     \param num number of result strings
  93 */
  94 YAZ_EXPORT void nmem_strsplit_blank(NMEM nmem, const char *dstr,
  95                                     char ***darray, int *num);
  96
  97 /** \brief allocates integer for NMEM
  98     \param nmem NMEM handle
  99     \param v integer value
 100     \returns pointer to created integer
 101 */
 102 YAZ_EXPORT int *nmem_intdup(NMEM nmem, int v);
 103
 104 /** \brief transfers memory from one NMEM handle to another
 105     \param src source NMEM handle
 106     \param dst destination NMEM handle
 107  */
 108 YAZ_EXPORT void nmem_transfer(NMEM dst, NMEM src);
 109
 110 /** \brief returns new NMEM handle
 111     \returns NMEM handle
 112  */
 113 YAZ_EXPORT NMEM nmem_create(void);
 114
 115 /** \brief destroys NMEM handle and memory associated with it
 116     \param n NMEM handle
 117  */
 118 YAZ_EXPORT void nmem_destroy(NMEM n);
 119
 120 /** \brief allocates memory block on NMEM handle
 121     \param n NMEM handle
 122     \param size number of bytes to be allocated
 123     \returns pointer to allocated memory
 124  */
 125 YAZ_EXPORT void *nmem_malloc(NMEM n, int size);
 126
 127 YAZ_END_CDECL
 128
 129 #endif
 130 /*
 131  * Local variables:
 132  * c-basic-offset: 4
 133  * c-file-style: "Stroustrup"
 134  * indent-tabs-mode: nil
 135  * End:
 136  * vim: shiftwidth=4 tabstop=8 expandtab
 137  */
 138