Oops, should have offset file in showbuildenv rather than cat.

[nmh] / h / fmt_scan.h

diff --git a/h/fmt_scan.h b/h/fmt_scan.h
index 50b597e16e6312bc6079dde3eac5e3d388d61fba..dfd26420d9491e1933eb5eb41460688dce953616 100644 (file)
--- a/h/fmt_scan.h
+++ b/h/fmt_scan.h
@@ -6,7 +6,7 @@
 /*
  * This structure describes an "interesting" component.  It holds
  * the name & text from the component (if found) and one piece of
- * auxilary info.  The structure for a particular component is located
+ * auxiliary info.  The structure for a particular component is located
  * by (open) hashing the name and using it as an index into the ptr array
  * "wantcomp".  All format entries that reference a particular component
  * point to its comp struct (so we only have to do component specific
@@ -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.
@@ -87,7 +89,7 @@ struct format {
 
 typedef char * (*formataddr_cb)(char *, char *);
 typedef char * (*concataddr_cb)(char *, char *);
-typedef void (*trace_cb)(void *, struct format *, int, char *, char *);
+typedef void (*trace_cb)(void *, struct format *, int, char *, const char *);
 
 struct fmt_callbacks {
     formataddr_cb      formataddr;
@@ -112,6 +114,12 @@ struct fmt_callbacks {
 
 char *new_fs (char *form, char *format, char *default_fs);
 
+/*
+ * Free memory allocated by new_fs().  It allocates to a static so
+ * no argument is necessary.
+ */
+void free_fs ();
+
 /*
  * Compile a format string into a set of format instructions.  Arguments are:
  *
@@ -121,7 +129,7 @@ char *new_fs (char *form, char *format, char *default_fs);
  *               format engine.
  * reset       - If set to true, the format compiler will reset the
  *               component hash table.  The component hash table contains
- *               all of the references to message components refered to in
+ *               all of the references to message components referred to in
  *               the format instructions.  If you have multiple format
  *               strings that you want to compile and operate on the
  *               same message, this should be set to false.
@@ -136,11 +144,11 @@ int fmt_compile (char *fstring, struct format **fmt, int reset);
  * Interpret a sequence of compiled format instructions.  Arguments are:
  *
  * format      - Array of format instructions generated by fmt_compile()
- * scanl       - Passed-in character array that will contain the output
- *               of the format instructions.  Is always terminated with
- *               a newline (\n).
- * max         - Maximum number of bytes to be written to "scanl" (in other
- *               words, the buffer size).  Includes the trailing NUL.
+ * scanl       - Passed-in charstring_t object (created with
+ *               charstring_create() and later destroyed with
+ *               charstring_free()) that will contain the output of the
+ *               format instructions.  Is always terminated with a
+ *               newline (\n).
  * width       - Maximum number of displayed characters.  Does not include
  *               characters marked as nonprinting or (depending on the
  *               encoding) bytes in a multibyte encoding that exceed the
@@ -167,8 +175,8 @@ int fmt_compile (char *fstring, struct format **fmt, int reset);
  * execute, which is currently always NULL.
  */
 
-struct format *fmt_scan (struct format *format, char *scanl, size_t max,
-                        int width, int *dat, struct fmt_callbacks *callbacks);
+struct format *fmt_scan (struct format *format, charstring_t scanl, int width,
+                        int *dat, struct fmt_callbacks *callbacks);
 
 /*
  * Free a format structure and/or component hash table.  Arguments are:
@@ -235,7 +243,7 @@ int fmt_addcompentry(char *component);
  *                component buffer is a newline, it will be separated
  *                from previous text by ",\n\t"; otherwise if the last
  *                character of the previous text is a newline it will
- *                simply be seperated by a "\t".  This unusual processing
+ *                simply be separated by a "\t".  This unusual processing
  *               is designed to handle the case where you have multiple
  *               headers with the same name (e.g.: multiple "cc:" headers,
  *               even though that isn't technically allowed in the RFCs).
@@ -265,6 +273,25 @@ int fmt_addcomptext(char *component, char *text);
 
 void fmt_appendcomp(int bucket, char *component, char *text);
 
+/*
+ * Iterate over the complete hash table of component structures.
+ *
+ * Arguments are:
+ *
+ * comp                - Pointer to the current component structure.  The next
+ *               component in the hash table after this component.  To
+ *               start (or restart) the iteration of the hash table
+ *               this argument should be NULL.
+ * bucket      - Pointer to hash bucket.  Will be managed by this function,
+ *               the caller should not modify this value.
+ *
+ * Returns the next component in the hash table.  This value should be
+ * passed into the next call to fmt_nextcomp().  Returns NULL at the end
+ * of the hash table.
+ */
+
+struct comp *fmt_nextcomp(struct comp *comp, unsigned int *bucket);
+
 /*
  * The implementation of the %(formataddr) function.  This is available for
  * programs to provide their own local implementation if they wish to do