include/yaz/wrbuf.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2011 Index Data.
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of Index Data nor the names of its contributors
  13  *       may be used to endorse or promote products derived from this
  14  *       software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 /**
  29  * \file wrbuf.h
  30  * \brief Header for WRBUF (growing buffer)
  31  */
  32
  33 #ifndef WRBUF_H
  34 #define WRBUF_H
  35
  36 #include <yaz/xmalloc.h>
  37 #include <yaz/yaz-iconv.h>
  38
  39 YAZ_BEGIN_CDECL
  40
  41 /** \brief string buffer */
  42 typedef struct wrbuf
  43 {
  44     char *buf;
  45     size_t pos;
  46     size_t size;
  47 } wrbuf, *WRBUF;
  48
  49 /** \brief construct WRBUF
  50     \returns WRBUF
  51  */
  52 YAZ_EXPORT WRBUF wrbuf_alloc(void);
  53
  54 /** \brief destroy WRBUF and its buffer
  55     \param b WRBUF
  56
  57     For YAZ 4.0.2 WRBUF b may be NULL.
  58  */
  59 YAZ_EXPORT void wrbuf_destroy(WRBUF b);
  60
  61 /** \brief empty WRBUF content (length of buffer set to 0)
  62     \param b WRBUF
  63  */
  64 YAZ_EXPORT void wrbuf_rewind(WRBUF b);
  65
  66 /** \brief append constant size buffer to WRBUF
  67     \param b WRBUF
  68     \param buf buffer
  69     \param size size of buffer
  70  */
  71 YAZ_EXPORT void wrbuf_write(WRBUF b, const char *buf, size_t size);
  72
  73 /** \brief inserts buffer into WRBUF at some position
  74     \param b WRBUF
  75     \param pos position (0=beginning)
  76     \param buf buffer
  77     \param size size of buffer
  78  */
  79 YAZ_EXPORT void wrbuf_insert(WRBUF b, size_t pos, const char *buf, size_t size);
  80
  81 /** \brief appends C-string to WRBUF
  82     \param b WRBUF
  83     \param buf C-string (0-terminated)
  84  */
  85 YAZ_EXPORT void wrbuf_puts(WRBUF b, const char *buf);
  86
  87 /** \brief appends C-string to WRBUF - void pointer variant
  88     \param buf C-string
  89     \param client_data assumed WRBUF
  90 */
  91 YAZ_EXPORT void wrbuf_vp_puts(const char *buf, void *client_data);
  92
  93 /** \brief writes buffer of certain size to WRBUF and XML encode (as CDATA)
  94     \param b WRBUF
  95     \param cp CDATA
  96     \param size size of CDATA
  97  */
  98 YAZ_EXPORT void wrbuf_xmlputs_n(WRBUF b, const char *cp, size_t size);
  99
 100 /** \brief writes C-String to WRBUF and XML encode (as CDATA)
 101     \param b WRBUF
 102     \param cp CDATA buffer (0-terminated)
 103  */
 104 YAZ_EXPORT void wrbuf_xmlputs(WRBUF b, const char *cp);
 105
 106 /** \brief puts buf to WRBUF and replaces a single char
 107     \param b WRBUF
 108     \param buf buffer to append (C-string)
 109     \param from character "from"
 110     \param to charcter "to"
 111 */
 112 YAZ_EXPORT void wrbuf_puts_replace_char(WRBUF b, const char *buf,
 113                                         const char from, const char to);
 114
 115 /** \brief writes C-string to WRBUF and escape non-ASCII characters
 116     \param b WRBUF
 117     \param str C-string
 118
 119     Non-ASCII characters will be presented as \\xDD .
 120  */
 121 YAZ_EXPORT void wrbuf_puts_escaped(WRBUF b, const char *str);
 122
 123 /** \brief writes buffer to WRBUF and escape non-ASCII characters
 124     \param b WRBUF
 125     \param buf buffer
 126     \param len size of buffer
 127
 128     Non-ASCII characters will be presented as \\xDD .
 129  */
 130 YAZ_EXPORT void wrbuf_write_escaped(WRBUF b, const char *buf, size_t len);
 131
 132 /** \brief writes printf result to WRBUF
 133     \param b WRBUF
 134     \param fmt printf-like format
 135  */
 136 YAZ_EXPORT void wrbuf_printf(WRBUF b, const char *fmt, ...)
 137 #ifdef __GNUC__
 138         __attribute__ ((format (printf, 2, 3)))
 139 #endif
 140         ;
 141
 142 /** \brief general writer of string using iconv and cdata
 143     \param b WRBUF
 144     \param cd iconv handle (0 for no conversion)
 145     \param buf buffer
 146     \param size size of buffer
 147     \param cdata non-zero for CDATA; 0 for cdata
 148     \returns -1 if invalid sequence was encountered (truncation in effect)
 149     \returns 0 if buffer could be converted and written
 150 */
 151 int wrbuf_iconv_write_x(WRBUF b, yaz_iconv_t cd, const char *buf,
 152                         size_t size, int cdata);
 153
 154 /** \brief iconv converts buffer and appends to WRBUF
 155     \param b WRBUF
 156     \param cd iconv handle
 157     \param buf buffer
 158     \param size size of buffer
 159 */
 160 YAZ_EXPORT void wrbuf_iconv_write(WRBUF b, yaz_iconv_t cd, const char *buf,
 161                                  size_t size);
 162
 163 /** \brief iconv converts buffer and appends to WRBUF as XML CDATA
 164     \param b WRBUF
 165     \param cd iconv handle
 166     \param buf buffer
 167     \param size size of buffer
 168 */
 169 YAZ_EXPORT void wrbuf_iconv_write_cdata(WRBUF b, yaz_iconv_t cd,
 170                                        const char *buf, size_t size);
 171
 172 /** \brief iconv converts C-string and appends to WRBUF
 173     \param b WRBUF
 174     \param cd iconv handle
 175     \param str C-string
 176 */
 177 YAZ_EXPORT void wrbuf_iconv_puts(WRBUF b, yaz_iconv_t cd, const char *str);
 178
 179 /** \brief iconv converts C-string and appends to WRBUF as XML CDATA
 180     \param b WRBUF
 181     \param cd iconv handle
 182     \param str C-string
 183 */
 184 YAZ_EXPORT void wrbuf_iconv_puts_cdata(WRBUF b, yaz_iconv_t cd,
 185                                        const char *str);
 186
 187 /** \brief iconv converts character and appends to WRBUF
 188     \param b WRBUF
 189     \param cd iconv handle
 190     \param ch character
 191 */
 192 YAZ_EXPORT void wrbuf_iconv_putchar(WRBUF b, yaz_iconv_t cd, int ch);
 193
 194 /** \brief iconv reset(flush) to WRBUF
 195     \param b
 196     \param cd iconv handle
 197
 198     This function calls iconv(cd, 0, 0, ..) to make it
 199     flush any remaining content.
 200 */
 201 YAZ_EXPORT void wrbuf_iconv_reset(WRBUF b, yaz_iconv_t cd);
 202
 203 /** \brief chips traling blanks away from WRBUF
 204     \param b WRBUF
 205 */
 206 YAZ_EXPORT void wrbuf_chop_right(WRBUF b);
 207
 208 /** \brief cut size of WRBUF
 209     \param b WRBUF
 210     \param no_to_remove number of bytes to remove
 211  */
 212 YAZ_EXPORT void wrbuf_cut_right(WRBUF b, size_t no_to_remove);
 213
 214 /** \brief grow WRBUF larger
 215     \param b WRBUF
 216     \param minsize make WRBUF at least this size
 217
 218     This function is normally not used by applications
 219 */
 220 YAZ_EXPORT int wrbuf_grow(WRBUF b, size_t minsize);
 221
 222 #define wrbuf_len(b) ((b)->pos)
 223 #define wrbuf_buf(b) ((b)->buf)
 224
 225 /** \brief returns WRBUF content as C-string
 226     \param b WRBUF
 227     \returns C-string
 228 */
 229 YAZ_EXPORT const char *wrbuf_cstr(WRBUF b);
 230
 231 #define wrbuf_putc(b, c) \
 232     ((void) ((b)->pos >= (b)->size ? wrbuf_grow(b, 1) : 0),  \
 233     (b)->buf[(b)->pos++] = (c), 0)
 234
 235 YAZ_END_CDECL
 236
 237 #endif
 238 /*
 239  * Local variables:
 240  * c-basic-offset: 4
 241  * c-file-style: "Stroustrup"
 242  * indent-tabs-mode: nil
 243  * End:
 244  * vim: shiftwidth=4 tabstop=8 expandtab
 245  */
 246