Header with public definitions about CQL. More...

#include <stdio.h>
#include <yaz/nmem.h>
#include <yaz/wrbuf.h>

Data Structures
struct	cql_node
	CQL parse tree (node) More...

struct	cql_buf_write_info
	Structure used by cql_buf_write_handler. More...

Macros
#define	CQL_NODE_ST 1
	Node type: search term.

#define	CQL_NODE_BOOL 2
	Node type: boolean.

#define	CQL_NODE_SORT 3
	Node type: sortby single spec.

Typedefs
typedef struct cql_parser *	CQL_parser
	CQL parser handle (opaque pointer)

typedef struct cql_transform_t_ *	cql_transform_t
	CQL transform handle. The transform describes how to convert from CQL to PQF (Type-1 AKA RPN).

Functions
CQL_parser	cql_parser_create (void)
	creates a CQL parser.

void	cql_parser_destroy (CQL_parser cp)
	destroys a CQL parser.

int	cql_parser_string (CQL_parser cp, const char *str)
	parses a CQL query (string)

int	cql_parser_stream (CQL_parser cp, int(getbyte)(void client_data), void(ungetbyte)(int b, void client_data), void *client_data)
	parses CQL query (query stream)

int	cql_parser_stdio (CQL_parser cp, FILE *f)
	parses CQL query (from FILE)

void	cql_parser_strict (CQL_parser cp, int mode)
	configures strict mode

void	cql_buf_write_handler (const char b, void client_data)
	Handler for cql_buf_write_info.

void	cql_node_print (struct cql_node *cn)
	Prints a CQL node and all sub nodes. Hence this function prints the parse tree which is as returned by cql_parser_result.

struct cql_node *	cql_node_mk_sc (NMEM nmem, const char index, const char relation, const char *term)
	creates a search clause node (st).

struct cql_node *	cql_apply_prefix (NMEM nmem, struct cql_node cn, const char prefix, const char *uri)
	applies a prefix+uri to "unresolved" index and relation URIs. "unresolved" URIs are those nodes where member index_uri / relation_uri is NULL.

struct cql_node *	cql_node_mk_boolean (NMEM nmem, const char *op)
	creates a boolean node.

struct cql_node *	cql_node_mk_sort (NMEM nmem, const char index, struct cql_node modifiers)
	creates a sort single spec node.

void	cql_node_destroy (struct cql_node *cn)
	destroys a node and its children.

struct cql_node *	cql_node_dup (NMEM nmem, struct cql_node *cp)

struct cql_node *	cql_parser_result (CQL_parser cp)
	returns the parse tree of the most recently parsed CQL query.

struct cql_node *	cql_parser_sort_result (CQL_parser cp)
	returns the sortby tree of the most recently parsed CQL query.

void	cql_to_xml (struct cql_node cn, void(pr)(const char buf, void client_data), void *client_data)
	converts CQL tree to XCQL and writes to user-defined stream

void	cql_to_xml_stdio (struct cql_node cn, FILE f)
	converts CQL tree to XCQL and writes to file

int	cql_to_xml_buf (struct cql_node cn, char out, int max)
	converts CQL tree to XCQL and writes result to buffer

int	cql_to_ccl (struct cql_node cn, void(pr)(const char buf, void client_data), void *client_data)
	converts CQL tree to CCL and writes to user-defined stream

void	cql_to_ccl_stdio (struct cql_node cn, FILE f)
	converts CQL tree to CCL and writes to file

int	cql_to_ccl_buf (struct cql_node cn, char out, int max)
	converts CQL tree to CCL and writes result to buffer

void	cql_fputs (const char buf, void client_data)
	stream handle for file (used by cql_to_xml_stdio)

cql_transform_t	cql_transform_create (void)
	creates a CQL transform handle

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

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

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

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

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

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_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_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

const char *	cql_strerror (int code)
	returns the CQL message corresponding to a given error code.

const char *	cql_uri (void)
	returns the standard CQL context set URI.

int	cql_strcmp (const char s1, const char s2)
	compares two CQL strings (ala strcmp)

int	cql_strncmp (const char s1, const char s2, size_t n)
	compares two CQL strings (ala strncmp)

int	cql_sortby_to_sortkeys (struct cql_node cn, void(pr)(const char buf, void client_data), void *client_data)
	converts CQL sortby to sortkeys (ala versions 1.1)

int	cql_sortby_to_sortkeys_buf (struct cql_node cn, char out, int max)
	converts CQL sortby to sortkeys ..

Detailed Description

Header with public definitions about CQL.

Definition in file cql.h.

Macro Definition Documentation

◆ CQL_NODE_BOOL

#define CQL_NODE_BOOL 2

Node type: boolean.

Definition at line 113 of file cql.h.

◆ CQL_NODE_SORT

#define CQL_NODE_SORT 3

Node type: sortby single spec.

Definition at line 115 of file cql.h.

◆ CQL_NODE_ST

#define CQL_NODE_ST 1

Node type: search term.

Definition at line 111 of file cql.h.

Typedef Documentation

◆ CQL_parser

typedef struct cql_parser* CQL_parser

CQL parser handle (opaque pointer)

Definition at line 41 of file cql.h.

◆ cql_transform_t

typedef struct cql_transform_t_* cql_transform_t

CQL transform handle. The transform describes how to convert from CQL to PQF (Type-1 AKA RPN).

Definition at line 292 of file cql.h.

Function Documentation

◆ cql_apply_prefix()

struct cql_node * cql_apply_prefix	(	NMEM	nmem,
		struct cql_node *	cn,
		const char *	prefix,
		const char *	uri
	)

applies a prefix+uri to "unresolved" index and relation URIs. "unresolved" URIs are those nodes where member index_uri / relation_uri is NULL.

Definition at line 110 of file cqlutil.c.

References cql_node::boolean, cql_apply_prefix(), CQL_NODE_BOOL, CQL_NODE_SORT, CQL_NODE_ST, cql_strncmp(), cql_node::index, cql_node::index_uri, cql_node::left, cql_node::modifiers, nmem_strdup(), cql_node::relation, cql_node::relation_uri, cql_node::right, cql_node::search, cql_node::sort, cql_node::st, cql_node::u, and cql_node::which.

Referenced by cql_apply_prefix(), cql_transform_r(), and yyparse().

◆ cql_buf_write_handler()

void cql_buf_write_handler	(	const char *	b,
		void *	client_data
	)

Handler for cql_buf_write_info.

Definition at line 251 of file xcqlutil.c.

References cql_buf_write_info::buf, cql_buf_write_info::max, and cql_buf_write_info::off.

Referenced by cql_sortby_to_sortkeys_buf(), cql_to_ccl_buf(), cql_to_xml_buf(), and cql_transform_buf().

◆ cql_fputs()

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

stream handle for file (used by cql_to_xml_stdio)

Definition at line 18 of file cqlutil.c.

Referenced by cql_to_ccl_stdio(), cql_to_xml_stdio(), and cql_transform_FILE().

◆ cql_node_destroy()

void cql_node_destroy ( struct cql_node * cn )

destroys a node and its children.

Definition at line 173 of file cqlutil.c.

References cql_node::boolean, CQL_NODE_BOOL, cql_node_destroy(), CQL_NODE_SORT, CQL_NODE_ST, cql_node::left, cql_node::modifiers, cql_node::next, cql_node::right, cql_node::search, cql_node::sort, cql_node::st, cql_node::u, and cql_node::which.

Referenced by cql_node_destroy(), cql_parser_destroy(), cql_parser_stream(), and yyparse().

◆ cql_node_dup()

struct cql_node * cql_node_dup	(	NMEM	nmem,
		struct cql_node *	cp
	)

duplicates a node (returns a copy of supplied node) .

Definition at line 24 of file cqlutil.c.

References cql_node::boolean, CQL_NODE_BOOL, cql_node_dup(), cql_node_mk_boolean(), cql_node_mk_sc(), cql_node_mk_sort(), CQL_NODE_SORT, CQL_NODE_ST, cql_node::index, cql_node::index_uri, cql_node::left, cql_node::modifiers, cql_node::next, nmem_strdup(), cql_node::relation, cql_node::relation_uri, cql_node::right, cql_node::search, cql_node::sort, cql_node::st, cql_node::term, cql_node::u, cql_node::value, and cql_node::which.

Referenced by cql_node_dup(), and yyparse().

◆ cql_node_mk_boolean()

struct cql_node * cql_node_mk_boolean	(	NMEM	nmem,
		const char *	op
	)

creates a boolean node.

Definition at line 78 of file cqlutil.c.

References cql_node::boolean, CQL_NODE_BOOL, cql_node::left, cql_node::modifiers, nmem_malloc(), nmem_strdup(), cql_node::right, cql_node::u, cql_node::value, and cql_node::which.

Referenced by cql_node_dup(), and yyparse().

◆ cql_node_mk_sc()

struct cql_node * cql_node_mk_sc	(	NMEM	nmem,
		const char *	index,
		const char *	relation,
		const char *	term
	)

creates a search clause node (st).

Definition at line 55 of file cqlutil.c.

References CQL_NODE_ST, cql_node::extra_terms, cql_node::index, cql_node::index_uri, cql_node::modifiers, nmem_malloc(), nmem_strdup(), cql_node::relation, cql_node::relation_uri, cql_node::st, cql_node::term, cql_node::u, and cql_node::which.

Referenced by cql_node_dup(), and yyparse().

◆ cql_node_mk_sort()

struct cql_node * cql_node_mk_sort	(	NMEM	nmem,
		const char *	index,
		struct cql_node *	modifiers
	)

creates a sort single spec node.

Definition at line 91 of file cqlutil.c.

References CQL_NODE_SORT, cql_node::index, cql_node::modifiers, cql_node::next, nmem_malloc(), nmem_strdup(), cql_node::search, cql_node::sort, cql_node::u, and cql_node::which.

Referenced by cql_node_dup(), and yyparse().

◆ cql_node_print()

void cql_node_print ( struct cql_node * cn )

Prints a CQL node and all sub nodes. Hence this function prints the parse tree which is as returned by cql_parser_result.

◆ cql_parser_create()

CQL_parser cql_parser_create ( void )

creates a CQL parser.

Returns: CCL parser

Returns CQL parser or NULL if parser could not be created.

Definition at line 1880 of file cql.c.

References cql_parser::client_data, cql_parser::getbyte, cql_parser::last_error, cql_parser::last_pos, cql_parser::nmem, nmem_create(), cql_parser::strict, cql_parser::top, cql_parser::ungetbyte, and xmalloc.

Referenced by cql2pqf(), and cql2pqf().

◆ cql_parser_destroy()

void cql_parser_destroy ( CQL_parser cp )

destroys a CQL parser.

Parameters

cp	CQL parser

This function does nothing if NULL if received.

Definition at line 1895 of file cql.c.

References cql_node_destroy(), cql_parser::nmem, nmem_destroy(), cql_parser::top, and xfree.

Referenced by cql2pqf(), and cql2pqf().

◆ cql_parser_result()

struct cql_node * cql_parser_result ( CQL_parser cp )

returns the parse tree of the most recently parsed CQL query.

Parameters

cp	CQL parser

Returns: CQL node or NULL for failure

Definition at line 1902 of file cql.c.

References cql_parser::top.

Referenced by cql2pqf(), and cql2pqf().

◆ cql_parser_sort_result()

struct cql_node * cql_parser_sort_result ( CQL_parser cp )

returns the sortby tree of the most recently parsed CQL query.

Parameters

cp	CQL parser

Returns: CQL node or NULL for failure

◆ cql_parser_stdio()

int cql_parser_stdio	(	CQL_parser	cp,
		FILE *	f
	)

parses CQL query (from FILE)

Parameters

cp	CQL parser
f	file where query is read from

Return values

0	success
!=0	failure

This function is similar to cql_parser_string but reads from stdio FILE handle instead.

Definition at line 34 of file cqlstdio.c.

References cql_parser_stream(), getbyte_stream(), and ungetbyte_stream().

◆ cql_parser_stream()

int cql_parser_stream	(	CQL_parser	cp,
		int()(void client_data)	getbyte,
		void()(int b, void client_data)	ungetbyte,
		void *	client_data
	)

parses CQL query (query stream)

Parameters

cp	CQL parser
getbyte	function which reads one character from stream
ungetbyte	function which unreads one character from stream
client_data	data to be passed to stream functions

Return values

0	success
!=0	failure

This function is similar to cql_parser_string but takes a functions to read each query character from a stream.

The functions pointers getbytes, ungetbyte are similar to that known from stdios getc, ungetc.

Definition at line 1864 of file cql.c.

References cql_parser::client_data, cql_node_destroy(), cql_parse(), cql_parser::getbyte, cql_parser::nmem, nmem_reset(), cql_parser::top, and cql_parser::ungetbyte.

Referenced by cql_parser_stdio(), and cql_parser_string().

◆ cql_parser_strict()

void cql_parser_strict	(	CQL_parser	cp,
		int	mode
	)

configures strict mode

Parameters

cp	CQL parser
mode	1=enable strict mode, 0=disable strict mode

This function is similar to cql_parser_string but reads from stdio FILE handle instead.

Definition at line 1907 of file cql.c.

References cql_parser::strict.

◆ cql_parser_string()

int cql_parser_string	(	CQL_parser	cp,
		const char *	str
	)

parses a CQL query (string)

Parameters

cp	CQL parser
str	CQL string

Return values

0	success
!=0	failure

Definition at line 35 of file cqlstring.c.

References cql_parser_stream(), getbuf(), cql_buf_info::off, cql_buf_info::str, and ungetbuf().

Referenced by cql2pqf(), and cql2pqf().

◆ cql_sortby_to_sortkeys()

int cql_sortby_to_sortkeys	(	struct cql_node *	cn,
		void()(const char buf, void *client_data)	pr,
		void *	client_data
	)

converts CQL sortby to sortkeys (ala versions 1.1)

Parameters

cn	CQL tree
pr	print function
client_data	data to be passed to pr function

This will take CQL_NODE_SORT entries and conver them to

path,schema,ascending,caseSensitive,missingValue items..

One for each sort keys. Where

path is string index for sorting

schema is schema for sort index

ascending is a boolean (0=false, 1=true). Default is true.

caseSensitive is a boolean. Default is false.

missingValue is a string and one of 'abort', 'highValue', 'lowValue', or 'omit'. Default is 'highValue'.

Definition at line 83 of file cql_sortkeys.c.

References CQL_NODE_SORT, cql_sort_modifiers(), cql_node::index, cql_node::modifiers, cql_node::next, pr_n(), cql_node::sort, cql_node::u, and cql_node::which.

Referenced by cql_sortby_to_sortkeys_buf().

◆ cql_sortby_to_sortkeys_buf()

int cql_sortby_to_sortkeys_buf	(	struct cql_node *	cn,
		char *	out,
		int	max
	)

converts CQL sortby to sortkeys ..

Parameters

cn	CQL tree
out	result buffer
max	size of buffer (allocated)

Return values

0	OK
-1	ERROR

Definition at line 120 of file cql_sortkeys.c.

References cql_buf_write_info::buf, cql_buf_write_handler(), cql_sortby_to_sortkeys(), cql_buf_write_info::max, and cql_buf_write_info::off.

Referenced by cql2pqf().

◆ cql_strcmp()

int cql_strcmp	(	const char *	s1,
		const char *	s2
	)

compares two CQL strings (ala strcmp)

Parameters

s1	string 1
s2	string 2

Returns: comparison value Compares two CQL strings (for relations, operators, etc) (unfortunately defined as case-insensitive unlike XML etc)

Definition at line 194 of file cqlutil.c.

Referenced by cql_lookup_property(), cql_transform_r(), emit_node(), node_bool(), node_st(), and yylex().

◆ cql_strerror()

const char * cql_strerror ( int code )

returns the CQL message corresponding to a given error code.

Parameters

code	error code

Returns: text message

Definition at line 16 of file cqlstrer.c.

References yaz_diag_srw_str().

Referenced by cql2pqf().

◆ cql_strncmp()

int cql_strncmp	(	const char *	s1,
		const char *	s2,
		size_t	n
	)

compares two CQL strings (ala strncmp)

Parameters

s1	string 1
s2	string 2
n	size

Returns: comparison value Compares two CQL strings at most n bytes (unfortunately defined as case-insensitive unlike XML etc)

Definition at line 210 of file cqlutil.c.

Referenced by cql_apply_prefix(), and cql_transform_r().

◆ cql_to_ccl()

int cql_to_ccl	(	struct cql_node *	cn,
		void()(const char buf, void *client_data)	pr,
		void *	client_data
	)

converts CQL tree to CCL and writes to user-defined stream

Parameters

cn	CQL node (tree)
pr	print function
client_data	data to be passed to pr function

Definition at line 249 of file cql2ccl.c.

References cql_to_ccl_r().

Referenced by cql_to_ccl_buf(), and cql_to_ccl_stdio().

◆ cql_to_ccl_buf()

int cql_to_ccl_buf	(	struct cql_node *	cn,
		char *	out,
		int	max
	)

converts CQL tree to CCL and writes result to buffer

Parameters

cn	CQL node (tree)
out	buffer
max	size of buffer (max chars to write)

Return values

0	OK
-1	conversion error
-2	buffer too small (truncated)

Definition at line 261 of file cql2ccl.c.

References cql_buf_write_info::buf, cql_buf_write_handler(), cql_to_ccl(), cql_buf_write_info::max, and cql_buf_write_info::off.

◆ cql_to_ccl_stdio()

void cql_to_ccl_stdio	(	struct cql_node *	cn,
		FILE *	f
	)

converts CQL tree to CCL and writes to file

Parameters

cn	CQL node (tree)
f	file handle

Definition at line 256 of file cql2ccl.c.

References cql_fputs(), and cql_to_ccl().

◆ cql_to_xml()

void cql_to_xml	(	struct cql_node *	cn,
		void()(const char buf, void *client_data)	pr,
		void *	client_data
	)

converts CQL tree to XCQL and writes to user-defined stream

Parameters

cn	CQL node (tree)
pr	print function
client_data	data to be passed to pr function

Definition at line 239 of file xcqlutil.c.

References cql_to_xml_r().

Referenced by cql_to_xml_buf(), and cql_to_xml_stdio().

◆ cql_to_xml_buf()

int cql_to_xml_buf	(	struct cql_node *	cn,
		char *	out,
		int	max
	)

converts CQL tree to XCQL and writes result to buffer

Parameters

cn	CQL node (tree)
out	buffer
max	size of buffer (max chars to write)

Returns: length of resulting buffer

Definition at line 264 of file xcqlutil.c.

References cql_buf_write_info::buf, cql_buf_write_handler(), cql_to_xml(), cql_buf_write_info::max, and cql_buf_write_info::off.

◆ cql_to_xml_stdio()

void cql_to_xml_stdio	(	struct cql_node *	cn,
		FILE *	f
	)

converts CQL tree to XCQL and writes to file

Parameters

cn	CQL node (tree)
f	file handle

Definition at line 246 of file xcqlutil.c.

References cql_fputs(), and cql_to_xml().

◆ 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_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().

◆ cql_uri()

const char * cql_uri ( void )

returns the standard CQL context set URI.

Returns: CQL URI string

Definition at line 105 of file cqlutil.c.

Referenced by emit_node().

Data Structures

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ CQL_NODE_BOOL

◆ CQL_NODE_SORT

◆ CQL_NODE_ST

Typedef Documentation

◆ CQL_parser

◆ cql_transform_t

Function Documentation

◆ cql_apply_prefix()

◆ cql_buf_write_handler()

◆ cql_fputs()

◆ cql_node_destroy()

◆ cql_node_dup()

◆ cql_node_mk_boolean()

◆ cql_node_mk_sc()

◆ cql_node_mk_sort()

◆ cql_node_print()

◆ cql_parser_create()

◆ cql_parser_destroy()

◆ cql_parser_result()

◆ cql_parser_sort_result()

◆ cql_parser_stdio()

◆ cql_parser_stream()

◆ cql_parser_strict()

◆ cql_parser_string()

◆ cql_sortby_to_sortkeys()

◆ cql_sortby_to_sortkeys_buf()

◆ cql_strcmp()

◆ cql_strerror()

◆ cql_strncmp()

◆ cql_to_ccl()

◆ cql_to_ccl_buf()

◆ cql_to_ccl_stdio()

◆ cql_to_xml()

◆ cql_to_xml_buf()

◆ cql_to_xml_stdio()

◆ 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_r()

◆ cql_transform_set_error()

◆ cql_uri()