mhmisc.c: Indent with "%*s" rather than "%*.*s".

[nmh] / h / prototypes.h

diff --git a/h/prototypes.h b/h/prototypes.h
index a6c412e2ff09e6ed53394a98f73a393259632016..7cce0ba75048431f16ec7a6ccd20a1e5918774a8 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.


@@ -18,10 +16,11 @@ 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 *, ...);
+void inform(char *fmt, ...) CHECK_PRINTF(1, 2);
+void adios (const char *, const char *, ...) CHECK_PRINTF(2, 3) 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 *);
 void argsplit_msgarg (struct msgs_array *, char *, char **);
 void argsplit_insert (struct msgs_array *, char *, char **);
 char **argsplit (char *, char **, int *);
 void argsplit_msgarg (struct msgs_array *, char *, char **);
 void argsplit_insert (struct msgs_array *, char *, char **);


@@ -53,7 +52,6 @@ int context_foil (char *);
 void context_read (void);
 void context_replace (char *, char *);
 void context_save (void);
 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 +59,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.


@@ -167,7 +164,9 @@ char **getarguments (char *, int, char **, int);
  */
 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);
 


@@ -203,7 +202,7 @@ char *get_term_stringcap(char *capability);
  * arg1..argN  - Arguments 1-N.
  *
  * Returns a tparm and tputs-processed string, or NULL if there was a problem
  * 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.
+ * initialising the terminal or retrieving the capability.

  */
 char *get_term_stringparm(char *capability, long arg1, long arg2);
 
  */
 char *get_term_stringparm(char *capability, long arg1, long arg2);
 


@@ -222,86 +221,23 @@ char *get_term_stringparm(char *capability, long arg1, long arg2);
  */
 int get_term_numcap(char *capability);
 
  */
 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 *);
 char *m_backup (const char *);
 int m_convert (struct msgs *, char *);
 char *m_draft (char *, char *, int, int *);
 int m_atoi (char *);
 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_getfld2(m_getfld_state_t *, char[NAMESZ], char *, int *);

 int m_gmprot (void);
 int m_gmprot (void);

-char *m_maildir (char *);
-char *m_mailpath (char *);

 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);
-
-/*
- * 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);
+void m_unknown2(m_getfld_state_t *);

 
 /*
  * Clear the screen, using the appropriate entry from the terminfo database
 
 /*
  * Clear the screen, using the appropriate entry from the terminfo database


@@ -310,7 +246,6 @@ 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 *);
 int pidwait (pid_t, int);
 int pidstatus (int, FILE *, char *);
 char *pluspath(char *);


@@ -319,15 +254,29 @@ void print_intro (FILE *, int);
 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);
 void readconfig (struct node **, FILE *, const char *, int);
 int refile (char **, char *);
 char *r1bindex(char *, int);
 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 *);


@@ -400,24 +349,7 @@ char *snprintb (char *buffer, size_t size, unsigned flags, char *bitfield);
 int ssequal (const char *, const char *);
 int stringdex (char *, char *);
 char *trimcpy (char *);
 int ssequal (const char *, const char *);
 int stringdex (char *, 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 vfgets (FILE *, char **);
 
 int uprf (const char *, const char *);
 int vfgets (FILE *, char **);
 


@@ -494,22 +426,44 @@ void hexify (const unsigned char *, size_t, char **);
 /*
  * credentials management
  */
 /*
  * credentials management
  */

-void init_credentials_file ();
-int nmh_get_credentials (char *, char *, int, nmh_creds_t);
+void init_credentials_file(void);

 
 /*
 
 /*

- * program initialization
+ * 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.

  *
  *

- * 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
+ * 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-terminated 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().

  */
  */

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