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