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