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