include/yaz/wrbuf.h

   1 /*
   2  * Copyright (c) 1995-2007, 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 /* $Id: wrbuf.h,v 1.24 2007-03-18 12:59:56 adam Exp $ */
  28
  29 /**
  30  * \file wrbuf.h
  31  * \brief Header for WRBUF (growing buffer)
  32  */
  33
  34 #ifndef WRBUF_H
  35 #define WRBUF_H
  36
  37 #include <yaz/xmalloc.h>
  38 #include <yaz/yaz-iconv.h>
  39
  40 YAZ_BEGIN_CDECL
  41
  42 /** \brief string buffer */
  43 typedef struct wrbuf
  44 {
  45     char *buf;
  46     int pos;
  47     int size;
  48 } wrbuf, *WRBUF;
  49
  50 /** \brief allocate / construct WRBUF */
  51 YAZ_EXPORT WRBUF wrbuf_alloc(void);
  52
  53 /** \brief free WRBUF and possibly its buffer */
  54 YAZ_EXPORT void wrbuf_free(WRBUF b, int free_buf);
  55
  56 /** \brief destroy WRBUF and its buffer */
  57 YAZ_EXPORT void wrbuf_destroy(WRBUF b);
  58
  59 /** \brief empty WRBUF content */
  60 YAZ_EXPORT void wrbuf_rewind(WRBUF b);
  61
  62 /** \brief grow WRBUF larger */
  63 YAZ_EXPORT int wrbuf_grow(WRBUF b, int minsize);
  64 YAZ_EXPORT int wrbuf_write(WRBUF b, const char *buf, int size);
  65 YAZ_EXPORT int wrbuf_xmlputs_n(WRBUF b, const char *cp, int size);
  66 YAZ_EXPORT int wrbuf_puts(WRBUF b, const char *buf);
  67 YAZ_EXPORT int wrbuf_puts_replace_char(WRBUF b, const char *buf,
  68                                        const char from, const char to);
  69 YAZ_EXPORT int wrbuf_xmlputs(WRBUF b, const char *cp);
  70 YAZ_EXPORT void wrbuf_printf(WRBUF b, const char *fmt, ...)
  71 #ifdef __GNUC__
  72         __attribute__ ((format (printf, 2, 3)))
  73 #endif
  74         ;
  75
  76 YAZ_EXPORT int wrbuf_iconv_write(WRBUF b, yaz_iconv_t cd, const char *buf,
  77                                  int size);
  78 YAZ_EXPORT int wrbuf_iconv_write_cdata(WRBUF b, yaz_iconv_t cd,
  79                                        const char *buf, int size);
  80 YAZ_EXPORT int wrbuf_iconv_puts(WRBUF b, yaz_iconv_t cd, const char *strz);
  81
  82 YAZ_EXPORT int wrbuf_iconv_putchar(WRBUF b, yaz_iconv_t cd, int ch);
  83
  84 YAZ_EXPORT void wrbuf_chop_right(WRBUF b);
  85
  86 /** \brief cut size of WRBUF */
  87 YAZ_EXPORT void wrbuf_cut_right(WRBUF b, size_t no_to_remove);
  88
  89 #define wrbuf_len(b) ((b)->pos)
  90 #define wrbuf_buf(b) ((b)->buf)
  91
  92 YAZ_EXPORT const char *wrbuf_cstr(WRBUF b);
  93
  94 #define wrbuf_putc(b, c) \
  95     (((b)->pos >= (b)->size ? wrbuf_grow(b, 1) : 0),  \
  96     (b)->buf[(b)->pos++] = (c), 0)
  97
  98 YAZ_END_CDECL
  99
 100 #endif
 101 /*
 102  * Local variables:
 103  * c-basic-offset: 4
 104  * indent-tabs-mode: nil
 105  * End:
 106  * vim: shiftwidth=4 tabstop=8 expandtab
 107  */
 108