include/yaz/nmem.h

   1 /*
   2  * Copyright (c) 1995-2007, 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 /* $Id: nmem.h,v 1.25 2007-04-17 20:26:18 adam Exp $ */
  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 YAZ_BEGIN_CDECL
  43
  44 /** \brief NMEM handle (an opaque pointer to memory) */
  45 typedef struct nmem_control *NMEM;
  46
  47 /** \brief release all memory associaged with an NMEM handle */
  48 YAZ_EXPORT void nmem_reset(NMEM n);
  49 /** \brief returns size in bytes of memory for NMEM handle */
  50 YAZ_EXPORT int nmem_total(NMEM n);
  51
  52 /** \brief allocates string on NMEM handle (similar strdup) */
  53 YAZ_EXPORT char *nmem_strdup (NMEM mem, const char *src);
  54 /** \brief allocates string on NMEM handle - allows NULL ptr buffer */
  55 YAZ_EXPORT char *nmem_strdup_null (NMEM mem, const char *src);
  56 /** \brief allocates string of certain size on NMEM handle */
  57 YAZ_EXPORT char *nmem_strdupn (NMEM mem, const char *src, size_t n);
  58
  59 /** \brief allocates sub strings out of string using certain delimitors
  60     \param nmem NMEM handle
  61     \param delim delimitor chars (splits on each char in there)
  62     \param dstr string to be split
  63     \param darray result string array for each sub string
  64     \param num number of result strings
  65 */
  66 YAZ_EXPORT void nmem_strsplit(NMEM nmem, const char *delim,
  67                               const char *dstr,
  68                               char ***darray, int *num);
  69
  70 /** \brief splits string into sub strings delimited by blanks
  71     \param nmem NMEM handle
  72     \param dstr string to be split
  73     \param darray result string array for each sub string
  74     \param num number of result strings
  75 */
  76 YAZ_EXPORT void nmem_strsplit_blank(NMEM nmem, const char *dstr,
  77                                     char ***darray, int *num);
  78
  79 /** \brief creates and allocates integer for NMEM */
  80 YAZ_EXPORT int *nmem_intdup (NMEM mem, int v);
  81
  82 /** \brief transfers memory from one NMEM handle to another  */
  83 YAZ_EXPORT void nmem_transfer (NMEM dst, NMEM src);
  84
  85 /** \brief returns new NMEM handle */
  86 YAZ_EXPORT NMEM nmem_create(void);
  87
  88 /** \brief destroys NMEM handle and memory associated with it */
  89 YAZ_EXPORT void nmem_destroy(NMEM n);
  90
  91 /** \brief allocate memory block on NMEM handle */
  92 YAZ_EXPORT void *nmem_malloc(NMEM n, int size);
  93
  94 YAZ_EXPORT int yaz_errno (void);
  95 YAZ_EXPORT void yaz_set_errno (int v);
  96 YAZ_EXPORT void yaz_strerror(char *buf, int max);
  97
  98 YAZ_END_CDECL
  99
 100 #endif
 101 /*
 102  * Local variables:
 103  * c-basic-offset: 4
 104  * indent-tabs-mode: nil
 105  * End:
 106  * vim: shiftwidth=4 tabstop=8 expandtab
 107  */
 108