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 HAVE_SYS_TIME_H
16 # include <sys/time.h>
21 ** hash table for deciding if a component is "interesting"
23 struct comp *wantcomp[128];
25 static struct format *formatvec; /* array to hold formats */
26 static struct format *next_fp; /* next free format slot */
27 static struct format *fp; /* current format slot */
28 static struct comp *cm; /* most recent comp ref */
29 static struct ftable *ftbl; /* most recent func ref */
31 static int infunction; /* function nesting cnt */
33 extern struct mailname fmt_mnull;
35 /* ftable->type (argument type) */
36 #define TF_COMP 0 /* component expected */
37 #define TF_NUM 1 /* number expected */
38 #define TF_STR 2 /* string expected */
39 #define TF_EXPR 3 /* component or func. expected */
40 #define TF_NONE 4 /* no argument */
41 #define TF_MYBOX 5 /* special - get current user's mbox */
42 #define TF_NOW 6 /* special - get current unix time */
43 #define TF_EXPR_SV 7 /* like expr but save current str reg */
44 #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 },
146 { "unquote", TF_EXPR, FT_LS_UNQUOTE, 0, TFL_PUTS},
151 /* Add new component to the hash table */
152 #define NEWCOMP(cm,name) do { \
153 cm = ((struct comp *) calloc(1, sizeof (struct comp)));\
157 cm->c_next = wantcomp[i];\
161 #define NEWFMT (next_fp++)
162 #define NEW(type,fill,wid) do {\
163 fp=NEWFMT; fp->f_type=(type); fp->f_fill=(fill); fp->f_width=(wid); \
166 /* Add (possibly new) component to the hash table */
167 #define ADDC(name) do { \
175 #define LV(type, value) do { NEW(type,0,0); fp->f_value = (value); } while (0)
176 #define LS(type, str) do { NEW(type,0,0); fp->f_text = (str); } while (0)
178 #define PUTCOMP(comp) do { NEW(FT_COMP,0,0); ADDC(comp); } while (0)
179 #define PUTLIT(str) do { NEW(FT_LIT,0,0); fp->f_text = (str); } while (0)
180 #define PUTC(c) do { NEW(FT_CHAR,0,0); fp->f_char = (c); } while (0)
182 static char *format_string;
183 static unsigned char *usr_fstring; /* for CERROR */
185 #define CERROR(str) compile_error(str, cp)
190 static struct ftable *lookup(char *);
191 static void compile_error(char *, char *);
192 static char *compile(char *);
193 static char *do_spec(char *);
194 static char *do_name(char *, int);
195 static char *do_func(char *);
196 static char *do_expr(char *, int);
197 static char *do_loop(char *);
198 static char *do_if(char *);
201 static struct ftable *
204 register struct ftable *t = functable;
206 register char c = *name;
208 while ((nm = t->name)) {
209 if (*nm == c && strcmp(nm, name) == 0)
214 return (struct ftable *) 0;
219 compile_error(char *str, char *cp)
221 int i, errpos, errctx;
223 errpos = cp - format_string;
224 errctx = errpos > 20 ? 20 : errpos;
225 usr_fstring[errpos] = '\0';
227 for (i = errpos-errctx; i < errpos; i++) {
228 if (iscntrl(usr_fstring[i]))
229 usr_fstring[i] = '_';
232 advise(NULL, "\"%s\": format compile error - %s",
233 &usr_fstring[errpos-errctx], str);
234 adios(NULL, "%*s", errctx+1, "^");
238 ** Compile format string "fstring" into format list "fmt".
239 ** Return the number of header components found in the format
244 fmt_compile(char *fstring, struct format **fmt)
251 format_string = getcpy(fstring);
252 usr_fstring = fstring;
254 /* init the component hash table. */
255 for (i = 0; i < sizeof(wantcomp)/sizeof(wantcomp[0]); i++)
258 memset((char *) &fmt_mnull, 0, sizeof(fmt_mnull));
261 ** it takes at least 4 char to generate one format so we
262 ** allocate a worst-case format array using 1/4 the length
263 ** of the format string. We actually need twice this much
264 ** to handle both pre-processing (e.g., address parsing) and
265 ** normal processing.
267 i = strlen(fstring)/2 + 1;
270 next_fp = formatvec = (struct format *)calloc((size_t) i,
271 sizeof(struct format));
273 adios(NULL, "unable to allocate format storage");
278 cp = compile(format_string);
280 CERROR("extra '%>', '%|' or '%?'");
282 LV(FT_DONE, 0); /* really done */
291 register char *cp = sp;
296 while ((c = *cp) && c != '%')
332 case ';': /* comment line */
334 while ((c = *cp++) && c != '\n')
349 register char *cp = sp;
352 register int ljust = 0;
353 #endif /* not lint */
354 register int wid = 0;
355 register char fill = ' ';
367 wid = wid*10 + (c - '0');
373 fp->f_type = wid? FT_COMPF : FT_COMP;
374 } else if (c == '(') {
377 if (ftbl->flags & TFL_PUTS) {
378 LV( wid? FT_STRF : FT_STR, ftbl->extra);
379 } else if (ftbl->flags & TFL_PUTN) {
380 LV( wid? FT_NUMF : FT_NUM, ftbl->extra);
384 CERROR("component or function name expected");
395 do_name(char *sp, int preprocess)
397 register char *cp = sp;
400 static int primed = 0;
402 while (isalnum(c = *cp++) || c == '-' || c == '_')
405 CERROR("'}' expected");
409 switch (preprocess) {
412 if (cm->c_type & CT_ADDR) {
413 CERROR("component used as both date and address");
415 cm->c_tws = (struct tws *)
416 calloc((size_t) 1, sizeof(*cm->c_tws));
417 fp->f_type = preprocess;
419 cm->c_type |= CT_DATE;
424 ismymbox((struct mailname *) 0);
429 if (cm->c_type & CT_DATE) {
430 CERROR("component used as both date and address");
432 cm->c_mn = &fmt_mnull;
433 fp->f_type = preprocess;
435 cm->c_type |= CT_ADDR;
439 if (cm->c_type & CT_DATE) {
440 CERROR("component used as both date and address");
442 cm->c_type |= CT_ADDR;
451 register char *cp = sp;
453 register struct ftable *t;
455 int mflag; /* minus sign in NUM */
459 while (isalnum(c = *cp++))
461 if (c != '(' && c != '{' && c != ' ' && c != ')') {
462 CERROR("'(', '{', ' ' or ')' expected");
465 if ((t = lookup(sp)) == 0) {
466 CERROR("unknown function");
475 CERROR("component name expected");
477 cp = do_name(cp, t->extra);
478 fp->f_type = t->f_type;
483 if ((mflag = (c == '-')))
487 n = n*10 + (c - '0');
497 while (c && c != ')')
504 LV(t->f_type,t->extra);
508 LS(t->f_type, getusername());
512 LV(t->f_type, time((time_t *) 0));
520 cp = do_expr(cp, t->extra);
528 cp = do_expr(cp, t->extra);
534 CERROR("')' expected");
541 do_expr(char *sp, int preprocess)
543 register char *cp = sp;
546 if ((c = *cp++) == '{') {
547 cp = do_name(cp, preprocess);
548 fp->f_type = FT_LS_COMP;
549 } else if (c == '(') {
551 } else if (c == ')') {
553 } else if (c == '%' && *cp == '<') {
556 CERROR("'(', '{', '%<' or ')' expected");
564 register char *cp = sp;
565 struct format *floop;
570 CERROR("']' expected");
572 LV(FT_DONE, 1); /* not yet done */
574 fp->f_skip = floop - fp; /* skip backwards */
582 register char *cp = sp;
583 register struct format *fexpr, *fif = (struct format *)NULL;
584 register int c = '<';
587 if (c == '<') { /* doing an IF */
588 if ((c = *cp++) == '{') /*}*/{
590 fp->f_type = FT_LS_COMP;
592 } else if (c == '(') {
594 /* see if we can merge the load and the "if" */
595 if (ftbl->f_type >= IF_FUNCS)
596 fp->f_type = ftbl->extra;
599 ** Put out a string test or a value
600 ** test depending on what this
601 ** function 's return type is.
603 if (ftbl->flags & TFL_PUTS) {
610 CERROR("'(' or '{' expected"); /*}*/
614 fexpr = fp; /* loc of [ELS]IF */
615 cp = compile(cp); /* compile IF TRUE stmts */
617 fif->f_skip = next_fp - fif;
619 if ((c = *cp++) == '|') { /* the last ELSE */
621 fif = fp; /* loc of GOTO */
622 fexpr->f_skip = next_fp - fexpr;
624 fexpr = (struct format *)NULL;/* no extra ENDIF */
626 cp = compile(cp); /* compile ELSE stmts */
627 fif->f_skip = next_fp - fif;
629 } else if (c == '?') { /* another ELSIF */
631 fif = fp; /* loc of GOTO */
632 fexpr->f_skip = next_fp - fexpr;
634 c = '<'; /* impersonate an IF */
641 CERROR("'>' expected.");
644 if (fexpr) /* IF ... [ELSIF ...] ENDIF */
645 fexpr->f_skip = next_fp - fexpr;