]> diplodocus.org Git - nmh/blobdiff - h/mhparse.h
Part 1 of merging sbr/norm_charmap.c into sbr/check_charset.c.
[nmh] / h / mhparse.h
index 3efec9cb62dff37b2d8ab1aa364313f6c9365dab..256586f370844ec886d43884b1f1be60dbce8855 100644 (file)
@@ -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...            */
@@ -193,6 +211,10 @@ struct Content {
 /* Structure for text content */
 struct text {
     int        tx_charset;             /* flag for character set */
+    int lf_line_endings;        /* Whether to use CR LF (0) or LF (1) line
+                                   endings.  The meaning of 0 was selected so
+                                   that CR LF is the default, in accordance
+                                   with RFC 2046, Sec. 4.1.1, Par. 1. */
 };
 
 /*
@@ -335,7 +357,6 @@ int get_ctinfo (char *, CT, int);
 int params_external (CT, int);
 int open7Bit (CT, char **);
 void close_encoding (CT);
-void free_content (CT);
 char *ct_type_str (int);
 char *ct_subtype_str (int, int);
 int ct_str_type (const char *);
@@ -344,7 +365,6 @@ const struct str2init *get_ct_init (int);
 const char *ce_str (int);
 const struct str2init *get_ce_method (const char *);
 char *content_charset (CT);
-int convert_charset (CT, char *, int *);
 void reverse_alternative_parts (CT);
 
 /*
@@ -393,7 +413,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.
  *
@@ -423,6 +443,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.
  *
@@ -486,49 +521,6 @@ char *get_param(PM first, const char *name, char replace, int fetchonly);
  */
 char *get_param_value(PM pm, char replace);
 
-/*
- * Display MIME message(s) on standard out.
- *
- * Arguments are:
- *
- * cts         - NULL terminated array of CT structures for messages
- *               to display
- * concat      - If true, concatenate all MIME parts.  If false, show each
- *               MIME part under a separate pager.
- * textonly    - If true, only display "text" MIME parts
- * 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
- *               display markers about non-displayed MIME parts.
- */
-void show_all_messages(CT *cts, int concat, int textonly, int inlineonly);
-
-/*
- * Display (or store) a single MIME part using the specified command
- *
- * Arguments are:
- *
- * ct          - The Content structure of the MIME part we wish to display
- * alternate   - Set this to true if this is one part of a MIME
- *               multipart/alternative part.  Will suppress some errors and
- *               will cause the function to return DONE instead of OK on
- *               success.
- * cp          - The command string to execute.  Will be run through the
- *               parser for %-escapes as described in mhshow(1).
- * cracked     - If set, chdir() to this directory before executing the
- *               command in "cp".  Only used by mhstore(1).
- * fmt         - A series of mh-format(5) instructions to execute if the
- *               command string indicates a marker is desired.  Can be NULL.
- *
- * Returns NOTOK if we could not display the part, DONE if alternate was
- * set and we could display the part, and OK if alternate was not set and
- * we could display the part.
- */
-struct format;
-int show_content_aux(CT ct, int alternate, char *cp, char *cracked,
-                    struct format *fmt);
-
 extern int checksw;    /* Add Content-MD5 field */
 
 /*