git.marmaro.de Git - mmh/blob - h/fmt_scan.h

   1
   2 /*
   3  * fmt_scan.h -- definitions for fmt_scan()
   4  *
   5  * $Id$
   6  */
   7
   8 /*
   9  * This structure describes an "interesting" component.  It holds
  10  * the name & text from the component (if found) and one piece of
  11  * auxilary info.  The structure for a particular component is located
  12  * by (open) hashing the name and using it as an index into the ptr array
  13  * "wantcomp".  All format entries that reference a particular component
  14  * point to its comp struct (so we only have to do component specific
  15  * processing once.  e.g., parse an address.).
  16  */
  17 struct comp {
  18     char        *c_name;        /* component name (in lower case) */
  19     char        *c_text;        /* component text (if found)      */
  20     struct comp *c_next;        /* hash chain linkage             */
  21     short        c_flags;       /* misc. flags (from fmt_scan)    */
  22     short        c_type;        /* type info   (from fmt_compile) */
  23     union {
  24         struct tws *c_u_tws;
  25         struct mailname *c_u_mn;
  26     } c_un;
  27 };
  28
  29 #define c_tws c_un.c_u_tws
  30 #define c_mn  c_un.c_u_mn
  31
  32 /*
  33  * c_type bits
  34  */
  35 #define CT_ADDR       (1<<0)    /* referenced as address    */
  36 #define CT_DATE       (1<<1)    /* referenced as date       */
  37
  38 /*
  39  * c_flags bits
  40  */
  41 #define CF_TRUE       (1<<0)    /* usually means component is present */
  42 #define CF_PARSED     (1<<1)    /* address/date has been parsed */
  43 #define CF_DATEFAB    (1<<2)    /* datefield fabricated */
  44
  45 extern int fmt_norm;
  46
  47 /*
  48  * Hash table for deciding if a component is "interesting".
  49  */
  50 extern struct comp *wantcomp[128];
  51
  52 /*
  53  * Hash function for component name.  The function should be
  54  * case independent and probably shouldn't involve a routine
  55  * call.  This function is pretty good but will not work on
  56  * single character component names.
  57  */
  58 #define CHASH(nm) (((((nm)[0]) - ((nm)[1])) & 0x1f) + (((nm)[2]) & 0x5f))
  59
  60 /*
  61  * Find a component in the hash table.
  62  */
  63 #define FINDCOMP(comp,name) \
  64                 for (comp = wantcomp[CHASH(name)]; \
  65                      comp && strcmp(comp->c_name,name); \
  66                      comp = comp->c_next) ;
  67
  68 /*
  69  * This structure defines one formatting instruction.
  70  */
  71 struct format {
  72     unsigned char f_type;
  73     char          f_fill;
  74     short         f_width;      /* output field width   */
  75     union {
  76         struct comp *f_u_comp;  /* associated component */
  77         char        *f_u_text;  /* literal text         */
  78         char         f_u_char;  /* literal character    */
  79         int          f_u_value; /* literal value        */
  80     } f_un;
  81 };
  82
  83 #define f_skip f_width          /* instr to skip (false "if") */
  84
  85 #define f_comp  f_un.f_u_comp
  86 #define f_text  f_un.f_u_text
  87 #define f_char  f_un.f_u_char
  88 #define f_value f_un.f_u_value
  89
  90 /*
  91  * prototypes
  92  */
  93 struct format *fmt_scan (struct format *, char *, int, int *);
  94 char *new_fs (char *, char *, char *);
  95 int fmt_compile (char *, struct format **);