X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=include%2Fyaz%2Fnmem.h;h=d63bd270ddf15c0952bc7fa73a62689d0e26c503;hp=e786d0bf7ada90c0566b3e2a28eaf7bebf617ff2;hb=d72929b7de6221054feb6a220dc72289b0f3e03d;hpb=8d691989077a0addcbd840d769dce6700f3d9622 diff --git a/include/yaz/nmem.h b/include/yaz/nmem.h index e786d0b..d63bd27 100644 --- a/include/yaz/nmem.h +++ b/include/yaz/nmem.h @@ -24,14 +24,14 @@ * (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.24 2007-01-03 08:42:14 adam Exp $ */ +/* $Id: nmem.h,v 1.26 2007-11-14 21:03:59 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,39 +39,41 @@ #include #include -#define NMEM_DEBUG 0 - -#ifndef NMEM_DEBUG -#define NMEM_DEBUG 0 -#endif - YAZ_BEGIN_CDECL -/** \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 *); - /** \brief NMEM handle (an opaque pointer to memory) */ typedef struct nmem_control *NMEM; -/** \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 */ + +/** \brief returns size in bytes of memory for NMEM handle + \returns number of bytes + */ 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 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 @@ -93,66 +95,40 @@ 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); -/** \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)) - -YAZ_EXPORT void nmem_print_list (void); -YAZ_EXPORT void nmem_print_list_l (int level); +/** \brief allocates integer for NMEM + \param nmem NMEM handle + \param v integer value + \returns pointer to created integer +*/ +YAZ_EXPORT int *nmem_intdup(NMEM nmem, int 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 */ +/** \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, 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 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) - */ -YAZ_EXPORT void nmem_get_memory_free(size_t *p); - YAZ_END_CDECL #endif