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