wrbuf.c File Reference

Implements WRBUF (growing buffer) More...

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <stdarg.h>
#include <yaz/wrbuf.h>
#include <yaz/snprintf.h>
#include <yaz/yaz-iconv.h>

Go to the source code of this file.

Functions
WRBUF	wrbuf_alloc (void)
	construct WRBUF
void	wrbuf_destroy (WRBUF b)
	destroy WRBUF and its buffer
void	wrbuf_rewind (WRBUF b)
	empty WRBUF content (length of buffer set to 0)
int	wrbuf_grow (WRBUF b, size_t minsize)
	grow WRBUF larger
void	wrbuf_write (WRBUF b, const char *buf, size_t size)
	append constant size buffer to WRBUF
void	wrbuf_insert (WRBUF b, size_t pos, const char *buf, size_t size)
	inserts buffer into WRBUF at some position
void	wrbuf_puts (WRBUF b, const char *buf)
	appends C-string to WRBUF
void	wrbuf_vp_puts (const char *buf, void *client_data)
	appends C-string to WRBUF - void pointer variant
void	wrbuf_puts_replace_char (WRBUF b, const char *buf, const char from, const char to)
	puts buf to WRBUF and replaces a single char
void	wrbuf_chop_right (WRBUF b)
	chips traling blanks away from WRBUF
void	wrbuf_xmlputs (WRBUF b, const char *cp)
	writes C-String to WRBUF and XML encode (as CDATA)
void	wrbuf_xmlputs_n (WRBUF b, const char *cp, size_t size)
	writes buffer of certain size to WRBUF and XML encode (as CDATA)
void	wrbuf_printf (WRBUF b, const char *fmt,...)
	writes printf result to WRBUF
int	wrbuf_iconv_write_x (WRBUF b, yaz_iconv_t cd, const char *buf, size_t size, int cdata)
	general writer of string using iconv and cdata
void	wrbuf_iconv_write (WRBUF b, yaz_iconv_t cd, const char *buf, size_t size)
	iconv converts buffer and appends to WRBUF
void	wrbuf_iconv_puts (WRBUF b, yaz_iconv_t cd, const char *strz)
	iconv converts C-string and appends to WRBUF
void	wrbuf_iconv_putchar (WRBUF b, yaz_iconv_t cd, int ch)
	iconv converts character and appends to WRBUF
void	wrbuf_iconv_write_cdata (WRBUF b, yaz_iconv_t cd, const char *buf, size_t size)
	iconv converts buffer and appends to WRBUF as XML CDATA
void	wrbuf_iconv_puts_cdata (WRBUF b, yaz_iconv_t cd, const char *strz)
	iconv converts C-string and appends to WRBUF as XML CDATA
void	wrbuf_iconv_reset (WRBUF b, yaz_iconv_t cd)
	iconv reset(flush) to WRBUF
const char *	wrbuf_cstr (WRBUF b)
	returns WRBUF content as C-string
void	wrbuf_cut_right (WRBUF b, size_t no_to_remove)
	cut size of WRBUF
void	wrbuf_puts_escaped (WRBUF b, const char *str)
	writes C-string to WRBUF and escape non-ASCII characters
void	wrbuf_write_escaped (WRBUF b, const char *str, size_t len)
	writes buffer to WRBUF and escape non-ASCII characters

Detailed Description

Implements WRBUF (growing buffer)

Definition in file wrbuf.c.

Function Documentation

WRBUF wrbuf_alloc

(

void

)

construct WRBUF

Returns

WRBUF

Definition at line 24 of file wrbuf.c.

References wrbuf::buf, wrbuf::pos, wrbuf::size, and xmalloc.

Referenced by add_marc_datafield_turbo_xml(), bibliographicRecord(), ccl_pr_tree(), ccl_rpn_query(), ccl_scan_query(), ccl_xml_config(), config_include_src(), cql2pqf(), cql_transform_create(), cql_transform_parse_tok_line(), cql_transform_rpn2cql_stream(), dummy_xml_record(), echo_extra_args(), get_facet_term_count(), get_term_hit(), process_deleteRequest(), process_ESRequest(), process_initRequest(), process_presentRequest(), process_scanRequest(), process_sortRequest(), replace_node(), response_searchRequest(), retrieve_fetch(), solr_transform_create(), solr_transform_parse_tok_line(), solr_transform_rpn2solr_stream(), srw_bend_scan(), srw_bend_search(), yaz_marc_create(), yaz_marc_read_iso2709(), yaz_marc_read_line(), yaz_marc_write_iso2709(), yaz_marc_write_xml(), yaz_marc_write_xml_turbo_xml(), yaz_query_charset_convert_apt(), yaz_query_charset_convert_rpnquery(), yaz_query_charset_convert_rpnquery_check(), yaz_record_conv_create(), yaz_record_conv_opac_record(), yaz_retrieval_create(), yaz_sc_program(), yaz_solr_decode_spellcheck(), yaz_solr_encode_facet_field(), yaz_sru_proxy_get_facet_term_count(), yaz_tok_parse_create(), ZOOM_connection_option_set(), ZOOM_query_ccl2rpn(), ZOOM_query_create(), ZOOM_record_get(), and ZOOM_resultset_create().

void wrbuf_chop_right

(

WRBUF

b

)

chips traling blanks away from WRBUF

Parameters

b

WRBUF

Definition at line 112 of file wrbuf.c.

References wrbuf::buf, and wrbuf::pos.

Referenced by yaz_rpnquery_to_wrbuf().

const char* wrbuf_cstr

(

WRBUF

b

)

returns WRBUF content as C-string

Parameters

b

WRBUF

Returns

C-string

Definition at line 252 of file wrbuf.c.

References wrbuf::buf, wrbuf::pos, and wrbuf_putc.

Referenced by add_marc_datafield_turbo_xml(), base64_render(), ccl_pr_tree(), ccl_rpn_query(), ccl_scan_query(), config_include_src(), cql2pqf(), cql_transform_parse_tok_line(), dummy_xml_record(), echo_extra_args(), generate(), get_facet_term_count(), get_record_format(), get_term_hit(), process_deleteRequest(), process_ESRequest(), process_initRequest(), process_presentRequest(), process_scanRequest(), process_sortRequest(), response_searchRequest(), return_marc_record(), return_opac_record(), return_string_record(), rpn2cql_simple(), rpn2solr_simple(), solr_transform_parse_tok_line(), srw_bend_scan(), srw_bend_search(), yaz_marc_decode_buf(), yaz_marc_read_iso2709(), yaz_marc_read_line(), yaz_marc_write_xml(), yaz_marc_write_xml_turbo_xml(), yaz_record_conv_get_error(), yaz_retrieval_get_error(), yaz_sc_program(), yaz_solr_decode_spellcheck(), yaz_solr_encode_facet_field(), yaz_sru_proxy_get_facet_term_count(), yaz_tok_parse_string(), ZOOM_connection_option_get(), ZOOM_connection_option_getl(), ZOOM_query_ccl2rpn(), ZOOM_query_get_query_string(), and ZOOM_query_get_sru11().

void wrbuf_cut_right	(	WRBUF	b,
		size_t	no_to_remove
	)

cut size of WRBUF

Parameters

b	WRBUF
no_to_remove	number of bytes to remove

Definition at line 259 of file wrbuf.c.

References wrbuf::pos.

Referenced by yaz_marc_line_gets().

void wrbuf_destroy

(

WRBUF

b

)

destroy WRBUF and its buffer

Parameters

b

WRBUF

For YAZ 4.0.2 WRBUF b may be NULL.

Definition at line 36 of file wrbuf.c.

References wrbuf::buf, and xfree.

Referenced by add_marc_datafield_turbo_xml(), bibliographicRecord(), ccl_pr_tree(), ccl_rpn_query(), ccl_scan_query(), ccl_xml_config(), config_include_src(), cql2pqf(), cql_transform_close(), cql_transform_parse_tok_line(), cql_transform_rpn2cql_stream(), dummy_xml_record(), echo_extra_args(), get_facet_term_count(), get_term_hit(), process_deleteRequest(), process_ESRequest(), process_initRequest(), process_presentRequest(), process_scanRequest(), process_sortRequest(), replace_node(), response_searchRequest(), resultset_destroy(), retrieve_fetch(), solr_transform_close(), solr_transform_parse_tok_line(), solr_transform_rpn2solr_stream(), srw_bend_scan(), srw_bend_search(), yaz_marc_destroy(), yaz_marc_read_iso2709(), yaz_marc_read_line(), yaz_marc_write_iso2709(), yaz_marc_write_xml(), yaz_marc_write_xml_turbo_xml(), yaz_query_charset_convert_apt(), yaz_query_charset_convert_rpnquery(), yaz_query_charset_convert_rpnquery_check(), yaz_record_conv_destroy(), yaz_record_conv_opac_record(), yaz_retrieval_destroy(), yaz_sc_program(), yaz_solr_encode_facet_field(), yaz_sru_proxy_get_facet_term_count(), yaz_tok_parse_destroy(), ZOOM_connection_destroy(), ZOOM_connection_option_set(), ZOOM_query_ccl2rpn(), ZOOM_query_destroy(), and ZOOM_record_release().

int wrbuf_grow	(	WRBUF	b,
		size_t	minsize
	)

grow WRBUF larger

Parameters

b	WRBUF
minsize	make WRBUF at least this size

This function is normally not used by applications

Definition at line 50 of file wrbuf.c.

References wrbuf::buf, wrbuf::size, xmalloc, and xrealloc.

Referenced by wrbuf_insert(), and wrbuf_write().

void wrbuf_iconv_putchar	(	WRBUF	b,
		yaz_iconv_t	cd,
		int	ch
	)

iconv converts character and appends to WRBUF

Parameters

b	WRBUF
cd	iconv handle
ch	character

Definition at line 222 of file wrbuf.c.

References wrbuf_iconv_write().

Referenced by yaz_marc_write_iso2709().

void wrbuf_iconv_puts	(	WRBUF	b,
		yaz_iconv_t	cd,
		const char *	str
	)

iconv converts C-string and appends to WRBUF

Parameters

b	WRBUF
cd	iconv handle
str	C-string

Definition at line 217 of file wrbuf.c.

References wrbuf_iconv_write().

Referenced by add_marc_datafield_turbo_xml(), yaz_marc_write_iso2709(), yaz_marc_write_line(), yaz_marc_write_marcxml_wrbuf(), yaz_marc_write_xml(), and yaz_marc_write_xml_turbo_xml().

void wrbuf_iconv_puts_cdata	(	WRBUF	b,
		yaz_iconv_t	cd,
		const char *	str
	)

iconv converts C-string and appends to WRBUF as XML CDATA

Parameters

b	WRBUF
cd	iconv handle
str	C-string

Definition at line 234 of file wrbuf.c.

References wrbuf_iconv_write_x().

void wrbuf_iconv_reset	(	WRBUF	b,
		yaz_iconv_t	cd
	)

iconv reset(flush) to WRBUF

Parameters

b
cd	iconv handle

This function calls iconv(cd, 0, 0, ..) to make it flush any remaining content.

Definition at line 239 of file wrbuf.c.

References wrbuf_write(), and yaz_iconv().

Referenced by marc_iconv_reset(), return_string_record(), and yaz_query_charset_convert_buf().

void wrbuf_iconv_write	(	WRBUF	b,
		yaz_iconv_t	cd,
		const char *	buf,
		size_t	size
	)

iconv converts buffer and appends to WRBUF

Parameters

b	WRBUF
cd	iconv handle
buf	buffer
size	size of buffer

Definition at line 212 of file wrbuf.c.

References wrbuf_iconv_write_x().

Referenced by add_marc_datafield_turbo_xml(), return_string_record(), wrbuf_iconv_putchar(), wrbuf_iconv_puts(), yaz_marc_write_check(), yaz_marc_write_line(), yaz_marc_write_xml(), and yaz_query_charset_convert_buf().

void wrbuf_iconv_write_cdata	(	WRBUF	b,
		yaz_iconv_t	cd,
		const char *	buf,
		size_t	size
	)

iconv converts buffer and appends to WRBUF as XML CDATA

Parameters

b	WRBUF
cd	iconv handle
buf	buffer
size	size of buffer

Definition at line 229 of file wrbuf.c.

References wrbuf_iconv_write_x().

Referenced by element_name_append_attribute_value(), and yaz_marc_write_marcxml_wrbuf().

int wrbuf_iconv_write_x	(	WRBUF	b,
		yaz_iconv_t	cd,
		const char *	buf,
		size_t	size,
		int	cdata
	)

general writer of string using iconv and cdata

Parameters

b	WRBUF
cd	iconv handle (0 for no conversion)
buf	buffer
size	size of buffer
cdata	non-zero for CDATA; 0 for cdata

Returns

-1 if invalid sequence was encountered (truncation in effect)

0 if buffer could be converted and written

Definition at line 172 of file wrbuf.c.

References wrbuf_write(), wrbuf_xmlputs_n(), yaz_iconv(), YAZ_ICONV_E2BIG, and yaz_iconv_error().

Referenced by opac_element_str(), wrbuf_iconv_puts_cdata(), wrbuf_iconv_write(), and wrbuf_iconv_write_cdata().

void wrbuf_insert	(	WRBUF	b,
		size_t	pos,
		const char *	buf,
		size_t	size
	)

inserts buffer into WRBUF at some position

Parameters

b	WRBUF
pos	position (0=beginning)
buf	buffer
size	size of buffer

Definition at line 77 of file wrbuf.c.

References wrbuf::buf, wrbuf::pos, wrbuf::size, and wrbuf_grow().

Referenced by yaz_sort_spec_to_type7().

void wrbuf_printf	(	WRBUF	b,
		const char *	fmt,
			...
	)

writes printf result to WRBUF

Parameters

b	WRBUF
fmt	printf-like format

Definition at line 160 of file wrbuf.c.

References wrbuf_puts(), and yaz_vsnprintf().

Referenced by ccl_pquery_complex(), ccl_xml_config_attr(), conf_dir_path(), conf_retrieval(), config_include_src(), construct_marc(), construct_xslt(), convert_marc(), convert_xslt(), display_grs1(), display_variant(), element_name_append_attribute_value(), json_write_wrbuf_r(), process_deleteRequest(), process_initRequest(), process_presentRequest(), process_scanRequest(), process_sortRequest(), response_searchRequest(), rpn2cql_simple(), rpn2solr_simple(), srw_bend_scan(), srw_bend_search(), wr_diag(), wrbuf_diags(), wrbuf_json_write(), wrbuf_write_escaped(), yaz_apt_to_wrbuf(), yaz_attribute_element_to_wrbuf(), yaz_marc_write_iso2709(), yaz_marc_write_line(), yaz_marc_write_marcxml_wrbuf(), yaz_marc_write_trailer(), yaz_query_to_wrbuf(), yaz_record_conv_configure_t(), yaz_retrieval_configure_t(), yaz_retrieval_request(), yaz_rpnquery_to_wrbuf(), yaz_rpnstructure_to_wrbuf(), yaz_solr_decode_misspelled(), yaz_sort_spec_to_type7(), and yaz_spipe_create().

void wrbuf_puts	(	WRBUF	b,
		const char *	buf
	)

appends C-string to WRBUF

Parameters

b	WRBUF
buf	C-string (0-terminated)

Definition at line 88 of file wrbuf.c.

References wrbuf_write().

Referenced by add_marc_datafield_turbo_xml(), ccl_pquery_complex(), ccl_pquery_indent(), conf_dir_path(), cql2pqf_wrbuf_puts(), cql_transform_parse_tok_line(), display_grs1(), echo_extra_args(), extract_text_node(), generate(), get_facet_term_count(), json_write_wrbuf_r(), opac_element_bool(), opac_element_str(), process_scanRequest(), process_sortRequest(), response_searchRequest(), rpn2cql_attr(), rpn2cql_simple(), rpn2solr_attr(), rpn2solr_simple(), solr_transform_parse_tok_line(), wr_diag(), wrbuf_diags(), wrbuf_printf(), wrbuf_vp_puts(), wrbuf_xmlputs_n(), yaz_apt_to_wrbuf(), yaz_attribute_element_to_wrbuf(), yaz_marc_line_gets(), yaz_marc_read_iso2709(), yaz_marc_write_check(), yaz_marc_write_line(), yaz_marc_write_marcxml_ns(), yaz_marc_write_marcxml_wrbuf(), yaz_opac_decode_wrbuf2(), yaz_query_to_wrbuf(), yaz_record_conv_opac_record(), yaz_rpnstructure_to_wrbuf(), yaz_sc_program(), yaz_scan_to_wrbuf(), yaz_solr_decode_misspelled(), yaz_solr_decode_spellcheck(), yaz_solr_decode_suggestion_values(), yaz_solr_encode_facet_field(), yaz_solr_sortkeys_to_sort_spec(), yaz_sort_spec_to_cql(), yaz_sort_spec_to_solr_sortkeys(), yaz_sort_spec_to_srw_sortkeys(), yaz_sort_spec_to_type7(), yaz_sru_proxy_get_facet_term_count(), and yaz_srw_sortkeys_to_sort_spec().

void wrbuf_puts_escaped	(	WRBUF	b,
		const char *	str
	)

writes C-string to WRBUF and escape non-ASCII characters

Parameters

b	WRBUF
str	C-string

Non-ASCII characters will be presented as \xDD .

Definition at line 266 of file wrbuf.c.

References wrbuf_write_escaped().

void wrbuf_puts_replace_char	(	WRBUF	b,
		const char *	buf,
		const char	from,
		const char	to
	)

puts buf to WRBUF and replaces a single char

Parameters

b	WRBUF
buf	buffer to append (C-string)
from	character "from"
to	charcter "to"

Definition at line 99 of file wrbuf.c.

References wrbuf_putc.

Referenced by wr_diag().

void wrbuf_rewind

(

WRBUF

b

)

empty WRBUF content (length of buffer set to 0)

Parameters

b

WRBUF

Definition at line 45 of file wrbuf.c.

References wrbuf::pos.

Referenced by add_marc_datafield_turbo_xml(), base64_render(), config_include_src(), convert_marc(), convert_xslt(), cql_transform_open_FILE(), generate(), get_record_format(), return_record_wrbuf(), rpn2cql_simple(), rpn2solr_simple(), solr_transform_open_FILE(), yaz_marc_decode_buf(), yaz_marc_line_gets(), yaz_marc_write_iso2709(), yaz_marc_write_xml(), yaz_marc_write_xml_turbo_xml(), yaz_query_charset_convert_buf(), yaz_record_conv_configure_t(), yaz_record_conv_opac_record(), yaz_record_conv_record_rule(), yaz_record_conv_reset(), yaz_retrieval_request(), yaz_retrieval_reset(), yaz_tok_move(), and ZOOM_connection_option_set().

void wrbuf_vp_puts	(	const char *	buf,
		void *	client_data
	)

appends C-string to WRBUF - void pointer variant

Parameters

buf	C-string
client_data	assumed WRBUF

Definition at line 93 of file wrbuf.c.

References wrbuf_puts().

Referenced by cql2pqf().

void wrbuf_write	(	WRBUF	b,
		const char *	buf,
		size_t	size
	)

append constant size buffer to WRBUF

Parameters

b	WRBUF
buf	buffer
size	size of buffer

Definition at line 67 of file wrbuf.c.

References wrbuf::buf, wrbuf::pos, wrbuf::size, and wrbuf_grow().

Referenced by base64_render(), convert_xslt(), get_record_format(), get_term_hit(), odr_wrbuf_write(), wrbuf_iconv_reset(), wrbuf_iconv_write_x(), wrbuf_puts(), wrbuf_vputs(), yaz_marc_write_iso2709(), yaz_marc_write_marcxml_ns(), yaz_query_to_wrbuf(), yaz_record_conv_record_rule(), yaz_sort_spec_to_cql(), and yaz_sort_spec_to_srw_sortkeys().

void wrbuf_write_escaped	(	WRBUF	b,
		const char *	buf,
		size_t	len
	)

writes buffer to WRBUF and escape non-ASCII characters

Parameters

b	WRBUF
buf	buffer
len	size of buffer

Non-ASCII characters will be presented as \xDD .

Definition at line 271 of file wrbuf.c.

References wrbuf_printf(), and wrbuf_putc.

Referenced by wrbuf_puts_escaped(), and yaz_marc_read_iso2709().

void wrbuf_xmlputs	(	WRBUF	b,
		const char *	cp
	)

writes C-String to WRBUF and XML encode (as CDATA)

Parameters

b	WRBUF
cp	CDATA buffer (0-terminated)

Definition at line 120 of file wrbuf.c.

References wrbuf_xmlputs_n().

Referenced by echo_extra_args().

void wrbuf_xmlputs_n	(	WRBUF	b,
		const char *	cp,
		size_t	size
	)

writes buffer of certain size to WRBUF and XML encode (as CDATA)

Parameters

b	WRBUF
cp	CDATA
size	size of CDATA

Definition at line 125 of file wrbuf.c.

References wrbuf_putc, and wrbuf_puts().

Referenced by wrbuf_iconv_write_x(), and wrbuf_xmlputs().