quit()+descendants: add hold_sigs_on argument, let'em handle it
[s-mailx.git] / nail.h
blobd31d323dc940acfa20cee117cfd3826e678a9629
1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
2 *@ Header inclusion, macros, constants, types and the global var declarations.
4 * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
5 * Copyright (c) 2012 - 2016 Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
6 */
7 /*
8 * Copyright (c) 1980, 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
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. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
37 * Mail -- a mail program
39 * Author: Kurt Shoens (UCB) March 25, 1978
42 #include "config.h"
44 #include <sys/stat.h>
45 #include <sys/types.h>
47 #ifdef HAVE_GETTIMEOFDAY
48 # include <sys/time.h>
49 #endif
51 #include <errno.h>
52 #include <fcntl.h>
53 #include <limits.h>
54 #include <setjmp.h>
55 #include <signal.h>
56 #include <stdarg.h>
57 #include <stdio.h>
58 #include <stdlib.h>
59 #include <string.h>
60 #include <termios.h>
61 #include <time.h>
62 #include <unistd.h>
64 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
65 # include <stdint.h>
66 #else
67 # include <inttypes.h>
68 #endif
70 #ifdef HAVE_C90AMEND1
71 # include <wchar.h>
72 # include <wctype.h>
73 #endif
74 #ifdef HAVE_DEBUG
75 # include <assert.h>
76 #endif
77 #ifdef HAVE_ICONV
78 # include <iconv.h>
79 #endif
80 #ifdef HAVE_REGEX
81 # include <regex.h>
82 #endif
84 #ifdef HAVE_XSSL_MD5
85 # include <openssl/md5.h>
86 #endif
89 * Constants, some nail-specific macros
92 #if !defined NI_MAXHOST
93 # define NI_MAXHOST 1025
94 #endif
96 /* TODO PATH_MAX: fixed-size buffer is always wrong (think NFS) */
97 #ifndef PATH_MAX
98 # ifdef MAXPATHLEN
99 # define PATH_MAX MAXPATHLEN
100 # else
101 # define PATH_MAX 1024 /* _XOPEN_PATH_MAX POSIX 2008/Cor 1-2013 */
102 # endif
103 #endif
105 #ifndef HOST_NAME_MAX
106 # ifdef _POSIX_HOST_NAME_MAX
107 # define HOST_NAME_MAX _POSIX_HOST_NAME_MAX
108 # else
109 # define HOST_NAME_MAX 255
110 # endif
111 #endif
113 #ifndef NAME_MAX
114 # ifdef _POSIX_NAME_MAX
115 # define NAME_MAX _POSIX_NAME_MAX
116 # else
117 # define NAME_MAX 14
118 # endif
119 #endif
120 #if NAME_MAX < 8
121 # error NAME_MAX too small
122 #endif
124 #ifndef STDIN_FILENO
125 # define STDIN_FILENO 0
126 #endif
127 #ifndef STDOUT_FILENO
128 # define STDOUT_FILENO 1
129 #endif
130 #ifndef STDERR_FILENO
131 # define STDERR_FILENO 2
132 #endif
134 #ifdef NSIG_MAX
135 # undef NSIG
136 # define NSIG NSIG_MAX
137 #elif !defined NSIG
138 # define NSIG ((sizeof(sigset_t) * 8) - 1)
139 #endif
141 #ifdef O_CLOEXEC
142 # define _O_CLOEXEC O_CLOEXEC
143 # define _CLOEXEC_SET(FD) do {;} while(0)
144 #else
145 # define _O_CLOEXEC 0
146 # define _CLOEXEC_SET(FD) \
147 do { (void)fcntl((FD), F_SETFD, FD_CLOEXEC); } while (0)
148 #endif
150 #ifdef O_NOFOLLOW
151 # define n_O_NOFOLLOW O_NOFOLLOW
152 #else
153 # define n_O_NOFOLLOW 0
154 #endif
156 /* */
158 #if BUFSIZ + 0 > 2560 /* TODO simply use BUFSIZ? */
159 # define LINESIZE BUFSIZ /* max readable line width */
160 #else
161 # define LINESIZE 2560
162 #endif
163 #define BUFFER_SIZE (BUFSIZ >= (1u << 13) ? BUFSIZ : (1u << 14))
165 /* Network protocol newline */
166 #define NETNL "\015\012"
167 #define NETLINE(X) X NETNL
169 /* Number of Not-Yet-Dead calls that are remembered */
170 #if defined HAVE_DEBUG || defined HAVE_DEVEL || defined HAVE_NYD2
171 # ifdef HAVE_NYD2
172 # define NYD_CALLS_MAX (25 * 84)
173 # elif defined HAVE_DEVEL
174 # define NYD_CALLS_MAX (25 * 42)
175 # else
176 # define NYD_CALLS_MAX (25 * 10)
177 # endif
178 #endif
180 #define APPEND /* New mail goes to end of mailbox */
181 #define CBAD (-15555)
182 #define DOTLOCK_TRIES 5 /* Number of open(2) calls for dotlock */
183 #define FILE_LOCK_TRIES 10 /* Maximum tries before n_file_lock() fails */
184 #define FILE_LOCK_MILLIS 200 /* If UIZ_MAX, fall back to that */
185 #define n_ERROR "ERROR" /* Is-error? Also as n_error[] */
186 #define ERRORS_MAX 1000 /* Maximum error ring entries TODO configable*/
187 #define ESCAPE '~' /* Default escape for sending */
188 #define HIST_SIZE 242 /* tty.c: history list default size */
189 #define HSHSIZE 23 /* Hash prime TODO make dynamic, obsolete */
190 #define MAXARGC 1024 /* Maximum list of raw strings */
191 #define MAXEXP 25 /* Maximum expansion of aliases */
192 #define REFERENCES_MAX 20 /* Maximum entries in References: */
193 #define n_UNIREPL "\xEF\xBF\xBD" /* 0xFFFD in UTF-8 */
194 #define FTMP_OPEN_TRIES 10 /* Maximum number of Ftmp() open(2) tries */
196 #define ACCOUNT_NULL "null" /* Name of "null" account */
198 /* Some environment variables for pipe hooks */
199 #define AGENT_USER "NAIL_USER"
200 #define AGENT_USER_ENC "NAIL_USER_ENC"
201 #define AGENT_HOST "NAIL_HOST"
202 #define AGENT_HOST_PORT "NAIL_HOST_PORT"
204 /* Colour stuff */
205 #ifdef HAVE_COLOUR
206 # define n_COLOUR(X) X
207 #else
208 # define n_COLOUR(X)
209 #endif
211 /* Special FD requests for run_command() / start_command() */
212 #define COMMAND_FD_PASS -1
213 #define COMMAND_FD_NULL -2
215 /* */
216 #define FROM_DATEBUF 64 /* Size of RFC 4155 From_ line date */
217 #define DATE_DAYSYEAR 365L
218 #define DATE_SECSMIN 60L
219 #define DATE_MINSHOUR 60L
220 #define DATE_HOURSDAY 24L
221 #define DATE_SECSHOUR (DATE_SECSMIN * DATE_MINSHOUR)
222 #define DATE_SECSDAY (DATE_SECSHOUR * DATE_HOURSDAY)
224 /* *indentprefix* default as of POSIX */
225 #define INDENT_DEFAULT "\t"
227 /* Auto-reclaimed memory storage: size of the buffers. Maximum auto-reclaimed
228 * storage is that value /2, which is n_CTA()ed to be > 1024 */
229 #define n_MEMORY_AUTOREC_SIZE 0x2000u
230 /* Ugly, but avoid dynamic allocation for the management structure! */
231 #define n_MEMORY_AUTOREC_TYPE_SIZEOF (7 * sizeof(void*))
233 /* Default *encoding* as enum mime_enc below */
234 #define MIME_DEFAULT_ENCODING MIMEE_B64
236 /* Maximum allowed line length in a mail before QP folding is necessary), and
237 * the real limit we go for */
238 #define MIME_LINELEN_MAX 998 /* Plus CRLF */
239 #define MIME_LINELEN_LIMIT (MIME_LINELEN_MAX - 48)
241 /* Ditto, SHOULD */
242 #define MIME_LINELEN 78 /* Plus CRLF */
244 /* And in headers which contain an encoded word according to RFC 2047 there is
245 * yet another limit; also RFC 2045: 6.7, (5). */
246 #define MIME_LINELEN_RFC2047 76
248 /* Locations of mime.types(5) */
249 #define MIME_TYPES_USR "~/.mime.types"
250 #define MIME_TYPES_SYS "/etc/mime.types"
252 /* Fallback MIME charsets, if *charset-7bit* and *charset-8bit* or not set.
253 * Note: must be lowercase!
254 * (Keep in SYNC: ./nail.1:"Character sets", ./nail.h:CHARSET_*!) */
255 #define CHARSET_7BIT "us-ascii"
256 #ifdef HAVE_ICONV
257 # define CHARSET_8BIT "utf-8"
258 # define CHARSET_8BIT_OKEY charset_8bit
259 #else
260 # define CHARSET_8BIT "iso-8859-1"
261 # define CHARSET_8BIT_OKEY ttycharset
262 #endif
264 /* Some environment variables for pipe hooks etc. */
265 #define NAILENV_TMPDIR "NAIL_TMPDIR"
266 #define NAILENV_FILENAME "NAIL_FILENAME"
267 #define NAILENV_FILENAME_GENERATED "NAIL_FILENAME_GENERATED"
268 #define NAILENV_FILENAME_TEMPORARY "NAIL_FILENAME_TEMPORARY"
269 #define NAILENV_CONTENT "NAIL_CONTENT"
270 #define NAILENV_CONTENT_EVIDENCE "NAIL_CONTENT_EVIDENCE"
272 /* Is *W* a quoting (ASCII only) character? */
273 #define ISQUOTE(W) \
274 ((W) == n_WC_C('>') || (W) == n_WC_C('|') ||\
275 (W) == n_WC_C('}') || (W) == n_WC_C(':'))
277 /* Maximum number of quote characters (not bytes!) that'll be used on
278 * follow lines when compressing leading quote characters */
279 #define QUOTE_MAX 42
281 /* How much spaces should a <tab> count when *quote-fold*ing? (power-of-two!) */
282 #define QUOTE_TAB_SPACES 8
284 /* Smells fishy after, or asks for shell expansion, dependent on context */
285 #define n_SHEXP_MAGIC_PATH_CHARS "|&;<>{}()[]*?$`'\"\\"
287 /* Maximum size of a message that is passed through to the spam system */
288 #define SPAM_MAXSIZE 420000
290 /* Switch indicating necessity of terminal access interface (termcap.c) */
291 #if defined HAVE_TERMCAP || defined HAVE_COLOUR || defined HAVE_MLE
292 # define n_HAVE_TCAP
293 #endif
296 * OS, CC support, generic macros etc.
299 #define n_ISPOW2(X) ((((X) - 1) & (X)) == 0)
300 #define n_MIN(A, B) ((A) < (B) ? (A) : (B))
301 #define n_MAX(A, B) ((A) < (B) ? (B) : (A))
302 #define n_ABS(A) ((A) < 0 ? -(A) : (A))
304 /* OS: we're not a library, only set what needs special treatment somewhere */
305 #define OS_DRAGONFLY 0
306 #define OS_SOLARIS 0
307 #define OS_SUNOS 0
309 #ifdef __DragonFly__
310 # undef OS_DRAGONFLY
311 # define OS_DRAGONFLY 1
312 #elif defined __solaris__ || defined __sun
313 # if defined __SVR4 || defined __svr4__
314 # undef OS_SOLARIS
315 # define OS_SOLARIS 1
316 # else
317 # undef OS_SUNOS
318 # define OS_SUNOS 1
319 # endif
320 #endif
322 /* CC */
323 #define CC_CLANG 0
324 #define PREREQ_CLANG(X,Y) 0
325 #define CC_GCC 0
326 #define PREREQ_GCC(X,Y) 0
327 #define CC_TCC 0
328 #define PREREQ_TCC(X,Y) 0
330 #ifdef __clang__
331 # undef CC_CLANG
332 # undef PREREQ_CLANG
333 # define CC_CLANG 1
334 # define PREREQ_CLANG(X,Y) \
335 (__clang_major__ + 0 > (X) || \
336 (__clang_major__ + 0 == (X) && __clang_minor__ + 0 >= (Y)))
337 # define __EXTEN __extension__
339 #elif defined __GNUC__
340 # undef CC_GCC
341 # undef PREREQ_GCC
342 # define CC_GCC 1
343 # define PREREQ_GCC(X,Y) \
344 (__GNUC__ + 0 > (X) || (__GNUC__ + 0 == (X) && __GNUC_MINOR__ + 0 >= (Y)))
345 # define __EXTEN __extension__
347 #elif defined __TINYC__
348 # undef CC_TCC
349 # define CC_TCC 1
350 #endif
352 #ifndef __EXTEN
353 # define __EXTEN
354 #endif
356 /* Suppress some technical warnings via #pragma's unless developing.
357 * XXX Wild guesses: clang(1) 1.7 and (OpenBSD) gcc(1) 4.2.1 don't work */
358 #ifndef HAVE_DEVEL
359 # if PREREQ_CLANG(3, 4)
360 # pragma clang diagnostic ignored "-Wassign-enum"
361 # pragma clang diagnostic ignored "-Wdisabled-macro-expansion"
362 # pragma clang diagnostic ignored "-Wformat"
363 # pragma clang diagnostic ignored "-Wunused-result"
364 # elif PREREQ_GCC(4, 7)
365 # pragma GCC diagnostic ignored "-Wunused-local-typedefs"
366 # pragma GCC diagnostic ignored "-Wunused-result"
367 # pragma GCC diagnostic ignored "-Wformat"
368 # endif
369 #endif
371 /* For injection macros like DBG(), n_NATCH_CHAR() */
372 #define COMMA ,
374 #define EMPTY_FILE() typedef int n_CONCAT(avoid_empty_file__, n_FILE);
376 /* Pointer to size_t */
377 #define PTR2SIZE(X) ((size_t)(uintptr_t)(X))
379 /* Pointer comparison (types from below) */
380 #define PTRCMP(A,C,B) ((uintptr_t)(A) C (uintptr_t)(B))
382 /* Ditto, compare (maybe mixed-signed) integers cases to T bits, unsigned;
383 * Note: doesn't sign-extend correctly, that's still up to the caller */
384 #define UICMP(T,A,C,B) ((ui ## T ## _t)(A) C (ui ## T ## _t)(B))
386 /* Align something to a size/boundary that cannot cause just any problem */
387 #define n_ALIGN(X) (((X) + 2*sizeof(void*)) & ~((2*sizeof(void*)) - 1))
388 #define n_ALIGN_SMALL(X) \
389 (((X) + n_MAX(sizeof(size_t), sizeof(void*))) &\
390 ~(n_MAX(sizeof(size_t), sizeof(void*)) - 1))
392 /* Members in constant array */
393 #define n_NELEM(A) (sizeof(A) / sizeof((A)[0]))
395 /* sizeof() for member fields */
396 #define n_SIZEOF_FIELD(T,F) sizeof(((T *)NULL)->F)
398 /* Casts-away (*NOT* cast-away) */
399 #define n_UNUSED(X) ((void)(X))
400 #define n_UNCONST(P) ((void*)(uintptr_t)(void const*)(P))
401 #define n_UNVOLATILE(P) ((void*)(uintptr_t)(void volatile*)(P))
402 /* To avoid warnings with modern compilers for "char*i; *(si32_t*)i=;" */
403 #define n_UNALIGN(T,P) ((T)(uintptr_t)(P))
404 #define n_UNXXX(T,C,P) ((T)(uintptr_t)(C)(P))
406 /* __STDC_VERSION__ is ISO C99, so also use __STDC__, which should work */
407 #if defined __STDC__ || defined __STDC_VERSION__ /*|| defined __cplusplus*/
408 # define n_STRING(X) #X
409 # define n_XSTRING(X) n_STRING(X)
410 # define n_CONCAT(S1,S2) n__CONCAT_1(S1, S2)
411 # define n__CONCAT_1(S1,S2) S1 ## S2
412 #else
413 # define n_STRING(X) "X"
414 # define n_XSTRING STRING
415 # define n_CONCAT(S1,S2) S1/* won't work out */S2
416 #endif
418 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
419 # define n_FIELD_INITN(N) CONCAT(., N) =
420 # define n_FIELD_INITI(I) [I] =
421 #else
422 # define n_FIELD_INITN(N)
423 # define n_FIELD_INITI(N)
424 #endif
426 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
427 # define n_VFIELD_SIZE(X)
428 # define n_VFIELD_SIZEOF(T,F) (0)
429 # define n_VSTRUCT_SIZEOF(T,F) sizeof(T)
430 #else
431 # define n_VFIELD_SIZE(X) \
432 ((X) == 0 ? sizeof(size_t) \
433 : ((ssize_t)(X) < 0 ? sizeof(size_t) - n_ABS(X) : (size_t)(X)))
434 # define n_VFIELD_SIZEOF(T,F) n_SIZEOF_FIELD(T, F)
435 # define n_VSTRUCT_SIZEOF(T,F) (sizeof(T) - n_SIZEOF_FIELD(T, F))
436 #endif
438 #ifdef HAVE_INLINE
439 # define SINLINE n_INLINE /* TODO obsolete */
440 #else
441 # define SINLINE static
442 #endif
444 #undef __FUN__
445 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
446 # define __FUN__ __func__
447 #elif CC_CLANG || PREREQ_GCC(3, 4)
448 # define __FUN__ __extension__ __FUNCTION__
449 #else
450 # define __FUN__ uagent /* Something that is not a literal */
451 #endif
453 #if defined __predict_true && defined __predict_false
454 # define n_LIKELY(X) __predict_true(X)
455 # define n_UNLIKELY(X) __predict_false(X)
456 #elif CC_CLANG || PREREQ_GCC(2, 96)
457 # define n_LIKELY(X) __builtin_expect(X, 1)
458 # define n_UNLIKELY(X) __builtin_expect(X, 0)
459 #else
460 # define n_LIKELY(X) (X)
461 # define n_UNLIKELY(X) (X)
462 #endif
464 #undef HAVE_NATCH_CHAR
465 #if defined HAVE_SETLOCALE && defined HAVE_C90AMEND1 && defined HAVE_WCWIDTH
466 # define HAVE_NATCH_CHAR
467 # define n_NATCH_CHAR(X) X
468 #else
469 # define n_NATCH_CHAR(X)
470 #endif
472 /* Compile-Time-Assert
473 * Problem is that some compilers warn on unused local typedefs, so add
474 * a special local CTA to overcome this */
475 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 201112L
476 # define n_CTA(T,M) _Static_assert(T, M)
477 # define n_LCTA(T,M) _Static_assert(T, M)
478 #else
479 # define n_CTA(T,M) n__CTA_1(T, n_FILE, __LINE__)
480 # define n_LCTA(T,M) n__LCTA_1(T, n_FILE, __LINE__)
481 #endif
482 #define n_CTAV(T) n_CTA(T, "Unexpected value of constant")
483 #define n_LCTAV(T) n_LCTA(T, "Unexpected value of constant")
485 #ifdef n_MAIN_SOURCE
486 # define n_MCTA(T,M) n_CTA(T, M);
487 #else
488 # define n_MCTA(T,M)
489 #endif
491 #define n__CTA_1(T,F,L) n__CTA_2(T, F, L)
492 #define n__CTA_2(T,F,L) \
493 typedef char ASSERTION_failed_in_file_## F ## _at_line_ ## L[(T) ? 1 : -1]
494 #define n__LCTA_1(T,F,L) n__LCTA_2(T, F, L)
495 #define n__LCTA_2(T,F,L) \
496 do{\
497 typedef char ASSERTION_failed_in_file_## F ## _at_line_ ## L[(T) ? 1 : -1];\
498 ASSERTION_failed_in_file_## F ## _at_line_ ## L __i_am_unused__;\
499 n_UNUSED(__i_am_unused__);\
500 }while(0)
502 #define n_UNINIT(N,V) N = V
504 /* Create a bit mask for the bit range LO..HI -- HI can't use highest bit! */
505 #define n_BITENUM_MASK(LO,HI) (((1u << ((HI) + 1)) - 1) & ~((1u << (LO)) - 1))
507 #undef DBG
508 #undef NDBG
509 #ifndef HAVE_DEBUG
510 # undef assert
511 # define assert(X) n_UNUSED(0)
512 # define DBG(X)
513 # define NDBG(X) X
514 # define DBGOR(X,Y) Y
515 #else
516 # define DBG(X) X
517 # define NDBG(X)
518 # define DBGOR(X,Y) X
519 #endif
521 /* Translation (init in main.c) */
522 #undef _
523 #undef N_
524 #undef V_
525 #define _(S) S
526 #define N_(S) S
527 #define V_(S) S
530 * Types TODO v15: n_XX_t
533 #ifdef UINT8_MAX
534 # define UI8_MAX UINT8_MAX
535 # define SI8_MIN INT8_MIN
536 # define SI8_MAX INT8_MAX
537 typedef uint8_t ui8_t;
538 typedef int8_t si8_t;
539 #elif UCHAR_MAX != 255
540 # error UCHAR_MAX must be 255
541 #else
542 # define UI8_MAX UCHAR_MAX
543 # define SI8_MIN CHAR_MIN
544 # define SI8_MAX CHAR_MAX
545 typedef unsigned char ui8_t;
546 typedef signed char si8_t;
547 #endif
549 #if !defined PRIu8 || !defined PRId8
550 # undef PRIu8
551 # undef PRId8
552 # define PRIu8 "hhu"
553 # define PRId8 "hhd"
554 #endif
556 #ifdef UINT16_MAX
557 # define UI16_MAX UINT16_MAX
558 # define SI16_MIN INT16_MIN
559 # define SI16_MAX INT16_MAX
560 typedef uint16_t ui16_t;
561 typedef int16_t si16_t;
562 #elif USHRT_MAX != 0xFFFFu
563 # error USHRT_MAX must be 0xFFFF
564 #else
565 # define UI16_MAX USHRT_MAX
566 # define SI16_MIN SHRT_MIN
567 # define SI16_MAX SHRT_MAX
568 typedef unsigned short ui16_t;
569 typedef signed short si16_t;
570 #endif
572 #if !defined PRIu16 || !defined PRId16
573 # undef PRIu16
574 # undef PRId16
575 # if UI16_MAX == UINT_MAX
576 # define PRIu16 "u"
577 # define PRId16 "d"
578 # else
579 # define PRIu16 "hu"
580 # define PRId16 "hd"
581 # endif
582 #endif
584 #ifdef UINT32_MAX
585 # define UI32_MAX UINT32_MAX
586 # define SI32_MIN INT32_MIN
587 # define SI32_MAX INT32_MAX
588 typedef uint32_t ui32_t;
589 typedef int32_t si32_t;
590 #elif ULONG_MAX == 0xFFFFFFFFu
591 # define UI32_MAX ULONG_MAX
592 # define SI32_MIN LONG_MIN
593 # define SI32_MAX LONG_MAX
594 typedef unsigned long int ui32_t;
595 typedef signed long int si32_t;
596 #elif UINT_MAX != 0xFFFFFFFFu
597 # error UINT_MAX must be 0xFFFFFFFF
598 #else
599 # define UI32_MAX UINT_MAX
600 # define SI32_MIN INT_MIN
601 # define SI32_MAX INT_MAX
602 typedef unsigned int ui32_t;
603 typedef signed int si32_t;
604 #endif
606 #if !defined PRIu32 || !defined PRId32
607 # undef PRIu32
608 # undef PRId32
609 # if UI32_MAX == ULONG_MAX
610 # define PRIu32 "lu"
611 # define PRId32 "ld"
612 # else
613 # define PRIu32 "u"
614 # define PRId32 "d"
615 # endif
616 #endif
618 #ifdef UINT64_MAX
619 # define UI64_MAX UINT64_MAX
620 # define SI64_MIN INT64_MIN
621 # define SI64_MAX INT64_MAX
622 typedef uint64_t ui64_t;
623 typedef int64_t si64_t;
624 #elif ULONG_MAX <= 0xFFFFFFFFu
625 # if !defined ULLONG_MAX || (ULLONG_MAX >> 31) < 0xFFFFFFFFu
626 # error We need a 64 bit integer
627 # else
628 # define UI64_MAX ULLONG_MAX
629 # define SI64_MIN LLONG_MIN
630 # define SI64_MAX LLONG_MAX
631 __EXTEN typedef unsigned long long ui64_t;
632 __EXTEN typedef signed long long si64_t;
633 # endif
634 #else
635 # define UI64_MAX ULONG_MAX
636 # define SI64_MIN LONG_MIN
637 # define SI64_MAX LONG_MAX
638 typedef unsigned long ui64_t;
639 typedef signed long si64_t;
640 #endif
642 #if !defined PRIu64 || !defined PRId64 || !defined PRIX64
643 # undef PRIu64
644 # undef PRId64
645 # undef PRIX64
646 # if defined ULLONG_MAX && UI64_MAX == ULLONG_MAX
647 # define PRIu64 "llu"
648 # define PRId64 "lld"
649 # define PRIX64 "llX"
650 # else
651 # define PRIu64 "lu"
652 # define PRId64 "ld"
653 # define PRIX64 "lX"
654 # endif
655 #endif
657 /* (So that we can use UICMP() for size_t comparison, too) */
658 typedef size_t uiz_t;
659 typedef ssize_t siz_t;
661 #undef PRIuZ
662 #undef PRIdZ
663 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
664 # define PRIuZ "zu"
665 # define PRIdZ "zd"
666 # define UIZ_MAX SIZE_MAX
667 #elif defined SIZE_MAX
668 /* UnixWare has size_t as unsigned as required but uses a signed limit
669 * constant (which is thus false!) */
670 # if SIZE_MAX == UI64_MAX || SIZE_MAX == SI64_MAX
671 # define PRIuZ PRIu64
672 # define PRIdZ PRId64
673 n_MCTA(sizeof(size_t) == sizeof(ui64_t),
674 "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
675 # elif SIZE_MAX == UI32_MAX || SIZE_MAX == SI32_MAX
676 # define PRIuZ PRIu32
677 # define PRIdZ PRId32
678 n_MCTA(sizeof(size_t) == sizeof(ui32_t),
679 "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
680 # else
681 # error SIZE_MAX is neither UI64_MAX nor UI32_MAX (please report this)
682 # endif
683 # define UIZ_MAX SIZE_MAX
684 #endif
685 #ifndef PRIuZ
686 # define PRIuZ "lu"
687 # define PRIdZ "ld"
688 n_MCTA(sizeof(size_t) == sizeof(unsigned long),
689 "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
690 # define UIZ_MAX ULONG_MAX
691 #endif
693 #ifndef UINTPTR_MAX
694 # ifdef SIZE_MAX
695 # define uintptr_t size_t
696 # define UINTPTR_MAX SIZE_MAX
697 # else
698 # define uintptr_t unsigned long
699 # define UINTPTR_MAX ULONG_MAX
700 # endif
701 #endif
703 #if !defined PRIuPTR || !defined PRIXPTR
704 # undef PRIuPTR
705 # undef PRIXPTR
706 # if UINTPTR_MAX == ULONG_MAX
707 # define PRIuPTR "lu"
708 # define PRIXPTR "lX"
709 # else
710 # define PRIuPTR "u"
711 # define PRIXPTR "X"
712 # endif
713 #endif
715 #ifdef HAVE_C90AMEND1
716 typedef wchar_t wc_t;
717 # define n_WC_C(X) L ## X
718 #else
719 typedef char wc_t; /* Yep: really 8-bit char */
720 # define n_WC_C(X) X
721 #endif
723 enum {FAL0, TRU1, TRUM1 = -1};
724 typedef si8_t bool_t;
726 /* Add shorter aliases for "normal" integers TODO v15 -> n_XX_t */
727 typedef unsigned long ul_i;
728 typedef unsigned int ui_i;
729 typedef unsigned short us_i;
730 typedef unsigned char uc_i;
732 typedef signed long sl_i;
733 typedef signed int si_i;
734 typedef signed short ss_i;
735 typedef signed char sc_i;
737 typedef void ( *sighandler_type)(int); /* TODO v15 obsolete */
738 typedef void ( *n_sighdl_t)(int);
740 enum authtype {
741 AUTHTYPE_NONE = 1<<0,
742 AUTHTYPE_PLAIN = 1<<1, /* POP3: APOP is covered by this */
743 AUTHTYPE_LOGIN = 1<<2,
744 AUTHTYPE_CRAM_MD5 = 1<<3,
745 AUTHTYPE_GSSAPI = 1<<4
748 enum expand_addr_flags {
749 EAF_NONE = 0, /* -> EAF_NOFILE | EAF_NOPIPE */
750 EAF_RESTRICT = 1<<0, /* "restrict" (do unless interaktive / -[~#]) */
751 EAF_FAIL = 1<<1, /* "fail" */
752 /* Bits reused by enum expand_addr_check_mode! */
753 EAF_FILE = 1<<3, /* +"file" targets */
754 EAF_PIPE = 1<<4, /* +"pipe" command pipe targets */
755 EAF_NAME = 1<<5, /* +"name"s (non-address) names / MTA aliases */
756 EAF_ADDR = 1<<6, /* +"addr" network address (contain "@") */
758 EAF_TARGET_MASK = EAF_FILE | EAF_PIPE | EAF_NAME | EAF_ADDR,
759 EAF_RESTRICT_TARGETS = EAF_NAME | EAF_ADDR /* (default set if not set) */
762 enum expand_addr_check_mode {
763 EACM_NONE = 0, /* Don't care about *expandaddr* */
764 EACM_NORMAL = 1<<0, /* Use our normal *expandaddr* checking */
765 EACM_STRICT = 1<<1, /* Never allow any file or pipe addresse */
766 EACM_MODE_MASK = 0x3, /* _NORMAL and _STRICT are mutual! */
768 EACM_NOLOG = 1<<2, /* Don't log check errors */
770 /* Some special overwrites of EAF_TARGETs.
771 * May NOT clash with EAF_* bits which may be ORd to these here! */
773 EACM_NONAME = 1<<16
776 enum n_cmd_arg_desc_flags{/* TODO incomplete, misses getmsglist() */
777 /* - A type */
778 n_CMD_ARG_DESC_STRING = 1<<0, /* A !blankspacechar() string */
779 n_CMD_ARG_DESC_WYSH = 1<<1, /* sh(1)ell-style quoted */
781 n__CMD_ARG_DESC_TYPE_MASK = n_CMD_ARG_DESC_STRING | n_CMD_ARG_DESC_WYSH,
783 /* - Optional flags */
784 /* It is not an error if an optional argument is missing; once an argument
785 * has been declared optional only optional arguments may follow */
786 n_CMD_ARG_DESC_OPTION = 1<<16,
787 /* GREEDY: parse as many of that type as possible; must be last entry */
788 n_CMD_ARG_DESC_GREEDY = 1<<17,
789 /* Honour an overall "stop" request in one of the arguments (\c@ or #) */
790 n_CMD_ARG_DESC_HONOUR_STOP = 1<<18,
792 n__CMD_ARG_DESC_FLAG_MASK = n_CMD_ARG_DESC_OPTION | n_CMD_ARG_DESC_GREEDY |
793 n_CMD_ARG_DESC_HONOUR_STOP
796 #ifdef HAVE_COLOUR
797 /* We do have several contexts of colour IDs; since only one of them can be
798 * active at any given time let's share the value range */
799 enum n_colour_ctx{
800 n_COLOUR_CTX_SUM,
801 n_COLOUR_CTX_VIEW,
802 n_COLOUR_CTX_MLE,
803 n__COLOUR_CTX_MAX
806 enum n_colour_id{
807 /* Header summary */
808 n_COLOUR_ID_SUM_DOTMARK = 0,
809 n_COLOUR_ID_SUM_HEADER,
810 n_COLOUR_ID_SUM_THREAD,
812 /* Message display */
813 n_COLOUR_ID_VIEW_FROM_ = 0,
814 n_COLOUR_ID_VIEW_HEADER,
815 n_COLOUR_ID_VIEW_MSGINFO,
816 n_COLOUR_ID_VIEW_PARTINFO,
818 /* Mailx-Line-Editor */
819 n_COLOUR_ID_MLE_POSITION = 0,
820 n_COLOUR_ID_MLE_PROMPT,
822 n__COLOUR_IDS = n_COLOUR_ID_VIEW_PARTINFO + 1
825 /* Colour preconditions, let's call them tags, cannot be an enum because for
826 * message display they are the actual header name of the current header. Thus
827 * let's use constants of pseudo pointers */
828 # define n_COLOUR_TAG_SUM_DOT ((char*)-2)
829 # define n_COLOUR_TAG_SUM_OLDER ((char*)-3)
830 #endif /* HAVE_COLOUR */
832 enum conversion {
833 CONV_NONE, /* no conversion */
834 CONV_7BIT, /* no conversion, is 7bit */
835 CONV_FROMQP, /* convert from quoted-printable */
836 CONV_TOQP, /* convert to quoted-printable */
837 CONV_8BIT, /* convert to 8bit (iconv) */
838 CONV_FROMB64, /* convert from base64 */
839 CONV_FROMB64_T, /* convert from base64/text */
840 CONV_TOB64, /* convert to base64 */
841 CONV_FROMHDR, /* convert from RFC1522 format */
842 CONV_TOHDR, /* convert to RFC1522 format */
843 CONV_TOHDR_A /* convert addresses for header */
846 enum cproto {
847 CPROTO_SMTP,
848 CPROTO_POP3
851 enum n_dotlock_state{
852 n_DLS_NONE,
853 n_DLS_CANT_CHDIR, /* Failed to chdir(2) into desired path */
854 n_DLS_NAMETOOLONG, /* Lock file name would be too long */
855 n_DLS_ROFS, /* Read-only filesystem (no error, mailbox RO) */
856 n_DLS_NOPERM, /* No permission to creat lock file */
857 n_DLS_NOEXEC, /* Privilege separated dotlocker not found */
858 n_DLS_PRIVFAILED, /* Rising privileges failed in dotlocker */
859 n_DLS_EXIST, /* Lock file already exists, stale lock? */
860 n_DLS_FISHY, /* Something makes us think bad of situation */
861 n_DLS_DUNNO, /* Catch-all error */
862 n_DLS_PING, /* Not an error, but have to wait for lock */
863 n_DLS_ABANDON = 1<<7 /* ORd to any but _NONE: give up, don't retry */
866 enum exit_status {
867 EXIT_OK = EXIT_SUCCESS,
868 EXIT_ERR = EXIT_FAILURE,
869 EXIT_USE = 64, /* sysexits.h:EX_USAGE */
870 EXIT_NOUSER = 67, /* :EX_NOUSER */
871 EXIT_COLL_ABORT = 1<<1, /* Message collection was aborted */
872 EXIT_SEND_ERROR = 1<<2 /* Unspecified send error occurred */
875 enum fedit_mode {
876 FEDIT_NONE = 0,
877 FEDIT_SYSBOX = 1<<0, /* %: prefix */
878 FEDIT_RDONLY = 1<<1, /* Readonly (per-box, OPT_R_FLAG is global) */
879 FEDIT_NEWMAIL = 1<<2 /* `newmail' operation TODO OBSOLETE THIS! */
882 enum fexp_mode {
883 FEXP_FULL, /* Full expansion */
884 FEXP_NOPROTO = 1<<0, /* TODO no which_protocol() to decide expansion */
885 FEXP_SILENT = 1<<1, /* Don't print but only return errors */
886 FEXP_MULTIOK = 1<<2, /* Expansion to many entries is ok */
887 FEXP_LOCAL = 1<<3, /* Result must be local file/maildir */
888 FEXP_NSHORTCUT = 1<<4, /* Don't expand shortcuts */
889 FEXP_NSPECIAL = 1<<5, /* No %,#,& specials */
890 FEXP_NFOLDER = 1<<6, /* NSPECIAL and no + folder, too */
891 FEXP_NSHELL = 1<<7, /* Don't do shell word exp. (but ~/, $VAR) */
892 FEXP_NVAR = 1<<8 /* ..not even $VAR expansion */
895 enum n_file_lock_type{
896 FLT_READ,
897 FLT_WRITE
900 enum n_iconv_flags{
901 n_ICONV_NONE = 0,
902 n_ICONV_IGN_ILSEQ = 1<<0, /* Ignore EILSEQ in input (replacement char) */
903 n_ICONV_IGN_NOREVERSE = 1<<1, /* .. non-reversible conversions in output */
904 n_ICONV_UNIREPL = 1<<2, /* Use Unicode replacement 0xFFFD = EF BF BD */
905 n_ICONV_DEFAULT = n_ICONV_IGN_ILSEQ | n_ICONV_IGN_NOREVERSE,
906 n_ICONV_UNIDEFAULT = n_ICONV_DEFAULT | n_ICONV_UNIREPL
909 enum n_lexinput_flags{
910 n_LEXINPUT_NONE,
911 n_LEXINPUT_CTX_BASE = 0, /* Generic shared base: don't use! */
912 n_LEXINPUT_CTX_DEFAULT = 1, /* Default input */
913 n_LEXINPUT_CTX_COMPOSE = 2, /* Compose mode input */
914 n__LEXINPUT_CTX_MASK = 3,
915 n__LEXINPUT_CTX_MAX = n_LEXINPUT_CTX_COMPOSE + 1,
917 n_LEXINPUT_NL_ESC = 1<<8, /* Support "\\$" line continuation */
918 n_LEXINPUT_NL_FOLLOW = 1<<9, /* ..on such a follow line */
919 n_LEXINPUT_PROMPT_NONE = 1<<10, /* Don't print prompt */
920 n_LEXINPUT_PROMPT_EVAL = 1<<11, /* Instead, evaluate *prompt* */
921 #if 0
922 n_LEXINPUT_DROP_TRAIL_SPC = 1<<14, /* Drop any trailing space */
923 n_LEXINPUT_DROP_LEAD_SPC = 1<<15, /* ..leading ones */
924 n_LEXINPUT_TRIM_SPACE = n_LEXINPUT_DROP_TRAIL_SPC | n_LEXINPUT_DROP_LEAD_SPC,
925 #endif
927 n_LEXINPUT_HIST_ADD = 1<<16, /* Add the result to history list */
928 n_LEXINPUT_HIST_GABBY = 1<<17 /* Consider history entry as gabby */
931 enum mimecontent {
932 MIME_UNKNOWN, /* unknown content */
933 MIME_SUBHDR, /* inside a multipart subheader */
934 MIME_822, /* message/rfc822 content */
935 MIME_MESSAGE, /* other message/ content */
936 MIME_TEXT_PLAIN, /* text/plain content */
937 MIME_TEXT_HTML, /* text/html content */
938 MIME_TEXT, /* other text/ content */
939 MIME_ALTERNATIVE, /* multipart/alternative content */
940 MIME_RELATED, /* mime/related (RFC 2387) */
941 MIME_DIGEST, /* multipart/digest content */
942 MIME_MULTI, /* other multipart/ content */
943 MIME_PKCS7, /* PKCS7 content */
944 MIME_DISCARD /* content is discarded */
947 enum mime_counter_evidence {
948 MIMECE_NONE,
949 MIMECE_SET = 1<<0, /* *mime-counter-evidence* was set */
950 MIMECE_BIN_OVWR = 1<<1, /* appli../octet-stream: check, ovw if possible */
951 MIMECE_ALL_OVWR = 1<<2, /* all: check, ovw if possible */
952 MIMECE_BIN_PARSE = 1<<3 /* appli../octet-stream: classify contents last */
955 /* Content-Transfer-Encodings as defined in RFC 2045:
956 * - Quoted-Printable, section 6.7
957 * - Base64, section 6.8 */
958 #define QP_LINESIZE (4 * 19) /* Max. compliant QP linesize */
960 #define B64_LINESIZE (4 * 19) /* Max. compliant Base64 linesize */
961 #define B64_ENCODE_INPUT_PER_LINE 57 /* Max. input for Base64 encode/line */
963 enum mime_enc {
964 MIMEE_NONE, /* message is not in MIME format */
965 MIMEE_BIN, /* message is in binary encoding */
966 MIMEE_8B, /* message is in 8bit encoding */
967 MIMEE_7B, /* message is in 7bit encoding */
968 MIMEE_QP, /* message is quoted-printable */
969 MIMEE_B64 /* message is in base64 encoding */
972 /* xxx QP came later, maybe rewrite all to use mime_enc_flags directly? */
973 enum mime_enc_flags {
974 MIMEEF_NONE,
975 MIMEEF_SALLOC = 1<<0, /* Use salloc(), not srealloc().. */
976 /* ..result .s,.l point to user buffer of *_LINESIZE+[+[+]] bytes instead */
977 MIMEEF_BUF = 1<<1,
978 MIMEEF_CRLF = 1<<2, /* (encode) Append "\r\n" to lines */
979 MIMEEF_LF = 1<<3, /* (encode) Append "\n" to lines */
980 /* (encode) If one of _CRLF/_LF is set, honour *_LINESIZE+[+[+]] and
981 * inject the desired line-ending whenever a linewrap is desired */
982 MIMEEF_MULTILINE = 1<<4,
983 /* (encode) Quote with header rules, do not generate soft NL breaks?
984 * For mustquote(), specifies whether special RFC 2047 header rules
985 * should be used instead */
986 MIMEEF_ISHEAD = 1<<5,
987 /* (encode) Ditto; for mustquote() this furtherly fine-tunes behaviour in
988 * that characters which would not be reported as "must-quote" when
989 * detecting whether quoting is necessary at all will be reported as
990 * "must-quote" if they have to be encoded in an encoded word */
991 MIMEEF_ISENCWORD = 1<<6,
992 __MIMEEF_LAST = 6
995 enum qpflags {
996 QP_NONE = MIMEEF_NONE,
997 QP_SALLOC = MIMEEF_SALLOC,
998 QP_BUF = MIMEEF_BUF,
999 QP_ISHEAD = MIMEEF_ISHEAD,
1000 QP_ISENCWORD = MIMEEF_ISENCWORD
1003 enum b64flags {
1004 B64_NONE = MIMEEF_NONE,
1005 B64_SALLOC = MIMEEF_SALLOC,
1006 B64_BUF = MIMEEF_BUF,
1007 B64_CRLF = MIMEEF_CRLF,
1008 B64_LF = MIMEEF_LF,
1009 B64_MULTILINE = MIMEEF_MULTILINE,
1010 /* Not used, but for clarity only */
1011 B64_ISHEAD = MIMEEF_ISHEAD,
1012 B64_ISENCWORD = MIMEEF_ISENCWORD,
1013 /* Special version of Base64, "Base64URL", according to RFC 4648.
1014 * Only supported for encoding! */
1015 B64_RFC4648URL = 1<<(__MIMEEF_LAST+1),
1016 /* Don't use any ("=") padding;
1017 * may NOT be used with any of _CRLF, _LF or _MULTILINE */
1018 B64_NOPAD = 1<<(__MIMEEF_LAST+2)
1021 enum mime_parse_flags {
1022 MIME_PARSE_NONE = 0,
1023 MIME_PARSE_DECRYPT = 1<<0,
1024 MIME_PARSE_PARTS = 1<<1
1027 enum mime_handler_flags {
1028 MIME_HDL_NULL, /* No pipe- mimetype handler, go away */
1029 MIME_HDL_CMD, /* Normal command */
1030 MIME_HDL_TEXT, /* @ special cmd to force treatment as text */
1031 MIME_HDL_PTF, /* A special pointer-to-function handler */
1032 MIME_HDL_MSG, /* Display msg (returned as command string) */
1033 MIME_HDL_TYPE_MASK = 7,
1034 MIME_HDL_ISQUOTE = 1<<4, /* Is quote action (we have info, keep it!) */
1035 MIME_HDL_NOQUOTE = 1<<5, /* No MIME for quoting */
1036 MIME_HDL_ALWAYS = 1<<6, /* Handler shall run for multi-msg actions */
1037 MIME_HDL_ASYNC = 1<<7, /* Should run asynchronously */
1038 MIME_HDL_NEEDSTERM = 1<<8, /* Takes over terminal */
1039 MIME_HDL_TMPF = 1<<9, /* Create temporary file (zero-sized) */
1040 MIME_HDL_TMPF_FILL = 1<<10, /* Fill in the msg body content */
1041 MIME_HDL_TMPF_UNLINK = 1<<11 /* Delete it later again */
1044 enum mlist_state {
1045 MLIST_OTHER = 0, /* Normal address */
1046 MLIST_KNOWN = 1, /* A known `mlist' */
1047 MLIST_SUBSCRIBED = -1 /* A `mlsubscribe'd list */
1050 enum oflags {
1051 OF_RDONLY = 1<<0,
1052 OF_WRONLY = 1<<1,
1053 OF_RDWR = 1<<2,
1054 OF_APPEND = 1<<3,
1055 OF_CREATE = 1<<4,
1056 OF_TRUNC = 1<<5,
1057 OF_EXCL = 1<<6,
1058 OF_CLOEXEC = 1<<7, /* TODO not used, always implied! CHANGE!! */
1059 OF_UNLINK = 1<<8, /* Only for Ftmp(): unlink(2) after creation */
1060 OF_HOLDSIGS = 1<<9, /* Mutual with OF_UNLINK - await Ftmp_free() */
1061 OF_REGISTER = 1<<10, /* Register file in our file table */
1062 OF_REGISTER_UNLINK = 1<<11, /* unlink(2) upon unreg.; _REGISTER asserted! */
1063 OF_SUFFIX = 1<<12 /* Ftmp() name hint is mandatory! extension! */
1066 enum okay {
1067 STOP = 0,
1068 OKAY = 1
1071 enum okey_xlook_mode {
1072 OXM_PLAIN = 1<<0, /* Plain key always tested */
1073 OXM_H_P = 1<<1, /* Check PLAIN-.url_h_p */
1074 OXM_U_H_P = 1<<2, /* Check PLAIN-.url_u_h_p */
1075 OXM_ALL = 0x7
1078 /* <0 means "stop" unless *prompt* extensions are enabled. */
1079 enum prompt_exp {
1080 PROMPT_STOP = -1, /* \c */
1081 /* *prompt* extensions: \$, \@ etc. */
1082 PROMPT_DOLLAR = -2,
1083 PROMPT_AT = -3
1086 enum protocol {
1087 PROTO_FILE, /* refers to a local file */
1088 PROTO_POP3, /* is a pop3 server string */
1089 PROTO_MAILDIR, /* refers to a maildir folder */
1090 PROTO_UNKNOWN /* unknown protocol */
1093 enum sendaction {
1094 SEND_MBOX, /* no conversion to perform */
1095 SEND_RFC822, /* no conversion, no From_ line */
1096 SEND_TODISP, /* convert to displayable form */
1097 SEND_TODISP_ALL, /* same, include all MIME parts */
1098 SEND_SHOW, /* convert to 'show' command form */
1099 SEND_TOSRCH, /* convert for IMAP SEARCH */
1100 SEND_TOFILE, /* convert for saving body to a file */
1101 SEND_TOPIPE, /* convert for pipe-content/subc. */
1102 SEND_QUOTE, /* convert for quoting */
1103 SEND_QUOTE_ALL, /* same, include all MIME parts */
1104 SEND_DECRYPT /* decrypt */
1107 enum n_shexp_parse_flags{
1108 n_SHEXP_PARSE_NONE,
1109 /* Don't perform any expansions or interpret backslash escape sequences etc.
1110 * Output may be NULL, otherwise the possibly trimmed non-expanded input is
1111 * used as output */
1112 n_SHEXP_PARSE_DRYRUN = 1<<0,
1113 n_SHEXP_PARSE_TRUNC = 1<<1, /* Truncate result storage on entry */
1114 n_SHEXP_PARSE_TRIMSPACE = 1<<2, /* Ignore space surrounding tokens */
1115 n_SHEXP_PARSE_LOG = 1<<3, /* Log errors */
1116 n_SHEXP_PARSE_LOG_D_V = 1<<4, /* Log errors if OPT_D_V */
1117 n_SHEXP_PARSE_IFS_ADD_COMMA = 1<<5, /* Add comma , to normal "IFS" */
1118 n_SHEXP_PARSE_IFS_IS_COMMA = 1<<6, /* Let comma , be the sole "IFS" */
1119 n_SHEXP_PARSE_IGNORE_EMPTY = 1<<7, /* Ignore empty tokens, start over */
1120 /* Implicitly open quotes, and ditto closing. _AUTO_FIXED may only be used
1121 * if an auto-quote-mode is enabled, implies _AUTO_CLOSE and causes the
1122 * quote mode to be permanently active (cannot be closed) */
1123 n_SHEXP_PARSE_QUOTE_AUTO_FIXED = 1<<8,
1124 n_SHEXP_PARSE_QUOTE_AUTO_SQ = 1<<9,
1125 n_SHEXP_PARSE_QUOTE_AUTO_DQ = 1<<10,
1126 n_SHEXP_PARSE_QUOTE_AUTO_DSQ = 1<<11,
1127 n_SHEXP_PARSE_QUOTE_AUTO_CLOSE = 1<<12, /* Ignore an open quote at EOS */
1128 n__SHEXP_PARSE_QUOTE_AUTO_MASK = n_SHEXP_PARSE_QUOTE_AUTO_SQ |
1129 n_SHEXP_PARSE_QUOTE_AUTO_DQ | n_SHEXP_PARSE_QUOTE_AUTO_DSQ,
1131 n__SHEXP_PARSE_LAST = 12
1134 enum n_shexp_state{
1135 n_SHEXP_STATE_NONE,
1136 /* We have produced some output (or would have, with _PARSE_DRYRUN).
1137 * Note that empty quotes like '' produce no output but set this bit */
1138 n_SHEXP_STATE_OUTPUT = 1<<2,
1139 /* Don't call the parser again (\c0 or # comment seen; out of input).
1140 * Not (necessarily) mutual with _OUTPUT) */
1141 n_SHEXP_STATE_STOP = 1<<1,
1142 n_SHEXP_STATE_UNICODE = 1<<3, /* \[Uu] used */
1143 n_SHEXP_STATE_CONTROL = 1<<4, /* Control characters seen */
1145 n_SHEXP_STATE_ERR_CONTROL = 1<<16, /* \c notation with invalid argument */
1146 n_SHEXP_STATE_ERR_UNICODE = 1<<17, /* Valid \[Uu] used and !OPT_UNICODE */
1147 n_SHEXP_STATE_ERR_NUMBER = 1<<18, /* Bad number (\[UuXx]) */
1148 n_SHEXP_STATE_ERR_BRACE = 1<<19, /* _QUOTEOPEN + no } brace for ${VAR */
1149 n_SHEXP_STATE_ERR_BADSUB = 1<<20, /* Empty/bad ${} substitution */
1150 n_SHEXP_STATE_ERR_QUOTEOPEN = 1<<21, /* Quote remains open at EOS */
1152 n_SHEXP_STATE_ERR_MASK = n_BITENUM_MASK(16, 21)
1155 enum n_sigman_flags{
1156 n_SIGMAN_NONE = 0,
1157 n_SIGMAN_HUP = 1<<0,
1158 n_SIGMAN_INT = 1<<1,
1159 n_SIGMAN_QUIT = 1<<2,
1160 n_SIGMAN_TERM = 1<<3,
1161 n_SIGMAN_PIPE = 1<<4,
1163 n_SIGMAN_IGN_HUP = 1<<5,
1164 n_SIGMAN_IGN_INT = 1<<6,
1165 n_SIGMAN_IGN_QUIT = 1<<7,
1166 n_SIGMAN_IGN_TERM = 1<<8,
1168 n_SIGMAN_ALL = 0xFF,
1169 /* Mostly for _leave() reraise flags */
1170 n_SIGMAN_VIPSIGS = n_SIGMAN_HUP | n_SIGMAN_INT | n_SIGMAN_QUIT |
1171 n_SIGMAN_TERM,
1172 n_SIGMAN_NTTYOUT_PIPE = 1<<16,
1173 n_SIGMAN_VIPSIGS_NTTYOUT = n_SIGMAN_HUP | n_SIGMAN_INT | n_SIGMAN_QUIT |
1174 n_SIGMAN_TERM | n_SIGMAN_NTTYOUT_PIPE,
1176 n__SIGMAN_PING = 1<<17
1179 #ifdef HAVE_SSL
1180 enum ssl_verify_level {
1181 SSL_VERIFY_IGNORE,
1182 SSL_VERIFY_WARN,
1183 SSL_VERIFY_ASK,
1184 SSL_VERIFY_STRICT
1186 #endif
1188 enum tdflags {
1189 TD_NONE, /* no display conversion */
1190 TD_ISPR = 1<<0, /* use isprint() checks */
1191 TD_ICONV = 1<<1, /* use iconv() */
1192 TD_DELCTRL = 1<<2, /* delete control characters */
1195 * NOTE: _TD_EOF and _TD_BUFCOPY may be ORd with enum conversion and
1196 * enum sendaction, and may thus NOT clash with their bit range!
1198 _TD_EOF = 1<<14, /* EOF seen, last round! */
1199 _TD_BUFCOPY = 1<<15 /* Buffer may be constant, copy it */
1202 #ifdef n_HAVE_TCAP
1203 enum n_termcap_captype{
1204 n_TERMCAP_CAPTYPE_NONE = 0,
1205 /* Internally we share the bitspace, so ensure no value ends up as 0 */
1206 n_TERMCAP_CAPTYPE_BOOL = 1,
1207 n_TERMCAP_CAPTYPE_NUMERIC,
1208 n_TERMCAP_CAPTYPE_STRING,
1209 n__TERMCAP_CAPTYPE_MAX
1212 /* Termcap commands; different to queries commands perform actions.
1213 * Commands are resolved upon init time, and are all termcap(5)-compatible,
1214 * therefore we use the short termcap(5) names.
1215 * Note this is parsed by mk-tcap-map.pl, which expects the syntax
1216 * "CONSTANT, COMMENT" where COMMENT is "Capname/TCap-Code, TYPE[, FLAGS]",
1217 * and one of Capname and TCap-Code may be the string "-" meaning ENOENT;
1218 * a | vertical bar or end-of-comment ends processing; see termcap.c.
1219 * We may use the free-form part after | for the "Variable String" and notes on
1220 * necessary termcap_cmd() arguments; if those are in [] brackets they are not
1221 * regular but are only used when the command, i.e., its effect, is somehow
1222 * simulated / faked by a builtin fallback implementation.
1223 * Availability of builtin fallback indicated by leading @ (at-sign) */
1224 enum n_termcap_cmd{
1225 # ifdef HAVE_TERMCAP
1226 n_TERMCAP_CMD_te, /* rmcup/te, STRING | exit_ca_mode: -,- */
1227 n_TERMCAP_CMD_ti, /* smcup/ti, STRING | enter_ca_mode: -,- */
1229 n_TERMCAP_CMD_ks, /* smkx/ks, STRING | keypad_xmit: -,- */
1230 n_TERMCAP_CMD_ke, /* rmkx/ke, STRING | keypad_local: -,- */
1232 n_TERMCAP_CMD_cd, /* ed/cd, STRING | clr_eos: -,- */
1233 n_TERMCAP_CMD_cl, /* clear/cl, STRING | clear_screen(+home): -,- */
1234 n_TERMCAP_CMD_ho, /* home/ho, STRING | cursor_home: -,- */
1235 # endif
1237 # ifdef HAVE_MLE
1238 n_TERMCAP_CMD_ce, /* el/ce, STRING | @ clr_eol: [start-column],- */
1239 n_TERMCAP_CMD_ch, /* hpa/ch, STRING, IDX1 | column_address: column,- */
1240 n_TERMCAP_CMD_cr, /* cr/cr, STRING | @ carriage_return: -,- */
1241 n_TERMCAP_CMD_le, /* cub1/le, STRING, CNT | @ cursor_left: count,- */
1242 n_TERMCAP_CMD_nd, /* cuf1/nd, STRING, CNT | @ cursor_right: count,- */
1243 # endif
1245 n__TERMCAP_CMD_MAX,
1246 n__TERMCAP_CMD_MASK = (1<<24) - 1,
1248 /* Only perform command if ca-mode is used */
1249 n_TERMCAP_CMD_FLAG_CA_MODE = 1<<29,
1250 /* I/O should be flushed after command completed */
1251 n_TERMCAP_CMD_FLAG_FLUSH = 1<<30
1254 /* Termcap queries; a query is a command that returns a struct n_termcap_value.
1255 * Queries are resolved once they are used first, and may not be termcap(5)-
1256 * compatible, therefore we use terminfo(5) names.
1257 * Note this is parsed by mk-tcap-map.pl, which expects the syntax
1258 * "CONSTANT, COMMENT" where COMMENT is "Capname/TCap-Code, TYPE[, FLAGS]",
1259 * and one of Capname and TCap-Code may be the string "-" meaning ENOENT;
1260 * a | vertical bar or end-of-comment ends processing; see termcap.c.
1261 * We may use the free-form part after | for the "Variable String" and notes.
1262 * The "xkey | X:" keys are Dickey's xterm extensions, see (our) manual */
1263 enum n_termcap_query{
1264 # ifdef HAVE_COLOUR
1265 n_TERMCAP_QUERY_colors, /* colors/Co, NUMERIC | max_colors */
1266 # endif
1268 /* --mk-tcap-map--: only KEY_BINDINGS follow. DON'T CHANGE THIS LINE! */
1269 /* Update the `bind' manual on change! */
1270 # ifdef HAVE_KEY_BINDINGS
1271 n_TERMCAP_QUERY_key_backspace, /* kbs/kb, STRING */
1272 n_TERMCAP_QUERY_key_dc, /* kdch1/kD, STRING | delete-character */
1273 n_TERMCAP_QUERY_key_sdc, /* kDC / *4, STRING | ..shifted */
1274 n_TERMCAP_QUERY_key_eol, /* kel/kE, STRING | clear-to-end-of-line */
1275 n_TERMCAP_QUERY_key_exit, /* kext/@9, STRING */
1276 n_TERMCAP_QUERY_key_ic, /* kich1/kI, STRING | insert character */
1277 n_TERMCAP_QUERY_key_sic, /* kIC/#3, STRING | ..shifted */
1278 n_TERMCAP_QUERY_key_home, /* khome/kh, STRING */
1279 n_TERMCAP_QUERY_key_shome, /* kHOM/#2, STRING | ..shifted */
1280 n_TERMCAP_QUERY_key_end, /* kend/@7, STRING */
1281 n_TERMCAP_QUERY_key_send, /* kEND / *7, STRING | ..shifted */
1282 n_TERMCAP_QUERY_key_npage, /* knp/kN, STRING */
1283 n_TERMCAP_QUERY_key_ppage, /* kpp/kP, STRING */
1284 n_TERMCAP_QUERY_key_left, /* kcub1/kl, STRING */
1285 n_TERMCAP_QUERY_key_sleft, /* kLFT/#4, STRING | ..shifted */
1286 n_TERMCAP_QUERY_xkey_aleft, /* kLFT3/-, STRING | X: Alt+left */
1287 n_TERMCAP_QUERY_xkey_cleft, /* kLFT5/-, STRING | X: Control+left */
1288 n_TERMCAP_QUERY_key_right, /* kcuf1/kr, STRING */
1289 n_TERMCAP_QUERY_key_sright, /* kRIT/%i, STRING | ..shifted */
1290 n_TERMCAP_QUERY_xkey_aright, /* kRIT3/-, STRING | X: Alt+right */
1291 n_TERMCAP_QUERY_xkey_cright, /* kRIT5/-, STRING | X: Control+right */
1292 n_TERMCAP_QUERY_key_down, /* kcud1/kd, STRING */
1293 n_TERMCAP_QUERY_xkey_sdown, /* kDN/-, STRING | ..shifted */
1294 n_TERMCAP_QUERY_xkey_adown, /* kDN3/-, STRING | X: Alt+down */
1295 n_TERMCAP_QUERY_xkey_cdown, /* kDN5/-, STRING | X: Control+down */
1296 n_TERMCAP_QUERY_key_up, /* kcuu1/ku, STRING */
1297 n_TERMCAP_QUERY_xkey_sup, /* kUP/-, STRING | ..shifted */
1298 n_TERMCAP_QUERY_xkey_aup, /* kUP3/-, STRING | X: Alt+up */
1299 n_TERMCAP_QUERY_xkey_cup, /* kUP5/-, STRING | X: Control+up */
1300 n_TERMCAP_QUERY_kf0, /* kf0/k0, STRING */
1301 n_TERMCAP_QUERY_kf1, /* kf1/k1, STRING */
1302 n_TERMCAP_QUERY_kf2, /* kf2/k2, STRING */
1303 n_TERMCAP_QUERY_kf3, /* kf3/k3, STRING */
1304 n_TERMCAP_QUERY_kf4, /* kf4/k4, STRING */
1305 n_TERMCAP_QUERY_kf5, /* kf5/k5, STRING */
1306 n_TERMCAP_QUERY_kf6, /* kf6/k6, STRING */
1307 n_TERMCAP_QUERY_kf7, /* kf7/k7, STRING */
1308 n_TERMCAP_QUERY_kf8, /* kf8/k8, STRING */
1309 n_TERMCAP_QUERY_kf9, /* kf9/k9, STRING */
1310 n_TERMCAP_QUERY_kf10, /* kf10/k;, STRING */
1311 n_TERMCAP_QUERY_kf11, /* kf11/F1, STRING */
1312 n_TERMCAP_QUERY_kf12, /* kf12/F2, STRING */
1313 n_TERMCAP_QUERY_kf13, /* kf13/F3, STRING */
1314 n_TERMCAP_QUERY_kf14, /* kf14/F4, STRING */
1315 n_TERMCAP_QUERY_kf15, /* kf15/F5, STRING */
1316 n_TERMCAP_QUERY_kf16, /* kf16/F6, STRING */
1317 n_TERMCAP_QUERY_kf17, /* kf17/F7, STRING */
1318 n_TERMCAP_QUERY_kf18, /* kf18/F8, STRING */
1319 n_TERMCAP_QUERY_kf19, /* kf19/F9, STRING */
1320 # endif /* HAVE_KEY_BINDINGS */
1322 n__TERMCAP_QUERY_MAX
1324 #endif /* n_HAVE_TCAP */
1326 enum n_visual_info_flags{
1327 n_VISUAL_INFO_NONE,
1328 n_VISUAL_INFO_ONE_CHAR = 1<<0, /* Step only one char, then return */
1329 n_VISUAL_INFO_SKIP_ERRORS = 1<<1, /* Treat via replacement, step byte */
1330 n_VISUAL_INFO_WIDTH_QUERY = 1<<2, /* Detect visual character widths */
1332 /* Rest only with HAVE_C90AMEND1, mutual with _ONE_CHAR */
1333 n_VISUAL_INFO_WOUT_CREATE = 1<<8, /* Use/create .vic_woudat */
1334 n_VISUAL_INFO_WOUT_SALLOC = 1<<9, /* ..salloc() it first */
1335 /* Only visuals into .vic_woudat - implies _WIDTH_QUERY */
1336 n_VISUAL_INFO_WOUT_PRINTABLE = 1<<10,
1337 n__VISUAL_INFO_FLAGS = n_VISUAL_INFO_WOUT_CREATE |
1338 n_VISUAL_INFO_WOUT_SALLOC | n_VISUAL_INFO_WOUT_PRINTABLE
1341 enum user_options {
1342 OPT_NONE,
1343 OPT_DEBUG = 1u<< 0, /* -d / *debug* */
1344 OPT_VERB = 1u<< 1, /* -v / *verbose* */
1345 OPT_VERBVERB = 1u<< 2, /* .. even more verbosity */
1346 OPT_EXISTONLY = 1u<< 3, /* -e */
1347 OPT_HEADERSONLY = 1u<<4, /* -H */
1348 OPT_HEADERLIST = 1u<< 5, /* -L */
1349 OPT_QUICKRUN_MASK = OPT_EXISTONLY | OPT_HEADERSONLY | OPT_HEADERLIST,
1350 OPT_E_FLAG = 1u<< 7, /* -E / *skipemptybody* */
1351 OPT_F_FLAG = 1u<< 8, /* -F */
1352 OPT_Mm_FLAG = 1u<< 9, /* -M or -m (plus option_Mm_arg) */
1353 OPT_N_FLAG = 1u<<10, /* -N / *header* */
1354 OPT_R_FLAG = 1u<<11, /* -R */
1355 OPT_r_FLAG = 1u<<12, /* -r (plus option_r_arg) */
1356 OPT_t_FLAG = 1u<<13, /* -t */
1357 OPT_TILDE_FLAG = 1u<<14, /* -~ */
1358 OPT_BATCH_FLAG = 1u<<15, /* -# */
1360 /* */
1361 OPT_MEMDEBUG = 1<<16, /* *memdebug* */
1363 /* */
1364 OPT_SENDMODE = 1u<<17, /* Usage case forces send mode */
1365 OPT_TTYIN = 1u<<18,
1366 OPT_TTYOUT = 1u<<19,
1367 OPT_INTERACTIVE = 1u<<20,
1368 OPT_UNICODE = 1u<<21, /* We're in an UTF-8 environment */
1370 OPT_ENC_MBSTATE = 1u<<22, /* Multibyte environment with shift states */
1372 /* Some easy-access shortcuts */
1373 OPT_D_V = OPT_DEBUG | OPT_VERB,
1374 OPT_D_VV = OPT_DEBUG | OPT_VERBVERB,
1375 OPT_D_V_VV = OPT_DEBUG | OPT_VERB | OPT_VERBVERB
1378 #define OBSOLETE(X) \
1379 do {\
1380 if (options & OPT_D_V_VV)\
1381 n_err("%s: %s\n", _("Obsoletion warning"), X);\
1382 } while (0)
1383 #define OBSOLETE2(X,Y) \
1384 do {\
1385 if (options & OPT_D_V_VV)\
1386 n_err("%s: %s: %s\n", _("Obsoletion warning"), X, Y);\
1387 } while (0)
1389 enum program_state {
1390 PS_NONE = 0,
1391 PS_STARTED = 1u<< 0, /* main.c startup code passed, functional */
1392 PS_ROOT = 1u<<30, /* Temporary "bypass any checks" bit */
1394 PS_EXIT = 1u<< 1, /* Exit request pending */
1395 PS_SOURCING = 1u<< 2, /* During load() or `source' */
1396 PS_RECURSED = 1u<< 3, /* State machine recursed, e.g. `~:CMD' */
1397 PS_ROBOT = 1u<< 4, /* State machine in non-interactive state */
1399 PS_EVAL_ERROR = 1u<< 5, /* Last evaluate() command failed */
1401 PS_HOOK_NEWMAIL = 1u<< 6,
1402 PS_HOOK = 1u<< 7,
1403 PS_HOOK_MASK = PS_HOOK_NEWMAIL | PS_HOOK,
1405 PS_EDIT = 1u<< 8, /* Current mailbox not a "system mailbox" */
1406 PS_SETFILE_OPENED = 1u<< 9, /* (hack) setfile() opened a new box */
1407 PS_SAW_COMMAND = 1u<<10, /* ..after mailbox switch */
1409 PS_DID_PRINT_DOT = 1u<<12, /* Current message has been printed */
1411 PS_SIGWINCH_PEND = 1u<<14, /* Need update of $COLUMNS/$LINES */
1412 PS_PSTATE_PENDMASK = PS_SIGWINCH_PEND, /* pstate housekeeping needed */
1414 PS_ARGLIST_MASK = n_BITENUM_MASK(17, 18),
1415 PS_MSGLIST_GABBY = 1u<<17, /* getmsglist() saw what it thinks: gabby */
1416 PS_MSGLIST_DIRECT = 1u<<18, /* One msg was directly chosen by number */
1417 /* TODO HACK: until v15 PS_MSGLIST_SAW_NO is an indication whether an entry
1418 * TODO may be placed in the history or not (grep this, see commands()),
1419 * TODO so avoid reusing this bit */
1420 PS_WYSHLIST_SAW_CONTROL = 1u<<18, /* ..saw C0+ control characters */
1422 PS_EXPAND_MULTIRESULT = 1u<<19, /* Last fexpand() with MULTIOK had .. */
1424 PS_HEADER_NEEDED_MIME = 1u<<20, /* mime_write_tohdr() needed x TODO HACK! */
1426 PS_READLINE_NL = 1u<<21, /* readline_input()+ saw a \n TODO HACK! */
1428 PS_COLOUR_ACTIVE = 1u<<22, /* n_colour_env_create().._gut() cycle */
1430 PS_ERRORS_PROMPT = 1u<<24, /* New error is to be reported in prompt */
1431 /* Various first-time-init switches */
1432 PS_ERRORS_NOTED = 1u<<25, /* Ring of `errors' advisory */
1433 PS_t_FLAG = 1u<<26, /* OPT_t_FLAG made persistant */
1434 PS_TERMCAP_DISABLE = 1u<<27, /* HAVE_TERMCAP: *termcap-disable* was set */
1435 PS_TERMCAP_CA_MODE = 1u<<28, /* HAVE_TERMCAP: ca_mode available & used */
1436 PS_LINE_EDITOR_INIT = 1u<<29 /* MLE is initialized */
1439 /* A large enum with all the boolean and value options a.k.a their keys.
1440 * Only the constant keys are in here, to be looked up via ok_[bv]look(),
1441 * ok_[bv]set() and ok_[bv]clear().
1442 * Notes:
1443 * - see the comments in accmacvar.c before changing *anything* in here!
1444 * - virt= implies rdonly,nodel
1445 * - import= implies env
1446 * - defval= implies notempty
1447 * - num and posnum are mutual exclusive
1448 * - most default VAL_ues come from in from build system via ./make.rc
1449 * (Keep in SYNC: ./nail.h:okeys, ./nail.rc, ./nail.1:"Initial settings") */
1450 enum okeys {
1451 /* TODO likely temporary hook data, v15 drop */
1452 ok_v_on_compose_enter,
1453 ok_v_on_compose_leave,
1454 ok_v_compose_from,
1455 ok_v_compose_sender,
1456 ok_v_compose_to,
1457 ok_v_compose_cc,
1458 ok_v_compose_bcc,
1459 ok_v_compose_subject,
1461 ok_v__account_name, /* {nolopts=1,rdonly=1,nodel=1} */
1462 ok_b_add_file_recipients,
1463 ok_v_agent_shell_lookup,
1464 ok_b_allnet,
1465 ok_b_append,
1466 ok_b_ask,
1467 ok_b_askatend,
1468 ok_b_askattach,
1469 ok_b_askbcc,
1470 ok_b_askcc,
1471 ok_b_asksign,
1472 ok_b_asksub, /* {i3val=TRU1} */
1473 ok_b_attachment_ask_content_description,
1474 ok_b_attachment_ask_content_disposition,
1475 ok_b_attachment_ask_content_id,
1476 ok_b_attachment_ask_content_type,
1477 ok_v_attrlist,
1478 ok_v_autobcc,
1479 ok_v_autocc,
1480 ok_b_autocollapse,
1481 ok_b_autoprint,
1482 ok_b_autothread,
1483 ok_v_autosort,
1485 ok_b_bang,
1486 ok_b_batch_exit_on_error,
1487 ok_v_bind_timeout, /* {notempty=1,posnum=1} */
1488 ok_b_bsdannounce,
1489 ok_b_bsdcompat,
1490 ok_b_bsdflags,
1491 ok_b_bsdheadline,
1492 ok_b_bsdmsgs,
1493 ok_b_bsdorder,
1495 ok_v_COLUMNS, /* {notempty=1,posnum=1,env=1} */
1496 ok_v_charset_7bit,
1497 ok_v_charset_8bit,
1498 ok_v_charset_unknown_8bit,
1499 ok_v_cmd,
1500 ok_b_colour_disable,
1501 ok_b_colour_pager,
1502 ok_v_crt, /* {posnum=1} */
1503 ok_v_customhdr, /* {nocntrls=1} */
1505 ok_v_DEAD, /* {notempty=1,env=1,defval=VAL_DEAD} */
1506 ok_v_datefield,
1507 ok_v_datefield_markout_older,
1508 ok_b_debug, /* {vip=1} */
1509 ok_b_disposition_notification_send,
1510 ok_b_dot,
1511 ok_b_dotlock_ignore_error,
1513 ok_v_EDITOR, /* {env=1,defval=VAL_EDITOR} */
1514 ok_b_editalong,
1515 ok_b_editheaders,
1516 ok_b_emptybox,
1517 ok_b_emptystart,
1518 ok_v_encoding,
1519 ok_v_escape,
1520 ok_v_expandaddr,
1521 ok_v_expandargv,
1522 /* TODO -exit-status should be num=1 */
1523 ok_v__exit_status, /* {nolopts=1,rdonly=1,nodel=1} */
1525 ok_v_features, /* {virt=VAL_FEATURES} */
1526 ok_b_flipr,
1527 ok_v_folder, /* {vip=1} */
1528 ok_v__folder_resolved, /* {rdonly=1,nodel=1} */
1529 ok_v_folder_hook,
1530 ok_b_followup_to,
1531 ok_v_followup_to_honour,
1532 ok_b_forward_as_attachment,
1533 ok_v_from,
1534 ok_b_fullnames,
1535 ok_v_fwdheading,
1537 ok_v_HOME, /* {vip=1,nodel=1,import=1} */
1538 ok_b_header, /* {vip=1,i3val=TRU1} */
1539 ok_v_headline,
1540 ok_v_headline_bidi,
1541 ok_v_history_file,
1542 ok_b_history_gabby,
1543 ok_b_history_gabby_persist,
1544 ok_v_history_size, /* {notempty=1,num=1} */
1545 ok_b_hold,
1546 ok_v_hostname,
1548 ok_b_idna_disable,
1549 ok_b_ignore,
1550 ok_b_ignoreeof,
1551 ok_v_inbox,
1552 ok_v_indentprefix,
1554 ok_b_keep,
1555 ok_b_keep_content_length,
1556 ok_b_keepsave,
1558 ok_v_LINES, /* {notempty=1,posnum=1,env=1} */
1559 ok_v_LISTER, /* {env=1,defval=VAL_LISTER} */
1560 ok_v_LOGNAME, /* {rdonly=1,import=1} */
1561 ok_b_line_editor_disable,
1562 ok_b_line_editor_no_defaults,
1564 ok_v_MAIL, /* {env=1} */
1565 ok_v_MAILRC, /* {import=1,defval=VAL_MAILRC} */
1566 ok_v_MBOX, /* {env=1,defval=VAL_MBOX} */
1567 ok_v__mailbox_resolved, /* {nolopts=1,rdonly=1,nodel=1} */
1568 ok_v__mailbox_display, /* {nolopts=1,rdonly=1,nodel=1} */
1569 ok_b_markanswered,
1570 ok_b_memdebug, /* {vip=1} */
1571 ok_b_message_id_disable,
1572 ok_v_message_inject_head,
1573 ok_v_message_inject_tail,
1574 ok_b_metoo,
1575 ok_b_mime_allow_text_controls,
1576 ok_b_mime_alternative_favour_rich,
1577 ok_v_mime_counter_evidence, /* {posnum=1} */
1578 ok_v_mimetypes_load_control,
1579 /* TODO: v15 (not yet due to <-> sendmail): {defval=VAL_MTA} */
1580 ok_v_mta,
1581 ok_v_mta_arguments,
1582 ok_b_mta_no_default_arguments,
1583 /* TODO v15: (not yet due to <-> sendmail-progname {defval=VAL_MTA_ARGV0} */
1584 ok_v_mta_argv0,
1586 ok_v_NAIL_EXTRA_RC, /* {name=NAIL_EXTRA_RC} */
1587 ok_b_NAIL_NO_SYSTEM_RC, /* {import=1} */
1588 ok_v_NAIL_HEAD, /* {name=NAIL_HEAD} */
1589 ok_v_NAIL_HISTFILE, /* {name=NAIL_HISTFILE} */
1590 ok_v_NAIL_HISTSIZE, /* {name=NAIL_HISTSIZE,notempty=1,num=1} */
1591 ok_v_NAIL_TAIL, /* {name=NAIL_TAIL} */
1592 ok_v_NETRC, /* {env=1,defval=VAL_NETRC} */
1593 ok_b_netrc_lookup,
1594 ok_v_netrc_pipe,
1595 ok_v_newfolders,
1596 ok_v_newmail,
1598 ok_b_outfolder,
1600 ok_v_PAGER, /* {env=1,defval=VAL_PAGER} */
1601 ok_v_PATH, /* {nodel=1,import=1} */
1602 ok_b_page,
1603 ok_v_password,
1604 ok_b_piperaw,
1605 ok_v_pop3_auth,
1606 ok_b_pop3_bulk_load,
1607 ok_v_pop3_keepalive,
1608 ok_b_pop3_no_apop,
1609 ok_b_pop3_use_starttls,
1610 ok_b_print_alternatives,
1611 ok_v_prompt, /* {i3val="? "} */
1612 ok_v_prompt2, /* {i3val=".. "} */
1614 ok_b_quiet,
1615 ok_v_quote,
1616 ok_b_quote_as_attachment,
1617 ok_v_quote_fold,
1619 ok_b_recipients_in_cc,
1620 ok_v_record,
1621 ok_b_record_resent,
1622 ok_b_reply_in_same_charset,
1623 ok_v_reply_strings,
1624 ok_v_replyto,
1625 ok_v_reply_to_honour,
1626 ok_b_rfc822_body_from_, /* {name=rfc822-body-from_} */
1628 ok_v_SHELL, /* {import=1,defval=VAL_SHELL} */
1629 ok_b_SYSV3, /* {env=1} */
1630 ok_b_save, /* {i3val=TRU1} */
1631 ok_v_screen, /* {notempty=1,posnum=1} */
1632 ok_b_searchheaders,
1633 ok_v_sendcharsets,
1634 ok_b_sendcharsets_else_ttycharset,
1635 ok_v_sender,
1636 ok_v_sendmail,
1637 ok_v_sendmail_arguments,
1638 ok_b_sendmail_no_default_arguments,
1639 ok_v_sendmail_progname,
1640 ok_b_sendwait,
1641 ok_b_showlast,
1642 ok_b_showname,
1643 ok_b_showto,
1644 ok_v_Sign,
1645 ok_v_sign,
1646 ok_v_signature,
1647 ok_b_skipemptybody, /* {vip=1} */
1648 ok_v_smime_ca_dir,
1649 ok_v_smime_ca_file,
1650 ok_v_smime_cipher,
1651 ok_v_smime_crl_dir,
1652 ok_v_smime_crl_file,
1653 /* smime-encrypt-USER@HOST */
1654 ok_b_smime_force_encryption,
1655 ok_b_smime_no_default_ca,
1656 ok_b_smime_sign,
1657 ok_v_smime_sign_cert,
1658 ok_v_smime_sign_include_certs,
1659 ok_v_smime_sign_message_digest,
1660 ok_v_smtp,
1661 ok_v_smtp_auth,
1662 ok_v_smtp_auth_password,
1663 ok_v_smtp_auth_user,
1664 ok_v_smtp_hostname,
1665 ok_b_smtp_use_starttls,
1666 ok_v_SOURCE_DATE_EPOCH,/*{name=SOURCE_DATE_EPOCH,env=1,notempty=1,posnum=1}*/
1667 ok_v_spam_interface,
1668 ok_v_spam_maxsize, /* {notempty=1,posnum=1} */
1669 ok_v_spamc_command,
1670 ok_v_spamc_arguments,
1671 ok_v_spamc_user,
1672 ok_v_spamd_socket,
1673 ok_v_spamd_user,
1674 ok_v_spamfilter_ham,
1675 ok_v_spamfilter_noham,
1676 ok_v_spamfilter_nospam,
1677 ok_v_spamfilter_rate,
1678 ok_v_spamfilter_rate_scanscore,
1679 ok_v_spamfilter_spam,
1680 ok_v_ssl_ca_dir,
1681 ok_v_ssl_ca_file,
1682 ok_v_ssl_cert,
1683 ok_v_ssl_cipher_list,
1684 ok_v_ssl_config_file,
1685 ok_v_ssl_crl_dir,
1686 ok_v_ssl_crl_file,
1687 ok_v_ssl_key,
1688 ok_v_ssl_method,
1689 ok_b_ssl_no_default_ca,
1690 ok_v_ssl_protocol,
1691 ok_v_ssl_rand_egd,
1692 ok_v_ssl_rand_file,
1693 ok_v_ssl_verify,
1694 ok_v_stealthmua,
1696 ok_v_TERM, /* {env=1} */
1697 ok_v_TMPDIR, /* {import=1,defval=VAL_TMPDIR} */
1698 ok_v_termcap,
1699 ok_b_termcap_disable,
1700 ok_v_toplines, /* {notempty=1,num=1,defval="5"} */
1701 ok_b_topsqueeze,
1702 ok_v_ttycharset,
1703 ok_b_typescript_mode, /* {vip=1} */
1705 ok_v_USER, /* {rdonly=1,import=1} */
1706 ok_v_umask, /* {vip=1,nodel=1,posnum=1,i3val="0077"} */
1707 ok_v_user,
1709 ok_v_VISUAL, /* {env=1,defval=VAL_VISUAL} */
1710 ok_b_v15_compat,
1711 ok_b_verbose, /* {vip=1} */
1712 ok_v_version, /* {virt=VERSION} */
1713 ok_v_version_major, /* {virt=VERSION_MAJOR} */
1714 ok_v_version_minor, /* {virt=VERSION_MINOR} */
1715 ok_v_version_update, /* {virt=VERSION_UPDATE} */
1717 ok_b_writebackedited
1720 /* Locale-independent character classes */
1721 enum {
1722 C_CNTRL = 1<<0,
1723 C_BLANK = 1<<1,
1724 C_WHITE = 1<<2,
1725 C_SPACE = 1<<3,
1726 C_PUNCT = 1<<4,
1727 C_OCTAL = 1<<5,
1728 C_DIGIT = 1<<6,
1729 C_UPPER = 1<<7,
1730 C_LOWER = 1<<8
1733 struct str {
1734 char *s; /* the string's content */
1735 size_t l; /* the stings's length */
1738 struct n_string{
1739 char *s_dat; /*@ May contain NULs, not automatically terminated */
1740 ui32_t s_len; /*@ gth of string */
1741 #ifdef HAVE_BYTE_ORDER_LITTLE
1742 ui32_t s_auto : 1; /* Stored in auto-reclaimed storage? */
1743 #endif
1744 ui32_t s_size : 31; /* of .s_dat, -1 */
1745 #ifndef HAVE_BYTE_ORDER_LITTLE
1746 ui32_t s_auto : 1;
1747 #endif
1750 struct n_strlist{
1751 struct n_strlist *sl_next;
1752 size_t sl_len;
1753 char sl_dat[n_VFIELD_SIZE(0)];
1755 #define n_STRLIST_MALLOC(SZ) /* XXX -> nailfuns.h (and pimp interface) */\
1756 smalloc(sizeof(struct n_strlist) - \
1757 n_VFIELD_SIZEOF(struct n_strlist, sl_dat) + (SZ) +1)
1759 struct bidi_info {
1760 struct str bi_start; /* Start of (possibly) bidirectional text */
1761 struct str bi_end; /* End of ... */
1762 size_t bi_pad; /* No of visual columns to reserve for BIDI pad */
1765 struct n_cmd_arg_desc{
1766 char cad_name[12]; /* Name of command */
1767 ui32_t cad_no; /* Number of entries in cad_ent_flags */
1768 /* [enum n_cmd_arg_desc_flags,arg-dep] */
1769 ui32_t cad_ent_flags[n_VFIELD_SIZE(0)][2];
1771 /* ISO C(99) doesn't allow initialization of "flex array" */
1772 #define n_CMD_ARG_DESC_SUBCLASS_DEF(CMD,NO,VAR) \
1773 struct n_cmd_arg_desc_ ## CMD {\
1774 char cad_name[12];\
1775 ui32_t cad_no;\
1776 ui32_t cad_ent_flags[NO][2];\
1777 } const VAR = { #CMD, NO,
1778 #define n_CMD_ARG_DESC_SUBCLASS_DEF_END }
1779 #define n_CMD_ARG_DESC_SUBCLASS_CAST(P) ((struct n_cmd_arg_desc const*)P)
1781 struct n_cmd_arg_ctx{
1782 struct n_cmd_arg_desc const *cac_desc;
1783 char const *cac_indat; /* Input that shall be parsed */
1784 size_t cac_inlen; /* Input length (UIZ_MAX: do a strlen()) */
1785 size_t cac_no; /* Output: number of parsed arguments */
1786 struct n_cmd_arg *cac_arg; /* Output: parsed arguments */
1789 struct n_cmd_arg{/* TODO incomplete, misses getmsglist() */
1790 struct n_cmd_arg *ca_next;
1791 char const *ca_indat; /* Pointer into n_cmd_arg_ctx.cac_indat */
1792 size_t ca_inlen; /* of .ca_indat of this arg (not terminated) */
1793 ui32_t ca_ent_flags[2]; /* Copy of n_cmd_arg_desc.cad_ent_flags[X] */
1794 ui32_t ca_arg_flags; /* [Output: _WYSH: copy of parse result flags] */
1795 ui8_t ca__dummy[4];
1796 union{
1797 struct str ca_str; /* _STRING, _WYSH */
1798 } ca_arg; /* Output: parsed result */
1801 #ifdef HAVE_COLOUR
1802 struct n_colour_pen;
1803 #endif
1805 struct url {
1806 char const *url_input; /* Input as given (really) */
1807 enum cproto url_cproto; /* Communication protocol as given */
1808 bool_t url_needs_tls; /* Whether the protocol uses SSL/TLS */
1809 bool_t url_had_user; /* Whether .url_user was part of the URL */
1810 ui16_t url_portno; /* atoi .url_port or default, host endian */
1811 char const *url_port; /* Port (if given) or NULL */
1812 char url_proto[14]; /* Communication protocol as 'xy\0//' */
1813 ui8_t url_proto_len; /* Length of .url_proto ('\0' index) */
1814 ui8_t url_proto_xlen; /* .. if '\0' is replaced with ':' */
1815 struct str url_user; /* User, exactly as given / looked up */
1816 struct str url_user_enc; /* User, urlxenc()oded */
1817 struct str url_pass; /* Pass (urlxdec()oded) or NULL */
1818 struct str url_host; /* Service hostname */
1819 struct str url_path; /* Path suffix or NULL */
1820 /* TODO: url_get_component(url *, enum COMPONENT, str *store) */
1821 struct str url_h_p; /* .url_host[:.url_port] */
1822 /* .url_user@.url_host
1823 * Note: for CPROTO_SMTP this may resolve HOST via *smtp-hostname* (->
1824 * *hostname*)! (And may later be overwritten according to *from*!) */
1825 struct str url_u_h;
1826 struct str url_u_h_p; /* .url_user@.url_host[:.url_port] */
1827 struct str url_eu_h_p; /* .url_user_enc@.url_host[:.url_port] */
1828 char const *url_p_u_h_p; /* .url_proto://.url_u_h_p */
1829 char const *url_p_eu_h_p; /* .url_proto://.url_eu_h_p */
1830 char const *url_p_eu_h_p_p; /* .url_proto://.url_eu_h_p[/.url_path] */
1833 struct ccred {
1834 enum cproto cc_cproto; /* Communication protocol */
1835 enum authtype cc_authtype; /* Desired authentication */
1836 char const *cc_auth; /* Authentication type as string */
1837 struct str cc_user; /* User (urlxdec()oded) or NULL */
1838 struct str cc_pass; /* Password (urlxdec()oded) or NULL */
1841 #ifdef HAVE_DOTLOCK
1842 struct n_dotlock_info{
1843 char const *di_file_name; /* Mailbox to lock */
1844 char const *di_lock_name; /* .di_file_name + .lock */
1845 char const *di_hostname; /* ..filled in parent (due resolver delays) */
1846 char const *di_randstr; /* ..ditto, random string */
1847 size_t di_pollmsecs; /* Delay in between locking attempts */
1848 struct stat *di_stb;
1850 #endif
1852 /* Execution context bundles */
1853 struct n_exec_ctx{
1855 void *l_smem; /* salloc() memory TODO -> memraw? */
1856 /* TODO our new per-exec-ctx memory "allocators" are yet very dumb.
1857 * TODO for v15 those should not be wrapping nodes but real allocators */
1858 struct n_mem_raw *l_memraw; /* n_mem_alloc() (/ n_mem_free()) */
1859 struct n_mem_wrap *l_memwrap; /* n_mem_wrap() (/ n_mem_unwrap()) */
1862 struct n_mem_raw{
1863 struct n_mem_raw *mr_prev;
1864 struct n_mem_raw *mr_next;
1865 char mr_buf[n_VFIELD_SIZE(0)];
1868 struct n_mem_wrap{
1869 struct n_mem_wrap *mw_prev;
1870 struct n_mem_wrap *mw_next;
1871 void *mw_obj;
1872 void (*mw_dtor)(void *obj);
1875 struct mime_handler {
1876 enum mime_handler_flags mh_flags;
1877 struct str mh_msg; /* Message describing this command */
1878 /* XXX union{} the following? */
1879 char const *mh_shell_cmd; /* For MIME_HDL_CMD */
1880 int (*mh_ptf)(void); /* PTF main() for MIME_HDL_PTF */
1883 struct quoteflt {
1884 FILE *qf_os; /* Output stream */
1885 char const *qf_pfix;
1886 ui32_t qf_pfix_len; /* Length of prefix: 0: bypass */
1887 ui32_t qf_qfold_min; /* Simple way: wrote prefix? */
1888 /* TODO quoteflt.qf_nl_last is a hack that i have introduced so that we
1889 * TODO finally can gracefully place a newline last in the visual display.
1890 * TODO I.e., for cases where quoteflt shouldn't be used at all ;} */
1891 bool_t qf_nl_last; /* Last thing written/seen was NL */
1892 #ifndef HAVE_QUOTE_FOLD
1893 ui8_t __dummy[7];
1894 #else
1895 ui8_t __dummy[1];
1896 ui8_t qf_state; /* *quote-fold* state machine */
1897 bool_t qf_brk_isws; /* Breakpoint is at WS */
1898 ui32_t qf_qfold_max; /* Otherwise: line lengths */
1899 ui32_t qf_wscnt; /* Whitespace count */
1900 ui32_t qf_brkl; /* Breakpoint */
1901 ui32_t qf_brkw; /* Visual width, breakpoint */
1902 ui32_t qf_datw; /* Current visual output line width */
1903 struct str qf_dat; /* Current visual output line */
1904 struct str qf_currq; /* Current quote, compressed */
1905 mbstate_t qf_mbps[2];
1906 #endif
1909 #ifdef HAVE_FILTER_HTML_TAGSOUP
1910 struct htmlflt {
1911 FILE *hf_os; /* Output stream */
1912 ui32_t hf_flags;
1913 ui32_t hf_lmax; /* Maximum byte +1 in .hf_line/4 */
1914 ui32_t hf_len; /* Current bytes in .hf_line */
1915 ui32_t hf_last_ws; /* Last whitespace on line (fold purposes) */
1916 ui32_t hf_mboff; /* Last offset for "mbtowc" */
1917 ui32_t hf_mbwidth; /* We count characters not bytes if possible */
1918 char *hf_line; /* Output line buffer - MUST be last field! */
1919 si32_t hf_href_dist; /* Count of lines since last HREF flush */
1920 ui32_t hf_href_no; /* HREF sequence number */
1921 struct htmlflt_href *hf_hrefs;
1922 struct htmlflt_tag const *hf_ign_tag; /* Tag that will end ignore mode */
1923 char *hf_curr; /* Current cursor into .hf_bdat */
1924 char *hf_bmax; /* Maximum byte in .hf_bdat +1 */
1925 char *hf_bdat; /* (Temporary) Tag content data storage */
1927 #endif
1929 struct search_expr {
1930 char const *ss_where; /* ..to search for the expr. (not always used) */
1931 char const *ss_sexpr; /* String search expr.; NULL: use .ss_regex */
1932 #ifdef HAVE_REGEX
1933 regex_t ss_regex;
1934 #endif
1937 /* This is somewhat temporary for pre v15 */
1938 struct n_sigman{
1939 ui32_t sm_flags; /* enum n_sigman_flags */
1940 int sm_signo;
1941 struct n_sigman *sm_outer;
1942 sighandler_type sm_ohup;
1943 sighandler_type sm_oint;
1944 sighandler_type sm_oquit;
1945 sighandler_type sm_oterm;
1946 sighandler_type sm_opipe;
1947 sigjmp_buf sm_jump;
1950 struct termios_state {
1951 struct termios ts_tios;
1952 char *ts_linebuf;
1953 size_t ts_linesize;
1954 bool_t ts_needs_reset;
1957 #define termios_state_reset() \
1958 do {\
1959 if (termios_state.ts_needs_reset) {\
1960 tcsetattr(0, TCSADRAIN, &termios_state.ts_tios);\
1961 termios_state.ts_needs_reset = FAL0;\
1963 } while (0)
1965 #ifdef n_HAVE_TCAP
1966 struct n_termcap_value{
1967 enum n_termcap_captype tv_captype;
1968 ui8_t tv__dummy[4];
1969 union n_termcap_value_data{
1970 bool_t tvd_bool;
1971 ui32_t tvd_numeric;
1972 char const *tvd_string;
1973 } tv_data;
1975 #endif
1977 struct n_visual_info_ctx{
1978 char const *vic_indat; /*I Input data */
1979 size_t vic_inlen; /*I If UIZ_MAX, strlen(.vic_indat) */
1980 char const *vic_oudat; /*O remains */
1981 size_t vic_oulen;
1982 size_t vic_chars_seen; /*O number of characters processed */
1983 size_t vic_bytes_seen; /*O number of bytes passed */
1984 size_t vic_vi_width; /*[O] visual width of the entire range */
1985 wc_t *vic_woudat; /*[O] if so requested */
1986 size_t vic_woulen; /*[O] entries in .vic_woudat, if used */
1987 wc_t vic_waccu; /*O The last wchar_t/char processed (if any) */
1988 enum n_visual_info_flags vic_flags; /*O Copy of parse flags */
1989 /* TODO bidi */
1990 #ifdef HAVE_C90AMEND1
1991 mbstate_t *vic_mbstate; /*IO .vic_mbs_def used if NULL */
1992 mbstate_t vic_mbs_def;
1993 #endif
1996 struct time_current {
1997 time_t tc_time;
1998 struct tm tc_gm;
1999 struct tm tc_local;
2000 char tc_ctime[32];
2003 struct sock { /* data associated with a socket */
2004 int s_fd; /* file descriptor */
2005 #ifdef HAVE_SSL
2006 int s_use_ssl; /* SSL is used */
2007 # ifdef HAVE_XSSL
2008 void *s_ssl; /* SSL object */
2009 # endif
2010 #endif
2011 char *s_wbuf; /* for buffered writes */
2012 int s_wbufsize; /* allocated size of s_buf */
2013 int s_wbufpos; /* position of first empty data byte */
2014 char *s_rbufptr; /* read pointer to s_rbuf */
2015 int s_rsz; /* size of last read in s_rbuf */
2016 char const *s_desc; /* description of error messages */
2017 void (*s_onclose)(void); /* execute on close */
2018 char s_rbuf[LINESIZE + 1]; /* for buffered reads */
2021 struct sockconn {
2022 struct url sc_url;
2023 struct ccred sc_cred;
2024 struct sock sc_sock;
2027 struct mailbox {
2028 enum {
2029 MB_NONE = 000, /* no reply expected */
2030 MB_COMD = 001, /* command reply expected */
2031 MB_MULT = 002, /* multiline reply expected */
2032 MB_PREAUTH = 004, /* not in authenticated state */
2033 MB_BYE = 010, /* may accept a BYE state */
2034 MB_FROM__WARNED = 1<<4 /* MBOX with invalid from seen & logged */
2035 } mb_active;
2036 FILE *mb_itf; /* temp file with messages, read open */
2037 FILE *mb_otf; /* same, write open */
2038 char *mb_sorted; /* sort method */
2039 enum {
2040 MB_VOID, /* no type (e. g. connection failed) */
2041 MB_FILE, /* local file */
2042 MB_POP3, /* POP3 mailbox */
2043 MB_MAILDIR /* maildir folder */
2044 } mb_type; /* type of mailbox */
2045 enum {
2046 MB_DELE = 01, /* may delete messages in mailbox */
2047 MB_EDIT = 02 /* may edit messages in mailbox */
2048 } mb_perm;
2049 int mb_threaded; /* mailbox has been threaded */
2050 struct sock mb_sock; /* socket structure */
2053 enum needspec {
2054 NEED_UNSPEC, /* unspecified need, don't fetch */
2055 NEED_HEADER, /* need the header of a message */
2056 NEED_BODY /* need header and body of a message */
2059 enum havespec {
2060 HAVE_NOTHING, /* nothing downloaded yet */
2061 HAVE_HEADER = 01, /* header is downloaded */
2062 HAVE_BODY = 02 /* entire message is downloaded */
2065 /* flag bits. Attention: Flags that are used in cache.c may not change */
2066 enum mflag {
2067 MUSED = (1<< 0), /* entry is used, but this bit isn't */
2068 MDELETED = (1<< 1), /* entry has been deleted */
2069 MSAVED = (1<< 2), /* entry has been saved */
2070 MTOUCH = (1<< 3), /* entry has been noticed */
2071 MPRESERVE = (1<< 4), /* keep entry in sys mailbox */
2072 MMARK = (1<< 5), /* message is marked! */
2073 MODIFY = (1<< 6), /* message has been modified */
2074 MNEW = (1<< 7), /* message has never been seen */
2075 MREAD = (1<< 8), /* message has been read sometime. */
2076 MSTATUS = (1<< 9), /* message status has changed */
2077 MBOX = (1<<10), /* Send this to mbox, regardless */
2078 MNOFROM = (1<<11), /* no From line */
2079 MHIDDEN = (1<<12), /* message is hidden to user */
2080 MBOXED = (1<<13), /* message has been sent to mbox */
2081 MNEWEST = (1<<14), /* message is very new (newmail) */
2082 MFLAG = (1<<15), /* message has been flagged recently */
2083 MUNFLAG = (1<<16), /* message has been unflagged */
2084 MFLAGGED = (1<<17), /* message is `flagged' */
2085 MANSWER = (1<<18), /* message has been answered recently */
2086 MUNANSWER = (1<<19), /* message has been unanswered */
2087 MANSWERED = (1<<20), /* message is `answered' */
2088 MDRAFT = (1<<21), /* message has been drafted recently */
2089 MUNDRAFT = (1<<22), /* message has been undrafted */
2090 MDRAFTED = (1<<23), /* message is marked as `draft' */
2091 MOLDMARK = (1<<24), /* messages was marked previously */
2092 MSPAM = (1<<25), /* message is classified as spam */
2093 MSPAMUNSURE = (1<<26) /* message may be spam, but it is unsure */
2095 #define MMNORM (MDELETED | MSAVED | MHIDDEN)
2096 #define MMNDEL (MDELETED | MHIDDEN)
2098 #define visible(mp) (((mp)->m_flag & MMNDEL) == 0)
2100 struct mimepart {
2101 enum mflag m_flag; /* flags */
2102 enum havespec m_have; /* downloaded parts of the part */
2103 #ifdef HAVE_SPAM
2104 ui32_t m_spamscore; /* Spam score as int, 24:8 bits */
2105 #endif
2106 int m_block; /* block number of this part */
2107 size_t m_offset; /* offset in block of part */
2108 size_t m_size; /* Bytes in the part */
2109 size_t m_xsize; /* Bytes in the full part */
2110 long m_lines; /* Lines in the message */
2111 long m_xlines; /* Lines in the full message */
2112 time_t m_time; /* time the message was sent */
2113 char const *m_from; /* message sender */
2114 struct mimepart *m_nextpart; /* next part at same level */
2115 struct mimepart *m_multipart; /* parts of multipart */
2116 struct mimepart *m_parent; /* enclosing multipart part */
2117 char const *m_ct_type; /* content-type */
2118 char const *m_ct_type_plain; /* content-type without specs */
2119 char const *m_ct_type_usr_ovwr; /* Forcefully overwritten one */
2120 enum mimecontent m_mimecontent; /* same in enum */
2121 char const *m_charset; /* charset */
2122 char const *m_ct_enc; /* content-transfer-encoding */
2123 enum mime_enc m_mime_enc; /* same in enum */
2124 char *m_partstring; /* part level string */
2125 char *m_filename; /* attachment filename */
2128 struct message {
2129 enum mflag m_flag; /* flags */
2130 enum havespec m_have; /* downloaded parts of the message */
2131 #ifdef HAVE_SPAM
2132 ui32_t m_spamscore; /* Spam score as int, 24:8 bits */
2133 #endif
2134 int m_block; /* block number of this message */
2135 size_t m_offset; /* offset in block of message */
2136 size_t m_size; /* Bytes in the message */
2137 size_t m_xsize; /* Bytes in the full message */
2138 long m_lines; /* Lines in the message */
2139 long m_xlines; /* Lines in the full message */
2140 time_t m_time; /* time the message was sent */
2141 time_t m_date; /* time in the 'Date' field */
2142 unsigned m_idhash; /* hash on Message-ID for threads */
2143 struct message *m_child; /* first child of this message */
2144 struct message *m_younger; /* younger brother of this message */
2145 struct message *m_elder; /* elder brother of this message */
2146 struct message *m_parent; /* parent of this message */
2147 unsigned m_level; /* thread level of message */
2148 long m_threadpos; /* position in threaded display */
2149 char *m_maildir_file; /* original maildir file of msg */
2150 ui32_t m_maildir_hash; /* hash of file name in maildir sub */
2151 int m_collapsed; /* collapsed thread information */
2154 /* Given a file address, determine the block number it represents */
2155 #define mailx_blockof(off) ((int) ((off) / 4096))
2156 #define mailx_offsetof(off) ((int) ((off) % 4096))
2157 #define mailx_positionof(block, offset) ((off_t)(block) * 4096 + (offset))
2159 /* Argument types */
2160 enum argtype {
2161 ARG_MSGLIST = 0, /* Message list type */
2162 ARG_STRLIST = 1, /* A pure string */
2163 ARG_RAWLIST = 2, /* getrawlist(), old style */
2164 ARG_NOLIST = 3, /* Just plain 0 */
2165 ARG_NDMLIST = 4, /* Message list, no defaults */
2166 ARG_WYSHLIST = 5, /* getrawlist(), sh(1) compatible */
2167 ARG_WYRALIST = 6, /* _RAWLIST or _WYSHLIST (with `wysh') */
2168 ARG_ARGMASK = 7, /* Mask of the above */
2170 ARG_A = 1u<< 4, /* Needs an active mailbox */
2171 ARG_F = 1u<< 5, /* Is a conditional command */
2172 ARG_G = 1u<< 6, /* Is supposed to produce "gabby" history */
2173 ARG_H = 1u<< 7, /* Never place in `history' */
2174 ARG_I = 1u<< 8, /* Interactive command bit */
2175 ARG_M = 1u<< 9, /* Legal from send mode bit */
2176 ARG_P = 1u<<10, /* Autoprint dot after command */
2177 ARG_R = 1u<<11, /* Cannot be called from collect / recursion */
2178 ARG_S = 1u<<12, /* Cannot be called unless PS_STARTED (POSIX) */
2179 ARG_T = 1u<<13, /* Is a transparent command */
2180 ARG_V = 1u<<14, /* Places data in temporary_arg_v_store */
2181 ARG_W = 1u<<15, /* Invalid when read only bit */
2182 ARG_O = 1u<<16 /* OBSOLETE()d command */
2185 enum gfield {
2186 GTO = 1<< 0, /* Grab To: line */
2187 GSUBJECT = 1<< 1, /* Likewise, Subject: line */
2188 GCC = 1<< 2, /* And the Cc: line */
2189 GBCC = 1<< 3, /* And also the Bcc: line */
2191 GNL = 1<< 4, /* Print blank line after */
2192 GDEL = 1<< 5, /* Entity removed from list */
2193 GCOMMA = 1<< 6, /* detract() puts in commas */
2194 GUA = 1<< 7, /* User-Agent field */
2195 GMIME = 1<< 8, /* MIME 1.0 fields */
2196 GMSGID = 1<< 9, /* a Message-ID */
2197 GNAMEONLY = 1<<10, /* detract() does NOT use fullnames */
2199 GIDENT = 1<<11, /* From:, Reply-To:, MFT: (user headers) */
2200 GREF = 1<<12, /* References:, In-Reply-To:, (Message-ID:) */
2201 GDATE = 1<<13, /* Date: field */
2202 GFULL = 1<<14, /* Include full names, comments etc. */
2203 GSKIN = 1<<15, /* Skin names */
2204 GEXTRA = 1<<16, /* Extra fields (mostly like GIDENT XXX) */
2205 GFILES = 1<<17, /* Include filename and pipe addresses */
2206 GFULLEXTRA = 1<<18 /* Only with GFULL: GFULL less address */
2208 #define GMASK (GTO | GSUBJECT | GCC | GBCC)
2210 enum header_flags {
2211 HF_NONE = 0,
2212 HF_LIST_REPLY = 1<< 0,
2213 HF_MFT_SENDER = 1<< 1, /* Add ourselves to Mail-Followup-To: */
2214 HF_RECIPIENT_RECORD = 1<<10, /* Save message in file named after rec. */
2215 HF__NEXT_SHIFT = 11
2218 /* Structure used to pass about the current state of a message (header) */
2219 struct n_header_field{
2220 struct n_header_field *hf_next;
2221 ui32_t hf_nl; /* Field-name length */
2222 ui32_t hf_bl; /* Field-body length*/
2223 char hf_dat[n_VFIELD_SIZE(0)];
2226 struct header {
2227 ui32_t h_flags; /* enum header_flags bits */
2228 ui32_t h_dummy;
2229 struct name *h_to; /* Dynamic "To:" string */
2230 char *h_subject; /* Subject string */
2231 struct name *h_cc; /* Carbon copies string */
2232 struct name *h_bcc; /* Blind carbon copies */
2233 struct name *h_ref; /* References (possibly overridden) */
2234 struct attachment *h_attach; /* MIME attachments */
2235 char *h_charset; /* preferred charset */
2236 struct name *h_from; /* overridden "From:" field */
2237 struct name *h_sender; /* overridden "Sender:" field */
2238 struct name *h_replyto; /* overridden "Reply-To:" field */
2239 struct name *h_message_id; /* overridden "Message-ID:" field */
2240 struct name *h_in_reply_to;/* overridden "In-Reply-To:" field */
2241 struct name *h_mft; /* Mail-Followup-To */
2242 char const *h_list_post; /* Address from List-Post:, for `Lreply' */
2243 struct n_header_field *h_user_headers;
2244 struct n_header_field *h_custom_headers; /* (Cached result) */
2247 /* Handling of namelist nodes used in processing the recipients of mail and
2248 * aliases, inspection of mail-addresses and all that kind of stuff */
2249 enum nameflags {
2250 NAME_NAME_SALLOC = 1<< 0, /* .n_name is doped */
2251 NAME_FULLNAME_SALLOC = 1<< 1, /* .n_fullname is doped */
2252 NAME_SKINNED = 1<< 2, /* Is actually skin()ned */
2253 NAME_IDNA = 1<< 3, /* IDNA was applied */
2255 NAME_ADDRSPEC_CHECKED = 1<< 4, /* Address has been .. and */
2256 NAME_ADDRSPEC_ISFILE = 1<< 5, /* ..is a file path */
2257 NAME_ADDRSPEC_ISPIPE = 1<< 6, /* ..is a command for piping */
2258 NAME_ADDRSPEC_ISFILEORPIPE = NAME_ADDRSPEC_ISFILE | NAME_ADDRSPEC_ISPIPE,
2259 NAME_ADDRSPEC_ISNAME = 1<< 7, /* ..is a valid mail network address */
2260 NAME_ADDRSPEC_ISADDR = 1<< 8, /* ..is a valid mail network address */
2262 NAME_ADDRSPEC_ERR_EMPTY = 1<< 9, /* An empty string (or NULL) */
2263 NAME_ADDRSPEC_ERR_ATSEQ = 1<<10, /* Weird @ sequence */
2264 NAME_ADDRSPEC_ERR_CHAR = 1<<11, /* Invalid character */
2265 NAME_ADDRSPEC_ERR_IDNA = 1<<12, /* IDNA convertion failed */
2266 NAME_ADDRSPEC_INVALID = NAME_ADDRSPEC_ERR_EMPTY |
2267 NAME_ADDRSPEC_ERR_ATSEQ | NAME_ADDRSPEC_ERR_CHAR |
2268 NAME_ADDRSPEC_ERR_IDNA,
2270 /* Error storage (we must fit in 31-bit) */
2271 _NAME_SHIFTWC = 13,
2272 _NAME_MAXWC = 0x3FFFF,
2273 _NAME_MASKWC = _NAME_MAXWC << _NAME_SHIFTWC
2276 /* In the !_ERR_EMPTY case, the failing character can be queried */
2277 #define NAME_ADDRSPEC_ERR_GETWC(F) \
2278 ((((unsigned int)(F) & _NAME_MASKWC) >> _NAME_SHIFTWC) & _NAME_MAXWC)
2279 #define NAME_ADDRSPEC_ERR_SET(F, E, WC) \
2280 do {\
2281 (F) = ((F) & ~(NAME_ADDRSPEC_INVALID | _NAME_MASKWC)) |\
2282 (E) | (((unsigned int)(WC) & _NAME_MAXWC) << _NAME_SHIFTWC);\
2283 } while (0)
2285 struct name {
2286 struct name *n_flink; /* Forward link in list. */
2287 struct name *n_blink; /* Backward list link */
2288 enum gfield n_type; /* From which list it came */
2289 enum nameflags n_flags; /* enum nameflags */
2290 char *n_name; /* This fella's address */
2291 char *n_fullname; /* Ditto, unless GFULL including comment */
2292 char *n_fullextra; /* GFULL, without address */
2295 struct addrguts {
2296 char const *ag_input; /* Input string as given */
2297 size_t ag_ilen; /* strlen() of input */
2298 size_t ag_iaddr_start; /* Start of *addr-spec* in .ag_input */
2299 size_t ag_iaddr_aend; /* ..and one past its end */
2300 char *ag_skinned; /* Output (alloced if !=.ag_input) */
2301 size_t ag_slen; /* strlen() of .ag_skinned */
2302 size_t ag_sdom_start; /* Start of domain in .ag_skinned, */
2303 enum nameflags ag_n_flags; /* enum nameflags of .ag_skinned */
2306 /* MIME attachments */
2307 enum attach_conv {
2308 AC_DEFAULT, /* _get_lc() -> _iter_*() */
2309 AC_FIX_OUTCS, /* _get_lc() -> "charset=" .a_charset */
2310 AC_FIX_INCS, /* "charset=".a_input_charset (nocnv) */
2311 AC_TMPFILE /* attachment.a_tmpf is converted */
2314 struct attachment {
2315 struct attachment *a_flink; /* Forward link in list. */
2316 struct attachment *a_blink; /* Backward list link */
2317 char const *a_name; /* file name */
2318 char const *a_content_type; /* content type */
2319 char const *a_content_disposition; /* content disposition */
2320 char const *a_content_id; /* content id */
2321 char const *a_content_description; /* content description */
2322 char const *a_input_charset; /* Interpretation depends on .a_conv */
2323 char const *a_charset; /* ... */
2324 FILE *a_tmpf; /* If AC_TMPFILE */
2325 enum attach_conv a_conv; /* User chosen conversion */
2326 int a_msgno; /* message number */
2329 struct sendbundle {
2330 struct header *sb_hp;
2331 struct name *sb_to;
2332 FILE *sb_input;
2333 struct str sb_signer; /* USER@HOST for signing+ */
2334 struct url sb_url;
2335 struct ccred sb_ccred;
2338 /* Structure of the hash table of ignored header fields */
2339 struct ignoretab{
2340 ui32_t it_count;
2341 bool_t it_auto; /* Stored in auto-reclaimed storage? */
2342 ui8_t it__dummy[3];
2343 struct n_ignoretab_field{
2344 struct n_ignoretab_field *itf_next;
2345 char itf_field[n_VFIELD_SIZE(0)]; /* Header field */
2346 } *it_head[5 /* TODO make dynamic hashmap */];
2349 /* For saving the current directory and later returning */
2350 struct cw {
2351 #ifdef HAVE_FCHDIR
2352 int cw_fd;
2353 #else
2354 char cw_wd[PATH_MAX];
2355 #endif
2359 * Global variable declarations
2361 * These become instantiated in main.c.
2364 #undef VL
2365 #ifdef n_MAIN_SOURCE
2366 # ifndef HAVE_AMALGAMATION
2367 # define VL
2368 # else
2369 # define VL static
2370 # endif
2371 #else
2372 # define VL extern
2373 #endif
2375 VL int mb_cur_max; /* Value of MB_CUR_MAX */
2376 VL int realscreenheight; /* The real screen height */
2377 VL int scrnwidth; /* Screen width, or best guess */
2378 VL int scrnheight; /* Screen height/guess (4 header) */
2380 VL char const *myname; /* My login name */
2381 VL char const *progname; /* Our name */
2383 VL gid_t group_id; /* getgid() and getuid() */
2384 VL uid_t user_id;
2386 VL int exit_status; /* Exit status */
2387 VL ui32_t options; /* Bits of enum user_options */
2388 VL char const *option_Mm_arg; /* Argument for -[Mm] aka OPT_[Mm]_FLAG */
2389 VL struct name *option_r_arg; /* Argument to -r option */
2390 VL char const **smopts; /* sendmail(1) opts from commline */
2391 VL size_t smopts_cnt; /* Entries in smopts */
2393 VL ui32_t pstate; /* Bits of enum program_state */
2395 /* XXX stylish sorting */
2396 VL int msgCount; /* Count of messages read in */
2397 VL struct mailbox mb; /* Current mailbox */
2398 VL int image; /* File descriptor for msg image */
2399 VL char mailname[PATH_MAX]; /* Name of current file TODO URL/object*/
2400 VL char displayname[80 - 40]; /* Prettyfied for display TODO URL/obj*/
2401 VL char prevfile[PATH_MAX]; /* Name of previous file TODO URL/obj */
2402 VL char const *account_name; /* Current account name or NULL */
2403 VL off_t mailsize; /* Size of system mailbox */
2404 VL struct message *dot; /* Pointer to current message */
2405 VL struct message *prevdot; /* Previous current message */
2406 VL struct message *message; /* The actual message structure */
2407 VL struct message *threadroot; /* first threaded message */
2408 VL int *n_msgvec; /* Folder setmsize(), list.c res. store*/
2410 VL struct ignoretab ignore[2]; /* ignored and retained fields
2411 * 0 is ignore, 1 is retain */
2412 VL struct ignoretab saveignore[2]; /* ignored and retained fields
2413 * on save to folder */
2414 VL struct ignoretab fwdignore[2]; /* fields to ignore for forwarding */
2415 #define allignore ((struct ignoretab*)-2) /* special, ignore all headers */
2417 VL struct time_current time_current; /* time(3); send: mail1() XXXcarrier */
2418 VL struct termios_state termios_state; /* getpassword(); see commands().. */
2420 #ifdef HAVE_SSL
2421 VL enum ssl_verify_level ssl_verify_level; /* SSL verification level */
2422 #endif
2424 #ifdef HAVE_ICONV
2425 VL iconv_t iconvd;
2426 #endif
2428 VL sigjmp_buf srbuf;
2429 VL volatile int interrupts; /* TODO rid! */
2430 VL sighandler_type dflpipe;
2432 /* TODO Temporary hacks unless the codebase doesn't jump and uses pass-by-value
2433 * TODO carrier structs instead of locals */
2434 VL char *temporary_arg_v_store;
2435 /* TODO temporary storage to overcome which_protocol() mess (for PROTO_FILE) */
2436 VL char const *temporary_protocol_ext;
2438 /* The remaining variables need initialization */
2440 #ifndef HAVE_AMALGAMATION
2441 VL char const month_names[12 + 1][4];
2442 VL char const weekday_names[7 + 1][4];
2444 VL char const uagent[sizeof VAL_UAGENT];
2445 VL char const n_error[sizeof n_ERROR];
2446 VL char const n_unirepl[sizeof n_UNIREPL];
2447 VL char const n_empty[1];
2449 VL ui16_t const class_char[1 + 0x7F];
2450 #endif
2453 * Finally, let's include the function prototypes XXX embed
2456 #ifndef n_PRIVSEP_SOURCE
2457 # include "nailfuns.h"
2458 #endif
2460 /* s-it-mode */