lib/custom.h

   1 /*
   2  *      Sherlock: Custom Parts of Configuration
   3  *
   4  *      (c) 2001--2002 Martin Mares <mj@ucw.cz>
   5  */
   6
   7 /* Word types */
   8
   9 enum word_type {
  10   WT_RESERVED,                          /* Reserved word type */
  11   WT_TEXT,                              /* Ordinary text */
  12   WT_EMPH,                              /* Emphasized text */
  13   WT_SMALL,                             /* Small font */
  14   WT_TITLE,                             /* Document title */
  15   WT_SMALL_HEADING,                     /* Heading */
  16   WT_BIG_HEADING,                       /* Larger heading */
  17   WT_KEYWORD,                           /* Explicitly marked keyword */
  18   WT_META,                              /* Various meta-information */
  19   WT_ALT,                               /* Alternate texts for graphical elements */
  20   WT_URL1,                              /* Word extracted from document URL (low and high weight) */
  21   WT_URL2,
  22   WT_FILE,                              /* Part of file name */
  23   WT_LINK,                              /* Link text */
  24   WT_MAX
  25 };
  26
  27 /* Descriptive names used for user output */
  28 #define WORD_TYPE_USER_NAMES                                                    \
  29    "reserved", "text", "emph", "small", "title", "hdr1", "hdr2", "keywd",       \
  30    "meta", "alt", "urlword1", "urlword2", "nameword", "link", "type14", "type15"
  31
  32 /* Keywords for word type names */
  33 #define WORD_TYPE_NAMES                         \
  34         T(WORD, ~((1 << WT_FILE) | (1 << WT_LINK)))     \
  35         T(TEXT, 1 << WT_TEXT)                   \
  36         T(EMPH, 1 << WT_EMPH)                   \
  37         T(SMALL, 1 << WT_SMALL)                 \
  38         T(TITLE, 1 << WT_TITLE)                 \
  39         T(HDR, (1 << WT_SMALL_HEADING) | (1 << WT_BIG_HEADING))  \
  40         T(HDR1, 1 << WT_SMALL_HEADING)          \
  41         T(HDR2, 1 << WT_BIG_HEADING)            \
  42         T(KEYWD, 1 << WT_KEYWORD)               \
  43         T(META, 1 << WT_META)                   \
  44         T(ALT, 1 << WT_ALT)                     \
  45         T(URLWORD, (1 << WT_URL1) | (1 << WT_URL2))     \
  46         T(FILE, 1 << WT_FILE)                   \
  47         T(LINK, 1 << WT_LINK)
  48
  49 /* These types are not shown in document contexts */
  50 #define WORD_TYPES_HIDDEN ((1 << WT_URL1) | (1 << WT_URL2) | (1 << WT_FILE))
  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) | (1 << WT_FILE) | (1 << WT_LINK))
  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_MAX
  64 };
  65
  66 #define STRING_TYPE_USER_NAMES                                                  \
  67    "URL", "host", "domain", "ref", "type4", "type5", "type6", "type7",  \
  68    "type8", "type9", "type10", "type11", "type12", "type13", "type14", "type15"
  69
  70 #define STRING_TYPE_NAMES                       \
  71         T(URL, 1 << ST_URL)                     \
  72         T(HOST, 1 << ST_HOST)                   \
  73         T(DOMAIN, 1 << ST_DOMAIN)               \
  74         T(REF, 1 << ST_REF)
  75
  76 #define STRING_TYPES_URL ((1 << ST_URL) | (1 << ST_REF))
  77 /* These must be indexed in lowercase form */
  78 #define STRING_TYPES_CASE_INSENSITIVE ((1 << ST_HOST) | (1 << ST_DOMAIN))
  79
  80 /*
  81  *  Definitions of custom attributes:
  82  *
  83  *  First of all, you need to define your own card_attr fields which will
  84  *  contain your attributes: CUSTOM_CARD_ATTRS lists them.
  85  *  Please order the attributes by decreasing size to get optimum padding.
  86  *
  87  *  Then define custom_create_attrs() which will get the object description
  88  *  and set your card_attr fields accordingly.
  89  *
  90  *  Finally, you have to define CUSTOM_ATTRS with matching rules:
  91  *
  92  *  INT_ATTR(id, keyword, get_func, parse_func) -- unsigned integer attribute
  93  *
  94  *  id          C identifier of the attribute
  95  *  keywd       search server keyword for the attribute
  96  *  type get_func(struct card_attr *ca, byte *attr)
  97  *              get attribute value from the card_attr
  98  *  byte *parse_func(u32 *dest, byte *value, uns intval)
  99  *              parse value in query (returns error message or NULL)
 100  *              for KEYWD = "string", it gets value="string", intval=0
 101  *              for KEYWD = num, it gets value=NULL, intval=num.
 102  *
 103  *  SMALL_SET_ATTR(id, keyword, get_func, parse_func)
 104  *    -- integers 0..31 with set matching
 105  *
 106  *  A good place for definitions of the functions is lib/custom.c.
 107  */
 108
 109 struct card_attr;
 110 struct odes;
 111
 112 #ifdef CONFIG_IMAGES
 113
 114 /*
 115  *  We store several image properties to card_attr->image_flags and
 116  *  match them as custom attributes. The image_flags byte contains:
 117  *
 118  *  bits 0--1   image format (0: not an image, 1: JPEG, 2: PNG, 3: GIF)
 119  *  bits 2--3   image size (0: <=100x100, 1: <=320x200, 2: <=640x480, 3: other)
 120  *  bits 4--5   image colors (0: grayscale, 1: <=16, 2: <=256, 3: >256)
 121  */
 122
 123 #define CUSTOM_CARD_ATTRS \
 124         byte image_flags;
 125
 126 #define CUSTOM_ATTRS \
 127         SMALL_SET_ATTR(ifmt, IMGTYPE, custom_it_get, custom_it_parse)           \
 128         SMALL_SET_ATTR(isize, IMGSIZE, custom_is_get, custom_is_parse)          \
 129         SMALL_SET_ATTR(icolors, IMGCOLORS, custom_ic_get, custom_ic_parse)
 130
 131 void custom_create_attrs(struct odes *odes, struct card_attr *ca);
 132
 133 /* These must be macros instead of inline functions, struct card_attr is not fully defined yet */
 134 #define custom_it_get(ca) ((ca)->image_flags & 3)
 135 #define custom_is_get(ca) (((ca)->image_flags >> 2) & 3)
 136 #define custom_ic_get(ca) (((ca)->image_flags >> 4) & 3)
 137
 138 byte *custom_it_parse(u32 *dest, byte *value, uns intval);
 139 byte *custom_is_parse(u32 *dest, byte *value, uns intval);
 140 byte *custom_ic_parse(u32 *dest, byte *value, uns intval);
 141
 142 #else
 143
 144 #if 0
 145
 146 /* FIXME: Add a simple example */
 147
 148 #else
 149
 150 /* No custom attributes defined */
 151
 152 #define CUSTOM_CARD_ATTRS
 153 #define CUSTOM_ATTRS
 154 static inline void custom_create_attrs(struct odes *odes UNUSED, struct card_attr *ca UNUSED) { }
 155
 156 #endif
 157
 158 #endif