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