X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=include%2Fyaz%2Fwrbuf.h;h=8664c36b2b211cd06f4382e46a95ee2f9059ab0b;hp=c69c3ad2cfb9898043d34ee81b3f159735e93da9;hb=7efed25c2ed807d32001e749f87f2eb300548c22;hpb=ee6ab2ee3a9ee1a8c65d7272ec7fba1d886f5af0

diff --git a/include/yaz/wrbuf.h b/include/yaz/wrbuf.h
index c69c3ad..8664c36 100644
--- a/include/yaz/wrbuf.h
+++ b/include/yaz/wrbuf.h
@@ -1,5 +1,5 @@
 /* This file is part of the YAZ toolkit.
- * Copyright (C) 1995-2008 Index Data.
+ * Copyright (C) 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.29 2008-01-30 19:58:24 adam Exp $ */
 
 /**
  * \file wrbuf.h
@@ -47,80 +46,252 @@ typedef struct wrbuf
     size_t size;
 } wrbuf, *WRBUF;
 
-/** \brief allocate / construct WRBUF */
+/** \brief construct WRBUF
+    \returns WRBUF
+ */
 YAZ_EXPORT WRBUF wrbuf_alloc(void);
 
-/** \brief destroy WRBUF and its buffer */
+/** \brief destroy WRBUF and its buffer
+    \param b WRBUF
+
+    For YAZ 4.0.2 WRBUF b may be NULL.
+ */
 YAZ_EXPORT void wrbuf_destroy(WRBUF b);
 
-/** \brief empty WRBUF content */
+/** \brief empty WRBUF content (length of buffer set to 0)
+    \param b WRBUF
+ */
 YAZ_EXPORT void wrbuf_rewind(WRBUF b);
 
-/** \brief writes (append) buffer to WRBUF */
-YAZ_EXPORT int wrbuf_write(WRBUF b, const char *buf, int size);
-/** \brief appends C-string to WRBUF */
-YAZ_EXPORT int wrbuf_puts(WRBUF b, const char *buf);
+/** \brief append constant size buffer to WRBUF
+    \param b WRBUF
+    \param buf buffer
+    \param size size of buffer
+ */
+YAZ_EXPORT void wrbuf_write(WRBUF b, const char *buf, size_t size);
+
+/** \brief inserts buffer into WRBUF at some position
+    \param b WRBUF
+    \param pos position (0=beginning)
+    \param buf buffer
+    \param size size of buffer
+ */
+YAZ_EXPORT void wrbuf_insert(WRBUF b, size_t pos, const char *buf, size_t size);
+
+/** \brief appends C-string to WRBUF
+    \param b WRBUF
+    \param buf C-string (0-terminated)
+ */
+YAZ_EXPORT void wrbuf_puts(WRBUF b, const char *buf);
+
+/** \brief appends C-string to WRBUF - void pointer variant
+    \param buf C-string
+    \param client_data assumed WRBUF
+*/
+YAZ_EXPORT void wrbuf_vp_puts(const char *buf, void *client_data);
+
+/** \brief writes buffer of certain size to WRBUF and XML encode (as CDATA)
+    \param b WRBUF
+    \param cp CDATA
+    \param size size of CDATA
+ */
+YAZ_EXPORT void wrbuf_xmlputs_n(WRBUF b, const char *cp, size_t size);
+
+/** \brief writes C-String to WRBUF and XML encode (as CDATA)
+    \param b WRBUF
+    \param cp CDATA buffer (0-terminated)
+ */
+YAZ_EXPORT void wrbuf_xmlputs(WRBUF b, const char *cp);
 
-/** \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);
+/** \brief puts buf to WRBUF and replaces a single char
+    \param b WRBUF
+    \param buf buffer to append (C-string)
+    \param from character "from"
+    \param to charcter "to"
+*/
+YAZ_EXPORT void wrbuf_puts_replace_char(WRBUF b, const char *buf,
+                                        const char from, const char to);
 
-YAZ_EXPORT int wrbuf_puts_replace_char(WRBUF b, const char *buf, 
-                                       const char from, const char to);
+/** \brief writes C-string to WRBUF and escape non-ASCII characters
+    \param b WRBUF
+    \param str C-string
 
-/** \brief writes buffer to WRBUF and escape non-ASCII characters */
+    Non-ASCII characters will be presented as \\xDD .
+ */
 YAZ_EXPORT void wrbuf_puts_escaped(WRBUF b, const char *str);
 
-/** \brief writes C-string to WRBUF and escape non-ASCII characters */
+/** \brief writes buffer to WRBUF and escape non-ASCII characters
+    \param b WRBUF
+    \param buf buffer
+    \param len size of buffer
+
+    Non-ASCII characters will be presented as \\xDD .
+ */
 YAZ_EXPORT void wrbuf_write_escaped(WRBUF b, const char *buf, size_t len);
 
-/** \brief writes printf result to WRBUF */
+/** \brief writes printf result to WRBUF
+    \param b WRBUF
+    \param fmt printf-like format
+ */
 YAZ_EXPORT void wrbuf_printf(WRBUF b, const char *fmt, ...)
 #ifdef __GNUC__
         __attribute__ ((format (printf, 2, 3)))
 #endif
         ;
 
-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);
+/** \brief General writer of string using iconv and cdata
+    \param b WRBUF
+    \param cd iconv handle (0 for no conversion)
+    \param buf buffer
+    \param size size of buffer
+    \param wfunc write handler (that takes WRBUF only)
+    \returns -1 if invalid sequence was encountered (truncation in effect)
+    \returns 0 if buffer could be converted and written
+*/
+int wrbuf_iconv_write2(WRBUF b, yaz_iconv_t cd, const char *buf,
+                       size_t size,
+                       void (*wfunc)(WRBUF, const char *, size_t));
+
+/** \brief writer of string using iconv and cdata
+
+    Obsolete: use wrbuf_iconv_write2 instead.
+    \param b WRBUF
+    \param cd iconv handle (0 for no conversion)
+    \param buf buffer
+    \param size size of buffer
+    \param cdata non-zero for CDATA; 0 for cdata
+    \returns -1 if invalid sequence was encountered (truncation in effect)
+    \returns 0 if buffer could be converted and written
+*/
+int wrbuf_iconv_write_x(WRBUF b, yaz_iconv_t cd, const char *buf,
+                        size_t size, int cdata)
+#ifdef __GNUC__
+    __attribute__ ((deprecated))
+#endif
+    ;
+
+/** \brief Converts buffer using iconv and appends to WRBUF
+    \param b WRBUF
+    \param cd iconv handle
+    \param buf buffer
+    \param size size of buffer
+*/
+YAZ_EXPORT void wrbuf_iconv_write(WRBUF b, yaz_iconv_t cd, const char *buf,
+                                 size_t size);
+
+/** \brief Converts buffer using iconv and appends to WRBUF as XML CDATA
+    \param b WRBUF
+    \param cd iconv handle
+    \param buf buffer
+    \param size size of buffer
+*/
+YAZ_EXPORT void wrbuf_iconv_write_cdata(WRBUF b, yaz_iconv_t cd,
+                                       const char *buf, size_t size);
+
+/** \brief iconv converts C-string and appends to WRBUF
+    \param b WRBUF
+    \param cd iconv handle
+    \param str C-string
+*/
+YAZ_EXPORT void wrbuf_iconv_puts(WRBUF b, yaz_iconv_t cd, const char *str);
+
+/** \brief iconv converts C-string and appends to WRBUF as XML CDATA
+    \param b WRBUF
+    \param cd iconv handle
+    \param str C-string
+*/
+YAZ_EXPORT void wrbuf_iconv_puts_cdata(WRBUF b, yaz_iconv_t cd,
+                                       const char *str);
 
-YAZ_EXPORT int wrbuf_iconv_puts(WRBUF b, yaz_iconv_t cd, const char *strz);
+/** \brief iconv converts character and appends to WRBUF
+    \param b WRBUF
+    \param cd iconv handle
+    \param ch character
+*/
+YAZ_EXPORT void wrbuf_iconv_putchar(WRBUF b, yaz_iconv_t cd, int ch);
 
-YAZ_EXPORT int wrbuf_iconv_putchar(WRBUF b, yaz_iconv_t cd, int ch);
+/** \brief iconv reset(flush) to WRBUF
+    \param b
+    \param cd iconv handle
 
+    This function calls iconv(cd, 0, 0, ..) to make it
+    flush any remaining content.
+*/
 YAZ_EXPORT void wrbuf_iconv_reset(WRBUF b, yaz_iconv_t cd);
 
+/** \brief chips traling blanks away from WRBUF
+    \param b WRBUF
+*/
 YAZ_EXPORT void wrbuf_chop_right(WRBUF b);
 
-/** \brief cut size of WRBUF */
+/** \brief cut size of WRBUF
+    \param b WRBUF
+    \param no_to_remove number of bytes to remove
+ */
 YAZ_EXPORT void wrbuf_cut_right(WRBUF b, size_t no_to_remove);
 
+/** \brief grow WRBUF larger
+    \param b WRBUF
+    \param minsize make WRBUF at least this size
 
-/** \brief grow WRBUF larger 
     This function is normally not used by applications
 */
-YAZ_EXPORT int wrbuf_grow(WRBUF b, int minsize);
+YAZ_EXPORT int wrbuf_grow(WRBUF b, size_t minsize);
 
 #define wrbuf_len(b) ((b)->pos)
 #define wrbuf_buf(b) ((b)->buf)
 
+/** \brief returns WRBUF content as C-string
+    \param b WRBUF
+    \returns C-string
+*/
 YAZ_EXPORT const char *wrbuf_cstr(WRBUF b);
 
 #define wrbuf_putc(b, c) \
-    (((b)->pos >= (b)->size ? wrbuf_grow(b, 1) : 0),  \
+    ((void) ((b)->pos >= (b)->size ? wrbuf_grow(b, 1) : 0),  \
     (b)->buf[(b)->pos++] = (c), 0)
 
+
+/** \brief writes JSON text to WRBUF with escaping
+    \param b result
+    \param str input string to be encoded
+*/
+YAZ_EXPORT
+void wrbuf_json_puts(WRBUF b, const char *str);
+
+/** \brief writes JSON text to WRBUF with escaping
+    \param b result
+    \param cp char buffer
+    \param sz size of char buffer
+*/
+YAZ_EXPORT
+void wrbuf_json_write(WRBUF b, const char *cp, size_t sz);
+
+YAZ_EXPORT
+void wrbuf_iconv_json_write(WRBUF b, yaz_iconv_t cd,
+                            const char *buf, size_t size);
+
+YAZ_EXPORT
+void wrbuf_iconv_json_puts(WRBUF b, yaz_iconv_t cd, const char *strz);
+
+/** \brief writes SHA1 text to WRBUF
+    \param b result
+    \param cp char buffer
+    \param sz size of char buffer
+    \param hexit 1=hex mode; 0=binary
+    \returns 0 if successful
+    \returns -1 on error
+*/
+YAZ_EXPORT
+int wrbuf_sha1_write(WRBUF b, const char *cp, size_t sz, int hexit);
+
 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