Basic format tracing support; seems to work!

diff --git a/h/fmt_scan.h b/h/fmt_scan.h
index e499d51dd47e9aea8b9fdf34e29bbcbe14e75d2e..50b597e16e6312bc6079dde3eac5e3d388d61fba 100644 (file)
--- a/h/fmt_scan.h
+++ b/h/fmt_scan.h
@@ -87,12 +87,13 @@ struct format {
 
 typedef char * (*formataddr_cb)(char *, char *);
 typedef char * (*concataddr_cb)(char *, char *);
-typedef void (*trace_cb)(void *, int, int, char *, char *);
+typedef void (*trace_cb)(void *, struct format *, int, char *, char *);
 
 struct fmt_callbacks {
     formataddr_cb      formataddr;
     concataddr_cb      concataddr;
-    trace_cb           trace;
+    trace_cb           trace_func;
+    void *             trace_context;
 };
 
 /*

diff --git a/sbr/fmt_scan.c b/sbr/fmt_scan.c
index 8e7827fdf6540d8ea71c1cc63559a7a16960dda8..e654b15e91a95fb9c5bdabae934e552a6f4ccc46 100644 (file)
--- a/sbr/fmt_scan.c
+++ b/sbr/fmt_scan.c
@@ -463,6 +463,9 @@ fmt_scan (struct format *format, char *scanl, size_t max, int width, int *dat,
            break;
 
        case FT_DONE:
+           if (callbacks && callbacks->trace_func)
+               callbacks->trace_func(callbacks->trace_context, fmt, value,
+                                     str, scanl);
            goto finished;
 
        case FT_IF_S:
@@ -1001,6 +1004,14 @@ fmt_scan (struct format *format, char *scanl, size_t max, int width, int *dat,
            }
            break;
        }
+
+       /*
+        * Call our tracing callback function, if one was supplied
+        */
+
+       if (callbacks && callbacks->trace_func)
+           callbacks->trace_func(callbacks->trace_context, fmt, value,
+                                 str, scanl);
        fmt++;
     }
 
@@ -1008,6 +1019,9 @@ fmt_scan (struct format *format, char *scanl, size_t max, int width, int *dat,
     while (fmt->f_type != FT_DONE) {
        if (fmt->f_type == FT_LS_LIT) {
            str = fmt->f_text;
+           if (callbacks && callbacks->trace_func)
+               callbacks->trace_func(callbacks->trace_context, fmt, value,
+                                     str, scanl);
        } else if (fmt->f_type == FT_STRLITZ) {
            /* Don't want to emit part of an escape sequence.  So if
               there isn't enough room in the buffer for the entire
@@ -1016,6 +1030,9 @@ fmt_scan (struct format *format, char *scanl, size_t max, int width, int *dat,
            if (cp - scanl + strlen (str) + 1 < max) {
                for (sp = str; *sp; *cp++ = *sp++) continue;
            }
+           if (callbacks && callbacks->trace_func)
+               callbacks->trace_func(callbacks->trace_context, fmt, value,
+                                     str, scanl);
        }
        fmt++;
     }

diff --git a/uip/fmttest.c b/uip/fmttest.c
index 8297ccb874c3b12a367a9ea5719dc474284afc30..f48d1cbef9581d2b2a5d53f9822c9053949096e3 100644 (file)
--- a/uip/fmttest.c
+++ b/uip/fmttest.c
@@ -28,6 +28,8 @@
     X("noccme", 0, NCCMESW) \
     X("normalize", 0, NORMSW) \
     X("nonormalize", 0, NNORMSW) \
+    X("trace", 0, TRACESW) \
+    X("notrace", 0, NTRACESW) \
     X("outsize size-in-characters", 0, OUTSIZESW) \
     X("bufsize size-in-bytes", 0, BUFSZSW) \
     X("width column-width", 0, WIDTHSW) \
@@ -59,6 +61,16 @@ enum mode_t { MESSAGE, ADDRESS, RAW };
 #define DEFADDRFORMAT "%<{error}%{error}: %{text}%|%(putstr(proper{text}))%>"
 #define DEFDATEFORMAT "%<(nodate{text})error: %{text}%|%(putstr(pretty{text}))%>"
 
+/*
+ * Context structure used by the tracing routines
+ */
+
+struct trace_context {
+    int num;
+    char *str;
+    char *outbuf;
+};
+
 /*
  * static prototypes
  */
@@ -79,6 +91,7 @@ static void process_raw(struct format *, struct msgs_array *, char *,
 static void process_messages(struct format *, struct msgs_array *,
                             struct msgs_array *, char *, char *, int,
                             int, int *, struct fmt_callbacks *);
+static void test_trace(void *, struct format *, int, char *, char *);
 static char *test_formataddr(char *, char *);
 static char *test_concataddr(char *, char *);
 static int insert(struct mailname *);
@@ -87,6 +100,7 @@ static void mlistfree(void);
 static int nodupcheck = 0;     /* If set, no check for duplicates */
 static int ccme = 0;           /* Should I cc myself? */
 static struct mailname mq;     /* Mail addresses to check for duplicates */
+static char *dummy = "dummy";
 
 int
 main (int argc, char **argv)
@@ -97,7 +111,7 @@ main (int argc, char **argv)
     struct comp *cptr;
     struct msgs_array msgs = { 0, 0, NULL }, compargs = { 0, 0, NULL};
     int dump = 0, i;
-    int outputsize = 0, bufsize = 0, dupaddrs = 1;
+    int outputsize = 0, bufsize = 0, dupaddrs = 1, trace = 0;
     int colwidth = -1, msgnum = -1, msgcur = -1, msgsize = -1, msgunseen = -1;
     int normalize = AD_HOST;
     enum mode_t mode = MESSAGE;
@@ -183,6 +197,13 @@ main (int argc, char **argv)
                    normalize = AD_NHST;
                    continue;
 
+               case TRACESW:
+                   trace++;
+                   continue;
+               case NTRACESW:
+                   trace = 0;
+                   continue;
+
                case ADDRSW:
                    mode = ADDRESS;
                    defformat = DEFADDRFORMAT;
@@ -281,10 +302,13 @@ main (int argc, char **argv)
     nfs = new_fs (form, format, defformat);
     (void) fmt_compile(nfs, &fmt, 1);
 
-    if (dump) {
-       fmt_dump(nfs, fmt);
-       if (compargs.size == 0 && msgs.size == 0)
-           done(0);
+    if (dump || trace) {
+        initlabels(fmt);
+       if (dump) {
+           fmt_dump(nfs, fmt);
+           if (compargs.size == 0 && msgs.size == 0)
+               done(0);
+       }
     }
 
     /*
@@ -316,13 +340,28 @@ main (int argc, char **argv)
      * callback, do that now.  Also, prime ismymbox if we use it.
      */
 
-    if (dupaddrs == 0) {
+    if (dupaddrs == 0 || trace) {
        memset(&cb, 0, sizeof(cb));
-       cb.formataddr = test_formataddr;
-       cb.concataddr = test_concataddr;
        cbp = &cb;
-       if (!ccme)
-           ismymbox(NULL);
+
+       if (dupaddrs == 0) {
+           cb.formataddr = test_formataddr;
+           cb.concataddr = test_concataddr;
+           if (!ccme)
+               ismymbox(NULL);
+       }
+
+       if (trace) {
+           struct trace_context *ctx;
+
+           ctx = mh_xmalloc(sizeof(*ctx));
+           ctx->num = -1;
+           ctx->str = dummy;
+           ctx->outbuf = getcpy(NULL);
+
+           cb.trace_func = test_trace;
+           cb.trace_context = ctx;
+       }
     }
 
     if (mode == MESSAGE) {
@@ -625,6 +664,44 @@ process_raw(struct format *fmt, struct msgs_array *text, char *buffer,
     }
 }
 
+/*
+ * Our basic tracing support callback.
+ *
+ * Print out each instruction as it's executed, including the values of
+ * the num and str registers if they've changed.
+ */
+
+static void
+test_trace(void *context, struct format *fmt, int num, char *str, char *outbuf)
+{
+    struct trace_context *ctx = (struct trace_context *) context;
+    int changed = 0;
+
+    dumpone(fmt);
+
+    if (num != ctx->num) {
+       printf("num=%d", num);
+       ctx->num = num;
+       changed++;
+    }
+
+    if (str != ctx->str) {
+       if (changed++)
+           printf(" ");
+       printf("str=\"%s\"", str ? str : "NULL");
+       ctx->str = str;
+    }
+
+    if (changed)
+       printf("\n");
+
+    if (strcmp(outbuf, ctx->outbuf) != 0) {
+       printf("outbuf=\"%s\"\n", outbuf);
+       free(ctx->outbuf);
+       ctx->outbuf = getcpy(outbuf);
+    }
+}
+
 static void
 fmt_dump (char *nfs, struct format *fmth)
 {
@@ -632,8 +709,6 @@ fmt_dump (char *nfs, struct format *fmth)
 
        printf("Instruction dump of format string: \n%s\n", nfs);
 
-       initlabels(fmth);
-
        /* Dump them out! */
        for (fmt = fmth; fmt; ++fmt) {
                dumpone(fmt);