include/yaz/cql.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2011 Index Data.
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   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.
  15  *
  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.
  26  */
  27
  28 /** \file cql.h
  29     \brief Header with public definitions about CQL.
  30 */
  31
  32 #ifndef CQL_H_INCLUDED
  33 #define CQL_H_INCLUDED
  34 #include <stdio.h>
  35 #include <yaz/nmem.h>
  36
  37 YAZ_BEGIN_CDECL
  38
  39 /** \brief CQL parser handle (opaque pointer) */
  40 typedef struct cql_parser *CQL_parser;
  41
  42 /** \brief creates a CQL parser.
  43     \returns CCL parser
  44
  45     Returns CQL parser or NULL if parser could not be created.
  46  */
  47 YAZ_EXPORT
  48 CQL_parser cql_parser_create(void);
  49
  50 /** \brief destroys a CQL parser.
  51     \param cp CQL parser
  52
  53     This function does nothing if NULL if received.
  54  */
  55 YAZ_EXPORT
  56 void cql_parser_destroy(CQL_parser cp);
  57
  58 /** \brief parses a CQL query (string)
  59     \param cp CQL parser
  60     \param str CQL string
  61     \retval 0 success
  62     \retval !=0 failure
  63  */
  64 YAZ_EXPORT
  65 int cql_parser_string(CQL_parser cp, const char *str);
  66
  67 /** \brief parses CQL query (query stream)
  68     \param cp CQL parser
  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
  72     \retval 0 success
  73     \retval !=0 failure
  74
  75     This function is similar to cql_parser_string but takes a
  76     functions to read each query character from a stream.
  77
  78     The functions pointers getbytes, ungetbyte are similar to
  79     that known from stdios getc, ungetc.
  80 */
  81 YAZ_EXPORT
  82 int cql_parser_stream(CQL_parser cp,
  83                       int (*getbyte)(void *client_data),
  84                       void (*ungetbyte)(int b, void *client_data),
  85                       void *client_data);
  86
  87 /** \brief parses CQL query (from FILE)
  88     \param cp CQL parser
  89     \param f file where query is read from
  90     \retval 0 success
  91     \retval !=0 failure
  92
  93     This function is similar to cql_parser_string but reads from
  94     stdio FILE handle instead.
  95 */
  96 YAZ_EXPORT
  97 int cql_parser_stdio(CQL_parser cp, FILE *f);
  98
  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 Node type: sortby single spec */
 104 #define CQL_NODE_SORT 3
 105
 106 /** \brief CQL parse tree (node)
 107  */
 108 struct cql_node {
 109     /** node type */
 110     int which;
 111     union {
 112         /** which == CQL_NODE_ST */
 113         struct {
 114             /** CQL index */
 115             char *index;
 116             /** CQL index URI or NULL if no URI */
 117             char *index_uri;
 118             /** Search term */
 119             char *term;
 120             /** relation */
 121             char *relation;
 122             /** relation URL or NULL if no relation URI) */
 123             char *relation_uri;
 124             /** relation modifiers */
 125             struct cql_node *modifiers;
 126             /** term list */
 127             struct cql_node *extra_terms;
 128         } st;
 129         /** which == CQL_NODE_BOOL */
 130         struct {
 131             /** operator name "and", "or", ... */
 132             char *value;
 133             /** left operand */
 134             struct cql_node *left;
 135             /** right operand */
 136             struct cql_node *right;
 137             /** modifiers (NULL for no list) */
 138             struct cql_node *modifiers;
 139         } boolean;
 140         /** which == CQL_NODE_SORT */
 141         struct {
 142             char *index;
 143             /** next spec */
 144             struct cql_node *next;
 145             /** modifiers (NULL for no list) */
 146             struct cql_node *modifiers;
 147             /** search node */
 148             struct cql_node *search;
 149         } sort;
 150     } u;
 151 };
 152
 153 /** \brief Private structure that describes the CQL properties (profile)
 154  */
 155 struct cql_properties;
 156
 157 /** \brief Structure used by cql_buf_write_handler
 158  */
 159 struct cql_buf_write_info {
 160     int max;
 161     int off;
 162     char *buf;
 163 };
 164
 165 /** \brief Handler for cql_buf_write_info
 166  */
 167 YAZ_EXPORT
 168 void cql_buf_write_handler(const char *b, void *client_data);
 169
 170 /** \brief Prints a CQL node and all sub nodes.
 171     Hence this function prints the parse tree which is as returned by
 172     cql_parser_result.
 173 */
 174 YAZ_EXPORT
 175 void cql_node_print(struct cql_node *cn);
 176
 177 /** \brief creates a search clause node (st). */
 178 YAZ_EXPORT
 179 struct cql_node *cql_node_mk_sc(NMEM nmem, const char *index,
 180                                 const char *relation, const char *term);
 181
 182 /** \brief applies a prefix+uri to "unresolved" index and relation URIs.
 183     "unresolved" URIs are those nodes where member index_uri / relation_uri
 184     is NULL.
 185 */
 186 YAZ_EXPORT
 187 struct cql_node *cql_apply_prefix(NMEM nmem, struct cql_node *cn,
 188                                   const char *prefix, const char *uri);
 189
 190 /** \brief creates a boolean node. */
 191 YAZ_EXPORT
 192 struct cql_node *cql_node_mk_boolean(NMEM nmem, const char *op);
 193
 194 /** \brief creates a sort single spec node. */
 195 YAZ_EXPORT
 196 struct cql_node *cql_node_mk_sort(NMEM nmem, const char *index,
 197     struct cql_node *modifiers);
 198
 199 /** \brief destroys a node and its children. */
 200 YAZ_EXPORT
 201 void cql_node_destroy(struct cql_node *cn);
 202
 203 /** duplicates a node (returns a copy of supplied node) . */
 204 YAZ_EXPORT
 205 struct cql_node *cql_node_dup (NMEM nmem, struct cql_node *cp);
 206
 207 /** \brief returns the parse tree of the most recently parsed CQL query.
 208     \param cp CQL parser
 209     \returns CQL node or NULL for failure
 210 */
 211 YAZ_EXPORT
 212 struct cql_node *cql_parser_result(CQL_parser cp);
 213
 214 /** \brief returns the sortby tree of the most recently parsed CQL query.
 215     \param cp CQL parser
 216     \returns CQL node or NULL for failure
 217 */
 218 YAZ_EXPORT
 219 struct cql_node *cql_parser_sort_result(CQL_parser cp);
 220
 221 /** \brief converts CQL tree to XCQL and writes to user-defined stream
 222     \param cn CQL node (tree)
 223     \param pr print function
 224     \param client_data data to be passed to pr function
 225  */
 226 YAZ_EXPORT
 227 void cql_to_xml(struct cql_node *cn,
 228                 void (*pr)(const char *buf, void *client_data),
 229                 void *client_data);
 230 /** \brief converts CQL tree to XCQL and writes to file
 231     \param cn CQL node (tree)
 232     \param f file handle
 233  */
 234 YAZ_EXPORT
 235 void cql_to_xml_stdio(struct cql_node *cn, FILE *f);
 236
 237 /** \brief converts CQL tree to XCQL and writes result to buffer
 238     \param cn CQL node (tree)
 239     \param out buffer
 240     \param max size of buffer (max chars to write)
 241     \returns length of resulting buffer
 242  */
 243 YAZ_EXPORT
 244 int cql_to_xml_buf(struct cql_node *cn, char *out, int max);
 245
 246 /** \brief stream handle for file (used by cql_to_xml_stdio) */
 247 YAZ_EXPORT
 248 void cql_fputs(const char *buf, void *client_data);
 249
 250 /** \brief CQL transform handle.
 251     The transform describes how to convert from CQL to PQF (Type-1 AKA RPN).
 252 */
 253 typedef struct cql_transform_t_ *cql_transform_t;
 254
 255 /** \brief creates a CQL transform handle
 256     \returns transform handle or NULL for failure
 257 */
 258 YAZ_EXPORT
 259 cql_transform_t cql_transform_create(void);
 260
 261 /** \brief creates a CQL transform handle from am opened file handle
 262     \param f file where transformation spec is read
 263     \returns transform handle or NULL for failure
 264
 265     The transformation spec is read from a FILE handle which is assumed
 266     opened for reading.
 267 */
 268 YAZ_EXPORT
 269 cql_transform_t cql_transform_open_FILE (FILE *f);
 270
 271 /** \brief creates a CQL transform handle from a file
 272     \param fname name of where transformation spec is read
 273     \returns transform handle or NULL for failure
 274 */
 275 YAZ_EXPORT
 276 cql_transform_t cql_transform_open_fname(const char *fname);
 277
 278
 279 /** \brief defines CQL transform pattern
 280     \param ct CQL transform handle
 281     \param pattern pattern string
 282     \param value pattern value
 283     \returns 0 for succes; -1 for failure
 284 */
 285 YAZ_EXPORT
 286 int cql_transform_define_pattern(cql_transform_t ct, const char *pattern,
 287                                  const char *value);
 288
 289
 290
 291 /** \brief destroys a CQL transform handle
 292     \param ct CQL transform handle
 293  */
 294 YAZ_EXPORT
 295 void cql_transform_close(cql_transform_t ct);
 296
 297 /** \brief tranforms PQF given a CQL tree
 298     \param ct CQL transform handle
 299     \param cn CQL node tree
 300     \param pr print function
 301     \param client_data data to be passed to pr
 302     \retval 0 success
 303     \retval != 0 error
 304
 305     The result is written to a user-defined stream.
 306 */
 307 YAZ_EXPORT
 308 int cql_transform(cql_transform_t ct,
 309                   struct cql_node *cn,
 310                   void (*pr)(const char *buf, void *client_data),
 311                   void *client_data);
 312
 313 /** \brief transforms PQF given a CQL tree (from FILE)
 314     \param ct CQL transform handle
 315     \param cn CQL tree
 316     \param f FILE where output is written
 317     \retval 0 success
 318     \retval !=0 failure (error code)
 319
 320     The result is written to a file specified by FILE handle (which must
 321     be opened for writing.
 322 */
 323 YAZ_EXPORT
 324 int cql_transform_FILE(cql_transform_t ct,
 325                        struct cql_node *cn, FILE *f);
 326
 327 /** \brief transforms PQF given a CQL tree (from FILE)
 328     \param ct CQL transform handle
 329     \param cn CQL tree
 330     \param out buffer for output
 331     \param max maximum bytes for output (size of buffer)
 332     \retval 0 success
 333     \retval !=0 failure (error code)
 334  */
 335 YAZ_EXPORT
 336 int cql_transform_buf(cql_transform_t ct,
 337                       struct cql_node *cn, char *out, int max);
 338
 339 /** \brief returns additional information for last transform
 340     \param ct CQL transform handle
 341     \param addinfo additional info (result)
 342     \returns error code
 343  */
 344 YAZ_EXPORT
 345 int cql_transform_error(cql_transform_t ct, const char **addinfo);
 346
 347 /** \brief sets error and addinfo for transform
 348     \param ct CQL transform handle
 349     \param error error code
 350     \param addinfo additional info
 351  */
 352 YAZ_EXPORT
 353 void cql_transform_set_error(cql_transform_t ct, int error, const char *addinfo);
 354
 355 /** \brief returns the CQL message corresponding to a given error code.
 356     \param code error code
 357     \returns text message
 358 */
 359 YAZ_EXPORT
 360 const char *cql_strerror(int code);
 361
 362 /** \brief returns the standard CQL context set URI.
 363     \returns CQL URI string
 364 */
 365 YAZ_EXPORT
 366 const char *cql_uri(void);
 367
 368 /** \brief compares two CQL strings (ala strcmp)
 369     \param s1 string 1
 370     \param s2 string 2
 371     \returns comparison value
 372     Compares two CQL strings (for relations, operators, etc)
 373     (unfortunately defined as case-insensitive unlike XML etc)
 374 */
 375 YAZ_EXPORT
 376 int cql_strcmp(const char *s1, const char *s2);
 377
 378 /** \brief compares two CQL strings (ala strncmp)
 379     \param s1 string 1
 380     \param s2 string 2
 381     \param n size
 382     \returns comparison value
 383     Compares two CQL strings at most n bytes
 384     (unfortunately defined as case-insensitive unlike XML etc)
 385  */
 386 YAZ_EXPORT
 387 int cql_strncmp(const char *s1, const char *s2, size_t n);
 388
 389 YAZ_END_CDECL
 390
 391 #endif
 392 /* CQL_H_INCLUDED */
 393 /*
 394  * Local variables:
 395  * c-basic-offset: 4
 396  * c-file-style: "Stroustrup"
 397  * indent-tabs-mode: nil
 398  * End:
 399  * vim: shiftwidth=4 tabstop=8 expandtab
 400  */
 401