API changes to WRBUF. wrbuf_free removed; replaced by wrbuf_destroy. And

[yaz-moved-to-github.git] / include / yaz / wrbuf.h

diff --git a/include/yaz/wrbuf.h b/include/yaz/wrbuf.h
index ba0d04a..e3c5de3 100644 (file)
--- a/include/yaz/wrbuf.h
+++ b/include/yaz/wrbuf.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1995-2006, Index Data
+ * Copyright (c) 1995-2007, 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:
@@ -24,7 +24,7 @@
  * (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: wrbuf.h,v 1.20 2006-10-09 21:02:41 adam Exp $ */
+/* $Id: wrbuf.h,v 1.25 2007-03-19 14:40:06 adam Exp $ */
 
 /**
  * \file wrbuf.h
@@ -39,16 +39,24 @@
 
 YAZ_BEGIN_CDECL
 
+/** \brief string buffer */
 typedef struct wrbuf
 {
     char *buf;
-    int pos;
-    int size;
+    size_t pos;
+    size_t size;
 } wrbuf, *WRBUF;
 
+/** \brief allocate / construct WRBUF */
 YAZ_EXPORT WRBUF wrbuf_alloc(void);
-YAZ_EXPORT void wrbuf_free(WRBUF b, int free_buf);
+
+/** \brief destroy WRBUF and its buffer */
+YAZ_EXPORT void wrbuf_destroy(WRBUF b);
+
+/** \brief empty WRBUF content */
 YAZ_EXPORT void wrbuf_rewind(WRBUF b);
+
+/** \brief grow WRBUF larger */
 YAZ_EXPORT int wrbuf_grow(WRBUF b, int minsize);
 YAZ_EXPORT int wrbuf_write(WRBUF b, const char *buf, int size);
 YAZ_EXPORT int wrbuf_xmlputs_n(WRBUF b, const char *cp, int size);
@@ -72,9 +80,14 @@ YAZ_EXPORT int wrbuf_iconv_putchar(WRBUF b, yaz_iconv_t cd, int ch);
 
 YAZ_EXPORT void wrbuf_chop_right(WRBUF b);
 
+/** \brief cut size of WRBUF */
+YAZ_EXPORT void wrbuf_cut_right(WRBUF b, size_t no_to_remove);
+
 #define wrbuf_len(b) ((b)->pos)
 #define wrbuf_buf(b) ((b)->buf)
 
+YAZ_EXPORT const char *wrbuf_cstr(WRBUF b);
+
 #define wrbuf_putc(b, c) \
     (((b)->pos >= (b)->size ? wrbuf_grow(b, 1) : 0),  \
     (b)->buf[(b)->pos++] = (c), 0)