lib/custom.h

   1 /*
   2  *      Sherlock: Custom Parts of Configuration
   3  *
   4  *      (c) 2001--2002 Martin Mares <mj@ucw.cz>
   5  */
   6
   7 /* Name of this customization (version suffix) */
   8
   9 #define SHER_SUFFIX ""
  10
  11 /* Word types */
  12
  13 enum word_type {
  14   WT_RESERVED,                          /* Reserved word type */
  15   WT_TEXT,                              /* Ordinary text */
  16   WT_EMPH,                              /* Emphasized text */
  17   WT_SMALL,                             /* Small font */
  18   WT_TITLE,                             /* Document title */
  19   WT_SMALL_HEADING,                     /* Heading */
  20   WT_BIG_HEADING,                       /* Larger heading */
  21   WT_KEYWORD,                           /* Explicitly marked keyword */
  22   WT_META,                              /* Various meta-information */
  23   WT_ALT,                               /* Alternate texts for graphical elements */
  24   WT_URL1,                              /* Word extracted from document URL (low and high weight) */
  25   WT_URL2,
  26   WT_MAX
  27 };
  28
  29 /* Descriptive names used for user output */
  30 #define WORD_TYPE_USER_NAMES                                                    \
  31    "reserved", "text", "emph", "small", "title", "hdr1", "hdr2", "keywd",       \
  32    "meta", "alt", "urlword1", "urlword2", "type12", "type13", "type14", "type15"
  33
  34 /* Keywords for word type names */
  35 #define WORD_TYPE_NAMES                         \
  36         T(WORD, ~0)                             \
  37         T(TEXT, 1 << WT_TEXT)                   \
  38         T(EMPH, 1 << WT_EMPH)                   \
  39         T(SMALL, 1 << WT_SMALL)                 \
  40         T(TITLE, 1 << WT_TITLE)                 \
  41         T(HDR, (1 << WT_SMALL_HEADING) | (1 << WT_BIG_HEADING))  \
  42         T(HDR1, 1 << WT_SMALL_HEADING)          \
  43         T(HDR2, 1 << WT_BIG_HEADING)            \
  44         T(KEYWD, 1 << WT_KEYWORD)               \
  45         T(META, 1 << WT_META)                   \
  46         T(ALT, 1 << WT_ALT)                     \
  47         T(URLWORD, (1 << WT_URL1) | (1 << WT_URL2))
  48
  49 /* These types are not shown in document contexts */
  50 #define WORD_TYPES_HIDDEN ((1 << WT_URL1) | (1 << WT_URL2))
  51
  52 /* These types are always matched without accents if accent mode is set to "auto" */
  53 #define WORD_TYPES_NO_AUTO_ACCENT ((1 << WT_URL1) | (1 << WT_URL2))
  54
  55 /* String types */
  56
  57 enum string_type {
  58   ST_RESERVED,                          /* Reserved string type */
  59   ST_URL,                               /* URL of the document */
  60   ST_HOST,                              /* Host name */
  61   ST_DOMAIN,                            /* Domain name */
  62   ST_REF,                               /* URL reference */
  63   ST_BACKREF,                           /* Back-reference (frame or redirect source) */
  64   ST_MAX
  65 };
  66
  67 #define STRING_TYPE_USER_NAMES                                                  \
  68    "URL", "host", "domain", "ref", "backref", "type5", "type6", "type7",        \
  69    "type8", "type9", "type10", "type11", "type12", "type13", "type14", "type15"
  70
  71 #define STRING_TYPE_NAMES                       \
  72         T(URL, 1 << ST_URL)                     \
  73         T(HOST, 1 << ST_HOST)                   \
  74         T(DOMAIN, 1 << ST_DOMAIN)               \
  75         T(REF, 1 << ST_REF)                     \
  76         T(BACKREF, 1 << ST_BACKREF)
  77
  78 #define STRING_TYPES_URL ((1 << ST_URL) | (1 << ST_REF) | (1 << ST_BACKREF))
  79 /* These must be indexed in lowercase form */
  80 #define STRING_TYPES_CASE_INSENSITIVE ((1 << ST_HOST) | (1 << ST_DOMAIN))
  81
  82 /*
  83  *  Definitions of custom attributes:
  84  *
  85  *  INT_ATTR(type, id, oattr, keyword, get_func, parse_func)
  86  *
  87  *  type        data type used to hold the value
  88  *  id          C identifier of the attribute
  89  *  oattr       object attribute we get the value from
  90  *  keywd       search server keyword for the attribute
  91  *  void get_func(struct card_attr *ca, byte *attr)
  92  *              parse object attribute (may be NULL)
  93  *  byte *parse_func(u32 *dest, byte *value, uns intval)
  94  *              parse value in query (returns error message or NULL)
  95  *              for KEYWD = "string", it gets value="string", intval=0
  96  *              for KEYWD = num, it gets value=NULL, intval=num.
  97  *
  98  *  A good place for definitions of the functions is lib/custom.c.
  99  *
 100  *  Please order the attributes by decreasing size to get optimum padding.
 101  */
 102
 103 #if 0           /* Example */
 104
 105 #define CUSTOM_ATTRS INT_ATTR(u32, lm, 'L', LM, custom_get_lm, custom_parse_lm)
 106
 107 struct card_attr;
 108 void custom_get_lm(struct card_attr *ca, byte *attr);
 109 byte *custom_parse_lm(u32 *dest, byte *value, uns intval);
 110
 111 #else
 112
 113 #define CUSTOM_ATTRS
 114
 115 #endif