3 * fmt_compile.c -- "compile" format strings for fmt_scan
5 * This code is Copyright (c) 2002, by the authors of nmh. See the
6 * COPYRIGHT file in the root directory of the nmh distribution for
7 * complete copyright information.
11 #include <h/addrsbr.h>
13 #include <h/fmt_scan.h>
14 #include <h/fmt_compile.h>
16 #ifdef HAVE_SYS_TIME_H
17 # include <sys/time.h>
22 * hash table for deciding if a component is "interesting"
24 struct comp *wantcomp[128];
26 static struct format *formatvec; /* array to hold formats */
27 static struct format *next_fp; /* next free format slot */
28 static struct format *fp; /* current format slot */
29 static struct comp *cm; /* most recent comp ref */
30 static struct ftable *ftbl; /* most recent func ref */
32 static int infunction; /* function nesting cnt */
34 extern struct mailname fmt_mnull;
36 /* ftable->type (argument type) */
37 #define TF_COMP 0 /* component expected */
38 #define TF_NUM 1 /* number expected */
39 #define TF_STR 2 /* string expected */
40 #define TF_EXPR 3 /* component or func. expected */
41 #define TF_NONE 4 /* no argument */
42 #define TF_MYBOX 5 /* special - get current user's mbox */
43 #define TF_NOW 6 /* special - get current unix time */
44 #define TF_EXPR_SV 7 /* like expr but save current str reg */
45 #define TF_NOP 8 /* like expr but no result */
48 /* NB that TFL_PUTS is also used to decide whether the test
49 * in a "%<(function)..." should be a string or numeric one.
51 #define TFL_PUTS 1 /* implicit putstr if top level */
52 #define TFL_PUTN 2 /* implicit putnum if top level */
55 char *name; /* function name */
56 char type; /* argument type */
57 char f_type; /* fmt type */
58 char extra; /* arg. type dependent extra info */
62 static struct ftable functable[] = {
63 { "nonzero", TF_EXPR, FT_V_NE, FT_IF_V_NE, 0 },
64 { "zero", TF_EXPR, FT_V_EQ, FT_IF_V_EQ, 0 },
65 { "eq", TF_NUM, FT_V_EQ, FT_IF_V_EQ, 0 },
66 { "ne", TF_NUM, FT_V_NE, FT_IF_V_NE, 0 },
67 { "gt", TF_NUM, FT_V_GT, FT_IF_V_GT, 0 },
68 { "null", TF_EXPR, FT_S_NULL, FT_IF_S_NULL, 0 },
69 { "nonnull", TF_EXPR, FT_S_NONNULL, FT_IF_S, 0 },
70 { "match", TF_STR, FT_V_MATCH, FT_IF_MATCH, 0 },
71 { "amatch", TF_STR, FT_V_AMATCH, FT_IF_AMATCH, 0 },
73 { "putstr", TF_EXPR, FT_STR, 0, 0 },
74 { "putstrf", TF_EXPR, FT_STRF, 0, 0 },
75 { "putnum", TF_EXPR, FT_NUM, 0, 0 },
76 { "putnumf", TF_EXPR, FT_NUMF, 0, 0 },
77 { "putaddr", TF_STR, FT_PUTADDR, 0, 0 },
78 { "void", TF_NOP, 0, 0, 0 },
80 { "comp", TF_COMP, FT_LS_COMP, 0, TFL_PUTS },
81 { "lit", TF_STR, FT_LS_LIT, 0, TFL_PUTS },
82 { "getenv", TF_STR, FT_LS_GETENV, 0, TFL_PUTS },
83 { "profile", TF_STR, FT_LS_CFIND, 0, TFL_PUTS },
84 { "decodecomp", TF_COMP, FT_LS_DECODECOMP, 0, TFL_PUTS },
85 { "decode", TF_EXPR, FT_LS_DECODE, 0, TFL_PUTS },
86 { "trim", TF_EXPR, FT_LS_TRIM, 0, 0 },
87 { "compval", TF_COMP, FT_LV_COMP, 0, TFL_PUTN },
88 { "compflag", TF_COMP, FT_LV_COMPFLAG, 0, TFL_PUTN },
89 { "num", TF_NUM, FT_LV_LIT, 0, TFL_PUTN },
90 { "msg", TF_NONE, FT_LV_DAT, 0, TFL_PUTN },
91 { "cur", TF_NONE, FT_LV_DAT, 1, TFL_PUTN },
92 { "size", TF_NONE, FT_LV_DAT, 2, TFL_PUTN },
93 { "width", TF_NONE, FT_LV_DAT, 3, TFL_PUTN },
94 { "unseen", TF_NONE, FT_LV_DAT, 4, TFL_PUTN },
95 { "dat", TF_NUM, FT_LV_DAT, 0, TFL_PUTN },
96 { "strlen", TF_NONE, FT_LV_STRLEN, 0, TFL_PUTN },
97 { "me", TF_MYBOX, FT_LS_LIT, 0, TFL_PUTS },
98 { "plus", TF_NUM, FT_LV_PLUS_L, 0, TFL_PUTN },
99 { "minus", TF_NUM, FT_LV_MINUS_L, 0, TFL_PUTN },
100 { "divide", TF_NUM, FT_LV_DIVIDE_L, 0, TFL_PUTN },
101 { "modulo", TF_NUM, FT_LV_MODULO_L, 0, TFL_PUTN },
102 { "charleft", TF_NONE, FT_LV_CHAR_LEFT, 0, TFL_PUTN },
103 { "timenow", TF_NOW, FT_LV_LIT, 0, TFL_PUTN },
105 { "month", TF_COMP, FT_LS_MONTH, FT_PARSEDATE, TFL_PUTS },
106 { "lmonth", TF_COMP, FT_LS_LMONTH, FT_PARSEDATE, TFL_PUTS },
107 { "tzone", TF_COMP, FT_LS_ZONE, FT_PARSEDATE, TFL_PUTS },
108 { "day", TF_COMP, FT_LS_DAY, FT_PARSEDATE, TFL_PUTS },
109 { "weekday", TF_COMP, FT_LS_WEEKDAY, FT_PARSEDATE, TFL_PUTS },
110 { "tws", TF_COMP, FT_LS_822DATE, FT_PARSEDATE, TFL_PUTS },
111 { "sec", TF_COMP, FT_LV_SEC, FT_PARSEDATE, TFL_PUTN },
112 { "min", TF_COMP, FT_LV_MIN, FT_PARSEDATE, TFL_PUTN },
113 { "hour", TF_COMP, FT_LV_HOUR, FT_PARSEDATE, TFL_PUTN },
114 { "mday", TF_COMP, FT_LV_MDAY, FT_PARSEDATE, TFL_PUTN },
115 { "mon", TF_COMP, FT_LV_MON, FT_PARSEDATE, TFL_PUTN },
116 { "year", TF_COMP, FT_LV_YEAR, FT_PARSEDATE, TFL_PUTN },
117 { "yday", TF_COMP, FT_LV_YDAY, FT_PARSEDATE, TFL_PUTN },
118 { "wday", TF_COMP, FT_LV_WDAY, FT_PARSEDATE, TFL_PUTN },
119 { "zone", TF_COMP, FT_LV_ZONE, FT_PARSEDATE, TFL_PUTN },
120 { "clock", TF_COMP, FT_LV_CLOCK, FT_PARSEDATE, TFL_PUTN },
121 { "rclock", TF_COMP, FT_LV_RCLOCK, FT_PARSEDATE, TFL_PUTN },
122 { "sday", TF_COMP, FT_LV_DAYF, FT_PARSEDATE, TFL_PUTN },
123 { "szone", TF_COMP, FT_LV_ZONEF, FT_PARSEDATE, TFL_PUTN },
124 { "dst", TF_COMP, FT_LV_DST, FT_PARSEDATE, TFL_PUTN },
125 { "pretty", TF_COMP, FT_LS_PRETTY, FT_PARSEDATE, TFL_PUTS },
126 { "nodate", TF_COMP, FT_LV_COMPFLAG, FT_PARSEDATE, TFL_PUTN },
127 { "date2local", TF_COMP, FT_LOCALDATE, FT_PARSEDATE, 0 },
128 { "date2gmt", TF_COMP, FT_GMTDATE, FT_PARSEDATE, 0 },
130 { "pers", TF_COMP, FT_LS_PERS, FT_PARSEADDR, TFL_PUTS },
131 { "mbox", TF_COMP, FT_LS_MBOX, FT_PARSEADDR, TFL_PUTS },
132 { "host", TF_COMP, FT_LS_HOST, FT_PARSEADDR, TFL_PUTS },
133 { "path", TF_COMP, FT_LS_PATH, FT_PARSEADDR, TFL_PUTS },
134 { "gname", TF_COMP, FT_LS_GNAME, FT_PARSEADDR, TFL_PUTS },
135 { "note", TF_COMP, FT_LS_NOTE, FT_PARSEADDR, TFL_PUTS },
136 { "addr", TF_COMP, FT_LS_ADDR, FT_PARSEADDR, TFL_PUTS },
137 { "proper", TF_COMP, FT_LS_822ADDR, FT_PARSEADDR, TFL_PUTS },
138 { "type", TF_COMP, FT_LV_HOSTTYPE, FT_PARSEADDR, TFL_PUTN },
139 { "ingrp", TF_COMP, FT_LV_INGRPF, FT_PARSEADDR, TFL_PUTN },
140 { "nohost", TF_COMP, FT_LV_NOHOSTF, FT_PARSEADDR, TFL_PUTN },
141 { "formataddr", TF_EXPR_SV,FT_FORMATADDR, FT_FORMATADDR, 0 },
142 { "friendly", TF_COMP, FT_LS_FRIENDLY, FT_PARSEADDR, TFL_PUTS },
144 { "mymbox", TF_COMP, FT_LV_COMPFLAG, FT_MYMBOX, TFL_PUTN },
145 { "addtoseq", TF_STR, FT_ADDTOSEQ, 0, 0 },
147 { "unquote", TF_EXPR, FT_LS_UNQUOTE, 0, TFL_PUTS},
152 /* Add new component to the hash table */
153 #define NEWCOMP(cm,name) do { \
154 cm = ((struct comp *) calloc(1, sizeof (struct comp)));\
158 cm->c_next = wantcomp[i];\
162 #define NEWFMT (next_fp++)
163 #define NEW(type,fill,wid) do {\
164 fp=NEWFMT; fp->f_type=(type); fp->f_fill=(fill); fp->f_width=(wid); \
167 /* Add (possibly new) component to the hash table */
168 #define ADDC(name) do { \
176 #define LV(type, value) do { NEW(type,0,0); fp->f_value = (value); } while (0)
177 #define LS(type, str) do { NEW(type,0,0); fp->f_text = (str); } while (0)
179 #define PUTCOMP(comp) do { NEW(FT_COMP,0,0); ADDC(comp); } while (0)
180 #define PUTLIT(str) do { NEW(FT_LIT,0,0); fp->f_text = (str); } while (0)
181 #define PUTC(c) do { NEW(FT_CHAR,0,0); fp->f_char = (c); } while (0)
183 static char *format_string;
184 static unsigned char *usr_fstring; /* for CERROR */
186 #define CERROR(str) compile_error (str, cp)
189 * external prototypes
191 extern char *getusername(void);
196 static struct ftable *lookup(char *);
197 static void compile_error(char *, char *);
198 static char *compile (char *);
199 static char *do_spec(char *);
200 static char *do_name(char *, int);
201 static char *do_func(char *);
202 static char *do_expr (char *, int);
203 static char *do_loop(char *);
204 static char *do_if(char *);
207 static struct ftable *
210 register struct ftable *t = functable;
212 register char c = *name;
214 while ((nm = t->name)) {
215 if (*nm == c && strcmp (nm, name) == 0)
220 return (struct ftable *) 0;
225 compile_error(char *str, char *cp)
227 int i, errpos, errctx;
229 errpos = cp - format_string;
230 errctx = errpos > 20 ? 20 : errpos;
231 usr_fstring[errpos] = '\0';
233 for (i = errpos-errctx; i < errpos; i++) {
235 if (iscntrl(usr_fstring[i]))
237 if (usr_fstring[i] < 32)
239 usr_fstring[i] = '_';
242 advise(NULL, "\"%s\": format compile error - %s",
243 &usr_fstring[errpos-errctx], str);
244 adios (NULL, "%*s", errctx+1, "^");
248 * Compile format string "fstring" into format list "fmt".
249 * Return the number of header components found in the format
254 fmt_compile(char *fstring, struct format **fmt)
260 free (format_string);
261 format_string = getcpy (fstring);
262 usr_fstring = fstring;
264 /* init the component hash table. */
265 for (i = 0; i < sizeof(wantcomp)/sizeof(wantcomp[0]); i++)
268 memset((char *) &fmt_mnull, 0, sizeof(fmt_mnull));
270 /* it takes at least 4 char to generate one format so we
271 * allocate a worst-case format array using 1/4 the length
272 * of the format string. We actually need twice this much
273 * to handle both pre-processing (e.g., address parsing) and
276 i = strlen(fstring)/2 + 1;
278 next_fp = formatvec = (struct format *)calloc ((size_t) i,
279 sizeof(struct format));
281 adios (NULL, "unable to allocate format storage");
286 cp = compile(format_string);
288 CERROR("extra '%>', '%|' or '%?'");
290 LV(FT_DONE, 0); /* really done */
299 register char *cp = sp;
304 while ((c = *cp) && c != '%')
340 case ';': /* comment line */
342 while ((c = *cp++) && c != '\n')
357 register char *cp = sp;
360 register int ljust = 0;
361 #endif /* not lint */
362 register int wid = 0;
363 register char fill = ' ';
375 wid = wid*10 + (c - '0');
381 fp->f_type = wid? FT_COMPF : FT_COMP;
386 if (ftbl->flags & TFL_PUTS) {
387 LV( wid? FT_STRF : FT_STR, ftbl->extra);
389 else if (ftbl->flags & TFL_PUTN) {
390 LV( wid? FT_NUMF : FT_NUM, ftbl->extra);
395 CERROR("component or function name expected");
406 do_name(char *sp, int preprocess)
408 register char *cp = sp;
411 static int primed = 0;
413 while (isalnum(c = *cp++) || c == '-' || c == '_')
416 CERROR("'}' expected");
420 switch (preprocess) {
423 if (cm->c_type & CT_ADDR) {
424 CERROR("component used as both date and address");
426 cm->c_tws = (struct tws *)
427 calloc((size_t) 1, sizeof(*cm->c_tws));
428 fp->f_type = preprocess;
430 cm->c_type |= CT_DATE;
435 ismymbox ((struct mailname *) 0);
440 if (cm->c_type & CT_DATE) {
441 CERROR("component used as both date and address");
443 cm->c_mn = &fmt_mnull;
444 fp->f_type = preprocess;
446 cm->c_type |= CT_ADDR;
450 if (cm->c_type & CT_DATE) {
451 CERROR("component used as both date and address");
453 cm->c_type |= CT_ADDR;
462 register char *cp = sp;
464 register struct ftable *t;
466 int mflag; /* minus sign in NUM */
470 while (isalnum(c = *cp++))
472 if (c != '(' && c != '{' && c != ' ' && c != ')') {
473 CERROR("'(', '{', ' ' or ')' expected");
476 if ((t = lookup (sp)) == 0) {
477 CERROR("unknown function");
486 CERROR("component name expected");
488 cp = do_name(cp, t->extra);
489 fp->f_type = t->f_type;
494 if ((mflag = (c == '-')))
498 n = n*10 + (c - '0');
508 while (c && c != ')')
515 LV(t->f_type,t->extra);
519 LS(t->f_type, getusername());
523 LV(t->f_type, time((time_t *) 0));
531 cp = do_expr(cp, t->extra);
539 cp = do_expr(cp, t->extra);
545 CERROR("')' expected");
552 do_expr (char *sp, int preprocess)
554 register char *cp = sp;
557 if ((c = *cp++) == '{') {
558 cp = do_name (cp, preprocess);
559 fp->f_type = FT_LS_COMP;
560 } else if (c == '(') {
562 } else if (c == ')') {
564 } else if (c == '%' && *cp == '<') {
567 CERROR ("'(', '{', '%<' or ')' expected");
575 register char *cp = sp;
576 struct format *floop;
581 CERROR ("']' expected");
583 LV(FT_DONE, 1); /* not yet done */
585 fp->f_skip = floop - fp; /* skip backwards */
593 register char *cp = sp;
594 register struct format *fexpr,
595 *fif = (struct format *)NULL;
596 register int c = '<';
599 if (c == '<') { /* doing an IF */
600 if ((c = *cp++) == '{') /*}*/{
602 fp->f_type = FT_LS_COMP;
607 /* see if we can merge the load and the "if" */
608 if (ftbl->f_type >= IF_FUNCS)
609 fp->f_type = ftbl->extra;
611 /* Put out a string test or a value test depending
612 * on what this function's return type is.
614 if (ftbl->flags & TFL_PUTS) {
622 CERROR("'(' or '{' expected"); /*}*/
626 fexpr = fp; /* loc of [ELS]IF */
627 cp = compile (cp); /* compile IF TRUE stmts */
629 fif->f_skip = next_fp - fif;
631 if ((c = *cp++) == '|') { /* the last ELSE */
633 fif = fp; /* loc of GOTO */
634 fexpr->f_skip = next_fp - fexpr;
636 fexpr = (struct format *)NULL;/* no extra ENDIF */
638 cp = compile (cp); /* compile ELSE stmts */
639 fif->f_skip = next_fp - fif;
642 else if (c == '?') { /* another ELSIF */
644 fif = fp; /* loc of GOTO */
645 fexpr->f_skip = next_fp - fexpr;
647 c = '<'; /* impersonate an IF */
654 CERROR("'>' expected.");
657 if (fexpr) /* IF ... [ELSIF ...] ENDIF */
658 fexpr->f_skip = next_fp - fexpr;