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