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 WRBU
  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 appends C-string to WRBUF
  74     \param b WRBUF
  75     \param buf C-string (0-terminated)
  76  */
  77 YAZ_EXPORT void wrbuf_puts(WRBUF b, const char *buf);
  78
  79 /** \brief writes buffer of certain size to WRBUF and XML encode (as CDATA)
  80     \param b WRBUF
  81     \param cp CDATA
  82     \param size size of CDATA
  83  */
  84 YAZ_EXPORT void wrbuf_xmlputs_n(WRBUF b, const char *cp, size_t size);
  85
  86 /** \brief writes C-String to WRBUF and XML encode (as CDATA)
  87     \param b WRBUF
  88     \param cp CDATA buffer (0-terminated)
  89  */
  90 YAZ_EXPORT void wrbuf_xmlputs(WRBUF b, const char *cp);
  91
  92 /** \brief puts buf to WRBUF and replaces a single char
  93     \param b WRBUF
  94     \param buf buffer to append (C-string)
  95     \param from character "from"
  96     \param to charcter "to"
  97 */
  98 YAZ_EXPORT void wrbuf_puts_replace_char(WRBUF b, const char *buf,
  99                                         const char from, const char to);
 100
 101 /** \brief writes C-string to WRBUF and escape non-ASCII characters
 102     \param b WRBUF
 103     \param str C-string
 104
 105     Non-ASCII characters will be presented as \\xDD .
 106  */
 107 YAZ_EXPORT void wrbuf_puts_escaped(WRBUF b, const char *str);
 108
 109 /** \brief writes buffer to WRBUF and escape non-ASCII characters
 110     \param b WRBUF
 111     \param buf buffer
 112     \param len size of buffer
 113
 114     Non-ASCII characters will be presented as \\xDD .
 115  */
 116 YAZ_EXPORT void wrbuf_write_escaped(WRBUF b, const char *buf, size_t len);
 117
 118 /** \brief writes printf result to WRBUF
 119     \param b WRBUF
 120     \param fmt printf-like format
 121  */
 122 YAZ_EXPORT void wrbuf_printf(WRBUF b, const char *fmt, ...)
 123 #ifdef __GNUC__
 124         __attribute__ ((format (printf, 2, 3)))
 125 #endif
 126         ;
 127
 128 /** \brief general writer of string using iconv and cdata
 129     \param b WRBUF
 130     \param cd iconv handle (0 for no conversion)
 131     \param buf buffer
 132     \param size size of buffer
 133     \param cdata non-zero for CDATA; 0 for cdata
 134     \returns -1 if invalid sequence was encountered (truncation in effect)
 135     \returns 0 if buffer could be converted and written
 136 */
 137 int wrbuf_iconv_write_x(WRBUF b, yaz_iconv_t cd, const char *buf,
 138                         size_t size, int cdata);
 139
 140 /** \brief iconv converts buffer and appends to WRBUF
 141     \param b WRBUF
 142     \param cd iconv handle
 143     \param buf buffer
 144     \param size size of buffer
 145 */
 146 YAZ_EXPORT void wrbuf_iconv_write(WRBUF b, yaz_iconv_t cd, const char *buf,
 147                                  size_t size);
 148
 149 /** \brief iconv converts buffer and appends to WRBUF as XML CDATA
 150     \param b WRBUF
 151     \param cd iconv handle
 152     \param buf buffer
 153     \param size size of buffer
 154 */
 155 YAZ_EXPORT void wrbuf_iconv_write_cdata(WRBUF b, yaz_iconv_t cd,
 156                                        const char *buf, size_t size);
 157
 158 /** \brief iconv converts C-string and appends to WRBUF
 159     \param b WRBUF
 160     \param cd iconv handle
 161     \param str C-string
 162 */
 163 YAZ_EXPORT void wrbuf_iconv_puts(WRBUF b, yaz_iconv_t cd, const char *str);
 164
 165 /** \brief iconv converts C-string and appends to WRBUF as XML CDATA
 166     \param b WRBUF
 167     \param cd iconv handle
 168     \param str C-string
 169 */
 170 YAZ_EXPORT void wrbuf_iconv_puts_cdata(WRBUF b, yaz_iconv_t cd,
 171                                        const char *str);
 172
 173 /** \brief iconv converts character and appends to WRBUF
 174     \param b WRBUF
 175     \param cd iconv handle
 176     \param ch character
 177 */
 178 YAZ_EXPORT void wrbuf_iconv_putchar(WRBUF b, yaz_iconv_t cd, int ch);
 179
 180 /** \brief iconv reset(flush) to WRBUF
 181     \param b
 182     \param cd iconv handle
 183
 184     This function calls iconv(cd, 0, 0, ..) to make it
 185     flush any remaining content.
 186 */
 187 YAZ_EXPORT void wrbuf_iconv_reset(WRBUF b, yaz_iconv_t cd);
 188
 189 /** \brief chips traling blanks away from WRBUF
 190     \param b WRBUF
 191 */
 192 YAZ_EXPORT void wrbuf_chop_right(WRBUF b);
 193
 194 /** \brief cut size of WRBUF
 195     \param b WRBUF
 196     \param no_to_remove number of bytes to remove
 197  */
 198 YAZ_EXPORT void wrbuf_cut_right(WRBUF b, size_t no_to_remove);
 199
 200 /** \brief grow WRBUF larger
 201     \param b WRBUF
 202     \param minsize make WRBUF at least this size
 203
 204     This function is normally not used by applications
 205 */
 206 YAZ_EXPORT int wrbuf_grow(WRBUF b, size_t minsize);
 207
 208 #define wrbuf_len(b) ((b)->pos)
 209 #define wrbuf_buf(b) ((b)->buf)
 210
 211 /** \brief returns WRBUF content as C-string
 212     \param b WRBUF
 213     \returns C-string
 214 */
 215 YAZ_EXPORT const char *wrbuf_cstr(WRBUF b);
 216
 217 #define wrbuf_putc(b, c) \
 218     (((b)->pos >= (b)->size ? wrbuf_grow(b, 1) : 0),  \
 219     (b)->buf[(b)->pos++] = (c), 0)
 220
 221 YAZ_END_CDECL
 222
 223 #endif
 224 /*
 225  * Local variables:
 226  * c-basic-offset: 4
 227  * c-file-style: "Stroustrup"
 228  * indent-tabs-mode: nil
 229  * End:
 230  * vim: shiftwidth=4 tabstop=8 expandtab
 231  */
 232