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

   1
   2 /*
   3  * prototypes.h -- various prototypes
   4  *
   5  * If you modify functions here, please document their current behavior
   6  * as much as practical.
   7  */
   8
   9 /*
  10  * prototype from config.h
  11  */
  12 char *etcpath(char *);
  13
  14 /*
  15  * prototypes from the nmh subroutine library
  16  */
  17
  18 struct msgs_array;
  19
  20 void add_profile_entry (const char *, const char *);
  21 void adios (char *, char *, ...) NORETURN;
  22 void admonish (char *, char *, ...);
  23 void advertise (char *, char *, char *, va_list);
  24 void advise (char *, char *, ...);
  25 char **argsplit (char *, char **, int *);
  26 void argsplit_msgarg (struct msgs_array *, char *, char **);
  27 void argsplit_insert (struct msgs_array *, char *, char **);
  28 void arglist_free (char *, char **);
  29 void ambigsw (char *, struct swit *);
  30 int atooi(char *);
  31 char **brkstring (char *, char *, char *);
  32 int check_charset (char *, int);
  33 int client(char *, char *, char *, int, int);
  34 void closefds(int);
  35 char *concat (const char *, ...);
  36 int context_del (char *);
  37 char *context_find (char *);
  38 int context_foil (char *);
  39 void context_read (void);
  40 void context_replace (char *, char *);
  41 void context_save (void);
  42 char *copy (const char *, char *);
  43 char **copyip (char **, char **, int);
  44 void cpydata (int, int, char *, char *);
  45 void cpydgst (int, int, char *, char *);
  46 char *cpytrim (const char *);
  47 int decode_rfc2047 (char *, char *, size_t);
  48 void discard (FILE *);
  49
  50 /*
  51  * Decode two characters into their quoted-printable representation.
  52  *
  53  * Arguments are:
  54  *
  55  * byte1        - First character of Q-P representation
  56  * byte2        - Second character of Q-P representation
  57  *
  58  * Returns the decoded value, -1 if the conversion failed.
  59  */
  60 int decode_qp(unsigned char byte1, unsigned char byte2);
  61
  62 int default_done (int);
  63
  64 /*
  65  * Encode a message header using RFC 2047 encoding.  If the message contains
  66  * no non-ASCII characters, then leave the header as-is.
  67  *
  68  * Arguments include:
  69  *
  70  * name         - Message header name
  71  * value        - Message header content; must point to allocated memory
  72  *                (may be changed if encoding is necessary)
  73  * encoding     - Encoding type.  May be one of CE_UNKNOWN (function chooses
  74  *                the encoding), CE_BASE64 or CE_QUOTED
  75  * charset      - Charset used for encoding.  If NULL, obtain from system
  76  *                locale.
  77  *
  78  * Returns 0 on success, any other value on failure.
  79  */
  80
  81 int encode_rfc2047(const char *name, char **value, int encoding,
  82                    const char *charset);
  83
  84 void escape_display_name (char *, size_t);
  85 void escape_local_part (char *, size_t);
  86 int ext_hook(char *, char *, char *);
  87 int fdcompare (int, int);
  88 int folder_addmsg (struct msgs **, char *, int, int, int, int, char *);
  89 int folder_delmsgs (struct msgs *, int, int);
  90 void folder_free (struct msgs *);
  91 int folder_pack (struct msgs **, int);
  92
  93 /*
  94  * Read a MH folder structure and return an allocated "struct msgs"
  95  * corresponding to the contents of the folder.
  96  *
  97  * Arguments include:
  98  *
  99  * name         - Name of folder
 100  * lockflag     - If true, write-lock (and keep open) metadata files.
 101  *                See comments for seq_read() for more information.
 102  */
 103 struct msgs *folder_read (char *name, int lockflag);
 104
 105 struct msgs *folder_realloc (struct msgs *, int, int);
 106 int gans (char *, struct swit *);
 107 char **getans (char *, struct swit *);
 108 #ifdef READLINE_SUPPORT
 109 char **getans_via_readline (char *, struct swit *);
 110 #endif /* READLINE_SUPPORT */
 111 int getanswer (char *);
 112 char **getarguments (char *, int, char **, int);
 113 char *get_charset(void);
 114 char *getcpy (const char *);
 115 char *get_default_editor(void);
 116 char *getfolder(int);
 117
 118 /*
 119  * Get a string from the terminfo database for the current terminal.
 120  *
 121  * Retrieve the specified terminfo capability and return a string that
 122  * can be output to the terminal.  The string returned has already been
 123  * processed by tputs(), so it is safe to output directly.  The return
 124  * value of this function is valid until the next call.
 125  *
 126  * Arguments:
 127  *
 128  * capability   - The name of the terminfo capability (see terminfo(5)).
 129  *
 130  * Returns a tputs-processed string, or NULL if terminal initialization failed
 131  * or the capability wasn't found.
 132  */
 133 char *get_term_stringcap(char *capability);
 134
 135 /*
 136  * Get a parameterized string from the terminfo database for the current
 137  * terminal.
 138  *
 139  * We don't yet have a standardized tparm() that will take a stdarg
 140  * argument.  Right now we don't want many parameters, so we only
 141  * take two.  Everything gets passed to tparm() as-is.  If we need
 142  * a capability with more arguments, we'll just add more later.
 143  *
 144  * Arguments:
 145  *
 146  * capability   - The name of the terminfo capability (see terminfo(5)).
 147  * arg1..argN   - Arguments 1-N.
 148  *
 149  * Returns a tparm and tputs-processed string, or NULL if there was a problem
 150  * initializating the terminal or retrieving the capability.
 151  */
 152 char *get_term_stringparm(char *capability, long arg1, long arg2);
 153
 154 /*
 155  * Get a number from the terminfo database for the current terminal.
 156  *
 157  * Retrieve the specified terminfo capability and return the numeric
 158  * value of that capability from the terminfo database.
 159  *
 160  * Arguments:
 161  *
 162  * capability   - The name of the terminfo capability (see terminfo(5)).
 163  *
 164  * Returns the output of tigetnum() for that capability, or -1 if it was
 165  * unable to initialize the terminfo database.
 166  */
 167 int get_term_numcap(char *capability);
 168
 169 /*
 170  * Lock open/close routines.
 171  *
 172  * The lk[f]opendata() functions are designed to open "data" files (anything
 173  * not a mail spool file) using the locking mechanism configured for data
 174  * files.  The lk[f]openspool() functions are for opening the mail spool
 175  * file, which will use the locking algorithm configured for the mail
 176  * spool.
 177  *
 178  * Files opened for reading are locked with a read lock (if possible by
 179  * the underlying lock mechanism), files opened for writing are locked
 180  * using an exclusive lock.
 181  */
 182 int lkclosedata(int, const char *);
 183 int lkclosespool(int, const char *);
 184 int lkfclosedata(FILE *, const char *);
 185 int lkfclosespool(FILE *, const char *);
 186 FILE *lkfopendata(const char *, const char *);
 187 int lkopendata(const char *, int, mode_t);
 188 FILE *lkfopenspool(const char *, const char *);
 189 int lkopenspool(const char *, int, mode_t);
 190 int m_atoi (char *);
 191 char *m_backup (char *);
 192 int m_convert (struct msgs *, char *);
 193 char *m_draft (char *, char *, int, int *);
 194 void m_eomsbr (m_getfld_state_t, int (*)(int));
 195 void m_getfld_state_reset (m_getfld_state_t *);
 196 void m_getfld_state_destroy (m_getfld_state_t *);
 197 void m_getfld_track_filepos (m_getfld_state_t *, FILE *);
 198 int m_getfld (m_getfld_state_t *, char[NAMESZ], char *, int *, FILE *);
 199 int m_gmprot (void);
 200 char *m_maildir (char *);
 201 char *m_mailpath (char *);
 202 char *m_name (int);
 203 int m_putenv (char *, char *);
 204 int m_rand (unsigned char *, size_t);
 205 char *m_mktemp(const char *, int *, FILE **);
 206 char *m_mktemp2(const char *, const char *, int *, FILE **);
 207 char *m_mktemps(const char *pfx, const char *suffix, int *, FILE **);
 208 char *get_temp_dir();
 209 void m_unknown(m_getfld_state_t *, FILE *);
 210 int makedir (char *);
 211 char *message_id (time_t, int);
 212
 213 /*
 214  * Return a MIME content-type string for the specified file.
 215  *
 216  * If the system supports it, will use the "file" command to determine
 217  * the appropriate content-type.  Otherwise it will try to determine the
 218  * content-type from the suffix.  If that fails, the file will be scanned
 219  * and either assigned a MIME type of text/plain or application/octet-stream
 220  * depending if binary content is present.
 221  *
 222  * Arguments:
 223  *
 224  * filename     - The name of the file to determine the MIME type of.
 225  *
 226  * Returns a pointer to a content-type string (which may include MIME
 227  * parameters, such as charset).  Returns a NULL if it cannot determine
 228  * the MIME type of the file.  Returns allocated storage that must be
 229  * free'd.
 230  */
 231 char *mime_type(const char *filename);
 232
 233 /*
 234  * Clear the screen, using the appropriate entry from the terminfo database
 235  */
 236 void nmh_clear_screen(void);
 237 char *nmh_getpass(const char *);
 238 char *norm_charmap(char *);
 239 char *new_fs (char *, char *, char *);
 240 char *path(char *, int);
 241 int peekc(FILE *ib);
 242 int pidwait (pid_t, int);
 243 int pidstatus (int, FILE *, char *);
 244 char *pluspath(char *);
 245 void print_help (char *, struct swit *, int);
 246 void print_sw (char *, struct swit *, char *, FILE *);
 247 void print_version (char *);
 248 void push (void);
 249 char *pwd (void);
 250 char *r1bindex(char *, int);
 251 void readconfig (struct node **, FILE *, char *, int);
 252 int refile (char **, char *);
 253 void ruserpass (char *, char **, char **);
 254 int remdir (char *);
 255 void scan_detect_mbox_style (FILE *);
 256 void scan_finished ();
 257 void scan_eom_action (int (*)());
 258 void scan_reset_m_getfld_state ();
 259 int seq_addmsg (struct msgs *, char *, int, int, int);
 260 int seq_addsel (struct msgs *, char *, int, int);
 261 char *seq_bits (struct msgs *);
 262 int seq_delmsg (struct msgs *, char *, int);
 263 int seq_delsel (struct msgs *, char *, int, int);
 264 int seq_getnum (struct msgs *, char *);
 265 char *seq_list (struct msgs *, char *);
 266 int seq_nameok (char *);
 267 void seq_print (struct msgs *, char *);
 268 void seq_printall (struct msgs *);
 269
 270 /*
 271  * Read the sequence files for the folder referenced in the given
 272  * struct msgs and populate the sequence entries in the struct msgs.
 273  *
 274  * Arguments:
 275  *
 276  * mp           - Folder structure to add sequence entries to
 277  * lockflag     - If true, obtain a write lock on the sequence file.
 278  *                Additionally, the sequence file will remain open
 279  *                and a pointer to the filehandle will be stored in
 280  *                folder structure, where it will later be used by
 281  *                seq_save().
 282  */
 283 void seq_read (struct msgs * mp, int lockflag);
 284 void seq_save (struct msgs *);
 285 void seq_setcur (struct msgs *, int);
 286 void seq_setprev (struct msgs *);
 287 void seq_setunseen (struct msgs *, int);
 288 int showfile (char **, char *);
 289 int smatch(char *, struct swit *);
 290
 291 /*
 292  * Convert a set of bit flags to printable format.
 293  *
 294  * Arguments:
 295  *
 296  * buffer       - Buffer to output string to.
 297  * size         - Size of buffer in bytes.  Buffer is always NUL terminated.
 298  * flags        - Binary flags to output
 299  * bitfield     - Textual representation of bits to output.  This string
 300  *                is in the following format:
 301  *
 302  *      Option byte 0x01 STRING1 0x02 STRING2 ....
 303  *
 304  * The first byte is an option byte to snprintb().  Currently the only option
 305  * supported is 0x08, which indicates that the flags should be output in
 306  * octal format; if the option byte is any other value, the flags will be
 307  * output in hexadecimal.
 308  *
 309  * After the option bytes are series of text strings, prefixed by the number
 310  * of the bit they correspond to.  For example, the bitfield string:
 311  *
 312  *      "\020\01FLAG1\02FLAG2\03FLAG3\04FLAG4"
 313  *
 314  * will output the following string if "flags" is set to 0x09:
 315  *
 316  *      0x2<FLAG1,FLAG4>
 317  *
 318  * You don't have to use octal in the bitfield string, that's just the
 319  * convention currently used by the nmh code.  The order of flags in the
 320  * bitfield string is not significant, but again, general convention is
 321  * from least significant bit to most significant.
 322  */
 323 char *snprintb (char *buffer, size_t size, unsigned flags, char *bitfield);
 324 int ssequal (char *, char *);
 325 int stringdex (char *, char *);
 326 char *trimcpy (char *);
 327 int unputenv (char *);
 328
 329 /*
 330  * Remove quotes and quoted-pair sequences from RFC-5322 atoms.
 331  *
 332  * Currently the actual algorithm is simpler than it technically should
 333  * be: any quotes are simply eaten, unless they're preceded by the escape
 334  * character (\).  This seems to be sufficient for our needs for now.
 335  *
 336  * Arguments:
 337  *
 338  * input        - The input string
 339  * output       - The output string; is assumed to have at least as much
 340  *                room as the input string.  At worst the output string will
 341  *                be the same size as the input string; it might be smaller.
 342  *
 343  */
 344 void unquote_string(const char *input, char *output);
 345 int uprf (char *, char *);
 346 int vfgets (FILE *, char **);
 347 char *write_charset_8bit (void);
 348
 349
 350 /*
 351  * some prototypes for address parsing system
 352  * (others are in addrsbr.h)
 353  */
 354 char *LocalName(int);
 355 char *SystemName(void);
 356
 357 /*
 358  * prototypes for some routines in uip
 359  */
 360 int annotate (char *, char *, char *, int, int, int, int);
 361 void annolist(char *, char *, char *, int);
 362 void annopreserve(int);
 363 void m_pclose(void);
 364 int make_intermediates(char *);
 365 int mhl(int, char **);
 366 int mhlsbr(int, char **, FILE *(*)(char *));
 367 int distout (char *, char *, char *);
 368 void replout (FILE *, char *, char *, struct msgs *, int,
 369         int, char *, char *, char *, int);
 370 int sc_length(void);
 371 int sc_width(void);
 372 int build_form (char *, char *, int *, char *, char *, char *, char *,
 373                 char *, char *);
 374 int sendsbr (char **, int, char *, char *, struct stat *, int);
 375 int SOprintf (char *, ...);
 376 int what_now (char *, int, int, char *, char *,
 377         int, struct msgs *, char *, int, char *, int);
 378 int WhatNow(int, char **);
 379
 380 /*
 381  * Copy data from one file to another, converting to base64-encoding.
 382  *
 383  * Arguments include:
 384  *
 385  * in           - Input filehandle (unencoded data)
 386  * out          - Output filename (base64-encoded data)
 387  * crlf         - If set, output encoded CRLF for every LF on input.
 388  *
 389  * Returns OK on success, NOTOK otherwise.
 390  */
 391 int writeBase64aux(FILE *in, FILE *out, int crlf);
 392
 393 int writeBase64 (unsigned char *, size_t, unsigned char *);
 394 int writeBase64raw (unsigned char *, size_t, unsigned char *);
 395
 396 /*
 397  * credentials management
 398  */
 399 void init_credentials_file ();
 400 int nmh_get_credentials (char *, char *, int, nmh_creds_t);
 401
 402 /*
 403  * temporary file management
 404  */
 405 int nmh_init(const char *argv0, int read_context);
 406 int m_unlink(const char *);
 407 void unregister_for_removal(int remove_files);