]> diplodocus.org Git - nmh/blobdiff - h/mhparse.h
picksbr.c: Remove some else after break in plist().
[nmh] / h / mhparse.h
index c2ba18a2ac138f402c2c8d5cba7572e35eabc8ca..00802d1341390e2412d49a006a61c0ac1c3b9ab8 100644 (file)
@@ -1,12 +1,10 @@
-
-/*
- * mhparse.h -- definitions for parsing/building of MIME content
+/* mhparse.h -- definitions for parsing/building of MIME content
  *           -- (mhparse.c/mhbuildsbr.c)
  */
 
 #define        NPARTS  50
 #define        NTYPES  20
  *           -- (mhparse.c/mhbuildsbr.c)
  */
 
 #define        NPARTS  50
 #define        NTYPES  20
-#define        NPARMS  10
+#define        NPREFS  20
 
 /*
  * Abstract type for header fields
 
 /*
  * Abstract type for header fields
@@ -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.
  * 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.
  * 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 */
  */
 struct Content {
     /* source (read) file */
@@ -141,7 +159,7 @@ struct Content {
     SizeCEFunc  c_cesizefnx;   /* size of decoded contents          */
 
     int        c_umask;                /* associated umask                  */
     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...            */
 
     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 */
 /* 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. */
 };
 
 /*
 };
 
 /*
@@ -205,6 +227,7 @@ struct text {
 #define        MULTI_ALTERNATE 0x02
 #define        MULTI_DIGEST    0x03
 #define        MULTI_PARALLEL  0x04
 #define        MULTI_ALTERNATE 0x02
 #define        MULTI_DIGEST    0x03
 #define        MULTI_PARALLEL  0x04
+#define        MULTI_RELATED   0x05
 
 /* Structure for subparts of a multipart content */
 struct part {
 
 /* Structure for subparts of a multipart content */
 struct part {
@@ -337,11 +360,14 @@ void close_encoding (CT);
 void free_content (CT);
 char *ct_type_str (int);
 char *ct_subtype_str (int, int);
 void free_content (CT);
 char *ct_type_str (int);
 char *ct_subtype_str (int, int);
+int ct_str_type (const char *);
+int ct_str_subtype (int, const char *);
 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 *);
 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);
 
 /*
  * Given a content structure, return true if the content has a disposition
 
 /*
  * Given a content structure, return true if the content has a disposition
@@ -389,7 +415,7 @@ int list_content(CT ct, int toplevel, int realsize, int verbose, int debug,
                 int dispo);
 
 /*
                 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.
  *
  * into multipart content if appropriate.  Uses list_content() for displaying
  * generic information.
  *
@@ -419,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);
 
 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.
  *
 /*
  * Add a parameter to the parameter linked list.
  *
@@ -495,7 +536,44 @@ 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).
  * 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 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);
 
  */
 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 */
 extern int checksw;    /* Add Content-MD5 field */
+
+/*
+ * mhstore
+ * Put it here because it uses the CT typedef.
+ */
+typedef struct mhstoreinfo *mhstoreinfo_t;
+mhstoreinfo_t mhstoreinfo_create(CT *, char *, const char *, int, int);
+int mhstoreinfo_files_not_clobbered(const mhstoreinfo_t);
+void mhstoreinfo_free(mhstoreinfo_t);
+void store_all_messages (mhstoreinfo_t);