pending-release-notes: add mhshow's "-prefer", and mh-format's %(kibi/kilo)

[nmh] / h / prototypes.h

diff --git a/h/prototypes.h b/h/prototypes.h
index 74e663196ab0ed96678226e217f7ae4f4db5b6b2..3399384ea8a6671d6746e0de0be6f910ee21f10c 100644 (file)
--- a/h/prototypes.h
+++ b/h/prototypes.h
@@ -29,12 +29,25 @@ void arglist_free (char *, char **);
 void ambigsw (char *, struct swit *);
 int atooi(char *);
 char **brkstring (char *, char *, char *);
 void ambigsw (char *, struct swit *);
 int atooi(char *);
 char **brkstring (char *, char *, char *);

+
+/*
+ * Check to see if we can display a given character set natively.
+ * Arguments include:
+ *
+ * str - Name of character set to check against
+ * len - Length of "str"
+ *
+ * Returns 1 if the specified character set can be displayed natively,
+ * 0 otherwise.
+ */
+

 int check_charset (char *, int);
 int client(char *, char *, char *, int, int);
 void closefds(int);
 char *concat (const char *, ...);
 int context_del (char *);
 int check_charset (char *, int);
 int client(char *, char *, char *, int, int);
 void closefds(int);
 char *concat (const char *, ...);
 int context_del (char *);

-char *context_find (char *);
+char *context_find (const char *);
+char *context_find_by_type (const char *, const char *, const char *);

 int context_foil (char *);
 void context_read (void);
 void context_replace (char *, char *);
 int context_foil (char *);
 void context_read (void);
 void context_replace (char *, char *);


@@ -44,8 +57,23 @@ char **copyip (char **, char **, int);
 void cpydata (int, int, char *, char *);
 void cpydgst (int, int, char *, char *);
 char *cpytrim (const char *);
 void cpydata (int, int, char *, char *);
 void cpydgst (int, int, char *, char *);
 char *cpytrim (const char *);

+char *rtrim (char *);

 int decode_rfc2047 (char *, char *, size_t);
 void discard (FILE *);
 int decode_rfc2047 (char *, char *, size_t);
 void discard (FILE *);

+char *upcase (const char *);
+
+/*
+ * Decode two characters into their quoted-printable representation.
+ *
+ * Arguments are:
+ *
+ * byte1       - First character of Q-P representation
+ * byte2       - Second character of Q-P representation
+ *
+ * Returns the decoded value, -1 if the conversion failed.
+ */
+int decode_qp(unsigned char byte1, unsigned char byte2);
+

 int default_done (int);
 
 /*
 int default_done (int);
 
 /*


@@ -97,7 +125,15 @@ char **getans_via_readline (char *, struct swit *);
 #endif /* READLINE_SUPPORT */
 int getanswer (char *);
 char **getarguments (char *, int, char **, int);
 #endif /* READLINE_SUPPORT */
 int getanswer (char *);
 char **getarguments (char *, int, char **, int);

+
+/*
+ * Returns the MIME character set indicated by the current locale setting.
+ * Should be used by routines that want to convert to/from the local
+ * character set, or if you want to check to see if you can display content
+ * in the local character set.
+ */

 char *get_charset(void);
 char *get_charset(void);

+

 char *getcpy (const char *);
 char *get_default_editor(void);
 char *getfolder(int);
 char *getcpy (const char *);
 char *get_default_editor(void);
 char *getfolder(int);


@@ -164,21 +200,21 @@ int get_term_numcap(char *capability);
  *
  * Files opened for reading are locked with a read lock (if possible by
  * the underlying lock mechanism), files opened for writing are locked
  *
  * Files opened for reading are locked with a read lock (if possible by
  * the underlying lock mechanism), files opened for writing are locked

- * using an exclusive lock.
+ * using an exclusive lock.  The int * argument is used to indicate failure
+ * to acquire a lock.

  */
 int lkclosedata(int, const char *);
 int lkclosespool(int, const char *);
 int lkfclosedata(FILE *, const char *);
 int lkfclosespool(FILE *, const char *);
  */
 int lkclosedata(int, const char *);
 int lkclosespool(int, const char *);
 int lkfclosedata(FILE *, const char *);
 int lkfclosespool(FILE *, const char *);

-FILE *lkfopendata(const char *, const char *);
-int lkopendata(const char *, int, mode_t);
+FILE *lkfopendata(const char *, const char *, int *);
+int lkopendata(const char *, int, mode_t, int *);

 FILE *lkfopenspool(const char *, const char *);
 FILE *lkfopenspool(const char *, const char *);

-int lkopenspool(const char *, int, mode_t);
+int lkopenspool(const char *, int, mode_t, int *);

 int m_atoi (char *);
 char *m_backup (char *);
 int m_convert (struct msgs *, char *);
 char *m_draft (char *, char *, int, int *);
 int m_atoi (char *);
 char *m_backup (char *);
 int m_convert (struct msgs *, char *);
 char *m_draft (char *, char *, int, int *);

-void m_eomsbr (m_getfld_state_t, int (*)(int));

 void m_getfld_state_reset (m_getfld_state_t *);
 void m_getfld_state_destroy (m_getfld_state_t *);
 void m_getfld_track_filepos (m_getfld_state_t *, FILE *);
 void m_getfld_state_reset (m_getfld_state_t *);
 void m_getfld_state_destroy (m_getfld_state_t *);
 void m_getfld_track_filepos (m_getfld_state_t *, FILE *);


@@ -191,16 +227,54 @@ int m_putenv (char *, char *);
 int m_rand (unsigned char *, size_t);
 char *m_mktemp(const char *, int *, FILE **);
 char *m_mktemp2(const char *, const char *, int *, FILE **);
 int m_rand (unsigned char *, size_t);
 char *m_mktemp(const char *, int *, FILE **);
 char *m_mktemp2(const char *, const char *, int *, FILE **);

+char *m_mktemps(const char *pfx, const char *suffix, int *, FILE **);
+char *get_temp_dir();
+
+/*
+ * Create a subprocess and redirect our standard output to it.
+ *
+ * Arguments are:
+ *
+ * name                - Name of process to create
+ * savestdout  - If true, will save the current stdout file descriptor and
+ *               m_pclose() will close it at the appropriate time.
+ */
+void m_popen(char *name, int savestdout);
+
+/*
+ * Wait for the last process opened by m_popen().
+ */
+void m_pclose(void);
+

 void m_unknown(m_getfld_state_t *, FILE *);
 int makedir (char *);
 char *message_id (time_t, int);
 
 void m_unknown(m_getfld_state_t *, FILE *);
 int makedir (char *);
 char *message_id (time_t, int);
 

+/*
+ * Return a MIME content-type string for the specified file.
+ *
+ * If the system supports it, will use the "file" command to determine
+ * the appropriate content-type.  Otherwise it will try to determine the
+ * content-type from the suffix.  If that fails, the file will be scanned
+ * and either assigned a MIME type of text/plain or application/octet-stream
+ * depending if binary content is present.
+ *
+ * Arguments:
+ *
+ * filename    - The name of the file to determine the MIME type of.
+ *
+ * Returns a pointer to a content-type string (which may include MIME
+ * parameters, such as charset).  Returns a NULL if it cannot determine
+ * the MIME type of the file.  Returns allocated storage that must be
+ * free'd.
+ */
+char *mime_type(const char *filename);
+

 /*
  * Clear the screen, using the appropriate entry from the terminfo database
  */
 void nmh_clear_screen(void);
 char *nmh_getpass(const char *);
 /*
  * Clear the screen, using the appropriate entry from the terminfo database
  */
 void nmh_clear_screen(void);
 char *nmh_getpass(const char *);

-char *norm_charmap(char *);

 char *new_fs (char *, char *, char *);
 char *path(char *, int);
 int peekc(FILE *ib);
 char *new_fs (char *, char *, char *);
 char *path(char *, int);
 int peekc(FILE *ib);


@@ -219,7 +293,6 @@ void ruserpass (char *, char **, char **);
 int remdir (char *);
 void scan_detect_mbox_style (FILE *);
 void scan_finished ();
 int remdir (char *);
 void scan_detect_mbox_style (FILE *);
 void scan_finished ();

-void scan_eom_action (int (*)());

 void scan_reset_m_getfld_state ();
 int seq_addmsg (struct msgs *, char *, int, int, int);
 int seq_addsel (struct msgs *, char *, int, int);
 void scan_reset_m_getfld_state ();
 int seq_addmsg (struct msgs *, char *, int, int, int);
 int seq_addsel (struct msgs *, char *, int, int);


@@ -244,8 +317,12 @@ void seq_printall (struct msgs *);
  *               and a pointer to the filehandle will be stored in
  *               folder structure, where it will later be used by
  *               seq_save().
  *               and a pointer to the filehandle will be stored in
  *               folder structure, where it will later be used by
  *               seq_save().

+ *
+ * Return values:
+ *     OK       - successfully read the sequence files, or they don't exist
+ *     NOTOK    - failed to lock sequence file

  */
  */

-void seq_read (struct msgs * mp, int lockflag);
+int seq_read (struct msgs * mp, int lockflag);

 void seq_save (struct msgs *);
 void seq_setcur (struct msgs *, int);
 void seq_setprev (struct msgs *);
 void seq_save (struct msgs *);
 void seq_setcur (struct msgs *, int);
 void seq_setprev (struct msgs *);


@@ -307,8 +384,13 @@ int unputenv (char *);
  *
  */
 void unquote_string(const char *input, char *output);
  *
  */
 void unquote_string(const char *input, char *output);

-int uprf (char *, char *);
+int uprf (const char *, const char *);

 int vfgets (FILE *, char **);
 int vfgets (FILE *, char **);

+
+/*
+ * Output the local character set name, but make sure it is suitable for
+ * 8-bit characters.
+ */

 char *write_charset_8bit (void);
 
 
 char *write_charset_8bit (void);
 
 


@@ -336,25 +418,37 @@ int sc_length(void);
 int sc_width(void);
 int build_form (char *, char *, int *, char *, char *, char *, char *,
                char *, char *);
 int sc_width(void);
 int build_form (char *, char *, int *, char *, char *, char *, char *,
                char *, char *);

-int sendsbr (char **, int, char *, char *, struct stat *, int, char *, int);
+int sendsbr (char **, int, char *, char *, struct stat *, int);

 int SOprintf (char *, ...);
 int what_now (char *, int, int, char *, char *,
        int, struct msgs *, char *, int, char *, int);
 int WhatNow(int, char **);
 int SOprintf (char *, ...);
 int what_now (char *, int, int, char *, char *,
        int, struct msgs *, char *, int, char *, int);
 int WhatNow(int, char **);

-int writeBase64aux(FILE *, FILE *);
-int writeBase64 (unsigned char *, size_t, unsigned char *);
-int writeBase64raw (unsigned char *, size_t, unsigned char *);

 
 /*
 
 /*

- * prototypes to support whatnow attach
+ * Copy data from one file to another, converting to base64-encoding.
+ *
+ * Arguments include:
+ *
+ * in          - Input filehandle (unencoded data)
+ * out         - Output filename (base64-encoded data)
+ * crlf                - If set, output encoded CRLF for every LF on input.
+ *
+ * Returns OK on success, NOTOK otherwise.

  */
  */

-int   attach(char *, char *, char *, size_t, char *, size_t, int);
-void  clean_up_temporary_files(const char *, const char *);
-char *mime_type (const char *);
+int writeBase64aux(FILE *in, FILE *out, int crlf);

 
 

+int writeBase64 (unsigned char *, size_t, unsigned char *);
+int writeBase64raw (unsigned char *, size_t, unsigned char *);

 
 /*
  * credentials management
  */
 void init_credentials_file ();
 int nmh_get_credentials (char *, char *, int, nmh_creds_t);
 
 /*
  * credentials management
  */
 void init_credentials_file ();
 int nmh_get_credentials (char *, char *, int, nmh_creds_t);

+
+/*
+ * temporary file management
+ */
+int nmh_init(const char *argv0, int read_context);
+int m_unlink(const char *);
+void unregister_for_removal(int remove_files);