2 ** fmt_compile.c -- "compile" format strings for fmt_scan
4 ** This code is Copyright (c) 2002, by the authors of nmh. See the
5 ** COPYRIGHT file in the root directory of the nmh distribution for
6 ** complete copyright information.
10 #include <h/addrsbr.h>
12 #include <h/fmt_scan.h>
13 #include <h/fmt_compile.h>
15 #ifdef TIME_WITH_SYS_TIME
16 # include <sys/time.h>
19 # ifdef TM_IN_SYS_TIME
20 # include <sys/time.h>
27 ** hash table for deciding if a component is "interesting"
29 struct comp *wantcomp[128];
31 static struct format *formatvec; /* array to hold formats */
32 static struct format *next_fp; /* next free format slot */
33 static struct format *fp; /* current format slot */
34 static struct comp *cm; /* most recent comp ref */
35 static struct ftable *ftbl; /* most recent func ref */
37 static int infunction; /* function nesting cnt */
39 extern struct mailname fmt_mnull;
41 /* ftable->type (argument type) */
42 #define TF_COMP 0 /* component expected */
43 #define TF_NUM 1 /* number expected */
44 #define TF_STR 2 /* string expected */
45 #define TF_EXPR 3 /* component or func. expected */
46 #define TF_NONE 4 /* no argument */
47 #define TF_MYBOX 5 /* special - get current user's mbox */
48 #define TF_NOW 6 /* special - get current unix time */
49 #define TF_EXPR_SV 7 /* like expr but save current str reg */
50 #define TF_NOP 8 /* like expr but no result */
54 ** NB that TFL_PUTS is also used to decide whether the test
55 ** in a "%<(function)..." should be a string or numeric one.
57 #define TFL_PUTS 1 /* implicit putstr if top level */
58 #define TFL_PUTN 2 /* implicit putnum if top level */
61 char *name; /* function name */
62 char type; /* argument type */
63 char f_type; /* fmt type */
64 char extra; /* arg. type dependent extra info */
68 static struct ftable functable[] = {
69 { "nonzero", TF_EXPR, FT_V_NE, FT_IF_V_NE, 0 },
70 { "zero", TF_EXPR, FT_V_EQ, FT_IF_V_EQ, 0 },
71 { "eq", TF_NUM, FT_V_EQ, FT_IF_V_EQ, 0 },
72 { "ne", TF_NUM, FT_V_NE, FT_IF_V_NE, 0 },
73 { "gt", TF_NUM, FT_V_GT, FT_IF_V_GT, 0 },
74 { "null", TF_EXPR, FT_S_NULL, FT_IF_S_NULL, 0 },
75 { "nonnull", TF_EXPR, FT_S_NONNULL, FT_IF_S, 0 },
76 { "match", TF_STR, FT_V_MATCH, FT_IF_MATCH, 0 },
77 { "amatch", TF_STR, FT_V_AMATCH, FT_IF_AMATCH, 0 },
79 { "putstr", TF_EXPR, FT_STR, 0, 0 },
80 { "putstrf", TF_EXPR, FT_STRF, 0, 0 },
81 { "putnum", TF_EXPR, FT_NUM, 0, 0 },
82 { "putnumf", TF_EXPR, FT_NUMF, 0, 0 },
83 { "putaddr", TF_STR, FT_PUTADDR, 0, 0 },
84 { "void", TF_NOP, 0, 0, 0 },
86 { "comp", TF_COMP, FT_LS_COMP, 0, TFL_PUTS },
87 { "lit", TF_STR, FT_LS_LIT, 0, TFL_PUTS },
88 { "getenv", TF_STR, FT_LS_GETENV, 0, TFL_PUTS },
89 { "profile", TF_STR, FT_LS_CFIND, 0, TFL_PUTS },
90 { "decodecomp", TF_COMP, FT_LS_DECODECOMP, 0, TFL_PUTS },
91 { "decode", TF_EXPR, FT_LS_DECODE, 0, TFL_PUTS },
92 { "trim", TF_EXPR, FT_LS_TRIM, 0, 0 },
93 { "compval", TF_COMP, FT_LV_COMP, 0, TFL_PUTN },
94 { "compflag", TF_COMP, FT_LV_COMPFLAG, 0, TFL_PUTN },
95 { "num", TF_NUM, FT_LV_LIT, 0, TFL_PUTN },
96 { "msg", TF_NONE, FT_LV_DAT, 0, TFL_PUTN },
97 { "cur", TF_NONE, FT_LV_DAT, 1, TFL_PUTN },
98 { "size", TF_NONE, FT_LV_DAT, 2, TFL_PUTN },
99 { "width", TF_NONE, FT_LV_DAT, 3, TFL_PUTN },
100 { "unseen", TF_NONE, FT_LV_DAT, 4, TFL_PUTN },
101 { "dat", TF_NUM, FT_LV_DAT, 0, TFL_PUTN },
102 { "strlen", TF_NONE, FT_LV_STRLEN, 0, TFL_PUTN },
103 { "me", TF_MYBOX, FT_LS_LIT, 0, TFL_PUTS },
104 { "plus", TF_NUM, FT_LV_PLUS_L, 0, TFL_PUTN },
105 { "minus", TF_NUM, FT_LV_MINUS_L, 0, TFL_PUTN },
106 { "divide", TF_NUM, FT_LV_DIVIDE_L, 0, TFL_PUTN },
107 { "modulo", TF_NUM, FT_LV_MODULO_L, 0, TFL_PUTN },
108 { "charleft", TF_NONE, FT_LV_CHAR_LEFT, 0, TFL_PUTN },
109 { "timenow", TF_NOW, FT_LV_LIT, 0, TFL_PUTN },
111 { "month", TF_COMP, FT_LS_MONTH, FT_PARSEDATE, TFL_PUTS },
112 { "lmonth", TF_COMP, FT_LS_LMONTH, FT_PARSEDATE, TFL_PUTS },
113 { "tzone", TF_COMP, FT_LS_ZONE, FT_PARSEDATE, TFL_PUTS },
114 { "day", TF_COMP, FT_LS_DAY, FT_PARSEDATE, TFL_PUTS },
115 { "weekday", TF_COMP, FT_LS_WEEKDAY, FT_PARSEDATE, TFL_PUTS },
116 { "tws", TF_COMP, FT_LS_822DATE, FT_PARSEDATE, TFL_PUTS },
117 { "sec", TF_COMP, FT_LV_SEC, FT_PARSEDATE, TFL_PUTN },
118 { "min", TF_COMP, FT_LV_MIN, FT_PARSEDATE, TFL_PUTN },
119 { "hour", TF_COMP, FT_LV_HOUR, FT_PARSEDATE, TFL_PUTN },
120 { "mday", TF_COMP, FT_LV_MDAY, FT_PARSEDATE, TFL_PUTN },
121 { "mon", TF_COMP, FT_LV_MON, FT_PARSEDATE, TFL_PUTN },
122 { "year", TF_COMP, FT_LV_YEAR, FT_PARSEDATE, TFL_PUTN },
123 { "yday", TF_COMP, FT_LV_YDAY, FT_PARSEDATE, TFL_PUTN },
124 { "wday", TF_COMP, FT_LV_WDAY, FT_PARSEDATE, TFL_PUTN },
125 { "zone", TF_COMP, FT_LV_ZONE, FT_PARSEDATE, TFL_PUTN },
126 { "clock", TF_COMP, FT_LV_CLOCK, FT_PARSEDATE, TFL_PUTN },
127 { "rclock", TF_COMP, FT_LV_RCLOCK, FT_PARSEDATE, TFL_PUTN },
128 { "sday", TF_COMP, FT_LV_DAYF, FT_PARSEDATE, TFL_PUTN },
129 { "szone", TF_COMP, FT_LV_ZONEF, FT_PARSEDATE, TFL_PUTN },
130 { "dst", TF_COMP, FT_LV_DST, FT_PARSEDATE, TFL_PUTN },
131 { "pretty", TF_COMP, FT_LS_PRETTY, FT_PARSEDATE, TFL_PUTS },
132 { "nodate", TF_COMP, FT_LV_COMPFLAG, FT_PARSEDATE, TFL_PUTN },
133 { "date2local", TF_COMP, FT_LOCALDATE, FT_PARSEDATE, 0 },
134 { "date2gmt", TF_COMP, FT_GMTDATE, FT_PARSEDATE, 0 },
136 { "pers", TF_COMP, FT_LS_PERS, FT_PARSEADDR, TFL_PUTS },
137 { "mbox", TF_COMP, FT_LS_MBOX, FT_PARSEADDR, TFL_PUTS },
138 { "host", TF_COMP, FT_LS_HOST, FT_PARSEADDR, TFL_PUTS },
139 { "path", TF_COMP, FT_LS_PATH, FT_PARSEADDR, TFL_PUTS },
140 { "gname", TF_COMP, FT_LS_GNAME, FT_PARSEADDR, TFL_PUTS },
141 { "note", TF_COMP, FT_LS_NOTE, FT_PARSEADDR, TFL_PUTS },
142 { "addr", TF_COMP, FT_LS_ADDR, FT_PARSEADDR, TFL_PUTS },
143 { "proper", TF_COMP, FT_LS_822ADDR, FT_PARSEADDR, TFL_PUTS },
144 { "type", TF_COMP, FT_LV_HOSTTYPE, FT_PARSEADDR, TFL_PUTN },
145 { "ingrp", TF_COMP, FT_LV_INGRPF, FT_PARSEADDR, TFL_PUTN },
146 { "nohost", TF_COMP, FT_LV_NOHOSTF, FT_PARSEADDR, TFL_PUTN },
147 { "formataddr", TF_EXPR_SV, FT_FORMATADDR, FT_FORMATADDR, 0 },
148 { "friendly", TF_COMP, FT_LS_FRIENDLY, FT_PARSEADDR, TFL_PUTS },
150 { "mymbox", TF_COMP, FT_LV_COMPFLAG, FT_MYMBOX, TFL_PUTN },
152 { "unquote", TF_EXPR, FT_LS_UNQUOTE, 0, TFL_PUTS},
157 /* Add new component to the hash table */
158 #define NEWCOMP(cm,name) do { \
159 cm = ((struct comp *) calloc(1, sizeof (struct comp)));\
163 cm->c_next = wantcomp[i];\
167 #define NEWFMT (next_fp++)
168 #define NEW(type,fill,wid) do {\
169 fp=NEWFMT; fp->f_type=(type); fp->f_fill=(fill); fp->f_width=(wid); \
172 /* Add (possibly new) component to the hash table */
173 #define ADDC(name) do { \
181 #define LV(type, value) do { NEW(type,0,0); fp->f_value = (value); } while (0)
182 #define LS(type, str) do { NEW(type,0,0); fp->f_text = (str); } while (0)
184 #define PUTCOMP(comp) do { NEW(FT_COMP,0,0); ADDC(comp); } while (0)
185 #define PUTLIT(str) do { NEW(FT_LIT,0,0); fp->f_text = (str); } while (0)
186 #define PUTC(c) do { NEW(FT_CHAR,0,0); fp->f_char = (c); } while (0)
188 static char *format_string;
189 static unsigned char *usr_fstring; /* for CERROR */
191 #define CERROR(str) compile_error(str, cp)
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++) {
234 if (iscntrl(usr_fstring[i]))
235 usr_fstring[i] = '_';
238 advise(NULL, "\"%s\": format compile error - %s",
239 &usr_fstring[errpos-errctx], str);
240 adios(NULL, "%*s", errctx+1, "^");
244 ** Compile format string "fstring" into format list "fmt".
245 ** Return the number of header components found in the format
250 fmt_compile(char *fstring, struct format **fmt)
257 format_string = getcpy(fstring);
258 usr_fstring = fstring;
260 /* init the component hash table. */
261 for (i = 0; i < sizeof(wantcomp)/sizeof(wantcomp[0]); i++)
264 memset((char *) &fmt_mnull, 0, sizeof(fmt_mnull));
267 ** it takes at least 4 char to generate one format so we
268 ** allocate a worst-case format array using 1/4 the length
269 ** of the format string. We actually need twice this much
270 ** to handle both pre-processing (e.g., address parsing) and
271 ** normal processing.
273 i = strlen(fstring)/2 + 1;
276 next_fp = formatvec = (struct format *)calloc((size_t) i,
277 sizeof(struct format));
279 adios(NULL, "unable to allocate format storage");
284 cp = compile(format_string);
286 CERROR("extra '%>', '%|' or '%?'");
288 LV(FT_DONE, 0); /* really done */
297 register char *cp = sp;
302 while ((c = *cp) && c != '%')
338 case ';': /* comment line */
340 while ((c = *cp++) && c != '\n')
355 register char *cp = sp;
358 register int ljust = 0;
359 #endif /* not lint */
360 register int wid = 0;
361 register char fill = ' ';
373 wid = wid*10 + (c - '0');
379 fp->f_type = wid? FT_COMPF : FT_COMP;
380 } else if (c == '(') {
383 if (ftbl->flags & TFL_PUTS) {
384 LV( wid? FT_STRF : FT_STR, ftbl->extra);
385 } else if (ftbl->flags & TFL_PUTN) {
386 LV( wid? FT_NUMF : FT_NUM, ftbl->extra);
390 CERROR("component or function name expected");
401 do_name(char *sp, int preprocess)
403 register char *cp = sp;
406 static int primed = 0;
408 while (isalnum(c = *cp++) || c == '-' || c == '_')
411 CERROR("'}' expected");
415 switch (preprocess) {
418 if (cm->c_type & CT_ADDR) {
419 CERROR("component used as both date and address");
421 cm->c_tws = (struct tws *)
422 calloc((size_t) 1, sizeof(*cm->c_tws));
423 fp->f_type = preprocess;
425 cm->c_type |= CT_DATE;
430 ismymbox((struct mailname *) 0);
435 if (cm->c_type & CT_DATE) {
436 CERROR("component used as both date and address");
438 cm->c_mn = &fmt_mnull;
439 fp->f_type = preprocess;
441 cm->c_type |= CT_ADDR;
445 if (cm->c_type & CT_DATE) {
446 CERROR("component used as both date and address");
448 cm->c_type |= CT_ADDR;
457 register char *cp = sp;
459 register struct ftable *t;
461 int mflag; /* minus sign in NUM */
465 while (isalnum(c = *cp++))
467 if (c != '(' && c != '{' && c != ' ' && c != ')') {
468 CERROR("'(', '{', ' ' or ')' expected");
471 if ((t = lookup(sp)) == 0) {
472 CERROR("unknown function");
481 CERROR("component name expected");
483 cp = do_name(cp, t->extra);
484 fp->f_type = t->f_type;
489 if ((mflag = (c == '-')))
493 n = n*10 + (c - '0');
503 while (c && c != ')')
510 LV(t->f_type,t->extra);
514 LS(t->f_type, getusername());
518 LV(t->f_type, time((time_t *) 0));
526 cp = do_expr(cp, t->extra);
534 cp = do_expr(cp, t->extra);
540 CERROR("')' expected");
547 do_expr(char *sp, int preprocess)
549 register char *cp = sp;
552 if ((c = *cp++) == '{') {
553 cp = do_name(cp, preprocess);
554 fp->f_type = FT_LS_COMP;
555 } else if (c == '(') {
557 } else if (c == ')') {
559 } else if (c == '%' && *cp == '<') {
562 CERROR("'(', '{', '%<' or ')' expected");
570 register char *cp = sp;
571 struct format *floop;
576 CERROR("']' expected");
578 LV(FT_DONE, 1); /* not yet done */
580 fp->f_skip = floop - fp; /* skip backwards */
588 register char *cp = sp;
589 register struct format *fexpr, *fif = (struct format *)NULL;
590 register int c = '<';
593 if (c == '<') { /* doing an IF */
594 if ((c = *cp++) == '{') /*}*/{
596 fp->f_type = FT_LS_COMP;
598 } else if (c == '(') {
600 /* see if we can merge the load and the "if" */
601 if (ftbl->f_type >= IF_FUNCS)
602 fp->f_type = ftbl->extra;
605 ** Put out a string test or a value
606 ** test depending on what this
607 ** function 's return type is.
609 if (ftbl->flags & TFL_PUTS) {
616 CERROR("'(' or '{' expected"); /*}*/
620 fexpr = fp; /* loc of [ELS]IF */
621 cp = compile(cp); /* compile IF TRUE stmts */
623 fif->f_skip = next_fp - fif;
625 if ((c = *cp++) == '|') { /* the last ELSE */
627 fif = fp; /* loc of GOTO */
628 fexpr->f_skip = next_fp - fexpr;
630 fexpr = (struct format *)NULL;/* no extra ENDIF */
632 cp = compile(cp); /* compile ELSE stmts */
633 fif->f_skip = next_fp - fif;
635 } else if (c == '?') { /* another ELSIF */
637 fif = fp; /* loc of GOTO */
638 fexpr->f_skip = next_fp - fexpr;
640 c = '<'; /* impersonate an IF */
647 CERROR("'>' expected.");
650 if (fexpr) /* IF ... [ELSIF ...] ENDIF */
651 fexpr->f_skip = next_fp - fexpr;