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