Remove unused NCWD and NPWD #defines.

[nmh] / h / prototypes.h

diff --git a/h/prototypes.h b/h/prototypes.h
index 26666eaee872a01816ec8ab97cb69e2478929eca..a17d12f9cbad6d2a7109e9f3f03535a65ec926c2 100644 (file)
--- a/h/prototypes.h
+++ b/h/prototypes.h
@@ -18,34 +18,63 @@ char *etcpath(char *);
 struct msgs_array;
 
 void add_profile_entry (const char *, const char *);
 struct msgs_array;
 
 void add_profile_entry (const char *, const char *);

-void adios (char *, char *, ...) NORETURN;
+void adios (const char *, const char *, ...) NORETURN;

 void admonish (char *, char *, ...);
 void admonish (char *, char *, ...);

-void advertise (char *, char *, char *, va_list);
-void advise (char *, char *, ...);
+void advertise (const char *, char *, const char *, va_list);
+void advise (const char *, const char *, ...);

 char **argsplit (char *, char **, int *);
 void argsplit_msgarg (struct msgs_array *, char *, char **);
 void argsplit_insert (struct msgs_array *, char *, char **);
 void arglist_free (char *, char **);
 char **argsplit (char *, char **, int *);
 void argsplit_msgarg (struct msgs_array *, char *, char **);
 void argsplit_insert (struct msgs_array *, char *, char **);
 void arglist_free (char *, char **);

-void ambigsw (char *, struct swit *);
+void ambigsw (const char *, const struct swit *);

 int atooi(char *);
 char **brkstring (char *, char *, char *);
 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_find_prefix(const char *);

 int context_foil (char *);
 void context_read (void);
 void context_replace (char *, char *);
 void context_save (void);
 char *copy (const char *, char *);
 char **copyip (char **, char **, int);
 int context_foil (char *);
 void context_read (void);
 void context_replace (char *, char *);
 void context_save (void);
 char *copy (const char *, char *);
 char **copyip (char **, char **, int);

-void cpydata (int, int, char *, char *);
+void cpydata (int, int, const char *, const char *);

 void cpydgst (int, int, char *, char *);
 char *cpytrim (const 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);
 
 /*


@@ -90,15 +119,57 @@ int folder_pack (struct msgs **, int);
 struct msgs *folder_read (char *name, int lockflag);
 
 struct msgs *folder_realloc (struct msgs *, int, int);
 struct msgs *folder_read (char *name, int lockflag);
 
 struct msgs *folder_realloc (struct msgs *, int, int);

-int gans (char *, struct swit *);
-char **getans (char *, struct swit *);
+
+/*
+ * Flush standard output, read a line from standard input into a static buffer,
+ * zero out the newline, and return a pointer to the buffer.
+ * On error, return NULL.
+ */
+const char *read_line(void);
+
+/*
+ * Print null-terminated PROMPT to and flush standard output.  Read answers from
+ * standard input until one matches an entry in SWITCHES.  When one matches,
+ * return its swret field.  Return 0 on EOF.
+ */
+int read_switch(const char *PROMPT, const struct swit *SWITCHES);
+
+/*
+ * If standard input is not a tty, return 1 without printing anything.  Else,
+ * print null-terminated PROMPT to and flush standard output.  Read answers from
+ * standard input until one is "yes" or "no", returning 1 for "yes" and 0 for
+ * "no".  Also return 0 on EOF.
+ */
+int read_yes_or_no_if_tty(const char *PROMPT);
+
+/*
+ * Print null-terminated PROMPT to and flush standard output.  Read multi-word
+ * answers from standard input until a first word matches an entry in SWITCHES.
+ * When one matches, return a pointer to an array of pointers to the words.
+ * Return NULL on EOF, interrupt, or other error.
+ */
+char **read_switch_multiword(const char *PROMPT, const struct swit *SWITCHES);
+
+/*
+ * Same as read_switch_multiword but using readline(3) for input.
+ */

 #ifdef READLINE_SUPPORT
 #ifdef READLINE_SUPPORT

-char **getans_via_readline (char *, struct swit *);
+char **read_switch_multiword_via_readline (char *, struct swit *);

 #endif /* READLINE_SUPPORT */
 #endif /* READLINE_SUPPORT */

-int getanswer (char *);
+

 char **getarguments (char *, int, char **, int);
 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 *);
+
+/* Return malloc'd copy of str, or of "" if NULL, exit on failure. */
+char *getcpy(const char *str);
+

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


@@ -164,21 +235,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 *);
 int m_atoi (char *);

-char *m_backup (char *);
+char *m_backup (const char *);

 int m_convert (struct msgs *, char *);
 char *m_draft (char *, char *, int, int *);
 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 +262,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 *);
 void m_unknown(m_getfld_state_t *, FILE *);

-int makedir (char *);
+int makedir (const char *);

 char *message_id (time_t, int);
 
 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);


@@ -208,18 +317,34 @@ int pidwait (pid_t, int);
 int pidstatus (int, FILE *, char *);
 char *pluspath(char *);
 void print_help (char *, struct swit *, int);
 int pidstatus (int, FILE *, char *);
 char *pluspath(char *);
 void print_help (char *, struct swit *, int);

-void print_sw (char *, struct swit *, char *, FILE *);
+void print_intro (FILE *, int);
+void print_sw (const char *, const struct swit *, char *, FILE *);

 void print_version (char *);
 void push (void);
 char *pwd (void);
 char *r1bindex(char *, int);
 void print_version (char *);
 void push (void);
 char *pwd (void);
 char *r1bindex(char *, int);

-void readconfig (struct node **, FILE *, char *, int);
+void readconfig (struct node **, FILE *, const char *, int);

 int refile (char **, char *);
 int refile (char **, char *);

-void ruserpass (char *, char **, char **);
+
+/*
+ * Read our credentials file and (optionally) ask the user for anything
+ * missing.
+ *
+ * Arguments:
+ *
+ * host                - Hostname (to scan credentials file)
+ * aname       - Pointer to filled-in username
+ * apass       - Pointer to filled-in password
+ * flags       - One or more of RUSERPASS_NO_PROMPT_USER,
+ *                RUSERPASS_NO_PROMPT_PASSWORD
+ */
+void ruserpass (const char *host, char **aname, char **apass, int flags);
+#define RUSERPASS_NO_PROMPT_USER       0x01
+#define RUSERPASS_NO_PROMPT_PASSWORD   0x02
+

 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,14 +369,18 @@ 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_setunseen (struct msgs *, int);
 int showfile (char **, char *);
 void seq_save (struct msgs *);
 void seq_setcur (struct msgs *, int);
 void seq_setprev (struct msgs *);
 void seq_setunseen (struct msgs *, int);
 int showfile (char **, char *);

-int smatch(char *, struct swit *);
+int smatch(const char *, const struct swit *);

 
 /*
  * Convert a set of bit flags to printable format.
 
 /*
  * Convert a set of bit flags to printable format.


@@ -286,7 +415,7 @@ int smatch(char *, struct swit *);
  * from least significant bit to most significant.
  */
 char *snprintb (char *buffer, size_t size, unsigned flags, char *bitfield);
  * from least significant bit to most significant.
  */
 char *snprintb (char *buffer, size_t size, unsigned flags, char *bitfield);

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

 int stringdex (char *, char *);
 char *trimcpy (char *);
 int unputenv (char *);
 int stringdex (char *, char *);
 char *trimcpy (char *);
 int unputenv (char *);


@@ -307,8 +436,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,17 +470,103 @@ 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, const char *);

 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 *);
+
+/* Includes trailing NUL */
+
+#define BASE64SIZE(x) ((((x + 2) / 3) * 4) + 1)
+
+/*
+ * 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 writeBase64aux(FILE *in, FILE *out, int crlf);
+
+int writeBase64 (const unsigned char *, size_t, unsigned char *);
+int writeBase64raw (const unsigned char *, size_t, unsigned char *);
+
+/*
+ * encoded      - the string to be decoded
+ * decoded      - the decoded bytes
+ * len          - number of decoded bytes
+ * skip-crs     - non-zero for text content, and for which CR's should be
+ *                skipped
+ * digest       - for an MD5 digest, it can be null
+ */
+int decodeBase64 (const char *encoded, unsigned char **decoded, size_t *len,
+                  int skip_crs, unsigned char *digest);
+
+void hexify (const unsigned char *, size_t, char **);

 
 /*
  * credentials management
  */
 void init_credentials_file ();
 
 /*
  * credentials management
  */
 void init_credentials_file ();

-int nmh_get_credentials (char *, char *, int, nmh_creds_t);
+
+/*
+ * Allocate and return a credentials structure.  The credentials structure
+ * is now opaque; you need to use accessors to get inside of it.  The
+ * accessors will only prompt the user for missing fields if they are
+ * needed.
+ *
+ * Arguments:
+ *
+ * host        - Hostname we're connecting to (used to search credentials file)
+ * user        - Username we are logging in as; can be NULL.
+ *
+ * Returns NULL on error, otherwise an allocated nmh_creds structure.
+ */
+nmh_creds_t nmh_get_credentials (const char *host, const char *user);
+
+/*
+ * Retrieve the user from a nmh_creds structure.  May prompt the user
+ * if one is not defined.
+ *
+ * Arguments:
+ *
+ * creds       - Structure from previous nmh_get_credentials() call
+ *
+ * Returns NULL on error, otherwise a NUL-termined string containing
+ * the username.  Points to allocated memory in the credentials structure
+ * that is free()d by nmh_free_credentials().
+ */
+const char *nmh_cred_get_user(nmh_creds_t creds);
+
+/*
+ * Retrieve the password from an nmh_creds structure.  Otherwise identical
+ * to nmh_cred_get_user().
+ */
+const char *nmh_cred_get_password(nmh_creds_t creds);
+
+/*
+ * Free an allocated nmh_creds structure.
+ */
+void nmh_credentials_free(nmh_creds_t creds);
+
+/*
+ * program initialization
+ *
+ * argv0        - argv[0], presumably the program name
+ * read_context - 0: don't read context
+ *              - 1: read context, check nmh version, and issue warning message
+ *                   if non-existent or old
+ *              - 2: read context, don't check nmh version
+ */
+int nmh_init(const char *argv0, int read_context);
+
+/*
+ * temporary file management
+ */
+int m_unlink(const char *);
+void unregister_for_removal(int remove_files);