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 - 2017 Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
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
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
37 * Mail -- a mail program
39 * Author: Kurt Shoens (UCB) March 25, 1978
45 #include <sys/types.h>
47 #ifdef HAVE_GETTIMEOFDAY
48 # include <sys/time.h>
64 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
67 # include <inttypes.h>
85 # include <openssl/md5.h>
89 * Constants, some nail-specific macros
92 #if !defined NI_MAXHOST
93 # define NI_MAXHOST 1025
96 /* TODO PATH_MAX: fixed-size buffer is always wrong (think NFS) */
99 # define PATH_MAX MAXPATHLEN
101 # define PATH_MAX 1024 /* _XOPEN_PATH_MAX POSIX 2008/Cor 1-2013 */
105 #ifndef HOST_NAME_MAX
106 # ifdef _POSIX_HOST_NAME_MAX
107 # define HOST_NAME_MAX _POSIX_HOST_NAME_MAX
109 # define HOST_NAME_MAX 255
114 # ifdef _POSIX_NAME_MAX
115 # define NAME_MAX _POSIX_NAME_MAX
121 # error NAME_MAX too small
125 # define STDIN_FILENO 0
127 #ifndef STDOUT_FILENO
128 # define STDOUT_FILENO 1
130 #ifndef STDERR_FILENO
131 # define STDERR_FILENO 2
136 # define NSIG NSIG_MAX
138 # define NSIG ((sizeof(sigset_t) * 8) - 1)
142 # define _O_CLOEXEC O_CLOEXEC
143 # define _CLOEXEC_SET(FD) do {;} while(0)
145 # define _O_CLOEXEC 0
146 # define _CLOEXEC_SET(FD) \
147 do { (void)fcntl((FD), F_SETFD, FD_CLOEXEC); } while (0)
151 # define n_O_NOFOLLOW O_NOFOLLOW
153 # define n_O_NOFOLLOW 0
158 #if BUFSIZ + 0 > 2560 /* TODO simply use BUFSIZ? */
159 # define LINESIZE BUFSIZ /* max readable line width */
161 # define LINESIZE 2560
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
172 # define NYD_CALLS_MAX (25 * 84)
173 # elif defined HAVE_DEVEL
174 # define NYD_CALLS_MAX (25 * 42)
176 # define NYD_CALLS_MAX (25 * 10)
180 #define APPEND /* New mail goes to end of mailbox */
181 #define CBAD (-15555)
182 #define DOTLOCK_TRIES 5 /* Number of open(2) calls for dotlock */
183 #define FILE_LOCK_TRIES 10 /* Maximum tries before n_file_lock() fails */
184 #define FILE_LOCK_MILLIS 200 /* If UIZ_MAX, fall back to that */
185 #define n_ERROR "ERROR" /* Is-error? Also as n_error[] */
186 #define ERRORS_MAX 1000 /* Maximum error ring entries TODO configable*/
187 #define n_ESCAPE '~' /* Default escape for sending */
188 #define HIST_SIZE 242 /* tty.c: history list default size */
189 #define HSHSIZE 23 /* Hash prime TODO make dynamic, obsolete */
190 #define MAXARGC 1024 /* Maximum list of raw strings */
191 #define MAXEXP 25 /* Maximum expansion of aliases */
192 #define REFERENCES_MAX 20 /* Maximum entries in References: */
193 #define n_UNIREPL "\xEF\xBF\xBD" /* 0xFFFD in UTF-8 */
194 #define FTMP_OPEN_TRIES 10 /* Maximum number of Ftmp() open(2) tries */
196 #define ACCOUNT_NULL "null" /* Name of "null" account */
198 /* Some environment variables for pipe hooks */
199 #define AGENT_USER "NAIL_USER"
200 #define AGENT_USER_ENC "NAIL_USER_ENC"
201 #define AGENT_HOST "NAIL_HOST"
202 #define AGENT_HOST_PORT "NAIL_HOST_PORT"
206 # define n_COLOUR(X) X
211 /* Special FD requests for run_command() / start_command() */
212 #define COMMAND_FD_PASS -1
213 #define COMMAND_FD_NULL -2
216 #define FROM_DATEBUF 64 /* Size of RFC 4155 From_ line date */
217 #define DATE_DAYSYEAR 365L
218 #define DATE_SECSMIN 60L
219 #define DATE_MINSHOUR 60L
220 #define DATE_HOURSDAY 24L
221 #define DATE_SECSHOUR (DATE_SECSMIN * DATE_MINSHOUR)
222 #define DATE_SECSDAY (DATE_SECSHOUR * DATE_HOURSDAY)
224 /* *indentprefix* default as of POSIX */
225 #define INDENT_DEFAULT "\t"
227 /* Auto-reclaimed memory storage: size of the buffers. Maximum auto-reclaimed
228 * storage is that value /2, which is n_CTA()ed to be > 1024 */
229 #define n_MEMORY_AUTOREC_SIZE 0x2000u
230 /* Ugly, but avoid dynamic allocation for the management structure! */
231 #define n_MEMORY_AUTOREC_TYPE_SIZEOF (7 * sizeof(void*))
233 /* Default *encoding* as enum mime_enc below */
234 #define MIME_DEFAULT_ENCODING MIMEE_B64
236 /* Maximum allowed line length in a mail before QP folding is necessary), and
237 * the real limit we go for */
238 #define MIME_LINELEN_MAX 998 /* Plus CRLF */
239 #define MIME_LINELEN_LIMIT (MIME_LINELEN_MAX - 48)
242 #define MIME_LINELEN 78 /* Plus CRLF */
244 /* And in headers which contain an encoded word according to RFC 2047 there is
245 * yet another limit; also RFC 2045: 6.7, (5). */
246 #define MIME_LINELEN_RFC2047 76
248 /* Locations of mime.types(5) */
249 #define MIME_TYPES_USR "~/.mime.types"
250 #define MIME_TYPES_SYS "/etc/mime.types"
252 /* Fallback MIME charsets, if *charset-7bit* and *charset-8bit* or not set.
253 * Note: must be lowercase! Changes affect enum okeys!
254 * (Keep in SYNC: ./nail.1:"Character sets", ./nail.h:CHARSET_*!) */
255 #define CHARSET_7BIT "us-ascii"
257 # define CHARSET_8BIT "utf-8"
258 # define CHARSET_8BIT_OKEY charset_8bit
260 # define CHARSET_8BIT "iso-8859-1"
261 # define CHARSET_8BIT_OKEY ttycharset
264 /* Some environment variables for pipe hooks etc. */
265 #define NAILENV_TMPDIR "NAIL_TMPDIR"
266 #define NAILENV_FILENAME "NAIL_FILENAME"
267 #define NAILENV_FILENAME_GENERATED "NAIL_FILENAME_GENERATED"
268 #define NAILENV_FILENAME_TEMPORARY "NAIL_FILENAME_TEMPORARY"
269 #define NAILENV_CONTENT "NAIL_CONTENT"
270 #define NAILENV_CONTENT_EVIDENCE "NAIL_CONTENT_EVIDENCE"
272 /* Is *W* a quoting (ASCII only) character? */
274 ((W) == n_WC_C('>') || (W) == n_WC_C('|') ||\
275 (W) == n_WC_C('}') || (W) == n_WC_C(':'))
277 /* Maximum number of quote characters (not bytes!) that'll be used on
278 * follow lines when compressing leading quote characters */
281 /* How much spaces should a <tab> count when *quote-fold*ing? (power-of-two!) */
282 #define QUOTE_TAB_SPACES 8
284 /* Smells fishy after, or asks for shell expansion, dependent on context */
285 #define n_SHEXP_MAGIC_PATH_CHARS "|&;<>{}()[]*?$`'\"\\"
287 /* Maximum size of a message that is passed through to the spam system */
288 #define SPAM_MAXSIZE 420000
290 /* Switch indicating necessity of terminal access interface (termcap.c) */
291 #if defined HAVE_TERMCAP || defined HAVE_COLOUR || defined HAVE_MLE
296 * OS, CC support, generic macros etc.
299 #define n_ISPOW2(X) ((((X) - 1) & (X)) == 0)
300 #define n_MIN(A, B) ((A) < (B) ? (A) : (B))
301 #define n_MAX(A, B) ((A) < (B) ? (B) : (A))
302 #define n_ABS(A) ((A) < 0 ? -(A) : (A))
304 /* OS: we're not a library, only set what needs special treatment somewhere */
305 #define n_OS_DRAGONFLY 0
306 #define n_OS_OPENBSD 0
307 #define n_OS_SOLARIS 0
311 # undef n_OS_DRAGONFLY
312 # define n_OS_DRAGONFLY 1
313 #elif defined __OpenBSD__
315 # define n_OS_OPENBSD 1
316 #elif defined __solaris__ || defined __sun
317 # if defined __SVR4 || defined __svr4__
319 # define n_OS_SOLARIS 1
322 # define n_OS_SUNOS 1
328 #define PREREQ_CLANG(X,Y) 0
330 #define PREREQ_GCC(X,Y) 0
332 #define PREREQ_TCC(X,Y) 0
338 # define PREREQ_CLANG(X,Y) \
339 (__clang_major__ + 0 > (X) || \
340 (__clang_major__ + 0 == (X) && __clang_minor__ + 0 >= (Y)))
341 # define __EXTEN __extension__
343 #elif defined __GNUC__
347 # define PREREQ_GCC(X,Y) \
348 (__GNUC__ + 0 > (X) || (__GNUC__ + 0 == (X) && __GNUC_MINOR__ + 0 >= (Y)))
349 # define __EXTEN __extension__
351 #elif defined __TINYC__
360 /* Suppress some technical warnings via #pragma's unless developing.
361 * XXX Wild guesses: clang(1) 1.7 and (OpenBSD) gcc(1) 4.2.1 don't work */
363 # if PREREQ_CLANG(3, 4)
364 # pragma clang diagnostic ignored "-Wassign-enum"
365 # pragma clang diagnostic ignored "-Wdisabled-macro-expansion"
366 # pragma clang diagnostic ignored "-Wformat"
367 # pragma clang diagnostic ignored "-Wunused-result"
368 # elif PREREQ_GCC(4, 7)
369 # pragma GCC diagnostic ignored "-Wunused-local-typedefs"
370 # pragma GCC diagnostic ignored "-Wunused-result"
371 # pragma GCC diagnostic ignored "-Wformat"
375 /* For injection macros like DBG(), n_NATCH_CHAR() */
378 #define EMPTY_FILE() typedef int n_CONCAT(avoid_empty_file__, n_FILE);
380 /* Pointer to size_t */
381 #define PTR2SIZE(X) ((size_t)(uintptr_t)(X))
383 /* Pointer comparison (types from below) */
384 #define PTRCMP(A,C,B) ((uintptr_t)(A) C (uintptr_t)(B))
386 /* Ditto, compare (maybe mixed-signed) integers cases to T bits, unsigned;
387 * Note: doesn't sign-extend correctly, that's still up to the caller */
388 #define UICMP(T,A,C,B) ((ui ## T ## _t)(A) C (ui ## T ## _t)(B))
390 /* Align something to a size/boundary that cannot cause just any problem */
391 #define n_ALIGN(X) (((X) + 2*sizeof(void*)) & ~((2*sizeof(void*)) - 1))
392 #define n_ALIGN_SMALL(X) \
393 (((X) + n_MAX(sizeof(size_t), sizeof(void*))) &\
394 ~(n_MAX(sizeof(size_t), sizeof(void*)) - 1))
396 /* Members in constant array */
397 #define n_NELEM(A) (sizeof(A) / sizeof((A)[0]))
399 /* sizeof() for member fields */
400 #define n_SIZEOF_FIELD(T,F) sizeof(((T *)NULL)->F)
402 /* Casts-away (*NOT* cast-away) */
403 #define n_UNUSED(X) ((void)(X))
404 #define n_UNCONST(P) ((void*)(uintptr_t)(void const*)(P))
405 #define n_UNVOLATILE(P) ((void*)(uintptr_t)(void volatile*)(P))
406 /* To avoid warnings with modern compilers for "char*i; *(si32_t*)i=;" */
407 #define n_UNALIGN(T,P) ((T)(uintptr_t)(P))
408 #define n_UNXXX(T,C,P) ((T)(uintptr_t)(C)(P))
410 /* __STDC_VERSION__ is ISO C99, so also use __STDC__, which should work */
411 #if defined __STDC__ || defined __STDC_VERSION__ /*|| defined __cplusplus*/
412 # define n_STRING(X) #X
413 # define n_XSTRING(X) n_STRING(X)
414 # define n_CONCAT(S1,S2) n__CONCAT_1(S1, S2)
415 # define n__CONCAT_1(S1,S2) S1 ## S2
417 # define n_STRING(X) "X"
418 # define n_XSTRING STRING
419 # define n_CONCAT(S1,S2) S1/* won't work out */S2
422 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
423 # define n_FIELD_INITN(N) CONCAT(., N) =
424 # define n_FIELD_INITI(I) [I] =
426 # define n_FIELD_INITN(N)
427 # define n_FIELD_INITI(N)
430 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
431 # define n_VFIELD_SIZE(X)
432 # define n_VSTRUCT_SIZEOF(T,F) sizeof(T)
434 # define n_VFIELD_SIZE(X) \
435 ((X) == 0 ? sizeof(size_t) \
436 : ((ssize_t)(X) < 0 ? sizeof(size_t) - n_ABS(X) : (size_t)(X)))
437 # define n_VSTRUCT_SIZEOF(T,F) (sizeof(T) - n_SIZEOF_FIELD(T, F))
441 # define SINLINE n_INLINE /* TODO obsolete */
443 # define SINLINE static
447 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
448 # define __FUN__ __func__
449 #elif CC_CLANG || PREREQ_GCC(3, 4)
450 # define __FUN__ __extension__ __FUNCTION__
452 # define __FUN__ uagent /* Something that is not a literal */
455 #if defined __predict_true && defined __predict_false
456 # define n_LIKELY(X) __predict_true(X)
457 # define n_UNLIKELY(X) __predict_false(X)
458 #elif CC_CLANG || PREREQ_GCC(2, 96)
459 # define n_LIKELY(X) __builtin_expect(X, 1)
460 # define n_UNLIKELY(X) __builtin_expect(X, 0)
462 # define n_LIKELY(X) (X)
463 # define n_UNLIKELY(X) (X)
466 #undef HAVE_NATCH_CHAR
467 #if defined HAVE_SETLOCALE && defined HAVE_C90AMEND1 && defined HAVE_WCWIDTH
468 # define HAVE_NATCH_CHAR
469 # define n_NATCH_CHAR(X) X
471 # define n_NATCH_CHAR(X)
474 /* Compile-Time-Assert
475 * Problem is that some compilers warn on unused local typedefs, so add
476 * a special local CTA to overcome this */
477 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 201112L
478 # define n_CTA(T,M) _Static_assert(T, M)
479 # define n_LCTA(T,M) _Static_assert(T, M)
481 # define n_CTA(T,M) n__CTA_1(T, n_FILE, __LINE__)
482 # define n_LCTA(T,M) n__LCTA_1(T, n_FILE, __LINE__)
484 #define n_CTAV(T) n_CTA(T, "Unexpected value of constant")
485 #define n_LCTAV(T) n_LCTA(T, "Unexpected value of constant")
488 # define n_MCTA(T,M) n_CTA(T, M);
493 #define n__CTA_1(T,F,L) n__CTA_2(T, F, L)
494 #define n__CTA_2(T,F,L) \
495 typedef char ASSERTION_failed_in_file_## F ## _at_line_ ## L[(T) ? 1 : -1]
496 #define n__LCTA_1(T,F,L) n__LCTA_2(T, F, L)
497 #define n__LCTA_2(T,F,L) \
499 typedef char ASSERTION_failed_in_file_## F ## _at_line_ ## L[(T) ? 1 : -1];\
500 ASSERTION_failed_in_file_## F ## _at_line_ ## L __i_am_unused__;\
501 n_UNUSED(__i_am_unused__);\
504 #define n_UNINIT(N,V) N = V
506 /* Create a bit mask for the bit range LO..HI -- HI can't use highest bit! */
507 #define n_BITENUM_MASK(LO,HI) (((1u << ((HI) + 1)) - 1) & ~((1u << (LO)) - 1))
513 # define assert(X) n_UNUSED(0)
516 # define DBGOR(X,Y) Y
520 # define DBGOR(X,Y) X
523 /* Translation (init in main.c) */
532 * Types TODO v15: n_XX_t
536 # define UI8_MAX UINT8_MAX
537 # define SI8_MIN INT8_MIN
538 # define SI8_MAX INT8_MAX
539 typedef uint8_t ui8_t
;
540 typedef int8_t si8_t
;
541 #elif UCHAR_MAX != 255
542 # error UCHAR_MAX must be 255
544 # define UI8_MAX UCHAR_MAX
545 # define SI8_MIN CHAR_MIN
546 # define SI8_MAX CHAR_MAX
547 typedef unsigned char ui8_t
;
548 typedef signed char si8_t
;
551 #if !defined PRIu8 || !defined PRId8
559 # define UI16_MAX UINT16_MAX
560 # define SI16_MIN INT16_MIN
561 # define SI16_MAX INT16_MAX
562 typedef uint16_t ui16_t
;
563 typedef int16_t si16_t
;
564 #elif USHRT_MAX != 0xFFFFu
565 # error USHRT_MAX must be 0xFFFF
567 # define UI16_MAX USHRT_MAX
568 # define SI16_MIN SHRT_MIN
569 # define SI16_MAX SHRT_MAX
570 typedef unsigned short ui16_t
;
571 typedef signed short si16_t
;
574 #if !defined PRIu16 || !defined PRId16
577 # if UI16_MAX == UINT_MAX
587 # define UI32_MAX UINT32_MAX
588 # define SI32_MIN INT32_MIN
589 # define SI32_MAX INT32_MAX
590 typedef uint32_t ui32_t
;
591 typedef int32_t si32_t
;
592 #elif ULONG_MAX == 0xFFFFFFFFu
593 # define UI32_MAX ULONG_MAX
594 # define SI32_MIN LONG_MIN
595 # define SI32_MAX LONG_MAX
596 typedef unsigned long int ui32_t
;
597 typedef signed long int si32_t
;
598 #elif UINT_MAX != 0xFFFFFFFFu
599 # error UINT_MAX must be 0xFFFFFFFF
601 # define UI32_MAX UINT_MAX
602 # define SI32_MIN INT_MIN
603 # define SI32_MAX INT_MAX
604 typedef unsigned int ui32_t
;
605 typedef signed int si32_t
;
608 #if !defined PRIu32 || !defined PRId32
611 # if UI32_MAX == ULONG_MAX
621 # define UI64_MAX UINT64_MAX
622 # define SI64_MIN INT64_MIN
623 # define SI64_MAX INT64_MAX
624 typedef uint64_t ui64_t
;
625 typedef int64_t si64_t
;
626 #elif ULONG_MAX <= 0xFFFFFFFFu
627 # if !defined ULLONG_MAX || (ULLONG_MAX >> 31) < 0xFFFFFFFFu
628 # error We need a 64 bit integer
630 # define UI64_MAX ULLONG_MAX
631 # define SI64_MIN LLONG_MIN
632 # define SI64_MAX LLONG_MAX
633 __EXTEN
typedef unsigned long long ui64_t
;
634 __EXTEN
typedef signed long long si64_t
;
637 # define UI64_MAX ULONG_MAX
638 # define SI64_MIN LONG_MIN
639 # define SI64_MAX LONG_MAX
640 typedef unsigned long ui64_t
;
641 typedef signed long si64_t
;
644 #if !defined PRIu64 || !defined PRId64 || !defined PRIX64
648 # if defined ULLONG_MAX && UI64_MAX == ULLONG_MAX
649 # define PRIu64 "llu"
650 # define PRId64 "lld"
651 # define PRIX64 "llX"
659 /* (So that we can use UICMP() for size_t comparison, too) */
660 typedef size_t uiz_t
;
661 typedef ssize_t siz_t
;
665 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
668 # define UIZ_MAX SIZE_MAX
669 #elif defined SIZE_MAX
670 /* UnixWare has size_t as unsigned as required but uses a signed limit
671 * constant (which is thus false!) */
672 # if SIZE_MAX == UI64_MAX || SIZE_MAX == SI64_MAX
673 # define PRIuZ PRIu64
674 # define PRIdZ PRId64
675 n_MCTA(sizeof(size_t) == sizeof(ui64_t
),
676 "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
677 # elif SIZE_MAX == UI32_MAX || SIZE_MAX == SI32_MAX
678 # define PRIuZ PRIu32
679 # define PRIdZ PRId32
680 n_MCTA(sizeof(size_t) == sizeof(ui32_t
),
681 "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
683 # error SIZE_MAX is neither UI64_MAX nor UI32_MAX (please report this)
685 # define UIZ_MAX SIZE_MAX
690 n_MCTA(sizeof(size_t) == sizeof(unsigned long),
691 "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
692 # define UIZ_MAX ULONG_MAX
697 # define uintptr_t size_t
698 # define UINTPTR_MAX SIZE_MAX
700 # define uintptr_t unsigned long
701 # define UINTPTR_MAX ULONG_MAX
705 #if !defined PRIuPTR || !defined PRIXPTR
708 # if UINTPTR_MAX == ULONG_MAX
709 # define PRIuPTR "lu"
710 # define PRIXPTR "lX"
717 #ifdef HAVE_C90AMEND1
718 typedef wchar_t wc_t
;
719 # define n_WC_C(X) L ## X
721 typedef char wc_t
; /* Yep: really 8-bit char */
725 enum {FAL0
, TRU1
, TRUM1
= -1};
726 typedef si8_t bool_t
;
728 /* Add shorter aliases for "normal" integers TODO v15 -> n_XX_t */
729 typedef unsigned long ul_i
;
730 typedef unsigned int ui_i
;
731 typedef unsigned short us_i
;
732 typedef unsigned char uc_i
;
734 typedef signed long sl_i
;
735 typedef signed int si_i
;
736 typedef signed short ss_i
;
737 typedef signed char sc_i
;
739 typedef void ( *sighandler_type
)(int); /* TODO v15 obsolete */
740 typedef void ( *n_sighdl_t
)(int);
743 AUTHTYPE_NONE
= 1<<0,
744 AUTHTYPE_PLAIN
= 1<<1, /* POP3: APOP is covered by this */
745 AUTHTYPE_LOGIN
= 1<<2,
746 AUTHTYPE_CRAM_MD5
= 1<<3,
747 AUTHTYPE_GSSAPI
= 1<<4
750 enum expand_addr_flags
{
751 EAF_NONE
= 0, /* -> EAF_NOFILE | EAF_NOPIPE */
752 EAF_RESTRICT
= 1<<0, /* "restrict" (do unless interaktive / -[~#]) */
753 EAF_FAIL
= 1<<1, /* "fail" */
754 EAF_FAILINVADDR
= 1<<2, /* "failinvaddr" */
755 /* Bits reused by enum expand_addr_check_mode! */
756 EAF_FILE
= 1<<3, /* +"file" targets */
757 EAF_PIPE
= 1<<4, /* +"pipe" command pipe targets */
758 EAF_NAME
= 1<<5, /* +"name"s (non-address) names / MTA aliases */
759 EAF_ADDR
= 1<<6, /* +"addr" network address (contain "@") */
761 EAF_TARGET_MASK
= EAF_FILE
| EAF_PIPE
| EAF_NAME
| EAF_ADDR
,
762 EAF_RESTRICT_TARGETS
= EAF_NAME
| EAF_ADDR
/* (default set if not set) */
765 enum expand_addr_check_mode
{
766 EACM_NONE
= 0, /* Don't care about *expandaddr* */
767 EACM_NORMAL
= 1<<0, /* Use our normal *expandaddr* checking */
768 EACM_STRICT
= 1<<1, /* Never allow any file or pipe addresse */
769 EACM_MODE_MASK
= 0x3, /* _NORMAL and _STRICT are mutual! */
771 EACM_NOLOG
= 1<<2, /* Don't log check errors */
773 /* Some special overwrites of EAF_TARGETs.
774 * May NOT clash with EAF_* bits which may be ORd to these here! */
779 enum n_cmd_arg_desc_flags
{/* TODO incomplete, misses getmsglist() */
781 n_CMD_ARG_DESC_STRING
= 1<<0, /* A !blankspacechar() string */
782 n_CMD_ARG_DESC_WYSH
= 1<<1, /* sh(1)ell-style quoted */
784 n__CMD_ARG_DESC_TYPE_MASK
= n_CMD_ARG_DESC_STRING
| n_CMD_ARG_DESC_WYSH
,
786 /* - Optional flags */
787 /* It is not an error if an optional argument is missing; once an argument
788 * has been declared optional only optional arguments may follow */
789 n_CMD_ARG_DESC_OPTION
= 1<<16,
790 /* GREEDY: parse as many of that type as possible; must be last entry */
791 n_CMD_ARG_DESC_GREEDY
= 1<<17,
792 /* Honour an overall "stop" request in one of the arguments (\c@ or #) */
793 n_CMD_ARG_DESC_HONOUR_STOP
= 1<<18,
795 n__CMD_ARG_DESC_FLAG_MASK
= n_CMD_ARG_DESC_OPTION
| n_CMD_ARG_DESC_GREEDY
|
796 n_CMD_ARG_DESC_HONOUR_STOP
800 /* We do have several contexts of colour IDs; since only one of them can be
801 * active at any given time let's share the value range */
811 n_COLOUR_ID_SUM_DOTMARK
= 0,
812 n_COLOUR_ID_SUM_HEADER
,
813 n_COLOUR_ID_SUM_THREAD
,
815 /* Message display */
816 n_COLOUR_ID_VIEW_FROM_
= 0,
817 n_COLOUR_ID_VIEW_HEADER
,
818 n_COLOUR_ID_VIEW_MSGINFO
,
819 n_COLOUR_ID_VIEW_PARTINFO
,
821 /* Mailx-Line-Editor */
822 n_COLOUR_ID_MLE_POSITION
= 0,
823 n_COLOUR_ID_MLE_PROMPT
,
825 n__COLOUR_IDS
= n_COLOUR_ID_VIEW_PARTINFO
+ 1
828 /* Colour preconditions, let's call them tags, cannot be an enum because for
829 * message display they are the actual header name of the current header. Thus
830 * let's use constants of pseudo pointers */
831 # define n_COLOUR_TAG_SUM_DOT ((char*)-2)
832 # define n_COLOUR_TAG_SUM_OLDER ((char*)-3)
833 #endif /* HAVE_COLOUR */
836 CONV_NONE
, /* no conversion */
837 CONV_7BIT
, /* no conversion, is 7bit */
838 CONV_FROMQP
, /* convert from quoted-printable */
839 CONV_TOQP
, /* convert to quoted-printable */
840 CONV_8BIT
, /* convert to 8bit (iconv) */
841 CONV_FROMB64
, /* convert from base64 */
842 CONV_FROMB64_T
, /* convert from base64/text */
843 CONV_TOB64
, /* convert to base64 */
844 CONV_FROMHDR
, /* convert from RFC1522 format */
845 CONV_TOHDR
, /* convert to RFC1522 format */
846 CONV_TOHDR_A
/* convert addresses for header */
850 CPROTO_CCRED
, /* Special dummy credential proto (S/MIME etc.) */
855 enum n_dotlock_state
{
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 */
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 */
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! */
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
{
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_UNIREPL
= 1<<2, /* Use Unicode replacement 0xFFFD = EF BF BD */
909 n_ICONV_DEFAULT
= n_ICONV_IGN_ILSEQ
| n_ICONV_IGN_NOREVERSE
,
910 n_ICONV_UNIDEFAULT
= n_ICONV_DEFAULT
| n_ICONV_UNIREPL
913 /* Special ignore (where _TYPE is covered by POSIX `ignore' / `retain').
914 * _ALL is very special in that it doesn't have a backing object */
915 #define n_IGNORE_ALL ((struct n_ignore*)-2)
916 #define n_IGNORE_TYPE ((struct n_ignore*)-3)
917 #define n_IGNORE_SAVE ((struct n_ignore*)-4)
918 #define n_IGNORE_FWD ((struct n_ignore*)-5)
919 #define n_IGNORE_TOP ((struct n_ignore*)-6)
920 #define n__IGNORE_ADJUST 3
921 #define n__IGNORE_MAX (6 - n__IGNORE_ADJUST)
923 enum n_lexinput_flags
{
925 n_LEXINPUT_CTX_BASE
= 0, /* Generic shared base: don't use! */
926 n_LEXINPUT_CTX_DEFAULT
= 1, /* Default input */
927 n_LEXINPUT_CTX_COMPOSE
= 2, /* Compose mode input */
928 n__LEXINPUT_CTX_MASK
= 3,
929 n__LEXINPUT_CTX_MAX1
= n_LEXINPUT_CTX_COMPOSE
+ 1,
931 n_LEXINPUT_FORCE_STDIN
= 1<<8, /* Even in macro, use stdin (`read')! */
932 n_LEXINPUT_NL_ESC
= 1<<9, /* Support "\\$" line continuation */
933 n_LEXINPUT_NL_FOLLOW
= 1<<10, /* ..on such a follow line */
934 n_LEXINPUT_PROMPT_NONE
= 1<<11, /* Don't print prompt */
935 n_LEXINPUT_PROMPT_EVAL
= 1<<12, /* Instead, evaluate *prompt* */
937 n_LEXINPUT_DROP_TRAIL_SPC
= 1<<14, /* Drop any trailing space */
938 n_LEXINPUT_DROP_LEAD_SPC
= 1<<15, /* ..leading ones */
939 n_LEXINPUT_TRIM_SPACE
= n_LEXINPUT_DROP_TRAIL_SPC
| n_LEXINPUT_DROP_LEAD_SPC
,
942 n_LEXINPUT_HIST_ADD
= 1<<16, /* Add the result to history list */
943 n_LEXINPUT_HIST_GABBY
= 1<<17 /* Consider history entry as gabby */
947 MIME_UNKNOWN
, /* unknown content */
948 MIME_SUBHDR
, /* inside a multipart subheader */
949 MIME_822
, /* message/rfc822 content */
950 MIME_MESSAGE
, /* other message/ content */
951 MIME_TEXT_PLAIN
, /* text/plain content */
952 MIME_TEXT_HTML
, /* text/html content */
953 MIME_TEXT
, /* other text/ content */
954 MIME_ALTERNATIVE
, /* multipart/alternative content */
955 MIME_RELATED
, /* mime/related (RFC 2387) */
956 MIME_DIGEST
, /* multipart/digest content */
957 MIME_SIGNED
, /* multipart/signed */
958 MIME_ENCRYPTED
, /* multipart/encrypted */
959 MIME_MULTI
, /* other multipart/ content */
960 MIME_PKCS7
, /* PKCS7 content */
961 MIME_DISCARD
/* content is discarded */
964 enum mime_counter_evidence
{
966 MIMECE_SET
= 1<<0, /* *mime-counter-evidence* was set */
967 MIMECE_BIN_OVWR
= 1<<1, /* appli../octet-stream: check, ovw if possible */
968 MIMECE_ALL_OVWR
= 1<<2, /* all: check, ovw if possible */
969 MIMECE_BIN_PARSE
= 1<<3 /* appli../octet-stream: classify contents last */
972 /* Content-Transfer-Encodings as defined in RFC 2045:
973 * - Quoted-Printable, section 6.7
974 * - Base64, section 6.8 */
975 #define QP_LINESIZE (4 * 19) /* Max. compliant QP linesize */
977 #define B64_LINESIZE (4 * 19) /* Max. compliant Base64 linesize */
978 #define B64_ENCODE_INPUT_PER_LINE 57 /* Max. input for Base64 encode/line */
981 MIMEE_NONE
, /* message is not in MIME format */
982 MIMEE_BIN
, /* message is in binary encoding */
983 MIMEE_8B
, /* message is in 8bit encoding */
984 MIMEE_7B
, /* message is in 7bit encoding */
985 MIMEE_QP
, /* message is quoted-printable */
986 MIMEE_B64
/* message is in base64 encoding */
989 /* xxx QP came later, maybe rewrite all to use mime_enc_flags directly? */
990 enum mime_enc_flags
{
992 MIMEEF_SALLOC
= 1<<0, /* Use salloc(), not srealloc().. */
993 /* ..result .s,.l point to user buffer of *_LINESIZE+[+[+]] bytes instead */
995 MIMEEF_CRLF
= 1<<2, /* (encode) Append "\r\n" to lines */
996 MIMEEF_LF
= 1<<3, /* (encode) Append "\n" to lines */
997 /* (encode) If one of _CRLF/_LF is set, honour *_LINESIZE+[+[+]] and
998 * inject the desired line-ending whenever a linewrap is desired */
999 MIMEEF_MULTILINE
= 1<<4,
1000 /* (encode) Quote with header rules, do not generate soft NL breaks?
1001 * For mustquote(), specifies whether special RFC 2047 header rules
1002 * should be used instead */
1003 MIMEEF_ISHEAD
= 1<<5,
1004 /* (encode) Ditto; for mustquote() this furtherly fine-tunes behaviour in
1005 * that characters which would not be reported as "must-quote" when
1006 * detecting whether quoting is necessary at all will be reported as
1007 * "must-quote" if they have to be encoded in an encoded word */
1008 MIMEEF_ISENCWORD
= 1<<6,
1013 QP_NONE
= MIMEEF_NONE
,
1014 QP_SALLOC
= MIMEEF_SALLOC
,
1015 QP_BUF
= MIMEEF_BUF
,
1016 QP_ISHEAD
= MIMEEF_ISHEAD
,
1017 QP_ISENCWORD
= MIMEEF_ISENCWORD
1021 B64_NONE
= MIMEEF_NONE
,
1022 B64_SALLOC
= MIMEEF_SALLOC
,
1023 B64_BUF
= MIMEEF_BUF
,
1024 B64_CRLF
= MIMEEF_CRLF
,
1026 B64_MULTILINE
= MIMEEF_MULTILINE
,
1027 /* Not used, but for clarity only */
1028 B64_ISHEAD
= MIMEEF_ISHEAD
,
1029 B64_ISENCWORD
= MIMEEF_ISENCWORD
,
1030 /* Special version of Base64, "Base64URL", according to RFC 4648.
1031 * Only supported for encoding! */
1032 B64_RFC4648URL
= 1<<(__MIMEEF_LAST
+1),
1033 /* Don't use any ("=") padding;
1034 * may NOT be used with any of _CRLF, _LF or _MULTILINE */
1035 B64_NOPAD
= 1<<(__MIMEEF_LAST
+2)
1038 enum mime_parse_flags
{
1039 MIME_PARSE_NONE
= 0,
1040 MIME_PARSE_DECRYPT
= 1<<0,
1041 MIME_PARSE_PARTS
= 1<<1,
1042 MIME_PARSE_SHALLOW
= 1<<2
1045 enum mime_handler_flags
{
1046 MIME_HDL_NULL
, /* No pipe- mimetype handler, go away */
1047 MIME_HDL_CMD
, /* Normal command */
1048 MIME_HDL_TEXT
, /* @ special cmd to force treatment as text */
1049 MIME_HDL_PTF
, /* A special pointer-to-function handler */
1050 MIME_HDL_MSG
, /* Display msg (returned as command string) */
1051 MIME_HDL_TYPE_MASK
= 7,
1052 MIME_HDL_ISQUOTE
= 1<<4, /* Is quote action (we have info, keep it!) */
1053 MIME_HDL_NOQUOTE
= 1<<5, /* No MIME for quoting */
1054 MIME_HDL_ALWAYS
= 1<<6, /* Handler shall run for multi-msg actions */
1055 MIME_HDL_ASYNC
= 1<<7, /* Should run asynchronously */
1056 MIME_HDL_NEEDSTERM
= 1<<8, /* Takes over terminal */
1057 MIME_HDL_TMPF
= 1<<9, /* Create temporary file (zero-sized) */
1058 MIME_HDL_TMPF_FILL
= 1<<10, /* Fill in the msg body content */
1059 MIME_HDL_TMPF_UNLINK
= 1<<11 /* Delete it later again */
1063 MLIST_OTHER
= 0, /* Normal address */
1064 MLIST_KNOWN
= 1, /* A known `mlist' */
1065 MLIST_SUBSCRIBED
= -1 /* A `mlsubscribe'd list */
1076 OF_CLOEXEC
= 1<<7, /* TODO not used, always implied! CHANGE!! */
1077 OF_UNLINK
= 1<<8, /* Only for Ftmp(): unlink(2) after creation */
1078 OF_HOLDSIGS
= 1<<9, /* Mutual with OF_UNLINK - await Ftmp_free() */
1079 OF_REGISTER
= 1<<10, /* Register file in our file table */
1080 OF_REGISTER_UNLINK
= 1<<11, /* unlink(2) upon unreg.; _REGISTER asserted! */
1081 OF_SUFFIX
= 1<<12 /* Ftmp() name hint is mandatory! extension! */
1089 enum okey_xlook_mode
{
1090 OXM_PLAIN
= 1<<0, /* Plain key always tested */
1091 OXM_H_P
= 1<<1, /* Check PLAIN-.url_h_p */
1092 OXM_U_H_P
= 1<<2, /* Check PLAIN-.url_u_h_p */
1096 /* <0 means "stop" unless *prompt* extensions are enabled. */
1098 PROMPT_STOP
= -1, /* \c */
1099 /* *prompt* extensions: \$, \@ etc. */
1105 PROTO_FILE
, /* refers to a local file */
1106 PROTO_POP3
, /* is a pop3 server string */
1107 PROTO_MAILDIR
, /* refers to a maildir folder */
1108 PROTO_UNKNOWN
/* unknown protocol */
1112 SEND_MBOX
, /* no conversion to perform */
1113 SEND_RFC822
, /* no conversion, no From_ line */
1114 SEND_TODISP
, /* convert to displayable form */
1115 SEND_TODISP_ALL
, /* same, include all MIME parts */
1116 SEND_SHOW
, /* convert to 'show' command form */
1117 SEND_TOSRCH
, /* convert for IMAP SEARCH */
1118 SEND_TOFILE
, /* convert for saving body to a file */
1119 SEND_TOPIPE
, /* convert for pipe-content/subc. */
1120 SEND_QUOTE
, /* convert for quoting */
1121 SEND_QUOTE_ALL
, /* same, include all MIME parts */
1122 SEND_DECRYPT
/* decrypt */
1125 enum n_shexp_parse_flags
{
1127 /* Don't perform any expansions or interpret backslash escape sequences etc.
1128 * Output may be NULL, otherwise the possibly trimmed non-expanded input is
1130 n_SHEXP_PARSE_DRYRUN
= 1<<0,
1131 n_SHEXP_PARSE_TRUNC
= 1<<1, /* Truncate result storage on entry */
1132 n_SHEXP_PARSE_TRIMSPACE
= 1<<2, /* Ignore space surrounding tokens */
1133 n_SHEXP_PARSE_LOG
= 1<<3, /* Log errors */
1134 n_SHEXP_PARSE_LOG_D_V
= 1<<4, /* Log errors if OPT_D_V */
1135 n_SHEXP_PARSE_IFS_ADD_COMMA
= 1<<5, /* Add comma , to normal "IFS" */
1136 n_SHEXP_PARSE_IFS_IS_COMMA
= 1<<6, /* Let comma , be the sole "IFS" */
1137 n_SHEXP_PARSE_IGNORE_EMPTY
= 1<<7, /* Ignore empty tokens, start over */
1138 /* Implicitly open quotes, and ditto closing. _AUTO_FIXED may only be used
1139 * if an auto-quote-mode is enabled, implies _AUTO_CLOSE and causes the
1140 * quote mode to be permanently active (cannot be closed) */
1141 n_SHEXP_PARSE_QUOTE_AUTO_FIXED
= 1<<8,
1142 n_SHEXP_PARSE_QUOTE_AUTO_SQ
= 1<<9,
1143 n_SHEXP_PARSE_QUOTE_AUTO_DQ
= 1<<10,
1144 n_SHEXP_PARSE_QUOTE_AUTO_DSQ
= 1<<11,
1145 n_SHEXP_PARSE_QUOTE_AUTO_CLOSE
= 1<<12, /* Ignore an open quote at EOS */
1146 n__SHEXP_PARSE_QUOTE_AUTO_MASK
= n_SHEXP_PARSE_QUOTE_AUTO_SQ
|
1147 n_SHEXP_PARSE_QUOTE_AUTO_DQ
| n_SHEXP_PARSE_QUOTE_AUTO_DSQ
,
1149 n__SHEXP_PARSE_LAST
= 12
1154 /* We have produced some output (or would have, with _PARSE_DRYRUN).
1155 * Note that empty quotes like '' produce no output but set this bit */
1156 n_SHEXP_STATE_OUTPUT
= 1<<2,
1157 /* Don't call the parser again (\c0 or # comment seen; out of input).
1158 * Not (necessarily) mutual with _OUTPUT) */
1159 n_SHEXP_STATE_STOP
= 1<<1,
1160 n_SHEXP_STATE_UNICODE
= 1<<3, /* \[Uu] used */
1161 n_SHEXP_STATE_CONTROL
= 1<<4, /* Control characters seen */
1163 n_SHEXP_STATE_ERR_CONTROL
= 1<<16, /* \c notation with invalid argument */
1164 n_SHEXP_STATE_ERR_UNICODE
= 1<<17, /* Valid \[Uu] used and !OPT_UNICODE */
1165 n_SHEXP_STATE_ERR_NUMBER
= 1<<18, /* Bad number (\[UuXx]) */
1166 n_SHEXP_STATE_ERR_BRACE
= 1<<19, /* _QUOTEOPEN + no } brace for ${VAR */
1167 n_SHEXP_STATE_ERR_BADSUB
= 1<<20, /* Empty/bad ${} substitution */
1168 n_SHEXP_STATE_ERR_QUOTEOPEN
= 1<<21, /* Quote remains open at EOS */
1170 n_SHEXP_STATE_ERR_MASK
= n_BITENUM_MASK(16, 21)
1173 enum n_sigman_flags
{
1175 n_SIGMAN_HUP
= 1<<0,
1176 n_SIGMAN_INT
= 1<<1,
1177 n_SIGMAN_QUIT
= 1<<2,
1178 n_SIGMAN_TERM
= 1<<3,
1179 n_SIGMAN_PIPE
= 1<<4,
1181 n_SIGMAN_IGN_HUP
= 1<<5,
1182 n_SIGMAN_IGN_INT
= 1<<6,
1183 n_SIGMAN_IGN_QUIT
= 1<<7,
1184 n_SIGMAN_IGN_TERM
= 1<<8,
1186 n_SIGMAN_ALL
= 0xFF,
1187 /* Mostly for _leave() reraise flags */
1188 n_SIGMAN_VIPSIGS
= n_SIGMAN_HUP
| n_SIGMAN_INT
| n_SIGMAN_QUIT
|
1190 n_SIGMAN_NTTYOUT_PIPE
= 1<<16,
1191 n_SIGMAN_VIPSIGS_NTTYOUT
= n_SIGMAN_HUP
| n_SIGMAN_INT
| n_SIGMAN_QUIT
|
1192 n_SIGMAN_TERM
| n_SIGMAN_NTTYOUT_PIPE
,
1194 n__SIGMAN_PING
= 1<<17
1198 enum ssl_verify_level
{
1207 TD_NONE
, /* no display conversion */
1208 TD_ISPR
= 1<<0, /* use isprint() checks */
1209 TD_ICONV
= 1<<1, /* use iconv() */
1210 TD_DELCTRL
= 1<<2, /* delete control characters */
1213 * NOTE: _TD_EOF and _TD_BUFCOPY may be ORd with enum conversion and
1214 * enum sendaction, and may thus NOT clash with their bit range!
1216 _TD_EOF
= 1<<14, /* EOF seen, last round! */
1217 _TD_BUFCOPY
= 1<<15 /* Buffer may be constant, copy it */
1221 enum n_termcap_captype
{
1222 n_TERMCAP_CAPTYPE_NONE
= 0,
1223 /* Internally we share the bitspace, so ensure no value ends up as 0 */
1224 n_TERMCAP_CAPTYPE_BOOL
= 1,
1225 n_TERMCAP_CAPTYPE_NUMERIC
,
1226 n_TERMCAP_CAPTYPE_STRING
,
1227 n__TERMCAP_CAPTYPE_MAX1
1230 /* Termcap commands; different to queries commands perform actions.
1231 * Commands are resolved upon init time, and are all termcap(5)-compatible,
1232 * therefore we use the short termcap(5) names.
1233 * Note this is parsed by mk-tcap-map.pl, which expects the syntax
1234 * "CONSTANT, COMMENT" where COMMENT is "Capname/TCap-Code, TYPE[, FLAGS]",
1235 * and one of Capname and TCap-Code may be the string "-" meaning ENOENT;
1236 * a | vertical bar or end-of-comment ends processing; see termcap.c.
1237 * We may use the free-form part after | for the "Variable String" and notes on
1238 * necessary termcap_cmd() arguments; if those are in [] brackets they are not
1239 * regular but are only used when the command, i.e., its effect, is somehow
1240 * simulated / faked by a builtin fallback implementation.
1241 * Availability of builtin fallback indicated by leading @ (at-sign) */
1243 # ifdef HAVE_TERMCAP
1244 n_TERMCAP_CMD_te
, /* rmcup/te, STRING | exit_ca_mode: -,- */
1245 n_TERMCAP_CMD_ti
, /* smcup/ti, STRING | enter_ca_mode: -,- */
1247 n_TERMCAP_CMD_ks
, /* smkx/ks, STRING | keypad_xmit: -,- */
1248 n_TERMCAP_CMD_ke
, /* rmkx/ke, STRING | keypad_local: -,- */
1250 n_TERMCAP_CMD_cd
, /* ed/cd, STRING | clr_eos: -,- */
1251 n_TERMCAP_CMD_cl
, /* clear/cl, STRING | clear_screen(+home): -,- */
1252 n_TERMCAP_CMD_ho
, /* home/ho, STRING | cursor_home: -,- */
1256 n_TERMCAP_CMD_ce
, /* el/ce, STRING | @ clr_eol: [start-column],- */
1257 n_TERMCAP_CMD_ch
, /* hpa/ch, STRING, IDX1 | column_address: column,- */
1258 n_TERMCAP_CMD_cr
, /* cr/cr, STRING | @ carriage_return: -,- */
1259 n_TERMCAP_CMD_le
, /* cub1/le, STRING, CNT | @ cursor_left: count,- */
1260 n_TERMCAP_CMD_nd
, /* cuf1/nd, STRING, CNT | @ cursor_right: count,- */
1263 n__TERMCAP_CMD_MAX1
,
1264 n__TERMCAP_CMD_MASK
= (1<<24) - 1,
1266 /* Only perform command if ca-mode is used */
1267 n_TERMCAP_CMD_FLAG_CA_MODE
= 1<<29,
1268 /* I/O should be flushed after command completed */
1269 n_TERMCAP_CMD_FLAG_FLUSH
= 1<<30
1272 /* Termcap queries; a query is a command that returns a struct n_termcap_value.
1273 * Queries are resolved once they are used first, and may not be termcap(5)-
1274 * compatible, therefore we use terminfo(5) names.
1275 * Note this is parsed by mk-tcap-map.pl, which expects the syntax
1276 * "CONSTANT, COMMENT" where COMMENT is "Capname/TCap-Code, TYPE[, FLAGS]",
1277 * and one of Capname and TCap-Code may be the string "-" meaning ENOENT;
1278 * a | vertical bar or end-of-comment ends processing; see termcap.c.
1279 * We may use the free-form part after | for the "Variable String" and notes.
1280 * The "xkey | X:" keys are Dickey's xterm extensions, see (our) manual */
1281 enum n_termcap_query
{
1283 n_TERMCAP_QUERY_colors
, /* colors/Co, NUMERIC | max_colors */
1286 /* --mk-tcap-map--: only KEY_BINDINGS follow. DON'T CHANGE THIS LINE! */
1287 /* Update the `bind' manual on change! */
1288 # ifdef HAVE_KEY_BINDINGS
1289 n_TERMCAP_QUERY_key_backspace
, /* kbs/kb, STRING */
1290 n_TERMCAP_QUERY_key_dc
, /* kdch1/kD, STRING | delete-character */
1291 n_TERMCAP_QUERY_key_sdc
, /* kDC / *4, STRING | ..shifted */
1292 n_TERMCAP_QUERY_key_eol
, /* kel/kE, STRING | clear-to-end-of-line */
1293 n_TERMCAP_QUERY_key_exit
, /* kext/@9, STRING */
1294 n_TERMCAP_QUERY_key_ic
, /* kich1/kI, STRING | insert character */
1295 n_TERMCAP_QUERY_key_sic
, /* kIC/#3, STRING | ..shifted */
1296 n_TERMCAP_QUERY_key_home
, /* khome/kh, STRING */
1297 n_TERMCAP_QUERY_key_shome
, /* kHOM/#2, STRING | ..shifted */
1298 n_TERMCAP_QUERY_key_end
, /* kend/@7, STRING */
1299 n_TERMCAP_QUERY_key_send
, /* kEND / *7, STRING | ..shifted */
1300 n_TERMCAP_QUERY_key_npage
, /* knp/kN, STRING */
1301 n_TERMCAP_QUERY_key_ppage
, /* kpp/kP, STRING */
1302 n_TERMCAP_QUERY_key_left
, /* kcub1/kl, STRING */
1303 n_TERMCAP_QUERY_key_sleft
, /* kLFT/#4, STRING | ..shifted */
1304 n_TERMCAP_QUERY_xkey_aleft
, /* kLFT3/-, STRING | X: Alt+left */
1305 n_TERMCAP_QUERY_xkey_cleft
, /* kLFT5/-, STRING | X: Control+left */
1306 n_TERMCAP_QUERY_key_right
, /* kcuf1/kr, STRING */
1307 n_TERMCAP_QUERY_key_sright
, /* kRIT/%i, STRING | ..shifted */
1308 n_TERMCAP_QUERY_xkey_aright
, /* kRIT3/-, STRING | X: Alt+right */
1309 n_TERMCAP_QUERY_xkey_cright
, /* kRIT5/-, STRING | X: Control+right */
1310 n_TERMCAP_QUERY_key_down
, /* kcud1/kd, STRING */
1311 n_TERMCAP_QUERY_xkey_sdown
, /* kDN/-, STRING | ..shifted */
1312 n_TERMCAP_QUERY_xkey_adown
, /* kDN3/-, STRING | X: Alt+down */
1313 n_TERMCAP_QUERY_xkey_cdown
, /* kDN5/-, STRING | X: Control+down */
1314 n_TERMCAP_QUERY_key_up
, /* kcuu1/ku, STRING */
1315 n_TERMCAP_QUERY_xkey_sup
, /* kUP/-, STRING | ..shifted */
1316 n_TERMCAP_QUERY_xkey_aup
, /* kUP3/-, STRING | X: Alt+up */
1317 n_TERMCAP_QUERY_xkey_cup
, /* kUP5/-, STRING | X: Control+up */
1318 n_TERMCAP_QUERY_kf0
, /* kf0/k0, STRING */
1319 n_TERMCAP_QUERY_kf1
, /* kf1/k1, STRING */
1320 n_TERMCAP_QUERY_kf2
, /* kf2/k2, STRING */
1321 n_TERMCAP_QUERY_kf3
, /* kf3/k3, STRING */
1322 n_TERMCAP_QUERY_kf4
, /* kf4/k4, STRING */
1323 n_TERMCAP_QUERY_kf5
, /* kf5/k5, STRING */
1324 n_TERMCAP_QUERY_kf6
, /* kf6/k6, STRING */
1325 n_TERMCAP_QUERY_kf7
, /* kf7/k7, STRING */
1326 n_TERMCAP_QUERY_kf8
, /* kf8/k8, STRING */
1327 n_TERMCAP_QUERY_kf9
, /* kf9/k9, STRING */
1328 n_TERMCAP_QUERY_kf10
, /* kf10/k;, STRING */
1329 n_TERMCAP_QUERY_kf11
, /* kf11/F1, STRING */
1330 n_TERMCAP_QUERY_kf12
, /* kf12/F2, STRING */
1331 n_TERMCAP_QUERY_kf13
, /* kf13/F3, STRING */
1332 n_TERMCAP_QUERY_kf14
, /* kf14/F4, STRING */
1333 n_TERMCAP_QUERY_kf15
, /* kf15/F5, STRING */
1334 n_TERMCAP_QUERY_kf16
, /* kf16/F6, STRING */
1335 n_TERMCAP_QUERY_kf17
, /* kf17/F7, STRING */
1336 n_TERMCAP_QUERY_kf18
, /* kf18/F8, STRING */
1337 n_TERMCAP_QUERY_kf19
, /* kf19/F9, STRING */
1338 # endif /* HAVE_KEY_BINDINGS */
1340 n__TERMCAP_QUERY_MAX1
1342 #endif /* n_HAVE_TCAP */
1344 enum n_visual_info_flags
{
1346 n_VISUAL_INFO_ONE_CHAR
= 1<<0, /* Step only one char, then return */
1347 n_VISUAL_INFO_SKIP_ERRORS
= 1<<1, /* Treat via replacement, step byte */
1348 n_VISUAL_INFO_WIDTH_QUERY
= 1<<2, /* Detect visual character widths */
1350 /* Rest only with HAVE_C90AMEND1, mutual with _ONE_CHAR */
1351 n_VISUAL_INFO_WOUT_CREATE
= 1<<8, /* Use/create .vic_woudat */
1352 n_VISUAL_INFO_WOUT_SALLOC
= 1<<9, /* ..salloc() it first */
1353 /* Only visuals into .vic_woudat - implies _WIDTH_QUERY */
1354 n_VISUAL_INFO_WOUT_PRINTABLE
= 1<<10,
1355 n__VISUAL_INFO_FLAGS
= n_VISUAL_INFO_WOUT_CREATE
|
1356 n_VISUAL_INFO_WOUT_SALLOC
| n_VISUAL_INFO_WOUT_PRINTABLE
1361 OPT_DEBUG
= 1u<< 0, /* -d / *debug* */
1362 OPT_VERB
= 1u<< 1, /* -v / *verbose* */
1363 OPT_VERBVERB
= 1u<< 2, /* .. even more verbosity */
1364 OPT_EXISTONLY
= 1u<< 3, /* -e */
1365 OPT_HEADERSONLY
= 1u<<4, /* -H */
1366 OPT_HEADERLIST
= 1u<< 5, /* -L */
1367 OPT_QUICKRUN_MASK
= OPT_EXISTONLY
| OPT_HEADERSONLY
| OPT_HEADERLIST
,
1368 OPT_E_FLAG
= 1u<< 7, /* -E / *skipemptybody* */
1369 OPT_F_FLAG
= 1u<< 8, /* -F */
1370 OPT_Mm_FLAG
= 1u<< 9, /* -M or -m (plus option_Mm_arg) */
1371 OPT_N_FLAG
= 1u<<10, /* -N / *header* */
1372 OPT_R_FLAG
= 1u<<11, /* -R */
1373 OPT_r_FLAG
= 1u<<12, /* -r (plus option_r_arg) */
1374 OPT_t_FLAG
= 1u<<13, /* -t */
1375 OPT_TILDE_FLAG
= 1u<<14, /* -~ */
1376 OPT_BATCH_FLAG
= 1u<<15, /* -# */
1379 OPT_MEMDEBUG
= 1<<16, /* *memdebug* */
1382 OPT_SENDMODE
= 1u<<17, /* Usage case forces send mode */
1384 OPT_TTYOUT
= 1u<<19,
1385 OPT_INTERACTIVE
= 1u<<20,
1386 OPT_UNICODE
= 1u<<21, /* We're in an UTF-8 environment */
1388 OPT_ENC_MBSTATE
= 1u<<22, /* Multibyte environment with shift states */
1390 /* Some easy-access shortcuts */
1391 OPT_D_V
= OPT_DEBUG
| OPT_VERB
,
1392 OPT_D_VV
= OPT_DEBUG
| OPT_VERBVERB
,
1393 OPT_D_V_VV
= OPT_DEBUG
| OPT_VERB
| OPT_VERBVERB
1396 #define OBSOLETE(X) \
1398 if (options & OPT_D_V_VV)\
1399 n_err("%s: %s\n", _("Obsoletion warning"), X);\
1401 #define OBSOLETE2(X,Y) \
1403 if (options & OPT_D_V_VV)\
1404 n_err("%s: %s: %s\n", _("Obsoletion warning"), X, Y);\
1407 enum program_state
{
1409 PS_STARTED
= 1u<< 0, /* main.c startup code passed, functional */
1410 PS_ROOT
= 1u<<30, /* Temporary "bypass any checks" bit */
1412 PS_EXIT
= 1u<< 1, /* Exit request pending */
1413 PS_SOURCING
= 1u<< 2, /* During load() or `source' */
1414 PS_COMPOSE_MODE
= 1u<< 3, /* State machine recursed */
1415 PS_COMPOSE_FORKHOOK
= 1u<<4, /* *on-compose-done* running (fork(2)ed!) */
1416 PS_ROBOT
= 1u<< 5, /* State machine in non-interactive state */
1418 PS_EVAL_ERROR
= 1u<< 6, /* Last evaluate() command failed */
1420 PS_HOOK_NEWMAIL
= 1u<< 7,
1422 PS_HOOK_MASK
= PS_HOOK_NEWMAIL
| PS_HOOK
,
1424 PS_EDIT
= 1u<< 9, /* Current mailbox not a "system mailbox" */
1425 PS_SETFILE_OPENED
= 1u<<10, /* (hack) setfile() opened a new box */
1426 PS_SAW_COMMAND
= 1u<<11, /* ..after mailbox switch */
1428 PS_DID_PRINT_DOT
= 1u<<12, /* Current message has been printed */
1430 PS_SIGWINCH_PEND
= 1u<<14, /* Need update of $COLUMNS/$LINES */
1431 PS_PSTATE_PENDMASK
= PS_SIGWINCH_PEND
, /* pstate housekeeping needed */
1433 PS_ARGLIST_MASK
= n_BITENUM_MASK(17, 18),
1434 PS_MSGLIST_GABBY
= 1u<<17, /* getmsglist() saw what it thinks: gabby */
1435 PS_MSGLIST_DIRECT
= 1u<<18, /* One msg was directly chosen by number */
1436 /* TODO HACK: until v15 PS_MSGLIST_SAW_NO is an indication whether an entry
1437 * TODO may be placed in the history or not (grep this, see commands()),
1438 * TODO so avoid reusing this bit */
1439 PS_WYSHLIST_SAW_CONTROL
= 1u<<18, /* ..saw C0+ control characters */
1441 PS_EXPAND_MULTIRESULT
= 1u<<19, /* Last fexpand() with MULTIOK had .. */
1443 PS_HEADER_NEEDED_MIME
= 1u<<20, /* mime_write_tohdr() needed x TODO HACK! */
1445 PS_READLINE_NL
= 1u<<21, /* readline_input()+ saw a \n TODO HACK! */
1447 PS_COLOUR_ACTIVE
= 1u<<22, /* n_colour_env_create().._gut() cycle */
1449 PS_ERRORS_PROMPT
= 1u<<24, /* New error is to be reported in prompt */
1450 /* Various first-time-init switches */
1451 PS_ERRORS_NOTED
= 1u<<25, /* Ring of `errors' advisory */
1452 PS_t_FLAG
= 1u<<26, /* OPT_t_FLAG made persistant */
1453 PS_TERMCAP_DISABLE
= 1u<<27, /* HAVE_TERMCAP: *termcap-disable* was set */
1454 PS_TERMCAP_CA_MODE
= 1u<<28, /* HAVE_TERMCAP: ca_mode available & used */
1455 PS_LINE_EDITOR_INIT
= 1u<<29 /* MLE is initialized */
1458 /* A large enum with all the boolean and value options a.k.a their keys.
1459 * Only the constant keys are in here, to be looked up via ok_[bv]look(),
1460 * ok_[bv]set() and ok_[bv]clear().
1462 * - see the comments in accmacvar.c before changing *anything* in here!
1463 * - virt= implies rdonly,nodel
1464 * - import= implies env
1465 * - defval= implies notempty
1466 * - num and posnum are mutual exclusive
1467 * - most default VAL_ues come from in from build system via ./make.rc
1468 * (Keep in SYNC: ./nail.h:okeys, ./nail.rc, ./nail.1:"Initial settings") */
1470 /* TODO likely temporary hook data, v15 drop */
1472 ok_v_compose_sender
,
1476 ok_v_compose_subject
,
1478 ok_v__account_name
, /* {nolopts=1,rdonly=1,nodel=1} */
1479 ok_b_add_file_recipients
,
1480 ok_v_agent_shell_lookup
,
1489 ok_b_asksub
, /* {i3val=TRU1} */
1499 ok_b_batch_exit_on_error
,
1500 ok_v_bind_timeout
, /* {notempty=1,posnum=1} */
1508 ok_v_COLUMNS
, /* {notempty=1,posnum=1,env=1} */
1509 ok_v_charset_7bit
, /* {lower=1,defval=CHARSET_7BIT} */
1510 /* But unused without HAVE_ICONV, we use ok_vlook(CHARSET_8BIT_OKEY)! */
1511 ok_v_charset_8bit
, /* {lower=1,defval=CHARSET_8BIT} */
1512 ok_v_charset_unknown_8bit
, /* {lower=1} */
1514 ok_b_colour_disable
,
1516 ok_v_crt
, /* {posnum=1} */
1517 ok_v_customhdr
, /* {nocntrls=1} */
1519 ok_v_DEAD
, /* {notempty=1,env=1,defval=VAL_DEAD} */
1521 ok_v_datefield_markout_older
,
1522 ok_b_debug
, /* {vip=1} */
1523 ok_b_disposition_notification_send
,
1525 ok_b_dotlock_ignore_error
,
1527 ok_v_EDITOR
, /* {env=1,defval=VAL_EDITOR} */
1535 /* TODO -exit-status should be num=1 */
1536 ok_v__exit_status
, /* {nolopts=1,rdonly=1,nodel=1} */
1538 ok_v_features
, /* {virt=VAL_FEATURES} */
1540 ok_v_folder
, /* {vip=1} */
1541 ok_v__folder_resolved
, /* {rdonly=1,nodel=1} */
1544 ok_v_followup_to_honour
,
1545 ok_b_forward_as_attachment
,
1550 ok_v_HOME
, /* {vip=1,nodel=1,import=1} */
1551 ok_b_header
, /* {vip=1,i3val=TRU1} */
1556 ok_b_history_gabby_persist
,
1557 ok_v_history_size
, /* {notempty=1,num=1} */
1568 ok_b_keep_content_length
,
1571 ok_v_LINES
, /* {notempty=1,posnum=1,env=1} */
1572 ok_v_LISTER
, /* {env=1,defval=VAL_LISTER} */
1573 ok_v_LOGNAME
, /* {rdonly=1,import=1} */
1574 ok_b_line_editor_disable
,
1575 ok_b_line_editor_no_defaults
,
1577 ok_v_MAIL
, /* {env=1} */
1578 ok_v_MAILRC
, /* {import=1,defval=VAL_MAILRC} */
1579 ok_v_MBOX
, /* {env=1,defval=VAL_MBOX} */
1580 ok_v__mailbox_resolved
, /* {nolopts=1,rdonly=1,nodel=1} */
1581 ok_v__mailbox_display
, /* {nolopts=1,rdonly=1,nodel=1} */
1583 ok_b_memdebug
, /* {vip=1} */
1584 ok_b_message_id_disable
,
1585 ok_v_message_inject_head
,
1586 ok_v_message_inject_tail
,
1588 ok_b_mime_allow_text_controls
,
1589 ok_b_mime_alternative_favour_rich
,
1590 ok_v_mime_counter_evidence
, /* {posnum=1} */
1591 ok_v_mimetypes_load_control
,
1592 /* TODO: v15 (not yet due to <-> sendmail): {defval=VAL_MTA} */
1595 ok_b_mta_no_default_arguments
,
1596 /* TODO v15: (not yet due to <-> sendmail-progname {defval=VAL_MTA_ARGV0} */
1599 ok_v_NAIL_EXTRA_RC
, /* {name=NAIL_EXTRA_RC} */
1600 ok_b_NAIL_NO_SYSTEM_RC
, /* {import=1} */
1601 ok_v_NAIL_HEAD
, /* {name=NAIL_HEAD} */
1602 ok_v_NAIL_HISTFILE
, /* {name=NAIL_HISTFILE} */
1603 ok_v_NAIL_HISTSIZE
, /* {name=NAIL_HISTSIZE,notempty=1,num=1} */
1604 ok_v_NAIL_TAIL
, /* {name=NAIL_TAIL} */
1605 ok_v_NETRC
, /* {env=1,defval=VAL_NETRC} */
1611 ok_v_on_compose_done
, /* {notempty=1} */
1612 ok_v_on_compose_done_shell
, /* {notempty=1} */
1613 ok_v_on_compose_enter
, /* {notempty=1} */
1614 ok_v_on_compose_leave
, /* {notempty=1} */
1617 ok_v_PAGER
, /* {env=1,defval=VAL_PAGER} */
1618 ok_v_PATH
, /* {nodel=1,import=1} */
1619 ok_b_POSIXLY_CORRECT
, /* {vip=1,import=1,name=POSIXLY_CORRECT} */
1624 ok_b_pop3_bulk_load
,
1625 ok_v_pop3_keepalive
,
1627 ok_b_pop3_use_starttls
,
1628 ok_b_posix
, /* {vip=1} */
1629 ok_b_print_alternatives
,
1630 ok_v_prompt
, /* {i3val="? "} */
1631 ok_v_prompt2
, /* {i3val=".. "} */
1635 ok_b_quote_as_attachment
,
1638 ok_b_r_option_implicit
,
1639 ok_b_recipients_in_cc
,
1642 ok_b_reply_in_same_charset
,
1645 ok_v_reply_to_honour
,
1646 ok_b_rfc822_body_from_
, /* {name=rfc822-body-from_} */
1648 ok_v_SHELL
, /* {import=1,defval=VAL_SHELL} */
1649 ok_b_SYSV3
, /* {env=1} */
1650 ok_b_save
, /* {i3val=TRU1} */
1651 ok_v_screen
, /* {notempty=1,posnum=1} */
1653 ok_v_sendcharsets
, /* {lower=1} */
1654 ok_b_sendcharsets_else_ttycharset
,
1657 ok_v_sendmail_arguments
,
1658 ok_b_sendmail_no_default_arguments
,
1659 ok_v_sendmail_progname
,
1667 ok_b_skipemptybody
, /* {vip=1} */
1672 ok_v_smime_crl_file
,
1673 /* smime-encrypt-USER@HOST */
1674 ok_b_smime_force_encryption
,
1675 ok_b_smime_no_default_ca
,
1677 ok_v_smime_sign_cert
,
1678 ok_v_smime_sign_include_certs
,
1679 ok_v_smime_sign_message_digest
,
1682 ok_v_smtp_auth_password
,
1683 ok_v_smtp_auth_user
,
1685 ok_b_smtp_use_starttls
,
1686 ok_v_SOURCE_DATE_EPOCH
,/*{name=SOURCE_DATE_EPOCH,env=1,notempty=1,posnum=1}*/
1687 ok_v_spam_interface
,
1688 ok_v_spam_maxsize
, /* {notempty=1,posnum=1} */
1690 ok_v_spamc_arguments
,
1694 ok_v_spamfilter_ham
,
1695 ok_v_spamfilter_noham
,
1696 ok_v_spamfilter_nospam
,
1697 ok_v_spamfilter_rate
,
1698 ok_v_spamfilter_rate_scanscore
,
1699 ok_v_spamfilter_spam
,
1703 ok_v_ssl_cipher_list
,
1704 ok_v_ssl_config_file
,
1709 ok_b_ssl_no_default_ca
,
1716 ok_v_TERM
, /* {env=1} */
1717 ok_v_TMPDIR
, /* {import=1,defval=VAL_TMPDIR} */
1719 ok_b_termcap_disable
,
1720 ok_v_toplines
, /* {notempty=1,num=1,defval="5"} */
1722 ok_v_ttycharset
, /* {lower=1,defval=CHARSET_8BIT} */
1723 ok_b_typescript_mode
, /* {vip=1} */
1725 ok_v_USER
, /* {rdonly=1,import=1} */
1726 ok_v_umask
, /* {vip=1,nodel=1,posnum=1,i3val="0077"} */
1729 ok_v_VISUAL
, /* {env=1,defval=VAL_VISUAL} */
1731 ok_b_verbose
, /* {vip=1} */
1732 ok_v_version
, /* {virt=VERSION} */
1733 ok_v_version_major
, /* {virt=VERSION_MAJOR} */
1734 ok_v_version_minor
, /* {virt=VERSION_MINOR} */
1735 ok_v_version_update
, /* {virt=VERSION_UPDATE} */
1737 ok_b_writebackedited
1740 /* Locale-independent character classes */
1754 char *s
; /* the string's content */
1755 size_t l
; /* the stings's length */
1759 char *s_dat
; /*@ May contain NULs, not automatically terminated */
1760 ui32_t s_len
; /*@ gth of string */
1761 #ifdef HAVE_BYTE_ORDER_LITTLE
1762 ui32_t s_auto
: 1; /* Stored in auto-reclaimed storage? */
1764 ui32_t s_size
: 31; /* of .s_dat, -1 */
1765 #ifndef HAVE_BYTE_ORDER_LITTLE
1771 struct n_strlist
*sl_next
;
1773 char sl_dat
[n_VFIELD_SIZE(0)];
1775 #define n_STRLIST_MALLOC(SZ) /* XXX -> nailfuns.h (and pimp interface) */\
1776 smalloc(n_VSTRUCT_SIZEOF(struct n_strlist, sl_dat) + (SZ) +1)
1779 struct str bi_start
; /* Start of (possibly) bidirectional text */
1780 struct str bi_end
; /* End of ... */
1781 size_t bi_pad
; /* No of visual columns to reserve for BIDI pad */
1784 struct n_cmd_arg_desc
{
1785 char cad_name
[12]; /* Name of command */
1786 ui32_t cad_no
; /* Number of entries in cad_ent_flags */
1787 /* [enum n_cmd_arg_desc_flags,arg-dep] */
1788 ui32_t cad_ent_flags
[n_VFIELD_SIZE(0)][2];
1790 /* ISO C(99) doesn't allow initialization of "flex array" */
1791 #define n_CMD_ARG_DESC_SUBCLASS_DEF(CMD,NO,VAR) \
1792 struct n_cmd_arg_desc_ ## CMD {\
1795 ui32_t cad_ent_flags[NO][2];\
1796 } const VAR = { #CMD, NO,
1797 #define n_CMD_ARG_DESC_SUBCLASS_DEF_END }
1798 #define n_CMD_ARG_DESC_SUBCLASS_CAST(P) ((struct n_cmd_arg_desc const*)P)
1800 struct n_cmd_arg_ctx
{
1801 struct n_cmd_arg_desc
const *cac_desc
;
1802 char const *cac_indat
; /* Input that shall be parsed */
1803 size_t cac_inlen
; /* Input length (UIZ_MAX: do a strlen()) */
1804 size_t cac_no
; /* Output: number of parsed arguments */
1805 struct n_cmd_arg
*cac_arg
; /* Output: parsed arguments */
1808 struct n_cmd_arg
{/* TODO incomplete, misses getmsglist() */
1809 struct n_cmd_arg
*ca_next
;
1810 char const *ca_indat
; /* Pointer into n_cmd_arg_ctx.cac_indat */
1811 size_t ca_inlen
; /* of .ca_indat of this arg (not terminated) */
1812 ui32_t ca_ent_flags
[2]; /* Copy of n_cmd_arg_desc.cad_ent_flags[X] */
1813 ui32_t ca_arg_flags
; /* [Output: _WYSH: copy of parse result flags] */
1816 struct str ca_str
; /* _STRING, _WYSH */
1817 } ca_arg
; /* Output: parsed result */
1821 struct n_colour_pen
;
1825 char const *url_input
; /* Input as given (really) */
1826 enum cproto url_cproto
; /* Communication protocol as given */
1827 bool_t url_needs_tls
; /* Whether the protocol uses SSL/TLS */
1828 bool_t url_had_user
; /* Whether .url_user was part of the URL */
1829 ui16_t url_portno
; /* atoi .url_port or default, host endian */
1830 char const *url_port
; /* Port (if given) or NULL */
1831 char url_proto
[14]; /* Communication protocol as 'xy\0//' */
1832 ui8_t url_proto_len
; /* Length of .url_proto ('\0' index) */
1833 ui8_t url_proto_xlen
; /* .. if '\0' is replaced with ':' */
1834 struct str url_user
; /* User, exactly as given / looked up */
1835 struct str url_user_enc
; /* User, urlxenc()oded */
1836 struct str url_pass
; /* Pass (urlxdec()oded) or NULL */
1837 struct str url_host
; /* Service hostname */
1838 struct str url_path
; /* Path suffix or NULL */
1839 /* TODO: url_get_component(url *, enum COMPONENT, str *store) */
1840 struct str url_h_p
; /* .url_host[:.url_port] */
1841 /* .url_user@.url_host
1842 * Note: for CPROTO_SMTP this may resolve HOST via *smtp-hostname* (->
1843 * *hostname*)! (And may later be overwritten according to *from*!) */
1845 struct str url_u_h_p
; /* .url_user@.url_host[:.url_port] */
1846 struct str url_eu_h_p
; /* .url_user_enc@.url_host[:.url_port] */
1847 char const *url_p_u_h_p
; /* .url_proto://.url_u_h_p */
1848 char const *url_p_eu_h_p
; /* .url_proto://.url_eu_h_p */
1849 char const *url_p_eu_h_p_p
; /* .url_proto://.url_eu_h_p[/.url_path] */
1853 enum cproto cc_cproto
; /* Communication protocol */
1854 enum authtype cc_authtype
; /* Desired authentication */
1855 char const *cc_auth
; /* Authentication type as string */
1856 struct str cc_user
; /* User (urlxdec()oded) or NULL */
1857 struct str cc_pass
; /* Password (urlxdec()oded) or NULL */
1861 struct n_dotlock_info
{
1862 char const *di_file_name
; /* Mailbox to lock */
1863 char const *di_lock_name
; /* .di_file_name + .lock */
1864 char const *di_hostname
; /* ..filled in parent (due resolver delays) */
1865 char const *di_randstr
; /* ..ditto, random string */
1866 size_t di_pollmsecs
; /* Delay in between locking attempts */
1867 struct stat
*di_stb
;
1871 /* Execution context bundles */
1874 void *l_smem
; /* salloc() memory TODO -> memraw? */
1875 /* TODO our new per-exec-ctx memory "allocators" are yet very dumb.
1876 * TODO for v15 those should not be wrapping nodes but real allocators */
1877 struct n_mem_raw
*l_memraw
; /* n_mem_alloc() (/ n_mem_free()) */
1878 struct n_mem_wrap
*l_memwrap
; /* n_mem_wrap() (/ n_mem_unwrap()) */
1882 struct n_mem_raw
*mr_prev
;
1883 struct n_mem_raw
*mr_next
;
1884 char mr_buf
[n_VFIELD_SIZE(0)];
1888 struct n_mem_wrap
*mw_prev
;
1889 struct n_mem_wrap
*mw_next
;
1891 void (*mw_dtor
)(void *obj
);
1894 struct mime_handler
{
1895 enum mime_handler_flags mh_flags
;
1896 struct str mh_msg
; /* Message describing this command */
1897 /* XXX union{} the following? */
1898 char const *mh_shell_cmd
; /* For MIME_HDL_CMD */
1899 int (*mh_ptf
)(void); /* PTF main() for MIME_HDL_PTF */
1903 FILE *qf_os
; /* Output stream */
1904 char const *qf_pfix
;
1905 ui32_t qf_pfix_len
; /* Length of prefix: 0: bypass */
1906 ui32_t qf_qfold_min
; /* Simple way: wrote prefix? */
1907 /* TODO quoteflt.qf_nl_last is a hack that i have introduced so that we
1908 * TODO finally can gracefully place a newline last in the visual display.
1909 * TODO I.e., for cases where quoteflt shouldn't be used at all ;} */
1910 bool_t qf_nl_last
; /* Last thing written/seen was NL */
1911 #ifndef HAVE_QUOTE_FOLD
1915 ui8_t qf_state
; /* *quote-fold* state machine */
1916 bool_t qf_brk_isws
; /* Breakpoint is at WS */
1917 ui32_t qf_qfold_max
; /* Otherwise: line lengths */
1918 ui32_t qf_wscnt
; /* Whitespace count */
1919 ui32_t qf_brkl
; /* Breakpoint */
1920 ui32_t qf_brkw
; /* Visual width, breakpoint */
1921 ui32_t qf_datw
; /* Current visual output line width */
1922 struct str qf_dat
; /* Current visual output line */
1923 struct str qf_currq
; /* Current quote, compressed */
1924 mbstate_t qf_mbps
[2];
1928 #ifdef HAVE_FILTER_HTML_TAGSOUP
1930 FILE *hf_os
; /* Output stream */
1932 ui32_t hf_lmax
; /* Maximum byte +1 in .hf_line/4 */
1933 ui32_t hf_len
; /* Current bytes in .hf_line */
1934 ui32_t hf_last_ws
; /* Last whitespace on line (fold purposes) */
1935 ui32_t hf_mboff
; /* Last offset for "mbtowc" */
1936 ui32_t hf_mbwidth
; /* We count characters not bytes if possible */
1937 char *hf_line
; /* Output line buffer - MUST be last field! */
1938 si32_t hf_href_dist
; /* Count of lines since last HREF flush */
1939 ui32_t hf_href_no
; /* HREF sequence number */
1940 struct htmlflt_href
*hf_hrefs
;
1941 struct htmlflt_tag
const *hf_ign_tag
; /* Tag that will end ignore mode */
1942 char *hf_curr
; /* Current cursor into .hf_bdat */
1943 char *hf_bmax
; /* Maximum byte in .hf_bdat +1 */
1944 char *hf_bdat
; /* (Temporary) Tag content data storage */
1948 struct search_expr
{
1949 char const *ss_where
; /* ..to search for the expr. (not always used) */
1950 char const *ss_sexpr
; /* String search expr.; NULL: use .ss_regex */
1956 /* This is somewhat temporary for pre v15 */
1958 ui32_t sm_flags
; /* enum n_sigman_flags */
1960 struct n_sigman
*sm_outer
;
1961 sighandler_type sm_ohup
;
1962 sighandler_type sm_oint
;
1963 sighandler_type sm_oquit
;
1964 sighandler_type sm_oterm
;
1965 sighandler_type sm_opipe
;
1969 struct termios_state
{
1970 struct termios ts_tios
;
1973 bool_t ts_needs_reset
;
1976 #define termios_state_reset() \
1978 if (termios_state.ts_needs_reset) {\
1979 tcsetattr(STDIN_FILENO, TCSADRAIN, &termios_state.ts_tios);\
1980 termios_state.ts_needs_reset = FAL0;\
1985 struct n_termcap_value
{
1986 enum n_termcap_captype tv_captype
;
1988 union n_termcap_value_data
{
1991 char const *tvd_string
;
1996 struct n_visual_info_ctx
{
1997 char const *vic_indat
; /*I Input data */
1998 size_t vic_inlen
; /*I If UIZ_MAX, strlen(.vic_indat) */
1999 char const *vic_oudat
; /*O remains */
2001 size_t vic_chars_seen
; /*O number of characters processed */
2002 size_t vic_bytes_seen
; /*O number of bytes passed */
2003 size_t vic_vi_width
; /*[O] visual width of the entire range */
2004 wc_t
*vic_woudat
; /*[O] if so requested */
2005 size_t vic_woulen
; /*[O] entries in .vic_woudat, if used */
2006 wc_t vic_waccu
; /*O The last wchar_t/char processed (if any) */
2007 enum n_visual_info_flags vic_flags
; /*O Copy of parse flags */
2009 #ifdef HAVE_C90AMEND1
2010 mbstate_t *vic_mbstate
; /*IO .vic_mbs_def used if NULL */
2011 mbstate_t vic_mbs_def
;
2015 struct time_current
{
2022 struct sock
{ /* data associated with a socket */
2023 int s_fd
; /* file descriptor */
2025 int s_use_ssl
; /* SSL is used */
2027 void *s_ssl
; /* SSL object */
2030 char *s_wbuf
; /* for buffered writes */
2031 int s_wbufsize
; /* allocated size of s_buf */
2032 int s_wbufpos
; /* position of first empty data byte */
2033 char *s_rbufptr
; /* read pointer to s_rbuf */
2034 int s_rsz
; /* size of last read in s_rbuf */
2035 char const *s_desc
; /* description of error messages */
2036 void (*s_onclose
)(void); /* execute on close */
2037 char s_rbuf
[LINESIZE
+ 1]; /* for buffered reads */
2042 struct ccred sc_cred
;
2043 struct sock sc_sock
;
2048 MB_NONE
= 000, /* no reply expected */
2049 MB_COMD
= 001, /* command reply expected */
2050 MB_MULT
= 002, /* multiline reply expected */
2051 MB_PREAUTH
= 004, /* not in authenticated state */
2052 MB_BYE
= 010, /* may accept a BYE state */
2053 MB_FROM__WARNED
= 1<<4 /* MBOX with invalid from seen & logged */
2055 FILE *mb_itf
; /* temp file with messages, read open */
2056 FILE *mb_otf
; /* same, write open */
2057 char *mb_sorted
; /* sort method */
2059 MB_VOID
, /* no type (e. g. connection failed) */
2060 MB_FILE
, /* local file */
2061 MB_POP3
, /* POP3 mailbox */
2062 MB_MAILDIR
/* maildir folder */
2063 } mb_type
; /* type of mailbox */
2065 MB_DELE
= 01, /* may delete messages in mailbox */
2066 MB_EDIT
= 02 /* may edit messages in mailbox */
2068 int mb_threaded
; /* mailbox has been threaded */
2069 struct sock mb_sock
; /* socket structure */
2073 NEED_UNSPEC
, /* unspecified need, don't fetch */
2074 NEED_HEADER
, /* need the header of a message */
2075 NEED_BODY
/* need header and body of a message */
2079 CI_NOTHING
, /* Nothing downloaded yet */
2080 CI_HAVE_HEADER
= 1<<0, /* Header is downloaded */
2081 CI_HAVE_BODY
= 1<<1, /* Entire message is downloaded */
2082 CI_MIME_ERRORS
= 1<<2, /* Defective MIME structure */
2083 CI_EXPANDED
= 1<<3, /* Container part (pk7m) exploded into X */
2084 CI_SIGNED
= 1<<4, /* Has a signature.. */
2085 CI_SIGNED_OK
= 1<<5, /* ..verified ok.. */
2086 CI_SIGNED_BAD
= 1<<6, /* ..verified bad (missing key).. */
2087 CI_ENCRYPTED
= 1<<7, /* Is encrypted.. */
2088 CI_ENCRYPTED_OK
= 1<<8, /* ..decryption possible/ok.. */
2089 CI_ENCRYPTED_BAD
= 1<<9 /* ..not possible/ok */
2092 /* flag bits. Attention: Flags that are used in cache.c may not change */
2094 MUSED
= (1<< 0), /* entry is used, but this bit isn't */
2095 MDELETED
= (1<< 1), /* entry has been deleted */
2096 MSAVED
= (1<< 2), /* entry has been saved */
2097 MTOUCH
= (1<< 3), /* entry has been noticed */
2098 MPRESERVE
= (1<< 4), /* keep entry in sys mailbox */
2099 MMARK
= (1<< 5), /* message is marked! */
2100 MODIFY
= (1<< 6), /* message has been modified */
2101 MNEW
= (1<< 7), /* message has never been seen */
2102 MREAD
= (1<< 8), /* message has been read sometime. */
2103 MSTATUS
= (1<< 9), /* message status has changed */
2104 MBOX
= (1<<10), /* Send this to mbox, regardless */
2105 MNOFROM
= (1<<11), /* no From line */
2106 MHIDDEN
= (1<<12), /* message is hidden to user */
2107 MBOXED
= (1<<13), /* message has been sent to mbox */
2108 MNEWEST
= (1<<14), /* message is very new (newmail) */
2109 MFLAG
= (1<<15), /* message has been flagged recently */
2110 MUNFLAG
= (1<<16), /* message has been unflagged */
2111 MFLAGGED
= (1<<17), /* message is `flagged' */
2112 MANSWER
= (1<<18), /* message has been answered recently */
2113 MUNANSWER
= (1<<19), /* message has been unanswered */
2114 MANSWERED
= (1<<20), /* message is `answered' */
2115 MDRAFT
= (1<<21), /* message has been drafted recently */
2116 MUNDRAFT
= (1<<22), /* message has been undrafted */
2117 MDRAFTED
= (1<<23), /* message is marked as `draft' */
2118 MOLDMARK
= (1<<24), /* messages was marked previously */
2119 MSPAM
= (1<<25), /* message is classified as spam */
2120 MSPAMUNSURE
= (1<<26) /* message may be spam, but it is unsure */
2122 #define MMNORM (MDELETED | MSAVED | MHIDDEN)
2123 #define MMNDEL (MDELETED | MHIDDEN)
2125 #define visible(mp) (((mp)->m_flag & MMNDEL) == 0)
2129 enum content_info m_content_info
;
2131 ui32_t m_spamscore
; /* Spam score as int, 24:8 bits */
2133 int m_block
; /* block number of this part */
2134 size_t m_offset
; /* offset in block of part */
2135 size_t m_size
; /* Bytes in the part */
2136 size_t m_xsize
; /* Bytes in the full part */
2137 long m_lines
; /* Lines in the message */
2138 long m_xlines
; /* Lines in the full message */
2139 time_t m_time
; /* time the message was sent */
2140 char const *m_from
; /* message sender */
2141 struct mimepart
*m_nextpart
; /* next part at same level */
2142 struct mimepart
*m_multipart
; /* parts of multipart */
2143 struct mimepart
*m_parent
; /* enclosing multipart part */
2144 char const *m_ct_type
; /* content-type */
2145 char const *m_ct_type_plain
; /* content-type without specs */
2146 char const *m_ct_type_usr_ovwr
; /* Forcefully overwritten one */
2147 enum mimecontent m_mimecontent
; /* ..in enum */
2148 char const *m_charset
;
2149 char const *m_ct_enc
; /* Content-Transfer-Encoding */
2150 enum mime_enc m_mime_enc
; /* ..in enum */
2151 char *m_partstring
; /* Part level string */
2152 char *m_filename
; /* ..of attachment */
2153 char const *m_content_description
;
2154 struct mime_handler
*m_handler
; /* MIME handler if yet classified */
2158 enum mflag m_flag
; /* flags */
2159 enum content_info m_content_info
;
2161 ui32_t m_spamscore
; /* Spam score as int, 24:8 bits */
2163 int m_block
; /* block number of this message */
2164 size_t m_offset
; /* offset in block of message */
2165 size_t m_size
; /* Bytes in the message */
2166 size_t m_xsize
; /* Bytes in the full message */
2167 long m_lines
; /* Lines in the message */
2168 long m_xlines
; /* Lines in the full message */
2169 time_t m_time
; /* time the message was sent */
2170 time_t m_date
; /* time in the 'Date' field */
2171 unsigned m_idhash
; /* hash on Message-ID for threads */
2172 struct message
*m_child
; /* first child of this message */
2173 struct message
*m_younger
; /* younger brother of this message */
2174 struct message
*m_elder
; /* elder brother of this message */
2175 struct message
*m_parent
; /* parent of this message */
2176 unsigned m_level
; /* thread level of message */
2177 long m_threadpos
; /* position in threaded display */
2178 char *m_maildir_file
; /* original maildir file of msg */
2179 ui32_t m_maildir_hash
; /* hash of file name in maildir sub */
2180 int m_collapsed
; /* collapsed thread information */
2183 /* Given a file address, determine the block number it represents */
2184 #define mailx_blockof(off) ((int) ((off) / 4096))
2185 #define mailx_offsetof(off) ((int) ((off) % 4096))
2186 #define mailx_positionof(block, offset) ((off_t)(block) * 4096 + (offset))
2188 /* Argument types */
2190 ARG_MSGLIST
= 0, /* Message list type */
2191 ARG_STRLIST
= 1, /* A pure string */
2192 ARG_RAWLIST
= 2, /* getrawlist(), old style */
2193 ARG_NOLIST
= 3, /* Just plain 0 */
2194 ARG_NDMLIST
= 4, /* Message list, no defaults */
2195 ARG_WYSHLIST
= 5, /* getrawlist(), sh(1) compatible */
2196 ARG_WYRALIST
= 6, /* _RAWLIST or _WYSHLIST (with `wysh') */
2197 ARG_ARGMASK
= 7, /* Mask of the above */
2199 ARG_A
= 1u<< 4, /* Needs an active mailbox */
2200 ARG_F
= 1u<< 5, /* Is a conditional command */
2201 ARG_G
= 1u<< 6, /* Is supposed to produce "gabby" history */
2202 ARG_H
= 1u<< 7, /* Never place in `history' */
2203 ARG_I
= 1u<< 8, /* Interactive command bit */
2204 ARG_M
= 1u<< 9, /* Legal from send mode bit */
2205 ARG_O
= 1u<<10, /* OBSOLETE()d command */
2206 ARG_P
= 1u<<11, /* Autoprint dot after command */
2207 ARG_R
= 1u<<12, /* Cannot be called in compose mode recursion */
2208 ARG_S
= 1u<<13, /* Cannot be called unless PS_STARTED (POSIX) */
2209 ARG_T
= 1u<<14, /* Is a transparent command */
2210 ARG_V
= 1u<<15, /* Places data in temporary_arg_v_store */
2211 ARG_W
= 1u<<16, /* Invalid when read only bit */
2212 ARG_X
= 1u<<17 /* Valid command in PS_COMPOSE_FORKHOOK mode */
2216 GTO
= 1<< 0, /* Grab To: line */
2217 GSUBJECT
= 1<< 1, /* Likewise, Subject: line */
2218 GCC
= 1<< 2, /* And the Cc: line */
2219 GBCC
= 1<< 3, /* And also the Bcc: line */
2221 GNL
= 1<< 4, /* Print blank line after */
2222 GDEL
= 1<< 5, /* Entity removed from list */
2223 GCOMMA
= 1<< 6, /* detract() puts in commas */
2224 GUA
= 1<< 7, /* User-Agent field */
2225 GMIME
= 1<< 8, /* MIME 1.0 fields */
2226 GMSGID
= 1<< 9, /* a Message-ID */
2227 GNAMEONLY
= 1<<10, /* detract() does NOT use fullnames */
2229 GIDENT
= 1<<11, /* From:, Reply-To:, MFT: (user headers) */
2230 GREF
= 1<<12, /* References:, In-Reply-To:, (Message-ID:) */
2231 GDATE
= 1<<13, /* Date: field */
2232 GFULL
= 1<<14, /* Include full names, comments etc. */
2233 GSKIN
= 1<<15, /* Skin names */
2234 GEXTRA
= 1<<16, /* Extra fields (mostly like GIDENT XXX) */
2235 GFILES
= 1<<17, /* Include filename and pipe addresses */
2236 GFULLEXTRA
= 1<<18 /* Only with GFULL: GFULL less address */
2238 #define GMASK (GTO | GSUBJECT | GCC | GBCC)
2242 HF_LIST_REPLY
= 1<< 0,
2243 HF_MFT_SENDER
= 1<< 1, /* Add ourselves to Mail-Followup-To: */
2244 HF_RECIPIENT_RECORD
= 1<<10, /* Save message in file named after rec. */
2248 /* Structure used to pass about the current state of a message (header) */
2249 struct n_header_field
{
2250 struct n_header_field
*hf_next
;
2251 ui32_t hf_nl
; /* Field-name length */
2252 ui32_t hf_bl
; /* Field-body length*/
2253 char hf_dat
[n_VFIELD_SIZE(0)];
2257 ui32_t h_flags
; /* enum header_flags bits */
2259 struct name
*h_to
; /* Dynamic "To:" string */
2260 char *h_subject
; /* Subject string */
2261 struct name
*h_cc
; /* Carbon copies string */
2262 struct name
*h_bcc
; /* Blind carbon copies */
2263 struct name
*h_ref
; /* References (possibly overridden) */
2264 struct attachment
*h_attach
; /* MIME attachments */
2265 char *h_charset
; /* preferred charset */
2266 struct name
*h_from
; /* overridden "From:" field */
2267 struct name
*h_sender
; /* overridden "Sender:" field */
2268 struct name
*h_replyto
; /* overridden "Reply-To:" field */
2269 struct name
*h_message_id
; /* overridden "Message-ID:" field */
2270 struct name
*h_in_reply_to
;/* overridden "In-Reply-To:" field */
2271 struct name
*h_mft
; /* Mail-Followup-To */
2272 char const *h_list_post
; /* Address from List-Post:, for `Lreply' */
2273 struct n_header_field
*h_user_headers
;
2274 struct n_header_field
*h_custom_headers
; /* (Cached result) */
2277 /* Handling of namelist nodes used in processing the recipients of mail and
2278 * aliases, inspection of mail-addresses and all that kind of stuff */
2280 NAME_NAME_SALLOC
= 1<< 0, /* .n_name is doped */
2281 NAME_FULLNAME_SALLOC
= 1<< 1, /* .n_fullname is doped */
2282 NAME_SKINNED
= 1<< 2, /* Is actually skin()ned */
2283 NAME_IDNA
= 1<< 3, /* IDNA was applied */
2285 NAME_ADDRSPEC_CHECKED
= 1<< 4, /* Address has been .. and */
2286 NAME_ADDRSPEC_ISFILE
= 1<< 5, /* ..is a file path */
2287 NAME_ADDRSPEC_ISPIPE
= 1<< 6, /* ..is a command for piping */
2288 NAME_ADDRSPEC_ISFILEORPIPE
= NAME_ADDRSPEC_ISFILE
| NAME_ADDRSPEC_ISPIPE
,
2289 NAME_ADDRSPEC_ISNAME
= 1<< 7, /* ..is a valid mail network address */
2290 NAME_ADDRSPEC_ISADDR
= 1<< 8, /* ..is a valid mail network address */
2292 NAME_ADDRSPEC_ERR_EMPTY
= 1<< 9, /* An empty string (or NULL) */
2293 NAME_ADDRSPEC_ERR_ATSEQ
= 1<<10, /* Weird @ sequence */
2294 NAME_ADDRSPEC_ERR_CHAR
= 1<<11, /* Invalid character */
2295 NAME_ADDRSPEC_ERR_IDNA
= 1<<12, /* IDNA convertion failed */
2296 NAME_ADDRSPEC_INVALID
= NAME_ADDRSPEC_ERR_EMPTY
|
2297 NAME_ADDRSPEC_ERR_ATSEQ
| NAME_ADDRSPEC_ERR_CHAR
|
2298 NAME_ADDRSPEC_ERR_IDNA
,
2300 /* Error storage (we must fit in 31-bit) */
2302 _NAME_MAXWC
= 0x3FFFF,
2303 _NAME_MASKWC
= _NAME_MAXWC
<< _NAME_SHIFTWC
2306 /* In the !_ERR_EMPTY case, the failing character can be queried */
2307 #define NAME_ADDRSPEC_ERR_GETWC(F) \
2308 ((((unsigned int)(F) & _NAME_MASKWC) >> _NAME_SHIFTWC) & _NAME_MAXWC)
2309 #define NAME_ADDRSPEC_ERR_SET(F, E, WC) \
2311 (F) = ((F) & ~(NAME_ADDRSPEC_INVALID | _NAME_MASKWC)) |\
2312 (E) | (((unsigned int)(WC) & _NAME_MAXWC) << _NAME_SHIFTWC);\
2316 struct name
*n_flink
; /* Forward link in list. */
2317 struct name
*n_blink
; /* Backward list link */
2318 enum gfield n_type
; /* From which list it came */
2319 enum nameflags n_flags
; /* enum nameflags */
2320 char *n_name
; /* This fella's address */
2321 char *n_fullname
; /* Ditto, unless GFULL including comment */
2322 char *n_fullextra
; /* GFULL, without address */
2326 /* Input string as given (maybe replaced with a fixed one!) */
2327 char const *ag_input
;
2328 size_t ag_ilen
; /* strlen() of input */
2329 size_t ag_iaddr_start
; /* Start of *addr-spec* in .ag_input */
2330 size_t ag_iaddr_aend
; /* ..and one past its end */
2331 char *ag_skinned
; /* Output (alloced if !=.ag_input) */
2332 size_t ag_slen
; /* strlen() of .ag_skinned */
2333 size_t ag_sdom_start
; /* Start of domain in .ag_skinned, */
2334 enum nameflags ag_n_flags
; /* enum nameflags of .ag_skinned */
2337 /* MIME attachments */
2339 AC_DEFAULT
, /* _get_lc() -> _iter_*() */
2340 AC_FIX_INCS
, /* "charset=".a_input_charset (nocnv) */
2341 AC_TMPFILE
/* attachment.a_tmpf is converted */
2344 enum n_attach_error
{
2346 n_ATTACH_ERR_FILE_OPEN
,
2347 n_ATTACH_ERR_ICONV_FAILED
,
2348 n_ATTACH_ERR_ICONV_NAVAIL
,
2353 struct attachment
*a_flink
; /* Forward link in list. */
2354 struct attachment
*a_blink
; /* Backward list link */
2355 char const *a_path_user
; /* Path as given (maybe including iconv spec) */
2356 char const *a_path
; /* Path as opened */
2357 char const *a_path_bname
; /* Basename of path as opened */
2358 char const *a_name
; /* File name to be stored (EQ a_path_bname) */
2359 char const *a_content_type
; /* content type */
2360 char const *a_content_disposition
; /* content disposition */
2361 struct name
*a_content_id
; /* content id */
2362 char const *a_content_description
; /* content description */
2363 char const *a_input_charset
; /* Interpretation depends on .a_conv */
2364 char const *a_charset
; /* ... */
2365 FILE *a_tmpf
; /* If AC_TMPFILE */
2366 enum attach_conv a_conv
; /* User chosen conversion */
2367 int a_msgno
; /* message number */
2371 struct header
*sb_hp
;
2374 struct str sb_signer
; /* USER@HOST for signing+ */
2376 struct ccred sb_ccred
;
2379 /* For saving the current directory and later returning */
2384 char cw_wd
[PATH_MAX
];
2389 * Global variable declarations
2391 * These become instantiated in main.c.
2395 #ifdef n_MAIN_SOURCE
2396 # ifndef HAVE_AMALGAMATION
2405 VL
int mb_cur_max
; /* Value of MB_CUR_MAX */
2406 VL
int realscreenheight
; /* The real screen height */
2407 VL
int scrnwidth
; /* Screen width, or best guess */
2408 VL
int scrnheight
; /* Screen height/guess (4 header) */
2409 VL
FILE *n_tty_fp
; /* Our terminal output TODO input channel */
2411 VL
char const *progname
; /* Our name */
2413 VL gid_t group_id
; /* getgid() and getuid() */
2416 VL
int exit_status
; /* Exit status */
2417 VL ui32_t options
; /* Bits of enum user_options */
2418 VL
char const *option_Mm_arg
; /* Argument for -[Mm] aka OPT_[Mm]_FLAG */
2419 VL
struct name
*option_r_arg
; /* Argument to -r option */
2420 VL
char const **smopts
; /* sendmail(1) opts from commline */
2421 VL
size_t smopts_cnt
; /* Entries in smopts */
2423 VL ui32_t pstate
; /* Bits of enum program_state */
2425 /* XXX stylish sorting */
2426 VL
int msgCount
; /* Count of messages read in */
2427 VL
struct mailbox mb
; /* Current mailbox */
2428 VL
int image
; /* File descriptor for msg image */
2429 VL
char mailname
[PATH_MAX
]; /* Name of current file TODO URL/object*/
2430 VL
char displayname
[80 - 40]; /* Prettyfied for display TODO URL/obj*/
2431 VL
char prevfile
[PATH_MAX
]; /* Name of previous file TODO URL/obj */
2432 VL
char const *account_name
; /* Current account name or NULL */
2433 VL off_t mailsize
; /* Size of system mailbox */
2434 VL
struct message
*dot
; /* Pointer to current message */
2435 VL
struct message
*prevdot
; /* Previous current message */
2436 VL
struct message
*message
; /* The actual message structure */
2437 VL
struct message
*threadroot
; /* first threaded message */
2438 VL
int *n_msgvec
; /* Folder setmsize(), list.c res. store*/
2440 VL
struct time_current time_current
; /* time(3); send: mail1() XXXcarrier */
2441 VL
struct termios_state termios_state
; /* getpassword(); see commands().. */
2444 VL
enum ssl_verify_level ssl_verify_level
; /* SSL verification level */
2451 VL
volatile int interrupts
; /* TODO rid! */
2452 VL sighandler_type dflpipe
;
2454 /* TODO Temporary hacks unless the codebase doesn't jump and uses pass-by-value
2455 * TODO carrier structs instead of locals */
2456 VL
char *temporary_arg_v_store
;
2457 /* TODO temporary storage to overcome which_protocol() mess (for PROTO_FILE) */
2458 VL
char const *temporary_protocol_ext
;
2460 /* The remaining variables need initialization */
2462 #ifndef HAVE_AMALGAMATION
2463 VL
char const month_names
[12 + 1][4];
2464 VL
char const weekday_names
[7 + 1][4];
2466 VL
char const uagent
[sizeof VAL_UAGENT
];
2467 VL
char const n_error
[sizeof n_ERROR
];
2468 VL
char const n_unirepl
[sizeof n_UNIREPL
];
2469 VL
char const n_empty
[1];
2471 VL ui16_t
const class_char
[1 + 0x7F];
2475 * Finally, let's include the function prototypes XXX embed
2478 #ifndef n_PRIVSEP_SOURCE
2479 # include "nailfuns.h"