Convert whatnow over to using the new Attach header.

[nmh] / h / fmt_scan.h

diff --git a/h/fmt_scan.h b/h/fmt_scan.h
index fcc87f7d72a655370aa02c2205c3c80eae001ec9..4d768b7bbe0e69ea3a233610b8a9ed35b19d86c6 100644 (file)
--- a/h/fmt_scan.h
+++ b/h/fmt_scan.h
@@ -37,6 +37,8 @@ struct comp {
 #define        CT_ADDR       (1<<0)    /* referenced as address    */
 #define        CT_DATE       (1<<1)    /* referenced as date       */
 
+#define CT_BITS       "\020\01ADDR\02DATE"
+
 /*
  * c_flags bits
  */
@@ -45,7 +47,7 @@ struct comp {
 #define        CF_DATEFAB    (1<<2)    /* datefield fabricated */
 #define CF_TRIMMED    (1<<3)   /* Component has been trimmed */
 
-extern int fmt_norm;
+#define CF_BITS       "\020\01TRUE\02PARSED\03CF_DATEFAB\04TRIMMED"
 
 /*
  * This structure defines one formatting instruction.
@@ -81,6 +83,21 @@ struct format {
  * prototypes used by the format engine
  */
 
+/*
+ * These are the definitions used by the callbacks for fmt_scan()
+ */
+
+typedef char * (*formataddr_cb)(char *, char *);
+typedef char * (*concataddr_cb)(char *, char *);
+typedef void (*trace_cb)(void *, struct format *, int, char *, char *);
+
+struct fmt_callbacks {
+    formataddr_cb      formataddr;
+    concataddr_cb      concataddr;
+    trace_cb           trace_func;
+    void *             trace_context;
+};
+
 /*
  * Create a new format string.  Arguments are:
  *
@@ -111,7 +128,8 @@ char *new_fs (char *form, char *format, char *default_fs);
  *               strings that you want to compile and operate on the
  *               same message, this should be set to false.
  *
- * Returns the number of components referenced by the format instructions.
+ * Returns the total number of components referenced by all format instructions
+ * since the last reset of the hash table.
  */
 
 int fmt_compile (char *fstring, struct format **fmt, int reset);
@@ -139,12 +157,20 @@ int fmt_compile (char *fstring, struct format **fmt, int reset);
  *             dat[3] - %(width)
  *             dat[4] - %(unseen)
  *
+ * callbacks   - A set of a callback functions used by the format engine.
+ *               Can be NULL.  If structure elements are NULL, a default
+ *               function will be used.  Callback structure elements are:
+ *
+ *             formataddr      - A callback for the %(formataddr) instruction
+ *             concataddr      - A callback for the %(concataddr) instruction
+ *             trace           - Called for every format instruction executed
+ *
  * The return value is a pointer to the next format instruction to
  * execute, which is currently always NULL.
  */
 
 struct format *fmt_scan (struct format *format, char *scanl, size_t max,
-                        int width, int *dat);
+                        int width, int *dat, struct fmt_callbacks *callbacks);
 
 /*
  * Free a format structure and/or component hash table.  Arguments are:
@@ -157,6 +183,12 @@ struct format *fmt_scan (struct format *format, char *scanl, size_t max,
 
 void fmt_free (struct format *fmt, int reset);
 
+/*
+ * Free all of the component text structures in the component hash table
+ */
+
+void fmt_freecomptext(void);
+
 /*
  * Search for a component structure in the component hash table.  Arguments are:
  *
@@ -171,6 +203,25 @@ void fmt_free (struct format *fmt, int reset);
 
 struct comp *fmt_findcomp(char *component);
 
+/*
+ * Search for a component structure in the component hash table.
+ *
+ * Identical to fmd_findcomp(), but is case-INSENSITIVE.
+ */
+
+struct comp *fmt_findcasecomp(char *component);
+
+/*
+ * Add a component entry to the component hash table
+ *
+ * component   - The name of the component to add to the hash table.
+ *
+ * If the component is already in the hash table, this function will do
+ * nothing.  Returns 1 if a component was added, 0 if it already existed.
+ */
+
+int fmt_addcompentry(char *component);
+
 /*
  * Add a string to a component hash table entry.  Arguments are:
  *
@@ -193,16 +244,18 @@ struct comp *fmt_findcomp(char *component);
  *
  * This function is designed to be called when you start processing a new
  * component.  The function returns the integer value of the hash table
- * bucket corresponding to this component.
+ * bucket corresponding to this component.  If there was no entry found
+ * in the component hash table, this function will return -1.
  */
 
-int fmt_addcomp(char *component, char *text);
+int fmt_addcomptext(char *component, char *text);
 
 /*
  * Append to an existing component.  Arguments are:
  *
  * bucket      - The hash table bucket corresponding to this component,
- *               as returned by fmt_addcomp().
+ *               as returned by fmt_addcomp().  If -1, this function will
+ *               return with no actions performed.
  * component   - The component to append text to.  Like fmt_addcomp, the
  *               component is searched case-INSENSITIVELY.
  * text                - The text to append to the component.  No special processing