X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/513587ec31160434400bb003d7160777e2db6bb6..582d5e802ceb8e0c7f0dc5b83fdbf2a62fc10fb3:/h/mhparse.h

diff --git a/h/mhparse.h b/h/mhparse.h
index 5d7668fb..00802d13 100644
--- a/h/mhparse.h
+++ b/h/mhparse.h
@@ -1,6 +1,4 @@
-
-/*
- * mhparse.h -- definitions for parsing/building of MIME content
+/* mhparse.h -- definitions for parsing/building of MIME content
  *           -- (mhparse.c/mhbuildsbr.c)
  */
 
@@ -87,9 +85,29 @@ struct cefile {
  * At the top level, the c_first_hf list has a list of all message
  * headers.  If the content-type is multipart (c_type == CT_MULTIPART)
  * then c_ctparams will contain a pointer to a struct multipart.
- * A struct multipart contains (among other trhings) a linked list
+ * A struct multipart contains (among other things) a linked list
  * of struct part elements, and THOSE contain a pointer to the sub-part's
  * Content structure.
+ *
+ * An extra note for message/external-body parts.  The enclosing
+ * content structure is marked as a message/external-body; the c_ctparams
+ * contains a pointer to a struct exbody, which contains a pointer to
+ * (among other things) the "real" content (e.g., application/octet-stream).
+ * The "real" content structure has the c_ctexbody pointer back to the
+ * same struct exbody sees in the enclosing content structure (the struct
+ * exbody contains parent pointers if you need to traverse up the content
+ * structure).  Hopefully this makes it clearer:
+ *
+ * Enclosing content:
+ *   Type: message/external-body
+ *   c_ctparams: pointer to "struct exbody"
+ *   c_ctexbody: NULL
+ *
+ * "Real" content:
+ *   Type: application/octet-stream (or whatever)
+ *   c_ctparams: NULL
+ *   c_ctexbody: pointer to "struct exbody"
+ *
  */
 struct Content {
     /* source (read) file */
@@ -141,7 +159,7 @@ struct Content {
     SizeCEFunc  c_cesizefnx;	/* size of decoded contents          */
 
     int	c_umask;		/* associated umask                  */
-    int	c_rfc934;		/* rfc934 compatibility flag         */
+    int	c_rfc934;		/* RFC 934 compatibility flag        */
 
     char *c_showproc;		/* default, if not in profile        */
     char *c_termproc;		/* for charset madness...            */
@@ -397,7 +415,7 @@ int list_content(CT ct, int toplevel, int realsize, int verbose, int debug,
 		 int dispo);
 
 /*
- * Display content-appropriate information on MIME parts, decending recursively
+ * Display content-appropriate information on MIME parts, descending recursively
  * into multipart content if appropriate.  Uses list_content() for displaying
  * generic information.
  *
@@ -427,6 +445,21 @@ int list_switch(CT ct, int toplevel, int realsize, int verbose, int debug,
 char *output_params(size_t initialwidth, PM params, int *offsetout,
 		    int external);
 
+/*
+ * Encode a parameter value using RFC 2231 encode.
+ *
+ * Arguments are:
+ *
+ * pm           - PM containing the parameter value and related info.
+ * output       - Output buffer.
+ * len          - Size, in octets, of output buffer.
+ * valuelen     - Number of characters in the value
+ * valueoff     - Offset into value field (pm->pm_value).
+ * index        - If 0, output character set and language tag.
+ */
+size_t encode_param(PM pm, char *output, size_t len, size_t valuelen,
+                    size_t valueoff, int index);
+
 /*
  * Add a parameter to the parameter linked list.
  *
@@ -503,7 +536,7 @@ char *get_param_value(PM pm, char replace);
  * inlineonly	- If true, only display MIME parts that are marked with
  *		  a disposition of "inline" (includes parts that lack a
  *		  Content-Disposition header).
- * markerform	- The name of a file containg mh-format(5) code used to
+ * markerform	- The name of a file containing mh-format(5) code used to
  *		  display markers about non-displayed MIME parts.
  */
 void show_all_messages(CT *cts, int concat, int textonly, int inlineonly);