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