-
-/*
- * fmt_scan.h -- definitions for fmt_scan()
+/* fmt_scan.h -- definitions for fmt_scan()
*/
/*
* 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
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;
void * trace_context;
};
-/*
- * Create a new format string. Arguments are:
- *
- * form - Name of format file. Will be searched by etcpath(), see that
- * function for details.
- * format - The format string to be used if no format file is given
- * default_fs - The default format string to be used if neither form nor
- * format is given
- *
- * This function also takes care of processing \ escapes like \n, \t, etc.
- *
- * Returns an allocated format string.
- */
-
-char *new_fs (char *form, char *format, char *default_fs);
-
/*
* Compile a format string into a set of format instructions. Arguments are:
*
* 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.
* 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
+ * characters marked as non-printing or (depending on the
* encoding) bytes in a multibyte encoding that exceed the
* character's column width.
* dat - An integer array that contains data used by certain format
* 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:
* or NULL if the component is not found in the hash table.
*/
-struct comp *fmt_findcomp(char *component);
+struct comp *fmt_findcomp(char *component) PURE;
/*
* Search for a component structure in the component hash table.
* Identical to fmd_findcomp(), but is case-INSENSITIVE.
*/
-struct comp *fmt_findcasecomp(char *component);
+struct comp *fmt_findcasecomp(char *component) PURE;
/*
* Add a component entry to the component hash table
* 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).
void fmt_appendcomp(int bucket, char *component, char *text);
/*
- * The implementation of the %(formataddr) function. This is available for
- * programs to provide their own local implementation if they wish to do
- * special processing (see uip/replsbr.c for an example). Arguments are:
+ * Iterate over the complete hash table of component structures.
*
- * orig - Existing list of addresses
- * str - New address(es) to append to list.
+ * Arguments are:
*
- * This function returns an allocated string containing the new list of
- * addresses.
- */
-
-char *formataddr(char *orig, char *str);
-
-/*
- * The implementation of the %(concataddr) function. Arguments and behavior
- * are the same as %(formataddr). Again, see uip/replsbr.c to see how you
- * can override this behavior.
+ * 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.
*/
-char *concataddr(char *orig, char *str);
+struct comp *fmt_nextcomp(struct comp *comp, unsigned int *bucket);
projects / nmh / blobdiff