X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=include%2Fyaz%2Fnmem.h;h=c12ddc090a7ff4296c483f2b38a96170d5117ca3;hp=2666fe7b2fd43e72836bb05d651b744da40dfa9a;hb=7d7e192def2fef342d235ea894eddb1e89edd714;hpb=964580242e2e0b2e570f652afa58bfb90ad0bb5e diff --git a/include/yaz/nmem.h b/include/yaz/nmem.h index 2666fe7..c12ddc0 100644 --- a/include/yaz/nmem.h +++ b/include/yaz/nmem.h @@ -1,5 +1,5 @@ -/* - * Copyright (c) 1995-2006, Index Data +/* 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: @@ -24,14 +24,13 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ -/* $Id: nmem.h,v 1.22 2006-10-09 21:02:41 adam Exp $ */ /** - * \file nmem.h + * \file * \brief Header for Nibble Memory functions * * This is a simple and fairly wasteful little module for nibble memory - * allocation. Evemtually we'll put in something better. + * allocation. Eventually we'll put in something better. */ #ifndef NMEM_H #define NMEM_H @@ -39,43 +38,68 @@ #include #include -#if YAZ_HAVE_XML2 -#include -#endif +YAZ_BEGIN_CDECL -#define NMEM_DEBUG 0 +/** \brief NMEM handle (an opaque pointer to memory) */ +typedef struct nmem_control *NMEM; -#ifndef NMEM_DEBUG -#define NMEM_DEBUG 0 +/** \brief Set to 1 if YAZ BER integer is 64-bit ; 0 otherwise */ +#ifndef NMEM_64 +#define NMEM_64 1 #endif -YAZ_BEGIN_CDECL +#if NMEM_64 -/** \brief NMEM/YAZ MUTEX opaque pointer */ -typedef struct nmem_mutex *NMEM_MUTEX; -/** \brief create Mutex */ -YAZ_EXPORT void nmem_mutex_create(NMEM_MUTEX *); -/** \brief enter critical section / AKA lock */ -YAZ_EXPORT void nmem_mutex_enter(NMEM_MUTEX); -/** \brief leave critical section / AKA unlock */ -YAZ_EXPORT void nmem_mutex_leave(NMEM_MUTEX); -/** \brief destroy MUTEX */ -YAZ_EXPORT void nmem_mutex_destroy(NMEM_MUTEX *); +#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 -/** \brief NMEM handle (an opaque pointer to memory) */ -typedef struct nmem_control *NMEM; +#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 + +/** \brief BER/utility boolean */ +typedef int nmem_bool_t; -/** \brief release all memory associaged with an NMEM handle */ +/** \brief releases memory associaged with an NMEM handle + \param n NMEM handle +*/ YAZ_EXPORT void nmem_reset(NMEM n); -/** \brief returns size in bytes of memory for NMEM handle */ -YAZ_EXPORT int nmem_total(NMEM n); -/** \brief allocates string on NMEM handle (similar strdup) */ -YAZ_EXPORT char *nmem_strdup (NMEM mem, const char *src); -/** \brief allocates string on NMEM handle - allows NULL ptr buffer */ -YAZ_EXPORT char *nmem_strdup_null (NMEM mem, const char *src); -/** \brief allocates string of certain size on NMEM handle */ -YAZ_EXPORT char *nmem_strdupn (NMEM mem, const char *src, size_t n); +/** \brief returns size in bytes of memory for NMEM handle + \returns number of bytes + */ +YAZ_EXPORT size_t nmem_total(NMEM n); + +/** \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); + +/** \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 @@ -88,6 +112,19 @@ 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 @@ -97,70 +134,42 @@ YAZ_EXPORT void nmem_strsplit(NMEM nmem, const char *delim, YAZ_EXPORT void nmem_strsplit_blank(NMEM nmem, const char *dstr, char ***darray, int *num); -#if YAZ_HAVE_XML2 -/** \brief copies TEXT Libxml2 node data to NMEM */ -YAZ_EXPORT char *nmem_text_node_cdata(const xmlNode *ptr, NMEM nmem); -#endif - -/** \brief creates and allocates integer for NMEM */ -YAZ_EXPORT int *nmem_intdup (NMEM mem, int v); - -/** \brief transfers memory from one NMEM handle to another */ -YAZ_EXPORT void nmem_transfer (NMEM dst, NMEM src); - -/** \brief internal (do not use) */ -YAZ_EXPORT void nmem_critical_enter (void); -/** \brief internal (do not use) */ -YAZ_EXPORT void nmem_critical_leave (void); - -#if NMEM_DEBUG - -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 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); -YAZ_EXPORT void nmem_print_list (void); -YAZ_EXPORT void nmem_print_list_l (int level); +/** \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); -#else +/** \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 */ +/** \brief returns new NMEM handle + \returns NMEM handle + */ YAZ_EXPORT NMEM nmem_create(void); -/** \brief destroys NMEM handle and memory associated with it */ +/** \brief destroys NMEM handle and memory associated with it + \param n NMEM handle + */ YAZ_EXPORT void nmem_destroy(NMEM n); -/** \brief allocate memory block on NMEM handle */ -YAZ_EXPORT void *nmem_malloc(NMEM n, int size); - -#define nmem_print_list() - -#endif - -/** \brief initializes NMEM system - This function increments a usage counter for NMEM.. Only - on first usage the system is initialized.. The \fn nmem_exit - decrements the counter. So these must be called in pairs -*/ -YAZ_EXPORT void nmem_init (void); - -/** \brief destroys NMEM system */ -YAZ_EXPORT void nmem_exit (void); - -YAZ_EXPORT int yaz_errno (void); -YAZ_EXPORT void yaz_set_errno (int v); -YAZ_EXPORT void yaz_strerror(char *buf, int max); - -/** \brief returns memory in use (by application) - \param p pointer to size (in bytes) - */ -YAZ_EXPORT void nmem_get_memory_in_use(size_t *p); -/** \brief returns memory in free (for later reuse) +/** \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_get_memory_free(size_t *p); +YAZ_EXPORT void *nmem_malloc(NMEM n, size_t size); YAZ_END_CDECL @@ -168,6 +177,7 @@ YAZ_END_CDECL /* * Local variables: * c-basic-offset: 4 + * c-file-style: "Stroustrup" * indent-tabs-mode: nil * End: * vim: shiftwidth=4 tabstop=8 expandtab