1 /* $Id: cql.h,v 1.6 2004-03-10 16:34:29 adam Exp $
2 Copyright (C) 2002-2004
5 This file is part of the YAZ toolkit.
10 #ifndef CQL_H_INCLUDED
11 #define CQL_H_INCLUDED
13 #include <yaz/yconfig.h>
17 typedef struct cql_parser *CQL_parser;
22 * creates a CQL parser.
24 * Returns CQL parser or NULL if parser could not be created.
27 CQL_parser cql_parser_create(void);
33 * Destroy CQL parser. This function does nothing if
34 * NULL pointer is received.
37 void cql_parser_destroy(CQL_parser cp);
42 * @str: A query string to be parsed.
44 * Parses a CQL query string.
46 * Returns 0 if parsing was succesful; non-zero (error code) if
50 int cql_parser_string(CQL_parser cp, const char *str);
55 * @getbyte: Handler to read one character (for parsing).
56 * @ungetbyte: Handler to unread one byte (for parsing).
57 * @client_data: User data associated with getbyte/ungetbyte handlers.
59 * Parses a CQL query from a user defined stream.
61 * Returns 0 if parsing was succesful; non-zero (error code) if
65 int cql_parser_stream(CQL_parser cp,
66 int (*getbyte)(void *client_data),
67 void (*ungetbyte)(int b, void *client_data),
73 * @f: FILE handler in read mode.
75 * Parses a CQL query from a file.
77 * Returns 0 if parsing was succesful; non-zero (error code) if
81 int cql_parser_stdio(CQL_parser cp, FILE *f);
84 #define CQL_NODE_BOOL 2
85 #define CQL_NODE_MOD 3
93 struct cql_node *modifiers;
94 struct cql_node *prefixes;
98 struct cql_node *left;
99 struct cql_node *right;
100 struct cql_node *modifiers;
101 struct cql_node *prefixes;
106 struct cql_properties;
108 struct cql_buf_write_info {
115 void cql_buf_write_handler (const char *b, void *client_data);
118 void cql_node_print(struct cql_node *cn);
120 struct cql_node *cql_node_mk_sc(const char *index,
121 const char *relation,
124 struct cql_node *cql_node_mk_boolean(const char *op);
126 void cql_node_destroy(struct cql_node *cn);
128 struct cql_node *cql_node_prefix(struct cql_node *n,
132 struct cql_node *cql_node_dup (struct cql_node *cp);
134 struct cql_node *cql_parser_result(CQL_parser cp);
137 void cql_to_xml(struct cql_node *cn,
138 void (*pr)(const char *buf, void *client_data),
141 void cql_to_xml_stdio(struct cql_node *cn, FILE *f);
143 int cql_to_xml_buf(struct cql_node *cn, char *out, int max);
146 struct cql_node *cql_node_mk_proxargs(const char *relation,
147 const char *distance,
149 const char *ordering);
153 void cql_fputs(const char *buf, void *client_data);
155 typedef struct cql_transform_t_ *cql_transform_t;
158 cql_transform_t cql_transform_open_FILE (FILE *f);
160 cql_transform_t cql_transform_open_fname(const char *fname);
162 void cql_transform_close(cql_transform_t ct);
165 void cql_transform_pr(cql_transform_t ct,
167 void (*pr)(const char *buf, void *client_data),
171 int cql_transform_FILE(cql_transform_t ct,
172 struct cql_node *cn, FILE *f);
175 int cql_transform_buf(cql_transform_t ct,
176 struct cql_node *cn, char *out, int max);
178 int cql_transform_error(cql_transform_t ct, const char **addinfo);
181 const char *cql_strerror(int code);