1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2008 Index Data.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of Index Data nor the names of its contributors
13 * may be used to endorse or promote products derived from this
14 * software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 \brief Header with public definitions about CQL.
32 #ifndef CQL_H_INCLUDED
33 #define CQL_H_INCLUDED
39 /** \brief CQL parser handle (opaque pointer) */
40 typedef struct cql_parser *CQL_parser;
42 /** \brief creates a CQL parser.
45 Returns CQL parser or NULL if parser could not be created.
48 CQL_parser cql_parser_create(void);
50 /** \brief destroys a CQL parser.
53 This function does nothing if NULL if received.
56 void cql_parser_destroy(CQL_parser cp);
58 /** \brief parses a CQL query (string)
65 int cql_parser_string(CQL_parser cp, const char *str);
67 /** \brief parses CQL query (query stream)
69 \param getbyte function which reads one character from stream
70 \param ungetbyte function which unreads one character from stream
71 \param client_data data to be passed to stream functions
75 This function is similar to cql_parser_string but takes a
76 functions to read each query character from a stream.
78 The functions pointers getbytes, ungetbyte are similar to
79 that known from stdios getc, ungetc.
82 int cql_parser_stream(CQL_parser cp,
83 int (*getbyte)(void *client_data),
84 void (*ungetbyte)(int b, void *client_data),
87 /** \brief parses CQL query (from FILE)
89 \param f file where query is read from
93 This function is similar to cql_parser_string but reads from
94 stdio FILE handle instead.
97 int cql_parser_stdio(CQL_parser cp, FILE *f);
99 /** \brief Node type: search term */
100 #define CQL_NODE_ST 1
101 /** \brief Node type: boolean */
102 #define CQL_NODE_BOOL 2
103 /** \brief CQL parse tree (node)
109 /** which == CQL_NODE_ST */
113 /** CQL index URI or NULL if no URI */
119 /** relation URL or NULL if no relation URI) */
121 /** relation modifiers */
122 struct cql_node *modifiers;
124 struct cql_node *extra_terms;
126 /** which == CQL_NODE_BOOL */
128 /** operator name "and", "or", ... */
131 struct cql_node *left;
133 struct cql_node *right;
134 /** modifiers (NULL for no list) */
135 struct cql_node *modifiers;
140 /** \brief Private structure that describes the CQL properties (profile)
142 struct cql_properties;
144 /** \brief Structure used by cql_buf_write_handler
146 struct cql_buf_write_info {
152 /** \brief Handler for cql_buf_write_info
155 void cql_buf_write_handler(const char *b, void *client_data);
157 /** \brief Prints a CQL node and all sub nodes.
158 Hence this function prints the parse tree which is as returned by
162 void cql_node_print(struct cql_node *cn);
164 /** \brief creates a search clause node (st). */
166 struct cql_node *cql_node_mk_sc(NMEM nmem, const char *index,
167 const char *relation, const char *term);
169 /** \brief applies a prefix+uri to "unresolved" index and relation URIs.
170 "unresolved" URIs are those nodes where member index_uri / relation_uri
174 struct cql_node *cql_apply_prefix(NMEM nmem, struct cql_node *cn,
175 const char *prefix, const char *uri);
177 /** \brief creates a boolean node. */
179 struct cql_node *cql_node_mk_boolean(NMEM nmem, const char *op);
181 /** \brief destroys a node and its children. */
183 void cql_node_destroy(struct cql_node *cn);
185 /** duplicates a node (returns a copy of supplied node) . */
187 struct cql_node *cql_node_dup (NMEM nmem, struct cql_node *cp);
189 /** \brief returns the parse tree of the most recently parsed CQL query.
191 \returns CQL node or NULL for failure
194 struct cql_node *cql_parser_result(CQL_parser cp);
196 /** \brief converts CQL tree to XCQL and writes to user-defined stream
197 \param cn CQL node (tree)
198 \param pr print function
199 \param client_data data to be passed to pr function
202 void cql_to_xml(struct cql_node *cn,
203 void (*pr)(const char *buf, void *client_data),
205 /** \brief converts CQL tree to XCQL and writes to file
206 \param cn CQL node (tree)
210 void cql_to_xml_stdio(struct cql_node *cn, FILE *f);
212 /** \brief converts CQL tree to XCQL and writes result to buffer
213 \param cn CQL node (tree)
215 \param max size of buffer (max chars to write)
216 \returns length of resulting buffer
219 int cql_to_xml_buf(struct cql_node *cn, char *out, int max);
221 /** \brief stream handle for file (used by cql_to_xml_stdio) */
223 void cql_fputs(const char *buf, void *client_data);
225 /** \brief CQL transform handle.
226 The transform describes how to convert from CQL to PQF (Type-1 AKA RPN).
228 typedef struct cql_transform_t_ *cql_transform_t;
230 /** \brief creates a CQL transform handle
231 \returns transform handle or NULL for failure
234 cql_transform_t cql_transform_create(void);
236 /** \brief creates a CQL transform handle from am opened file handle
237 \param f file where transformation spec is read
238 \returns transform handle or NULL for failure
240 The transformation spec is read from a FILE handle which is assumed
244 cql_transform_t cql_transform_open_FILE (FILE *f);
246 /** \brief creates a CQL transform handle from a file
247 \param fname name of where transformation spec is read
248 \returns transform handle or NULL for failure
251 cql_transform_t cql_transform_open_fname(const char *fname);
254 /** \brief defines CQL transform pattern
255 \param ct CQL transform handle
256 \param pattern pattern string
257 \param value pattern value
258 \returns 0 for succes; -1 for failure
261 int cql_transform_define_pattern(cql_transform_t ct, const char *pattern,
266 /** \brief destroys a CQL transform handle
267 \param ct CQL transform handle
270 void cql_transform_close(cql_transform_t ct);
272 /** \brief tranforms PQF given a CQL tree
273 \param ct CQL transform handle
274 \param cn CQL node tree
275 \param pr print function
276 \param client_data data to be passed to pr
280 The result is written to a user-defined stream.
283 int cql_transform(cql_transform_t ct,
285 void (*pr)(const char *buf, void *client_data),
288 /** \brief transforms PQF given a CQL tree (from FILE)
289 \param ct CQL transform handle
291 \param f FILE where output is written
293 \retval !=0 failure (error code)
295 The result is written to a file specified by FILE handle (which must
296 be opened for writing.
299 int cql_transform_FILE(cql_transform_t ct,
300 struct cql_node *cn, FILE *f);
302 /** \brief transforms PQF given a CQL tree (from FILE)
303 \param ct CQL transform handle
305 \param out buffer for output
306 \param max maximum bytes for output (size of buffer)
308 \retval !=0 failure (error code)
311 int cql_transform_buf(cql_transform_t ct,
312 struct cql_node *cn, char *out, int max);
314 /** \brief returns additional information for last transform
315 \param ct CQL transform handle
316 \param addinfo additional info (result)
320 int cql_transform_error(cql_transform_t ct, const char **addinfo);
322 /** \brief sets error and addinfo for transform
323 \param ct CQL transform handle
324 \param error error code
325 \param addinfo additional info
328 void cql_transform_set_error(cql_transform_t ct, int error, const char *addinfo);
330 /** \brief returns the CQL message corresponding to a given error code.
331 \param code error code
332 \returns text message
335 const char *cql_strerror(int code);
337 /** \brief returns the standard CQL context set URI.
338 \returns CQL URI string
341 const char *cql_uri(void);
343 /** \brief compares two CQL strings (ala strcmp)
346 \returns comparison value
347 Compares two CQL strings (for relations, operators, etc)
348 (unfortunately defined as case-insensitive unlike XML etc)
351 int cql_strcmp(const char *s1, const char *s2);
353 /** \brief compares two CQL strings (ala strncmp)
357 \returns comparison value
358 Compares two CQL strings at most n bytes
359 (unfortunately defined as case-insensitive unlike XML etc)
362 int cql_strncmp(const char *s1, const char *s2, size_t n);
371 * indent-tabs-mode: nil
373 * vim: shiftwidth=4 tabstop=8 expandtab