Added NMH_ADDL_CPPFLAGS macro in new m4/cppflags.m4, to remove

[nmh] / h / fmt_scan.h

diff --git a/h/fmt_scan.h b/h/fmt_scan.h
index d50dc4416ae813ae8b44c603c3c3d3ad7c23a32e..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
 /*
  * 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
  * 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


@@ -89,7 +89,7 @@ struct format {
 
 typedef char * (*formataddr_cb)(char *, char *);
 typedef char * (*concataddr_cb)(char *, char *);
 
 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;
 
 struct fmt_callbacks {
     formataddr_cb      formataddr;


@@ -114,6 +114,12 @@ struct fmt_callbacks {
 
 char *new_fs (char *form, char *format, char *default_fs);
 
 
 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:
  *
 /*
  * Compile a format string into a set of format instructions.  Arguments are:
  *


@@ -123,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
  *               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.
  *               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.


@@ -138,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()
  * 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
  * 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


@@ -169,8 +175,8 @@ int fmt_compile (char *fstring, struct format **fmt, int reset);
  * execute, which is currently always NULL.
  */
 
  * 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:
 
 /*
  * Free a format structure and/or component hash table.  Arguments are:


@@ -237,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
  *                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).
  *               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).