1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
2 *@ Exported function prototypes.
4 * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
5 * Copyright (c) 2012 - 2014 Steffen "Daode" Nurpmeso <sdaoden@users.sf.net>.
8 * Copyright (c) 1992, 1993
9 * The Regents of the University of California. All rights reserved.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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
41 * TODO Convert optional utility+ functions to n_*(); ditto
42 * TODO else use generic module-specific prefixes: str_(), am[em]_, sm[em]_, ..
44 /* TODO s-it-mode: not really (docu, funnames, funargs, etc) */
47 #ifndef HAVE_AMALGAMATION
57 /* Don't use _var_* unless you *really* have to! */
59 /* Constant option key look/(un)set/clear */
60 FL
char * _var_oklook(enum okeys okey
);
61 #define ok_blook(C) (_var_oklook(CONCAT(ok_b_, C)) != NULL)
62 #define ok_vlook(C) _var_oklook(CONCAT(ok_v_, C))
64 FL bool_t
_var_okset(enum okeys okey
, uintptr_t val
);
65 #define ok_bset(C,B) _var_okset(CONCAT(ok_b_, C), (uintptr_t)(B))
66 #define ok_vset(C,V) _var_okset(CONCAT(ok_v_, C), (uintptr_t)(V))
68 FL bool_t
_var_okclear(enum okeys okey
);
69 #define ok_bclear(C) _var_okclear(CONCAT(ok_b_, C))
70 #define ok_vclear(C) _var_okclear(CONCAT(ok_v_, C))
72 /* Variable option key look/(un)set/clear */
73 FL
char * _var_voklook(char const *vokey
);
74 #define vok_blook(S) (_var_voklook(S) != NULL)
75 #define vok_vlook(S) _var_voklook(S)
77 FL bool_t
_var_vokset(char const *vokey
, uintptr_t val
);
78 #define vok_bset(S,B) _var_vokset(S, (uintptr_t)(B))
79 #define vok_vset(S,V) _var_vokset(S, (uintptr_t)(V))
81 FL bool_t
_var_vokclear(char const *vokey
);
82 #define vok_bclear(S) _var_vokclear(S)
83 #define vok_vclear(S) _var_vokclear(S)
85 /* List all variables */
86 FL
void var_list_all(void);
88 FL
int c_var_inspect(void *v
);
89 FL
int c_define(void *v
);
90 FL
int c_undef(void *v
);
91 FL
int c_call(void *v
);
93 FL
int callhook(char const *name
, int nmail
);
96 FL
int c_defines(void *v
);
99 FL
int c_account(void *v
);
102 FL
int c_localopts(void *v
);
108 /* Try to add an attachment for *file*, file_expand()ed.
109 * Return the new head of list *aphead*, or NULL.
110 * The newly created attachment will be stored in **newap*, if given */
111 FL
struct attachment
* add_attachment(struct attachment
*aphead
, char *file
,
112 struct attachment
**newap
);
114 /* Append comma-separated list of file names to the end of attachment list */
115 FL
struct attachment
* append_attachments(struct attachment
*aphead
,
118 /* Interactively edit the attachment list, return the new list head */
119 FL
struct attachment
* edit_attachments(struct attachment
*aphead
);
125 /* Announce a fatal error (and die) */
126 FL
void panic(char const *format
, ...);
127 FL
void alert(char const *format
, ...);
129 /* Provide BSD-like signal() on all (POSIX) systems */
130 FL sighandler_type
safe_signal(int signum
, sighandler_type handler
);
132 /* Hold *all* signals but SIGCHLD, and release that total block again */
133 FL
void hold_all_sigs(void);
134 FL
void rele_all_sigs(void);
136 /* Hold HUP/QUIT/INT */
137 FL
void hold_sigs(void);
138 FL
void rele_sigs(void);
140 /* Not-Yet-Dead debug information (handler installation in main.c) */
142 FL
void _nyd_chirp(ui8_t act
, char const *file
, ui32_t line
,
144 FL
void _nyd_oncrash(int signo
);
146 # define NYD_ENTER _nyd_chirp(1, __FILE__, __LINE__, __FUN__)
147 # define NYD_LEAVE _nyd_chirp(2, __FILE__, __LINE__, __FUN__)
148 # define NYD _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
149 # define NYD_X _nyd_chirp(0, __FILE__, __LINE__, __FUN__)
151 # define NYD_ENTER do {} while (0)
152 # define NYD_LEAVE do {} while (0)
153 # define NYD do {} while (0)
154 # define NYD_X do {} while (0) /* XXX LEGACY */
157 /* Touch the named message by setting its MTOUCH flag. Touched messages have
158 * the effect of not being sent back to the system mailbox on exit */
159 FL
void touch(struct message
*mp
);
161 /* Test to see if the passed file name is a directory, return true if it is */
162 FL bool_t
is_dir(char const *name
);
164 /* Count the number of arguments in the given string raw list */
165 FL
int argcount(char **argv
);
167 /* Compute screen size */
168 FL
int screensize(void);
171 FL
char const *get_pager(void);
173 /* Check wether using a pager is possible/makes sense and is desired by user
174 * (*crt* set); return number of screen lines (or *crt*) if so, 0 otherwise */
175 FL
size_t paging_seems_sensible(void);
177 /* Use a pager or STDOUT to print *fp*; if *lines* is 0, they'll be counted */
178 FL
void page_or_print(FILE *fp
, size_t lines
);
179 #define try_pager(FP) page_or_print(FP, 0) /* TODO obsolete */
181 /* Parse name and guess at the required protocol */
182 FL
enum protocol
which_protocol(char const *name
);
184 /* Hash the passed string -- uses Chris Torek's hash algorithm */
185 FL ui32_t
torek_hash(char const *name
);
186 #define hash(S) (torek_hash(S) % HSHSIZE) /* xxx COMPAT (?) */
189 FL ui32_t
pjw(char const *cp
); /* TODO obsolete -> torek_hash() */
191 /* Find a prime greater than n */
192 FL ui32_t
nextprime(ui32_t n
);
194 /* Check wether *s is an escape sequence, expand it as necessary.
195 * Returns the expanded sequence or 0 if **s is NUL or PROMPT_STOP if it is \c.
196 * *s is advanced to after the expanded sequence (as possible).
197 * If use_prompt_extensions is set, an enum prompt_exp may be returned */
198 FL
int expand_shell_escape(char const **s
,
199 bool_t use_prompt_extensions
);
201 /* Get *prompt*, or '& ' if *bsdcompat*, of '? ' otherwise */
202 FL
char * getprompt(void);
204 /* Detect and query the hostname to use */
205 FL
char * nodename(int mayoverride
);
207 /* Try to lookup a variable named "password-*token*".
208 * Return NULL or salloc()ed buffer */
209 FL
char * lookup_password_for_token(char const *token
);
211 /* Get a (pseudo) random string of *length* bytes; returns salloc()ed buffer */
212 FL
char * getrandstring(size_t length
);
214 #define Hexchar(n) ((n)>9 ? (n)-10+'A' : (n)+'0')
215 #define hexchar(n) ((n)>9 ? (n)-10+'a' : (n)+'0')
218 /* Store the MD5 checksum as a hexadecimal string in *hex*, *not* terminated */
219 # define MD5TOHEX_SIZE 32
220 FL
char * md5tohex(char hex
[MD5TOHEX_SIZE
], void const *vp
);
222 /* CRAM-MD5 encode the *user* / *pass* / *b64* combo */
223 FL
char * cram_md5_string(char const *user
, char const *pass
,
227 FL
enum okay
makedir(const char *name
);
229 /* A get-wd..restore-wd approach */
230 FL
enum okay
cwget(struct cw
*cw
);
231 FL
enum okay
cwret(struct cw
*cw
);
232 FL
void cwrelse(struct cw
*cw
);
234 /* xxx Place cp in a salloc()ed buffer, column-aligned */
235 FL
char * colalign(char const *cp
, int col
, int fill
,
236 int *cols_decr_used_or_null
);
238 /* Convert a string to a displayable one;
239 * prstr() returns the result savestr()d, prout() writes it */
240 FL
void makeprint(struct str
const *in
, struct str
*out
);
241 FL
char * prstr(char const *s
);
242 FL
int prout(char const *s
, size_t sz
, FILE *fp
);
244 /* Print out a Unicode character or a substitute for it, return 0 on error or
245 * wcwidth() (or 1) on success */
246 FL
size_t putuc(int u
, int c
, FILE *fp
);
248 /* We want coloured output (in this salloc() cycle). If pager_used is not NULL
249 * we check against *colour-pagers* wether colour is really desirable */
251 FL
void colour_table_create(char const *pager_used
);
252 FL
void colour_put(FILE *fp
, enum colourspec cs
);
253 FL
void colour_put_header(FILE *fp
, char const *name
);
254 FL
void colour_reset(FILE *fp
);
255 FL
struct str
const * colour_get(enum colourspec cs
);
257 # define colour_put(FP,CS)
258 # define colour_put_header(FP,N)
259 # define colour_reset(FP)
262 /* Update *tc* to now; only .tc_time updated unless *full_update* is true */
263 FL
void time_current_update(struct time_current
*tc
,
266 /* Memory allocation routines */
268 # define SMALLOC_DEBUG_ARGS , char const *mdbg_file, int mdbg_line
269 # define SMALLOC_DEBUG_ARGSCALL , mdbg_file, mdbg_line
271 # define SMALLOC_DEBUG_ARGS
272 # define SMALLOC_DEBUG_ARGSCALL
275 FL
void * smalloc(size_t s SMALLOC_DEBUG_ARGS
);
276 FL
void * srealloc(void *v
, size_t s SMALLOC_DEBUG_ARGS
);
277 FL
void * scalloc(size_t nmemb
, size_t size SMALLOC_DEBUG_ARGS
);
280 FL
void sfree(void *v SMALLOC_DEBUG_ARGS
);
281 /* Called by sreset(), then */
282 FL
void smemreset(void);
284 FL
int c_smemtrace(void *v
);
287 FL bool_t
_smemcheck(char const *file
, int line
);
290 # define smalloc(SZ) smalloc(SZ, __FILE__, __LINE__)
291 # define srealloc(P,SZ) srealloc(P, SZ, __FILE__, __LINE__)
292 # define scalloc(N,SZ) scalloc(N, SZ, __FILE__, __LINE__)
293 # define free(P) sfree(P, __FILE__, __LINE__)
294 # define smemcheck() _smemcheck(__FILE__, __LINE__)
299 FL
enum okay
getcache1(struct mailbox
*mp
, struct message
*m
,
300 enum needspec need
, int setflags
);
301 FL
enum okay
getcache(struct mailbox
*mp
, struct message
*m
,
303 FL
void putcache(struct mailbox
*mp
, struct message
*m
);
304 FL
void initcache(struct mailbox
*mp
);
305 FL
void purgecache(struct mailbox
*mp
, struct message
*m
, long mc
);
306 FL
void delcache(struct mailbox
*mp
, struct message
*m
);
307 FL
enum okay
cache_setptr(int transparent
);
308 FL
enum okay
cache_list(struct mailbox
*mp
, const char *base
, int strip
,
310 FL
enum okay
cache_remove(const char *name
);
311 FL
enum okay
cache_rename(const char *old
, const char *new);
312 FL
unsigned long cached_uidvalidity(struct mailbox
*mp
);
313 FL
FILE * cache_queue(struct mailbox
*mp
);
314 FL
enum okay
cache_dequeue(struct mailbox
*mp
);
315 #endif /* HAVE_IMAP */
321 FL
int ccmdnotsupp(void *v
);
323 /* Show header group */
324 FL
int headers(void *v
);
326 /* Scroll to the next/previous screen */
327 FL
int scroll(void *v
);
328 FL
int Scroll(void *v
);
330 /* Print out the headlines for each message in the passed message list */
331 FL
int from(void *v
);
333 /* Print all message in between bottom and topx (including bottom) */
334 FL
void print_headers(size_t bottom
, size_t topx
);
336 /* Print out the value of dot */
337 FL
int pdot(void *v
);
339 /* Paginate messages, honor/don't honour ignored fields, respectively */
340 FL
int more(void *v
);
341 FL
int More(void *v
);
343 /* Type out messages, honor/don't honour ignored fields, respectively */
344 FL
int type(void *v
);
345 FL
int Type(void *v
);
347 /* Show MIME-encoded message text, including all fields */
348 FL
int show(void *v
);
350 /* Pipe messages, honor/don't honour ignored fields, respectively */
351 FL
int pipecmd(void *v
);
352 FL
int Pipecmd(void *v
);
354 /* Print the top so many lines of each desired message.
355 * The number of lines is taken from *toplines* and defaults to 5 */
358 /* Touch all the given messages so that they will get mboxed */
359 FL
int stouch(void *v
);
361 /* Make sure all passed messages get mboxed */
362 FL
int mboxit(void *v
);
364 /* List the folders the user currently has */
365 FL
int folders(void *v
);
368 FL
int next(void *v
);
369 FL
int save(void *v
);
370 FL
int Save(void *v
);
371 FL
int copycmd(void *v
);
372 FL
int Copycmd(void *v
);
373 FL
int cmove(void *v
);
374 FL
int cMove(void *v
);
375 FL
int cdecrypt(void *v
);
376 FL
int cDecrypt(void *v
);
377 FL
int cwrite(void *v
);
378 FL
int delete(void *v
);
379 FL
int deltype(void *v
);
380 FL
int undeletecmd(void *v
);
381 FL
int retfield(void *v
);
382 FL
int igfield(void *v
);
383 FL
int saveretfield(void *v
);
384 FL
int saveigfield(void *v
);
385 FL
int fwdretfield(void *v
);
386 FL
int fwdigfield(void *v
);
387 FL
int unignore(void *v
);
388 FL
int unretain(void *v
);
389 FL
int unsaveignore(void *v
);
390 FL
int unsaveretain(void *v
);
391 FL
int unfwdignore(void *v
);
392 FL
int unfwdretain(void *v
);
395 FL
int shell(void *v
);
396 FL
int dosh(void *v
);
397 FL
int help(void *v
);
399 /* Print user's working directory */
400 FL
int c_cwd(void *v
);
402 /* Change user's working directory */
403 FL
int c_chdir(void *v
);
405 FL
int respond(void *v
);
406 FL
int respondall(void *v
);
407 FL
int respondsender(void *v
);
408 FL
int followup(void *v
);
409 FL
int followupall(void *v
);
410 FL
int followupsender(void *v
);
411 FL
int preserve(void *v
);
412 FL
int unread(void *v
);
413 FL
int seen(void *v
);
414 FL
int messize(void *v
);
415 FL
int rexit(void *v
);
416 /* Set or display a variable value. Syntax is similar to that of sh */
418 FL
int unset(void *v
);
419 FL
int group(void *v
);
420 FL
int ungroup(void *v
);
421 FL
int cfile(void *v
);
422 FL
int echo(void *v
);
423 FL
int Respond(void *v
);
424 FL
int Followup(void *v
);
425 FL
int forwardcmd(void *v
);
426 FL
int Forwardcmd(void *v
);
428 /* if.else.endif conditional execution */
429 FL
int c_if(void *v
);
430 FL
int c_else(void *v
);
431 FL
int c_endif(void *v
);
433 FL
int alternates(void *v
);
434 FL
int resendcmd(void *v
);
435 FL
int Resendcmd(void *v
);
436 FL
int newmail(void *v
);
437 FL
int shortcut(void *v
);
438 FL
struct shortcut
*get_shortcut(const char *str
);
439 FL
int unshortcut(void *v
);
440 FL
int cflag(void *v
);
441 FL
int cunflag(void *v
);
442 FL
int canswered(void *v
);
443 FL
int cunanswered(void *v
);
444 FL
int cdraft(void *v
);
445 FL
int cundraft(void *v
);
446 FL
int cnoop(void *v
);
447 FL
int cremove(void *v
);
448 FL
int crename(void *v
);
452 FL
FILE * collect(struct header
*hp
, int printheaders
, struct message
*mp
,
453 char *quotefile
, int doprefix
);
455 FL
void savedeadletter(FILE *fp
, int fflush_rewind_first
);
458 FL
int fcntl_lock(int fd
, int type
);
459 FL
int dot_lock(const char *fname
, int fd
, int pollinterval
, FILE *fp
,
461 FL
void dot_unlock(const char *fname
);
464 FL
int editor(void *v
);
465 FL
int visual(void *v
);
466 FL
FILE * run_editor(FILE *fp
, off_t size
, int type
, int readonly
,
467 struct header
*hp
, struct message
*mp
,
468 enum sendaction action
, sighandler_type oldint
);
475 FL
struct quoteflt
* quoteflt_dummy(void); /* TODO LEGACY */
476 FL
void quoteflt_init(struct quoteflt
*self
, char const *prefix
);
477 FL
void quoteflt_destroy(struct quoteflt
*self
);
478 FL
void quoteflt_reset(struct quoteflt
*self
, FILE *f
);
479 FL ssize_t
quoteflt_push(struct quoteflt
*self
,
480 char const *dat
, size_t len
);
481 FL ssize_t
quoteflt_flush(struct quoteflt
*self
);
485 /* fgets() replacement to handle lines of arbitrary size and with embedded \0
487 * *line* - line buffer. *line be NULL.
488 * *linesize* - allocated size of line buffer.
489 * *count* - maximum characters to read. May be NULL.
490 * *llen* - length_of_line(*line).
492 * *appendnl* - always terminate line with \n, append if necessary.
494 FL
char * fgetline(char **line
, size_t *linesize
, size_t *count
,
495 size_t *llen
, FILE *fp
, int appendnl SMALLOC_DEBUG_ARGS
);
497 # define fgetline(A,B,C,D,E,F) \
498 fgetline(A, B, C, D, E, F, __FILE__, __LINE__)
501 /* Read up a line from the specified input into the linebuffer.
502 * Return the number of characters read. Do not include the newline at EOL.
503 * *n* is the number of characters already read.
505 FL
int readline_restart(FILE *ibuf
, char **linebuf
, size_t *linesize
,
506 size_t n SMALLOC_DEBUG_ARGS
);
508 # define readline_restart(A,B,C,D) \
509 readline_restart(A, B, C, D, __FILE__, __LINE__)
512 /* Read a complete line of input, with editing if interactive and possible.
513 * If prompt is NULL we'll call getprompt() first, if necessary.
514 * nl_escape defines wether user can escape newlines via backslash (POSIX).
515 * If string is set it is used as the initial line content if in interactive
516 * mode, otherwise this argument is ignored for reproducibility.
517 * Return number of octets or a value <0 on error */
518 FL
int readline_input(char const *prompt
, bool_t nl_escape
,
519 char **linebuf
, size_t *linesize
, char const *string
522 # define readline_input(A,B,C,D,E) readline_input(A,B,C,D,E,__FILE__,__LINE__)
525 /* Read a line of input, with editing if interactive and possible, return it
526 * savestr()d or NULL in case of errors or if an empty line would be returned.
527 * This may only be called from toplevel (not during sourcing).
528 * If prompt is NULL we'll call getprompt() if necessary.
529 * If string is set it is used as the initial line content if in interactive
530 * mode, otherwise this argument is ignored for reproducibility */
531 FL
char * readstr_input(char const *prompt
, char const *string
);
533 FL
void setptr(FILE *ibuf
, off_t offset
);
534 FL
int putline(FILE *obuf
, char *linebuf
, size_t count
);
535 FL
FILE * setinput(struct mailbox
*mp
, struct message
*m
,
537 FL
struct message
* setdot(struct message
*mp
);
538 FL
int rm(char *name
);
539 FL off_t
fsize(FILE *iob
);
541 /* Evaluate the string given as a new mailbox name. Supported meta characters:
542 * % for my system mail box
543 * %user for user's system mail box
544 * # for previous file
545 * & invoker's mbox file
546 * +file file in folder directory
547 * any shell meta character
548 * Returns the file name as an auto-reclaimed string */
549 FL
char * fexpand(char const *name
, enum fexp_mode fexpm
);
551 #define expand(N) fexpand(N, FEXP_FULL) /* XXX obsolete */
552 #define file_expand(N) fexpand(N, FEXP_LOCAL) /* XXX obsolete */
554 /* Get rid of queued mail */
555 FL
void demail(void);
557 /* vars.c hook: *folder* variable has been updated; if *folder* shouldn't be
558 * replaced by something else, leave *store* alone, otherwise smalloc() the
559 * desired value (ownership will be taken) */
560 FL bool_t
var_folder_updated(char const *folder
, char **store
);
562 /* Determine the current *folder* name, store it in *name* */
563 FL bool_t
getfold(char *name
, size_t size
);
565 FL
char const * getdeadletter(void);
567 FL
enum okay
get_body(struct message
*mp
);
570 FL
int sclose(struct sock
*sp
);
571 FL
enum okay
swrite(struct sock
*sp
, const char *data
);
572 FL
enum okay
swrite1(struct sock
*sp
, const char *data
, int sz
,
574 FL
enum okay
sopen(const char *xserver
, struct sock
*sp
, int use_ssl
,
575 const char *uhp
, const char *portstr
, int verbose
);
578 FL
int sgetline(char **line
, size_t *linesize
, size_t *linelen
,
579 struct sock
*sp SMALLOC_DEBUG_ARGS
);
581 # define sgetline(A,B,C,D) sgetline(A, B, C, D, __FILE__, __LINE__)
585 /* Deal with loading of resource files and dealing with a stack of files for
586 * the source command */
588 /* Load a file of user definitions */
589 FL
void load(char const *name
);
591 /* Pushdown current input file and switch to a new one. Set the global flag
592 * *sourcing* so that others will realize that they are no longer reading from
593 * a tty (in all probability) */
594 FL
int csource(void *v
);
596 /* Pop the current input back to the previous level. Update the *sourcing*
597 * flag as appropriate */
598 FL
int unstack(void);
602 /* Fill in / reedit the desired header fields */
603 FL
int grab_headers(struct header
*hp
, enum gfield gflags
,
606 /* Return the user's From: address(es) */
607 FL
char const * myaddrs(struct header
*hp
);
608 /* Boil the user's From: addresses down to a single one, or use *sender* */
609 FL
char const * myorigin(struct header
*hp
);
611 /* See if the passed line buffer, which may include trailing newline (sequence)
612 * is a mail From_ header line according to RFC 4155 */
613 FL
int is_head(char const *linebuf
, size_t linelen
);
615 /* Savage extract date field from From_ line. *linelen* is convenience as line
616 * must be terminated (but it may end in a newline [sequence]).
617 * Return wether the From_ line was parsed successfully */
618 FL
int extract_date_from_from_(char const *line
, size_t linelen
,
619 char datebuf
[FROM_DATEBUF
]);
621 FL
void extract_header(FILE *fp
, struct header
*hp
);
622 #define hfieldX(a, b) hfield_mult(a, b, 1)
623 #define hfield1(a, b) hfield_mult(a, b, 0)
624 FL
char * hfield_mult(char const *field
, struct message
*mp
, int mult
);
625 FL
char const * thisfield(char const *linebuf
, char const *field
);
626 FL
char * nameof(struct message
*mp
, int reptype
);
627 FL
char const * skip_comment(char const *cp
);
628 FL
char const * routeaddr(char const *name
);
629 FL
int is_addr_invalid(struct name
*np
, int putmsg
);
631 /* Does *NP* point to a file or pipe addressee? */
632 #define is_fileorpipe_addr(NP) \
633 (((NP)->n_flags & NAME_ADDRSPEC_ISFILEORPIPE) != 0)
635 /* Return skinned version of *NP*s name */
636 #define skinned_name(NP) \
637 (assert((NP)->n_flags & NAME_SKINNED), \
638 ((struct name const*)NP)->n_name)
640 /* Skin an address according to the RFC 822 interpretation of "host-phrase" */
641 FL
char * skin(char const *name
);
643 /* Skin *name* and extract the *addr-spec* according to RFC 5322.
644 * Store the result in .ag_skinned and also fill in those .ag_ fields that have
645 * actually been seen.
646 * Return 0 if something good has been parsed, 1 if fun didn't exactly know how
647 * to deal with the input, or if that was plain invalid */
648 FL
int addrspec_with_guts(int doskin
, char const *name
,
649 struct addrguts
*agp
);
651 FL
char * realname(char const *name
);
652 FL
char * name1(struct message
*mp
, int reptype
);
653 FL
int msgidcmp(const char *s1
, const char *s2
);
654 FL
int is_ign(char const *field
, size_t fieldlen
,
655 struct ignoretab ignore
[2]);
656 FL
int member(char const *realfield
, struct ignoretab
*table
);
657 FL
char const * fakefrom(struct message
*mp
);
658 FL
char const * fakedate(time_t t
);
659 FL
time_t unixtime(char const *from
);
660 FL
time_t rfctime(char const *date
);
661 FL
time_t combinetime(int year
, int month
, int day
,
662 int hour
, int minute
, int second
);
663 FL
void substdate(struct message
*m
);
664 FL
int check_from_and_sender(struct name
*fromfield
,
665 struct name
*senderfield
);
666 FL
char * getsender(struct message
*m
);
670 FL
char const * imap_fileof(char const *xcp
);
671 FL
enum okay
imap_noop(void);
672 FL
enum okay
imap_select(struct mailbox
*mp
, off_t
*size
, int *count
,
674 FL
int imap_setfile(const char *xserver
, int nmail
, int isedit
);
675 FL
enum okay
imap_header(struct message
*m
);
676 FL
enum okay
imap_body(struct message
*m
);
677 FL
void imap_getheaders(int bot
, int top
);
678 FL
void imap_quit(void);
679 FL
enum okay
imap_undelete(struct message
*m
, int n
);
680 FL
enum okay
imap_unread(struct message
*m
, int n
);
681 FL
int imap_imap(void *vp
);
682 FL
int imap_newmail(int nmail
);
683 FL
enum okay
imap_append(const char *xserver
, FILE *fp
);
684 FL
void imap_folders(const char *name
, int strip
);
685 FL
enum okay
imap_copy(struct message
*m
, int n
, const char *name
);
686 FL
enum okay
imap_search1(const char *spec
, int f
);
687 FL
int imap_thisaccount(const char *cp
);
688 FL
enum okay
imap_remove(const char *name
);
689 FL
enum okay
imap_rename(const char *old
, const char *new);
690 FL
enum okay
imap_dequeue(struct mailbox
*mp
, FILE *fp
);
691 FL
int cconnect(void *vp
);
692 FL
int cdisconnect(void *vp
);
693 FL
int ccache(void *vp
);
694 FL
int disconnected(const char *file
);
695 FL
void transflags(struct message
*omessage
, long omsgCount
,
697 FL
time_t imap_read_date_time(const char *cp
);
698 FL
const char * imap_make_date_time(time_t t
);
700 # define imap_imap ccmdnotsupp
701 # define cconnect ccmdnotsupp
702 # define cdisconnect ccmdnotsupp
703 # define ccache ccmdnotsupp
706 FL
time_t imap_read_date(const char *cp
);
707 FL
char * imap_quotestr(const char *s
);
708 FL
char * imap_unquotestr(const char *s
);
711 FL
enum okay
imap_search(const char *spec
, int f
);
714 FL
int setfile(char const *name
, int nmail
);
715 FL
int newmailinfo(int omsgCount
);
717 /* Interpret user commands. If standard input is not a tty, print no prompt */
718 FL
void commands(void);
720 /* Evaluate a single command.
721 * .ev_add_history and .ev_new_content will be updated upon success.
722 * Command functions return 0 for success, 1 for error, and -1 for abort.
723 * 1 or -1 aborts a load or source, a -1 aborts the interactive command loop */
724 FL
int evaluate(struct eval_ctx
*evp
);
725 /* TODO drop execute() is the legacy version of evaluate().
726 * Contxt is non-zero if called while composing mail */
727 FL
int execute(char *linebuf
, int contxt
, size_t linesize
);
729 FL
void setmsize(int sz
);
730 FL
void onintr(int s
);
731 FL
void announce(int printheaders
);
732 FL
int newfileinfo(void);
733 FL
int getmdot(int nmail
);
734 FL
void initbox(const char *name
);
736 /* Print the docstring of `comm', which may be an abbreviation.
737 * Return FAL0 if there is no such command */
738 #ifdef HAVE_DOCSTRINGS
739 FL bool_t
print_comm_docstr(char const *comm
);
743 FL
int getmsglist(char *buf
, int *vector
, int flags
);
744 FL
int getrawlist(const char *line
, size_t linesize
,
745 char **argv
, int argc
, int echolist
);
746 FL
int first(int f
, int m
);
747 FL
void mark(int mesg
, int f
);
751 FL
int zwrite(void *cookie
, const char *wbp
, int num
);
752 FL
int zfree(void *cookie
);
753 FL
int zread(void *cookie
, char *rbp
, int num
);
754 FL
void * zalloc(FILE *fp
);
755 #endif /* HAVE_IMAP */
758 FL
int maildir_setfile(const char *name
, int nmail
, int isedit
);
759 FL
void maildir_quit(void);
760 FL
enum okay
maildir_append(const char *name
, FILE *fp
);
761 FL
enum okay
maildir_remove(const char *name
);
765 /* *charset-7bit*, else CHARSET_7BIT */
766 FL
char const * charset_get_7bit(void);
768 /* *charset-8bit*, else CHARSET_8BIT */
769 FL
char const * charset_get_8bit(void);
771 /* LC_CTYPE:CODESET / *ttycharset*, else *charset-8bit*, else CHARSET_8BIT */
772 FL
char const * charset_get_lc(void);
774 /* *sendcharsets* / *charset-8bit* iterator.
775 * *a_charset_to_try_first* may be used to prepend a charset (as for
776 * *reply-in-same-charset*); works correct for !HAVE_ICONV */
777 FL
void charset_iter_reset(char const *a_charset_to_try_first
);
778 FL
char const * charset_iter_next(void);
779 FL
char const * charset_iter_current(void);
780 FL
void charset_iter_recurse(char *outer_storage
[2]); /* TODO LEGACY */
781 FL
void charset_iter_restore(char *outer_storage
[2]); /* TODO LEGACY */
783 FL
char const * need_hdrconv(struct header
*hp
, enum gfield w
);
784 FL
enum mimeenc
mime_getenc(char *h
);
785 FL
char * mime_getparam(char const *param
, char *h
);
787 /* Get the boundary out of a Content-Type: multipart/xyz header field, return
788 * salloc()ed copy of it; store strlen() in *len if set */
789 FL
char * mime_get_boundary(char *h
, size_t *len
);
791 /* Create a salloc()ed MIME boundary */
792 FL
char * mime_create_boundary(void);
794 /* Classify content of *fp* as necessary and fill in arguments; **charset* is
795 * left alone unless it's non-NULL */
796 FL
int mime_classify_file(FILE *fp
, char const **contenttype
,
797 char const **charset
, int *do_iconv
);
800 FL
enum mimecontent
mime_classify_content_of_part(struct mimepart
const *mip
);
802 /* Return the Content-Type matching the extension of name */
803 FL
char * mime_classify_content_type_by_fileext(char const *name
);
805 /* "mimetypes" command */
806 FL
int c_mimetypes(void *v
);
808 FL
void mime_fromhdr(struct str
const *in
, struct str
*out
,
810 FL
char * mime_fromaddr(char const *name
);
812 /* fwrite(3) performing the given MIME conversion */
813 FL ssize_t
mime_write(char const *ptr
, size_t size
, FILE *f
,
814 enum conversion convert
, enum tdflags dflags
,
815 struct quoteflt
*qf
, struct str
*rest
);
816 FL ssize_t
xmime_write(char const *ptr
, size_t size
, /* TODO LEGACY */
817 FILE *f
, enum conversion convert
, enum tdflags dflags
,
822 * Content-Transfer-Encodings as defined in RFC 2045:
823 * - Quoted-Printable, section 6.7
824 * - Base64, section 6.8
827 /* How many characters of (the complete body) *ln* need to be quoted */
828 FL
size_t mime_cte_mustquote(char const *ln
, size_t lnlen
, bool_t ishead
);
830 /* How much space is necessary to encode *len* bytes in QP, worst case.
831 * Includes room for terminator */
832 FL
size_t qp_encode_calc_size(size_t len
);
834 /* If *flags* includes QP_ISHEAD these assume "word" input and use special
835 * quoting rules in addition; soft line breaks are not generated.
836 * Otherwise complete input lines are assumed and soft line breaks are
837 * generated as necessary */
838 FL
struct str
* qp_encode(struct str
*out
, struct str
const *in
,
841 FL
struct str
* qp_encode_cp(struct str
*out
, char const *cp
,
843 FL
struct str
* qp_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
847 /* If *rest* is set then decoding will assume body text input (assumes input
848 * represents lines, only create output when input didn't end with soft line
849 * break [except it finalizes an encoded CRLF pair]), otherwise it is assumed
850 * to decode a header strings and (1) uses special decoding rules and (b)
851 * directly produces output.
852 * The buffers of *out* and possibly *rest* will be managed via srealloc().
853 * Returns OKAY. XXX or STOP on error (in which case *out* is set to an error
854 * XXX message); caller is responsible to free buffers */
855 FL
int qp_decode(struct str
*out
, struct str
const *in
,
858 /* How much space is necessary to encode *len* bytes in Base64, worst case.
859 * Includes room for (CR/LF/CRLF and) terminator */
860 FL
size_t b64_encode_calc_size(size_t len
);
862 /* Note these simply convert all the input (if possible), including the
863 * insertion of NL sequences if B64_CRLF or B64_LF is set (and multiple thereof
864 * if B64_MULTILINE is set).
865 * Thus, in the B64_BUF case, better call b64_encode_calc_size() first */
866 FL
struct str
* b64_encode(struct str
*out
, struct str
const *in
,
867 enum b64flags flags
);
868 FL
struct str
* b64_encode_cp(struct str
*out
, char const *cp
,
869 enum b64flags flags
);
870 FL
struct str
* b64_encode_buf(struct str
*out
, void const *vp
, size_t vp_len
,
871 enum b64flags flags
);
873 /* If *rest* is set then decoding will assume text input.
874 * The buffers of *out* and possibly *rest* will be managed via srealloc().
875 * Returns OKAY or STOP on error (in which case *out* is set to an error
876 * message); caller is responsible to free buffers */
877 FL
int b64_decode(struct str
*out
, struct str
const *in
,
884 FL
struct name
* nalloc(char *str
, enum gfield ntype
);
885 FL
struct name
* ndup(struct name
*np
, enum gfield ntype
);
886 FL
struct name
* cat(struct name
*n1
, struct name
*n2
);
887 FL
int count(struct name
const *np
);
889 FL
struct name
* extract(char const *line
, enum gfield ntype
);
890 FL
struct name
* lextract(char const *line
, enum gfield ntype
);
891 FL
char * detract(struct name
*np
, enum gfield ntype
);
893 /* Get a lextract() list via readstr_input(), reassigning to *np* */
894 FL
struct name
* grab_names(const char *field
, struct name
*np
, int comma
,
897 FL
struct name
* checkaddrs(struct name
*np
);
898 FL
struct name
* usermap(struct name
*names
, bool_t force_metoo
);
899 FL
struct name
* elide(struct name
*names
);
900 FL
struct name
* delete_alternates(struct name
*np
);
901 FL
int is_myname(char const *name
);
903 /* Dispatch a message to all pipe and file addresses TODO -> sendout.c */
904 FL
struct name
* outof(struct name
*names
, FILE *fo
, struct header
*hp
,
907 /* Handling of alias groups */
909 /* Locate a group name and return it */
910 FL
struct grouphead
* findgroup(char *name
);
912 /* Print a group out on stdout */
913 FL
void printgroup(char *name
);
915 FL
void remove_group(char const *name
);
919 FL
enum okay
ssl_open(const char *server
, struct sock
*sp
, const char *uhp
);
920 FL
void ssl_gen_err(const char *fmt
, ...);
921 FL
int cverify(void *vp
);
922 FL
FILE * smime_sign(FILE *ip
, struct header
*);
923 FL
FILE * smime_encrypt(FILE *ip
, const char *certfile
, const char *to
);
924 FL
struct message
* smime_decrypt(struct message
*m
, const char *to
,
925 const char *cc
, int signcall
);
926 FL
enum okay
smime_certsave(struct message
*m
, int n
, FILE *op
);
928 # define cverify ccmdnotsupp
933 FL
enum okay
pop3_noop(void);
934 FL
int pop3_setfile(const char *server
, int nmail
, int isedit
);
935 FL
enum okay
pop3_header(struct message
*m
);
936 FL
enum okay
pop3_body(struct message
*m
);
937 FL
void pop3_quit(void);
942 * Subprocesses, popen, but also file handling with registering
945 FL
FILE * safe_fopen(const char *file
, const char *mode
, int *omode
);
946 FL
FILE * Fopen(const char *file
, const char *mode
);
947 FL
FILE * Fdopen(int fd
, const char *mode
);
948 FL
int Fclose(FILE *fp
);
949 FL
FILE * Zopen(const char *file
, const char *mode
, int *compression
);
951 /* Create a temporary file in tempdir, use prefix for its name, store the
952 * unique name in fn, and return a stdio FILE pointer with access mode.
953 * *bits* specifies the access mode of the newly created temporary file */
954 FL
FILE * Ftemp(char **fn
, char const *prefix
, char const *mode
,
955 int bits
, int register_file
);
957 /* Free the resources associated with the given filename. To be called after
958 * unlink(). Since this function can be called after receiving a signal, the
959 * variable must be made NULL first and then free()d, to avoid more than one
960 * free() call in all circumstances */
961 FL
void Ftfree(char **fn
);
963 /* Create a pipe and ensure CLOEXEC bit is set in both descriptors */
964 FL bool_t
pipe_cloexec(int fd
[2]);
966 FL
FILE * Popen(const char *cmd
, const char *mode
, const char *shell
,
969 FL bool_t
Pclose(FILE *ptr
, bool_t dowait
);
971 FL
void close_all_files(void);
972 FL
int run_command(char const *cmd
, sigset_t
*mask
, int infd
,
973 int outfd
, char const *a0
, char const *a1
, char const *a2
);
974 FL
int start_command(const char *cmd
, sigset_t
*mask
, int infd
,
975 int outfd
, const char *a0
, const char *a1
, const char *a2
);
976 FL
void prepare_child(sigset_t
*nset
, int infd
, int outfd
);
977 FL
void sigchild(int signo
);
978 FL
void free_child(int pid
);
980 /* Wait for pid, return wether we've had a normal EXIT_SUCCESS exit.
981 * If wait_status is set, set it to the reported waitpid(2) wait status */
982 FL bool_t
wait_child(int pid
, int *wait_status
);
985 FL
int quitcmd(void *v
);
987 FL
int holdbits(void);
988 FL
void save_mbox_for_possible_quitstuff(void); /* TODO DROP IF U CAN */
989 FL
enum okay
makembox(void);
990 FL
int savequitflags(void);
991 FL
void restorequitflags(int);
994 FL
int sendmp(struct message
*mp
, FILE *obuf
, struct ignoretab
*doign
,
995 char const *prefix
, enum sendaction action
, off_t
*stats
);
998 FL
int mail(struct name
*to
, struct name
*cc
, struct name
*bcc
,
999 char *subject
, struct attachment
*attach
,
1000 char *quotefile
, int recipient_record
);
1001 FL
int csendmail(void *v
);
1002 FL
int cSendmail(void *v
);
1003 FL
enum okay
mail1(struct header
*hp
, int printheaders
,
1004 struct message
*quote
, char *quotefile
, int recipient_record
,
1006 FL
int mkdate(FILE *fo
, const char *field
);
1007 FL
int puthead(struct header
*hp
, FILE *fo
, enum gfield w
,
1008 enum sendaction action
, enum conversion convert
,
1009 char const *contenttype
, char const *charset
);
1010 FL
enum okay
resend_msg(struct message
*mp
, struct name
*to
, int add_resent
);
1017 FL
char * smtp_auth_var(const char *type
, const char *addr
);
1018 FL
int smtp_mta(char *server
, struct name
*to
, FILE *fi
,
1019 struct header
*hp
, const char *user
, const char *password
,
1020 const char *skinned
);
1028 FL
int cspam_clear(void *v
);
1029 FL
int cspam_set(void *v
);
1030 FL
int cspam_forget(void *v
);
1031 FL
int cspam_ham(void *v
);
1032 FL
int cspam_rate(void *v
);
1033 FL
int cspam_spam(void *v
);
1035 # define cspam_clear ccmdnotsupp
1036 # define cspam_set ccmdnotsupp
1037 # define cspam_forget ccmdnotsupp
1038 # define cspam_ham ccmdnotsupp
1039 # define cspam_rate ccmdnotsupp
1040 # define cspam_spam ccmdnotsupp
1045 FL
void ssl_set_vrfy_level(const char *uhp
);
1046 FL
enum okay
ssl_vrfy_decide(void);
1047 FL
char * ssl_method_string(const char *uhp
);
1048 FL
enum okay
smime_split(FILE *ip
, FILE **hp
, FILE **bp
, long xcount
,
1050 FL
FILE * smime_sign_assemble(FILE *hp
, FILE *bp
, FILE *sp
);
1051 FL
FILE * smime_encrypt_assemble(FILE *hp
, FILE *yp
);
1052 FL
struct message
* smime_decrypt_assemble(struct message
*m
, FILE *hp
,
1054 FL
int ccertsave(void *v
);
1055 FL
enum okay
rfc2595_hostname_match(const char *host
, const char *pattern
);
1057 # define ccertsave ccmdnotsupp
1062 * This bundles several different string related support facilities:
1063 * - auto-reclaimed string storage (memory goes away on command loop ticks)
1064 * - plain char* support functions which use unspecified or smalloc() memory
1065 * - struct str related support funs
1066 * - our iconv(3) wrapper
1069 /* Auto-reclaimed string storage */
1072 # define SALLOC_DEBUG_ARGS , char const *mdbg_file, int mdbg_line
1073 # define SALLOC_DEBUG_ARGSCALL , mdbg_file, mdbg_line
1075 # define SALLOC_DEBUG_ARGS
1076 # define SALLOC_DEBUG_ARGSCALL
1079 /* Allocate size more bytes of space and return the address of the first byte
1080 * to the caller. An even number of bytes are always allocated so that the
1081 * space will always be on a word boundary */
1082 FL
void * salloc(size_t size SALLOC_DEBUG_ARGS
);
1083 FL
void * csalloc(size_t nmemb
, size_t size SALLOC_DEBUG_ARGS
);
1085 # define salloc(SZ) salloc(SZ, __FILE__, __LINE__)
1086 # define csalloc(NM,SZ) csalloc(NM, SZ, __FILE__, __LINE__)
1089 /* Auto-reclaim string storage; if only_if_relaxed is true then only perform
1090 * the reset when a srelax_hold() is currently active */
1091 FL
void sreset(bool_t only_if_relaxed
);
1093 /* The "problem" with sreset() is that it releases all string storage except
1094 * what was present once spreserve() had been called; it therefore cannot be
1095 * called from all that code which yet exists and walks about all the messages
1096 * in order, e.g. quit(), searches, etc., because, unfortunately, these code
1097 * paths are reached with new intermediate string dope already in use.
1098 * Thus such code should take a srelax_hold(), successively call srelax() after
1099 * a single message has been handled, and finally srelax_rele() (unless it is
1100 * clear that sreset() occurs anyway) */
1101 FL
void srelax_hold(void);
1102 FL
void srelax_rele(void);
1103 FL
void srelax(void);
1105 /* Make current string storage permanent: new allocs will be auto-reclaimed by
1106 * sreset(). This is called once only, from within main() */
1107 FL
void spreserve(void);
1109 /* 'sstats' command */
1111 FL
int c_sstats(void *v
);
1114 /* Return a pointer to a dynamic copy of the argument */
1115 FL
char * savestr(char const *str SALLOC_DEBUG_ARGS
);
1116 FL
char * savestrbuf(char const *sbuf
, size_t sbuf_len SALLOC_DEBUG_ARGS
);
1118 # define savestr(CP) savestr(CP, __FILE__, __LINE__)
1119 # define savestrbuf(CBP,CBL) savestrbuf(CBP, CBL, __FILE__, __LINE__)
1122 /* Make copy of argument incorporating old one, if set, separated by space */
1123 FL
char * save2str(char const *str
, char const *old SALLOC_DEBUG_ARGS
);
1125 # define save2str(S,O) save2str(S, O, __FILE__, __LINE__)
1129 FL
char * savecat(char const *s1
, char const *s2 SALLOC_DEBUG_ARGS
);
1131 # define savecat(S1,S2) savecat(S1, S2, __FILE__, __LINE__)
1134 /* Create duplicate, lowercasing all characters along the way */
1135 FL
char * i_strdup(char const *src SALLOC_DEBUG_ARGS
);
1137 # define i_strdup(CP) i_strdup(CP, __FILE__, __LINE__)
1140 /* Extract the protocol base and return a duplicate */
1141 FL
char * protbase(char const *cp SALLOC_DEBUG_ARGS
);
1143 # define protbase(CP) protbase(CP, __FILE__, __LINE__)
1146 /* URL en- and decoding (RFC 1738, but not really) */
1147 FL
char * urlxenc(char const *cp SALLOC_DEBUG_ARGS
);
1148 FL
char * urlxdec(char const *cp SALLOC_DEBUG_ARGS
);
1150 # define urlxenc(CP) urlxenc(CP, __FILE__, __LINE__)
1151 # define urlxdec(CP) urlxdec(CP, __FILE__, __LINE__)
1155 FL
struct str
* str_concat_csvl(struct str
*self
, ...);
1156 FL
struct str
* str_concat_cpa(struct str
*self
, char const * const *cpa
,
1157 char const *sep_o_null SALLOC_DEBUG_ARGS
);
1159 # define str_concat_cpa(S,A,N) str_concat_cpa(S, A, N, __FILE__, __LINE__)
1162 /* Plain char* support, not auto-reclaimed (unless noted) */
1164 /* Are any of the characters in the two strings the same? */
1165 FL
int anyof(char const *s1
, char const *s2
);
1167 /* Treat *iolist as a sep separated list of strings; find and return the
1168 * next entry, trimming surrounding whitespace, and point *iolist to the next
1169 * entry or to NULL if no more entries are contained. If ignore_empty is not
1170 * set empty entries are started over. Return NULL or an entry */
1171 FL
char * n_strsep(char **iolist
, char sep
, bool_t ignore_empty
);
1172 #define strcomma(IOL,IGN) n_strsep(IOL, ',', IGN)
1174 /* Copy a string, lowercasing it as we go; *size* is buffer size of *dest*;
1175 * *dest* will always be terminated unless *size* is 0 */
1176 FL
void i_strcpy(char *dest
, char const *src
, size_t size
);
1178 /* Is *as1* a valid prefix of *as2*? */
1179 FL
int is_prefix(char const *as1
, char const *as2
);
1181 /* Find the last AT @ before the first slash */
1182 FL
char const * last_at_before_slash(char const *sp
);
1184 /* Get (and isolate) the last, possibly quoted part of linebuf, set *needs_list
1185 * to indicate wether getmsglist() et al need to be called to collect
1186 * additional args that remain in linebuf. Return NULL on "error" */
1187 FL
char * laststring(char *linebuf
, bool_t
*needs_list
, bool_t strip
);
1189 /* Convert a string to lowercase, in-place and with multibyte-aware */
1190 FL
void makelow(char *cp
);
1192 /* Is *sub* a substring of *str*, case-insensitive and multibyte-aware? */
1193 FL
int substr(const char *str
, const char *sub
);
1195 /* Lazy vsprintf wrapper */
1196 #ifndef HAVE_SNPRINTF
1197 FL
int snprintf(char *str
, size_t size
, const char *format
, ...);
1200 FL
char * sstpcpy(char *dst
, const char *src
);
1201 FL
char * sstrdup(char const *cp SMALLOC_DEBUG_ARGS
);
1202 FL
char * sbufdup(char const *cp
, size_t len SMALLOC_DEBUG_ARGS
);
1204 # define sstrdup(CP) sstrdup(CP, __FILE__, __LINE__)
1205 # define sbufdup(CP,L) sbufdup(CP, L, __FILE__, __LINE__)
1208 FL
char * n_strlcpy(char *dst
, const char *src
, size_t len
);
1210 /* Locale-independent character class functions */
1211 FL
int asccasecmp(char const *s1
, char const *s2
);
1212 FL
int ascncasecmp(char const *s1
, char const *s2
, size_t sz
);
1213 FL
char const * asccasestr(char const *haystack
, char const *xneedle
);
1214 FL bool_t
is_asccaseprefix(char const *as1
, char const *as2
);
1216 /* struct str related support funs */
1218 /* *self->s* is srealloc()ed */
1219 FL
struct str
* n_str_dup(struct str
*self
, struct str
const *t
1220 SMALLOC_DEBUG_ARGS
);
1222 /* *self->s* is srealloc()ed, *self->l* incremented */
1223 FL
struct str
* n_str_add_buf(struct str
*self
, char const *buf
, size_t buflen
1224 SMALLOC_DEBUG_ARGS
);
1225 #define n_str_add(S, T) n_str_add_buf(S, (T)->s, (T)->l)
1226 #define n_str_add_cp(S, CP) n_str_add_buf(S, CP, (CP) ? strlen(CP) : 0)
1229 # define n_str_dup(S,T) n_str_dup(S, T, __FILE__, __LINE__)
1230 # define n_str_add_buf(S,B,BL) n_str_add_buf(S, B, BL, __FILE__, __LINE__)
1233 /* Our iconv(3) wrappers */
1236 FL iconv_t
n_iconv_open(char const *tocode
, char const *fromcode
);
1237 /* If *cd* == *iconvd*, assigns -1 to the latter */
1238 FL
void n_iconv_close(iconv_t cd
);
1240 /* Reset encoding state */
1242 FL
void n_iconv_reset(iconv_t cd
);
1245 /* iconv(3), but return *errno* or 0; *skipilseq* forces step over illegal byte
1246 * sequences; likewise iconv_str(), but which auto-grows on E2BIG errors; *in*
1247 * and *in_rest_or_null* may be the same object.
1248 * Note: EINVAL (incomplete sequence at end of input) is NOT handled, so the
1249 * replacement character must be added manually if that happens at EOF! */
1250 FL
int n_iconv_buf(iconv_t cd
, char const **inb
, size_t *inbleft
,
1251 char **outb
, size_t *outbleft
, bool_t skipilseq
);
1252 FL
int n_iconv_str(iconv_t icp
, struct str
*out
, struct str
const *in
,
1253 struct str
*in_rest_or_null
, bool_t skipilseq
);
1257 FL
int thread(void *vp
);
1258 FL
int unthread(void *vp
);
1259 FL
struct message
* next_in_thread(struct message
*mp
);
1260 FL
struct message
* prev_in_thread(struct message
*mp
);
1261 FL
struct message
* this_in_thread(struct message
*mp
, long n
);
1262 FL
int sort(void *vp
);
1263 FL
int ccollapse(void *v
);
1264 FL
int cuncollapse(void *v
);
1265 FL
void uncollapse1(struct message
*m
, int always
);
1271 /* Return wether user says yes. If prompt is NULL, "Continue (y/n)? " is used
1272 * instead. If interactive, asks on STDIN, anything but [0]==[yY] is false.
1273 * If noninteractive, returns noninteract_default */
1274 FL bool_t
getapproval(char const *prompt
, bool_t noninteract_default
);
1276 /* [Yy]es or [Nn]o. Always `yes' if not interactive, always `no' on error */
1277 FL bool_t
yorn(char const *msg
);
1279 /* Get a password the expected way, return termios_state.ts_linebuf on
1280 * success or NULL on error */
1281 FL
char * getuser(char const *query
);
1283 /* Get a password the expected way, return termios_state.ts_linebuf on
1284 * success or NULL on error.
1285 * termios_state_reset() (def.h) must be called anyway */
1286 FL
char * getpassword(char const *query
);
1288 /* Get both, user and password in the expected way; simply reuses a value that
1289 * is set, otherwise calls one of the above.
1290 * Returns true only if we have a user and a password.
1291 * *user* will be savestr()ed if neither it nor *pass* have a default value
1292 * (so that termios_state.ts_linebuf carries only one) */
1293 FL bool_t
getcredentials(char **user
, char **pass
);
1295 /* Overall interactive terminal life cycle for command line editor library */
1296 #if defined HAVE_EDITLINE || defined HAVE_READLINE
1297 # define TTY_WANTS_SIGWINCH
1299 FL
void tty_init(void);
1300 FL
void tty_destroy(void);
1302 /* Rather for main.c / SIGWINCH interaction only */
1303 FL
void tty_signal(int sig
);
1305 /* Read a line after printing prompt (if set and non-empty).
1306 * If n>0 assumes that *linebuf has n bytes of default content */
1307 FL
int tty_readline(char const *prompt
, char **linebuf
,
1308 size_t *linesize
, size_t n SMALLOC_DEBUG_ARGS
);
1310 # define tty_readline(A,B,C,D) tty_readline(A, B, C, D, __FILE__, __LINE__)
1313 /* Add a line (most likely as returned by tty_readline()) to the history
1314 * (only added for real if non-empty and doesn't begin with U+0020) */
1315 FL
void tty_addhist(char const *s
);
1317 #if defined HAVE_HISTORY &&\
1318 (defined HAVE_READLINE || defined HAVE_EDITLINE || defined HAVE_NCL)
1319 FL
int c_history(void *v
);
1322 #ifndef HAVE_AMALGAMATION
1327 /* vim:set fenc=utf-8:s-it-mode */