runpty.c: Replace fprintf()+exit() pairs with new die().

[nmh] / h / prototypes.h

diff --git a/h/prototypes.h b/h/prototypes.h
index f06322b508c6ef0fdb91c3132a7dc7bb09d740db..ec11915adcbb214e5a50b9b5c77fb3d7ec4ec50f 100644 (file)
--- a/h/prototypes.h
+++ b/h/prototypes.h
@@ -1,6 +1,4 @@
-
-/*
- * prototypes.h -- various prototypes
+/* prototypes.h -- various prototypes

  *
  * If you modify functions here, please document their current behavior
  * as much as practical.
  *
  * If you modify functions here, please document their current behavior
  * as much as practical.


@@ -9,7 +7,7 @@
 /*
  * prototype from config.h
  */
 /*
  * prototype from config.h
  */

-char *etcpath(char *);
+char *etcpath(char *) NONNULL(1);

 
 /*
  * prototypes from the nmh subroutine library
 
 /*
  * prototypes from the nmh subroutine library


@@ -18,17 +16,19 @@ 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 (const char *, const char *, ...) NORETURN;
-void admonish (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 inform(char *fmt, ...) CHECK_PRINTF(1, 2);
+void adios (const char *, const char *, ...) CHECK_PRINTF(2, 3) NORETURN;
+void die(const char *, ...) CHECK_PRINTF(1, 2) NORETURN;
+void admonish (char *, char *, ...) CHECK_PRINTF(2, 3);
+void advertise (const char *, char *, const char *, va_list) CHECK_PRINTF(3, 0);
+void advise (const char *, const char *, ...) CHECK_PRINTF(2, 3);
+char **argsplit (char *, char **, int *) NONNULL(1, 2);
+void argsplit_msgarg (struct msgs_array *, char *, char **) NONNULL(1, 2, 3);
+void argsplit_insert (struct msgs_array *, char *, char **) NONNULL(1, 2, 3);

 void arglist_free (char *, char **);
 void arglist_free (char *, char **);

-void ambigsw (const char *, const struct swit *);
-int atooi(char *);
-char **brkstring (char *, char *, char *);
+void ambigsw (const char *, const struct swit *) NONNULL(1, 2);
+int atooi(char *) NONNULL(1) PURE;
+char **brkstring (char *, char *, char *) NONNULL(1);

 
 /*
  * Check to see if we can display a given character set natively.
 
 /*
  * Check to see if we can display a given character set natively.


@@ -44,16 +44,15 @@ char **brkstring (char *, char *, char *);
 int check_charset (char *, int);
 int client(char *, char *, char *, int, int);
 void closefds(int);
 int check_charset (char *, int);
 int client(char *, char *, char *, int, int);
 void closefds(int);

-char *concat (const char *, ...);
+char *concat (const char *, ...) ENDNULL;

 int context_del (char *);
 int context_del (char *);

-char *context_find (const char *);
+char *context_find (const char *) PURE;

 char *context_find_by_type (const char *, const char *, const char *);
 char *context_find_by_type (const char *, const char *, const char *);

-int context_find_prefix(const char *);
+int context_find_prefix(const char *) PURE;

 int context_foil (char *);
 void context_read (void);
 void context_replace (char *, char *);
 void context_save (void);
 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, const char *, const char *);
 void cpydgst (int, int, char *, char *);
 char **copyip (char **, char **, int);
 void cpydata (int, int, const char *, const char *);
 void cpydgst (int, int, char *, char *);


@@ -61,7 +60,6 @@ char *cpytrim (const char *);
 char *rtrim (char *);
 int decode_rfc2047 (char *, char *, size_t);
 void discard (FILE *);
 char *rtrim (char *);
 int decode_rfc2047 (char *, char *, size_t);
 void discard (FILE *);

-char *upcase (const char *);

 
 /*
  * Decode two characters into their quoted-printable representation.
 
 /*
  * Decode two characters into their quoted-printable representation.


@@ -73,7 +71,7 @@ char *upcase (const char *);
  *
  * Returns the decoded value, -1 if the conversion failed.
  */
  *
  * Returns the decoded value, -1 if the conversion failed.
  */

-int decode_qp(unsigned char byte1, unsigned char byte2);
+int decode_qp(unsigned char byte1, unsigned char byte2) CONST;

 
 int default_done (int);
 
 
 int default_done (int);
 


@@ -120,13 +118,6 @@ struct msgs *folder_read (char *name, int lockflag);
 
 struct msgs *folder_realloc (struct msgs *, int, int);
 
 
 struct msgs *folder_realloc (struct msgs *, int, int);
 

-/*
- * 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,
 /*
  * Print null-terminated PROMPT to and flush standard output.  Read answers from
  * standard input until one matches an entry in SWITCHES.  When one matches,


@@ -171,165 +162,60 @@ char *get_charset(void);
 char *getcpy(const char *str);
 
 char *get_default_editor(void);
 char *getcpy(const char *str);
 
 char *get_default_editor(void);

-char *getfolder(int);
-
-/*
- * Get a string from the terminfo database for the current terminal.
- *
- * Retrieve the specified terminfo capability and return a string that
- * can be output to the terminal.  The string returned has already been
- * processed by tputs(), so it is safe to output directly.  The return
- * value of this function is valid until the next call.
- *
- * Arguments:
- *
- * capability  - The name of the terminfo capability (see terminfo(5)).
- *
- * Returns a tputs-processed string, or NULL if terminal initialization failed
- * or the capability wasn't found.
- */
-char *get_term_stringcap(char *capability);
+char *getfolder(int) PURE;

 
 

-/*
- * Get a parameterized string from the terminfo database for the current
- * terminal.
- *
- * We don't yet have a standardized tparm() that will take a stdarg
- * argument.  Right now we don't want many parameters, so we only
- * take two.  Everything gets passed to tparm() as-is.  If we need
- * a capability with more arguments, we'll just add more later.
- *
- * Arguments:
- *
- * capability  - The name of the terminfo capability (see terminfo(5)).
- * arg1..argN  - Arguments 1-N.
- *
- * Returns a tparm and tputs-processed string, or NULL if there was a problem
- * initializating the terminal or retrieving the capability.
- */
-char *get_term_stringparm(char *capability, long arg1, long arg2);
-
-/*
- * Get a number from the terminfo database for the current terminal.
- *
- * Retrieve the specified terminfo capability and return the numeric
- * value of that capability from the terminfo database.
- *
- * Arguments:
- *
- * capability  - The name of the terminfo capability (see terminfo(5)).
- *
- * Returns the output of tigetnum() for that capability, or -1 if it was
- * unable to initialize the terminfo database.
- */
-int get_term_numcap(char *capability);
-
-/*
- * Lock open/close routines.
- *
- * The lk[f]opendata() functions are designed to open "data" files (anything
- * not a mail spool file) using the locking mechanism configured for data
- * files.  The lk[f]openspool() functions are for opening the mail spool
- * file, which will use the locking algorithm configured for the mail
- * spool.
- *
- * 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.  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 *);
-FILE *lkfopendata(const char *, const char *, int *);
-int lkopendata(const char *, int, mode_t, int *);
-FILE *lkfopenspool(const char *, const char *);
-int lkopenspool(const char *, int, mode_t, int *);
-int m_atoi (char *);
+int m_atoi (char *) PURE;

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

+
+m_getfld_state_t m_getfld_state_init(FILE *iob);

 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 *);

+void m_getfld_track_filepos2(m_getfld_state_t *);

 int m_getfld (m_getfld_state_t *, char[NAMESZ], char *, int *, FILE *);
 int m_getfld (m_getfld_state_t *, char[NAMESZ], char *, int *, FILE *);

-int m_gmprot (void);
-char *m_maildir (char *);
-char *m_mailpath (char *);
+int m_getfld2(m_getfld_state_t *, char[NAMESZ], char *, int *);
+int m_gmprot (void) PURE;

 char *m_name (int);
 char *m_name (int);

-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 **);
-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 (const char *);
-char *message_id (time_t, int);
+void m_unknown2(m_getfld_state_t *);

 
 

-/*
- * 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 *);
 char *new_fs (char *, char *, char *);
 char *path(char *, int);
 char *nmh_getpass(const char *);
 char *new_fs (char *, char *, char *);
 char *path(char *, int);

-int peekc(FILE *ib);

 int pidwait (pid_t, int);
 int pidstatus (int, FILE *, char *);
 char *pluspath(char *);
 void print_help (char *, struct swit *, int);
 int pidwait (pid_t, int);
 int pidstatus (int, FILE *, char *);
 char *pluspath(char *);
 void print_help (char *, struct swit *, int);

-void print_intro (FILE *, int);
+void print_intro (FILE *, bool);

 void print_sw (const char *, const struct swit *, char *, FILE *);
 void print_version (char *);
 void push (void);
 void print_sw (const char *, const struct swit *, char *, FILE *);
 void print_version (char *);
 void push (void);

-char *pwd (void);
-char *r1bindex(char *, int);
+char *r1bindex(char *, int) PURE;

 void readconfig (struct node **, FILE *, const char *, int);
 int refile (char **, char *);
 void readconfig (struct node **, FILE *, const char *, int);
 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 *);
 int remdir (char *);
 void scan_detect_mbox_style (FILE *);

-void scan_finished ();
-void scan_reset_m_getfld_state ();
+void scan_finished(void);

 int seq_addmsg (struct msgs *, char *, int, int, int);
 int seq_addsel (struct msgs *, char *, int, int);
 char *seq_bits (struct msgs *);
 int seq_addmsg (struct msgs *, char *, int, int, int);
 int seq_addsel (struct msgs *, char *, int, int);
 char *seq_bits (struct msgs *);


@@ -364,7 +250,7 @@ void seq_setcur (struct msgs *, int);
 void seq_setprev (struct msgs *);
 void seq_setunseen (struct msgs *, int);
 int showfile (char **, char *);
 void seq_setprev (struct msgs *);
 void seq_setunseen (struct msgs *, int);
 int showfile (char **, char *);

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

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


@@ -399,28 +285,11 @@ int smatch(const char *, const 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 (const char *, const char *);
-int stringdex (char *, char *);
+int ssequal (const char *, const char *) PURE;
+int stringdex (char *, char *) PURE;

 char *trimcpy (char *);
 char *trimcpy (char *);

-int unputenv (char *);

 
 

-/*
- * Remove quotes and quoted-pair sequences from RFC-5322 atoms.
- *
- * Currently the actual algorithm is simpler than it technically should
- * be: any quotes are simply eaten, unless they're preceded by the escape
- * character (\).  This seems to be sufficient for our needs for now.
- *
- * Arguments:
- *
- * input       - The input string
- * output      - The output string; is assumed to have at least as much
- *               room as the input string.  At worst the output string will
- *               be the same size as the input string; it might be smaller.
- *
- */
-void unquote_string(const char *input, char *output);
-int uprf (const char *, const char *);
+int uprf (const char *, const char *) PURE;

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


@@ -440,78 +309,63 @@ char *SystemName(void);
 /*
  * prototypes for some routines in uip
  */
 /*
  * prototypes for some routines in uip
  */

-int annotate (char *, char *, char *, int, int, int, int);
+int annotate (char *, char *, char *, bool, bool, int, bool);

 void annolist(char *, char *, char *, int);
 void annopreserve(int);
 void m_pclose(void);
 void annolist(char *, char *, char *, int);
 void annopreserve(int);
 void m_pclose(void);

-int make_intermediates(char *);

 int mhl(int, char **);
 int mhlsbr(int, char **, FILE *(*)(char *));
 int distout (char *, char *, char *);
 void replout (FILE *, char *, char *, struct msgs *, int,
        int, char *, char *, char *, int);
 int mhl(int, char **);
 int mhlsbr(int, char **, FILE *(*)(char *));
 int distout (char *, char *, char *);
 void replout (FILE *, char *, char *, struct msgs *, int,
        int, char *, char *, char *, int);

-int sc_length(void);
-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, const char *);
 int build_form (char *, char *, int *, char *, char *, char *, char *,
                char *, char *);
 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 what_now (char *, int, int, char *, char *,
        int, struct msgs *, char *, int, char *, int);

-int WhatNow(int, char **);
-
-/* Includes trailing NUL */
+int WhatNow(int, char **) NORETURN;

 
 

-#define BASE64SIZE(x) ((((x + 2) / 3) * 4) + 1)
+/*
+ * credentials management
+ */
+void init_credentials_file(void);

 
 /*
 
 /*

- * Copy data from one file to another, converting to base64-encoding.
+ * 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 include:
+ * Arguments:

  *
  *

- * in          - Input filehandle (unencoded data)
- * out         - Output filename (base64-encoded data)
- * crlf                - If set, output encoded CRLF for every LF on input.
+ * host        - Hostname we're connecting to (used to search credentials file)
+ * user        - Username we are logging in as; can be NULL.

  *
  *

- * Returns OK on success, NOTOK otherwise.
+ * Returns NULL on error, otherwise an allocated nmh_creds structure.

  */
  */

-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 *);
+nmh_creds_t nmh_get_credentials (const char *host, const char *user);

 
 /*
 
 /*

- * 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
+ * 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-terminated string containing
+ * the username.  Points to allocated memory in the credentials structure
+ * that is free()d by nmh_free_credentials().

  */
  */

-void init_credentials_file ();
-int nmh_get_credentials (char *, char *, int, nmh_creds_t);
+const char *nmh_cred_get_user(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
+ * Retrieve the password from an nmh_creds structure.  Otherwise identical
+ * to nmh_cred_get_user().

  */
  */

-int nmh_init(const char *argv0, int read_context);
+const char *nmh_cred_get_password(nmh_creds_t creds);

 
 /*
 
 /*

- * temporary file management
+ * Free an allocated nmh_creds structure.

  */
  */

-int m_unlink(const char *);
-void unregister_for_removal(int remove_files);
+void nmh_credentials_free(nmh_creds_t creds);