diplodocus.org Git - nmh/blob - h/fmt_scan.h

   1
   2 /*
   3  * fmt_scan.h -- definitions for fmt_scan()
   4  */
   5
   6 /*
   7  * This structure describes an "interesting" component.  It holds
   8  * the name & text from the component (if found) and one piece of
   9  * auxilary info.  The structure for a particular component is located
  10  * by (open) hashing the name and using it as an index into the ptr array
  11  * "wantcomp".  All format entries that reference a particular component
  12  * point to its comp struct (so we only have to do component specific
  13  * processing once.  e.g., parse an address.).
  14  *
  15  * In previous implementations "wantcomp" was made available to other
  16  * functions, but now it's private and is accessed via functions.
  17  */
  18 struct comp {
  19     char        *c_name;        /* component name (in lower case) */
  20     char        *c_text;        /* component text (if found)      */
  21     struct comp *c_next;        /* hash chain linkage             */
  22     short        c_flags;       /* misc. flags (from fmt_scan)    */
  23     short        c_type;        /* type info   (from fmt_compile) */
  24     union {
  25         struct tws *c_u_tws;
  26         struct mailname *c_u_mn;
  27     } c_un;
  28     int          c_refcount;    /* Reference count                */
  29 };
  30
  31 #define c_tws c_un.c_u_tws
  32 #define c_mn  c_un.c_u_mn
  33
  34 /*
  35  * c_type bits
  36  */
  37 #define CT_ADDR       (1<<0)    /* referenced as address    */
  38 #define CT_DATE       (1<<1)    /* referenced as date       */
  39
  40 /*
  41  * c_flags bits
  42  */
  43 #define CF_TRUE       (1<<0)    /* usually means component is present */
  44 #define CF_PARSED     (1<<1)    /* address/date has been parsed */
  45 #define CF_DATEFAB    (1<<2)    /* datefield fabricated */
  46 #define CF_TRIMMED    (1<<3)    /* Component has been trimmed */
  47
  48 extern int fmt_norm;
  49
  50 /*
  51  * This structure defines one formatting instruction.
  52  */
  53 struct format {
  54     unsigned char f_type;
  55     char          f_fill;
  56     short         f_width;      /* output field width   */
  57     union {
  58         struct comp *f_u_comp;  /* associated component */
  59         char        *f_u_text;  /* literal text         */
  60         char         f_u_char;  /* literal character    */
  61         int          f_u_value; /* literal value        */
  62     } f_un;
  63     short         f_flags;      /* misc. flags          */
  64 };
  65
  66 #define f_skip f_width          /* instr to skip (false "if") */
  67
  68 #define f_comp  f_un.f_u_comp
  69 #define f_text  f_un.f_u_text
  70 #define f_char  f_un.f_u_char
  71 #define f_value f_un.f_u_value
  72
  73 /*
  74  * f_flags bits
  75  */
  76
  77 #define FF_STRALLOC     (1<<0)  /* String has been allocated */
  78 #define FF_COMPREF      (1<<1)  /* Component reference */
  79
  80 /*
  81  * prototypes used by the format engine
  82  */
  83
  84 /*
  85  * These are the definitions used by the callbacks for fmt_scan()
  86  */
  87
  88 typedef char * (*formataddr_cb)(char *, char *);
  89 typedef char * (*concataddr_cb)(char *, char *);
  90 typedef void (*trace_cb)(void *, struct format *, int, char *, char *);
  91
  92 struct fmt_callbacks {
  93     formataddr_cb       formataddr;
  94     concataddr_cb       concataddr;
  95     trace_cb            trace_func;
  96     void *              trace_context;
  97 };
  98
  99 /*
 100  * Create a new format string.  Arguments are:
 101  *
 102  * form         - Name of format file.  Will be searched by etcpath(), see that
 103  *                function for details.
 104  * format       - The format string to be used if no format file is given
 105  * default_fs   - The default format string to be used if neither form nor
 106  *                format is given
 107  *
 108  * This function also takes care of processing \ escapes like \n, \t, etc.
 109  *
 110  * Returns an allocated format string.
 111  */
 112
 113 char *new_fs (char *form, char *format, char *default_fs);
 114
 115 /*
 116  * Compile a format string into a set of format instructions.  Arguments are:
 117  *
 118  * fstring      - The format string (the "source code").
 119  * fmt          - Returns an allocated array of "struct fmt" elements.  Each
 120  *                struct fmt is one format instruction interpreted by the
 121  *                format engine.
 122  * reset        - If set to true, the format compiler will reset the
 123  *                component hash table.  The component hash table contains
 124  *                all of the references to message components refered to in
 125  *                the format instructions.  If you have multiple format
 126  *                strings that you want to compile and operate on the
 127  *                same message, this should be set to false.
 128  *
 129  * Returns the total number of components referenced by all format instructions
 130  * since the last reset of the hash table.
 131  */
 132
 133 int fmt_compile (char *fstring, struct format **fmt, int reset);
 134
 135 /*
 136  * Interpret a sequence of compiled format instructions.  Arguments are:
 137  *
 138  * format       - Array of format instructions generated by fmt_compile()
 139  * scanl        - Passed-in character array that will contain the output
 140  *                of the format instructions.  Is always terminated with
 141  *                a newline (\n).
 142  * max          - Maximum number of bytes to be written to "scanl" (in other
 143  *                words, the buffer size).  Includes the trailing NUL.
 144  * width        - Maximum number of displayed characters.  Does not include
 145  *                characters marked as nonprinting or (depending on the
 146  *                encoding) bytes in a multibyte encoding that exceed the
 147  *                character's column width.
 148  * dat          - An integer array that contains data used by certain format
 149  *                functions.  Currently the following instructions use
 150  *                dat[]:
 151  *
 152  *              dat[0] - %(msg), %(dat)
 153  *              dat[1] - %(cur)
 154  *              dat[2] - %(size)
 155  *              dat[3] - %(width)
 156  *              dat[4] - %(unseen)
 157  *
 158  * callbacks    - A set of a callback functions used by the format engine.
 159  *                Can be NULL.  If structure elements are NULL, a default
 160  *                function will be used.  Callback structure elements are:
 161  *
 162  *              formataddr      - A callback for the %(formataddr) instruction
 163  *              concataddr      - A callback for the %(concataddr) instruction
 164  *              trace           - Called for every format instruction executed
 165  *
 166  * The return value is a pointer to the next format instruction to
 167  * execute, which is currently always NULL.
 168  */
 169
 170 struct format *fmt_scan (struct format *format, char *scanl, size_t max,
 171                          int width, int *dat, struct fmt_callbacks *callbacks);
 172
 173 /*
 174  * Free a format structure and/or component hash table.  Arguments are:
 175  *
 176  * format       - An array of format structures allocated by fmt_compile,
 177  *                or NULL.
 178  * reset        - If true, reset and remove all references in the component
 179  *                hash table.
 180  */
 181
 182 void fmt_free (struct format *fmt, int reset);
 183
 184 /*
 185  * Free all of the component text structures in the component hash table
 186  */
 187
 188 void fmt_freecomptext(void);
 189
 190 /*
 191  * Search for a component structure in the component hash table.  Arguments are:
 192  *
 193  * component    - The name of the component to search for.  By convention
 194  *                all component names used in format strings are lower case,
 195  *                but for backwards compatibility this search is done in
 196  *                a case-SENSITIVE manner.
 197  *
 198  * This function returns a "struct comp" corresponding to the named component,
 199  * or NULL if the component is not found in the hash table.
 200  */
 201
 202 struct comp *fmt_findcomp(char *component);
 203
 204 /*
 205  * Search for a component structure in the component hash table.
 206  *
 207  * Identical to fmd_findcomp(), but is case-INSENSITIVE.
 208  */
 209
 210 struct comp *fmt_findcasecomp(char *component);
 211
 212 /*
 213  * Add a component entry to the component hash table
 214  *
 215  * component    - The name of the component to add to the hash table.
 216  *
 217  * If the component is already in the hash table, this function will do
 218  * nothing.  Returns 1 if a component was added, 0 if it already existed.
 219  */
 220
 221 int fmt_addcompentry(char *component);
 222
 223 /*
 224  * Add a string to a component hash table entry.  Arguments are:
 225  *
 226  * component    - The name of the component to add text to.  The component
 227  *                is searched for in a case-INSENSITIVE manner (note that
 228  *                this is different than fmt_findcomp()).  If the component
 229  *                is not found in the hash table, this function will silently
 230  *                return.
 231  * text         - The text to add to a component hash table entry.  Note that
 232  *                if the last character of the existing component
 233  *                text is a newline AND it is marked as an address
 234  *                component (the the CT_ADDR flag is set) existing
 235  *                component buffer is a newline, it will be separated
 236  *                from previous text by ",\n\t"; otherwise if the last
 237  *                character of the previous text is a newline it will
 238  *                simply be seperated by a "\t".  This unusual processing
 239  *                is designed to handle the case where you have multiple
 240  *                headers with the same name (e.g.: multiple "cc:" headers,
 241  *                even though that isn't technically allowed in the RFCs).
 242  *
 243  * This function is designed to be called when you start processing a new
 244  * component.  The function returns the integer value of the hash table
 245  * bucket corresponding to this component.  If there was no entry found
 246  * in the component hash table, this function will return -1.
 247  */
 248
 249 int fmt_addcomptext(char *component, char *text);
 250
 251 /*
 252  * Append to an existing component.  Arguments are:
 253  *
 254  * bucket       - The hash table bucket corresponding to this component,
 255  *                as returned by fmt_addcomp().  If -1, this function will
 256  *                return with no actions performed.
 257  * component    - The component to append text to.  Like fmt_addcomp, the
 258  *                component is searched case-INSENSITIVELY.
 259  * text         - The text to append to the component.  No special processing
 260  *                is done.
 261  *
 262  * This function is designed to be called when you are processing continuation
 263  * lines on the same header (state == FLDPLUS).
 264  */
 265
 266 void fmt_appendcomp(int bucket, char *component, char *text);
 267
 268 /*
 269  * The implementation of the %(formataddr) function.  This is available for
 270  * programs to provide their own local implementation if they wish to do
 271  * special processing (see uip/replsbr.c for an example).  Arguments are:
 272  *
 273  * orig         - Existing list of addresses
 274  * str          - New address(es) to append to list.
 275  *
 276  * This function returns an allocated string containing the new list of
 277  * addresses.
 278  */
 279
 280 char *formataddr(char *orig, char *str);
 281
 282 /*
 283  * The implementation of the %(concataddr) function.  Arguments and behavior
 284  * are the same as %(formataddr).  Again, see uip/replsbr.c to see how you
 285  * can override this behavior.
 286  */
 287
 288 char *concataddr(char *orig, char *str);