Mainline is now v3.3.

[libucw.git] / lib / index.h

diff --git a/lib/index.h b/lib/index.h
index 8a97529380954be6fe4f87cb8ddcc151605a6c03..bab49b952dcaca54ecbcb43058eecfb494f91e09 100644 (file)
--- a/lib/index.h
+++ b/lib/index.h
@@ -1,49 +1,75 @@
 /*
 /*

- *     Sherlock Gatherer: Data structures used in indices
+ *     Sherlock: Data structures used in indices

  *
  *

- *     (c) 2001 Martin Mares <mj@ucw.cz>
+ *     (c) 2001--2004 Martin Mares <mj@ucw.cz>

  */
 
  */
 

-#define CLAMP(x,min,max) ({ int _t=x; (_t < min) ? min : (_t > max) ? max : _t; })
+#ifndef _SHERLOCK_INDEX_H
+#define _SHERLOCK_INDEX_H

 
 

-/* Words */
+#include "custom/lib/custom.h"

 
 

-#define MAX_WORD_LEN           64
+#define INDEX_VERSION (0x32260200+sizeof(struct card_attr))    /* Increase with each incompatible change in index format */

 
 

-/* Word types */
+/*
+ *  Words
+ *
+ *  MAX_WORD_LEN is the maximum length (measured in UTF-8 characters, excluding
+ *  the terminating zero byte if there's any) of any word which may appear in the
+ *  indices or in the bucket file. Naturally, the same constant also bounds
+ *  the number of UCS-2 characters in a word.
+ *
+ *  Caveat: If you are upcasing/downcasing the word, the UTF-8 encoding can
+ *  expand, although at most twice, so you need to reserve 2*MAX_WORD_LEN bytes.
+ */

 
 

-enum word_type {
-  WT_RESERVED,                         /* Reserved word type */
-  WT_TEXT,                             /* Ordinary text */
-  WT_EMPH,                             /* Emphasized text */
-  WT_SMALL,                            /* Small font */
-  WT_TITLE,                            /* Document title */
-  WT_SMALL_HEADING,                    /* Heading */
-  WT_BIG_HEADING,                      /* Larger heading */
-  WT_KEYWORD,                          /* Explicitly marked keyword */
-  WT_META,                             /* Various meta-information */
-  WT_ALT                               /* Alternate texts for graphical elements */
-};
+#define MAX_WORD_LEN           64      /* a multiple of 4 */

 
 

-/* String types */
+/* Word and string types are defined in lib/custom.h */

 
 

-enum string_type {
-  ST_RESERVED,                         /* Reserved string type */
-  ST_URL,                              /* URL of the document */
-  ST_HOST,                             /* Host name */
-  ST_DOMAIN,                           /* Domain name */
-  ST_REF,                              /* URL reference */
-  ST_BACKREF,                          /* Back-reference (frame or redirect source) */
-};
+/* Types used for storing contexts */
+
+#ifdef CONFIG_CONTEXTS
+#if CONFIG_MAX_CONTEXTS == 32768
+typedef u16 context_t;
+#define bget_context bgetw
+#define bput_context bputw
+#define GET_CONTEXT GET_U16
+#define PUT_CONTEXT PUT_U16
+#elif CONFIG_MAX_CONTEXTS == 256
+typedef byte context_t;
+#define bget_context bgetc
+#define bput_context bputc
+#define GET_CONTEXT GET_U8
+#define PUT_CONTEXT PUT_U8
+#else
+#error CONFIG_MAX_CONTEXTS set to an invalid value.
+#endif
+#else
+struct fastbuf;
+typedef struct { } context_t;
+static inline uns bget_context(struct fastbuf *b UNUSED) { return 0; }
+static inline void bput_context(struct fastbuf *b UNUSED, uns context UNUSED) { }
+#define GET_CONTEXT(p) 0
+#define PUT_CONTEXT(p,x) do {} while(0)
+#endif

 
 /* Index card attributes */
 
 struct card_attr {
   u32 card;                            /* Reference to card description (either oid or filepos) */
 
 /* Index card attributes */
 
 struct card_attr {
   u32 card;                            /* Reference to card description (either oid or filepos) */

+#ifdef CONFIG_SITES

   u32 site_id;
   u32 site_id;

+#endif
+  CUSTOM_CARD_ATTRS                    /* Include all custom attributes */

   byte weight;
   byte flags;
   byte weight;
   byte flags;

-  byte rfu[2];
+#ifdef CONFIG_LASTMOD
+  byte age;                            /* Document age in pseudo-logarithmic units wrt. reference time */
+#endif
+#ifdef CONFIG_FILETYPE
+  byte type_flags;                     /* File type flags (see below) */
+#endif

 };
 
 enum card_flag {
 };
 
 enum card_flag {


@@ -51,8 +77,46 @@ enum card_flag {
   CARD_FLAG_ACCENTED = 2,              /* Document contains accented characters [scanner] */
   CARD_FLAG_DUP = 4,                   /* Removed as a duplicate [merger] */
   CARD_FLAG_MERGED = 8,                        /* Destination of a merge [merger] */
   CARD_FLAG_ACCENTED = 2,              /* Document contains accented characters [scanner] */
   CARD_FLAG_DUP = 4,                   /* Removed as a duplicate [merger] */
   CARD_FLAG_MERGED = 8,                        /* Destination of a merge [merger] */

+  CARD_FLAG_IMAGE = 16,                        /* Is an image object [scanner] */
+  CARD_FLAG_FRAMESET = 32,             /* Contains a frameset to be ignored [scanner] */
+  CARD_FLAG_OVERRIDEN = 64,            /* Overriden by another index [sherlockd] */

 };
 
 };
 

+#define CARD_POS_SHIFT 5               /* Card positions are shifted this # of bits to the right */
+
+/*
+ *  We store document type and several other properties in card_attr->type_flags.
+ *  Here we define only the basic structure, the details are defined in custom.h
+ *  (the list of type names custom_file_type_names[] and also setting of the file
+ *  types in custom_create_attrs()).
+ *
+ *  bits 7--5  file type: (0-3: text types, 4-7: other types, defined by custom.h)
+ *  bits 4--0  type-dependent information, for text types it's document language code
+ */
+
+#ifdef CONFIG_FILETYPE
+#define CA_GET_FILE_TYPE(a) ((a)->type_flags >> 5)
+#define CA_GET_FILE_INFO(a) ((a)->type_flags & 0x1f)
+#define CA_GET_FILE_LANG(a) ((a)->type_flags & 0x80 ? 0 : CA_GET_FILE_INFO(a))
+#define FILETYPE_ATTRS SMALL_SET_ATTR(ftype, FILETYPE, CA_GET_FILE_TYPE, ext_ft_parse)
+#define MAX_FILE_TYPES 8
+#define FILETYPE_IS_TEXT(f) ((f) < 4)
+byte *ext_ft_parse(u32 *dest, byte *value, uns intval);
+extern byte *custom_file_type_names[MAX_FILE_TYPES];
+#else
+#define FILETYPE_ATTRS
+#endif
+
+#ifdef CONFIG_LANG
+/* You can use language matching without CONFIG_FILETYPE, but you have to define CA_GET_FILE_LANG yourself. */
+#define LANG_ATTRS SMALL_SET_ATTR(lang, LANG, CA_GET_FILE_LANG, ext_lang_parse)
+byte *ext_lang_parse(u32 *dest, byte *value, uns intval);
+#else
+#define LANG_ATTRS
+#endif
+
+#define EXTENDED_ATTRS CUSTOM_ATTRS LANG_ATTRS         /* Beware, FILETYPE_ATTRS are handled separately */
+

 /* String fingerprints */
 
 struct fingerprint {
 /* String fingerprints */
 
 struct fingerprint {


@@ -60,3 +124,48 @@ struct fingerprint {
 };
 
 void fingerprint(byte *string, struct fingerprint *fp);
 };
 
 void fingerprint(byte *string, struct fingerprint *fp);

+
+static inline u32
+fp_hash(struct fingerprint *fp)
+{
+  return (fp->hash[0] << 24) | (fp->hash[1] << 16) | (fp->hash[2] << 8) | fp->hash[3];
+}
+
+/* The card fingerprints */
+
+struct card_print {
+  struct fingerprint fp;
+  u32 cardid;
+};
+
+/* URL keys */
+
+#define URL_KEY_BUF_SIZE (3*MAX_URL_SIZE)
+byte *url_key(byte *url, byte *buf);
+void url_fingerprint(byte *url, struct fingerprint *fp);
+void url_key_init(void);
+
+/* Conversion of document age from seconds to our internal units */
+
+static inline int
+convert_age(sh_time_t lastmod, sh_time_t reftime)
+{
+  sh_time_t age;
+  if (reftime < lastmod)               /* past times */
+    return -1;
+  age = (reftime - lastmod) / 3600;
+  if (age < 48)                                /* last 2 days: 1 hour resolution */
+    return age;
+  age = (age-48) / 24;
+  if (age < 64)                                /* next 64 days: 1 day resolution */
+    return 48 + age;
+  age = (age-64) / 7;
+  if (age < 135)                       /* next 135 weeks: 1 week resolution */
+    return 112 + age;
+  age = (age-135) / 52;
+  if (age < 8)                         /* next 8 years: 1 year resolution */
+    return 247 + age;
+  return 255;                          /* then just "infinite future" */
+}
+
+#endif