X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/096cb902c659b224590c2989020d437721d8e9e5..8206fbf:/h/fmt_scan.h?ds=inline diff --git a/h/fmt_scan.h b/h/fmt_scan.h index a2bff891..2bcc265f 100644 --- 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 *, const char *); + +struct fmt_callbacks { + formataddr_cb formataddr; + concataddr_cb concataddr; + trace_cb trace_func; + void * trace_context; +}; + /* * Create a new format string. Arguments are: * @@ -121,11 +138,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 @@ -140,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); +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: @@ -158,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: * @@ -178,7 +209,7 @@ struct comp *fmt_findcomp(char *component); * Identical to fmd_findcomp(), but is case-INSENSITIVE. */ -struct comp *fmt_findcasecmp(char *component); +struct comp *fmt_findcasecomp(char *component); /* * Add a component entry to the component hash table @@ -236,6 +267,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