lib/custom.h

   1 /*
   2  *      Sherlock: Custom Parts of Configuration
   3  *
   4  *      (c) 2001--2003 Martin Mares <mj@ucw.cz>
   5  *
   6  *      This software may be freely distributed and used according to the terms
   7  *      of the GNU Lesser General Public License.
   8  */
   9
  10 /* Word types (at most 7 of them + WT_RESERVED and WT_MAX) */
  11
  12 enum word_type {
  13   WT_RESERVED,                          /* Reserved word type */
  14   WT_TEXT,                              /* Ordinary text */
  15   WT_EMPH,                              /* Emphasized text */
  16   WT_SMALL,                             /* Small font */
  17   WT_SMALL_HEADING,                     /* Heading */
  18   WT_BIG_HEADING,                       /* Larger heading */
  19   WT_ALT,                               /* Alternate texts for graphical elements */
  20   WT_LINK,                              /* Link text */
  21   WT_MAX
  22 };
  23
  24 /* Descriptive names used for user output */
  25 #define WORD_TYPE_USER_NAMES                                                    \
  26    "reserved", "text", "emph", "small", "hdr1", "hdr2", "alt", "link"
  27
  28 /* Keywords for word type names */
  29 #define WORD_TYPE_NAMES                         \
  30         T(WORD, ~(1 << WT_LINK))                \
  31         T(TEXT, 1 << WT_TEXT)                   \
  32         T(EMPH, 1 << WT_EMPH)                   \
  33         T(SMALL, 1 << WT_SMALL)                 \
  34         T(HDR, (1 << WT_SMALL_HEADING) | (1 << WT_BIG_HEADING))  \
  35         T(HDR1, 1 << WT_SMALL_HEADING)          \
  36         T(HDR2, 1 << WT_BIG_HEADING)            \
  37         T(ALT, 1 << WT_ALT)                     \
  38         T(LINK, 1 << WT_LINK)
  39
  40 /* These types are always matched without accents if accent mode is set to "auto" */
  41 #define WORD_TYPES_NO_AUTO_ACCENT 0
  42
  43 /* Meta information types (at most 16 of them + MT_MAX) */
  44
  45 enum meta_type {
  46   MT_TITLE,                             /* Document title */
  47   MT_KEYWORD,                           /* Keyword from the document */
  48   MT_MISC,                              /* Unclassified metas */
  49   MT_MAX
  50 };
  51
  52 #define META_TYPE_USER_NAMES                    \
  53    "title", "keywd", "misc"
  54
  55 /* Keywords for meta type names */
  56 #define META_TYPE_NAMES                         \
  57         T(TITLE, 1 << MT_TITLE)                 \
  58         T(KEYWD, 1 << MT_KEYWORD)               \
  59         T(META, 1 << MT_MISC)
  60
  61 #define META_TYPES_NO_AUTO_ACCENT 0
  62
  63 /* String types */
  64
  65 enum string_type {
  66   ST_RESERVED,                          /* Reserved string type */
  67   ST_URL,                               /* URL of the document */
  68   ST_HOST,                              /* Host name */
  69   ST_DOMAIN,                            /* Domain name */
  70   ST_REF,                               /* URL reference */
  71   ST_MAX
  72 };
  73
  74 #define STRING_TYPE_USER_NAMES                                                  \
  75    "URL", "host", "domain", "ref", "type4", "type5", "type6", "type7",  \
  76    "type8", "type9", "type10", "type11", "type12", "type13", "type14", "type15"
  77
  78 #define STRING_TYPE_NAMES                       \
  79         T(URL, 1 << ST_URL)                     \
  80         T(HOST, 1 << ST_HOST)                   \
  81         T(DOMAIN, 1 << ST_DOMAIN)               \
  82         T(REF, 1 << ST_REF)
  83
  84 #define STRING_TYPES_URL ((1 << ST_URL) | (1 << ST_REF))
  85 /* These must be indexed in lowercase form */
  86 #define STRING_TYPES_CASE_INSENSITIVE ((1 << ST_HOST) | (1 << ST_DOMAIN))
  87
  88 /*
  89  *  Definitions of custom attributes:
  90  *
  91  *  First of all, you need to define your own card_attr fields which will
  92  *  contain your attributes: CUSTOM_CARD_ATTRS lists them.
  93  *  Please order the attributes by decreasing size to get optimum padding.
  94  *
  95  *  Then define custom_create_attrs() which will get the object description
  96  *  and set your card_attr fields accordingly.
  97  *
  98  *  Finally, you have to define CUSTOM_ATTRS with matching rules:
  99  *
 100  *  INT_ATTR(id, keyword, get_func, parse_func) -- unsigned integer attribute
 101  *
 102  *  id          C identifier of the attribute
 103  *  keywd       search server keyword for the attribute
 104  *  int get_func(struct card_attr *ca)
 105  *              get attribute value from the card_attr
 106  *  byte *parse_func(u32 *dest, byte *value, uns intval)
 107  *              parse value in query (returns error message or NULL)
 108  *              for KEYWD = "string", it gets value="string", intval=0
 109  *              for KEYWD = num, it gets value=NULL, intval=num.
 110  *
 111  *  SMALL_SET_ATTR(id, keyword, get_func, parse_func)
 112  *    -- integers 0..31 with set matching
 113  *
 114  *  A good place for definitions of the functions is lib/custom.c.
 115  */
 116
 117 struct card_attr;
 118 struct odes;
 119
 120 /* No custom attributes defined yet */
 121
 122 #define CUSTOM_CARD_ATTRS
 123 #define CUSTOM_ATTRS
 124 static inline void custom_create_attrs(struct odes *odes UNUSED, struct card_attr *ca UNUSED) { }