include/yaz/ccl.h

   1 /*
   2  * Copyright (c) 1995, the EUROPAGATE consortium (see below).
   3  *
   4  * The EUROPAGATE consortium members are:
   5  *
   6  *    University College Dublin
   7  *    Danmarks Teknologiske Videnscenter
   8  *    An Chomhairle Leabharlanna
   9  *    Consejo Superior de Investigaciones Cientificas
  10  *
  11  * Permission to use, copy, modify, distribute, and sell this software and
  12  * its documentation, in whole or in part, for any purpose, is hereby granted,
  13  * provided that:
  14  *
  15  * 1. This copyright and permission notice appear in all copies of the
  16  * software and its documentation. Notices of copyright or attribution
  17  * which appear at the beginning of any file must remain unchanged.
  18  *
  19  * 2. The names of EUROPAGATE or the project partners may not be used to
  20  * endorse or promote products derived from this software without specific
  21  * prior written permission.
  22  *
  23  * 3. Users of this software (implementors and gateway operators) agree to
  24  * inform the EUROPAGATE consortium of their use of the software. This
  25  * information will be used to evaluate the EUROPAGATE project and the
  26  * software, and to plan further developments. The consortium may use
  27  * the information in later publications.
  28  *
  29  * 4. Users of this software agree to make their best efforts, when
  30  * documenting their use of the software, to acknowledge the EUROPAGATE
  31  * consortium, and the role played by the software in their work.
  32  *
  33  * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
  34  * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  35  * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  36  * IN NO EVENT SHALL THE EUROPAGATE CONSORTIUM OR ITS MEMBERS BE LIABLE
  37  * FOR ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF
  38  * ANY KIND, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA
  39  * OR PROFITS, WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND
  40  * ON ANY THEORY OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE
  41  * USE OR PERFORMANCE OF THIS SOFTWARE.
  42  *
  43  */
  44
  45 /** \file ccl.h
  46     \brief Header with public definitions for CCL.
  47 */
  48
  49 /*
  50  * CCL - header file
  51  *
  52  * $Id: ccl.h,v 1.20 2004-10-15 00:18:59 adam Exp $
  53  *
  54  * Old Europagate Log:
  55  *
  56  * Revision 1.10  1996/01/08  08:41:22  adam
  57  * Minor changes.
  58  *
  59  * Revision 1.9  1995/07/20  08:15:16  adam
  60  * Bug fix: Token value for comma and OR were the same!
  61  *
  62  * Revision 1.8  1995/07/11  12:28:34  adam
  63  * New function: ccl_token_simple (split into simple tokens) and
  64  *  ccl_token_del (delete tokens).
  65  *
  66  * Revision 1.7  1995/05/16  09:39:38  adam
  67  * LICENSE.
  68  *
  69  * Revision 1.6  1995/05/11  14:04:03  adam
  70  * Changes in the reading of qualifier(s). New function: ccl_qual_fitem.
  71  * New variable ccl_case_sensitive, which controls whether reserved
  72  * words and field names are case sensitive or not.
  73  *
  74  * Revision 1.5  1995/02/23  08:32:11  adam
  75  * Changed header.
  76  *
  77  * Revision 1.3  1995/02/16  13:20:10  adam
  78  * Spell fix.
  79  *
  80  * Revision 1.2  1995/02/15  17:43:08  adam
  81  * Minor changes to the ccl interface. Bug fix in iso2709 module.
  82  *
  83  * Revision 1.1  1995/02/14  19:55:21  adam
  84  * Header files ccl.h/cclp.h are gone! They have been merged an
  85  * moved to ../include/ccl.h.
  86  *
  87  */
  88
  89 #ifndef CCL_H
  90 #define CCL_H
  91
  92 #include <yaz/yconfig.h>
  93 #include <stdio.h>
  94 #include <yaz/xmalloc.h>
  95 #include <yaz/wrbuf.h>
  96
  97 YAZ_BEGIN_CDECL
  98
  99 /* CCL error numbers */
 100 #define CCL_ERR_OK                0
 101 #define CCL_ERR_TERM_EXPECTED     1
 102 #define CCL_ERR_RP_EXPECTED       2
 103 #define CCL_ERR_SETNAME_EXPECTED  3
 104 #define CCL_ERR_OP_EXPECTED       4
 105 #define CCL_ERR_BAD_RP            5
 106 #define CCL_ERR_UNKNOWN_QUAL      6
 107 #define CCL_ERR_DOUBLE_QUAL       7
 108 #define CCL_ERR_EQ_EXPECTED       8
 109 #define CCL_ERR_BAD_RELATION      9
 110 #define CCL_ERR_TRUNC_NOT_LEFT   10
 111 #define CCL_ERR_TRUNC_NOT_BOTH   11
 112 #define CCL_ERR_TRUNC_NOT_RIGHT  12
 113
 114 /** attribute node (type, value) pair as used in RPN */
 115 struct ccl_rpn_attr {
 116     /** next node */
 117     struct ccl_rpn_attr *next;
 118     /** attribute set */
 119     char *set;
 120     /** attribute type, Bib-1: 1=use, 2=relation, 3=position, .. */
 121     int type;
 122     /** attribute value type (numeric or string) */
 123     int kind;
 124 #define CCL_RPN_ATTR_NUMERIC 1
 125 #define CCL_RPN_ATTR_STRING 2
 126     union {
 127         /** numeric attribute value */
 128         int numeric;
 129         /** string attribute value */
 130         char *str;
 131     } value;
 132 };
 133
 134 #define CCL_RPN_AND 1
 135 #define CCL_RPN_OR 2
 136 #define CCL_RPN_NOT 3
 137 #define CCL_RPN_TERM 4
 138 #define CCL_RPN_SET 5
 139 #define CCL_RPN_PROX 6
 140
 141 /** RPN tree structure node */
 142 struct ccl_rpn_node {
 143     /** RPN tree node type */
 144     int kind;
 145     union {
 146         /** Boolean including proximity 0=left, 2=right, 3=prox parms */
 147         struct ccl_rpn_node *p[3];
 148         /** Attributes + Term */
 149         struct {
 150             char *term;
 151             struct ccl_rpn_attr *attr_list;
 152         } t;
 153         /** Result set */
 154         char *setname;
 155     } u;
 156 };
 157
 158 typedef struct ccl_qualifiers *CCL_bibset;
 159
 160 /* use (1)
 161
 162    relation (2)
 163                             -1  none
 164                              0  ordered
 165                            1-6  relation (<, <=, =, >=, >, <>)
 166
 167    position (3)
 168                             -1  none
 169                              1  first in field
 170                              2  first in sub field
 171                              3  any position in field
 172    structure (4)
 173                             -1  none
 174                              0  word/phrase auto select
 175                              1  phrase
 176                              2  word
 177                              3  key
 178                              4  year
 179                              5  date (normalized)
 180                              6  word list
 181                            100  date (un-normalized)
 182                            101  name (normalized)
 183                            102  name (un-normalized)
 184    truncation (5)
 185    completeness (6)
 186 */
 187
 188 #define CCL_BIB1_USE 1
 189 #define CCL_BIB1_REL 2
 190 #define CCL_BIB1_POS 3
 191 #define CCL_BIB1_STR 4
 192 #define CCL_BIB1_TRU 5
 193 #define CCL_BIB1_COM 6
 194
 195 #define CCL_BIB1_STR_WP (-1)
 196 #define CCL_BIB1_STR_AND_LIST (-2)
 197 #define CCL_BIB1_STR_OR_LIST (-3)
 198 #define CCL_BIB1_REL_ORDER (-1)
 199 #define CCL_BIB1_REL_PORDER (-2)
 200
 201 #define CCL_BIB1_TRU_CAN_LEFT (-1)
 202 #define CCL_BIB1_TRU_CAN_RIGHT (-2)
 203 #define CCL_BIB1_TRU_CAN_BOTH  (-3)
 204 #define CCL_BIB1_TRU_CAN_NONE  (-4)
 205
 206 #define CCL_TOK_EOL   0
 207 #define CCL_TOK_TERM  1
 208 #define CCL_TOK_REL   2
 209 #define CCL_TOK_EQ    3
 210 #define CCL_TOK_PROX  4
 211 #define CCL_TOK_LP    5
 212 #define CCL_TOK_RP    6
 213 #define CCL_TOK_COMMA 7
 214 #define CCL_TOK_AND   8
 215 #define CCL_TOK_OR    9
 216 #define CCL_TOK_NOT   10
 217 #define CCL_TOK_SET   11
 218
 219 /** CCL token */
 220 struct ccl_token {
 221     char kind;
 222     size_t len;
 223     const char *name;
 224     struct ccl_token *next;
 225     struct ccl_token *prev;
 226 };
 227
 228 /** CCL Qualifier */
 229 struct ccl_qualifier {
 230     char *name;
 231     int no_sub;
 232     struct ccl_qualifier **sub;
 233     struct ccl_rpn_attr *attr_list;
 234     struct ccl_qualifier *next;
 235 };
 236
 237 /** CCL parser structure */
 238 struct ccl_parser {
 239     /** current lookahead token */
 240     struct ccl_token *look_token;
 241
 242     /** holds error code if error occur */
 243     int error_code;
 244     /** if error occurs, this holds position (starting from 0). */
 245     const char *error_pos;
 246
 247     /** current bibset */
 248     CCL_bibset bibset;
 249
 250     /** names of and operator */
 251     char *ccl_token_and;
 252     /** names of or operator */
 253     char *ccl_token_or;
 254     /** names of not operator */
 255     char *ccl_token_not;
 256     /** names of set operator */
 257     char *ccl_token_set;
 258     /** 1=CCL parser is case sensitive, 0=case insensitive */
 259     int ccl_case_sensitive;
 260 };
 261
 262 typedef struct ccl_parser *CCL_parser;
 263
 264 /**
 265  * Splits CCL command string into individual tokens using
 266  * a CCL parser.
 267  */
 268 YAZ_EXPORT
 269 struct ccl_token *ccl_parser_tokenize (CCL_parser cclp, const char *command);
 270
 271 /**
 272  * Splits CCL command string into tokens using temporary parser.
 273  *
 274  * Use ccl_parser_tokenize instead and provide a parser - it is
 275  * more flexible and efficient.
 276  */
 277 YAZ_EXPORT
 278 struct ccl_token *ccl_tokenize (const char *command);
 279
 280 /**
 281  * Splits CCL command into tokens. This function is obsolete. Use
 282  * ccl_parser_tokenize instead.
 283  */
 284 YAZ_EXPORT
 285 struct ccl_token *ccl_token_simple (const char *command);
 286
 287 /**
 288  * Deletes token list
 289  */
 290 YAZ_EXPORT
 291 void ccl_token_del (struct ccl_token *list);
 292
 293 /**
 294  * Add single token after a given onde.
 295  */
 296 YAZ_EXPORT
 297 struct ccl_token *ccl_token_add (struct ccl_token *at);
 298
 299 /**
 300  * Parses a CCL Find command in a simple C string. Returns CCL parse
 301  * tree node describing RPN if parsing is successful. If parsing is
 302  * unsuccesful, NULL is returned and error and pos is set accordingly.
 303  */
 304 YAZ_EXPORT
 305 struct ccl_rpn_node *ccl_find_str (CCL_bibset bibset,
 306                                    const char *str, int *error, int *pos);
 307
 308 /**
 309  * Parses CCL Find command from a list of CCL tokens. Otherwise similar to
 310  * ccl_find_str.
 311  */
 312 YAZ_EXPORT
 313 struct ccl_rpn_node *ccl_find (CCL_bibset abibset, struct ccl_token *list,
 314                                int *error, const char **pos);
 315
 316 /**
 317  * Parses a CCL Find command from a list of CCL tokens and given a CCL
 318  * parser. Otherwise similar to ccl_find_str.
 319  */
 320 YAZ_EXPORT
 321 struct ccl_rpn_node *ccl_parser_find (CCL_parser cclp, struct ccl_token *list);
 322
 323 /** Set names for AND operator in parser */
 324 YAZ_EXPORT
 325 void ccl_parser_set_op_and (CCL_parser p, const char *op);
 326
 327 /** Set names for OR operator in parser */
 328 YAZ_EXPORT
 329 void ccl_parser_set_op_or (CCL_parser p, const char *op);
 330
 331 /** Set names for ANDNOT operator in parser */
 332 YAZ_EXPORT
 333 void ccl_parser_set_op_not (CCL_parser p, const char *op);
 334
 335 /** Set names for ResultSet in parser */
 336 YAZ_EXPORT
 337 void ccl_parser_set_op_set (CCL_parser p, const char *op);
 338
 339 /** Set case sensitivity for parser */
 340 YAZ_EXPORT
 341 void ccl_parser_set_case (CCL_parser p, int case_sensitivity_flag);
 342
 343 /** Return english-readable error message for CCL parser error number */
 344 YAZ_EXPORT
 345 const char *ccl_err_msg (int ccl_errno);
 346
 347 /** Delete RPN tree returned by ccl_find */
 348 YAZ_EXPORT
 349 void ccl_rpn_delete (struct ccl_rpn_node *rpn);
 350
 351 /** Dump RPN tree in readable format to fd_out */
 352 YAZ_EXPORT
 353 void ccl_pr_tree (struct ccl_rpn_node *rpn, FILE *fd_out);
 354
 355 /** Add qualifier and supply attribute pairs for it */
 356 YAZ_EXPORT
 357 void ccl_qual_add (CCL_bibset b, const char *name, int no, int *attr);
 358
 359 /** Add qualifier and supply attributes pairs+attribute set for it */
 360 YAZ_EXPORT
 361 void ccl_qual_add_set (CCL_bibset b, const char *name, int no,
 362                        int *type, int *value, char **svalue, char **attsets);
 363
 364 /** Add special qualifier */
 365 YAZ_EXPORT
 366 void ccl_qual_add_special (CCL_bibset bibset, const char *n, const char *v);
 367
 368 /** Add combo qualifier */
 369 YAZ_EXPORT
 370 void ccl_qual_add_combi (CCL_bibset b, const char *n, const char *names);
 371
 372 /** Read CCL qualifier list spec from file inf */
 373 YAZ_EXPORT
 374 void ccl_qual_file (CCL_bibset bibset, FILE *inf);
 375
 376 /** Read CCL qualifier list spec from file inf */
 377 YAZ_EXPORT
 378 int ccl_qual_fname (CCL_bibset bibset, const char *fname);
 379
 380 /** Add CCL qualifier as buf spec (multiple lines). */
 381 YAZ_EXPORT
 382 void ccl_qual_buf(CCL_bibset bibset, const char *buf);
 383
 384 /** Add CCL qualifier as line spec. Note: line is _modified_ */
 385 YAZ_EXPORT
 386 void ccl_qual_line(CCL_bibset bibset, char *line);
 387
 388 /* Add CCL qualifier by using qual_name + value pair */
 389 YAZ_EXPORT
 390 void ccl_qual_fitem (CCL_bibset bibset, const char *value,
 391                      const char *qual_name);
 392
 393 /** Make CCL qualifier set */
 394 YAZ_EXPORT
 395 CCL_bibset ccl_qual_mk (void);
 396
 397 /** Delete CCL qualifier set */
 398 YAZ_EXPORT
 399 void ccl_qual_rm (CCL_bibset *b);
 400
 401 /** Char-to-upper function */
 402 extern int (*ccl_toupper)(int c);
 403
 404 /** CCL version of ccl_stricmp */
 405 YAZ_EXPORT
 406 int ccl_stricmp (const char *s1, const char *s2);
 407
 408 /** CCL version of ccl_memicmp */
 409 YAZ_EXPORT
 410 int ccl_memicmp (const char *s1, const char *s2, size_t n);
 411
 412 /** Search for qualifier 'name' in set 'b'. */
 413 YAZ_EXPORT
 414 struct ccl_rpn_attr *ccl_qual_search (CCL_parser cclp, const char *name,
 415                                       size_t len, int seq);
 416
 417 /** Create CCL parser */
 418 YAZ_EXPORT
 419 CCL_parser ccl_parser_create (void);
 420
 421 /** Destroy CCL parser */
 422 YAZ_EXPORT
 423 void ccl_parser_destroy (CCL_parser p);
 424
 425 /** String dup utility (ala strdup) */
 426 YAZ_EXPORT
 427 char *ccl_strdup (const char *str);
 428
 429 /** Search for special qualifier */
 430 YAZ_EXPORT
 431 const char *ccl_qual_search_special (CCL_bibset b,
 432                                                 const char *name);
 433 /** Pretty-print CCL RPN node tree to WRBUF */
 434 YAZ_EXPORT
 435 void ccl_pquery (WRBUF w, struct ccl_rpn_node *p);
 436
 437 #ifndef ccl_assert
 438 #define ccl_assert(x) ;
 439 #endif
 440
 441 YAZ_END_CDECL
 442
 443 #endif
 444