]> diplodocus.org Git - nmh/blobdiff - h/prototypes.h
Specify function parameters in prototypes, mainly void.
[nmh] / h / prototypes.h
index d4502fe5cc7d69985fd0ae00bb4ac6fd6e9fbb0a..a89fe734f973dbd959a016fd2b7b50cdc4d13f9e 100644 (file)
@@ -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.
@@ -18,10 +16,11 @@ char *etcpath(char *);
 struct msgs_array;
 
 void add_profile_entry (const char *, const char *);
-void adios (const char *, char *, ...) NORETURN;
+void inform(char *fmt, ...);
+void adios (const char *, const char *, ...) NORETURN;
 void admonish (char *, char *, ...);
-void advertise (const char *, char *, char *, va_list);
-void advise (const 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 **);
@@ -48,11 +47,11 @@ char *concat (const char *, ...);
 int context_del (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);
 void cpydata (int, int, const char *, const char *);
 void cpydgst (int, int, char *, char *);
@@ -166,7 +165,9 @@ char **getarguments (char *, int, char **, int);
  */
 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);
 
@@ -202,7 +203,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
- * initializating the terminal or retrieving the capability.
+ * initialising the terminal or retrieving the capability.
  */
 char *get_term_stringparm(char *capability, long arg1, long arg2);
 
@@ -255,12 +256,11 @@ int m_gmprot (void);
 char *m_maildir (char *);
 char *m_mailpath (char *);
 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();
+char *get_temp_dir(void);
 
 /*
  * Create a subprocess and redirect our standard output to it.
@@ -309,23 +309,38 @@ void nmh_clear_screen(void);
 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);
+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 readconfig (struct node **, FILE *, 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 *);
-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 *);
@@ -398,7 +413,6 @@ 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 unputenv (char *);
 
 /*
  * Remove quotes and quoted-pair sequences from RFC-5322 atoms.
@@ -450,12 +464,16 @@ 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);
+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 **);
 
+/* Includes trailing NUL */
+
+#define BASE64SIZE(x) ((((x + 2) / 3) * 4) + 1)
+
 /*
  * Copy data from one file to another, converting to base64-encoding.
  *
@@ -469,18 +487,80 @@ int WhatNow(int, 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 *);
+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 ();
-int nmh_get_credentials (char *, char *, int, nmh_creds_t);
+void init_credentials_file(void);
 
 /*
- * temporary file management
+ * 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-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().
+ */
+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);