X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=include%2Fyaz%2Fwrbuf.h;h=7d757a35523a7f36e9c6cbc5a69dc7273abf54e0;hb=6f7757087a49db5fb3fa4f3b12b8b67ebbbe3aa3;hp=f3bb57b8a498d0be449312df296bba20d02b53c1;hpb=69bcd68523a9a8da083faef16887100369152673;p=yaz-moved-to-github.git diff --git a/include/yaz/wrbuf.h b/include/yaz/wrbuf.h index f3bb57b..7d757a3 100644 --- a/include/yaz/wrbuf.h +++ b/include/yaz/wrbuf.h @@ -1,88 +1,129 @@ -/* - * Copyright (c) 1995-2000, Index Data. - * - * Permission to use, copy, modify, distribute, and sell this software and - * its documentation, in whole or in part, for any purpose, is hereby granted, - * provided that: - * - * 1. This copyright and permission notice appear in all copies of the - * software and its documentation. Notices of copyright or attribution - * which appear at the beginning of any file must remain unchanged. - * - * 2. The names of Index Data or the individual authors may not be used to - * endorse or promote products derived from this software without specific - * prior written permission. - * - * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND, - * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY - * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. - * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL, - * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR - * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF - * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE - * OF THIS SOFTWARE. - * - * $Log: wrbuf.h,v $ - * Revision 1.4 2001-10-23 21:00:19 adam - * Old Z39.50 codecs gone. Added ZOOM. WRBUF MARC display util. - * - * Revision 1.3 2001/10/15 19:36:48 adam - * New function marc_display_wrbuf. - * - * Revision 1.2 2000/02/28 11:20:06 adam - * Using autoconf. New definitions: YAZ_BEGIN_CDECL/YAZ_END_CDECL. - * - * Revision 1.1 1999/11/30 13:47:11 adam - * Improved installation. Moved header files to include/yaz. - * - * Revision 1.8 1999/11/03 09:05:56 adam - * Implemented wrbuf_puts. +/* This file is part of the YAZ toolkit. + * Copyright (C) 1995-2008 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: * - * Revision 1.7 1999/08/27 09:40:32 adam - * Renamed logf function to yaz_log. Removed VC++ project files. - * - * Revision 1.6 1997/10/31 12:20:08 adam - * Improved memory debugging for xmalloc/nmem.c. References to NMEM - * instead of ODR in n ESPEC-1 handling in source d1_espec.c. - * Bug fix: missing fclose in data1_read_espec1. - * - * Revision 1.5 1997/09/17 12:10:32 adam - * YAZ version 1.4. + * * 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. + */ + +/** + * \file wrbuf.h + * \brief Header for WRBUF (growing buffer) */ #ifndef WRBUF_H #define WRBUF_H #include +#include YAZ_BEGIN_CDECL +/** \brief string buffer */ typedef struct wrbuf { char *buf; - int pos; - int size; + size_t pos; + size_t size; } wrbuf, *WRBUF; +/** \brief allocate / construct WRBUF */ YAZ_EXPORT WRBUF wrbuf_alloc(void); -YAZ_EXPORT void wrbuf_free(WRBUF b, int free_buf); + +/** \brief destroy WRBUF and its buffer */ +YAZ_EXPORT void wrbuf_destroy(WRBUF b); + +/** \brief empty WRBUF content */ YAZ_EXPORT void wrbuf_rewind(WRBUF b); -YAZ_EXPORT int wrbuf_grow(WRBUF b, int minsize); + +/** \brief writes (append) buffer to WRBUF */ YAZ_EXPORT int wrbuf_write(WRBUF b, const char *buf, int size); +/** \brief appends C-string to WRBUF (returns int) */ YAZ_EXPORT int wrbuf_puts(WRBUF b, const char *buf); +/** \brief appends C-string to WRBUF (void) */ +YAZ_EXPORT void wrbuf_vputs(const char *buf, void *client_data); + +/** \brief writes buffer to WRBUF and XML encode (as CDATA) */ +YAZ_EXPORT int wrbuf_xmlputs_n(WRBUF b, const char *cp, int size); +/** \brief writes C-String to WRBUF and XML encode (as CDATA) */ +YAZ_EXPORT int wrbuf_xmlputs(WRBUF b, const char *cp); + +YAZ_EXPORT int wrbuf_puts_replace_char(WRBUF b, const char *buf, + const char from, const char to); + +/** \brief writes buffer to WRBUF and escape non-ASCII characters */ +YAZ_EXPORT void wrbuf_puts_escaped(WRBUF b, const char *str); + +/** \brief writes C-string to WRBUF and escape non-ASCII characters */ +YAZ_EXPORT void wrbuf_write_escaped(WRBUF b, const char *buf, size_t len); + +/** \brief writes printf result to WRBUF */ +YAZ_EXPORT void wrbuf_printf(WRBUF b, const char *fmt, ...) +#ifdef __GNUC__ + __attribute__ ((format (printf, 2, 3))) +#endif + ; + +YAZ_EXPORT int wrbuf_iconv_write(WRBUF b, yaz_iconv_t cd, const char *buf, + int size); +YAZ_EXPORT int wrbuf_iconv_write_cdata(WRBUF b, yaz_iconv_t cd, + const char *buf, int size); +YAZ_EXPORT int wrbuf_iconv_puts_cdata(WRBUF b, yaz_iconv_t cd, + const char *strz); + +YAZ_EXPORT int wrbuf_iconv_puts(WRBUF b, yaz_iconv_t cd, const char *strz); + +YAZ_EXPORT int 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); + +/** \brief cut size of WRBUF */ +YAZ_EXPORT void wrbuf_cut_right(WRBUF b, size_t no_to_remove); + + +/** \brief grow WRBUF larger + This function is normally not used by applications +*/ +YAZ_EXPORT int wrbuf_grow(WRBUF b, int minsize); #define wrbuf_len(b) ((b)->pos) #define wrbuf_buf(b) ((b)->buf) +YAZ_EXPORT const char *wrbuf_cstr(WRBUF b); + #define wrbuf_putc(b, c) \ (((b)->pos >= (b)->size ? wrbuf_grow(b, 1) : 0), \ (b)->buf[(b)->pos++] = (c), 0) -YAZ_EXPORT int marc_display_wrbuf (const char *buf, WRBUF wr, int debug, - int bsize); - YAZ_END_CDECL #endif +/* + * Local variables: + * c-basic-offset: 4 + * indent-tabs-mode: nil + * End: + * vim: shiftwidth=4 tabstop=8 expandtab + */ +