]> diplodocus.org Git - nmh/blobdiff - sbr/fmt_compile.c
Escape literal leading full stop in man/new.man.
[nmh] / sbr / fmt_compile.c
index 437c811cff974ac173981c63b8748a39cfbc1fb3..f7fcff2b6afd545ae9ca9a732c4d342e65660677 100644 (file)
@@ -16,7 +16,7 @@
  * There is a NOT a one-to-one correspondence between format strings and
  * format instructions; some functions have side effects that can result
  * in multiple instructions being generated.  The exact list of instructions
- * generated by a format string can be seem with the nmh fmtdump utility.
+ * generated by a format string can be seem with the nmh fmttest utility.
  *
  * A list of format instructions can be found in fmt_compile.h.
  *
@@ -35,7 +35,7 @@
  *
  * - Add the code in fmt_scan.c to handle your new function.
  *
- * - Add code to fmtdump.c to display your new function.
+ * - Add code to fmttest.c to display your new function.
  *
  * - Document the new function in the mh-format(5) man page.
  *
@@ -82,6 +82,13 @@ extern struct mailname fmt_mnull;
 #define TF_MYNAME  9        /* special - get current name of user */
 #define TF_MYHOST  10       /* special - get "local" hostname     */
 #define TF_LMBOX   11       /* special - get full local mailbox   */
+#define TF_BOLD    12      /* special - enter terminal bold mode */
+#define TF_UNDERLN 13       /* special - enter underline mode     */
+#define TF_STNDOUT 14       /* special - enter underline mode     */
+#define TF_RESET   15       /* special - reset terminal modes     */
+#define TF_HASCLR  16       /* special - terminal have color?     */
+#define TF_FGCOLR  17       /* special - foreground term color    */
+#define TF_BGCOLR  18       /* special - background term color    */
 
 /* ftable->flags */
 /* NB that TFL_PUTS is also used to decide whether the test
@@ -100,7 +107,9 @@ extern struct mailname fmt_mnull;
  *         what maps a particular function name into a format instruction.
  * type -   The type of argument this function expects.  Those types are
  *         listed above (with the TF_ prefix).  This affects what gets
- *         placed in the format instruction (the f_un union).
+ *         placed in the format instruction (the f_un union).  Also,
+ *         instructions that require special handling are distinguished
+ *         here (TF_MYMBOX is one example).
  * f_type - The instruction corresponding to this function (from the list
  *         in fmt_compile.h).
  * extra  - Used by some functions to provide extra data to the compiler.
@@ -150,6 +159,8 @@ static struct ftable functable[] = {
      { "decodecomp", TF_COMP,  FT_LS_DECODECOMP, 0,            TFL_PUTS },
      { "decode",     TF_EXPR,  FT_LS_DECODE,   0,              TFL_PUTS },
      { "trim",       TF_EXPR,  FT_LS_TRIM,     0,              0 },
+     { "kilo",       TF_EXPR,  FT_LS_KILO,     0,              TFL_PUTS },
+     { "kibi",       TF_EXPR,  FT_LS_KIBI,     0,              TFL_PUTS },
      { "compval",    TF_COMP,  FT_LV_COMP,     0,              TFL_PUTN },
      { "compflag",   TF_COMP,  FT_LV_COMPFLAG, 0,              TFL_PUTN },
      { "num",        TF_NUM,   FT_LV_LIT,      0,              TFL_PUTN },
@@ -166,6 +177,7 @@ static struct ftable functable[] = {
      { "localmbox",  TF_LMBOX, FT_LS_LIT,      0,              TFL_PUTS },
      { "plus",       TF_NUM,   FT_LV_PLUS_L,   0,              TFL_PUTN },
      { "minus",      TF_NUM,   FT_LV_MINUS_L,  0,              TFL_PUTN },
+     { "multiply",   TF_NUM,   FT_LV_MULTIPLY_L, 0,            TFL_PUTN },
      { "divide",     TF_NUM,   FT_LV_DIVIDE_L, 0,              TFL_PUTN },
      { "modulo",     TF_NUM,   FT_LV_MODULO_L, 0,              TFL_PUTN },
      { "charleft",   TF_NONE,  FT_LV_CHAR_LEFT, 0,             TFL_PUTN },
@@ -212,19 +224,59 @@ static struct ftable functable[] = {
      { "friendly",   TF_COMP,  FT_LS_FRIENDLY, FT_PARSEADDR,   TFL_PUTS },
 
      { "mymbox",     TF_COMP,  FT_LV_COMPFLAG, FT_MYMBOX,      TFL_PUTN },
+     { "getmymbox",  TF_COMP,  FT_STR,         FT_GETMYMBOX,   0 },
+     { "getmyaddr",  TF_COMP,  FT_LS_ADDR,     FT_GETMYADDR,   TFL_PUTS },
 
-     { "unquote",   TF_EXPR,   FT_LS_UNQUOTE,  0,              TFL_PUTS},
+     { "unquote",    TF_EXPR,  FT_LS_UNQUOTE,  0,              TFL_PUTS },
+
+     { "bold",       TF_BOLD,  FT_LS_LIT,      0,              TFL_PUTS },
+     { "underline",  TF_UNDERLN,FT_LS_LIT,     0,              TFL_PUTS },
+     { "standout",   TF_STNDOUT,FT_LS_LIT,     0,              TFL_PUTS },
+     { "resetterm",  TF_RESET, FT_LS_LIT,      0,              TFL_PUTS },
+     { "hascolor",   TF_HASCLR, FT_LV_LIT,     0,              0 },
+     { "fgcolor",    TF_FGCOLR, FT_LS_LIT,     0,              TFL_PUTS },
+     { "bgcolor",    TF_BGCOLR, FT_LS_LIT,     0,              TFL_PUTS },
 
      { NULL,         0,                0,              0,              0 }
 };
 
-/* 
- * Hash function for component name.  The function should be
- * case independent and probably shouldn't involve a routine
- * call.  This function is pretty good but will not work on
- * single character component names.  
+/*
+ * A mapping of color names to terminfo color numbers.
+ *
+ * There are two sets of terminal-setting codes: 'setaf/setab' (ANSI) and
+ * 'setf/setb'.  Different terminals support different capabilities, so
+ * we provide a mapping for both.  I'm not crazy about putting numbers
+ * directly in here, but it seems these are well defined by terminfo
+ * so it should be okay.
  */
-#define        CHASH(nm) (((((nm)[0]) - ((nm)[1])) & 0x1f) + (((nm)[2]) & 0x5f))
+
+struct colormap {
+    char *colorname;   /* Name of color */
+    int ansinum;       /* The ANSI escape color number */
+    int nonansinum;    /* The non-ANSI escape color number */
+};
+
+static struct colormap colortable[] = {
+    { "black",         0,      0 },
+    { "red",           1,      4 },
+    { "green",         2,      2 },
+    { "yellow",                3,      6 },
+    { "blue",          4,      1 },
+    { "magenta",       5,      5 },
+    { "cyan",          6,      3 },
+    { "white",         7,      7 },
+    { NULL,            0,      0 }
+};
+
+/* Hash function for component name.  Deliberately avoids a function
+ * call.  Is case independent.  Covers interval [0, 126] so never uses
+ * the last element of wantcomp[]. This function is "pretty good". */
+#define CHASH(nm) ( \
+        (( \
+            ((nm)[0]) - ((nm)[0] ? ((nm)[1]) : 0) \
+        ) & 0x1f) + \
+        ((nm[1]) ? (((nm)[2]) & 0x5f) : 0) \
+    )
 
 /*
  * Find a component in the hash table.
@@ -237,8 +289,8 @@ static struct ftable functable[] = {
 
 /* Add new component to the hash table */
 #define NEWCOMP(cm,name) do { \
-       cm = ((struct comp *) calloc(1, sizeof (struct comp)));\
-       cm->c_name = getcpy(name);\
+       NEW0(cm);\
+       cm->c_name = mh_xstrdup(name);\
        cm->c_refcount++;\
        ncomp++;\
        i = CHASH(name);\
@@ -247,7 +299,7 @@ static struct ftable functable[] = {
        } while (0)
 
 #define NEWFMT (next_fp++)
-#define NEW(type,fill,wid) do {\
+#define NEW_FP(type,fill,wid) do {\
        fp=NEWFMT; fp->f_type=(type); fp->f_fill=(fill); fp->f_width=(wid); \
        } while (0)
 
@@ -262,15 +314,15 @@ static struct ftable functable[] = {
        cm->c_refcount++; \
        } while (0)
 
-#define LV(type, value)                do { NEW(type,0,0); fp->f_value = (value); } while (0)
-#define LS(type, str)          do { NEW(type,0,0); fp->f_text = getcpy(str); fp->f_flags |= FF_STRALLOC; } while (0)
+#define LV(type, value)                do { NEW_FP(type,0,0); fp->f_value = (value); } while (0)
+#define LS(type, str)          do { NEW_FP(type,0,0); fp->f_text = getcpy(str); fp->f_flags |= FF_STRALLOC; } while (0)
 
-#define PUTCOMP(comp)          do { NEW(FT_COMP,0,0); ADDC(comp); } while (0)
-#define PUTLIT(str)            do { NEW(FT_LIT,0,0); fp->f_text = getcpy(str); fp->f_flags |= FF_STRALLOC; } while (0)
-#define PUTC(c)                        do { NEW(FT_CHAR,0,0); fp->f_char = (c); } while (0)
+#define PUTCOMP(comp)          do { NEW_FP(FT_COMP,0,0); ADDC(comp); } while (0)
+#define PUTLIT(str)            do { NEW_FP(FT_LIT,0,0); fp->f_text = getcpy(str); fp->f_flags |= FF_STRALLOC; } while (0)
+#define PUTC(c)                        do { NEW_FP(FT_CHAR,0,0); fp->f_char = (c); } while (0)
 
 static char *format_string;
-static unsigned char *usr_fstring;     /* for CERROR */
+static char *usr_fstring;      /* for CERROR */
 
 #define CERROR(str) compile_error (str, cp)
 
@@ -289,16 +341,15 @@ static char *do_if(char *);
 static void free_component(struct comp *);
 static void free_comptable(void);
 
-
 /*
  * Lookup a function name in the functable
  */
 static struct ftable *
 lookup(char *name)
 {
-    register struct ftable *t = functable;
-    register char *nm;
-    register char c = *name;
+    struct ftable *t = functable;
+    char *nm;
+    char c = *name;
 
     while ((nm = t->name)) {
        if (*nm == c && strcmp (nm, name) == 0)
@@ -320,11 +371,7 @@ compile_error(char *str, char *cp)
     usr_fstring[errpos] = '\0';
 
     for (i = errpos-errctx; i < errpos; i++) {
-#ifdef LOCALE
-       if (iscntrl(usr_fstring[i]))
-#else
-       if (usr_fstring[i] < 32)
-#endif
+       if (iscntrl((unsigned char) usr_fstring[i]))
            usr_fstring[i] = '_';
     }
 
@@ -342,11 +389,11 @@ compile_error(char *str, char *cp)
 int
 fmt_compile(char *fstring, struct format **fmt, int reset_comptable)
 {
-    register char *cp;
+    char *cp;
     size_t i;
     static int comptable_initialized = 0;
 
-    format_string = getcpy (fstring);
+    format_string = mh_xstrdup(fstring);
     usr_fstring = fstring;
 
     if (reset_comptable || !comptable_initialized) {
@@ -354,8 +401,6 @@ fmt_compile(char *fstring, struct format **fmt, int reset_comptable)
        comptable_initialized = 1;
     }
 
-    memset((char *) &fmt_mnull, 0, sizeof(fmt_mnull));
-
     /* it takes at least 4 char to generate one format so we
      * allocate a worst-case format array using 1/4 the length
      * of the format string.  We actually need twice this much
@@ -364,11 +409,7 @@ fmt_compile(char *fstring, struct format **fmt, int reset_comptable)
      */
     i = strlen(fstring)/2 + 1;
                if (i==1) i++;
-    next_fp = formatvec = (struct format *)calloc ((size_t) i,
-                                                  sizeof(struct format));
-    if (next_fp == NULL)
-       adios (NULL, "unable to allocate format storage");
-
+    next_fp = formatvec = mh_xcalloc(i, sizeof *next_fp);
     infunction = 0;
 
     cp = compile(format_string);
@@ -385,8 +426,8 @@ fmt_compile(char *fstring, struct format **fmt, int reset_comptable)
 static char *
 compile (char *sp)
 {
-    register char *cp = sp;
-    register int  c;
+    char *cp = sp;
+    int  c;
 
     for (;;) {
        sp = cp;
@@ -446,13 +487,13 @@ compile (char *sp)
 static char *
 do_spec(char *sp)
 {
-    register char *cp = sp;
-    register int c;
+    char *cp = sp;
+    int c;
 #ifndef        lint
-    register int ljust = 0;
+    int ljust = 0;
 #endif /* not lint */
-    register int wid = 0;
-    register char fill = ' ';
+    int wid = 0;
+    char fill = ' ';
 
     c = *cp++;
     if (c == '-') {
@@ -502,9 +543,9 @@ do_spec(char *sp)
 static char *
 do_name(char *sp, int preprocess)
 {
-    register char *cp = sp;
-    register int c;
-    register int i;
+    char *cp = sp;
+    int c;
+    int i;
     static int primed = 0;
 
     while (isalnum(c = *cp++) || c == '-' || c == '_')
@@ -520,19 +561,24 @@ do_name(char *sp, int preprocess)
        if (cm->c_type & CT_ADDR) {
            CERROR("component used as both date and address");
        }
-       cm->c_tws = (struct tws *)
-           calloc((size_t) 1, sizeof(*cm->c_tws));
+       if (cm->c_tws) {
+           memset (cm->c_tws, 0, sizeof *cm->c_tws);
+       } else {
+           NEW0(cm->c_tws);
+       }
        fp->f_type = preprocess;
        PUTCOMP(sp);
        cm->c_type |= CT_DATE;
        break;
 
     case FT_MYMBOX:
+    case FT_GETMYMBOX:
+    case FT_GETMYADDR:
        if (!primed) {
            ismymbox ((struct mailname *) 0);
            primed++;
        }
-       /* fall through */
+       /* FALLTHRU */
     case FT_PARSEADDR:
        if (cm->c_type & CT_DATE) {
            CERROR("component used as both date and address");
@@ -560,10 +606,10 @@ do_name(char *sp, int preprocess)
 static char *
 do_func(char *sp)
 {
-    register char *cp = sp;
-    register int c;
-    register struct ftable *t;
-    register int n;
+    char *cp = sp;
+    int c;
+    struct ftable *t;
+    int n;
     int mflag;         /* minus sign in NUM */
 
     infunction++;
@@ -632,13 +678,69 @@ do_func(char *sp)
        LS(t->f_type, getlocalmbox());
        break;
 
+    case TF_BOLD:
+       LS(t->f_type, get_term_stringcap("bold"));
+       break;
+
+    case TF_UNDERLN:
+       LS(t->f_type, get_term_stringcap("smul"));
+       break;
+
+    case TF_STNDOUT:
+       LS(t->f_type, get_term_stringcap("smso"));
+       break;
+
+    case TF_RESET:
+       LS(t->f_type, get_term_stringcap("sgr0"));
+       break;
+
+    case TF_HASCLR:
+       LV(t->f_type, get_term_numcap("colors") > 1);
+       break;
+
+    case TF_FGCOLR:
+    case TF_BGCOLR: {
+       struct colormap *cmap = colortable;
+       char *code;
+
+       sp = cp - 1;
+       while (c && c != ')')
+           c = *cp++;
+       cp[-1] = '\0';
+
+       while (cmap->colorname != NULL) {
+           if (strcasecmp(sp, cmap->colorname) == 0)
+               break;
+           cmap++;
+       }
+
+       if (cmap->colorname == NULL) {
+           CERROR("Unknown color name");
+           break;
+       }
+
+       code = get_term_stringparm(t->type == TF_FGCOLR ? "setaf" : "setab",
+                                  cmap->ansinum, 0);
+
+       /*
+        * If this doesn't have anything, try falling back to setf/setb
+        */
+
+       if (! code)
+           code = get_term_stringparm(t->type == TF_FGCOLR ? "setf" : "setb",
+                                      cmap->nonansinum, 0);
+
+       LS(t->f_type, code);
+       break;
+    }
+
     case TF_NOW:
        LV(t->f_type, time((time_t *) 0));
        break;
 
     case TF_EXPR_SV:
        LV(FT_SAVESTR, 0);
-       /* fall through */
+       /* FALLTHRU */
     case TF_EXPR:
        *--cp = c;
        cp = do_expr(cp, t->extra);
@@ -668,8 +770,8 @@ do_func(char *sp)
 static char *
 do_expr (char *sp, int preprocess)
 {
-    register char *cp = sp;
-    register int  c;
+    char *cp = sp;
+    int  c;
 
     if ((c = *cp++) == '{') {
        cp = do_name (cp, preprocess);
@@ -729,7 +831,7 @@ do_expr (char *sp, int preprocess)
 static char *
 do_loop(char *sp)
 {
-    register char *cp = sp;
+    char *cp = sp;
     struct format *floop;
 
     floop = next_fp;
@@ -753,10 +855,10 @@ do_loop(char *sp)
 static char *
 do_if(char *sp)
 {
-    register char *cp = sp;
-    register struct format *fexpr,
+    char *cp = sp;
+    struct format *fexpr,
                           *fif = (struct format *)NULL;
-    register int c = '<';
+    int c = '<';
 
     for (;;) {
        if (c == '<') {                 /* doing an IF */
@@ -856,6 +958,23 @@ fmt_free(struct format *fmt, int reset_comptable)
        free_comptable();
 }
 
+/*
+ * Free just the text strings from all of the component hash table entries
+ */
+
+void
+fmt_freecomptext(void)
+{
+    unsigned int i;
+    struct comp *cm;
+
+    for (i = 0; i < sizeof(wantcomp)/sizeof(wantcomp[0]); i++)
+        for (cm = wantcomp[i]; cm; cm = cm->c_next) {
+            mh_xfree(cm->c_text);
+            cm->c_text = NULL;
+        }
+}
+
 /*
  * Find a component in our hash table.  This is just a public interface to
  * the FINDCOMP macro, so we don't have to expose our hash table.
@@ -881,7 +1000,7 @@ fmt_findcasecomp(char *component)
     struct comp *cm;
 
     for (cm = wantcomp[CHASH(component)]; cm; cm = cm->c_next)
-       if (mh_strcasecmp(component, cm->c_name) == 0)
+       if (strcasecmp(component, cm->c_name ? cm->c_name : "") == 0)
            break;
 
     return cm;
@@ -933,18 +1052,18 @@ fmt_addcomptext(char *component, char *text)
     char *cp;
 
     while (cptr) {
-       if (mh_strcasecmp(component, cptr->c_name) == 0) {
+       if (strcasecmp(component, cptr->c_name ? cptr->c_name : "") == 0) {
            found++;
            if (! cptr->c_text) {
-               cptr->c_text = getcpy(text);
+               cptr->c_text = getcpy(text);
            } else {
-               i = strlen(cp = cptr->c_text) - 1;
+               i = strlen(cp = cptr->c_text) - 1;
                if (cp[i] == '\n') {
                    if (cptr->c_type & CT_ADDR) {
-                       cp[i] = '\0';
+                       cp[i] = '\0';
                        cp = add(",\n\t", cp);
                    } else {
-                       cp = add("\t", cp);
+                       cp = add("\t", cp);
                    }
                }
                cptr->c_text = add(text, cp);
@@ -968,11 +1087,30 @@ fmt_appendcomp(int bucket, char *component, char *text)
 
     if (bucket != -1) {
        for (cptr = wantcomp[bucket]; cptr; cptr = cptr->c_next)
-           if (mh_strcasecmp(component, cptr->c_name) == 0)
+           if (strcasecmp(component, cptr->c_name ? cptr->c_name : "") == 0)
                cptr->c_text = add(text, cptr->c_text);
     }
 }
 
+/*
+ * Iterate over our component hash table
+ */
+
+struct comp *
+fmt_nextcomp(struct comp *comp, unsigned int *bucket)
+{
+    if (comp == NULL)
+       *bucket = 0;
+    else
+       comp = comp->c_next;
+
+    while (comp == NULL && *bucket < sizeof(wantcomp)/sizeof(wantcomp[0])) {
+       comp = wantcomp[(*bucket)++];
+    }
+
+    return comp;
+}
+
 /*
  * Free and reset our component hash table
  */
@@ -1006,10 +1144,8 @@ free_component(struct comp *cm)
 {
     if (--cm->c_refcount <= 0) {
        /* Shouldn't ever be NULL, but just in case ... */
-       if (cm->c_name)
-           free(cm->c_name);
-       if (cm->c_text)
-           free(cm->c_text);
+        mh_xfree(cm->c_name);
+        mh_xfree(cm->c_text);
        if (cm->c_type & CT_DATE)
            free(cm->c_tws);
        if (cm->c_type & CT_ADDR && cm->c_mn && cm->c_mn != &fmt_mnull)