X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=include%2Fyaz%2Fnmem.h;h=2666fe7b2fd43e72836bb05d651b744da40dfa9a;hb=c83035e0e0177b385091cd273562ea0d222b5908;hp=c0ebc9b99a7d5a488afbe9b21eb8a6a6d3bc89fc;hpb=a0e27aac0589d493172c73f6660b844fc6460d7c;p=yaz-moved-to-github.git diff --git a/include/yaz/nmem.h b/include/yaz/nmem.h index c0ebc9b..2666fe7 100644 --- a/include/yaz/nmem.h +++ b/include/yaz/nmem.h @@ -1,30 +1,30 @@ /* - * Copyright (C) 1995-2005, Index Data ApS + * Copyright (c) 1995-2006, 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: * - * 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: + * * 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. * - * 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. - * - * $Id: nmem.h,v 1.18 2006-05-02 20:47:45 adam Exp $ + * 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. */ +/* $Id: nmem.h,v 1.22 2006-10-09 21:02:41 adam Exp $ */ /** * \file nmem.h @@ -39,6 +39,10 @@ #include #include +#if YAZ_HAVE_XML2 +#include +#endif + #define NMEM_DEBUG 0 #ifndef NMEM_DEBUG @@ -47,33 +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); -YAZ_EXPORT char *nmem_text_node_cdata(const void *ptr_cdata, NMEM nmem); +/** \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 @@ -90,20 +127,41 @@ 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