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