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