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