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