/*
- * Copyright (c) 1995-2001, Index Data.
+ * Copyright (C) 1995-2006, Index Data ApS
*
* Permission to use, copy, modify, distribute, and sell this software and
* its documentation, in whole or in part, for any purpose, is hereby granted,
* LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
* OF THIS SOFTWARE.
*
- * $Log: nmem.h,v $
- * Revision 1.5 2001-03-25 21:55:12 adam
- * Added odr_intdup. Ztest server returns TaskPackage for ItemUpdate.
- *
- * Revision 1.4 2000/05/09 11:48:58 adam
- * Fix (bug introduced by previous commit).
- *
- * 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).
- *
- * 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.
- *
+ * $Id: nmem.h,v 1.21 2006-08-13 17:30:57 adam Exp $
*/
+/**
+ * \file nmem.h
+ * \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.
+ */
#ifndef NMEM_H
#define NMEM_H
+
+#include <stddef.h>
#include <yaz/yconfig.h>
+#if YAZ_HAVE_XML2
+#include <libxml/parser.h>
+#endif
+
#define NMEM_DEBUG 0
#ifndef NMEM_DEBUG
YAZ_BEGIN_CDECL
-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;
-
+/** \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 */
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 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 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);
+
+#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
#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);
#else
+/** \brief returns new NMEM handle */
YAZ_EXPORT NMEM nmem_create(void);
+
+/** \brief destroys NMEM handle and memory associated with it */
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)
+ */
+YAZ_EXPORT void nmem_get_memory_free(size_t *p);
+
YAZ_END_CDECL
#endif
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+
projects / yaz-moved-to-github.git / blobdiff