include/yaz/wrbuf.h

   1 /*
   2  * Copyright (C) 1995-2005, Index Data ApS
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and
   5  * its documentation, in whole or in part, for any purpose, is hereby granted,
   6  * provided that:
   7  *
   8  * 1. This copyright and permission notice appear in all copies of the
   9  * software and its documentation. Notices of copyright or attribution
  10  * which appear at the beginning of any file must remain unchanged.
  11  *
  12  * 2. The names of Index Data or the individual authors may not be used to
  13  * endorse or promote products derived from this software without specific
  14  * prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  18  * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  19  * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
  20  * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
  21  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
  22  * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
  23  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  24  * OF THIS SOFTWARE.
  25  *
  26  * $Id: wrbuf.h,v 1.19 2006-08-28 12:34:40 adam Exp $
  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 typedef struct wrbuf
  42 {
  43     char *buf;
  44     int pos;
  45     int size;
  46 } wrbuf, *WRBUF;
  47
  48 YAZ_EXPORT WRBUF wrbuf_alloc(void);
  49 YAZ_EXPORT void wrbuf_free(WRBUF b, int free_buf);
  50 YAZ_EXPORT void wrbuf_rewind(WRBUF b);
  51 YAZ_EXPORT int wrbuf_grow(WRBUF b, int minsize);
  52 YAZ_EXPORT int wrbuf_write(WRBUF b, const char *buf, int size);
  53 YAZ_EXPORT int wrbuf_xmlputs_n(WRBUF b, const char *cp, int size);
  54 YAZ_EXPORT int wrbuf_puts(WRBUF b, const char *buf);
  55 YAZ_EXPORT int wrbuf_puts_replace_char(WRBUF b, const char *buf,
  56                                        const char from, const char to);
  57 YAZ_EXPORT int wrbuf_xmlputs(WRBUF b, const char *cp);
  58 YAZ_EXPORT void wrbuf_printf(WRBUF b, const char *fmt, ...)
  59 #ifdef __GNUC__
  60         __attribute__ ((format (printf, 2, 3)))
  61 #endif
  62         ;
  63
  64 YAZ_EXPORT int wrbuf_iconv_write(WRBUF b, yaz_iconv_t cd, const char *buf,
  65                                  int size);
  66 YAZ_EXPORT int wrbuf_iconv_write_cdata(WRBUF b, yaz_iconv_t cd,
  67                                        const char *buf, int size);
  68 YAZ_EXPORT int wrbuf_iconv_puts(WRBUF b, yaz_iconv_t cd, const char *strz);
  69
  70 YAZ_EXPORT int wrbuf_iconv_putchar(WRBUF b, yaz_iconv_t cd, int ch);
  71
  72 YAZ_EXPORT void wrbuf_chop_right(WRBUF b);
  73
  74 #define wrbuf_len(b) ((b)->pos)
  75 #define wrbuf_buf(b) ((b)->buf)
  76
  77 #define wrbuf_putc(b, c) \
  78     (((b)->pos >= (b)->size ? wrbuf_grow(b, 1) : 0),  \
  79     (b)->buf[(b)->pos++] = (c), 0)
  80
  81 YAZ_END_CDECL
  82
  83 #endif
  84 /*
  85  * Local variables:
  86  * c-basic-offset: 4
  87  * indent-tabs-mode: nil
  88  * End:
  89  * vim: shiftwidth=4 tabstop=8 expandtab
  90  */
  91