Implements CQL transform (CQL to RPN conversion). More...

#include <assert.h>
#include <stdlib.h>
#include <string.h>
#include <yaz/rpn2cql.h>
#include <yaz/xmalloc.h>
#include <yaz/diagsrw.h>
#include <yaz/tokenizer.h>
#include <yaz/wrbuf.h>
#include <yaz/z-core.h>
#include <yaz/matchstr.h>
#include <yaz/oid_db.h>
#include <yaz/log.h>
#include <yaz/proxunit.h>

Data Structures
struct	cql_prop_entry

struct	cql_transform_t_

Functions
cql_transform_t	cql_transform_create (void)
	creates a CQL transform handle

static int	cql_transform_parse_tok_line (cql_transform_t ct, const char *pattern, yaz_tok_parse_t tp)

int	cql_transform_define_pattern (cql_transform_t ct, const char pattern, const char value)
	defines CQL transform pattern

cql_transform_t	cql_transform_open_FILE (FILE *f)
	creates a CQL transform handle from an opened file handle

int	cql_transform_define_FILE (cql_transform_t ct, FILE *f)
	extends transform from opened file

void	cql_transform_close (cql_transform_t ct)
	destroys a CQL transform handle

cql_transform_t	cql_transform_open_fname (const char *fname)
	creates a CQL transform handle from a file

int	cql_transform_define_fname (cql_transform_t ct, const char *fname)
	extends transform from a file

static int	compare_attr (Z_AttributeElement a, Z_AttributeElement b)

const char *	cql_lookup_reverse (cql_transform_t ct, const char category, Z_AttributeList attributes)
	find a pattern that has a subset of attributes

static const char *	cql_lookup_property (cql_transform_t ct, const char pat1, const char pat2, const char *pat3)

int	cql_pr_attr_uri (cql_transform_t ct, WRBUF addinfo, const char category, const char uri, const char val, const char default_val, void(pr)(const char buf, void client_data), void client_data, int errcode)

int	cql_pr_attr (cql_transform_t ct, WRBUF addinfo, const char category, const char val, const char default_val, void(pr)(const char buf, void client_data), void *client_data, int errcode)

static void	cql_pr_int (int val, void(pr)(const char buf, void client_data), void client_data)

static int	cql_pr_prox (cql_transform_t ct, struct cql_node mods, WRBUF addinfo, void(pr)(const char buf, void client_data), void *client_data)

static int	has_modifier (struct cql_node cn, const char name)

static int	emit_term (cql_transform_t ct, struct cql_node cn, WRBUF addinfo, const char term, int length, void(pr)(const char buf, void client_data), void client_data)

static int	emit_terms (cql_transform_t ct, struct cql_node cn, WRBUF addinfo, void(pr)(const char buf, void client_data), void client_data, const char op)

static int	emit_wordlist (cql_transform_t ct, struct cql_node cn, WRBUF addinfo, void(pr)(const char buf, void client_data), void client_data, const char op)

static int	emit_node (cql_transform_t ct, struct cql_node cn, WRBUF addinfo, void(pr)(const char buf, void client_data), void *client_data)

int	cql_transform_r (cql_transform_t ct, struct cql_node cn, WRBUF addinfo, void(pr)(const char buf, void client_data), void *client_data)
	tranforms PQF given a CQL tree (re-entrant)

int	cql_transform (cql_transform_t ct, struct cql_node cn, void(pr)(const char buf, void client_data), void *client_data)
	tranforms PQF given a CQL tree (NOT re-entrant)

int	cql_transform_FILE (cql_transform_t ct, struct cql_node cn, FILE f)
	transforms PQF given a CQL tree from FILE (not re-entrant)

int	cql_transform_buf (cql_transform_t ct, struct cql_node cn, char out, int max)
	transforms PQF given a CQL tree from buffer (not re-entrant)

int	cql_transform_error (cql_transform_t ct, const char **addinfo)
	returns additional information for last transform

void	cql_transform_set_error (cql_transform_t ct, int error, const char *addinfo)
	sets error and addinfo for transform

Detailed Description

Implements CQL transform (CQL to RPN conversion).

Evaluation order of rules:

always relation structure position truncation index relationModifier

Definition in file cqltransform.c.

Function Documentation

◆ compare_attr()

static int compare_attr	(	Z_AttributeElement *	a,
		Z_AttributeElement *	b
	)

static

Definition at line 314 of file cqltransform.c.

References odr_createmem(), odr_destroy(), ODR_ENCODE, odr_getbuf(), yaz_memcmp(), and z_AttributeElement().

Referenced by cql_lookup_reverse().

◆ cql_lookup_property()

static const char * cql_lookup_property	(	cql_transform_t	ct,
		const char *	pat1,
		const char *	pat2,
		const char *	pat3
	)

static

Definition at line 376 of file cqltransform.c.

References cql_strcmp(), cql_transform_t_::entry, cql_prop_entry::next, cql_prop_entry::pattern, and cql_prop_entry::value.

Referenced by cql_pr_attr_uri(), and emit_term().

◆ cql_lookup_reverse()

const char * cql_lookup_reverse	(	cql_transform_t	ct,
		const char *	category,
		Z_AttributeList *	attributes
	)

find a pattern that has a subset of attributes

Parameters

ct	CQL transform handle
category	pattern category
attributes	RPN attributes

Returns: pattern value or NULL if not found

Definition at line 335 of file cqltransform.c.

References cql_prop_entry::attr_list, Z_AttributeList::attributes, Z_AttributeElement::attributeSet, compare_attr(), cql_transform_t_::entry, cql_prop_entry::next, Z_AttributeList::num_attributes, oid_oidcmp(), cql_prop_entry::pattern, and yaz_oid_attset_bib_1.

Referenced by rpn2cql_attr(), and solr_lookup_reverse().

◆ cql_pr_attr()

int cql_pr_attr	(	cql_transform_t	ct,
		WRBUF	addinfo,
		const char *	category,
		const char *	val,
		const char *	default_val,
		void()(const char buf, void *client_data)	pr,
		void *	client_data,
		int	errcode
	)

Definition at line 488 of file cqltransform.c.

References cql_pr_attr_uri().

Referenced by emit_node(), and emit_term().

◆ cql_pr_attr_uri()

int cql_pr_attr_uri	(	cql_transform_t	ct,
		WRBUF	addinfo,
		const char *	category,
		const char *	uri,
		const char *	val,
		const char *	default_val,
		void()(const char buf, void *client_data)	pr,
		void *	client_data,
		int	errcode
	)

Definition at line 402 of file cqltransform.c.

References cql_lookup_property(), cql_transform_t_::entry, cql_prop_entry::next, cql_prop_entry::pattern, cql_prop_entry::value, and wrbuf_puts().

Referenced by cql_pr_attr(), emit_node(), and emit_term().

◆ cql_pr_int()

static void cql_pr_int	(	int	val,
		void()(const char buf, void *client_data)	pr,
		void *	client_data
	)

static

Definition at line 499 of file cqltransform.c.

Referenced by cql_pr_prox().

◆ cql_pr_prox()

static int cql_pr_prox	(	cql_transform_t	ct,
		struct cql_node *	mods,
		WRBUF	addinfo,
		void()(const char buf, void *client_data)	pr,
		void *	client_data
	)

static

Definition at line 510 of file cqltransform.c.

References cql_pr_int(), cql_node::index, cql_node::modifiers, name, cql_node::relation, cql_node::st, cql_node::term, cql_node::u, wrbuf_puts(), YAZ_SRW_UNSUPP_BOOLEAN_MODIFIER, YAZ_SRW_UNSUPP_PROX_RELATION, YAZ_SRW_UNSUPP_PROX_UNIT, and z_str_to_ProxUnit().

Referenced by emit_node().

◆ cql_transform()

int cql_transform	(	cql_transform_t	ct,
		struct cql_node *	cn,
		void()(const char buf, void *client_data)	pr,
		void *	client_data
	)

tranforms PQF given a CQL tree (NOT re-entrant)

Parameters

ct	CQL transform handle
cn	CQL node tree
pr	print function
client_data	data to be passed to pr

Return values

0	success
!=	0 error

The result is written to a user-defined stream.

Definition at line 1000 of file cqltransform.c.

References cql_transform_r(), cql_transform_set_error(), wrbuf_alloc(), wrbuf_cstr(), and wrbuf_destroy().

Referenced by cql2pqf(), cql2pqf(), cql_transform_buf(), and cql_transform_FILE().

◆ cql_transform_buf()

int cql_transform_buf	(	cql_transform_t	ct,
		struct cql_node *	cn,
		char *	out,
		int	max
	)

transforms PQF given a CQL tree from buffer (not re-entrant)

Parameters

ct	CQL transform handle
cn	CQL tree
out	buffer for output
max	maximum bytes for output (size of buffer)

Return values

0	success
!=0	failure (error code)

Definition at line 1016 of file cqltransform.c.

References cql_buf_write_info::buf, cql_buf_write_handler(), cql_transform(), cql_transform_set_error(), cql_buf_write_info::max, cql_buf_write_info::off, and YAZ_SRW_TOO_MANY_CHARS_IN_QUERY.

◆ cql_transform_close()

void cql_transform_close ( cql_transform_t ct )

destroys a CQL transform handle

Parameters

ct	CQL transform handle

Definition at line 258 of file cqltransform.c.

References cql_transform_t_::addinfo, cql_transform_t_::entry, cql_prop_entry::next, cql_transform_t_::nmem, nmem_destroy(), cql_prop_entry::pattern, cql_transform_t_::tok_cfg, cql_prop_entry::value, wrbuf_destroy(), xfree, and yaz_tok_cfg_destroy().

Referenced by cql2pqf(), cql_transform_open_FILE(), cql_transform_open_fname(), and solr_transform_close().

◆ cql_transform_create()

cql_transform_t cql_transform_create ( void )

creates a CQL transform handle

Returns: transform handle or NULL for failure

Definition at line 53 of file cqltransform.c.

References cql_transform_t_::addinfo, cql_transform_t_::entry, cql_transform_t_::error, cql_transform_t_::nmem, nmem_create(), cql_transform_t_::tok_cfg, wrbuf_alloc(), xmalloc, and yaz_tok_cfg_create().

Referenced by cql_transform_open_FILE(), cql_transform_open_fname(), and solr_transform_create().

◆ cql_transform_define_FILE()

int cql_transform_define_FILE	(	cql_transform_t	ct,
		FILE *	f
	)

extends transform from opened file

Parameters

ct	CQL transform handle
f	file where transformation spec is read

Returns: 0 for success; -1 for failure

Definition at line 226 of file cqltransform.c.

References cql_transform_parse_tok_line(), cql_prop_entry::pattern, cql_transform_t_::tok_cfg, xfree, xstrdup, yaz_tok_cfg_single_tokens(), YAZ_TOK_EOF, yaz_tok_move(), yaz_tok_parse_buf(), yaz_tok_parse_destroy(), yaz_tok_parse_string(), and YAZ_TOK_STRING.

Referenced by cql_transform_define_fname(), and cql_transform_open_FILE().

◆ cql_transform_define_fname()

int cql_transform_define_fname	(	cql_transform_t	ct,
		const char *	fname
	)

extends transform from a file

Parameters

fname name of where transformation spec is read

Returns: transform handle or NULL for failure

Definition at line 289 of file cqltransform.c.

References cql_transform_define_FILE().

Referenced by cql_transform_open_fname().

◆ cql_transform_define_pattern()

int cql_transform_define_pattern	(	cql_transform_t	ct,
		const char *	pattern,
		const char *	value
	)

defines CQL transform pattern

Parameters

ct	CQL transform handle
pattern	pattern string
value	pattern value

Returns: 0 for succes; -1 for failure

Definition at line 204 of file cqltransform.c.

References cql_transform_parse_tok_line(), cql_prop_entry::pattern, cql_transform_t_::tok_cfg, cql_prop_entry::value, yaz_tok_cfg_single_tokens(), yaz_tok_parse_buf(), and yaz_tok_parse_destroy().

Referenced by solr_transform_define_pattern().

◆ cql_transform_error()

int cql_transform_error	(	cql_transform_t	ct,
		const char **	addinfo
	)

returns additional information for last transform

Parameters

ct	CQL transform handle
addinfo	additional info (result)

Returns: error code

Definition at line 1040 of file cqltransform.c.

References cql_transform_t_::addinfo, cql_transform_t_::error, wrbuf_cstr(), and wrbuf_len.

Referenced by cql2pqf(), cql2pqf(), and solr_transform_error().

◆ cql_transform_FILE()

int cql_transform_FILE	(	cql_transform_t	ct,
		struct cql_node *	cn,
		FILE *	f
	)

transforms PQF given a CQL tree from FILE (not re-entrant)

Parameters

ct	CQL transform handle
cn	CQL tree
f	FILE where output is written

Return values

0	success
!=0	failure (error code)

The result is written to a file specified by FILE handle (which must be opened for writing.

Definition at line 1011 of file cqltransform.c.

References cql_fputs(), and cql_transform().

◆ cql_transform_open_FILE()

cql_transform_t cql_transform_open_FILE ( FILE * f )

creates a CQL transform handle from an opened file handle

Parameters

f	file where transformation spec is read

Returns: transform handle or NULL for failure

The transformation spec is read from a FILE handle which is assumed opened for reading.

Definition at line 215 of file cqltransform.c.

References cql_transform_close(), cql_transform_create(), and cql_transform_define_FILE().

Referenced by solr_transform_open_FILE().

◆ cql_transform_open_fname()

cql_transform_t cql_transform_open_fname ( const char * fname )

creates a CQL transform handle from a file

Parameters

fname name of where transformation spec is read

Returns: transform handle or NULL for failure

Definition at line 278 of file cqltransform.c.

References cql_transform_close(), cql_transform_create(), and cql_transform_define_fname().

Referenced by cql2pqf(), solr_transform_open_fname(), and xml_config_read().

◆ cql_transform_parse_tok_line()

static int cql_transform_parse_tok_line	(	cql_transform_t	ct,
		const char *	pattern,
		yaz_tok_parse_t	tp
	)

static

Definition at line 64 of file cqltransform.c.

References Z_AttributeElement::attributeSet, Z_AttributeElement::attributeType, CLASS_ATTSET, Z_AttributeElement::complex, cql_transform_t_::entry, Z_ComplexAttribute::list, cql_prop_entry::next, cql_transform_t_::nmem, nmem_intdup(), nmem_malloc(), nmem_strdup(), Z_ComplexAttribute::num_list, Z_ComplexAttribute::num_semanticAction, Z_AttributeElement::numeric, odr_createmem(), odr_destroy(), ODR_INT_PRINTF, ODR_PRINT, odr_setprint_noclose(), cql_prop_entry::pattern, Z_ComplexAttribute::semanticAction, Z_StringOrNumeric::string, Z_StringOrNumeric::u, Z_AttributeElement::value, Z_AttributeElement::which, Z_StringOrNumeric::which, wrbuf_alloc(), wrbuf_cstr(), wrbuf_destroy(), wrbuf_puts(), xmalloc, xstrdup, yaz_isdigit, yaz_log(), yaz_log_file(), yaz_oid_std(), yaz_string_to_oid_nmem(), YAZ_TOK_EOF, yaz_tok_move(), yaz_tok_parse_string(), YAZ_TOK_STRING, YLOG_WARN, z_AttributeList(), Z_AttributeValue_complex, Z_AttributeValue_numeric, and Z_StringOrNumeric_string.

Referenced by cql_transform_define_FILE(), and cql_transform_define_pattern().

◆ cql_transform_r()

int cql_transform_r	(	cql_transform_t	ct,
		struct cql_node *	cn,
		WRBUF	addinfo,
		void()(const char buf, void *client_data)	pr,
		void *	client_data
	)

tranforms PQF given a CQL tree (re-entrant)

Parameters

ct	CQL transform handle
cn	CQL node tree
addinfo	additional information (if error)
pr	print function
client_data	data to be passed to pr

Return values

0	success
!=	0 error code

The result is written to a user-defined stream.

Definition at line 979 of file cqltransform.c.

References cql_apply_prefix(), cql_strcmp(), cql_strncmp(), emit_node(), cql_transform_t_::entry, cql_prop_entry::next, nmem_create(), nmem_destroy(), cql_prop_entry::pattern, and cql_prop_entry::value.

Referenced by cql_transform().

◆ cql_transform_set_error()

void cql_transform_set_error	(	cql_transform_t	ct,
		int	error,
		const char *	addinfo
	)

sets error and addinfo for transform

Parameters

ct	CQL transform handle
error	error code
addinfo	additional info

Definition at line 1046 of file cqltransform.c.

References cql_transform_t_::addinfo, cql_transform_t_::error, wrbuf_puts(), and wrbuf_rewind().

Referenced by cql_transform(), cql_transform_buf(), cql_transform_rpn2cql_stream(), and solr_transform_set_error().

◆ emit_node()

static int emit_node	(	cql_transform_t	ct,
		struct cql_node *	cn,
		WRBUF	addinfo,
		void()(const char buf, void *client_data)	pr,
		void *	client_data
	)

static

◆ emit_term()

static int emit_term	(	cql_transform_t	ct,
		struct cql_node *	cn,
		WRBUF	addinfo,
		const char *	term,
		int	length,
		void()(const char buf, void *client_data)	pr,
		void *	client_data
	)

static

Definition at line 592 of file cqltransform.c.

References cql_lookup_property(), CQL_NODE_ST, cql_pr_attr(), cql_pr_attr_uri(), has_modifier(), cql_node::index, cql_node::index_uri, cql_node::modifiers, cql_node::st, cql_node::term, cql_node::u, cql_node::which, yaz_isdigit, YAZ_SRW_ANCHORING_CHAR_IN_UNSUPP_POSITION, YAZ_SRW_MASKING_CHAR_UNSUPP, YAZ_SRW_UNSUPP_INDEX, and YAZ_SRW_UNSUPP_RELATION_MODIFIER.

Referenced by emit_terms(), and emit_wordlist().

◆ emit_terms()

static int emit_terms	(	cql_transform_t	ct,
		struct cql_node *	cn,
		WRBUF	addinfo,
		void()(const char buf, void *client_data)	pr,
		void *	client_data,
		const char *	op
	)

static

Definition at line 795 of file cqltransform.c.

References emit_term(), cql_node::extra_terms, cql_node::st, cql_node::term, and cql_node::u.

Referenced by emit_node().

◆ emit_wordlist()

static int emit_wordlist	(	cql_transform_t	ct,
		struct cql_node *	cn,
		WRBUF	addinfo,
		void()(const char buf, void *client_data)	pr,
		void *	client_data,
		const char *	op
	)

static

Definition at line 825 of file cqltransform.c.

References emit_term(), cql_node::st, cql_node::term, and cql_node::u.

Referenced by emit_node().

◆ has_modifier()

static int has_modifier	(	struct cql_node *	cn,
		const char *	name
	)

static

Definition at line 582 of file cqltransform.c.

References cql_node::index, cql_node::modifiers, name, cql_node::st, cql_node::term, and cql_node::u.

Referenced by emit_term().

Data Structures

Functions

Detailed Description

Function Documentation

◆ compare_attr()

◆ cql_lookup_property()

◆ cql_lookup_reverse()

◆ cql_pr_attr()

◆ cql_pr_attr_uri()

◆ cql_pr_int()

◆ cql_pr_prox()

◆ cql_transform()

◆ cql_transform_buf()

◆ cql_transform_close()

◆ cql_transform_create()

◆ cql_transform_define_FILE()

◆ cql_transform_define_fname()

◆ cql_transform_define_pattern()

◆ cql_transform_error()

◆ cql_transform_FILE()

◆ cql_transform_open_FILE()

◆ cql_transform_open_fname()

◆ cql_transform_parse_tok_line()

◆ cql_transform_r()

◆ cql_transform_set_error()

◆ emit_node()

◆ emit_term()

◆ emit_terms()

◆ emit_wordlist()

◆ has_modifier()