include/yaz/wrbuf.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2009 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 allocate / construct WRBUF */
  50 YAZ_EXPORT WRBUF wrbuf_alloc(void);
  51
  52 /** \brief destroy WRBUF and its buffer */
  53 YAZ_EXPORT void wrbuf_destroy(WRBUF b);
  54
  55 /** \brief empty WRBUF content */
  56 YAZ_EXPORT void wrbuf_rewind(WRBUF b);
  57
  58 /** \brief writes (append) buffer to WRBUF */
  59 YAZ_EXPORT int wrbuf_write(WRBUF b, const char *buf, int size);
  60 /** \brief appends C-string to WRBUF (returns int) */
  61 YAZ_EXPORT int wrbuf_puts(WRBUF b, const char *buf);
  62 /** \brief appends C-string to WRBUF (void) */
  63 YAZ_EXPORT void wrbuf_vputs(const char *buf, void *client_data);
  64
  65 /** \brief writes buffer to WRBUF and XML encode (as CDATA) */
  66 YAZ_EXPORT int wrbuf_xmlputs_n(WRBUF b, const char *cp, int size);
  67 /** \brief writes C-String to WRBUF and XML encode (as CDATA) */
  68 YAZ_EXPORT int wrbuf_xmlputs(WRBUF b, const char *cp);
  69
  70 YAZ_EXPORT int wrbuf_puts_replace_char(WRBUF b, const char *buf,
  71                                        const char from, const char to);
  72
  73 /** \brief writes buffer to WRBUF and escape non-ASCII characters */
  74 YAZ_EXPORT void wrbuf_puts_escaped(WRBUF b, const char *str);
  75
  76 /** \brief writes C-string to WRBUF and escape non-ASCII characters */
  77 YAZ_EXPORT void wrbuf_write_escaped(WRBUF b, const char *buf, size_t len);
  78
  79 /** \brief writes printf result to WRBUF */
  80 YAZ_EXPORT void wrbuf_printf(WRBUF b, const char *fmt, ...)
  81 #ifdef __GNUC__
  82         __attribute__ ((format (printf, 2, 3)))
  83 #endif
  84         ;
  85
  86 YAZ_EXPORT int wrbuf_iconv_write(WRBUF b, yaz_iconv_t cd, const char *buf,
  87                                  int size);
  88 YAZ_EXPORT int wrbuf_iconv_write_cdata(WRBUF b, yaz_iconv_t cd,
  89                                        const char *buf, int size);
  90 YAZ_EXPORT int wrbuf_iconv_puts_cdata(WRBUF b, yaz_iconv_t cd,
  91                                       const char *strz);
  92
  93 YAZ_EXPORT int wrbuf_iconv_puts(WRBUF b, yaz_iconv_t cd, const char *strz);
  94
  95 YAZ_EXPORT int wrbuf_iconv_putchar(WRBUF b, yaz_iconv_t cd, int ch);
  96
  97 YAZ_EXPORT void wrbuf_iconv_reset(WRBUF b, yaz_iconv_t cd);
  98
  99 YAZ_EXPORT void wrbuf_chop_right(WRBUF b);
 100
 101 /** \brief cut size of WRBUF */
 102 YAZ_EXPORT void wrbuf_cut_right(WRBUF b, size_t no_to_remove);
 103
 104
 105 /** \brief grow WRBUF larger
 106     This function is normally not used by applications
 107 */
 108 YAZ_EXPORT int wrbuf_grow(WRBUF b, int minsize);
 109
 110 #define wrbuf_len(b) ((b)->pos)
 111 #define wrbuf_buf(b) ((b)->buf)
 112
 113 YAZ_EXPORT const char *wrbuf_cstr(WRBUF b);
 114
 115 #define wrbuf_putc(b, c) \
 116     (((b)->pos >= (b)->size ? wrbuf_grow(b, 1) : 0),  \
 117     (b)->buf[(b)->pos++] = (c), 0)
 118
 119 YAZ_END_CDECL
 120
 121 #endif
 122 /*
 123  * Local variables:
 124  * c-basic-offset: 4
 125  * indent-tabs-mode: nil
 126  * End:
 127  * vim: shiftwidth=4 tabstop=8 expandtab
 128  */
 129