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