]> diplodocus.org Git - nmh/blobdiff - h/mhparse.h
Replace getcpy() with mh_xstrdup() where the string isn't NULL.
[nmh] / h / mhparse.h
index ead187bea664cd08e22328baf6358f93cb3e61bd..d184e530b3b14b6c9fc2cd3ab09dcfe19e99ea96 100644 (file)
@@ -6,7 +6,7 @@
 
 #define        NPARTS  50
 #define        NTYPES  20
-#define        NPARMS  10
+#define        NPREFS  20
 
 /*
  * Abstract type for header fields
@@ -87,7 +87,7 @@ 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.
  */
@@ -141,7 +141,6 @@ struct Content {
     SizeCEFunc  c_cesizefnx;   /* size of decoded contents          */
 
     int        c_umask;                /* associated umask                  */
-    pid_t c_pid;               /* process doing display             */
     int        c_rfc934;               /* rfc934 compatibility flag         */
 
     char *c_showproc;          /* default, if not in profile        */
@@ -194,6 +193,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. */
 };
 
 /*
@@ -206,6 +209,7 @@ struct text {
 #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 {
@@ -299,7 +303,6 @@ extern struct str2init str2methods[];
 /*
  * prototypes
  */
-int pidcheck (int);
 CT parse_mime (char *);
 
 /*
@@ -322,13 +325,14 @@ CT parse_mime (char *);
  *               CE_QUOTED.
  * maxunencoded        - The maximum line length before the default encoding for
  *               text parts is quoted-printable.
+ * verbose     - If 1, output verbose information during message composition
  *
  * Returns a CT structure describing the resulting MIME message.  If the
  * -auto flag is set and a MIME-Version header is encountered, the return
  * value is NULL.
  */
 CT build_mime (char *infile, int autobuild, int dist, int directives,
-              int encoding, size_t maxunencoded);
+              int encoding, size_t maxunencoded, int verbose);
 
 int add_header (CT, char *, char *);
 int get_ctinfo (char *, CT, int);
@@ -338,9 +342,69 @@ 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 *);
+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 *);
+void reverse_alternative_parts (CT);
+
+/*
+ * Given a content structure, return true if the content has a disposition
+ * of "inline".
+ *
+ * Arguments are:
+ *
+ * ct          - Content structure to examine
+ */
+int is_inline(CT ct);
+
+/*
+ * Given a list of messages, display information about them on standard
+ * output.
+ *
+ * Arguments are:
+ *
+ * cts         - An array of CT elements of messages that need to be
+ *               displayed.  Array is terminated by a NULL.
+ * headsw      - If 1, display a column header.
+ * sizesw      - If 1, display the size of the part.
+ * verbosw     - If 1, display verbose information
+ * debugsw     - If 1, turn on debugging for the output.
+ * disposw     - If 1, display MIME part disposition information.
+ *
+ */
+void list_all_messages(CT *cts, int headsw, int sizesw, int verbosw,
+                      int debugsw, int disposw);
+
+/*
+ * List the content information of a single MIME part on stdout.
+ *
+ * Arguments are:
+ *
+ * ct          - MIME Content structure to display.
+ * toplevel    - If set, we're at the top level of a message
+ * realsize    - If set, determine the real size of the content
+ * verbose     - If set, output verbose information
+ * debug       - If set, turn on debugging for the output
+ * dispo       - If set, display MIME part disposition information.
+ *
+ * Returns OK on success, NOTOK otherwise.
+ */
+int list_content(CT ct, int toplevel, int realsize, int verbose, int debug,
+                int dispo);
+
+/*
+ * Display content-appropriate information on MIME parts, decending recursively
+ * into multipart content if appropriate.  Uses list_content() for displaying
+ * generic information.
+ *
+ * Arguments and return value are the same as list_content().
+ */
+int list_switch(CT ct, int toplevel, int realsize, int verbose, int debug,
+               int dispo);
 
 /*
  * Given a linked list of parameters, build an output string for them.  This
@@ -363,6 +427,21 @@ const struct str2init *get_ce_method (const char *);
 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.
  *
@@ -372,10 +451,23 @@ char *output_params(size_t initialwidth, PM params, int *offsetout,
  * last                - Pointer to tail of linked list
  * name                - Name of parameter
  * value       - Value of parameter
+ * nocopy      - If set, will use the pointer values directly for "name"
+ *               and "value" instead of making their own copy.  These
+ *               pointers will be free()'d later by the MIME routines, so
+ *               they should not be used after calling this function!
  *
- * Returned allocated parameter element
+ * Returns allocated parameter element
  */
-PM add_param(PM *first, PM *last, const char *name, const char *value);
+PM add_param(PM *first, PM *last, char *name, char *value, int nocopy);
+
+/*
+ * Replace (or add) a parameter to the parameter linked list.
+ *
+ * If the named parameter already exists on the parameter linked list,
+ * replace the value with the new one.  Otherwise add it to the linked
+ * list.  All parameters are identical to add_param().
+ */
+PM replace_param(PM *first, PM *last, char *name, char *value, int nocopy);
 
 /*
  * Retrieve a parameter value from a parameter linked list.  Convert to the
@@ -413,4 +505,57 @@ 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 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);
+
+/*
+ * 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 */
+
+/*
+ * 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);