More cleaned and conversion to the new parameter API.

[nmh] / h / mhparse.h

diff --git a/h/mhparse.h b/h/mhparse.h
index 3c0756de3bec49892bf592f389edfe5f6f7fca69..160838168af3763a38f74a3dd85c9e9fe0178941 100644 (file)
--- a/h/mhparse.h
+++ b/h/mhparse.h
@@ -341,7 +341,28 @@ char *ct_subtype_str (int, int);
 const struct str2init *get_ct_init (int);
 const char *ce_str (int);
 const struct str2init *get_ce_method (const char *);
-int parse_header_attrs (const char *, int, char **, CI, int *);
+
+/*
+ * Parse a series of MIME attributes (or parameters) given a header as
+ * input.
+ *
+ * Arguments include:
+ *
+ * filename    - Name of input file (for error messages)
+ * fieldname   - Name of field being processed
+ * headerp     - Pointer to pointer of the beginning of the MIME attributes.
+ *               Updated to point to end of attributes when finished.
+ * param_head  - Pointer to head of parameter list
+ * param_tail  - Pointer to tail of parameter list
+ * commentp    - Pointer to header comment pointer (may be NULL)
+ *
+ * Returns OK if parsing was successful, NOTOK if parsing failed, and
+ * DONE to indicate a benign error (minor parsing error, but the program
+ * should continue).
+ */
+int parse_header_attrs (const char *filename, const char *fieldname,
+                       char **headerp, PM *param_head, PM *param_tail,
+                       char **commentp);
 
 /*
  * Given a linked list of parameters, build an output string for them.  This
@@ -355,10 +376,63 @@ int parse_header_attrs (const char *, int, char **, CI, int *);
  * params      - Pointer to head of linked list of parameters.
  * offsetout   - The final line offset after all the parameters have been
  *               output.  May be NULL.
- *
+ * external    - If set, outputting an external-body type and will not
+ *               output a "body" parameter.
+ 
  * Returns a pointer to the resulting parameter string.  This string must
  * be free()'d by the caller.  Returns NULL on error.
  */
-char *output_params(size_t initialwidth, PM params, int *offsetout);
+char *output_params(size_t initialwidth, PM params, int *offsetout,
+                   int external);
+
+/*
+ * Add a parameter to the parameter linked list.
+ *
+ * Arguments are:
+ *
+ * first       - Pointer to head of linked list
+ * last                - Pointer to tail of linked list
+ * name                - Name of parameter
+ * value       - Value of parameter
+ *
+ * Returned allocated parameter element
+ */
+PM add_param(PM *first, PM *last, const char *name, const char *value);
+
+/*
+ * Retrieve a parameter value from a parameter linked list.  Convert to the
+ * local character set if required.
+ *
+ * Arguments are:
+ *
+ * first       - Pointer to head of parameter linked list.
+ * name                - Name of parameter.
+ * replace     - If characters in the parameter list cannot be converted to
+ *               the local character set, replace with this character.
+ * fetchonly   - If true, return pointer to original value, no conversion
+ *               performed.
+ *
+ * Returns parameter value if found, NULL otherwise.  Memory must be free()'d
+ * unless fetchonly is set.
+ */
+
+char *get_param(PM first, const char *name, char replace, int fetchonly);
+
+/*
+ * Fetch a parameter value from a parameter structure, converting it to
+ * the local character set.
+ *
+ * Arguments are:
+ *
+ * pm          - Pointer to parameter structure
+ * replace     - If characters in the parameter list cannot be converted to
+ *               the local character set, replace with this character.
+ *
+ * Returns a pointer to the parameter value.  Memory is stored in an
+ * internal buffer, so the returned value is only valid until the next
+ * call to get_param_value() or get_param() (get_param() uses get_param_value()
+ * internally).
+ */
+char *get_param_value(PM pm, char replace);
 
 extern int checksw;    /* Add Content-MD5 field */