extern.h

   1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
   2  *@ Exported function prototypes.
   3  *
   4  * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
   5  * Copyright (c) 2012 - 2014 Steffen "Daode" Nurpmeso <sdaoden@users.sf.net>.
   6  */
   7 /*-
   8  * Copyright (c) 1992, 1993
   9  * The Regents of the University of California.  All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. All advertising materials mentioning features or use of this software
  20  *    must display the following acknowledgement:
  21  *    This product includes software developed by the University of
  22  *    California, Berkeley and its contributors.
  23  * 4. Neither the name of the University nor the names of its contributors
  24  *    may be used to endorse or promote products derived from this software
  25  *    without specific prior written permission.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  37  * SUCH DAMAGE.
  38  */
  39
  40 /*
  41  * TODO Convert optional utility+ functions to n_*(); ditto
  42  * TODO else use generic module-specific prefixes: str_(), am[em]_, sm[em]_, ..
  43  */
  44 /* TODO s-it-mode: not really (docu, funnames, funargs, etc) */
  45
  46 #undef FL
  47 #ifndef HAVE_AMALGAMATION
  48 # define FL                      extern
  49 #else
  50 # define FL                      static
  51 #endif
  52
  53 /*
  54  * acmava.c
  55  */
  56
  57 /* Don't use _var_* unless you *really* have to! */
  58
  59 /* Constant option key look/(un)set/clear */
  60 FL char *   _var_oklook(enum okeys okey);
  61 #define ok_blook(C)              (_var_oklook(CONCAT(ok_b_, C)) != NULL)
  62 #define ok_vlook(C)              _var_oklook(CONCAT(ok_v_, C))
  63
  64 FL bool_t   _var_okset(enum okeys okey, uintptr_t val);
  65 #define ok_bset(C,B)             _var_okset(CONCAT(ok_b_, C), (uintptr_t)(B))
  66 #define ok_vset(C,V)             _var_okset(CONCAT(ok_v_, C), (uintptr_t)(V))
  67
  68 FL bool_t   _var_okclear(enum okeys okey);
  69 #define ok_bclear(C)             _var_okclear(CONCAT(ok_b_, C))
  70 #define ok_vclear(C)             _var_okclear(CONCAT(ok_v_, C))
  71
  72 /* Variable option key look/(un)set/clear */
  73 FL char *   _var_voklook(char const *vokey);
  74 #define vok_blook(S)              (_var_voklook(S) != NULL)
  75 #define vok_vlook(S)              _var_voklook(S)
  76
  77 FL bool_t   _var_vokset(char const *vokey, uintptr_t val);
  78 #define vok_bset(S,B)            _var_vokset(S, (uintptr_t)(B))
  79 #define vok_vset(S,V)            _var_vokset(S, (uintptr_t)(V))
  80
  81 FL bool_t   _var_vokclear(char const *vokey);
  82 #define vok_bclear(S)            _var_vokclear(S)
  83 #define vok_vclear(S)            _var_vokclear(S)
  84
  85 /* List all variables */
  86 FL void     var_list_all(void);
  87
  88 FL int      c_var_inspect(void *v);
  89 FL int      c_define(void *v);
  90 FL int      c_undef(void *v);
  91 FL int      c_call(void *v);
  92
  93 FL int      callhook(char const *name, int nmail);
  94
  95 /* List all macros */
  96 FL int      c_defines(void *v);
  97
  98 /* `account' */
  99 FL int      c_account(void *v);
 100
 101 /* `localopts' */
 102 FL int      c_localopts(void *v);
 103
 104 /*
 105  * attachments.c
 106  */
 107
 108 /* Try to add an attachment for *file*, file_expand()ed.
 109  * Return the new head of list *aphead*, or NULL.
 110  * The newly created attachment will be stored in **newap*, if given */
 111 FL struct attachment *  add_attachment(struct attachment *aphead, char *file,
 112                            struct attachment **newap);
 113
 114 /* Append comma-separated list of file names to the end of attachment list */
 115 FL struct attachment *  append_attachments(struct attachment *aphead,
 116                            char *names);
 117
 118 /* Interactively edit the attachment list, return the new list head */
 119 FL struct attachment *  edit_attachments(struct attachment *aphead);
 120
 121 /*
 122  * auxlily.c
 123  */
 124
 125 /* Announce a fatal error (and die) */
 126 FL void        panic(char const *format, ...);
 127 FL void        alert(char const *format, ...);
 128
 129 /* Provide BSD-like signal() on all (POSIX) systems */
 130 FL sighandler_type safe_signal(int signum, sighandler_type handler);
 131
 132 /* Hold *all* signals but SIGCHLD, and release that total block again */
 133 FL void        hold_all_sigs(void);
 134 FL void        rele_all_sigs(void);
 135
 136 /* Hold HUP/QUIT/INT */
 137 FL void        hold_sigs(void);
 138 FL void        rele_sigs(void);
 139
 140 FL void        touch(struct message *mp);
 141 FL int         is_dir(char const *name);
 142 FL int         argcount(char **argv);
 143 FL char *      colalign(const char *cp, int col, int fill,
 144                   int *cols_decr_used_or_null);
 145
 146 /* Get our PAGER */
 147 FL char const *get_pager(void);
 148
 149 /* Check wether using a pager is possible/makes sense and is desired by user
 150  * (*crt* set); return number of screen lines (or *crt*) if so, 0 otherwise */
 151 FL size_t      paging_seems_sensible(void);
 152
 153 /* Use a pager or STDOUT to print *fp*; if *lines* is 0, they'll be counted */
 154 FL void        page_or_print(FILE *fp, size_t lines);
 155 #define try_pager(FP)            page_or_print(FP, 0) /* TODO obsolete */
 156
 157 FL enum protocol  which_protocol(const char *name);
 158
 159 /* Hash the passed string -- uses Chris Torek's hash algorithm */
 160 FL ui32_t      torek_hash(char const *name);
 161 #define hash(S)                  (torek_hash(S) % HSHSIZE) /* xxx COMPAT (?) */
 162
 163 FL unsigned    pjw(const char *cp);
 164 FL long        nextprime(long n);
 165
 166 /* Check wether *s is an escape sequence, expand it as necessary.
 167  * Returns the expanded sequence or 0 if **s is NUL or PROMPT_STOP if it is \c.
 168  * *s is advanced to after the expanded sequence (as possible).
 169  * If use_prompt_extensions is set, an enum prompt_exp may be returned */
 170 FL int         expand_shell_escape(char const **s,
 171                   bool_t use_prompt_extensions);
 172
 173 /* Get *prompt*, or '& ' if *bsdcompat*, of '? ' otherwise */
 174 FL char *      getprompt(void);
 175
 176 /* Detect and query the hostname to use */
 177 FL char *      nodename(int mayoverride);
 178
 179 /* Try to lookup a variable named "password-*token*".
 180  * Return NULL or salloc()ed buffer */
 181 FL char *      lookup_password_for_token(char const *token);
 182
 183 /* Get a (pseudo) random string of *length* bytes; returns salloc()ed buffer */
 184 FL char *      getrandstring(size_t length);
 185
 186 #define Hexchar(n)               ((n)>9 ? (n)-10+'A' : (n)+'0')
 187 #define hexchar(n)               ((n)>9 ? (n)-10+'a' : (n)+'0')
 188
 189 #ifdef HAVE_MD5
 190 /* Store the MD5 checksum as a hexadecimal string in *hex*, *not* terminated */
 191 # define MD5TOHEX_SIZE           32
 192 FL char *      md5tohex(char hex[MD5TOHEX_SIZE], void const *vp);
 193
 194 /* CRAM-MD5 encode the *user* / *pass* / *b64* combo */
 195 FL char *      cram_md5_string(char const *user, char const *pass,
 196                   char const *b64);
 197 #endif
 198
 199 FL enum okay   makedir(const char *name);
 200 FL enum okay   cwget(struct cw *cw);
 201 FL enum okay   cwret(struct cw *cw);
 202 FL void        cwrelse(struct cw *cw);
 203 FL void        makeprint(struct str const *in, struct str *out);
 204 FL char *      prstr(const char *s);
 205 FL int         prout(const char *s, size_t sz, FILE *fp);
 206
 207 /* Print out a Unicode character or a substitute for it, return 0 on error or
 208  * wcwidth() (or 1) on success */
 209 FL size_t      putuc(int u, int c, FILE *fp);
 210
 211 /* We want coloured output (in this salloc() cycle).  If pager_used is not NULL
 212  * we check against *colour-pagers* wether colour is really desirable */
 213 #ifdef HAVE_COLOUR
 214 FL void        colour_table_create(char const *pager_used);
 215 FL void        colour_put(FILE *fp, enum colourspec cs);
 216 FL void        colour_put_header(FILE *fp, char const *name);
 217 FL void        colour_reset(FILE *fp);
 218 FL struct str const * colour_get(enum colourspec cs);
 219 #else
 220 # define colour_put(FP,CS)
 221 # define colour_put_header(FP,N)
 222 # define colour_reset(FP)
 223 #endif
 224
 225 /* Update *tc* to now; only .tc_time updated unless *full_update* is true */
 226 FL void        time_current_update(struct time_current *tc,
 227                   bool_t full_update);
 228
 229 /* Memory allocation routines */
 230 #ifdef HAVE_DEBUG
 231 # define SMALLOC_DEBUG_ARGS      , char const *mdbg_file, int mdbg_line
 232 # define SMALLOC_DEBUG_ARGSCALL  , mdbg_file, mdbg_line
 233 #else
 234 # define SMALLOC_DEBUG_ARGS
 235 # define SMALLOC_DEBUG_ARGSCALL
 236 #endif
 237
 238 FL void *      smalloc(size_t s SMALLOC_DEBUG_ARGS);
 239 FL void *      srealloc(void *v, size_t s SMALLOC_DEBUG_ARGS);
 240 FL void *      scalloc(size_t nmemb, size_t size SMALLOC_DEBUG_ARGS);
 241
 242 #ifdef HAVE_DEBUG
 243 FL void        sfree(void *v SMALLOC_DEBUG_ARGS);
 244 /* Called by sreset(), then */
 245 FL void        smemreset(void);
 246 /* The *smemtrace* command */
 247 FL int         smemtrace(void *v);
 248 # if 0
 249 #  define MEMCHECK
 250 FL bool_t      _smemcheck(char const *file, int line);
 251 # endif
 252
 253 # define smalloc(SZ)             smalloc(SZ, __FILE__, __LINE__)
 254 # define srealloc(P,SZ)          srealloc(P, SZ, __FILE__, __LINE__)
 255 # define scalloc(N,SZ)           scalloc(N, SZ, __FILE__, __LINE__)
 256 # define free(P)                 sfree(P, __FILE__, __LINE__)
 257 # define smemcheck()             _smemcheck(__FILE__, __LINE__)
 258 #endif
 259
 260 /* cache.c */
 261 #ifdef HAVE_IMAP
 262 FL enum okay   getcache1(struct mailbox *mp, struct message *m,
 263                   enum needspec need, int setflags);
 264 FL enum okay   getcache(struct mailbox *mp, struct message *m,
 265                   enum needspec need);
 266 FL void        putcache(struct mailbox *mp, struct message *m);
 267 FL void        initcache(struct mailbox *mp);
 268 FL void        purgecache(struct mailbox *mp, struct message *m, long mc);
 269 FL void        delcache(struct mailbox *mp, struct message *m);
 270 FL enum okay   cache_setptr(int transparent);
 271 FL enum okay   cache_list(struct mailbox *mp, const char *base, int strip,
 272                   FILE *fp);
 273 FL enum okay   cache_remove(const char *name);
 274 FL enum okay   cache_rename(const char *old, const char *new);
 275 FL unsigned long cached_uidvalidity(struct mailbox *mp);
 276 FL FILE *      cache_queue(struct mailbox *mp);
 277 FL enum okay   cache_dequeue(struct mailbox *mp);
 278 #endif /* HAVE_IMAP */
 279
 280 /* cmd1.c */
 281 FL int         ccmdnotsupp(void *v);
 282 FL int         headers(void *v);
 283 FL int         scroll(void *v);
 284 FL int         Scroll(void *v);
 285 FL int         screensize(void);
 286 FL int         from(void *v);
 287
 288 /* Print all message in between bottom and topx (including bottom) */
 289 FL void        print_headers(size_t bottom, size_t topx);
 290
 291 FL int         pdot(void *v);
 292 FL int         more(void *v);
 293 FL int         More(void *v);
 294 FL int         type(void *v);
 295 FL int         Type(void *v);
 296 FL int         show(void *v);
 297 FL int         pipecmd(void *v);
 298 FL int         Pipecmd(void *v);
 299 FL int         top(void *v);
 300 FL int         stouch(void *v);
 301 FL int         mboxit(void *v);
 302 FL int         folders(void *v);
 303
 304 /* cmd2.c */
 305 FL int         next(void *v);
 306 FL int         save(void *v);
 307 FL int         Save(void *v);
 308 FL int         copycmd(void *v);
 309 FL int         Copycmd(void *v);
 310 FL int         cmove(void *v);
 311 FL int         cMove(void *v);
 312 FL int         cdecrypt(void *v);
 313 FL int         cDecrypt(void *v);
 314 FL int         cwrite(void *v);
 315 FL int         delete(void *v);
 316 FL int         deltype(void *v);
 317 FL int         undeletecmd(void *v);
 318 FL int         retfield(void *v);
 319 FL int         igfield(void *v);
 320 FL int         saveretfield(void *v);
 321 FL int         saveigfield(void *v);
 322 FL int         fwdretfield(void *v);
 323 FL int         fwdigfield(void *v);
 324 FL int         unignore(void *v);
 325 FL int         unretain(void *v);
 326 FL int         unsaveignore(void *v);
 327 FL int         unsaveretain(void *v);
 328 FL int         unfwdignore(void *v);
 329 FL int         unfwdretain(void *v);
 330
 331 /* cmd3.c */
 332 FL int         shell(void *v);
 333 FL int         dosh(void *v);
 334 FL int         help(void *v);
 335
 336 /* Print user's working directory */
 337 FL int         c_cwd(void *v);
 338
 339 /* Change user's working directory */
 340 FL int         c_chdir(void *v);
 341
 342 FL int         respond(void *v);
 343 FL int         respondall(void *v);
 344 FL int         respondsender(void *v);
 345 FL int         followup(void *v);
 346 FL int         followupall(void *v);
 347 FL int         followupsender(void *v);
 348 FL int         preserve(void *v);
 349 FL int         unread(void *v);
 350 FL int         seen(void *v);
 351 FL int         messize(void *v);
 352 FL int         rexit(void *v);
 353 /* Set or display a variable value.  Syntax is similar to that of sh */
 354 FL int         set(void *v);
 355 FL int         unset(void *v);
 356 FL int         group(void *v);
 357 FL int         ungroup(void *v);
 358 FL int         cfile(void *v);
 359 FL int         echo(void *v);
 360 FL int         Respond(void *v);
 361 FL int         Followup(void *v);
 362 FL int         forwardcmd(void *v);
 363 FL int         Forwardcmd(void *v);
 364
 365 /* if.else.endif conditional execution */
 366 FL int         c_if(void *v);
 367 FL int         c_else(void *v);
 368 FL int         c_endif(void *v);
 369
 370 FL int         alternates(void *v);
 371 FL int         resendcmd(void *v);
 372 FL int         Resendcmd(void *v);
 373 FL int         newmail(void *v);
 374 FL int         shortcut(void *v);
 375 FL struct shortcut *get_shortcut(const char *str);
 376 FL int         unshortcut(void *v);
 377 FL int         cflag(void *v);
 378 FL int         cunflag(void *v);
 379 FL int         canswered(void *v);
 380 FL int         cunanswered(void *v);
 381 FL int         cdraft(void *v);
 382 FL int         cundraft(void *v);
 383 FL int         cnoop(void *v);
 384 FL int         cremove(void *v);
 385 FL int         crename(void *v);
 386
 387 /* collect.c */
 388
 389 FL FILE *      collect(struct header *hp, int printheaders, struct message *mp,
 390                   char *quotefile, int doprefix);
 391
 392 FL void        savedeadletter(FILE *fp, int fflush_rewind_first);
 393
 394 /* dotlock.c */
 395 FL int         fcntl_lock(int fd, int type);
 396 FL int         dot_lock(const char *fname, int fd, int pollinterval, FILE *fp,
 397                   const char *msg);
 398 FL void        dot_unlock(const char *fname);
 399
 400 /* edit.c */
 401 FL int         editor(void *v);
 402 FL int         visual(void *v);
 403 FL FILE *      run_editor(FILE *fp, off_t size, int type, int readonly,
 404                   struct header *hp, struct message *mp,
 405                   enum sendaction action, sighandler_type oldint);
 406
 407 /*
 408  * filter.c
 409  */
 410
 411 /* Quote filter */
 412 FL struct quoteflt * quoteflt_dummy(void); /* TODO LEGACY */
 413 FL void        quoteflt_init(struct quoteflt *self, char const *prefix);
 414 FL void        quoteflt_destroy(struct quoteflt *self);
 415 FL void        quoteflt_reset(struct quoteflt *self, FILE *f);
 416 FL ssize_t     quoteflt_push(struct quoteflt *self,
 417                   char const *dat, size_t len);
 418 FL ssize_t     quoteflt_flush(struct quoteflt *self);
 419
 420 /* fio.c */
 421
 422 /* fgets() replacement to handle lines of arbitrary size and with embedded \0
 423  * characters.
 424  * *line* - line buffer. *line be NULL.
 425  * *linesize* - allocated size of line buffer.
 426  * *count* - maximum characters to read. May be NULL.
 427  * *llen* - length_of_line(*line).
 428  * *fp* - input FILE.
 429  * *appendnl* - always terminate line with \n, append if necessary.
 430  */
 431 FL char *      fgetline(char **line, size_t *linesize, size_t *count,
 432                   size_t *llen, FILE *fp, int appendnl SMALLOC_DEBUG_ARGS);
 433 #ifdef HAVE_DEBUG
 434 # define fgetline(A,B,C,D,E,F)   \
 435    fgetline(A, B, C, D, E, F, __FILE__, __LINE__)
 436 #endif
 437
 438 /* Read up a line from the specified input into the linebuffer.
 439  * Return the number of characters read.  Do not include the newline at EOL.
 440  * *n* is the number of characters already read.
 441  */
 442 FL int         readline_restart(FILE *ibuf, char **linebuf, size_t *linesize,
 443                   size_t n SMALLOC_DEBUG_ARGS);
 444 #ifdef HAVE_DEBUG
 445 # define readline_restart(A,B,C,D) \
 446    readline_restart(A, B, C, D, __FILE__, __LINE__)
 447 #endif
 448
 449 /* Read a complete line of input, with editing if interactive and possible.
 450  * If prompt is NULL we'll call getprompt() first, if necessary.
 451  * nl_escape defines wether user can escape newlines via backslash (POSIX).
 452  * If string is set it is used as the initial line content if in interactive
 453  * mode, otherwise this argument is ignored for reproducibility.
 454  * Return number of octets or a value <0 on error */
 455 FL int         readline_input(char const *prompt, bool_t nl_escape,
 456                   char **linebuf, size_t *linesize, char const *string
 457                   SMALLOC_DEBUG_ARGS);
 458 #ifdef HAVE_DEBUG
 459 # define readline_input(A,B,C,D,E) readline_input(A,B,C,D,E,__FILE__,__LINE__)
 460 #endif
 461
 462 /* Read a line of input, with editing if interactive and possible, return it
 463  * savestr()d or NULL in case of errors or if an empty line would be returned.
 464  * This may only be called from toplevel (not during sourcing).
 465  * If prompt is NULL we'll call getprompt() if necessary.
 466  * If string is set it is used as the initial line content if in interactive
 467  * mode, otherwise this argument is ignored for reproducibility */
 468 FL char *      readstr_input(char const *prompt, char const *string);
 469
 470 FL void        setptr(FILE *ibuf, off_t offset);
 471 FL int         putline(FILE *obuf, char *linebuf, size_t count);
 472 FL FILE *      setinput(struct mailbox *mp, struct message *m,
 473                   enum needspec need);
 474 FL struct message * setdot(struct message *mp);
 475 FL int         rm(char *name);
 476 FL off_t       fsize(FILE *iob);
 477
 478 /* Evaluate the string given as a new mailbox name. Supported meta characters:
 479  * %  for my system mail box
 480  * %user for user's system mail box
 481  * #  for previous file
 482  * &  invoker's mbox file
 483  * +file file in folder directory
 484  * any shell meta character
 485  * Returns the file name as an auto-reclaimed string */
 486 FL char *      fexpand(char const *name, enum fexp_mode fexpm);
 487
 488 #define expand(N)                fexpand(N, FEXP_FULL)   /* XXX obsolete */
 489 #define file_expand(N)           fexpand(N, FEXP_LOCAL)  /* XXX obsolete */
 490
 491 /* Get rid of queued mail */
 492 FL void        demail(void);
 493
 494 /* vars.c hook: *folder* variable has been updated; if *folder* shouldn't be
 495  * replaced by something else, leave *store* alone, otherwise smalloc() the
 496  * desired value (ownership will be taken) */
 497 FL bool_t      var_folder_updated(char const *folder, char **store);
 498
 499 /* Determine the current *folder* name, store it in *name* */
 500 FL bool_t      getfold(char *name, size_t size);
 501
 502 FL char const * getdeadletter(void);
 503
 504 FL enum okay   get_body(struct message *mp);
 505
 506 #ifdef HAVE_SOCKETS
 507 FL int         sclose(struct sock *sp);
 508 FL enum okay   swrite(struct sock *sp, const char *data);
 509 FL enum okay   swrite1(struct sock *sp, const char *data, int sz,
 510                   int use_buffer);
 511 FL enum okay   sopen(const char *xserver, struct sock *sp, int use_ssl,
 512                   const char *uhp, const char *portstr, int verbose);
 513
 514 /*  */
 515 FL int         sgetline(char **line, size_t *linesize, size_t *linelen,
 516                   struct sock *sp SMALLOC_DEBUG_ARGS);
 517 # ifdef HAVE_DEBUG
 518 #  define sgetline(A,B,C,D)      sgetline(A, B, C, D, __FILE__, __LINE__)
 519 # endif
 520 #endif
 521
 522 /* Deal with loading of resource files and dealing with a stack of files for
 523  * the source command */
 524
 525 /* Load a file of user definitions */
 526 FL void        load(char const *name);
 527
 528 /* Pushdown current input file and switch to a new one.  Set the global flag
 529  * *sourcing* so that others will realize that they are no longer reading from
 530  * a tty (in all probability) */
 531 FL int         csource(void *v);
 532
 533 /* Pop the current input back to the previous level.  Update the *sourcing*
 534  * flag as appropriate */
 535 FL int         unstack(void);
 536
 537 /* head.c */
 538
 539 /* Fill in / reedit the desired header fields */
 540 FL int         grab_headers(struct header *hp, enum gfield gflags,
 541                   int subjfirst);
 542
 543 /* Return the user's From: address(es) */
 544 FL char const * myaddrs(struct header *hp);
 545 /* Boil the user's From: addresses down to a single one, or use *sender* */
 546 FL char const * myorigin(struct header *hp);
 547
 548 /* See if the passed line buffer, which may include trailing newline (sequence)
 549  * is a mail From_ header line according to RFC 4155 */
 550 FL int         is_head(char const *linebuf, size_t linelen);
 551
 552 /* Savage extract date field from From_ line.  *linelen* is convenience as line
 553  * must be terminated (but it may end in a newline [sequence]).
 554  * Return wether the From_ line was parsed successfully */
 555 FL int         extract_date_from_from_(char const *line, size_t linelen,
 556                   char datebuf[FROM_DATEBUF]);
 557
 558 FL void        extract_header(FILE *fp, struct header *hp);
 559 #define hfieldX(a, b)            hfield_mult(a, b, 1)
 560 #define hfield1(a, b)            hfield_mult(a, b, 0)
 561 FL char *      hfield_mult(char const *field, struct message *mp, int mult);
 562 FL char const * thisfield(char const *linebuf, char const *field);
 563 FL char *      nameof(struct message *mp, int reptype);
 564 FL char const * skip_comment(char const *cp);
 565 FL char const * routeaddr(char const *name);
 566 FL int         is_addr_invalid(struct name *np, int putmsg);
 567
 568 /* Does *NP* point to a file or pipe addressee? */
 569 #define is_fileorpipe_addr(NP)   \
 570    (((NP)->n_flags & NAME_ADDRSPEC_ISFILEORPIPE) != 0)
 571
 572 /* Return skinned version of *NP*s name */
 573 #define skinned_name(NP)         \
 574    (assert((NP)->n_flags & NAME_SKINNED), \
 575    ((struct name const*)NP)->n_name)
 576
 577 /* Skin an address according to the RFC 822 interpretation of "host-phrase" */
 578 FL char *      skin(char const *name);
 579
 580 /* Skin *name* and extract the *addr-spec* according to RFC 5322.
 581  * Store the result in .ag_skinned and also fill in those .ag_ fields that have
 582  * actually been seen.
 583  * Return 0 if something good has been parsed, 1 if fun didn't exactly know how
 584  * to deal with the input, or if that was plain invalid */
 585 FL int         addrspec_with_guts(int doskin, char const *name,
 586                   struct addrguts *agp);
 587
 588 FL char *      realname(char const *name);
 589 FL char *      name1(struct message *mp, int reptype);
 590 FL int         msgidcmp(const char *s1, const char *s2);
 591 FL int         is_ign(char const *field, size_t fieldlen,
 592                   struct ignoretab ignore[2]);
 593 FL int         member(char const *realfield, struct ignoretab *table);
 594 FL char const * fakefrom(struct message *mp);
 595 FL char const * fakedate(time_t t);
 596 FL time_t      unixtime(char const *from);
 597 FL time_t      rfctime(char const *date);
 598 FL time_t      combinetime(int year, int month, int day,
 599                   int hour, int minute, int second);
 600 FL void        substdate(struct message *m);
 601 FL int         check_from_and_sender(struct name *fromfield,
 602                   struct name *senderfield);
 603 FL char *      getsender(struct message *m);
 604
 605 /* imap.c */
 606 #ifdef HAVE_IMAP
 607 FL char const * imap_fileof(char const *xcp);
 608 FL enum okay   imap_noop(void);
 609 FL enum okay   imap_select(struct mailbox *mp, off_t *size, int *count,
 610                   const char *mbx);
 611 FL int         imap_setfile(const char *xserver, int nmail, int isedit);
 612 FL enum okay   imap_header(struct message *m);
 613 FL enum okay   imap_body(struct message *m);
 614 FL void        imap_getheaders(int bot, int top);
 615 FL void        imap_quit(void);
 616 FL enum okay   imap_undelete(struct message *m, int n);
 617 FL enum okay   imap_unread(struct message *m, int n);
 618 FL int         imap_imap(void *vp);
 619 FL int         imap_newmail(int nmail);
 620 FL enum okay   imap_append(const char *xserver, FILE *fp);
 621 FL void        imap_folders(const char *name, int strip);
 622 FL enum okay   imap_copy(struct message *m, int n, const char *name);
 623 FL enum okay   imap_search1(const char *spec, int f);
 624 FL int         imap_thisaccount(const char *cp);
 625 FL enum okay   imap_remove(const char *name);
 626 FL enum okay   imap_rename(const char *old, const char *new);
 627 FL enum okay   imap_dequeue(struct mailbox *mp, FILE *fp);
 628 FL int         cconnect(void *vp);
 629 FL int         cdisconnect(void *vp);
 630 FL int         ccache(void *vp);
 631 FL int         disconnected(const char *file);
 632 FL void        transflags(struct message *omessage, long omsgCount,
 633                   int transparent);
 634 FL time_t      imap_read_date_time(const char *cp);
 635 FL const char * imap_make_date_time(time_t t);
 636 #else
 637 # define imap_imap               ccmdnotsupp
 638 # define cconnect                ccmdnotsupp
 639 # define cdisconnect             ccmdnotsupp
 640 # define ccache                  ccmdnotsupp
 641 #endif
 642
 643 FL time_t      imap_read_date(const char *cp);
 644 FL char *      imap_quotestr(const char *s);
 645 FL char *      imap_unquotestr(const char *s);
 646
 647 /* imap_search.c */
 648 FL enum okay   imap_search(const char *spec, int f);
 649
 650 /* lex.c */
 651 FL int         setfile(char const *name, int nmail);
 652 FL int         newmailinfo(int omsgCount);
 653
 654 /* Interpret user commands.  If standard input is not a tty, print no prompt */
 655 FL void        commands(void);
 656
 657 /* Evaluate a single command.
 658  * .ev_add_history and .ev_new_content will be updated upon success.
 659  * Command functions return 0 for success, 1 for error, and -1 for abort.
 660  * 1 or -1 aborts a load or source, a -1 aborts the interactive command loop */
 661 FL int         evaluate(struct eval_ctx *evp);
 662 /* TODO drop execute() is the legacy version of evaluate().
 663  * Contxt is non-zero if called while composing mail */
 664 FL int         execute(char *linebuf, int contxt, size_t linesize);
 665
 666 FL void        setmsize(int sz);
 667 FL void        onintr(int s);
 668 FL void        announce(int printheaders);
 669 FL int         newfileinfo(void);
 670 FL int         getmdot(int nmail);
 671 FL void        initbox(const char *name);
 672
 673 /* Print the docstring of `comm', which may be an abbreviation.
 674  * Return FAL0 if there is no such command */
 675 #ifdef HAVE_DOCSTRINGS
 676 FL bool_t      print_comm_docstr(char const *comm);
 677 #endif
 678
 679 /* list.c */
 680 FL int         getmsglist(char *buf, int *vector, int flags);
 681 FL int         getrawlist(const char *line, size_t linesize,
 682                   char **argv, int argc, int echolist);
 683 FL int         first(int f, int m);
 684 FL void        mark(int mesg, int f);
 685
 686 /* lzw.c */
 687 #ifdef HAVE_IMAP
 688 FL int         zwrite(void *cookie, const char *wbp, int num);
 689 FL int         zfree(void *cookie);
 690 FL int         zread(void *cookie, char *rbp, int num);
 691 FL void *      zalloc(FILE *fp);
 692 #endif /* HAVE_IMAP */
 693
 694 /* maildir.c */
 695 FL int         maildir_setfile(const char *name, int nmail, int isedit);
 696 FL void        maildir_quit(void);
 697 FL enum okay   maildir_append(const char *name, FILE *fp);
 698 FL enum okay   maildir_remove(const char *name);
 699
 700 /* mime.c */
 701
 702 /* *charset-7bit*, else CHARSET_7BIT */
 703 FL char const * charset_get_7bit(void);
 704
 705 /* *charset-8bit*, else CHARSET_8BIT */
 706 FL char const * charset_get_8bit(void);
 707
 708 /* LC_CTYPE:CODESET / *ttycharset*, else *charset-8bit*, else CHARSET_8BIT */
 709 FL char const * charset_get_lc(void);
 710
 711 /* *sendcharsets* / *charset-8bit* iterator.
 712  * *a_charset_to_try_first* may be used to prepend a charset (as for
 713  * *reply-in-same-charset*);  works correct for !HAVE_ICONV */
 714 FL void        charset_iter_reset(char const *a_charset_to_try_first);
 715 FL char const * charset_iter_next(void);
 716 FL char const * charset_iter_current(void);
 717 FL void        charset_iter_recurse(char *outer_storage[2]); /* TODO LEGACY */
 718 FL void        charset_iter_restore(char *outer_storage[2]); /* TODO LEGACY */
 719
 720 FL char const * need_hdrconv(struct header *hp, enum gfield w);
 721 FL enum mimeenc mime_getenc(char *h);
 722 FL char *      mime_getparam(char const *param, char *h);
 723
 724 /* Get the boundary out of a Content-Type: multipart/xyz header field, return
 725  * salloc()ed copy of it; store strlen() in *len if set */
 726 FL char *      mime_get_boundary(char *h, size_t *len);
 727
 728 /* Create a salloc()ed MIME boundary */
 729 FL char *      mime_create_boundary(void);
 730
 731 /* Classify content of *fp* as necessary and fill in arguments; **charset* is
 732  * left alone unless it's non-NULL */
 733 FL int         mime_classify_file(FILE *fp, char const **contenttype,
 734                   char const **charset, int *do_iconv);
 735
 736 /* */
 737 FL enum mimecontent mime_classify_content_of_part(struct mimepart const *mip);
 738
 739 /* Return the Content-Type matching the extension of name */
 740 FL char *      mime_classify_content_type_by_fileext(char const *name);
 741
 742 /* "mimetypes" command */
 743 FL int         c_mimetypes(void *v);
 744
 745 FL void        mime_fromhdr(struct str const *in, struct str *out,
 746                   enum tdflags flags);
 747 FL char *      mime_fromaddr(char const *name);
 748
 749 /* fwrite(3) performing the given MIME conversion */
 750 FL ssize_t     mime_write(char const *ptr, size_t size, FILE *f,
 751                   enum conversion convert, enum tdflags dflags,
 752                   struct quoteflt *qf, struct str *rest);
 753 FL ssize_t     xmime_write(char const *ptr, size_t size, /* TODO LEGACY */
 754                   FILE *f, enum conversion convert, enum tdflags dflags,
 755                   struct str *rest);
 756
 757 /*
 758  * mime_cte.c
 759  * Content-Transfer-Encodings as defined in RFC 2045:
 760  * - Quoted-Printable, section 6.7
 761  * - Base64, section 6.8
 762  */
 763
 764 /* How many characters of (the complete body) *ln* need to be quoted */
 765 FL size_t      mime_cte_mustquote(char const *ln, size_t lnlen, bool_t ishead);
 766
 767 /* How much space is necessary to encode *len* bytes in QP, worst case.
 768  * Includes room for terminator */
 769 FL size_t      qp_encode_calc_size(size_t len);
 770
 771 /* If *flags* includes QP_ISHEAD these assume "word" input and use special
 772  * quoting rules in addition; soft line breaks are not generated.
 773  * Otherwise complete input lines are assumed and soft line breaks are
 774  * generated as necessary */
 775 FL struct str * qp_encode(struct str *out, struct str const *in,
 776                   enum qpflags flags);
 777 #ifdef notyet
 778 FL struct str * qp_encode_cp(struct str *out, char const *cp,
 779                   enum qpflags flags);
 780 FL struct str * qp_encode_buf(struct str *out, void const *vp, size_t vp_len,
 781                   enum qpflags flags);
 782 #endif
 783
 784 /* If *rest* is set then decoding will assume body text input (assumes input
 785  * represents lines, only create output when input didn't end with soft line
 786  * break [except it finalizes an encoded CRLF pair]), otherwise it is assumed
 787  * to decode a header strings and (1) uses special decoding rules and (b)
 788  * directly produces output.
 789  * The buffers of *out* and possibly *rest* will be managed via srealloc().
 790  * Returns OKAY. XXX or STOP on error (in which case *out* is set to an error
 791  * XXX message); caller is responsible to free buffers */
 792 FL int         qp_decode(struct str *out, struct str const *in,
 793                   struct str *rest);
 794
 795 /* How much space is necessary to encode *len* bytes in Base64, worst case.
 796  * Includes room for (CR/LF/CRLF and) terminator */
 797 FL size_t      b64_encode_calc_size(size_t len);
 798
 799 /* Note these simply convert all the input (if possible), including the
 800  * insertion of NL sequences if B64_CRLF or B64_LF is set (and multiple thereof
 801  * if B64_MULTILINE is set).
 802  * Thus, in the B64_BUF case, better call b64_encode_calc_size() first */
 803 FL struct str * b64_encode(struct str *out, struct str const *in,
 804                   enum b64flags flags);
 805 FL struct str * b64_encode_cp(struct str *out, char const *cp,
 806                   enum b64flags flags);
 807 FL struct str * b64_encode_buf(struct str *out, void const *vp, size_t vp_len,
 808                   enum b64flags flags);
 809
 810 /* If *rest* is set then decoding will assume text input.
 811  * The buffers of *out* and possibly *rest* will be managed via srealloc().
 812  * Returns OKAY or STOP on error (in which case *out* is set to an error
 813  * message); caller is responsible to free buffers */
 814 FL int         b64_decode(struct str *out, struct str const *in,
 815                   struct str *rest);
 816
 817 /*
 818  * names.c
 819  */
 820
 821 FL struct name * nalloc(char *str, enum gfield ntype);
 822 FL struct name * ndup(struct name *np, enum gfield ntype);
 823 FL struct name * cat(struct name *n1, struct name *n2);
 824 FL int         count(struct name const *np);
 825
 826 FL struct name * extract(char const *line, enum gfield ntype);
 827 FL struct name * lextract(char const *line, enum gfield ntype);
 828 FL char *      detract(struct name *np, enum gfield ntype);
 829
 830 /* Get a lextract() list via readstr_input(), reassigning to *np* */
 831 FL struct name * grab_names(const char *field, struct name *np, int comma,
 832          enum gfield gflags);
 833
 834 FL struct name * checkaddrs(struct name *np);
 835 FL struct name * usermap(struct name *names, bool_t force_metoo);
 836 FL struct name * elide(struct name *names);
 837 FL struct name * delete_alternates(struct name *np);
 838 FL int         is_myname(char const *name);
 839
 840 /* Dispatch a message to all pipe and file addresses TODO -> sendout.c */
 841 FL struct name * outof(struct name *names, FILE *fo, struct header *hp,
 842                   bool_t *senderror);
 843
 844 /* Handling of alias groups */
 845
 846 /* Locate a group name and return it */
 847 FL struct grouphead * findgroup(char *name);
 848
 849 /* Print a group out on stdout */
 850 FL void        printgroup(char *name);
 851
 852 FL void        remove_group(char const *name);
 853
 854 /* openssl.c */
 855 #ifdef HAVE_OPENSSL
 856 FL enum okay   ssl_open(const char *server, struct sock *sp, const char *uhp);
 857 FL void        ssl_gen_err(const char *fmt, ...);
 858 FL int         cverify(void *vp);
 859 FL FILE *      smime_sign(FILE *ip, struct header *);
 860 FL FILE *      smime_encrypt(FILE *ip, const char *certfile, const char *to);
 861 FL struct message * smime_decrypt(struct message *m, const char *to,
 862                      const char *cc, int signcall);
 863 FL enum okay   smime_certsave(struct message *m, int n, FILE *op);
 864 #else
 865 # define cverify                 ccmdnotsupp
 866 #endif
 867
 868 /* pop3.c */
 869 #ifdef HAVE_POP3
 870 FL enum okay   pop3_noop(void);
 871 FL int         pop3_setfile(const char *server, int nmail, int isedit);
 872 FL enum okay   pop3_header(struct message *m);
 873 FL enum okay   pop3_body(struct message *m);
 874 FL void        pop3_quit(void);
 875 #endif
 876
 877 /*
 878  * popen.c
 879  * Subprocesses, popen, but also file handling with registering
 880  */
 881
 882 FL FILE *      safe_fopen(const char *file, const char *mode, int *omode);
 883 FL FILE *      Fopen(const char *file, const char *mode);
 884 FL FILE *      Fdopen(int fd, const char *mode);
 885 FL int         Fclose(FILE *fp);
 886 FL FILE *      Zopen(const char *file, const char *mode, int *compression);
 887
 888 /* Create a temporary file in tempdir, use prefix for its name, store the
 889  * unique name in fn, and return a stdio FILE pointer with access mode.
 890  * *bits* specifies the access mode of the newly created temporary file */
 891 FL FILE *      Ftemp(char **fn, char const *prefix, char const *mode,
 892                   int bits, int register_file);
 893
 894 /* Free the resources associated with the given filename.  To be called after
 895  * unlink().  Since this function can be called after receiving a signal, the
 896  * variable must be made NULL first and then free()d, to avoid more than one
 897  * free() call in all circumstances */
 898 FL void        Ftfree(char **fn);
 899
 900 /* Create a pipe and ensure CLOEXEC bit is set in both descriptors */
 901 FL bool_t      pipe_cloexec(int fd[2]);
 902
 903 FL FILE *      Popen(const char *cmd, const char *mode, const char *shell,
 904                   int newfd1);
 905
 906 FL bool_t      Pclose(FILE *ptr, bool_t dowait);
 907
 908 FL void        close_all_files(void);
 909 FL int         run_command(char const *cmd, sigset_t *mask, int infd,
 910                   int outfd, char const *a0, char const *a1, char const *a2);
 911 FL int         start_command(const char *cmd, sigset_t *mask, int infd,
 912                   int outfd, const char *a0, const char *a1, const char *a2);
 913 FL void        prepare_child(sigset_t *nset, int infd, int outfd);
 914 FL void        sigchild(int signo);
 915 FL void        free_child(int pid);
 916
 917 /* Wait for pid, return wether we've had a normal EXIT_SUCCESS exit.
 918  * If wait_status is set, set it to the reported waitpid(2) wait status */
 919 FL bool_t      wait_child(int pid, int *wait_status);
 920
 921 /* quit.c */
 922 FL int         quitcmd(void *v);
 923 FL void        quit(void);
 924 FL int         holdbits(void);
 925 FL void        save_mbox_for_possible_quitstuff(void); /* TODO DROP IF U CAN */
 926 FL enum okay   makembox(void);
 927 FL int         savequitflags(void);
 928 FL void        restorequitflags(int);
 929
 930 /* send.c */
 931 FL int         sendmp(struct message *mp, FILE *obuf, struct ignoretab *doign,
 932                   char const *prefix, enum sendaction action, off_t *stats);
 933
 934 /* sendout.c */
 935 FL int         mail(struct name *to, struct name *cc, struct name *bcc,
 936                   char *subject, struct attachment *attach,
 937                   char *quotefile, int recipient_record);
 938 FL int         csendmail(void *v);
 939 FL int         cSendmail(void *v);
 940 FL enum        okay mail1(struct header *hp, int printheaders,
 941                   struct message *quote, char *quotefile, int recipient_record,
 942                   int doprefix);
 943 FL int         mkdate(FILE *fo, const char *field);
 944 FL int         puthead(struct header *hp, FILE *fo, enum gfield w,
 945                   enum sendaction action, enum conversion convert,
 946                   char const *contenttype, char const *charset);
 947 FL enum okay   resend_msg(struct message *mp, struct name *to, int add_resent);
 948
 949 /*
 950  * smtp.c
 951  */
 952
 953 #ifdef HAVE_SMTP
 954 FL char *      smtp_auth_var(const char *type, const char *addr);
 955 FL int         smtp_mta(char *server, struct name *to, FILE *fi,
 956                   struct header *hp, const char *user, const char *password,
 957                   const char *skinned);
 958 #endif
 959
 960 /*
 961  * spam.c
 962  */
 963
 964 #ifdef HAVE_SPAM
 965 FL int         cspam_clear(void *v);
 966 FL int         cspam_set(void *v);
 967 FL int         cspam_forget(void *v);
 968 FL int         cspam_ham(void *v);
 969 FL int         cspam_rate(void *v);
 970 FL int         cspam_spam(void *v);
 971 #else
 972 # define cspam_clear             ccmdnotsupp
 973 # define cspam_set               ccmdnotsupp
 974 # define cspam_forget            ccmdnotsupp
 975 # define cspam_ham               ccmdnotsupp
 976 # define cspam_rate              ccmdnotsupp
 977 # define cspam_spam              ccmdnotsupp
 978 #endif
 979
 980 /* ssl.c */
 981 #ifdef HAVE_SSL
 982 FL void        ssl_set_vrfy_level(const char *uhp);
 983 FL enum okay   ssl_vrfy_decide(void);
 984 FL char *      ssl_method_string(const char *uhp);
 985 FL enum okay   smime_split(FILE *ip, FILE **hp, FILE **bp, long xcount,
 986                   int keep);
 987 FL FILE *      smime_sign_assemble(FILE *hp, FILE *bp, FILE *sp);
 988 FL FILE *      smime_encrypt_assemble(FILE *hp, FILE *yp);
 989 FL struct message * smime_decrypt_assemble(struct message *m, FILE *hp,
 990                      FILE *bp);
 991 FL int         ccertsave(void *v);
 992 FL enum okay   rfc2595_hostname_match(const char *host, const char *pattern);
 993 #else
 994 # define ccertsave               ccmdnotsupp
 995 #endif
 996
 997 /*
 998  * strings.c
 999  * This bundles several different string related support facilities:
1000  * - auto-reclaimed string storage (memory goes away on command loop ticks)
1001  * - plain char* support functions which use unspecified or smalloc() memory
1002  * - struct str related support funs
1003  * - our iconv(3) wrapper
1004  */
1005
1006 /* Auto-reclaimed string storage */
1007
1008 #ifdef HAVE_DEBUG
1009 # define SALLOC_DEBUG_ARGS       , char const *mdbg_file, int mdbg_line
1010 # define SALLOC_DEBUG_ARGSCALL   , mdbg_file, mdbg_line
1011 #else
1012 # define SALLOC_DEBUG_ARGS
1013 # define SALLOC_DEBUG_ARGSCALL
1014 #endif
1015
1016 /* Allocate size more bytes of space and return the address of the first byte
1017  * to the caller.  An even number of bytes are always allocated so that the
1018  * space will always be on a word boundary */
1019 FL void *      salloc(size_t size SALLOC_DEBUG_ARGS);
1020 FL void *      csalloc(size_t nmemb, size_t size SALLOC_DEBUG_ARGS);
1021 #ifdef HAVE_DEBUG
1022 # define salloc(SZ)              salloc(SZ, __FILE__, __LINE__)
1023 # define csalloc(NM,SZ)          csalloc(NM, SZ, __FILE__, __LINE__)
1024 #endif
1025
1026 /* Auto-reclaim string storage; if only_if_relaxed is true then only perform
1027  * the reset when a srelax_hold() is currently active */
1028 FL void        sreset(bool_t only_if_relaxed);
1029
1030 /* The "problem" with sreset() is that it releases all string storage except
1031  * what was present once spreserve() had been called; it therefore cannot be
1032  * called from all that code which yet exists and walks about all the messages
1033  * in order, e.g. quit(), searches, etc., because, unfortunately, these code
1034  * paths are reached with new intermediate string dope already in use.
1035  * Thus such code should take a srelax_hold(), successively call srelax() after
1036  * a single message has been handled, and finally srelax_rele() (unless it is
1037  * clear that sreset() occurs anyway) */
1038 FL void        srelax_hold(void);
1039 FL void        srelax_rele(void);
1040 FL void        srelax(void);
1041
1042 /* Make current string storage permanent: new allocs will be auto-reclaimed by
1043  * sreset().  This is called once only, from within main() */
1044 FL void        spreserve(void);
1045
1046 /* 'sstats' command */
1047 #ifdef HAVE_DEBUG
1048 FL int         c_sstats(void *v);
1049 #endif
1050
1051 /* Return a pointer to a dynamic copy of the argument */
1052 FL char *      savestr(char const *str SALLOC_DEBUG_ARGS);
1053 FL char *      savestrbuf(char const *sbuf, size_t sbuf_len SALLOC_DEBUG_ARGS);
1054 #ifdef HAVE_DEBUG
1055 # define savestr(CP)             savestr(CP, __FILE__, __LINE__)
1056 # define savestrbuf(CBP,CBL)     savestrbuf(CBP, CBL, __FILE__, __LINE__)
1057 #endif
1058
1059 /* Make copy of argument incorporating old one, if set, separated by space */
1060 FL char *      save2str(char const *str, char const *old SALLOC_DEBUG_ARGS);
1061 #ifdef HAVE_DEBUG
1062 # define save2str(S,O)           save2str(S, O, __FILE__, __LINE__)
1063 #endif
1064
1065 /* strcat */
1066 FL char *      savecat(char const *s1, char const *s2 SALLOC_DEBUG_ARGS);
1067 #ifdef HAVE_DEBUG
1068 # define savecat(S1,S2)          savecat(S1, S2, __FILE__, __LINE__)
1069 #endif
1070
1071 /* Create duplicate, lowercasing all characters along the way */
1072 FL char *      i_strdup(char const *src SALLOC_DEBUG_ARGS);
1073 #ifdef HAVE_DEBUG
1074 # define i_strdup(CP)            i_strdup(CP, __FILE__, __LINE__)
1075 #endif
1076
1077 /* Extract the protocol base and return a duplicate */
1078 FL char *      protbase(char const *cp SALLOC_DEBUG_ARGS);
1079 #ifdef HAVE_DEBUG
1080 # define protbase(CP)            protbase(CP, __FILE__, __LINE__)
1081 #endif
1082
1083 /* URL en- and decoding (RFC 1738, but not really) */
1084 FL char *      urlxenc(char const *cp SALLOC_DEBUG_ARGS);
1085 FL char *      urlxdec(char const *cp SALLOC_DEBUG_ARGS);
1086 #ifdef HAVE_DEBUG
1087 # define urlxenc(CP)             urlxenc(CP, __FILE__, __LINE__)
1088 # define urlxdec(CP)             urlxdec(CP, __FILE__, __LINE__)
1089 #endif
1090
1091 /*  */
1092 FL struct str * str_concat_csvl(struct str *self, ...);
1093 FL struct str * str_concat_cpa(struct str *self, char const * const *cpa,
1094                   char const *sep_o_null SALLOC_DEBUG_ARGS);
1095 #ifdef HAVE_DEBUG
1096 # define str_concat_cpa(S,A,N)   str_concat_cpa(S, A, N, __FILE__, __LINE__)
1097 #endif
1098
1099 /* Plain char* support, not auto-reclaimed (unless noted) */
1100
1101 /* Are any of the characters in the two strings the same? */
1102 FL int         anyof(char const *s1, char const *s2);
1103
1104 /* Treat *iolist as a sep separated list of strings; find and return the
1105  * next entry, trimming surrounding whitespace, and point *iolist to the next
1106  * entry or to NULL if no more entries are contained.  If ignore_empty is not
1107  * set empty entries are started over.  Return NULL or an entry */
1108 FL char *      n_strsep(char **iolist, char sep, bool_t ignore_empty);
1109 #define strcomma(IOL,IGN)        n_strsep(IOL, ',', IGN)
1110
1111 /* Copy a string, lowercasing it as we go; *size* is buffer size of *dest*;
1112  * *dest* will always be terminated unless *size* is 0 */
1113 FL void        i_strcpy(char *dest, char const *src, size_t size);
1114
1115 /* Is *as1* a valid prefix of *as2*? */
1116 FL int         is_prefix(char const *as1, char const *as2);
1117
1118 /* Find the last AT @ before the first slash */
1119 FL char const * last_at_before_slash(char const *sp);
1120
1121 /* Get (and isolate) the last, possibly quoted part of linebuf, set *needs_list
1122  * to indicate wether getmsglist() et al need to be called to collect
1123  * additional args that remain in linebuf.  Return NULL on "error" */
1124 FL char *      laststring(char *linebuf, bool_t *needs_list, bool_t strip);
1125
1126 /* Convert a string to lowercase, in-place and with multibyte-aware */
1127 FL void        makelow(char *cp);
1128
1129 /* Is *sub* a substring of *str*, case-insensitive and multibyte-aware? */
1130 FL int         substr(const char *str, const char *sub);
1131
1132 /* Lazy vsprintf wrapper */
1133 #ifndef HAVE_SNPRINTF
1134 FL int         snprintf(char *str, size_t size, const char *format, ...);
1135 #endif
1136
1137 FL char *      sstpcpy(char *dst, const char *src);
1138 FL char *      sstrdup(char const *cp SMALLOC_DEBUG_ARGS);
1139 FL char *      sbufdup(char const *cp, size_t len SMALLOC_DEBUG_ARGS);
1140 #ifdef HAVE_DEBUG
1141 # define sstrdup(CP)             sstrdup(CP, __FILE__, __LINE__)
1142 # define sbufdup(CP,L)           sbufdup(CP, L, __FILE__, __LINE__)
1143 #endif
1144
1145 FL char *      n_strlcpy(char *dst, const char *src, size_t len);
1146
1147 /* Locale-independent character class functions */
1148 FL int         asccasecmp(char const *s1, char const *s2);
1149 FL int         ascncasecmp(char const *s1, char const *s2, size_t sz);
1150 FL char const * asccasestr(char const *haystack, char const *xneedle);
1151 FL bool_t      is_asccaseprefix(char const *as1, char const *as2);
1152
1153 /* struct str related support funs */
1154
1155 /* *self->s* is srealloc()ed */
1156 FL struct str * n_str_dup(struct str *self, struct str const *t
1157                   SMALLOC_DEBUG_ARGS);
1158
1159 /* *self->s* is srealloc()ed, *self->l* incremented */
1160 FL struct str * n_str_add_buf(struct str *self, char const *buf, size_t buflen
1161                   SMALLOC_DEBUG_ARGS);
1162 #define n_str_add(S, T)          n_str_add_buf(S, (T)->s, (T)->l)
1163 #define n_str_add_cp(S, CP)      n_str_add_buf(S, CP, (CP) ? strlen(CP) : 0)
1164
1165 #ifdef HAVE_DEBUG
1166 # define n_str_dup(S,T)          n_str_dup(S, T, __FILE__, __LINE__)
1167 # define n_str_add_buf(S,B,BL)   n_str_add_buf(S, B, BL, __FILE__, __LINE__)
1168 #endif
1169
1170 /* Our iconv(3) wrappers */
1171
1172 #ifdef HAVE_ICONV
1173 FL iconv_t     n_iconv_open(char const *tocode, char const *fromcode);
1174 /* If *cd* == *iconvd*, assigns -1 to the latter */
1175 FL void        n_iconv_close(iconv_t cd);
1176
1177 /* Reset encoding state */
1178 #ifdef notyet
1179 FL void        n_iconv_reset(iconv_t cd);
1180 #endif
1181
1182 /* iconv(3), but return *errno* or 0; *skipilseq* forces step over illegal byte
1183  * sequences; likewise iconv_str(), but which auto-grows on E2BIG errors; *in*
1184  * and *in_rest_or_null* may be the same object.
1185  * Note: EINVAL (incomplete sequence at end of input) is NOT handled, so the
1186  * replacement character must be added manually if that happens at EOF! */
1187 FL int         n_iconv_buf(iconv_t cd, char const **inb, size_t *inbleft,
1188                   char **outb, size_t *outbleft, bool_t skipilseq);
1189 FL int         n_iconv_str(iconv_t icp, struct str *out, struct str const *in,
1190                   struct str *in_rest_or_null, bool_t skipilseq);
1191 #endif
1192
1193 /* thread.c */
1194 FL int         thread(void *vp);
1195 FL int         unthread(void *vp);
1196 FL struct message * next_in_thread(struct message *mp);
1197 FL struct message * prev_in_thread(struct message *mp);
1198 FL struct message * this_in_thread(struct message *mp, long n);
1199 FL int         sort(void *vp);
1200 FL int         ccollapse(void *v);
1201 FL int         cuncollapse(void *v);
1202 FL void        uncollapse1(struct message *m, int always);
1203
1204 /*
1205  * tty.c
1206  */
1207
1208 /* [Yy]es or [Nn]o */
1209 FL bool_t      yorn(char const *msg);
1210
1211 /* Get a password the expected way, return termios_state.ts_linebuf on
1212  * success or NULL on error */
1213 FL char *      getuser(char const *query);
1214
1215 /* Get a password the expected way, return termios_state.ts_linebuf on
1216  * success or NULL on error.
1217  * termios_state_reset() (def.h) must be called anyway */
1218 FL char *      getpassword(char const *query);
1219
1220 /* Get both, user and password in the expected way; simply reuses a value that
1221  * is set, otherwise calls one of the above.
1222  * Returns true only if we have a user and a password.
1223  * *user* will be savestr()ed if neither it nor *pass* have a default value
1224  * (so that termios_state.ts_linebuf carries only one) */
1225 FL bool_t      getcredentials(char **user, char **pass);
1226
1227 /* Overall interactive terminal life cycle for command line editor library */
1228 #if defined HAVE_EDITLINE || defined HAVE_READLINE
1229 # define TTY_WANTS_SIGWINCH
1230 #endif
1231 FL void        tty_init(void);
1232 FL void        tty_destroy(void);
1233
1234 /* Rather for main.c / SIGWINCH interaction only */
1235 FL void        tty_signal(int sig);
1236
1237 /* Read a line after printing prompt (if set and non-empty).
1238  * If n>0 assumes that *linebuf has n bytes of default content */
1239 FL int         tty_readline(char const *prompt, char **linebuf,
1240                   size_t *linesize, size_t n SMALLOC_DEBUG_ARGS);
1241 #ifdef HAVE_DEBUG
1242 # define tty_readline(A,B,C,D)   tty_readline(A, B, C, D, __FILE__, __LINE__)
1243 #endif
1244
1245 /* Add a line (most likely as returned by tty_readline()) to the history
1246  * (only added for real if non-empty and doesn't begin with U+0020) */
1247 FL void        tty_addhist(char const *s);
1248
1249 #if defined HAVE_HISTORY &&\
1250    (defined HAVE_READLINE || defined HAVE_EDITLINE || defined HAVE_NCL)
1251 FL int         c_history(void *v);
1252 #endif
1253
1254 #ifndef HAVE_AMALGAMATION
1255 # undef FL
1256 # define FL
1257 #endif
1258
1259 /* vim:set fenc=utf-8:s-it-mode */