X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=include%2Fyaz%2Fnmem.h;h=c12ddc090a7ff4296c483f2b38a96170d5117ca3;hp=595156b87107499f7c507f43246a8b7d2f6392cb;hb=7d7e192def2fef342d235ea894eddb1e89edd714;hpb=588af2e484a5a48afac3069578959437c9b3271e diff --git a/include/yaz/nmem.h b/include/yaz/nmem.h index 595156b..c12ddc0 100644 --- a/include/yaz/nmem.h +++ b/include/yaz/nmem.h @@ -1,116 +1,185 @@ -/* - * Copyright (c) 1995-2000, Index Data. - * - * Permission to use, copy, modify, distribute, and sell this software and - * its documentation, in whole or in part, for any purpose, is hereby granted, - * provided that: - * - * 1. This copyright and permission notice appear in all copies of the - * software and its documentation. Notices of copyright or attribution - * which appear at the beginning of any file must remain unchanged. - * - * 2. The names of Index Data or the individual authors may not be used to - * endorse or promote products derived from this software without specific - * prior written permission. - * - * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND, - * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY - * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. - * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL, - * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR - * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF - * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE - * OF THIS SOFTWARE. - * - * $Log: nmem.h,v $ - * Revision 1.3 2000-05-09 10:55:05 adam - * Public nmem_print_list (for debugging). - * - * Revision 1.2 2000/02/28 11:20:06 adam - * Using autoconf. New definitions: YAZ_BEGIN_CDECL/YAZ_END_CDECL. - * - * Revision 1.1 1999/11/30 13:47:11 adam - * Improved installation. Moved header files to include/yaz. - * - * Revision 1.10 1998/10/19 15:24:20 adam - * New nmem utility, nmem_transfer, that transfer blocks from one - * NMEM to another. - * - * Revision 1.9 1998/10/13 16:00:17 adam - * Implemented nmem_critical_{enter,leave}. - * - * Revision 1.8 1998/07/20 12:35:59 adam - * Added more memory diagnostics (when NMEM_DEBUG is 1). +/* This file is part of the YAZ toolkit. + * Copyright (C) 1995-2011 Index Data. + * All rights reserved. + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: * - * Revision 1.7 1997/10/31 12:20:08 adam - * Improved memory debugging for xmalloc/nmem.c. References to NMEM - * instead of ODR in n ESPEC-1 handling in source d1_espec.c. - * Bug fix: missing fclose in data1_read_espec1. + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * * Neither the name of Index Data nor the names of its contributors + * may be used to endorse or promote products derived from this + * software without specific prior written permission. * + * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY + * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY + * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * \file + * \brief Header for Nibble Memory functions + * + * This is a simple and fairly wasteful little module for nibble memory + * allocation. Eventually we'll put in something better. + */ #ifndef NMEM_H #define NMEM_H + +#include #include -#define NMEM_DEBUG 1 +YAZ_BEGIN_CDECL -#ifndef NMEM_DEBUG -#define NMEM_DEBUG 0 -#endif +/** \brief NMEM handle (an opaque pointer to memory) */ +typedef struct nmem_control *NMEM; -YAZ_BEGIN_CDECL +/** \brief Set to 1 if YAZ BER integer is 64-bit ; 0 otherwise */ +#ifndef NMEM_64 +#define NMEM_64 1 +#endif -typedef struct nmem_block -{ - char *buf; /* memory allocated in this block */ - int size; /* size of buf */ - int top; /* top of buffer */ - struct nmem_block *next; -} nmem_block; - -typedef struct nmem_control -{ - int total; - nmem_block *blocks; - struct nmem_control *next; -} nmem_control; +#if NMEM_64 -typedef struct nmem_control *NMEM; +#ifdef _MSC_VER +/* Visual Studio. 6.0 and later supports this */ +typedef __int64 nmem_int_t; +#define NMEM_INT_PRINTF "%I64d" +#else +/* C99 */ +typedef long long int nmem_int_t; +#define NMEM_INT_PRINTF "%lld" +#endif -YAZ_EXPORT void nmem_reset(NMEM n); -YAZ_EXPORT int nmem_total(NMEM n); -YAZ_EXPORT char *nmem_strdup (NMEM mem, const char *src); -YAZ_EXPORT void nmem_transfer (NMEM dst, NMEM src); +#else +/** \brief BER/utility integer (32-bit on most platforms) */ +typedef int nmem_int_t; +/** \brief printf format for nmem_int_t type */ +#define NMEM_INT_PRINTF "%d" +#endif -YAZ_EXPORT void nmem_critical_enter (void); -YAZ_EXPORT void nmem_critical_leave (void); +/** \brief BER/utility boolean */ +typedef int nmem_bool_t; -#if NMEM_DEBUG +/** \brief releases memory associaged with an NMEM handle + \param n NMEM handle +*/ +YAZ_EXPORT void nmem_reset(NMEM n); -YAZ_EXPORT NMEM nmem_create_f(const char *file, int line); -YAZ_EXPORT void nmem_destroy_f(const char *file, int line, NMEM n); -YAZ_EXPORT void *nmem_malloc_f(const char *file, int line, NMEM n, int size); -#define nmem_create() nmem_create_f(__FILE__, __LINE__) -#define nmem_destroy(x) nmem_destroy_f(__FILE__, __LINE__, (x)) -#define nmem_malloc(x, y) nmem_malloc_f(__FILE__, __LINE__, (x), (y)) +/** \brief returns size in bytes of memory for NMEM handle + \returns number of bytes + */ +YAZ_EXPORT size_t nmem_total(NMEM n); -YAZ_EXPORT void nmem_print_list (void); +/** \brief allocates string on NMEM handle (similar strdup) + \param mem HNEM handle + \param src string + \returns duplicated string + */ +YAZ_EXPORT char *nmem_strdup(NMEM mem, const char *src); +/** \brief allocates string on NMEM handle - allows NULL ptr buffer + \param mem HNEM handle + \param src string + \returns duplicated string or NULL if src was NULL + */ +YAZ_EXPORT char *nmem_strdup_null(NMEM mem, const char *src); -#else +/** \brief allocates string of certain size on NMEM handle + \param mem NMEM handle + \param src string + \param n size of string + \returns duplicated string (0 terminated) + */ +YAZ_EXPORT char *nmem_strdupn(NMEM mem, const char *src, size_t n); + +/** \brief allocates sub strings out of string using certain delimitors + \param nmem NMEM handle + \param delim delimitor chars (splits on each char in there) + \param dstr string to be split + \param darray result string array for each sub string + \param num number of result strings +*/ +YAZ_EXPORT void nmem_strsplit(NMEM nmem, const char *delim, + const char *dstr, + char ***darray, int *num); + +/** \brief allocates sub strings out of string using certain delimitors + \param nmem NMEM handle + \param delim delimitor chars (splits on each char in there) + \param dstr string to be split + \param darray result string array for each sub string + \param num number of result strings + \param collapse 1=collapse multiple delims to one; 0=no collapse +*/ +YAZ_EXPORT void nmem_strsplitx(NMEM nmem, const char *delim, + const char *dstr, + char ***darray, int *num, + int collapse); + +/** \brief splits string into sub strings delimited by blanks + \param nmem NMEM handle + \param dstr string to be split + \param darray result string array for each sub string + \param num number of result strings +*/ +YAZ_EXPORT void nmem_strsplit_blank(NMEM nmem, const char *dstr, + char ***darray, int *num); + +/** \brief allocates and sets integer for NMEM + \param nmem NMEM handle + \param v integer value + \returns pointer to created integer +*/ +YAZ_EXPORT nmem_int_t *nmem_intdup(NMEM nmem, nmem_int_t v); + +/** \brief allocates and sets boolean for NMEM + \param nmem NMEM handle + \param v value (0=false, != 0 true) + \returns pointer to created boolean +*/ +YAZ_EXPORT nmem_bool_t *nmem_booldup(NMEM nmem, nmem_bool_t v); + +/** \brief transfers memory from one NMEM handle to another + \param src source NMEM handle + \param dst destination NMEM handle + */ +YAZ_EXPORT void nmem_transfer(NMEM dst, NMEM src); +/** \brief returns new NMEM handle + \returns NMEM handle + */ YAZ_EXPORT NMEM nmem_create(void); -YAZ_EXPORT void nmem_destroy(NMEM n); -YAZ_EXPORT void *nmem_malloc(NMEM n, int size); - -#define nmem_print_list -#endif +/** \brief destroys NMEM handle and memory associated with it + \param n NMEM handle + */ +YAZ_EXPORT void nmem_destroy(NMEM n); -YAZ_EXPORT void nmem_init (void); -YAZ_EXPORT void nmem_exit (void); +/** \brief allocates memory block on NMEM handle + \param n NMEM handle + \param size number of bytes to be allocated + \returns pointer to allocated memory + */ +YAZ_EXPORT void *nmem_malloc(NMEM n, size_t size); YAZ_END_CDECL #endif +/* + * Local variables: + * c-basic-offset: 4 + * c-file-style: "Stroustrup" + * indent-tabs-mode: nil + * End: + * vim: shiftwidth=4 tabstop=8 expandtab + */ +