lib/index.h

   1 /*
   2  *      Sherlock: Data structures used in indices
   3  *
   4  *      (c) 2001--2003 Martin Mares <mj@ucw.cz>
   5  */
   6
   7 #ifndef _SHERLOCK_INDEX_H
   8 #define _SHERLOCK_INDEX_H
   9
  10 #include "lib/fastbuf.h"
  11 #include SHERLOCK_CUSTOM
  12 #include "charset/unistream.h"
  13
  14 /*
  15  *  Words and word complexes
  16  *
  17  *  MAX_WORD_LEN is the maximum length (measured in UTF-8 characters, excluding
  18  *  the terminating zero byte if there's any) of any word which may appear in the
  19  *  indices or in the bucket file. Naturally, the same constant also bounds
  20  *  the number of UCS-2 characters in a word.
  21  *
  22  *  Caveat: If you are upcasing/downcasing the word, the UTF-8 encoding can
  23  *  expand, although at most twice, so you need to reserve 2*MAX_WORD_LEN bytes.
  24  *
  25  *  MAX_COMPLEX_LEN is the upper bound on number of words in any word complex.
  26  */
  27
  28 #define MAX_WORD_LEN            64      /* a multiple of 4 */
  29 #define MAX_COMPLEX_LEN         10
  30
  31 /* Word and string types are defined in lib/custom.h */
  32
  33 /* Global index parameters */
  34
  35 struct index_params {
  36   sh_time_t ref_time;                   /* Reference time (for document ages etc.) */
  37 };
  38
  39 /* Index card attributes */
  40
  41 struct card_attr {
  42   u32 card;                             /* Reference to card description (either oid or filepos) */
  43 #ifdef CONFIG_SITES
  44   u32 site_id;
  45 #endif
  46   CUSTOM_CARD_ATTRS                     /* Include all custom attributes */
  47   byte weight;
  48   byte flags;
  49 #ifdef CONFIG_LASTMOD
  50   byte age;                             /* Document age in pseudo-logarithmic units wrt. reference time */
  51 #endif
  52 #ifdef CONFIG_FILETYPE
  53   byte type_flags;                      /* File type flags (see below) */
  54 #endif
  55 };
  56
  57 enum card_flag {
  58   CARD_FLAG_EMPTY = 1,                  /* Empty document (redirect, robot file etc.) [scanner] */
  59   CARD_FLAG_ACCENTED = 2,               /* Document contains accented characters [scanner] */
  60   CARD_FLAG_DUP = 4,                    /* Removed as a duplicate [merger] */
  61   CARD_FLAG_MERGED = 8,                 /* Destination of a merge [merger] */
  62   CARD_FLAG_IMAGE = 16,                 /* Is an image object [scanner] */
  63   CARD_FLAG_FRAMESET = 32,              /* Contains a frameset to be ignored [scanner] */
  64 };
  65
  66 #define CARD_POS_SHIFT 5                /* Card positions are shifted this # of bits to the right */
  67
  68 /*
  69  *  We store document type and several other properties in card_attr->type_flags.
  70  *  Here we define only the basic structure, the details are defined in custom.h
  71  *  (the list of type names custom_file_type_names[] and also setting of the file
  72  *  types in custom_create_attrs()).
  73  *
  74  *  bits 7--5   file type: (0-3: text types, 4-7: other types, defined by custom.h)
  75  *  bits 4--0   type-dependent information, for text types it's document language code
  76  */
  77
  78 #ifdef CONFIG_FILETYPE
  79 #define CA_GET_FILE_TYPE(a) ((a)->type_flags >> 5)
  80 #define CA_GET_FILE_INFO(a) ((a)->type_flags & 0x1f)
  81 #define CA_GET_FILE_LANG(a) ((a)->type_flags & 0x80 ? 0 : CA_GET_FILE_INFO(a))
  82 #define FILETYPE_ATTRS SMALL_SET_ATTR(ftype, FILETYPE, CA_GET_FILE_TYPE, ext_ft_parse)
  83 byte *ext_ft_parse(u32 *dest, byte *value, uns intval);
  84 extern byte *custom_file_type_names[8];
  85 #else
  86 #define FILETYPE_ATTRS
  87 #endif
  88
  89 #ifdef CONFIG_LANG
  90 /* You can use language matching without CONFIG_FILETYPE, but you have to define CA_GET_FILE_LANG yourself. */
  91 #define LANG_ATTRS SMALL_SET_ATTR(lang, LANG, CA_GET_FILE_LANG, ext_lang_parse)
  92 byte *ext_lang_parse(u32 *dest, byte *value, uns intval);
  93 #else
  94 #define LANG_ATTRS
  95 #endif
  96
  97 #define EXTENDED_ATTRS CUSTOM_ATTRS FILETYPE_ATTRS LANG_ATTRS
  98
  99 /* String fingerprints */
 100
 101 struct fingerprint {
 102   byte hash[12];
 103 };
 104
 105 void fingerprint(byte *string, struct fingerprint *fp);
 106
 107 static inline u32
 108 fp_hash(struct fingerprint *fp)
 109 {
 110   return (fp->hash[0] << 24) | (fp->hash[1] << 16) | (fp->hash[2] << 8) | fp->hash[3];
 111 }
 112
 113 /* Reading of tagged text (Unicode values, tags mapped to 0x80000000 and higher) */
 114
 115 #define GET_TAGGED_CHAR(p,u) do {                               \
 116   u = *p;                                                       \
 117   if (u >= 0xc0)                                                \
 118     GET_UTF8_CHAR(p,u);                                         \
 119   else if (u >= 0x80)                                           \
 120     {                                                           \
 121       p++;                                                      \
 122       if (u >= 0xb0)                                            \
 123         {                                                       \
 124           ASSERT(u == 0xb0);                                    \
 125           u += 0x80020000;                                      \
 126         }                                                       \
 127       else if (u >= 0xa0)                                       \
 128         {                                                       \
 129           ASSERT(*p >= 0x80 && *p <= 0xbf);                     \
 130           u = 0x80010000 + ((u & 0x0f) << 6) + (*p++ & 0x3f);   \
 131         }                                                       \
 132       else                                                      \
 133         u += 0x80000000;                                        \
 134     }                                                           \
 135   else                                                          \
 136     p++;                                                        \
 137 } while (0)
 138
 139 #define SKIP_TAGGED_CHAR(p) do {                                \
 140   if (*p >= 0x80 && *p < 0xc0)                                  \
 141     {                                                           \
 142       uns u = *p++;                                             \
 143       if (u >= 0xa0 && u < 0xb0 && *p >= 0x80 && *p < 0xc0)     \
 144         p++;                                                    \
 145     }                                                           \
 146   else                                                          \
 147     UTF8_SKIP(p);                                               \
 148 } while (0)
 149
 150 static inline uns
 151 bget_tagged_char(struct fastbuf *f)
 152 {
 153   uns u = bgetc(f);
 154   if ((int)u < 0x80)
 155     ;
 156   else if (u < 0xc0)
 157     {
 158       if (u >= 0xb0)
 159         {
 160           ASSERT(u == 0xb0);
 161           u += 0x80020000;
 162         }
 163       else if (u >= 0xa0)
 164         {
 165           uns v = bgetc(f);
 166           ASSERT(v >= 0x80 && v <= 0xbf);
 167           u = 0x80010000 + ((u & 0x0f) << 6) + (v & 0x3f);
 168         }
 169       else
 170         u += 0x80000000;
 171     }
 172   else
 173     {
 174       bungetc(f);
 175       u = bget_utf8(f);
 176     }
 177   return u;
 178 }
 179
 180 /* Conversion of document age from seconds to our internal units */
 181
 182 static inline int
 183 convert_age(sh_time_t lastmod, sh_time_t reftime)
 184 {
 185   sh_time_t age;
 186   if (reftime < lastmod)                /* past times */
 187     return -1;
 188   age = (reftime - lastmod) / 3600;
 189   if (age < 48)                         /* last 2 days: 1 hour resolution */
 190     return age;
 191   age = (age-48) / 24;
 192   if (age < 64)                         /* next 64 days: 1 day resolution */
 193     return 48 + age;
 194   age = (age-64) / 7;
 195   if (age < 135)                        /* next 135 weeks: 1 week resolution */
 196     return 112 + age;
 197   age = (age-135) / 52;
 198   if (age < 8)                          /* next 8 years: 1 year resolution */
 199     return 247 + age;
 200   return 255;                           /* then just "infinite future" */
 201 }
 202
 203 #endif