Rename userarg_extract() to lextract()..
[s-mailx.git] / extern.h
blob8fbab626ddb5582aae3f4e5988c726a9fecdb64b
1 /*
2 * S-nail - a mail user agent derived from Berkeley Mail.
4 * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
5 * Copyright (c) 2012 Steffen "Daode" Nurpmeso.
6 * All rights reserved.
7 */
8 /*-
9 * Copyright (c) 1992, 1993
10 * The Regents of the University of California. All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. All advertising materials mentioning features or use of this software
21 * must display the following acknowledgement:
22 * This product includes software developed by the University of
23 * California, Berkeley and its contributors.
24 * 4. Neither the name of the University nor the names of its contributors
25 * may be used to endorse or promote products derived from this software
26 * without specific prior written permission.
28 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
29 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
32 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 * SUCH DAMAGE.
41 /* aux.c */
42 void panic(const char *format, ...);
43 void holdint(void);
44 void relseint(void);
45 void touch(struct message *mp);
46 int is_dir(char *name);
47 int argcount(char **argv);
48 void i_strcpy(char *dest, const char *src, int size);
49 char *i_strdup(const char *src);
50 void makelow(char *cp);
51 int substr(const char *str, const char *sub);
52 char *colalign(const char *cp, int col, int fill);
53 void try_pager(FILE *fp);
54 int source(void *v);
55 int unstack(void);
56 void alter(char *name);
57 int blankline(char *linebuf);
58 int anyof(char *s1, char *s2);
59 int is_prefix(const char *as1, const char *as2);
60 char *last_at_before_slash(const char *sp);
61 enum protocol which_protocol(const char *name);
62 const char *protfile(const char *xcp);
63 char *protbase(const char *cp);
64 int disconnected(const char *file);
65 unsigned pjw(const char *cp);
66 long nextprime(long n);
67 char *strenc(const char *cp);
68 char *strdec(const char *cp);
69 #ifdef USE_MD5
70 char *md5tohex(const void *vp);
71 char *cram_md5_string(const char *user, const char *pass, const char *b64);
72 #endif
73 char *getuser(void);
74 char *getpassword(struct termios *otio, int *reset_tio, const char *query);
75 void transflags(struct message *omessage, long omsgCount, int transparent);
76 char *getrandstring(size_t length);
77 void out_of_memory(void);
78 void *smalloc(size_t s);
79 void *srealloc(void *v, size_t s);
80 void *scalloc(size_t nmemb, size_t size);
81 char *sstpcpy(char *dst, const char *src);
82 char *sstrdup(const char *cp);
83 enum okay makedir(const char *name);
84 enum okay cwget(struct cw *cw);
85 enum okay cwret(struct cw *cw);
86 void cwrelse(struct cw *cw);
87 void makeprint(struct str *in, struct str *out);
88 char *prstr(const char *s);
89 int prout(const char *s, size_t sz, FILE *fp);
90 int putuc(int u, int c, FILE *fp);
91 int asccasecmp(const char *s1, const char *s2);
92 int ascncasecmp(const char *s1, const char *s2, size_t sz);
93 char *asccasestr(const char *haystack, const char *xneedle);
94 /* base64.c */
95 char *strtob64(const char *p);
96 char *memtob64(const void *vp, size_t isz);
97 size_t mime_write_tob64(struct str *in, FILE *fo, int is_header);
98 void mime_fromb64(struct str *in, struct str *out, int is_text);
99 void mime_fromb64_b(struct str *in, struct str *out, int is_text, FILE *f);
100 /* cache.c */
101 enum okay getcache1(struct mailbox *mp, struct message *m,
102 enum needspec need, int setflags);
103 enum okay getcache(struct mailbox *mp, struct message *m, enum needspec need);
104 void putcache(struct mailbox *mp, struct message *m);
105 void initcache(struct mailbox *mp);
106 void purgecache(struct mailbox *mp, struct message *m, long mc);
107 void delcache(struct mailbox *mp, struct message *m);
108 enum okay cache_setptr(int transparent);
109 enum okay cache_list(struct mailbox *mp, const char *base, int strip, FILE *fp);
110 enum okay cache_remove(const char *name);
111 enum okay cache_rename(const char *old, const char *new);
112 unsigned long cached_uidvalidity(struct mailbox *mp);
113 FILE *cache_queue(struct mailbox *mp);
114 enum okay cache_dequeue(struct mailbox *mp);
115 /* cmd1.c */
116 char *get_pager(void);
117 int headers(void *v);
118 int scroll(void *v);
119 int Scroll(void *v);
120 int screensize(void);
121 int from(void *v);
122 void printhead(int mesg, FILE *f, int threaded);
123 int pdot(void *v);
124 int pcmdlist(void *v);
125 char *laststring(char *linebuf, int *flag, int strip);
126 int more(void *v);
127 int More(void *v);
128 int type(void *v);
129 int Type(void *v);
130 int show(void *v);
131 int pipecmd(void *v);
132 int Pipecmd(void *v);
133 int top(void *v);
134 int stouch(void *v);
135 int mboxit(void *v);
136 int folders(void *v);
137 /* cmd2.c */
138 int next(void *v);
139 int save(void *v);
140 int Save(void *v);
141 int copycmd(void *v);
142 int Copycmd(void *v);
143 int cmove(void *v);
144 int cMove(void *v);
145 int cdecrypt(void *v);
146 int cDecrypt(void *v);
147 int cwrite(void *v);
148 int delete(void *v);
149 int deltype(void *v);
150 int undeletecmd(void *v);
151 int retfield(void *v);
152 int igfield(void *v);
153 int saveretfield(void *v);
154 int saveigfield(void *v);
155 int fwdretfield(void *v);
156 int fwdigfield(void *v);
157 int unignore(void *v);
158 int unretain(void *v);
159 int unsaveignore(void *v);
160 int unsaveretain(void *v);
161 int unfwdignore(void *v);
162 int unfwdretain(void *v);
163 /* cmd3.c */
164 int shell(void *v);
165 int dosh(void *v);
166 int help(void *v);
167 int schdir(void *v);
168 int respond(void *v);
169 int respondall(void *v);
170 int respondsender(void *v);
171 int followup(void *v);
172 int followupall(void *v);
173 int followupsender(void *v);
174 int preserve(void *v);
175 int unread(void *v);
176 int seen(void *v);
177 int messize(void *v);
178 int rexit(void *v);
179 int set(void *v);
180 int unset(void *v);
181 int group(void *v);
182 int ungroup(void *v);
183 int cfile(void *v);
184 int echo(void *v);
185 int Respond(void *v);
186 int Followup(void *v);
187 int forwardcmd(void *v);
188 int Forwardcmd(void *v);
189 int ifcmd(void *v);
190 int elsecmd(void *v);
191 int endifcmd(void *v);
192 int alternates(void *v);
193 int resendcmd(void *v);
194 int Resendcmd(void *v);
195 int newmail(void *v);
196 int shortcut(void *v);
197 struct shortcut *get_shortcut(const char *str);
198 int unshortcut(void *v);
199 struct oldaccount *get_oldaccount(const char *name);
200 int account(void *v);
201 int cflag(void *v);
202 int cunflag(void *v);
203 int canswered(void *v);
204 int cunanswered(void *v);
205 int cdraft(void *v);
206 int cundraft(void *v);
207 int ckill(void *v);
208 int cunkill(void *v);
209 int cscore(void *v);
210 int cnoop(void *v);
211 int cremove(void *v);
212 int crename(void *v);
213 /* cmdtab.c */
214 /* collect.c */
215 struct attachment *edit_attachments(struct attachment *attach);
216 struct attachment *add_attachment(struct attachment *attach, char *file,
217 int expand_file);
218 FILE *collect(struct header *hp, int printheaders, struct message *mp,
219 char *quotefile, int doprefix, int tflag);
220 void savedeadletter(FILE *fp);
221 /* dotlock.c */
222 int fcntl_lock(int fd, int type);
223 int dot_lock(const char *fname, int fd, int pollinterval, FILE *fp,
224 const char *msg);
225 void dot_unlock(const char *fname);
226 /* edit.c */
227 int editor(void *v);
228 int visual(void *v);
229 FILE *run_editor(FILE *fp, off_t size, int type, int readonly,
230 struct header *hp, struct message *mp, enum sendaction action,
231 sighandler_type oldint);
232 /* fio.c */
233 void setptr(FILE *ibuf, off_t offset);
234 int putline(FILE *obuf, char *linebuf, size_t count);
235 #define readline(a, b, c) readline_restart(a, b, c, 0)
236 int readline_restart(FILE *ibuf, char **linebuf, size_t *linesize, size_t n);
237 FILE *setinput(struct mailbox *mp, struct message *m, enum needspec need);
238 struct message *setdot(struct message *mp);
239 int rm(char *name);
240 void holdsigs(void);
241 void relsesigs(void);
242 off_t fsize(FILE *iob);
243 char *expand(char *name);
244 int getfold(char *name, int size);
245 char *getdeadletter(void);
246 char *fgetline(char **line, size_t *linesize, size_t *count,
247 size_t *llen, FILE *fp, int appendnl);
248 void newline_appended(void);
249 enum okay get_body(struct message *mp);
250 int sclose(struct sock *sp);
251 enum okay swrite(struct sock *sp, const char *data);
252 enum okay swrite1(struct sock *sp, const char *data, int sz, int use_buffer);
253 int sgetline(char **line, size_t *linesize, size_t *linelen, struct sock *sp);
254 enum okay sopen(const char *xserver, struct sock *sp, int use_ssl,
255 const char *uhp, const char *portstr, int verbose);
256 /* getname.c */
257 char *getname(int uid);
258 int getuserid(char *name);
259 /* getopt.c */
260 #ifdef USE_BUILTIN_GETOPT
261 int getopt(int argc, char *const argv[], const char *optstring);
262 #endif
263 /* head.c */
264 int is_head(char *linebuf, size_t linelen);
265 void parse(char *line, size_t linelen, struct headline *hl, char *pbuf);
266 void extract_header(FILE *fp, struct header *hp);
267 #define hfield(a, b) hfield_mult(a, b, 1)
268 char *hfield_mult(char *field, struct message *mp, int mult);
269 char *thisfield(const char *linebuf, const char *field);
270 char *nameof(struct message *mp, int reptype);
271 char *skip_comment(const char *cp);
272 char *routeaddr(const char *name);
273 char *skin(char *name);
274 char *skinned_name(struct name *np);
275 char *realname(char *name);
276 char *name1(struct message *mp, int reptype);
277 int msgidcmp(const char *s1, const char *s2);
278 int is_ign(char *field, size_t fieldlen, struct ignoretab ignore[2]);
279 int member(char *realfield, struct ignoretab *table);
280 char *fakefrom(struct message *mp);
281 char *fakedate(time_t t);
282 char *nexttoken(char *cp);
283 time_t unixtime(char *from);
284 time_t rfctime(char *date);
285 time_t combinetime(int year, int month, int day,
286 int hour, int minute, int second);
287 void substdate(struct message *m);
288 int check_from_and_sender(struct name *fromfield, struct name *senderfield);
289 char *getsender(struct message *m);
290 /* imap.c */
291 enum okay imap_noop(void);
292 enum okay imap_select(struct mailbox *mp, off_t *size, int *count,
293 const char *mbx);
294 int imap_setfile(const char *xserver, int newmail, int isedit);
295 enum okay imap_header(struct message *m);
296 enum okay imap_body(struct message *m);
297 void imap_getheaders(int bot, int top);
298 void imap_quit(void);
299 enum okay imap_undelete(struct message *m, int n);
300 enum okay imap_unread(struct message *m, int n);
301 int imap_imap(void *vp);
302 int imap_newmail(int autoinc);
303 enum okay imap_append(const char *xserver, FILE *fp);
304 void imap_folders(const char *name, int strip);
305 enum okay imap_copy(struct message *m, int n, const char *name);
306 enum okay imap_search1(const char *spec, int f);
307 int imap_thisaccount(const char *cp);
308 enum okay imap_remove(const char *name);
309 enum okay imap_rename(const char *old, const char *new);
310 enum okay imap_dequeue(struct mailbox *mp, FILE *fp);
311 int cconnect(void *vp);
312 int cdisconnect(void *vp);
313 int ccache(void *vp);
314 time_t imap_read_date_time(const char *cp);
315 time_t imap_read_date(const char *cp);
316 const char *imap_make_date_time(time_t t);
317 char *imap_quotestr(const char *s);
318 char *imap_unquotestr(const char *s);
319 /* imap_gssapi.c */
320 /* imap_search.c */
321 enum okay imap_search(const char *spec, int f);
322 /* junk.c */
323 int cgood(void *v);
324 int cjunk(void *v);
325 int cungood(void *v);
326 int cunjunk(void *v);
327 int cclassify(void *v);
328 int cprobability(void *v);
329 /* lex.c */
330 int setfile(char *name, int newmail);
331 int newmailinfo(int omsgCount);
332 void commands(void);
333 int execute(char *linebuf, int contxt, size_t linesize);
334 void setmsize(int sz);
335 void onintr(int s);
336 void announce(int printheaders);
337 int newfileinfo(void);
338 int getmdot(int newmail);
339 int pversion(void *v);
340 void load(char *name);
341 void initbox(const char *name);
342 /* list.c */
343 int getmsglist(char *buf, int *vector, int flags);
344 int getrawlist(const char *line, size_t linesize,
345 char **argv, int argc, int echolist);
346 int first(int f, int m);
347 void mark(int mesg, int f);
348 /* lzw.c */
349 int zwrite(void *cookie, const char *wbp, int num);
350 int zfree(void *cookie);
351 int zread(void *cookie, char *rbp, int num);
352 void *zalloc(FILE *fp);
353 /* macro.c */
354 int cdefine(void *v);
355 int define1(const char *name, int account);
356 int cundef(void *v);
357 int ccall(void *v);
358 int callaccount(const char *name);
359 int callhook(const char *name, int newmail);
360 int listaccounts(FILE *fp);
361 int cdefines(void *v);
362 void delaccount(const char *name);
363 /* maildir.c */
364 int maildir_setfile(const char *name, int newmail, int isedit);
365 void maildir_quit(void);
366 enum okay maildir_append(const char *name, FILE *fp);
367 enum okay maildir_remove(const char *name);
368 /* main.c */
369 int main(int argc, char *argv[]);
370 /* mime.c */
371 int mime_name_invalid(struct name *np, int putmsg);
372 struct name *checkaddrs(struct name *np);
373 char *gettcharset(void);
374 char *need_hdrconv(struct header *hp, enum gfield w);
375 #ifdef HAVE_ICONV
376 iconv_t iconv_open_ft(const char *tocode, const char *fromcode);
377 size_t iconv_ft(iconv_t cd, char **inb, size_t *inbleft,
378 char **outb, size_t *outbleft, int tolerant);
379 #endif /* HAVE_ICONV */
380 enum mimeenc mime_getenc(char *h);
381 int mime_getcontent(char *h);
382 char *mime_getparam(char *param, char *h);
383 char *mime_getboundary(char *h);
384 char *mime_filecontent(char *name);
385 int get_mime_convert(FILE *fp, char **contenttype, char **charset,
386 enum mimeclean *isclean, int dosign);
387 void mime_fromhdr(struct str *in, struct str *out, enum tdflags flags);
388 char *mime_fromaddr(char *name);
389 size_t prefixwrite(void *ptr, size_t size, size_t nmemb, FILE *f,
390 char *prefix, size_t prefixlen);
391 size_t mime_write(void *ptr, size_t size, FILE *f,
392 enum conversion convert, enum tdflags dflags,
393 char *prefix, size_t prefixlen,
394 char **rest, size_t *restsize);
395 /* names.c */
396 struct name *nalloc(char *str, enum gfield ntype);
397 struct name *ndup(struct name *np, enum gfield ntype);
398 struct name *extract(char *line, enum gfield ntype);
399 struct name *sextract(char *line, enum gfield ntype);
400 struct name *lextract(char *line, enum gfield ntype);
401 char *detract(struct name *np, enum gfield ntype);
402 struct name *outof(struct name *names, FILE *fo, struct header *hp);
403 int is_fileaddr(char *name);
404 struct name *usermap(struct name *names);
405 struct name *cat(struct name *n1, struct name *n2);
406 char **unpack(struct name *np);
407 struct name *elide(struct name *names);
408 int count(struct name *np);
409 struct name *delete_alternates(struct name *np);
410 int is_myname(char *name);
411 /* nss.c */
412 #ifdef USE_NSS
413 enum okay ssl_open(const char *server, struct sock *sp, const char *uhp);
414 void nss_gen_err(const char *fmt, ...);
415 #endif /* USE_NSS */
416 /* openssl.c */
417 #ifdef USE_OPENSSL
418 enum okay ssl_open(const char *server, struct sock *sp, const char *uhp);
419 void ssl_gen_err(const char *fmt, ...);
420 #endif /* USE_OPENSSL */
421 int cverify(void *vp);
422 FILE *smime_sign(FILE *ip, struct header *);
423 FILE *smime_encrypt(FILE *ip, const char *certfile, const char *to);
424 struct message *smime_decrypt(struct message *m, const char *to,
425 const char *cc, int signcall);
426 enum okay smime_certsave(struct message *m, int n, FILE *op);
427 /* pop3.c */
428 enum okay pop3_noop(void);
429 int pop3_setfile(const char *server, int newmail, int isedit);
430 enum okay pop3_header(struct message *m);
431 enum okay pop3_body(struct message *m);
432 void pop3_quit(void);
433 /* popen.c */
434 sighandler_type safe_signal(int signum, sighandler_type handler);
435 FILE *safe_fopen(const char *file, const char *mode, int *omode);
436 FILE *Fopen(const char *file, const char *mode);
437 FILE *Fdopen(int fd, const char *mode);
438 int Fclose(FILE *fp);
439 FILE *Zopen(const char *file, const char *mode, int *compression);
440 FILE *Popen(const char *cmd, const char *mode, const char *shell, int newfd1);
441 int Pclose(FILE *ptr);
442 void close_all_files(void);
443 int run_command(char *cmd, sigset_t *mask, int infd, int outfd,
444 char *a0, char *a1, char *a2);
445 int start_command(const char *cmd, sigset_t *mask, int infd, int outfd,
446 const char *a0, const char *a1, const char *a2);
447 void prepare_child(sigset_t *nset, int infd, int outfd);
448 void sigchild(int signo);
449 void free_child(int pid);
450 int wait_child(int pid);
451 /* quit.c */
452 int quitcmd(void *v);
453 void quit(void);
454 int holdbits(void);
455 enum okay makembox(void);
456 int savequitflags(void);
457 void restorequitflags(int);
458 /* send.c */
459 char *foldergets(char **s, size_t *size, size_t *count, size_t *llen,
460 FILE *stream);
461 #undef send
462 #define send(a, b, c, d, e, f) xsend(a, b, c, d, e, f)
463 int send(struct message *mp, FILE *obuf, struct ignoretab *doign,
464 char *prefix, enum sendaction action, off_t *stats);
465 /* sendout.c */
466 char *makeboundary(void);
467 int mail(struct name *to, struct name *cc, struct name *bcc,
468 struct name *smopts, char *subject, struct attachment *attach,
469 char *quotefile, int recipient_record, int tflag, int Eflag);
470 int sendmail(void *v);
471 int Sendmail(void *v);
472 enum okay mail1(struct header *hp, int printheaders, struct message *quote,
473 char *quotefile, int recipient_record, int doprefix, int tflag,
474 int Eflag);
475 int mkdate(FILE *fo, const char *field);
476 int puthead(struct header *hp, FILE *fo, enum gfield w,
477 enum sendaction action, enum conversion convert,
478 char *contenttype, char *charset);
479 enum okay resend_msg(struct message *mp, struct name *to, int add_resent);
480 /* smtp.c */
481 char *nodename(int mayoverride);
482 char *myaddrs(struct header *hp);
483 char *myorigin(struct header *hp);
484 char *smtp_auth_var(const char *type, const char *addr);
485 int smtp_mta(char *server, struct name *to, FILE *fi, struct header *hp,
486 const char *user, const char *password, const char *skinned);
487 /* ssl.c */
488 void ssl_set_vrfy_level(const char *uhp);
489 enum okay ssl_vrfy_decide(void);
490 char *ssl_method_string(const char *uhp);
491 enum okay smime_split(FILE *ip, FILE **hp, FILE **bp, long xcount, int keep);
492 FILE *smime_sign_assemble(FILE *hp, FILE *bp, FILE *sp);
493 FILE *smime_encrypt_assemble(FILE *hp, FILE *yp);
494 struct message *smime_decrypt_assemble(struct message *m, FILE *hp, FILE *bp);
495 int ccertsave(void *v);
496 enum okay rfc2595_hostname_match(const char *host, const char *pattern);
497 /* strings.c */
498 void *salloc(size_t size);
499 void *csalloc(size_t nmemb, size_t size);
500 void sreset(void);
501 void spreserve(void);
502 char *savestr(const char *str);
503 char *savestrbuf(const char *sbuf, size_t sbuf_len);
504 char *save2str(const char *str, const char *old);
505 char *savecat(const char *s1, const char *s2);
506 /* temp.c */
507 FILE *Ftemp(char **fn, char *prefix, char *mode, int bits, int register_file);
508 void Ftfree(char **fn);
509 void tinit(void);
510 /* thread.c */
511 int thread(void *vp);
512 int unthread(void *vp);
513 struct message *next_in_thread(struct message *mp);
514 struct message *prev_in_thread(struct message *mp);
515 struct message *this_in_thread(struct message *mp, long n);
516 int sort(void *vp);
517 int ccollapse(void *v);
518 int cuncollapse(void *v);
519 void uncollapse1(struct message *m, int always);
520 /* tty.c */
521 int grabh(struct header *hp, enum gfield gflags, int subjfirst);
522 char *readtty(char *prefix, char *string);
523 int yorn(char *msg);
524 /* v7.local.c */
525 void findmail(char *user, int force, char *buf, int size);
526 void demail(void);
527 char *username(void);
528 /* vars.c */
529 void assign(const char *name, const char *value);
530 char *vcopy(const char *str);
531 char *value(const char *name);
532 struct grouphead *findgroup(char *name);
533 void printgroup(char *name);
534 int hash(const char *name);
535 int unset_internal(const char *name);
536 void remove_group(const char *name);