include/yaz/ccl.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2008 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 ccl.h
  29     \brief Header with public definitions for CCL.
  30 */
  31
  32 /*
  33  * CCL - header file
  34  *
  35  * $Id: ccl.h,v 1.29 2007-05-01 12:22:10 adam Exp $
  36  *
  37  * Old Europagate Log:
  38  *
  39  * Revision 1.10  1996/01/08  08:41:22  adam
  40  * Minor changes.
  41  *
  42  * Revision 1.9  1995/07/20  08:15:16  adam
  43  * Bug fix: Token value for comma and OR were the same!
  44  *
  45  * Revision 1.8  1995/07/11  12:28:34  adam
  46  * New function: ccl_token_simple (split into simple tokens) and
  47  *  ccl_token_del (delete tokens).
  48  *
  49  * Revision 1.7  1995/05/16  09:39:38  adam
  50  * LICENSE.
  51  *
  52  * Revision 1.6  1995/05/11  14:04:03  adam
  53  * Changes in the reading of qualifier(s). New function: ccl_qual_fitem.
  54  * New variable ccl_case_sensitive, which controls whether reserved
  55  * words and field names are case sensitive or not.
  56  *
  57  * Revision 1.5  1995/02/23  08:32:11  adam
  58  * Changed header.
  59  *
  60  * Revision 1.3  1995/02/16  13:20:10  adam
  61  * Spell fix.
  62  *
  63  * Revision 1.2  1995/02/15  17:43:08  adam
  64  * Minor changes to the ccl interface. Bug fix in iso2709 module.
  65  *
  66  * Revision 1.1  1995/02/14  19:55:21  adam
  67  * Header files ccl.h/cclp.h are gone! They have been merged an
  68  * moved to ../include/ccl.h.
  69  *
  70  */
  71
  72 #ifndef CCL_H
  73 #define CCL_H
  74
  75 #include <yaz/yconfig.h>
  76 #include <stdio.h>
  77 #include <yaz/xmalloc.h>
  78 #include <yaz/wrbuf.h>
  79
  80 YAZ_BEGIN_CDECL
  81
  82 #define CCL_ERR_OK                0
  83 #define CCL_ERR_TERM_EXPECTED     1
  84 #define CCL_ERR_RP_EXPECTED       2
  85 #define CCL_ERR_SETNAME_EXPECTED  3
  86 #define CCL_ERR_OP_EXPECTED       4
  87 #define CCL_ERR_BAD_RP            5
  88 #define CCL_ERR_UNKNOWN_QUAL      6
  89 #define CCL_ERR_DOUBLE_QUAL       7
  90 #define CCL_ERR_EQ_EXPECTED       8
  91 #define CCL_ERR_BAD_RELATION      9
  92 #define CCL_ERR_TRUNC_NOT_LEFT   10
  93 #define CCL_ERR_TRUNC_NOT_BOTH   11
  94 #define CCL_ERR_TRUNC_NOT_RIGHT  12
  95
  96 /** \brief attribute node (type, value) pair as used in RPN */
  97 struct ccl_rpn_attr {
  98     /** \brief next attribute */
  99     struct ccl_rpn_attr *next;
 100     /** \brief attribute set */
 101     char *set;
 102     /** \brief attribute type, Bib-1: 1=use, 2=relation, 3=position, .. */
 103     int type;
 104     /** \brief attribute value type (numeric or string) */
 105     int kind;
 106 #define CCL_RPN_ATTR_NUMERIC 1
 107 #define CCL_RPN_ATTR_STRING 2
 108     union {
 109         /** \brief numeric attribute value */
 110         int numeric;
 111         /** \brief string attribute value */
 112         char *str;
 113     } value;
 114 };
 115
 116 /** \brief node type or RPN tree generated by the CCL parser */
 117 enum ccl_rpn_kind {
 118     CCL_RPN_AND,
 119     CCL_RPN_OR,
 120     CCL_RPN_NOT,
 121     CCL_RPN_TERM,
 122     CCL_RPN_SET,
 123     CCL_RPN_PROX
 124 };
 125
 126 /** \brief RPN tree structure node */
 127 struct ccl_rpn_node {
 128     /** \brief node type, one of CCL_RPN_AND, CCL_RPN_OR,.. */
 129     enum ccl_rpn_kind kind;
 130     union {
 131         /** \brief Boolean including proximity 0=left, 1=right, 2=prox parms */
 132         struct ccl_rpn_node *p[3];
 133         /** \brief Attributes + Term */
 134         struct {
 135             char *term;
 136             char *qual;
 137             struct ccl_rpn_attr *attr_list;
 138         } t;
 139         /** Result set */
 140         char *setname;
 141     } u;
 142 };
 143
 144 /** \brief CCL bibset, AKA profile */
 145 typedef struct ccl_qualifiers *CCL_bibset;
 146
 147 /** \brief CCL parser */
 148 typedef struct ccl_parser *CCL_parser;
 149
 150 /**
 151    \brief parse CCL find string using CCL profile return RPN tree
 152
 153    Parses a CCL Find command in a simple C string. Returns CCL parse
 154    tree node describing RPN if parsing is successful. If parsing is
 155    unsuccesful, NULL is returned and error and pos is set accordingly.
 156 */
 157 YAZ_EXPORT
 158 struct ccl_rpn_node *ccl_find_str(CCL_bibset bibset,
 159                                   const char *str, int *error, int *pos);
 160
 161
 162 /**
 163    \brief parse CCL find string with parser and return RPN tree
 164
 165    Parses a CCL Find command in a simple C string. Returns CCL parse
 166    tree node describing RPN if parsing is successful. If parsing is
 167    unsuccesful, NULL is returned and error and pos is set accordingly.
 168 */
 169 YAZ_EXPORT
 170 struct ccl_rpn_node *ccl_parser_find_str(CCL_parser cclp, const char *str);
 171
 172 /** Set case sensitivity for parser */
 173 YAZ_EXPORT
 174 void ccl_parser_set_case(CCL_parser p, int case_sensitivity_flag);
 175
 176 /** Return english-readable error message for CCL parser error number */
 177 YAZ_EXPORT
 178 const char *ccl_err_msg(int ccl_errno);
 179
 180 /** Delete RPN tree returned by ccl_find */
 181 YAZ_EXPORT
 182 void ccl_rpn_delete(struct ccl_rpn_node *rpn);
 183
 184 /** Dump RPN tree in readable format to fd_out */
 185 YAZ_EXPORT
 186 void ccl_pr_tree(struct ccl_rpn_node *rpn, FILE *fd_out);
 187
 188 /** Add qualifier and supply attribute pairs for it */
 189 YAZ_EXPORT
 190 void ccl_qual_add(CCL_bibset b, const char *name, int no, int *attr);
 191
 192 /** Add qualifier and supply attributes pairs+attribute set for it */
 193 YAZ_EXPORT
 194 void ccl_qual_add_set(CCL_bibset b, const char *name, int no,
 195                       int *type, int *value, char **svalue, char **attsets);
 196
 197 /** Add special qualifier */
 198 YAZ_EXPORT
 199 void ccl_qual_add_special(CCL_bibset bibset, const char *n, const char *cp);
 200
 201 /** Add combo qualifier */
 202 YAZ_EXPORT
 203 void ccl_qual_add_combi(CCL_bibset b, const char *n, const char **names);
 204
 205 /** Read CCL qualifier list spec from file inf */
 206 YAZ_EXPORT
 207 void ccl_qual_file(CCL_bibset bibset, FILE *inf);
 208
 209 /** Read CCL qualifier list spec from file inf */
 210 YAZ_EXPORT
 211 int ccl_qual_fname(CCL_bibset bibset, const char *fname);
 212
 213 /** Add CCL qualifier as buf spec(multiple lines). */
 214 YAZ_EXPORT
 215 void ccl_qual_buf(CCL_bibset bibset, const char *buf);
 216
 217 /** Add CCL qualifier as line spec. Note: line is _modified_ */
 218 YAZ_EXPORT
 219 void ccl_qual_line(CCL_bibset bibset, char *line);
 220
 221 /* Add CCL qualifier by using qual_name + value pair */
 222 YAZ_EXPORT
 223 void ccl_qual_fitem(CCL_bibset bibset, const char *value,
 224                     const char *qual_name);
 225
 226 /** Make CCL qualifier set */
 227 YAZ_EXPORT
 228 CCL_bibset ccl_qual_mk(void);
 229
 230 /** Delete CCL qualifier set */
 231 YAZ_EXPORT
 232 void ccl_qual_rm(CCL_bibset *b);
 233
 234 /** Char-to-upper function */
 235 extern int(*ccl_toupper)(int c);
 236
 237 /** CCL version of ccl_stricmp */
 238 YAZ_EXPORT
 239 int ccl_stricmp(const char *s1, const char *s2);
 240
 241 /** CCL version of ccl_memicmp */
 242 YAZ_EXPORT
 243 int ccl_memicmp(const char *s1, const char *s2, size_t n);
 244
 245 /** Create CCL parser */
 246 YAZ_EXPORT
 247 CCL_parser ccl_parser_create(CCL_bibset bibset);
 248
 249 /** Destroy CCL parser */
 250 YAZ_EXPORT
 251 void ccl_parser_destroy(CCL_parser p);
 252
 253 /** Search for special qualifier */
 254 YAZ_EXPORT
 255 const char **ccl_qual_search_special(CCL_bibset b, const char *name);
 256 /** Pretty-print CCL RPN node tree to WRBUF */
 257 YAZ_EXPORT
 258 void ccl_pquery(WRBUF w, struct ccl_rpn_node *p);
 259
 260 YAZ_EXPORT
 261 int ccl_parser_get_error(CCL_parser cclp, int *pos);
 262
 263 YAZ_EXPORT
 264 struct ccl_rpn_node *ccl_rpn_node_create(enum ccl_rpn_kind kind);
 265
 266 YAZ_EXPORT
 267 void ccl_add_attr_numeric(struct ccl_rpn_node *p, const char *set,
 268                           int type, int value);
 269
 270 YAZ_EXPORT
 271 void ccl_add_attr_string(struct ccl_rpn_node *p, const char *set,
 272                          int type, char *value);
 273
 274 YAZ_EXPORT
 275 int ccl_search_stop(CCL_bibset bibset, const char *qname,
 276                     const char *src_str, size_t src_len);
 277
 278
 279 /** \brief stop words handle (pimpl) */
 280 typedef struct ccl_stop_words *ccl_stop_words_t;
 281
 282 /** \brief creates stop words handle */
 283 YAZ_EXPORT
 284 ccl_stop_words_t ccl_stop_words_create(void);
 285
 286 /** \brief destroys stop words handle */
 287 YAZ_EXPORT
 288 void ccl_stop_words_destroy(ccl_stop_words_t csw);
 289
 290 /** \brief removes stop words from RPN tree */
 291 YAZ_EXPORT
 292 int ccl_stop_words_tree(ccl_stop_words_t csw,
 293                         CCL_bibset bibset, struct ccl_rpn_node **t);
 294
 295 /** \brief returns information about removed "stop" words */
 296 YAZ_EXPORT
 297 int ccl_stop_words_info(ccl_stop_words_t csw, int idx,
 298                         const char **qualname, const char **term);
 299
 300 #ifndef ccl_assert
 301 #define ccl_assert(x) ;
 302 #endif
 303
 304
 305 /** \brief common attributes
 306
 307    use (1)
 308
 309    relation (2)
 310                             -1  none
 311                              0  ordered
 312                            1-6  relation (<, <=, =, >=, >, <>)
 313
 314    position (3)
 315                             -1  none
 316                              1  first in field
 317                              2  first in sub field
 318                              3  any position in field
 319    structure (4)
 320                             -1  none
 321                              0  word/phrase auto select
 322                              1  phrase
 323                              2  word
 324                              3  key
 325                              4  year
 326                              5  date (normalized)
 327                              6  word list
 328                            100  date (un-normalized)
 329                            101  name (normalized)
 330                            102  name (un-normalized)
 331    truncation (5)
 332    completeness (6)
 333 */
 334
 335 #define CCL_BIB1_USE 1
 336 #define CCL_BIB1_REL 2
 337 #define CCL_BIB1_POS 3
 338 #define CCL_BIB1_STR 4
 339 #define CCL_BIB1_TRU 5
 340 #define CCL_BIB1_COM 6
 341
 342 #define CCL_BIB1_STR_WP (-1)
 343 #define CCL_BIB1_STR_AND_LIST (-2)
 344 #define CCL_BIB1_STR_OR_LIST (-3)
 345 #define CCL_BIB1_REL_ORDER (-1)
 346 #define CCL_BIB1_REL_PORDER (-2)
 347
 348 #define CCL_BIB1_TRU_CAN_LEFT (-1)
 349 #define CCL_BIB1_TRU_CAN_RIGHT (-2)
 350 #define CCL_BIB1_TRU_CAN_BOTH  (-3)
 351 #define CCL_BIB1_TRU_CAN_NONE  (-4)
 352
 353
 354
 355 YAZ_END_CDECL
 356
 357 #endif
 358
 359 /*
 360  * Local variables:
 361  * c-basic-offset: 4
 362  * indent-tabs-mode: nil
 363  * End:
 364  * vim: shiftwidth=4 tabstop=8 expandtab
 365  */
 366