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