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