-/*
- * Copyright (c) 1995-2001, Index Data.
- *
- * 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:
- *
- * 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.
- *
- * $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.
+/* This file is part of the YAZ toolkit.
+ * Copyright (C) 1995-2009 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:
*
- * 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.
+ * * 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.
*
+ * 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.
*/
+/**
+ * \file
+ * \brief Header for Nibble Memory functions
+ *
+ * This is a simple and fairly wasteful little module for nibble memory
+ * allocation. Eventually we'll put in something better.
+ */
#ifndef NMEM_H
#define NMEM_H
-#include <yaz/yconfig.h>
-
-#define NMEM_DEBUG 0
-#ifndef NMEM_DEBUG
-#define NMEM_DEBUG 0
-#endif
+#include <stddef.h>
+#include <yaz/yconfig.h>
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 handle (an opaque pointer to memory) */
typedef struct nmem_control *NMEM;
+/** \brief releases memory associaged with an NMEM handle
+ \param n NMEM handle
+*/
YAZ_EXPORT void nmem_reset(NMEM n);
-YAZ_EXPORT int nmem_total(NMEM n);
-YAZ_EXPORT char *nmem_strdup (NMEM mem, const char *src);
-YAZ_EXPORT int *nmem_intdup (NMEM mem, int v);
-YAZ_EXPORT void nmem_transfer (NMEM dst, NMEM src);
-
-YAZ_EXPORT void nmem_critical_enter (void);
-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 returns size in bytes of memory for NMEM handle
+ \returns number of bytes
+ */
+YAZ_EXPORT int nmem_total(NMEM n);
-YAZ_EXPORT void nmem_print_list (void);
+/** \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);
-#else
+/** \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
+ \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);
+
+/** \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);
+
+/** \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
+ \returns NMEM handle
+ */
YAZ_EXPORT NMEM nmem_create(void);
+
+/** \brief destroys NMEM handle and memory associated with it
+ \param n NMEM handle
+ */
YAZ_EXPORT void nmem_destroy(NMEM n);
+
+/** \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()
+/** \brief returns errno
+ \returns errno value
+*/
+YAZ_EXPORT int yaz_errno(void);
-#endif
+/** \brief sets errno to value
+ \param v errno value
+*/
+YAZ_EXPORT void yaz_set_errno (int v);
-YAZ_EXPORT void nmem_init (void);
-YAZ_EXPORT void nmem_exit (void);
+/** \brief returns system error description string
+ \param buf buffer for result
+ \param max maximum number of bytes to store
+*/
+YAZ_EXPORT void yaz_strerror(char *buf, int max);
YAZ_END_CDECL
#endif
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * c-file-style: "Stroustrup"
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+