include/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 /*
  46  * CCL - header file
  47  *
  48  * $Log: ccl.h,v $
  49  * Revision 1.9  1998-02-11 11:53:33  adam
  50  * Changed code so that it compiles as C++.
  51  *
  52  * Revision 1.8  1997/09/29 09:01:19  adam
  53  * Changed CCL parser to be thread safe. New type, CCL-parser, declared
  54  * and a create/destructor ccl_parser_create/ccl_parser_destroy has been
  55  * added.
  56  *
  57  * Revision 1.7  1997/09/01 08:49:47  adam
  58  * New windows NT/95 port using MSV5.0. To export DLL functions the
  59  * YAZ_EXPORT modifier was added. Defined in yconfig.h.
  60  *
  61  * Revision 1.6  1997/05/14 06:53:37  adam
  62  * C++ support.
  63  *
  64  * Revision 1.5  1997/04/30 08:52:08  quinn
  65  * Null
  66  *
  67  * Revision 1.4  1996/10/11  15:02:26  adam
  68  * CCL parser from Europagate Email gateway 1.0.
  69  *
  70  * Revision 1.10  1996/01/08  08:41:22  adam
  71  * Minor changes.
  72  *
  73  * Revision 1.9  1995/07/20  08:15:16  adam
  74  * Bug fix: Token value for comma and OR were the same!
  75  *
  76  * Revision 1.8  1995/07/11  12:28:34  adam
  77  * New function: ccl_token_simple (split into simple tokens) and
  78  *  ccl_token_del (delete tokens).
  79  *
  80  * Revision 1.7  1995/05/16  09:39:38  adam
  81  * LICENSE.
  82  *
  83  * Revision 1.6  1995/05/11  14:04:03  adam
  84  * Changes in the reading of qualifier(s). New function: ccl_qual_fitem.
  85  * New variable ccl_case_sensitive, which controls whether reserved
  86  * words and field names are case sensitive or not.
  87  *
  88  * Revision 1.5  1995/02/23  08:32:11  adam
  89  * Changed header.
  90  *
  91  * Revision 1.3  1995/02/16  13:20:10  adam
  92  * Spell fix.
  93  *
  94  * Revision 1.2  1995/02/15  17:43:08  adam
  95  * Minor changes to the ccl interface. Bug fix in iso2709 module.
  96  *
  97  * Revision 1.1  1995/02/14  19:55:21  adam
  98  * Header files ccl.h/cclp.h are gone! They have been merged an
  99  * moved to ../include/ccl.h.
 100  *
 101  */
 102
 103 #ifndef CCL_H
 104 #define CCL_H
 105
 106 #ifdef __cplusplus
 107 extern "C" {
 108 #endif
 109
 110 /* CCL error numbers */
 111 #define CCL_ERR_OK                0
 112 #define CCL_ERR_TERM_EXPECTED     1
 113 #define CCL_ERR_RP_EXPECTED       2
 114 #define CCL_ERR_SETNAME_EXPECTED  3
 115 #define CCL_ERR_OP_EXPECTED       4
 116 #define CCL_ERR_BAD_RP            5
 117 #define CCL_ERR_UNKNOWN_QUAL      6
 118 #define CCL_ERR_DOUBLE_QUAL       7
 119 #define CCL_ERR_EQ_EXPECTED       8
 120 #define CCL_ERR_BAD_RELATION      9
 121 #define CCL_ERR_TRUNC_NOT_LEFT   10
 122 #define CCL_ERR_TRUNC_NOT_BOTH   11
 123 #define CCL_ERR_TRUNC_NOT_RIGHT  12
 124
 125 /* attribute pair (type, value) */
 126 struct ccl_rpn_attr {
 127     struct ccl_rpn_attr *next;
 128     int type;
 129     int value;
 130 };
 131
 132 #define CCL_RPN_AND 1
 133 #define CCL_RPN_OR 2
 134 #define CCL_RPN_NOT 3
 135 #define CCL_RPN_TERM 4
 136 #define CCL_RPN_SET 5
 137 #define CCL_RPN_PROX 6
 138
 139 /* RPN tree structure */
 140 struct ccl_rpn_node {
 141     int kind;
 142     union {
 143         struct ccl_rpn_node *p[2];
 144         struct {
 145             char *term;
 146             struct ccl_rpn_attr *attr_list;
 147         } t;
 148         char *setname;
 149     } u;
 150 };
 151
 152 typedef struct ccl_qualifiers *CCL_bibset;
 153
 154 /* use (1)
 155
 156    relation (2)
 157                             -1  none
 158                              0  ordered
 159                            1-6  relation (<, <=, =, >=, >, <>)
 160
 161    position (3)
 162                             -1  none
 163                              1  first in field
 164                              2  first in sub field
 165                              3  any position in field
 166    structure (4)
 167                             -1  none
 168                              0  word/phrase auto select
 169                              1  phrase
 170                              2  word
 171                              3  key
 172                              4  year
 173                              5  date (normalized)
 174                              6  word list
 175                            100  date (un-normalized)
 176                            101  name (normalized)
 177                            102  name (un-normalized)
 178    truncation (5)
 179    completeness (6)
 180 */
 181
 182 #define CCL_BIB1_USE 1
 183 #define CCL_BIB1_REL 2
 184 #define CCL_BIB1_POS 3
 185 #define CCL_BIB1_STR 4
 186 #define CCL_BIB1_TRU 5
 187 #define CCL_BIB1_COM 6
 188
 189 #define CCL_BIB1_STR_WP (-1)
 190 #define CCL_BIB1_REL_ORDER (-1)
 191
 192 #define CCL_BIB1_TRU_CAN_LEFT (-1)
 193 #define CCL_BIB1_TRU_CAN_RIGHT (-2)
 194 #define CCL_BIB1_TRU_CAN_BOTH  (-3)
 195 #define CCL_BIB1_TRU_CAN_NONE  (-4)
 196
 197 #define CCL_TOK_EOL   0
 198 #define CCL_TOK_TERM  1
 199 #define CCL_TOK_REL   2
 200 #define CCL_TOK_EQ    3
 201 #define CCL_TOK_PROX  4
 202 #define CCL_TOK_LP    5
 203 #define CCL_TOK_RP    6
 204 #define CCL_TOK_COMMA 7
 205 #define CCL_TOK_AND   8
 206 #define CCL_TOK_OR    9
 207 #define CCL_TOK_NOT   10
 208 #define CCL_TOK_MINUS 11
 209 #define CCL_TOK_SET   12
 210
 211 /* CCL token */
 212 struct ccl_token {
 213     char kind;
 214     size_t len;
 215     const char *name;
 216     struct ccl_token *next;
 217     struct ccl_token *prev;
 218 };
 219
 220 /* CCL Qualifier */
 221 struct ccl_qualifier {
 222     char *name;
 223     struct ccl_rpn_attr *attr_list;
 224     struct ccl_qualifier *next;
 225 };
 226
 227 struct ccl_parser {
 228 /* current lookahead token */
 229     struct ccl_token *look_token;
 230
 231 /* holds error code if error occur (and approx position of error) */
 232     int error_code;
 233     const char *error_pos;
 234
 235 /* current bibset */
 236     CCL_bibset bibset;
 237
 238     char *ccl_token_and;
 239     char *ccl_token_or;
 240     char *ccl_token_not;
 241     char *ccl_token_set;
 242     int ccl_case_sensitive;
 243 };
 244
 245 typedef struct ccl_parser *CCL_parser;
 246
 247 /* Generate tokens from command string - obeys all CCL opererators */
 248 struct ccl_token *ccl_parser_tokenize (CCL_parser cclp,
 249                                        const char *command);
 250 struct ccl_token *ccl_tokenize (const char *command);
 251
 252 /* Generate tokens from command string - oebeys only simple tokens and
 253    quoted strings */
 254 struct ccl_token *ccl_token_simple (const char *command);
 255
 256 /* Delete token list */
 257 void ccl_token_del (struct ccl_token *list);
 258
 259 /* Parse CCL Find command - NULL-terminated string */
 260 struct ccl_rpn_node *ccl_find_str (CCL_bibset bibset,
 261                                    const char *str, int *error, int *pos);
 262
 263 /* Parse CCL Find command - Tokens read by ccl_tokenize */
 264 struct ccl_rpn_node *ccl_find (CCL_bibset abibset, struct ccl_token *list,
 265                                int *error, const char **pos);
 266
 267 /* Return english-readable error message */
 268 const char *ccl_err_msg (int ccl_errno);
 269
 270 /* Delete RPN tree returned by ccl_find */
 271 void ccl_rpn_delete (struct ccl_rpn_node *rpn);
 272
 273 /* Dump RPN tree in readable format to fd_out */
 274 void ccl_pr_tree (struct ccl_rpn_node *rpn, FILE *fd_out);
 275
 276 /* Add CCL qualifier */
 277 void ccl_qual_add (CCL_bibset b, const char *name, int no, int *attr);
 278
 279 /* Read CCL qualifier list spec from file inf */
 280 void ccl_qual_file (CCL_bibset bibset, FILE *inf);
 281
 282 /* Add CCL qualifier by using single-line spec */
 283 void ccl_qual_fitem (CCL_bibset bibset, const char *cp, const char *qual_name);
 284
 285 /* Make CCL qualifier set */
 286 CCL_bibset ccl_qual_mk (void);
 287
 288 /* Delete CCL qualifier set */
 289 void ccl_qual_rm (CCL_bibset *b);
 290
 291 /* Char-to-upper function */
 292 extern int (*ccl_toupper)(int c);
 293
 294 /* String utilities */
 295 int ccl_stricmp (const char *s1, const char *s2);
 296 int ccl_memicmp (const char *s1, const char *s2, size_t n);
 297
 298 /* Search for qualifier 'name' in set 'b'. */
 299 struct ccl_rpn_attr *ccl_qual_search (CCL_parser cclp, const char *name,
 300                                       size_t len);
 301
 302 /* Create CCL parser */
 303 CCL_parser ccl_parser_create (void);
 304
 305 /* Destroy CCL parser */
 306 void ccl_parser_destroy (CCL_parser p);
 307
 308 #ifdef __cplusplus
 309 }
 310 #endif
 311
 312 #endif
 313