diplodocus.org Git - nmh/blob - h/prototypes.h

   1 /* prototypes.h -- various prototypes
   2  *
   3  * If you modify functions here, please document their current behavior
   4  * as much as practical.
   5  */
   6
   7 /*
   8  * prototype from config.h
   9  */
  10 char *etcpath(char *) NONNULL(1);
  11
  12 /*
  13  * prototypes from the nmh subroutine library
  14  */
  15
  16 struct msgs_array;
  17
  18 /*
  19  * Check to see if we can display a given character set natively.
  20  * Arguments include:
  21  *
  22  * str  - Name of character set to check against
  23  * len  - Length of "str"
  24  *
  25  * Returns 1 if the specified character set can be displayed natively,
  26  * 0 otherwise.
  27  */
  28
  29 int check_charset (char *, int);
  30 int client(char *, char *, char *, int, int);
  31 void closefds(int);
  32 char *concat (const char *, ...) ENDNULL;
  33 int context_del (char *);
  34 char *context_find (const char *) PURE;
  35 char *context_find_by_type (const char *, const char *, const char *);
  36 int context_find_prefix(const char *) PURE;
  37 int context_foil (char *);
  38 void context_read (void);
  39 void context_replace (char *, char *);
  40 void context_save (void);
  41 char **copyip (char **, char **, int);
  42 void cpydata (int, int, const char *, const char *);
  43 void cpydgst (int, int, char *, char *);
  44 char *cpytrim (const char *);
  45 char *rtrim (char *);
  46 int decode_rfc2047 (char *, char *, size_t);
  47 void discard (FILE *);
  48
  49 /*
  50  * Decode two characters into their quoted-printable representation.
  51  *
  52  * Arguments are:
  53  *
  54  * byte1        - First character of Q-P representation
  55  * byte2        - Second character of Q-P representation
  56  *
  57  * Returns the decoded value, -1 if the conversion failed.
  58  */
  59 int decode_qp(unsigned char byte1, unsigned char byte2) CONST;
  60
  61 /*
  62  * Encode a message header using RFC 2047 encoding.  If the message contains
  63  * no non-ASCII characters, then leave the header as-is.
  64  *
  65  * Arguments include:
  66  *
  67  * name         - Message header name
  68  * value        - Message header content; must point to allocated memory
  69  *                (may be changed if encoding is necessary)
  70  * encoding     - Encoding type.  May be one of CE_UNKNOWN (function chooses
  71  *                the encoding), CE_BASE64 or CE_QUOTED
  72  * charset      - Charset used for encoding.  If NULL, obtain from system
  73  *                locale.
  74  *
  75  * Returns 0 on success, any other value on failure.
  76  */
  77
  78 int encode_rfc2047(const char *name, char **value, int encoding,
  79                    const char *charset);
  80
  81 void escape_display_name (char *, size_t);
  82 void escape_local_part (char *, size_t);
  83 int ext_hook(char *, char *, char *);
  84 int fdcompare (int, int);
  85 int folder_addmsg (struct msgs **, char *, int, int, int, int, char *);
  86 int folder_delmsgs (struct msgs *, int, int);
  87 void folder_free (struct msgs *);
  88 int folder_pack (struct msgs **, int);
  89
  90 /*
  91  * Read a MH folder structure and return an allocated "struct msgs"
  92  * corresponding to the contents of the folder.
  93  *
  94  * Arguments include:
  95  *
  96  * name         - Name of folder
  97  * lockflag     - If true, write-lock (and keep open) metadata files.
  98  *                See comments for seq_read() for more information.
  99  */
 100 struct msgs *folder_read (char *name, int lockflag);
 101
 102 struct msgs *folder_realloc (struct msgs *, int, int);
 103
 104 /*
 105  * Print null-terminated PROMPT to and flush standard output.  Read answers from
 106  * standard input until one matches an entry in SWITCHES.  When one matches,
 107  * return its swret field.  Return 0 on EOF.
 108  */
 109 int read_switch(const char *PROMPT, const struct swit *SWITCHES);
 110
 111 /*
 112  * If standard input is not a tty, return 1 without printing anything.  Else,
 113  * print null-terminated PROMPT to and flush standard output.  Read answers from
 114  * standard input until one is "yes" or "no", returning 1 for "yes" and 0 for
 115  * "no".  Also return 0 on EOF.
 116  */
 117 int read_yes_or_no_if_tty(const char *PROMPT);
 118
 119 /*
 120  * Print null-terminated PROMPT to and flush standard output.  Read multi-word
 121  * answers from standard input until a first word matches an entry in SWITCHES.
 122  * When one matches, return a pointer to an array of pointers to the words.
 123  * Return NULL on EOF, interrupt, or other error.
 124  */
 125 char **read_switch_multiword(const char *PROMPT, const struct swit *SWITCHES);
 126
 127 /*
 128  * Same as read_switch_multiword but using readline(3) for input.
 129  */
 130 #ifdef READLINE_SUPPORT
 131 char **read_switch_multiword_via_readline (char *, struct swit *);
 132 #endif /* READLINE_SUPPORT */
 133
 134 char **getarguments (char *, int, char **, int);
 135
 136 /*
 137  * Returns the MIME character set indicated by the current locale setting.
 138  * Should be used by routines that want to convert to/from the local
 139  * character set, or if you want to check to see if you can display content
 140  * in the local character set.
 141  */
 142 char *get_charset(void);
 143
 144 /* Return malloc'd copy of str, or of "" if NULL, exit on failure. */
 145 char *getcpy(const char *str);
 146
 147 char *get_default_editor(void);
 148 char *getfolder(int) PURE;
 149
 150 int m_atoi (char *) PURE;
 151 char *m_backup (const char *);
 152 int m_convert (struct msgs *, char *);
 153 char *m_draft (char *, char *, int, int *);
 154
 155 m_getfld_state_t m_getfld_state_init(FILE *iob);
 156 void m_getfld_state_reset (m_getfld_state_t *);
 157 void m_getfld_state_destroy (m_getfld_state_t *);
 158 void m_getfld_track_filepos (m_getfld_state_t *, FILE *);
 159 void m_getfld_track_filepos2(m_getfld_state_t *);
 160 int m_getfld (m_getfld_state_t *, char[NAMESZ], char *, int *, FILE *);
 161 int m_getfld2(m_getfld_state_t *, char[NAMESZ], char *, int *);
 162 int m_gmprot (void) PURE;
 163 char *m_name (int);
 164
 165 void m_unknown(m_getfld_state_t *, FILE *);
 166 void m_unknown2(m_getfld_state_t *);
 167
 168 char *nmh_getpass(const char *);
 169 int pidwait (pid_t, int);
 170 char *r1bindex(char *, int) PURE;
 171 int refile (char **, char *);
 172
 173 /*
 174  * Read our credentials file and (optionally) ask the user for anything
 175  * missing.
 176  *
 177  * Arguments:
 178  *
 179  * host         - Hostname (to scan credentials file)
 180  * aname        - Pointer to filled-in username
 181  * apass        - Pointer to filled-in password
 182  * flags        - One or more of RUSERPASS_NO_PROMPT_USER,
 183  *                RUSERPASS_NO_PROMPT_PASSWORD
 184  */
 185 void ruserpass (const char *host, char **aname, char **apass, int flags);
 186 #define RUSERPASS_NO_PROMPT_USER        0x01
 187 #define RUSERPASS_NO_PROMPT_PASSWORD    0x02
 188
 189 int remdir (char *);
 190 void scan_detect_mbox_style (FILE *);
 191 void scan_finished(void);
 192
 193 /*
 194  * Read the sequence files for the folder referenced in the given
 195  * struct msgs and populate the sequence entries in the struct msgs.
 196  *
 197  * Arguments:
 198  *
 199  * mp           - Folder structure to add sequence entries to
 200  * lockflag     - If true, obtain a write lock on the sequence file.
 201  *                Additionally, the sequence file will remain open
 202  *                and a pointer to the filehandle will be stored in
 203  *                folder structure, where it will later be used by
 204  *                seq_save().
 205  *
 206  * Return values:
 207  *     OK       - successfully read the sequence files, or they don't exist
 208  *     NOTOK    - failed to lock sequence file
 209  */
 210 int seq_read (struct msgs * mp, int lockflag);
 211 void seq_save (struct msgs *);
 212 void seq_setcur (struct msgs *, int);
 213 void seq_setprev (struct msgs *);
 214 void seq_setunseen (struct msgs *, int);
 215 int showfile (char **, char *);
 216 int smatch(const char *, const struct swit *) PURE;
 217
 218 /*
 219  * Convert a set of bit flags to printable format.
 220  *
 221  * Arguments:
 222  *
 223  * buffer       - Buffer to output string to.
 224  * size         - Size of buffer in bytes.  Buffer is always NUL terminated.
 225  * flags        - Binary flags to output
 226  * bitfield     - Textual representation of bits to output.  This string
 227  *                is in the following format:
 228  *
 229  *      Option byte 0x01 STRING1 0x02 STRING2 ....
 230  *
 231  * The first byte is an option byte to snprintb().  Currently the only option
 232  * supported is 0x08, which indicates that the flags should be output in
 233  * octal format; if the option byte is any other value, the flags will be
 234  * output in hexadecimal.
 235  *
 236  * After the option bytes are series of text strings, prefixed by the number
 237  * of the bit they correspond to.  For example, the bitfield string:
 238  *
 239  *      "\020\01FLAG1\02FLAG2\03FLAG3\04FLAG4"
 240  *
 241  * will output the following string if "flags" is set to 0x09:
 242  *
 243  *      0x2<FLAG1,FLAG4>
 244  *
 245  * You don't have to use octal in the bitfield string, that's just the
 246  * convention currently used by the nmh code.  The order of flags in the
 247  * bitfield string is not significant, but again, general convention is
 248  * from least significant bit to most significant.
 249  */
 250 char *snprintb (char *buffer, size_t size, unsigned flags, char *bitfield);
 251 int ssequal (const char *, const char *) PURE;
 252 int stringdex (char *, char *) PURE;
 253 char *trimcpy (char *);
 254
 255 int uprf (const char *, const char *) PURE;
 256 int vfgets (FILE *, char **);
 257
 258 /*
 259  * Output the local character set name, but make sure it is suitable for
 260  * 8-bit characters.
 261  */
 262 char *write_charset_8bit (void);
 263
 264
 265 /*
 266  * prototypes for some routines in uip
 267  */
 268 int annotate (char *, char *, char *, bool, bool, int, bool);
 269 void annolist(char *, char *, char *, int);
 270 void annopreserve(int);
 271 int mhl(int, char **);
 272 int mhlsbr(int, char **, FILE *(*)(char *));
 273 int distout (char *, char *, char *);
 274 int sendsbr (char **, int, char *, char *, struct stat *, int, const char *);
 275 int what_now (char *, int, int, char *, char *,
 276         int, struct msgs *, char *, int, char *, int);
 277 int WhatNow(int, char **) NORETURN;
 278
 279 /*
 280  * credentials management
 281  */
 282 void init_credentials_file(void);
 283
 284 /*
 285  * Allocate and return a credentials structure.  The credentials structure
 286  * is now opaque; you need to use accessors to get inside of it.  The
 287  * accessors will only prompt the user for missing fields if they are
 288  * needed.
 289  *
 290  * Arguments:
 291  *
 292  * host - Hostname we're connecting to (used to search credentials file)
 293  * user - Username we are logging in as; can be NULL.
 294  *
 295  * Returns NULL on error, otherwise an allocated nmh_creds structure.
 296  */
 297 nmh_creds_t nmh_get_credentials (const char *host, const char *user);
 298
 299 /*
 300  * Retrieve the user from a nmh_creds structure.  May prompt the user
 301  * if one is not defined.
 302  *
 303  * Arguments:
 304  *
 305  * creds        - Structure from previous nmh_get_credentials() call
 306  *
 307  * Returns NULL on error, otherwise a NUL-terminated string containing
 308  * the username.  Points to allocated memory in the credentials structure
 309  * that is free()d by nmh_free_credentials().
 310  */
 311 const char *nmh_cred_get_user(nmh_creds_t creds);
 312
 313 /*
 314  * Retrieve the password from an nmh_creds structure.  Otherwise identical
 315  * to nmh_cred_get_user().
 316  */
 317 const char *nmh_cred_get_password(nmh_creds_t creds);
 318
 319 /*
 320  * Free an allocated nmh_creds structure.
 321  */
 322 void nmh_credentials_free(nmh_creds_t creds);