Happy new year

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

diff --git a/include/yaz/wrbuf.h b/include/yaz/wrbuf.h
index ba0d04a..5ba50c3 100644 (file)
--- a/include/yaz/wrbuf.h
+++ b/include/yaz/wrbuf.h
@@ -1,5 +1,5 @@
-/*
- * Copyright (c) 1995-2006, Index Data
+/* 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:
@@ -24,7 +24,6 @@
  * (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 $ */
 
 /**
  * \file wrbuf.h
@@ -39,23 +38,45 @@
 
 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);
-YAZ_EXPORT int wrbuf_grow(WRBUF b, int minsize);
+
+/** \brief writes (append) buffer to WRBUF */
 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);
+/** \brief appends C-string to WRBUF (returns int) */
 YAZ_EXPORT int wrbuf_puts(WRBUF b, const char *buf);
+/** \brief appends C-string to WRBUF (void) */
+YAZ_EXPORT void wrbuf_vputs(const char *buf, void *client_data);
+
+/** \brief writes buffer to WRBUF and XML encode (as CDATA) */
+YAZ_EXPORT int wrbuf_xmlputs_n(WRBUF b, const char *cp, int size);
+/** \brief writes C-String to WRBUF and XML encode (as CDATA) */
+YAZ_EXPORT int wrbuf_xmlputs(WRBUF b, const char *cp);
+
 YAZ_EXPORT int wrbuf_puts_replace_char(WRBUF b, const char *buf, 
                                        const char from, const char to);
-YAZ_EXPORT int wrbuf_xmlputs(WRBUF b, const char *cp);
+
+/** \brief writes buffer to WRBUF and escape non-ASCII characters */
+YAZ_EXPORT void wrbuf_puts_escaped(WRBUF b, const char *str);
+
+/** \brief writes C-string to WRBUF and escape non-ASCII characters */
+YAZ_EXPORT void wrbuf_write_escaped(WRBUF b, const char *buf, size_t len);
+
+/** \brief writes printf result to WRBUF */
 YAZ_EXPORT void wrbuf_printf(WRBUF b, const char *fmt, ...)
 #ifdef __GNUC__
         __attribute__ ((format (printf, 2, 3)))
@@ -66,15 +87,31 @@ YAZ_EXPORT int wrbuf_iconv_write(WRBUF b, yaz_iconv_t cd, const char *buf,
                                  int size);
 YAZ_EXPORT int wrbuf_iconv_write_cdata(WRBUF b, yaz_iconv_t cd,
                                        const char *buf, int size);
+YAZ_EXPORT int wrbuf_iconv_puts_cdata(WRBUF b, yaz_iconv_t cd,
+                                      const char *strz);
+
 YAZ_EXPORT int wrbuf_iconv_puts(WRBUF b, yaz_iconv_t cd, const char *strz);
 
 YAZ_EXPORT int wrbuf_iconv_putchar(WRBUF b, yaz_iconv_t cd, int ch);
 
+YAZ_EXPORT void wrbuf_iconv_reset(WRBUF b, yaz_iconv_t cd);
+
 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);
+
+
+/** \brief grow WRBUF larger 
+    This function is normally not used by applications
+*/
+YAZ_EXPORT int wrbuf_grow(WRBUF b, int minsize);
+
 #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)