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