X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=include%2Fyaz%2Fnmem.h;h=c5802e489c1c375f808aea5dd3a023ddc4c39ef3;hp=b424be0687b729a738b8f474ea55ea92f236dce7;hb=4b46dbf6d639a40bdeae0c280861505b937f34b9;hpb=a97174e3c213916ba968c8922ec69e9101badb2d

diff --git a/include/yaz/nmem.h b/include/yaz/nmem.h
index b424be0..c5802e4 100644
--- a/include/yaz/nmem.h
+++ b/include/yaz/nmem.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2005, Index Data ApS
+ * 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,
@@ -23,7 +23,7 @@
  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  * OF THIS SOFTWARE.
  *
- * $Id: nmem.h,v 1.16 2005-06-03 20:30:30 adam Exp $
+ * $Id: nmem.h,v 1.21 2006-08-13 17:30:57 adam Exp $
  */
 
 /**
@@ -39,6 +39,10 @@
 #include <stddef.h>
 #include <yaz/yconfig.h>
 
+#if YAZ_HAVE_XML2
+#include <libxml/parser.h>
+#endif
+
 #define NMEM_DEBUG 0
 
 #ifndef NMEM_DEBUG
@@ -47,32 +51,66 @@
 
 YAZ_BEGIN_CDECL
 
-typedef struct nmem_block nmem_block;
-
-typedef struct nmem_control 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);
-YAZ_EXPORT void nmem_strsplit_blank(NMEM nmem, 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
+*/
 YAZ_EXPORT void nmem_strsplit(NMEM nmem, const char *delim,
-			      const char *dstr,
-			      char ***darray, int *num);
+                              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
@@ -89,20 +127,49 @@ 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
+ */
+