wrbuf.h

Go to the documentation of this file.

/* This file is part of the YAZ toolkit.
 * Copyright (C) Index Data.
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Index Data nor the names of its contributors
 *       may be used to endorse or promote products derived from this
 *       software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef WRBUF_H
#define WRBUF_H
 
#include <yaz/xmalloc.h>
#include <yaz/yaz-iconv.h>
 
YAZ_BEGIN_CDECL
 
typedef struct wrbuf
{
    char *buf;
    size_t pos;
    size_t size;
} wrbuf, *WRBUF;
 
YAZ_EXPORT WRBUF wrbuf_alloc(void);
 
YAZ_EXPORT void wrbuf_destroy(WRBUF b);
 
YAZ_EXPORT void wrbuf_rewind(WRBUF b);
 
YAZ_EXPORT void wrbuf_write(WRBUF b, const char *buf, size_t size);
 
YAZ_EXPORT void wrbuf_insert(WRBUF b, size_t pos, const char *buf, size_t size);
 
YAZ_EXPORT void wrbuf_puts(WRBUF b, const char *buf);
 
YAZ_EXPORT void wrbuf_vp_puts(const char *buf, void *client_data);
 
YAZ_EXPORT void wrbuf_xmlputs_n(WRBUF b, const char *cp, size_t size);
 
YAZ_EXPORT void wrbuf_xml_strip(WRBUF b, const char *cp, size_t size);
 
YAZ_EXPORT void wrbuf_xmlputs(WRBUF b, const char *cp);
 
YAZ_EXPORT void wrbuf_puts_replace_char(WRBUF b, const char *buf,
                                        const char from, const char to);
 
YAZ_EXPORT void wrbuf_puts_replace_str(WRBUF b, const char *buf,
                                        const char *from, const char *to);
 
YAZ_EXPORT void wrbuf_puts_escaped(WRBUF b, const char *str);
 
YAZ_EXPORT void wrbuf_write_escaped(WRBUF b, const char *buf, size_t len);
 
YAZ_EXPORT void wrbuf_printf(WRBUF b, const char *fmt, ...)
#ifdef __GNUC__
        __attribute__ ((format (printf, 2, 3)))
#endif
        ;
 
int wrbuf_iconv_write2(WRBUF b, yaz_iconv_t cd, const char *buf,
                       size_t size,
                       void (*wfunc)(WRBUF, const char *, size_t));
 
int wrbuf_iconv_puts2(WRBUF b, yaz_iconv_t cd, const char *buf,
                      void (*wfunc)(WRBUF, const char *, size_t));
 
 
int wrbuf_iconv_write_x(WRBUF b, yaz_iconv_t cd, const char *buf,
                        size_t size, int cdata)
#ifdef __GNUC__
    __attribute__ ((deprecated))
#endif
    ;
 
YAZ_EXPORT void wrbuf_iconv_write(WRBUF b, yaz_iconv_t cd, const char *buf,
                                 size_t size);
 
YAZ_EXPORT void wrbuf_iconv_write_cdata(WRBUF b, yaz_iconv_t cd,
                                       const char *buf, size_t size);
 
YAZ_EXPORT void wrbuf_iconv_puts(WRBUF b, yaz_iconv_t cd, const char *str);
 
YAZ_EXPORT void wrbuf_iconv_puts_cdata(WRBUF b, yaz_iconv_t cd,
                                       const char *str);
 
YAZ_EXPORT void wrbuf_iconv_putchar(WRBUF b, yaz_iconv_t cd, int ch);
 
YAZ_EXPORT void wrbuf_iconv_reset(WRBUF b, yaz_iconv_t cd);
 
YAZ_EXPORT void wrbuf_chop_right(WRBUF b);
 
YAZ_EXPORT void wrbuf_cut_right(WRBUF b, size_t no_to_remove);
 
YAZ_EXPORT int wrbuf_grow(WRBUF b, size_t minsize);
 
#define wrbuf_len(b) ((b)->pos)
#define wrbuf_buf(b) ((b)->buf)
 
YAZ_EXPORT const char *wrbuf_cstr(WRBUF b);
 
YAZ_EXPORT
const char *wrbuf_cstr_null(WRBUF b);
 
#define wrbuf_putc(b, c) \
    ((void) ((b)->pos >= (b)->size ? wrbuf_grow(b, 1) : 0),  \
    (b)->buf[(b)->pos++] = (c))
 
 
YAZ_EXPORT
void wrbuf_json_puts(WRBUF b, const char *str);
 
YAZ_EXPORT
void wrbuf_json_write(WRBUF b, const char *cp, size_t sz);
 
YAZ_EXPORT
void wrbuf_iconv_json_write(WRBUF b, yaz_iconv_t cd,
                            const char *buf, size_t size);
 
YAZ_EXPORT
void wrbuf_iconv_json_puts(WRBUF b, yaz_iconv_t cd, const char *strz);
 
YAZ_EXPORT
int wrbuf_sha1_write(WRBUF b, const char *cp, size_t sz, int hexit);
 
YAZ_EXPORT
int wrbuf_sha1_puts(WRBUF b, const char *cp, int hexit);
 
YAZ_END_CDECL
 
#endif
/*
 * Local variables:
 * c-basic-offset: 4
 * c-file-style: "Stroustrup"
 * indent-tabs-mode: nil
 * End:
 * vim: shiftwidth=4 tabstop=8 expandtab
 */