Add wrbuf_sha1_write

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

diff --git a/include/yaz/wrbuf.h b/include/yaz/wrbuf.h
index 56b5e60..8664c36 100644 (file)
--- 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-2011 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:
@@ -53,7 +53,7 @@ YAZ_EXPORT WRBUF wrbuf_alloc(void);
 
 /** \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);
@@ -63,19 +63,33 @@ YAZ_EXPORT void wrbuf_destroy(WRBUF b);
  */
 YAZ_EXPORT void wrbuf_rewind(WRBUF b);
 
-/** \brief append constant size buffer to WRBU
+/** \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
@@ -95,7 +109,7 @@ YAZ_EXPORT void wrbuf_xmlputs(WRBUF b, const char *cp);
     \param from character "from"
     \param to charcter "to"
 */
-YAZ_EXPORT void wrbuf_puts_replace_char(WRBUF b, const char *buf, 
+YAZ_EXPORT void 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
@@ -125,7 +139,22 @@ YAZ_EXPORT void wrbuf_printf(WRBUF b, const char *fmt, ...)
 #endif
         ;
 
-/** \brief general writer of string using iconv and cdata
+/** \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
@@ -135,9 +164,13 @@ YAZ_EXPORT void wrbuf_printf(WRBUF b, const char *fmt, ...)
     \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);
+                        size_t size, int cdata)
+#ifdef __GNUC__
+    __attribute__ ((deprecated))
+#endif
+    ;
 
-/** \brief iconv converts buffer and appends to WRBUF
+/** \brief Converts buffer using iconv and appends to WRBUF
     \param b WRBUF
     \param cd iconv handle
     \param buf buffer
@@ -146,7 +179,7 @@ int wrbuf_iconv_write_x(WRBUF b, yaz_iconv_t cd, const char *buf,
 YAZ_EXPORT void wrbuf_iconv_write(WRBUF b, yaz_iconv_t cd, const char *buf,
                                  size_t size);
 
-/** \brief iconv converts buffer and appends to WRBUF as XML CDATA
+/** \brief Converts buffer using iconv and appends to WRBUF as XML CDATA
     \param b WRBUF
     \param cd iconv handle
     \param buf buffer
@@ -180,7 +213,7 @@ YAZ_EXPORT void 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.
 */
@@ -197,7 +230,7 @@ YAZ_EXPORT void wrbuf_chop_right(WRBUF b);
  */
 YAZ_EXPORT void wrbuf_cut_right(WRBUF b, size_t no_to_remove);
 
-/** \brief grow WRBUF larger 
+/** \brief grow WRBUF larger
     \param b WRBUF
     \param minsize make WRBUF at least this size
 
@@ -215,9 +248,43 @@ YAZ_EXPORT int wrbuf_grow(WRBUF b, size_t minsize);
 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