1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2012 Index Data.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
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.
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.
30 * \brief Header for WRBUF (growing buffer)
36 #include <yaz/xmalloc.h>
37 #include <yaz/yaz-iconv.h>
41 /** \brief string buffer */
49 /** \brief construct WRBUF
52 YAZ_EXPORT WRBUF wrbuf_alloc(void);
54 /** \brief destroy WRBUF and its buffer
57 For YAZ 4.0.2 WRBUF b may be NULL.
59 YAZ_EXPORT void wrbuf_destroy(WRBUF b);
61 /** \brief empty WRBUF content (length of buffer set to 0)
64 YAZ_EXPORT void wrbuf_rewind(WRBUF b);
66 /** \brief append constant size buffer to WRBUF
69 \param size size of buffer
71 YAZ_EXPORT void wrbuf_write(WRBUF b, const char *buf, size_t size);
73 /** \brief inserts buffer into WRBUF at some position
75 \param pos position (0=beginning)
77 \param size size of buffer
79 YAZ_EXPORT void wrbuf_insert(WRBUF b, size_t pos, const char *buf, size_t size);
81 /** \brief appends C-string to WRBUF
83 \param buf C-string (0-terminated)
85 YAZ_EXPORT void wrbuf_puts(WRBUF b, const char *buf);
87 /** \brief appends C-string to WRBUF - void pointer variant
89 \param client_data assumed WRBUF
91 YAZ_EXPORT void wrbuf_vp_puts(const char *buf, void *client_data);
93 /** \brief writes buffer of certain size to WRBUF and XML encode (as CDATA)
96 \param size size of CDATA
98 YAZ_EXPORT void wrbuf_xmlputs_n(WRBUF b, const char *cp, size_t size);
100 /** \brief writes C-String to WRBUF and XML encode (as CDATA)
102 \param cp CDATA buffer (0-terminated)
104 YAZ_EXPORT void wrbuf_xmlputs(WRBUF b, const char *cp);
106 /** \brief puts buf to WRBUF and replaces a single char
108 \param buf buffer to append (C-string)
109 \param from character "from"
110 \param to charcter "to"
112 YAZ_EXPORT void wrbuf_puts_replace_char(WRBUF b, const char *buf,
113 const char from, const char to);
115 /** \brief writes C-string to WRBUF and escape non-ASCII characters
119 Non-ASCII characters will be presented as \\xDD .
121 YAZ_EXPORT void wrbuf_puts_escaped(WRBUF b, const char *str);
123 /** \brief writes buffer to WRBUF and escape non-ASCII characters
126 \param len size of buffer
128 Non-ASCII characters will be presented as \\xDD .
130 YAZ_EXPORT void wrbuf_write_escaped(WRBUF b, const char *buf, size_t len);
132 /** \brief writes printf result to WRBUF
134 \param fmt printf-like format
136 YAZ_EXPORT void wrbuf_printf(WRBUF b, const char *fmt, ...)
138 __attribute__ ((format (printf, 2, 3)))
142 /** \brief general writer of string using iconv and cdata
144 \param cd iconv handle (0 for no conversion)
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
151 int wrbuf_iconv_write_x(WRBUF b, yaz_iconv_t cd, const char *buf,
152 size_t size, int cdata);
154 /** \brief iconv converts buffer and appends to WRBUF
156 \param cd iconv handle
158 \param size size of buffer
160 YAZ_EXPORT void wrbuf_iconv_write(WRBUF b, yaz_iconv_t cd, const char *buf,
163 /** \brief iconv converts buffer and appends to WRBUF as XML CDATA
165 \param cd iconv handle
167 \param size size of buffer
169 YAZ_EXPORT void wrbuf_iconv_write_cdata(WRBUF b, yaz_iconv_t cd,
170 const char *buf, size_t size);
172 /** \brief iconv converts C-string and appends to WRBUF
174 \param cd iconv handle
177 YAZ_EXPORT void wrbuf_iconv_puts(WRBUF b, yaz_iconv_t cd, const char *str);
179 /** \brief iconv converts C-string and appends to WRBUF as XML CDATA
181 \param cd iconv handle
184 YAZ_EXPORT void wrbuf_iconv_puts_cdata(WRBUF b, yaz_iconv_t cd,
187 /** \brief iconv converts character and appends to WRBUF
189 \param cd iconv handle
192 YAZ_EXPORT void wrbuf_iconv_putchar(WRBUF b, yaz_iconv_t cd, int ch);
194 /** \brief iconv reset(flush) to WRBUF
196 \param cd iconv handle
198 This function calls iconv(cd, 0, 0, ..) to make it
199 flush any remaining content.
201 YAZ_EXPORT void wrbuf_iconv_reset(WRBUF b, yaz_iconv_t cd);
203 /** \brief chips traling blanks away from WRBUF
206 YAZ_EXPORT void wrbuf_chop_right(WRBUF b);
208 /** \brief cut size of WRBUF
210 \param no_to_remove number of bytes to remove
212 YAZ_EXPORT void wrbuf_cut_right(WRBUF b, size_t no_to_remove);
214 /** \brief grow WRBUF larger
216 \param minsize make WRBUF at least this size
218 This function is normally not used by applications
220 YAZ_EXPORT int wrbuf_grow(WRBUF b, size_t minsize);
222 #define wrbuf_len(b) ((b)->pos)
223 #define wrbuf_buf(b) ((b)->buf)
225 /** \brief returns WRBUF content as C-string
229 YAZ_EXPORT const char *wrbuf_cstr(WRBUF b);
231 #define wrbuf_putc(b, c) \
232 ((void) ((b)->pos >= (b)->size ? wrbuf_grow(b, 1) : 0), \
233 (b)->buf[(b)->pos++] = (c), 0)
241 * c-file-style: "Stroustrup"
242 * indent-tabs-mode: nil
244 * vim: shiftwidth=4 tabstop=8 expandtab