1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
2 *@ Header inclusion, macros, constants, types and the global var declarations.
3 *@ TODO Place in include/, split in object-based subheaders. And please: sort.
5 * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
6 * Copyright (c) 2012 - 2017 Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
9 * Copyright (c) 1980, 1993
10 * The Regents of the University of California. All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
40 * Mail -- a mail program
42 * Author: Kurt Shoens (UCB) March 25, 1978
45 #include "mk-config.h"
48 #include <sys/types.h>
51 #ifdef HAVE_GETTIMEOFDAY
52 # include <sys/time.h>
85 # include <openssl/md5.h>
88 /* Many things possibly of interest for adjustments have been outsourced */
91 /* Special FD requests for n_child_run(), n_child_start() */
92 #define n_CHILD_FD_PASS -1
93 #define n_CHILD_FD_NULL -2
97 # define n_COLOUR(X) X
103 #define n_FROM_DATEBUF 64 /* Size of RFC 4155 From_ line date */
104 #define n_DATE_DAYSYEAR 365u
105 #define n_DATE_NANOSSEC (n_DATE_MICROSSEC * 1000)
106 #define n_DATE_MICROSSEC (n_DATE_MILLISSEC * 1000)
107 #define n_DATE_MILLISSEC 1000u
108 #define n_DATE_SECSMIN 60u
109 #define n_DATE_MINSHOUR 60u
110 #define n_DATE_HOURSDAY 24u
111 #define n_DATE_SECSHOUR (n_DATE_SECSMIN * n_DATE_MINSHOUR)
112 #define n_DATE_SECSDAY (n_DATE_SECSHOUR * n_DATE_HOURSDAY)
114 /* Network protocol newline */
115 #define NETNL "\015\012"
116 #define NETLINE(X) X NETNL
119 * OS, CC support, generic macros etc.
122 #define n_ISPOW2(X) ((((X) - 1) & (X)) == 0)
123 #define n_MIN(A,B) ((A) < (B) ? (A) : (B))
124 #define n_MAX(A,B) ((A) < (B) ? (B) : (A))
125 #define n_CLIP(X,A,B) (((X) <= (A)) ? (A) : (((X) >= (B)) ? (B) : (X)))
126 #define n_ABS(A) ((A) < 0 ? -(A) : (A))
128 /* OS: we're not a library, only set what needs special treatment somewhere */
129 #define n_OS_DRAGONFLY 0
130 #define n_OS_OPENBSD 0
131 #define n_OS_SOLARIS 0
135 # undef n_OS_DRAGONFLY
136 # define n_OS_DRAGONFLY 1
137 #elif defined __OpenBSD__
139 # define n_OS_OPENBSD 1
140 #elif defined __solaris__ || defined __sun
141 # if defined __SVR4 || defined __svr4__
143 # define n_OS_SOLARIS 1
146 # define n_OS_SUNOS 1
152 #define PREREQ_CLANG(X,Y) 0
154 #define PREREQ_GCC(X,Y) 0
156 #define PREREQ_TCC(X,Y) 0
162 # define PREREQ_CLANG(X,Y) \
163 (__clang_major__ + 0 > (X) || \
164 (__clang_major__ + 0 == (X) && __clang_minor__ + 0 >= (Y)))
165 # define __EXTEN __extension__
167 #elif defined __GNUC__
171 # define PREREQ_GCC(X,Y) \
172 (__GNUC__ + 0 > (X) || (__GNUC__ + 0 == (X) && __GNUC_MINOR__ + 0 >= (Y)))
173 # define __EXTEN __extension__
175 #elif defined __TINYC__
184 /* Suppress some technical warnings via #pragma's unless developing.
185 * XXX Wild guesses: clang(1) 1.7 and (OpenBSD) gcc(1) 4.2.1 don't work */
187 # if PREREQ_CLANG(3, 4)
188 # pragma clang diagnostic ignored "-Wassign-enum"
189 # pragma clang diagnostic ignored "-Wdisabled-macro-expansion"
190 # pragma clang diagnostic ignored "-Wformat"
191 # pragma clang diagnostic ignored "-Wunused-result"
192 # elif PREREQ_GCC(4, 7)
193 # pragma GCC diagnostic ignored "-Wunused-local-typedefs"
194 # pragma GCC diagnostic ignored "-Wunused-result"
195 # pragma GCC diagnostic ignored "-Wformat"
199 /* For injection macros like DBG(), n_NATCH_CHAR() */
202 #define EMPTY_FILE() typedef int n_CONCAT(avoid_empty_file__, n_FILE);
204 /* Pointer to size_t */
205 #define PTR2SIZE(X) ((size_t)(uintptr_t)(X))
207 /* Pointer comparison (types from below) */
208 #define PTRCMP(A,C,B) ((uintptr_t)(A) C (uintptr_t)(B))
210 /* Ditto, compare (maybe mixed-signed) integers cases to T bits, unsigned;
211 * Note: doesn't sign-extend correctly, that's still up to the caller */
212 #define UICMP(T,A,C,B) ((ui ## T ## _t)(A) C (ui ## T ## _t)(B))
214 /* Align something to a size/boundary that cannot cause just any problem */
215 #define n_ALIGN(X) (((X) + 2*sizeof(void*)) & ~((2*sizeof(void*)) - 1))
216 #define n_ALIGN_SMALL(X) \
217 (((X) + n_MAX(sizeof(size_t), sizeof(void*))) &\
218 ~(n_MAX(sizeof(size_t), sizeof(void*)) - 1))
220 /* Members in constant array */
221 #define n_NELEM(A) (sizeof(A) / sizeof((A)[0]))
223 /* sizeof() for member fields */
224 #define n_SIZEOF_FIELD(T,F) sizeof(((T *)NULL)->F)
226 /* Casts-away (*NOT* cast-away) */
227 #define n_UNUSED(X) ((void)(X))
228 #define n_UNCONST(P) ((void*)(uintptr_t)(void const*)(P))
229 #define n_UNVOLATILE(P) ((void*)(uintptr_t)(void volatile*)(P))
230 /* To avoid warnings with modern compilers for "char*i; *(si32_t*)i=;" */
231 #define n_UNALIGN(T,P) ((T)(uintptr_t)(P))
232 #define n_UNXXX(T,C,P) ((T)(uintptr_t)(C)(P))
234 /* __STDC_VERSION__ is ISO C99, so also use __STDC__, which should work */
235 #if defined __STDC__ || defined __STDC_VERSION__ /*|| defined __cplusplus*/
236 # define n_STRING(X) #X
237 # define n_XSTRING(X) n_STRING(X)
238 # define n_CONCAT(S1,S2) n__CONCAT_1(S1, S2)
239 # define n__CONCAT_1(S1,S2) S1 ## S2
241 # define n_STRING(X) "X"
242 # define n_XSTRING STRING
243 # define n_CONCAT(S1,S2) S1/* won't work out */S2
246 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
247 # define n_FIELD_INITN(N) CONCAT(., N) =
248 # define n_FIELD_INITI(I) [I] =
250 # define n_FIELD_INITN(N)
251 # define n_FIELD_INITI(N)
254 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
255 # define n_VFIELD_SIZE(X)
256 # define n_VSTRUCT_SIZEOF(T,F) sizeof(T)
258 # define n_VFIELD_SIZE(X) \
259 ((X) == 0 ? sizeof(size_t) \
260 : ((ssize_t)(X) < 0 ? sizeof(size_t) - n_ABS(X) : (size_t)(X)))
261 # define n_VSTRUCT_SIZEOF(T,F) (sizeof(T) - n_SIZEOF_FIELD(T, F))
265 # define SINLINE n_INLINE /* TODO obsolete */
267 # define SINLINE static
271 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
272 # define __FUN__ __func__
273 #elif CC_CLANG || PREREQ_GCC(3, 4)
274 # define __FUN__ __extension__ __FUNCTION__
276 # define __FUN__ n_uagent /* Something that is not a literal */
279 #if defined __predict_true && defined __predict_false
280 # define n_LIKELY(X) __predict_true(X)
281 # define n_UNLIKELY(X) __predict_false(X)
282 #elif CC_CLANG || PREREQ_GCC(2, 96)
283 # define n_LIKELY(X) __builtin_expect(X, 1)
284 # define n_UNLIKELY(X) __builtin_expect(X, 0)
286 # define n_LIKELY(X) (X)
287 # define n_UNLIKELY(X) (X)
290 #undef HAVE_NATCH_CHAR
291 #if defined HAVE_SETLOCALE && defined HAVE_C90AMEND1 && defined HAVE_WCWIDTH
292 # define HAVE_NATCH_CHAR
293 # define n_NATCH_CHAR(X) X
295 # define n_NATCH_CHAR(X)
298 /* Compile-Time-Assert
299 * Problem is that some compilers warn on unused local typedefs, so add
300 * a special local CTA to overcome this */
301 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 201112L
302 # define n_CTA(T,M) _Static_assert(T, M)
303 # define n_LCTA(T,M) _Static_assert(T, M)
305 # define n_CTA(T,M) n__CTA_1(T, n_FILE, __LINE__)
306 # define n_LCTA(T,M) n__LCTA_1(T, n_FILE, __LINE__)
308 #define n_CTAV(T) n_CTA(T, "Unexpected value of constant")
309 #define n_LCTAV(T) n_LCTA(T, "Unexpected value of constant")
312 # define n_MCTA(T,M) n_CTA(T, M);
317 #define n__CTA_1(T,F,L) n__CTA_2(T, F, L)
318 #define n__CTA_2(T,F,L) \
319 typedef char ASSERTION_failed_in_file_## F ## _at_line_ ## L[(T) ? 1 : -1]
320 #define n__LCTA_1(T,F,L) n__LCTA_2(T, F, L)
321 #define n__LCTA_2(T,F,L) \
323 typedef char ASSERTION_failed_in_file_## F ## _at_line_ ## L[(T) ? 1 : -1];\
324 ASSERTION_failed_in_file_## F ## _at_line_ ## L __i_am_unused__;\
325 n_UNUSED(__i_am_unused__);\
328 #define n_UNINIT(N,V) N = V
330 /* Create a bit mask for the bit range LO..HI -- HI can't use highest bit! */
331 #define n_BITENUM_MASK(LO,HI) (((1u << ((HI) + 1)) - 1) & ~((1u << (LO)) - 1))
337 # define assert(X) n_UNUSED(0)
340 # define DBGOR(X,Y) Y
344 # define DBGOR(X,Y) X
347 /* Translation (init in main.c): may NOT set errno! */
356 * Types TODO v15: n_XX_t
360 # define UI8_MAX UINT8_MAX
361 # define SI8_MIN INT8_MIN
362 # define SI8_MAX INT8_MAX
363 typedef uint8_t ui8_t
;
364 typedef int8_t si8_t
;
365 #elif UCHAR_MAX != 255
366 # error UCHAR_MAX must be 255
368 # define UI8_MAX UCHAR_MAX
369 # define SI8_MIN CHAR_MIN
370 # define SI8_MAX CHAR_MAX
371 typedef unsigned char ui8_t
;
372 typedef signed char si8_t
;
375 #if !defined PRIu8 || !defined PRId8
383 # define UI16_MAX UINT16_MAX
384 # define SI16_MIN INT16_MIN
385 # define SI16_MAX INT16_MAX
386 typedef uint16_t ui16_t
;
387 typedef int16_t si16_t
;
388 #elif USHRT_MAX != 0xFFFFu
389 # error USHRT_MAX must be 0xFFFF
391 # define UI16_MAX USHRT_MAX
392 # define SI16_MIN SHRT_MIN
393 # define SI16_MAX SHRT_MAX
394 typedef unsigned short ui16_t
;
395 typedef signed short si16_t
;
398 #if !defined PRIu16 || !defined PRId16
401 # if UI16_MAX == UINT_MAX
411 # define UI32_MAX UINT32_MAX
412 # define SI32_MIN INT32_MIN
413 # define SI32_MAX INT32_MAX
414 typedef uint32_t ui32_t
;
415 typedef int32_t si32_t
;
416 #elif ULONG_MAX == 0xFFFFFFFFu
417 # define UI32_MAX ULONG_MAX
418 # define SI32_MIN LONG_MIN
419 # define SI32_MAX LONG_MAX
420 typedef unsigned long int ui32_t
;
421 typedef signed long int si32_t
;
422 #elif UINT_MAX != 0xFFFFFFFFu
423 # error UINT_MAX must be 0xFFFFFFFF
425 # define UI32_MAX UINT_MAX
426 # define SI32_MIN INT_MIN
427 # define SI32_MAX INT_MAX
428 typedef unsigned int ui32_t
;
429 typedef signed int si32_t
;
432 #if !defined PRIu32 || !defined PRId32
435 # if UI32_MAX == ULONG_MAX
445 # define UI64_MAX UINT64_MAX
446 # define SI64_MIN INT64_MIN
447 # define SI64_MAX INT64_MAX
448 typedef uint64_t ui64_t
;
449 typedef int64_t si64_t
;
450 #elif ULONG_MAX <= 0xFFFFFFFFu
451 # if !defined ULLONG_MAX || (ULLONG_MAX >> 31) < 0xFFFFFFFFu
452 # error We need a 64 bit integer
454 # define UI64_MAX ULLONG_MAX
455 # define SI64_MIN LLONG_MIN
456 # define SI64_MAX LLONG_MAX
457 __EXTEN
typedef unsigned long long ui64_t
;
458 __EXTEN
typedef signed long long si64_t
;
461 # define UI64_MAX ULONG_MAX
462 # define SI64_MIN LONG_MIN
463 # define SI64_MAX LONG_MAX
464 typedef unsigned long ui64_t
;
465 typedef signed long si64_t
;
468 /* PRIo64 for `vexpr' */
469 #if !defined PRIu64 || !defined PRId64 || !defined PRIX64 || !defined PRIo64
474 # if defined ULLONG_MAX && UI64_MAX == ULLONG_MAX
475 # define PRIu64 "llu"
476 # define PRId64 "lld"
477 # define PRIX64 "llX"
478 # define PRIo64 "llo"
487 /* (So that we can use UICMP() for size_t comparison, too) */
488 typedef size_t uiz_t
;
489 typedef ssize_t siz_t
;
493 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
496 # define UIZ_MAX SIZE_MAX
497 #elif defined SIZE_MAX
498 /* UnixWare has size_t as unsigned as required but uses a signed limit
499 * constant (which is thus false!) */
500 # if SIZE_MAX == UI64_MAX || SIZE_MAX == SI64_MAX
501 # define PRIuZ PRIu64
502 # define PRIdZ PRId64
503 n_MCTA(sizeof(size_t) == sizeof(ui64_t
),
504 "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
505 # elif SIZE_MAX == UI32_MAX || SIZE_MAX == SI32_MAX
506 # define PRIuZ PRIu32
507 # define PRIdZ PRId32
508 n_MCTA(sizeof(size_t) == sizeof(ui32_t
),
509 "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
511 # error SIZE_MAX is neither UI64_MAX nor UI32_MAX (please report this)
513 # define UIZ_MAX SIZE_MAX
518 n_MCTA(sizeof(size_t) == sizeof(unsigned long),
519 "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
520 # define UIZ_MAX ULONG_MAX
525 # define uintptr_t size_t
526 # define UINTPTR_MAX SIZE_MAX
528 # define uintptr_t unsigned long
529 # define UINTPTR_MAX ULONG_MAX
533 #if !defined PRIuPTR || !defined PRIXPTR
536 # if UINTPTR_MAX == ULONG_MAX
537 # define PRIuPTR "lu"
538 # define PRIXPTR "lX"
545 #ifdef HAVE_C90AMEND1
546 typedef wchar_t wc_t
;
547 # define n_WC_C(X) L ## X
549 typedef char wc_t
; /* Yep: really 8-bit char */
553 enum {FAL0
, TRU1
, TRUM1
= -1};
554 typedef si8_t bool_t
;
556 /* Add shorter aliases for "normal" integers TODO v15 -> n_XX_t */
557 typedef unsigned long ul_i
;
558 typedef unsigned int ui_i
;
559 typedef unsigned short us_i
;
560 typedef unsigned char uc_i
;
562 typedef signed long sl_i
;
563 typedef signed int si_i
;
564 typedef signed short ss_i
;
565 typedef signed char sc_i
;
567 typedef void ( *sighandler_type
)(int); /* TODO v15 obsolete */
568 typedef void ( *n_sighdl_t
)(int);
570 enum n_announce_flags
{
571 n_ANNOUNCE_NONE
= 0, /* Only housekeeping */
572 n_ANNOUNCE_MAIN_CALL
= 1u<<0, /* POSIX covered startup call */
573 n_ANNOUNCE_STATUS
= 1u<<1, /* Only print status */
574 n_ANNOUNCE_CHANGE
= 1u<<2, /* Folder changed */
576 n__ANNOUNCE_HEADER
= 1u<<6,
577 n__ANNOUNCE_ANY
= 1u<<7
581 AUTHTYPE_NONE
= 1<<0,
582 AUTHTYPE_PLAIN
= 1<<1, /* POP3: APOP is covered by this */
583 AUTHTYPE_LOGIN
= 1<<2,
584 AUTHTYPE_CRAM_MD5
= 1<<3,
585 AUTHTYPE_GSSAPI
= 1<<4
588 enum expand_addr_flags
{
589 EAF_NONE
= 0, /* -> EAF_NOFILE | EAF_NOPIPE */
590 EAF_RESTRICT
= 1<<0, /* "restrict" (do unless interaktive / -[~#]) */
591 EAF_FAIL
= 1<<1, /* "fail" */
592 EAF_FAILINVADDR
= 1<<2, /* "failinvaddr" */
593 /* TODO HACK! In pre-v15 we have a control flow problem (it is a general
594 * TODO design problem): if collect() calls makeheader(), e.g., for -t or
595 * TODO because of ~e diting, then that will checkaddr() and that will
596 * TODO remove invalid headers. However, this code path does not know
597 * TODO about keeping track of senderrors unless a pointer has been passed,
598 * TODO but which it doesn't for ~e, and shall not, too. Thus, invalid
599 * TODO addresses may be automatically removed, silently, and noone will
600 * TODO ever know, in particular not regarding "failinvaddr".
601 * TODO The hacky solution is this bit -- which can ONLY be used for fields
602 * TODO which will be subject to namelist_vaporise_head() later on!! --,
603 * TODO if it is set (by extract_header()) then checkaddr() will NOT strip
604 * TODO invalid headers off IF it deals with a NULL senderror pointer */
606 /* Bits reused by enum expand_addr_check_mode! */
607 EAF_FILE
= 1<<4, /* +"file" targets */
608 EAF_PIPE
= 1<<5, /* +"pipe" command pipe targets */
609 EAF_NAME
= 1<<6, /* +"name"s (non-address) names / MTA aliases */
610 EAF_ADDR
= 1<<7, /* +"addr" network address (contain "@") */
612 EAF_TARGET_MASK
= EAF_FILE
| EAF_PIPE
| EAF_NAME
| EAF_ADDR
,
613 EAF_RESTRICT_TARGETS
= EAF_NAME
| EAF_ADDR
/* (default set if not set) */
616 enum expand_addr_check_mode
{
617 EACM_NONE
= 0, /* Don't care about *expandaddr* */
618 EACM_NORMAL
= 1<<0, /* Use our normal *expandaddr* checking */
619 EACM_STRICT
= 1<<1, /* Never allow any file or pipe addresse */
620 EACM_MODE_MASK
= 0x3, /* _NORMAL and _STRICT are mutual! */
622 EACM_NOLOG
= 1<<2, /* Don't log check errors */
624 /* Some special overwrites of EAF_TARGETs.
625 * May NOT clash with EAF_* bits which may be ORd to these here! */
630 enum n_cmd_arg_flags
{ /* TODO Most of these need to change, in fact in v15
631 * TODO i rather see the mechanism that is used in c_bind() extended and used
632 * TODO anywhere, i.e. n_cmd_arg_parse().
633 * TODO Note that we may NOT support arguments with strlen()>=UI32_MAX (?) */
634 n_CMD_ARG_TYPE_MSGLIST
= 0, /* Message list type */
635 n_CMD_ARG_TYPE_NDMLIST
= 1, /* Message list, no defaults */
636 n_CMD_ARG_TYPE_RAWDAT
= 2, /* The plain string in an argv[] */
637 n_CMD_ARG_TYPE_STRING
= 3, /* A pure string TODO obsolete */
638 n_CMD_ARG_TYPE_WYSH
= 4, /* getrawlist(), sh(1) compatible */
639 n_CMD_ARG_TYPE_RAWLIST
= 5, /* getrawlist(), old style TODO obsolete */
640 n_CMD_ARG_TYPE_WYRA
= 6, /* _RAWLIST or _WYSH (with `wysh') TODO obs. */
641 n_CMD_ARG_TYPE_ARG
= 7, /* n_cmd_arg_desc/n_cmd_arg() new-style */
642 n_CMD_ARG_TYPE_MASK
= 7, /* Mask of the above */
644 n_CMD_ARG_A
= 1u<< 4, /* Needs an active mailbox */
645 n_CMD_ARG_F
= 1u<< 5, /* Is a conditional command */
646 n_CMD_ARG_G
= 1u<< 6, /* Is supposed to produce "gabby" history */
647 n_CMD_ARG_H
= 1u<< 7, /* Never place in `history' */
648 n_CMD_ARG_I
= 1u<< 8, /* Interactive command bit */
649 n_CMD_ARG_M
= 1u<< 9, /* Legal from send mode bit */
650 n_CMD_ARG_O
= 1u<<10, /* n_OBSOLETE()d command */
651 n_CMD_ARG_P
= 1u<<11, /* Autoprint dot after command */
652 n_CMD_ARG_R
= 1u<<12, /* Cannot be called in compose mode recursion */
653 n_CMD_ARG_S
= 1u<<13, /* Cannot be called pre-n_PSO_STARTED (POSIX) */
654 n_CMD_ARG_T
= 1u<<14, /* Is a transparent command */
655 n_CMD_ARG_V
= 1u<<15, /* Supports `vput' prefix (only WYSH/WYRA) */
656 n_CMD_ARG_W
= 1u<<16, /* Invalid when read only bit */
657 n_CMD_ARG_X
= 1u<<17, /* Valid command in n_PS_COMPOSE_FORKHOOK mode */
658 /* XXX Note that CMD_ARG_EM implies a _real_ return value for $! */
659 n_CMD_ARG_EM
= 1u<<30 /* If error: n_pstate_err_no (4 $! aka. ok_v___em) */
662 enum n_cmd_arg_desc_flags
{/* TODO incomplete, misses getmsglist() */
664 n_CMD_ARG_DESC_STRING
= 1u<<0, /* A !blankspacechar() string */
665 n_CMD_ARG_DESC_WYSH
= 1u<<1, /* sh(1)ell-style quoted */
667 n__CMD_ARG_DESC_TYPE_MASK
= n_CMD_ARG_DESC_STRING
| n_CMD_ARG_DESC_WYSH
,
669 /* - Optional flags */
670 /* It is not an error if an optional argument is missing; once an argument
671 * has been declared optional only optional arguments may follow */
672 n_CMD_ARG_DESC_OPTION
= 1u<<16,
673 /* GREEDY: parse as many of that type as possible; must be last entry */
674 n_CMD_ARG_DESC_GREEDY
= 1u<<17,
675 /* If greedy, join all given arguments separated by ASCII SP right away */
676 n_CMD_ARG_DESC_GREEDY_JOIN
= 1u<<18,
677 /* Honour an overall "stop" request in one of the arguments (\c@ or #) */
678 n_CMD_ARG_DESC_HONOUR_STOP
= 1u<<19,
680 n__CMD_ARG_DESC_FLAG_MASK
= n_CMD_ARG_DESC_OPTION
| n_CMD_ARG_DESC_GREEDY
|
681 n_CMD_ARG_DESC_GREEDY_JOIN
| n_CMD_ARG_DESC_HONOUR_STOP
685 /* We do have several contexts of colour IDs; since only one of them can be
686 * active at any given time let's share the value range */
696 n_COLOUR_ID_SUM_DOTMARK
= 0,
697 n_COLOUR_ID_SUM_HEADER
,
698 n_COLOUR_ID_SUM_THREAD
,
700 /* Message display */
701 n_COLOUR_ID_VIEW_FROM_
= 0,
702 n_COLOUR_ID_VIEW_HEADER
,
703 n_COLOUR_ID_VIEW_MSGINFO
,
704 n_COLOUR_ID_VIEW_PARTINFO
,
706 /* Mailx-Line-Editor */
707 n_COLOUR_ID_MLE_POSITION
= 0,
708 n_COLOUR_ID_MLE_PROMPT
,
710 n__COLOUR_IDS
= n_COLOUR_ID_VIEW_PARTINFO
+ 1
713 /* Colour preconditions, let's call them tags, cannot be an enum because for
714 * message display they are the actual header name of the current header. Thus
715 * let's use constants of pseudo pointers */
716 # define n_COLOUR_TAG_SUM_DOT ((char*)-2)
717 # define n_COLOUR_TAG_SUM_OLDER ((char*)-3)
718 #endif /* HAVE_COLOUR */
721 CONV_NONE
, /* no conversion */
722 CONV_7BIT
, /* no conversion, is 7bit */
723 CONV_FROMQP
, /* convert from quoted-printable */
724 CONV_TOQP
, /* convert to quoted-printable */
725 CONV_8BIT
, /* convert to 8bit (iconv) */
726 CONV_FROMB64
, /* convert from base64 */
727 CONV_FROMB64_T
, /* convert from base64/text */
728 CONV_TOB64
, /* convert to base64 */
729 CONV_FROMHDR
, /* convert from RFC1522 format */
730 CONV_TOHDR
, /* convert to RFC1522 format */
731 CONV_TOHDR_A
/* convert addresses for header */
735 CPROTO_CCRED
, /* Special dummy credential proto (S/MIME etc.) */
736 CPROTO_SOCKS
, /* Special dummy SOCKS5 proxy proto */
742 enum n_dotlock_state
{
744 n_DLS_CANT_CHDIR
, /* Failed to chdir(2) into desired path */
745 n_DLS_NAMETOOLONG
, /* Lock file name would be too long */
746 n_DLS_ROFS
, /* Read-only filesystem (no error, mailbox RO) */
747 n_DLS_NOPERM
, /* No permission to creat lock file */
748 n_DLS_NOEXEC
, /* Privilege separated dotlocker not found */
749 n_DLS_PRIVFAILED
, /* Rising privileges failed in dotlocker */
750 n_DLS_EXIST
, /* Lock file already exists, stale lock? */
751 n_DLS_FISHY
, /* Something makes us think bad of situation */
752 n_DLS_DUNNO
, /* Catch-all error */
753 n_DLS_PING
, /* Not an error, but have to wait for lock */
754 n_DLS_ABANDON
= 1<<7 /* ORd to any but _NONE: give up, don't retry */
757 /* enum n_err_number from mk-config.h, which is in sync with
758 * n_err_to_doc(), n_err_to_name() and n_err_from_name() */
761 n_EXIT_OK
= EXIT_SUCCESS
,
762 n_EXIT_ERR
= EXIT_FAILURE
,
763 n_EXIT_USE
= 64, /* sysexits.h:EX_USAGE */
764 n_EXIT_NOUSER
= 67, /* :EX_NOUSER */
765 n_EXIT_COLL_ABORT
= 1<<1, /* Message collection was aborted */
766 n_EXIT_SEND_ERROR
= 1<<2 /* Unspecified send error occurred */
771 FEDIT_SYSBOX
= 1<<0, /* %: prefix */
772 FEDIT_RDONLY
= 1<<1, /* Readonly (per-box, n_OPT_R_FLAG is global) */
773 FEDIT_NEWMAIL
= 1<<2 /* `newmail' operation TODO OBSOLETE THIS! */
777 FEXP_FULL
, /* Full expansion */
778 FEXP_NOPROTO
= 1<<0, /* TODO no which_protocol() to decide expansion */
779 FEXP_SILENT
= 1<<1, /* Don't print but only return errors */
780 FEXP_MULTIOK
= 1<<2, /* Expansion to many entries is ok */
781 FEXP_LOCAL
= 1<<3, /* Result must be local file/maildir */
782 FEXP_NSHORTCUT
= 1<<4, /* Don't expand shortcuts */
783 FEXP_NSPECIAL
= 1<<5, /* No %,#,& specials */
784 FEXP_NFOLDER
= 1<<6, /* NSPECIAL and no + folder, too */
785 FEXP_NSHELL
= 1<<7, /* Don't do shell word exp. (but ~/, $VAR) */
786 FEXP_NVAR
= 1<<8 /* ..not even $VAR expansion */
789 enum n_file_lock_type
{
794 enum n_fopen_state
{ /* TODO add n_fopen_mode, too */
795 /* First n__PROTO_SHIFT bits are enum protocol! n_MCTA()d below */
796 n_FOPEN_STATE_NONE
= 0,
797 n_FOPEN_STATE_EXISTS
= 1u<<5
800 enum n_go_input_flags
{
802 n_GO_INPUT_CTX_BASE
= 0, /* Generic shared base: don't use! */
803 n_GO_INPUT_CTX_DEFAULT
= 1, /* Default input */
804 n_GO_INPUT_CTX_COMPOSE
= 2, /* Compose mode input */
805 n__GO_INPUT_CTX_MASK
= 3,
806 n__GO_INPUT_CTX_MAX1
= n_GO_INPUT_CTX_COMPOSE
+ 1,
808 n_GO_INPUT_HOLDALLSIGS
= 1u<<8, /* hold_all_sigs() active TODO */
809 /* `xcall' is `call' (at the level where this is set): to be set when
810 * teardown of top level has undesired effects, e.g., for `account's and
811 * folder hooks etc., where we do not to loose our `localopts' unroll list */
812 n_GO_INPUT_NO_XCALL
= 1u<<9,
814 n_GO_INPUT_FORCE_STDIN
= 1u<<10, /* Even in macro, use stdin (`read')! */
815 n_GO_INPUT_NL_ESC
= 1u<<11, /* Support "\\$" line continuation */
816 n_GO_INPUT_NL_FOLLOW
= 1u<<12, /* ..on such a follow line */
817 n_GO_INPUT_PROMPT_NONE
= 1u<<13, /* Don't print prompt */
818 n_GO_INPUT_PROMPT_EVAL
= 1u<<14, /* Instead, evaluate *prompt* */
820 n_GO_INPUT_HIST_ADD
= 1u<<16, /* Add the result to history list */
821 n_GO_INPUT_HIST_GABBY
= 1u<<17, /* Consider history entry as gabby */
826 enum n_go_input_inject_flags
{
827 n_GO_INPUT_INJECT_NONE
= 0,
828 n_GO_INPUT_INJECT_COMMIT
= 1u<<0, /* Auto-commit input */
829 n_GO_INPUT_INJECT_HISTORY
= 1u<<1 /* Allow history addition */
834 n_ICONV_IGN_ILSEQ
= 1<<0, /* Ignore EILSEQ in input (replacement char) */
835 n_ICONV_IGN_NOREVERSE
= 1<<1, /* .. non-reversible conversions in output */
836 n_ICONV_UNIREPL
= 1<<2, /* Use Unicode replacement 0xFFFD = EF BF BD */
837 n_ICONV_DEFAULT
= n_ICONV_IGN_ILSEQ
| n_ICONV_IGN_NOREVERSE
,
838 n_ICONV_UNIDEFAULT
= n_ICONV_DEFAULT
| n_ICONV_UNIREPL
841 /* Special ignore (where _TYPE is covered by POSIX `ignore' / `retain').
842 * _ALL is very special in that it doesn't have a backing object.
843 * Go over enum to avoid cascads of (different) CC warnings for used CTA()s */
844 #define n_IGNORE_ALL ((struct n_ignore*)n__IGNORE_ALL)
845 #define n_IGNORE_TYPE ((struct n_ignore*)n__IGNORE_TYPE)
846 #define n_IGNORE_SAVE ((struct n_ignore*)n__IGNORE_SAVE)
847 #define n_IGNORE_FWD ((struct n_ignore*)n__IGNORE_FWD)
848 #define n_IGNORE_TOP ((struct n_ignore*)n__IGNORE_TOP)
856 n__IGNORE_ADJUST
= 3,
857 n__IGNORE_MAX
= 6 - n__IGNORE_ADJUST
862 n_IDEC_MODE_SIGNED_TYPE
= 1u<<0, /* To choose limits, error constants etc. */
864 n_IDEC_MODE_SIGN_FORCE_SIGNED_TYPE
= 1u<<2,
866 n_IDEC_MODE_LIMIT_8BIT
= 1u<<3, /* Saturate if result exceeds 8-bit */
867 n_IDEC_MODE_LIMIT_16BIT
= 2u<<3,
868 n_IDEC_MODE_LIMIT_32BIT
= 3u<<3,
869 n__IDEC_MODE_LIMIT_MASK
= 3u<<3,
870 n_IDEC_MODE_LIMIT_NOERROR
= 1u<<5, /* Not an error if limit is excessed! */
871 /* These bits are duplicated in the _state result bits! */
872 n__IDEC_MODE_MASK
= (1u<<6) - 1
877 /* Malformed input, no usable result has been stored */
878 n_IDEC_STATE_EINVAL
= 1u<<8,
879 /* Bad character according to base, but we have seen some good before,
880 * otherwise _EINVAL would have been used */
881 n_IDEC_STATE_EBASE
= 2u<<8,
882 n_IDEC_STATE_EOVERFLOW
= 3u<<8, /* Result too large */
883 n_IDEC_STATE_EMASK
= 3u<<8, /* Any errors, that is */
884 n_IDEC_STATE_SEEN_MINUS
= 1u<<16, /* Seen - in input? */
885 n_IDEC_STATE_CONSUMED
= 1u<<17, /* All the input buffer was consumed */
886 n__IDEC_PRIVATE_SHIFT1
= 24u
888 n_MCTA(n__IDEC_MODE_MASK
<= (1u<<8) - 1, "Shared bit range overlaps")
891 MIME_UNKNOWN
, /* unknown content */
892 MIME_SUBHDR
, /* inside a multipart subheader */
893 MIME_822
, /* message/rfc822 content */
894 MIME_MESSAGE
, /* other message/ content */
895 MIME_TEXT_PLAIN
, /* text/plain content */
896 MIME_TEXT_HTML
, /* text/html content */
897 MIME_TEXT
, /* other text/ content */
898 MIME_ALTERNATIVE
, /* multipart/alternative content */
899 MIME_RELATED
, /* mime/related (RFC 2387) */
900 MIME_DIGEST
, /* multipart/digest content */
901 MIME_SIGNED
, /* multipart/signed */
902 MIME_ENCRYPTED
, /* multipart/encrypted */
903 MIME_MULTI
, /* other multipart/ content */
904 MIME_PKCS7
, /* PKCS7 content */
905 MIME_DISCARD
/* content is discarded */
908 enum mime_counter_evidence
{
910 MIMECE_SET
= 1<<0, /* *mime-counter-evidence* was set */
911 MIMECE_BIN_OVWR
= 1<<1, /* appli../octet-stream: check, ovw if possible */
912 MIMECE_ALL_OVWR
= 1<<2, /* all: check, ovw if possible */
913 MIMECE_BIN_PARSE
= 1<<3 /* appli../octet-stream: classify contents last */
916 /* Content-Transfer-Encodings as defined in RFC 2045:
917 * - Quoted-Printable, section 6.7
918 * - Base64, section 6.8 */
919 #define QP_LINESIZE (4 * 19) /* Max. compliant QP linesize */
921 #define B64_LINESIZE (4 * 19) /* Max. compliant Base64 linesize */
922 #define B64_ENCODE_INPUT_PER_LINE ((B64_LINESIZE / 4) * 3)
925 MIMEE_NONE
, /* message is not in MIME format */
926 MIMEE_BIN
, /* message is in binary encoding */
927 MIMEE_8B
, /* message is in 8bit encoding */
928 MIMEE_7B
, /* message is in 7bit encoding */
929 MIMEE_QP
, /* message is quoted-printable */
930 MIMEE_B64
/* message is in base64 encoding */
933 /* xxx QP came later, maybe rewrite all to use mime_enc_flags directly? */
934 enum mime_enc_flags
{
936 MIMEEF_SALLOC
= 1<<0, /* Use salloc(), not srealloc().. */
937 /* ..result .s,.l point to user buffer of *_LINESIZE+[+[+]] bytes instead */
939 MIMEEF_CRLF
= 1<<2, /* (encode) Append "\r\n" to lines */
940 MIMEEF_LF
= 1<<3, /* (encode) Append "\n" to lines */
941 /* (encode) If one of _CRLF/_LF is set, honour *_LINESIZE+[+[+]] and
942 * inject the desired line-ending whenever a linewrap is desired */
943 MIMEEF_MULTILINE
= 1<<4,
944 /* (encode) Quote with header rules, do not generate soft NL breaks?
945 * For mustquote(), specifies whether special RFC 2047 header rules
946 * should be used instead */
947 MIMEEF_ISHEAD
= 1<<5,
948 /* (encode) Ditto; for mustquote() this furtherly fine-tunes behaviour in
949 * that characters which would not be reported as "must-quote" when
950 * detecting whether quoting is necessary at all will be reported as
951 * "must-quote" if they have to be encoded in an encoded word */
952 MIMEEF_ISENCWORD
= 1<<6,
957 QP_NONE
= MIMEEF_NONE
,
958 QP_SALLOC
= MIMEEF_SALLOC
,
960 QP_ISHEAD
= MIMEEF_ISHEAD
,
961 QP_ISENCWORD
= MIMEEF_ISENCWORD
965 B64_NONE
= MIMEEF_NONE
,
966 B64_SALLOC
= MIMEEF_SALLOC
,
967 B64_BUF
= MIMEEF_BUF
,
968 B64_CRLF
= MIMEEF_CRLF
,
970 B64_MULTILINE
= MIMEEF_MULTILINE
,
971 /* Not used, but for clarity only */
972 B64_ISHEAD
= MIMEEF_ISHEAD
,
973 B64_ISENCWORD
= MIMEEF_ISENCWORD
,
974 /* Special version of Base64, "Base64URL", according to RFC 4648.
975 * Only supported for encoding! */
976 B64_RFC4648URL
= 1<<(__MIMEEF_LAST
+1),
977 /* Don't use any ("=") padding;
978 * may NOT be used with any of _CRLF, _LF or _MULTILINE */
979 B64_NOPAD
= 1<<(__MIMEEF_LAST
+2)
982 enum mime_parse_flags
{
984 MIME_PARSE_DECRYPT
= 1<<0,
985 MIME_PARSE_PARTS
= 1<<1,
986 MIME_PARSE_SHALLOW
= 1<<2
989 enum mime_handler_flags
{
990 MIME_HDL_NULL
, /* No pipe- mimetype handler, go away */
991 MIME_HDL_CMD
, /* Normal command */
992 MIME_HDL_TEXT
, /* @ special cmd to force treatment as text */
993 MIME_HDL_PTF
, /* A special pointer-to-function handler */
994 MIME_HDL_MSG
, /* Display msg (returned as command string) */
995 MIME_HDL_TYPE_MASK
= 7u,
996 MIME_HDL_COPIOUSOUTPUT
= 1u<<4, /* _CMD produces reintegratable text */
997 MIME_HDL_ISQUOTE
= 1u<<5, /* Is quote action (we have info, keep it!) */
998 MIME_HDL_NOQUOTE
= 1u<<6, /* No MIME for quoting */
999 MIME_HDL_ASYNC
= 1u<<7, /* Should run asynchronously */
1000 MIME_HDL_NEEDSTERM
= 1u<<8, /* Takes over terminal */
1001 MIME_HDL_TMPF
= 1u<<9, /* Create temporary file (zero-sized) */
1002 MIME_HDL_TMPF_FILL
= 1u<<10, /* Fill in the msg body content */
1003 MIME_HDL_TMPF_UNLINK
= 1u<<11 /* Delete it later again */
1007 MLIST_OTHER
= 0, /* Normal address */
1008 MLIST_KNOWN
= 1, /* A known `mlist' */
1009 MLIST_SUBSCRIBED
= -1 /* A `mlsubscribe'd list */
1020 OF_CLOEXEC
= 1<<7, /* TODO not used, always implied! CHANGE!! */
1021 OF_UNLINK
= 1<<8, /* Only for Ftmp(): unlink(2) after creation */
1022 OF_HOLDSIGS
= 1<<9, /* Mutual with OF_UNLINK - await Ftmp_free() */
1023 OF_REGISTER
= 1<<10, /* Register file in our file table */
1024 OF_REGISTER_UNLINK
= 1<<11, /* unlink(2) upon unreg.; _REGISTER asserted! */
1025 OF_SUFFIX
= 1<<12 /* Ftmp() name hint is mandatory! extension! */
1033 enum okey_xlook_mode
{
1034 OXM_PLAIN
= 1<<0, /* Plain key always tested */
1035 OXM_H_P
= 1<<1, /* Check PLAIN-.url_h_p */
1036 OXM_U_H_P
= 1<<2, /* Check PLAIN-.url_u_h_p */
1040 /* <0 means "stop" unless *prompt* extensions are enabled. */
1042 PROMPT_STOP
= -1, /* \c */
1043 /* *prompt* extensions: \$, \@ etc. */
1050 n_PROTO_FILE
, /* refers to a local file */
1051 PROTO_FILE
= n_PROTO_FILE
,
1052 n_PROTO_POP3
, /* is a pop3 server string */
1053 PROTO_POP3
= n_PROTO_POP3
,
1055 PROTO_IMAP
= n_PROTO_IMAP
,
1056 n_PROTO_MAILDIR
, /* refers to a maildir folder */
1057 PROTO_MAILDIR
= n_PROTO_MAILDIR
,
1058 n_PROTO_UNKNOWN
, /* unknown protocol */
1059 PROTO_UNKNOWN
= n_PROTO_UNKNOWN
,
1061 n__PROTO_SHIFT
= n_PROTO_UNKNOWN
,
1062 n_PROTO_MASK
= (1u << n__PROTO_SHIFT
) - 1
1064 n_MCTA(n__PROTO_SHIFT
== 5, "enum n_fopen_state shift value must be adjusted!")
1067 SEND_MBOX
, /* no conversion to perform */
1068 SEND_RFC822
, /* no conversion, no From_ line */
1069 SEND_TODISP
, /* convert to displayable form */
1070 SEND_TODISP_ALL
, /* same, include all MIME parts */
1071 SEND_TODISP_PARTS
, /* same, but only interactive, user-selected parts */
1072 SEND_SHOW
, /* convert to 'show' command form */
1073 SEND_TOSRCH
, /* convert for IMAP SEARCH */
1074 SEND_TOFILE
, /* convert for saving body to a file */
1075 SEND_TOPIPE
, /* convert for pipe-content/subc. */
1076 SEND_QUOTE
, /* convert for quoting */
1077 SEND_QUOTE_ALL
, /* same, include all MIME parts */
1078 SEND_DECRYPT
/* decrypt */
1081 enum n_shexp_parse_flags
{
1083 /* Don't perform expansions or interpret reverse solidus escape sequences.
1084 * Output may be NULL, otherwise the possibly trimmed non-expanded input is
1085 * used as output (implies _PARSE_META_KEEP) */
1086 n_SHEXP_PARSE_DRYRUN
= 1u<<0,
1087 n_SHEXP_PARSE_TRUNC
= 1u<<1, /* Truncate result storage on entry */
1088 n_SHEXP_PARSE_TRIM_SPACE
= 1u<<2, /* ..surrounding tokens */
1089 n_SHEXP_PARSE_TRIM_IFSSPACE
= 1u<<3, /* " */
1090 n_SHEXP_PARSE_LOG
= 1u<<4, /* Log errors */
1091 n_SHEXP_PARSE_LOG_D_V
= 1u<<5, /* Log errors if n_PO_D_V */
1092 n_SHEXP_PARSE_IFS_VAR
= 1u<<6, /* IFS is *ifs*, not blankchar() */
1093 n_SHEXP_PARSE_IFS_ADD_COMMA
= 1u<<7, /* Add comma , to normal "IFS" */
1094 n_SHEXP_PARSE_IFS_IS_COMMA
= 1u<<8, /* Let comma , be the sole "IFS" */
1095 n_SHEXP_PARSE_IGNORE_EMPTY
= 1u<<9, /* Ignore empty tokens, start over */
1097 /* Implicitly open quotes, and ditto closing. _AUTO_FIXED may only be used
1098 * if an auto-quote-mode is enabled, implies _AUTO_CLOSE and causes the
1099 * quote mode to be permanently active (cannot be closed) */
1100 n_SHEXP_PARSE_QUOTE_AUTO_FIXED
= 1u<<16,
1101 n_SHEXP_PARSE_QUOTE_AUTO_SQ
= 1u<<17,
1102 n_SHEXP_PARSE_QUOTE_AUTO_DQ
= 1u<<18,
1103 n_SHEXP_PARSE_QUOTE_AUTO_DSQ
= 1u<<19,
1104 n_SHEXP_PARSE_QUOTE_AUTO_CLOSE
= 1u<<20, /* Ignore an open quote at EOS */
1105 n__SHEXP_PARSE_QUOTE_AUTO_MASK
= n_SHEXP_PARSE_QUOTE_AUTO_SQ
|
1106 n_SHEXP_PARSE_QUOTE_AUTO_DQ
| n_SHEXP_PARSE_QUOTE_AUTO_DSQ
,
1108 /* Recognize metacharacters to separate tokens */
1109 n_SHEXP_PARSE_META_VERTBAR
= 1u<<21,
1110 n_SHEXP_PARSE_META_AMPERSAND
= 1u<<22,
1111 /* Interpret ; as a sequencing operator, go_input_inject() remainder */
1112 n_SHEXP_PARSE_META_SEMICOLON
= 1u<<23,
1113 /* LPAREN, RPAREN, LESSTHAN, GREATERTHAN */
1115 n_SHEXP_PARSE_META_MASK
= n_SHEXP_PARSE_META_VERTBAR
|
1116 n_SHEXP_PARSE_META_AMPERSAND
| n_SHEXP_PARSE_META_SEMICOLON
,
1118 /* Keep the metacharacter (or IFS character), do not skip over it */
1119 n_SHEXP_PARSE_META_KEEP
= 1u<<24,
1121 n__SHEXP_PARSE_LAST
= 24
1126 /* We have produced some output (or would have, with _PARSE_DRYRUN).
1127 * Note that empty quotes like '' produce no output but set this bit */
1128 n_SHEXP_STATE_OUTPUT
= 1u<<0,
1129 /* Don't call the parser again (# comment seen; out of input).
1130 * Not (necessarily) mutual with _OUTPUT) */
1131 n_SHEXP_STATE_STOP
= 1u<<1,
1132 n_SHEXP_STATE_UNICODE
= 1u<<2, /* \[Uu] used */
1133 n_SHEXP_STATE_CONTROL
= 1u<<3, /* Control characters seen */
1134 n_SHEXP_STATE_QUOTE
= 1u<<4, /* Any quotes seen */
1135 n_SHEXP_STATE_WS_LEAD
= 1u<<5, /* _TRIM_{IFS,}SPACE: seen.. */
1136 n_SHEXP_STATE_WS_TRAIL
= 1u<<6, /* .. leading / trailing WS */
1137 n_SHEXP_STATE_META_VERTBAR
= 1u<<7, /* Metacharacter | follows/ed */
1138 n_SHEXP_STATE_META_AMPERSAND
= 1u<<8, /* Metacharacter & follows/ed */
1139 n_SHEXP_STATE_META_SEMICOLON
= 1u<<9, /* Metacharacter ; follows/ed */
1141 n_SHEXP_STATE_META_MASK
= n_SHEXP_STATE_META_VERTBAR
|
1142 n_SHEXP_STATE_META_AMPERSAND
| n_SHEXP_STATE_META_SEMICOLON
,
1144 n_SHEXP_STATE_ERR_CONTROL
= 1u<<16, /* \c notation with invalid arg. */
1145 n_SHEXP_STATE_ERR_UNICODE
= 1u<<17, /* Valid \[Uu] and !n_PSO_UNICODE */
1146 n_SHEXP_STATE_ERR_NUMBER
= 1u<<18, /* Bad number (\[UuXx]) */
1147 n_SHEXP_STATE_ERR_BRACE
= 1u<<19, /* _QUOTEOPEN + no } brace 4 ${VAR */
1148 n_SHEXP_STATE_ERR_IDENTIFIER
= 1u<<20, /* Invalid identifier */
1149 n_SHEXP_STATE_ERR_BADSUB
= 1u<<21, /* Empty/bad ${} substitution */
1150 n_SHEXP_STATE_ERR_QUOTEOPEN
= 1u<<22, /* Quote remains open at EOS */
1152 n_SHEXP_STATE_ERR_MASK
= n_BITENUM_MASK(16, 22)
1155 enum n_sigman_flags
{
1157 n_SIGMAN_HUP
= 1<<0,
1158 n_SIGMAN_INT
= 1<<1,
1159 n_SIGMAN_QUIT
= 1<<2,
1160 n_SIGMAN_TERM
= 1<<3,
1161 n_SIGMAN_PIPE
= 1<<4,
1163 n_SIGMAN_IGN_HUP
= 1<<5,
1164 n_SIGMAN_IGN_INT
= 1<<6,
1165 n_SIGMAN_IGN_QUIT
= 1<<7,
1166 n_SIGMAN_IGN_TERM
= 1<<8,
1168 n_SIGMAN_ALL
= 0xFF,
1169 /* Mostly for _leave() reraise flags */
1170 n_SIGMAN_VIPSIGS
= n_SIGMAN_HUP
| n_SIGMAN_INT
| n_SIGMAN_QUIT
|
1172 n_SIGMAN_NTTYOUT_PIPE
= 1<<16,
1173 n_SIGMAN_VIPSIGS_NTTYOUT
= n_SIGMAN_HUP
| n_SIGMAN_INT
| n_SIGMAN_QUIT
|
1174 n_SIGMAN_TERM
| n_SIGMAN_NTTYOUT_PIPE
,
1176 n__SIGMAN_PING
= 1<<17
1180 enum ssl_verify_level
{
1188 enum n_str_trim_flags
{
1189 n_STR_TRIM_FRONT
= 1u<<0,
1190 n_STR_TRIM_END
= 1u<<1,
1191 n_STR_TRIM_BOTH
= n_STR_TRIM_FRONT
| n_STR_TRIM_END
1195 TD_NONE
, /* no display conversion */
1196 TD_ISPR
= 1<<0, /* use isprint() checks */
1197 TD_ICONV
= 1<<1, /* use iconv() */
1198 TD_DELCTRL
= 1<<2, /* delete control characters */
1201 * NOTE: _TD_EOF and _TD_BUFCOPY may be ORd with enum conversion and
1202 * enum sendaction, and may thus NOT clash with their bit range!
1204 _TD_EOF
= 1<<14, /* EOF seen, last round! */
1205 _TD_BUFCOPY
= 1<<15 /* Buffer may be constant, copy it */
1209 enum n_termcap_captype
{
1210 n_TERMCAP_CAPTYPE_NONE
= 0,
1211 /* Internally we share the bitspace, so ensure no value ends up as 0 */
1212 n_TERMCAP_CAPTYPE_BOOL
= 1,
1213 n_TERMCAP_CAPTYPE_NUMERIC
,
1214 n_TERMCAP_CAPTYPE_STRING
,
1215 n__TERMCAP_CAPTYPE_MAX1
1218 /* Termcap commands; different to queries commands perform actions.
1219 * Commands are resolved upon init time, and are all termcap(5)-compatible,
1220 * therefore we use the short termcap(5) names.
1221 * Note this is parsed by make-tcap-map.pl, which expects the syntax
1222 * "CONSTANT, COMMENT" where COMMENT is "Capname/TCap-Code, TYPE[, FLAGS]",
1223 * and one of Capname and TCap-Code may be the string "-" meaning ENOENT;
1224 * a | vertical bar or end-of-comment ends processing; see termcap.c.
1225 * We may use the free-form part after | for the "Variable String" and notes on
1226 * necessary termcap_cmd() arguments; if those are in [] brackets they are not
1227 * regular but are only used when the command, i.e., its effect, is somehow
1228 * simulated / faked by a built-in fallback implementation.
1229 * Availability of built-in fallback indicated by leading @ (at-sign) */
1231 # ifdef HAVE_TERMCAP
1232 n_TERMCAP_CMD_te
, /* rmcup/te, STRING | exit_ca_mode: -,- */
1233 n_TERMCAP_CMD_ti
, /* smcup/ti, STRING | enter_ca_mode: -,- */
1235 n_TERMCAP_CMD_ks
, /* smkx/ks, STRING | keypad_xmit: -,- */
1236 n_TERMCAP_CMD_ke
, /* rmkx/ke, STRING | keypad_local: -,- */
1238 n_TERMCAP_CMD_cd
, /* ed/cd, STRING | clr_eos: -,- */
1239 n_TERMCAP_CMD_cl
, /* clear/cl, STRING | clear_screen(+home): -,- */
1240 n_TERMCAP_CMD_ho
, /* home/ho, STRING | cursor_home: -,- */
1244 n_TERMCAP_CMD_ce
, /* el/ce, STRING | @ clr_eol: [start-column],- */
1245 n_TERMCAP_CMD_ch
, /* hpa/ch, STRING, IDX1 | column_address: column,- */
1246 n_TERMCAP_CMD_cr
, /* cr/cr, STRING | @ carriage_return: -,- */
1247 n_TERMCAP_CMD_le
, /* cub1/le, STRING, CNT | @ cursor_left: count,- */
1248 n_TERMCAP_CMD_nd
, /* cuf1/nd, STRING, CNT | @ cursor_right: count,- */
1251 n__TERMCAP_CMD_MAX1
,
1252 n__TERMCAP_CMD_MASK
= (1<<24) - 1,
1254 /* Only perform command if ca-mode is used */
1255 n_TERMCAP_CMD_FLAG_CA_MODE
= 1<<29,
1256 /* I/O should be flushed after command completed */
1257 n_TERMCAP_CMD_FLAG_FLUSH
= 1<<30
1260 /* Termcap queries; a query is a command that returns a struct n_termcap_value.
1261 * Queries are resolved once they are used first, and may not be termcap(5)-
1262 * compatible, therefore we use terminfo(5) names.
1263 * Note this is parsed by make-tcap-map.pl, which expects the syntax
1264 * "CONSTANT, COMMENT" where COMMENT is "Capname/TCap-Code, TYPE[, FLAGS]",
1265 * and one of Capname and TCap-Code may be the string "-" meaning ENOENT;
1266 * a | vertical bar or end-of-comment ends processing; see termcap.c.
1267 * We may use the free-form part after | for the "Variable String" and notes.
1268 * The "xkey | X:" keys are Dickey's xterm extensions, see (our) manual */
1269 enum n_termcap_query
{
1271 n_TERMCAP_QUERY_colors
, /* colors/Co, NUMERIC | max_colors */
1274 /* --make-tcap-map--: only KEY_BINDINGS follow. DON'T CHANGE THIS LINE! */
1275 /* Update the `bind' manual on change! */
1276 # ifdef HAVE_KEY_BINDINGS
1277 n_TERMCAP_QUERY_key_backspace
, /* kbs/kb, STRING */
1278 n_TERMCAP_QUERY_key_dc
, /* kdch1/kD, STRING | delete-character */
1279 n_TERMCAP_QUERY_key_sdc
, /* kDC / *4, STRING | ..shifted */
1280 n_TERMCAP_QUERY_key_eol
, /* kel/kE, STRING | clear-to-end-of-line */
1281 n_TERMCAP_QUERY_key_exit
, /* kext/@9, STRING */
1282 n_TERMCAP_QUERY_key_ic
, /* kich1/kI, STRING | insert character */
1283 n_TERMCAP_QUERY_key_sic
, /* kIC/#3, STRING | ..shifted */
1284 n_TERMCAP_QUERY_key_home
, /* khome/kh, STRING */
1285 n_TERMCAP_QUERY_key_shome
, /* kHOM/#2, STRING | ..shifted */
1286 n_TERMCAP_QUERY_key_end
, /* kend/@7, STRING */
1287 n_TERMCAP_QUERY_key_send
, /* kEND / *7, STRING | ..shifted */
1288 n_TERMCAP_QUERY_key_npage
, /* knp/kN, STRING */
1289 n_TERMCAP_QUERY_key_ppage
, /* kpp/kP, STRING */
1290 n_TERMCAP_QUERY_key_left
, /* kcub1/kl, STRING */
1291 n_TERMCAP_QUERY_key_sleft
, /* kLFT/#4, STRING | ..shifted */
1292 n_TERMCAP_QUERY_xkey_aleft
, /* kLFT3/-, STRING | X: Alt+left */
1293 n_TERMCAP_QUERY_xkey_cleft
, /* kLFT5/-, STRING | X: Control+left */
1294 n_TERMCAP_QUERY_key_right
, /* kcuf1/kr, STRING */
1295 n_TERMCAP_QUERY_key_sright
, /* kRIT/%i, STRING | ..shifted */
1296 n_TERMCAP_QUERY_xkey_aright
, /* kRIT3/-, STRING | X: Alt+right */
1297 n_TERMCAP_QUERY_xkey_cright
, /* kRIT5/-, STRING | X: Control+right */
1298 n_TERMCAP_QUERY_key_down
, /* kcud1/kd, STRING */
1299 n_TERMCAP_QUERY_xkey_sdown
, /* kDN/-, STRING | ..shifted */
1300 n_TERMCAP_QUERY_xkey_adown
, /* kDN3/-, STRING | X: Alt+down */
1301 n_TERMCAP_QUERY_xkey_cdown
, /* kDN5/-, STRING | X: Control+down */
1302 n_TERMCAP_QUERY_key_up
, /* kcuu1/ku, STRING */
1303 n_TERMCAP_QUERY_xkey_sup
, /* kUP/-, STRING | ..shifted */
1304 n_TERMCAP_QUERY_xkey_aup
, /* kUP3/-, STRING | X: Alt+up */
1305 n_TERMCAP_QUERY_xkey_cup
, /* kUP5/-, STRING | X: Control+up */
1306 n_TERMCAP_QUERY_kf0
, /* kf0/k0, STRING */
1307 n_TERMCAP_QUERY_kf1
, /* kf1/k1, STRING */
1308 n_TERMCAP_QUERY_kf2
, /* kf2/k2, STRING */
1309 n_TERMCAP_QUERY_kf3
, /* kf3/k3, STRING */
1310 n_TERMCAP_QUERY_kf4
, /* kf4/k4, STRING */
1311 n_TERMCAP_QUERY_kf5
, /* kf5/k5, STRING */
1312 n_TERMCAP_QUERY_kf6
, /* kf6/k6, STRING */
1313 n_TERMCAP_QUERY_kf7
, /* kf7/k7, STRING */
1314 n_TERMCAP_QUERY_kf8
, /* kf8/k8, STRING */
1315 n_TERMCAP_QUERY_kf9
, /* kf9/k9, STRING */
1316 n_TERMCAP_QUERY_kf10
, /* kf10/k;, STRING */
1317 n_TERMCAP_QUERY_kf11
, /* kf11/F1, STRING */
1318 n_TERMCAP_QUERY_kf12
, /* kf12/F2, STRING */
1319 n_TERMCAP_QUERY_kf13
, /* kf13/F3, STRING */
1320 n_TERMCAP_QUERY_kf14
, /* kf14/F4, STRING */
1321 n_TERMCAP_QUERY_kf15
, /* kf15/F5, STRING */
1322 n_TERMCAP_QUERY_kf16
, /* kf16/F6, STRING */
1323 n_TERMCAP_QUERY_kf17
, /* kf17/F7, STRING */
1324 n_TERMCAP_QUERY_kf18
, /* kf18/F8, STRING */
1325 n_TERMCAP_QUERY_kf19
, /* kf19/F9, STRING */
1326 # endif /* HAVE_KEY_BINDINGS */
1328 n__TERMCAP_QUERY_MAX1
1330 #endif /* n_HAVE_TCAP */
1333 n_URL_TLS_REQUIRED
= 1<<0, /* Whether protocol always uses SSL/TLS.. */
1334 n_URL_TLS_OPTIONAL
= 1<<1, /* ..may later upgrade to SSL/TLS */
1335 n_URL_TLS_MASK
= n_URL_TLS_REQUIRED
| n_URL_TLS_OPTIONAL
,
1336 n_URL_HAD_USER
= 1<<2, /* Whether .url_user was part of the URL */
1337 n_URL_HOST_IS_NAME
= 1<<3 /* .url_host not numeric address */
1340 enum n_visual_info_flags
{
1342 n_VISUAL_INFO_ONE_CHAR
= 1<<0, /* Step only one char, then return */
1343 n_VISUAL_INFO_SKIP_ERRORS
= 1<<1, /* Treat via replacement, step byte */
1344 n_VISUAL_INFO_WIDTH_QUERY
= 1<<2, /* Detect visual character widths */
1346 /* Rest only with HAVE_C90AMEND1, mutual with _ONE_CHAR */
1347 n_VISUAL_INFO_WOUT_CREATE
= 1<<8, /* Use/create .vic_woudat */
1348 n_VISUAL_INFO_WOUT_SALLOC
= 1<<9, /* ..salloc() it first */
1349 /* Only visuals into .vic_woudat - implies _WIDTH_QUERY */
1350 n_VISUAL_INFO_WOUT_PRINTABLE
= 1<<10,
1351 n__VISUAL_INFO_FLAGS
= n_VISUAL_INFO_WOUT_CREATE
|
1352 n_VISUAL_INFO_WOUT_SALLOC
| n_VISUAL_INFO_WOUT_PRINTABLE
1355 enum n_program_option
{
1356 n_PO_DEBUG
= 1u<<0, /* -d / *debug* */
1357 n_PO_VERB
= 1u<<1, /* -v / *verbose* */
1358 n_PO_VERBVERB
= 1u<<2, /* .. even more verbosity */
1359 n_PO_EXISTONLY
= 1u<<3, /* -e */
1360 n_PO_HEADERSONLY
= 1u<<4, /* -H */
1361 n_PO_HEADERLIST
= 1u<<5, /* -L */
1362 n_PO_QUICKRUN_MASK
= n_PO_EXISTONLY
| n_PO_HEADERSONLY
| n_PO_HEADERLIST
,
1363 n_PO_E_FLAG
= 1u<<6, /* -E / *skipemptybody* */
1364 n_PO_F_FLAG
= 1u<<7, /* -F */
1365 n_PO_Mm_FLAG
= 1u<<8, /* -M or -m (plus n_poption_arg_Mm) */
1366 n_PO_R_FLAG
= 1u<<9, /* -R */
1367 n_PO_r_FLAG
= 1u<<10, /* -r (plus n_poption_arg_r) */
1368 n_PO_t_FLAG
= 1u<<11, /* -t */
1369 n_PO_TILDE_FLAG
= 1u<<12, /* -~ */
1370 n_PO_BATCH_FLAG
= 1u<<13, /* -# */
1373 n_PO_MEMDEBUG
= 1<<24, /* *memdebug* */
1375 /* Some easy-access shortcuts */
1376 n_PO_D_V
= n_PO_DEBUG
| n_PO_VERB
,
1377 n_PO_D_VV
= n_PO_DEBUG
| n_PO_VERBVERB
,
1378 n_PO_D_V_VV
= n_PO_DEBUG
| n_PO_VERB
| n_PO_VERBVERB
1381 #define n_OBSOLETE(X) \
1383 if(n_poption & n_PO_D_V_VV)\
1384 n_err("%s: %s\n", _("Obsoletion warning"), X);\
1386 #define n_OBSOLETE2(X,Y) \
1388 if(n_poption & n_PO_D_V_VV)\
1389 n_err("%s: %s: %s\n", _("Obsoletion warning"), X, Y);\
1392 /* Program state bits which may regulary fluctuate */
1393 enum n_program_state
{
1394 n_PS_ROOT
= 1u<<30, /* Temporary "bypass any checks" bit */
1395 #define n_PS_ROOT_BLOCK(ACT) \
1397 bool_t a___reset___ = !(n_pstate & n_PS_ROOT);\
1398 n_pstate |= n_PS_ROOT;\
1401 n_pstate &= ~n_PS_ROOT;\
1404 /* XXX These are internal to the state machine and do not belong here,
1405 * XXX yet this was the easiest (accessible) approach */
1406 n_PS_ERR_XIT
= 1u<<0, /* Unless `ignerr' seen -> n_PSO_XIT */
1407 n_PS_ERR_QUIT
= 1u<<1, /* ..ditto: -> n_PSO_QUIT */
1408 n_PS_ERR_EXIT_MASK
= n_PS_ERR_XIT
| n_PS_ERR_QUIT
,
1410 n_PS_SOURCING
= 1u<<2, /* During load() or `source' */
1411 n_PS_ROBOT
= 1u<<3, /* .. even more robotic */
1412 n_PS_COMPOSE_MODE
= 1u<<4, /* State machine recursed */
1413 n_PS_COMPOSE_FORKHOOK
= 1u<<5, /* A hook running in a subprocess */
1415 n_PS_HOOK_NEWMAIL
= 1u<<7,
1417 n_PS_HOOK_MASK
= n_PS_HOOK_NEWMAIL
| n_PS_HOOK
,
1419 n_PS_EDIT
= 1u<<9, /* Current mailbox no "system mailbox" */
1420 n_PS_SETFILE_OPENED
= 1u<<10, /* (hack) setfile() opened a new box */
1421 n_PS_SAW_COMMAND
= 1u<<11, /* ..after mailbox switch */
1422 n_PS_DID_PRINT_DOT
= 1u<<12, /* Current message has been printed */
1424 n_PS_SIGWINCH_PEND
= 1u<<13, /* Need update of $COLUMNS/$LINES */
1425 n_PS_PSTATE_PENDMASK
= n_PS_SIGWINCH_PEND
, /* pstate housekeeping needed */
1427 n_PS_ARGLIST_MASK
= n_BITENUM_MASK(14, 16),
1428 n_PS_ARGMOD_VPUT
= 1u<<16, /* "vput" modifier TODO struct CmdCtx */
1429 n_PS_MSGLIST_GABBY
= 1u<<14, /* getmsglist() saw something gabby */
1430 n_PS_MSGLIST_DIRECT
= 1u<<15, /* A msg was directly chosen by number */
1431 /* TODO HACK: until v15 PS_MSGLIST_SAW_NO is an indication whether an entry
1432 * TODO may be placed in the history or not (grep this, see commands()),
1433 * TODO so avoid reusing this bit */
1434 n_PS_WYSHLIST_SAW_CONTROL
= 1u<<15, /* ..saw C0+ control characters */
1436 n_PS_EXPAND_MULTIRESULT
= 1u<<17, /* Last fexpand() with MULTIOK had .. */
1437 n_PS_ERRORS_PROMPT
= 1u<<18, /* New error to be reported in prompt */
1440 n_PS_HEADER_NEEDED_MIME
= 1u<<24, /* mime_write_tohdr() not ASCII clean */
1441 n_PS_READLINE_NL
= 1u<<25, /* readline_input()+ saw a \n */
1442 n_PS_BASE64_STRIP_CR
= 1u<<26 /* Go for text output, strip CR's */
1445 /* Various states set once, and first time messages or initializers */
1446 enum n_program_state_once
{
1447 /* Exit request pending (quick) */
1450 n_PSO_EXIT_MASK
= n_PSO_XIT
| n_PSO_QUIT
,
1453 n_PSO_SENDMODE
= 1u<<2,
1454 n_PSO_INTERACTIVE
= 1u<<3,
1455 n_PSO_TTYIN
= 1u<<4,
1456 n_PSO_TTYOUT
= 1u<<5, /* TODO should be TTYERR! */
1458 n_PSO_BIG_ENDIAN
= 1u<<8,
1459 n_PSO_UNICODE
= 1u<<9,
1460 n_PSO_ENC_MBSTATE
= 1u<<10,
1462 n_PSO_REPRODUCIBLE
= 1u<<14,
1464 /* main.c startup code passed, we are functional! */
1465 n_PSO_STARTED
= 1u<<15,
1467 /* (Likely) Post _STARTED */
1468 n_PSO_ATTACH_QUOTE_NOTED
= 1u<<16,
1469 n_PSO_ERRORS_NOTED
= 1u<<17,
1470 n_PSO_TERMCAP_DISABLE
= 1u<<18,
1471 n_PSO_TERMCAP_CA_MODE
= 1u<<19,
1472 n_PSO_LINE_EDITOR_INIT
= 1u<<20,
1473 n_PSO_RANDOM_INIT
= 1u<<21,
1475 /* A subtile hack which works in conjunction with n_OPT_t_FLAG so as to
1476 * allow to have multiple states regarding the related header setup */
1477 n_PSO_t_FLAG
= 1u<<30
1480 /* {{{ A large enum with all the boolean and value options a.k.a their keys.
1481 * Only the constant keys are in here, to be looked up via ok_[bv]look(),
1482 * ok_[bv]set() and ok_[bv]clear().
1483 * Variable properties are placed in {PROP=VALUE[:,PROP=VALUE:]} comments,
1484 * a {\} comment causes the next line to be read for (overlong) properties.
1486 * - see the comments in accmacvar.c before changing *anything* in here!
1487 * - virt= implies rdonly,nodel
1488 * - import= implies env
1489 * - num and posnum are mutual exclusive
1490 * - most default VAL_ues come from in from build system via ./make.rc
1491 * (Keep in SYNC: ./nail.h:okeys, ./nail.rc, ./nail.1:"Initial settings") */
1493 /* This is used for all macro(-local) variables etc., i.e.,
1494 * [*@#]|[1-9][0-9]*, in order to have something with correct properties.
1495 * It is also used for the ${^.+} multiplexer */
1496 ok_v___special_param
, /* {nolopts=1,rdonly=1,nodel=1} */
1497 /*__qm/__em aka ?/! should be num=1 but that more expensive than what now */
1498 ok_v___qm
, /* {name=?,nolopts=1,rdonly=1,nodel=1} */
1499 ok_v___em
, /* {name=!,nolopts=1,rdonly=1,nodel=1} */
1501 ok_v_account
, /* {nolopts=1,rdonly=1,nodel=1} */
1502 ok_b_add_file_recipients
,
1503 ok_v_agent_shell_lookup
,
1506 /* *ask* is auto-mapped to *asksub* as imposed by standard! */
1507 ok_b_ask
, /* {vip=1} */
1513 ok_b_asksub
, /* {i3val=TRU1} */
1523 ok_b_batch_exit_on_error
,
1524 ok_v_bind_timeout
, /* {notempty=1,posnum=1} */
1531 ok_v_build_os
, /* {virt=VAL_BUILD_OS} */
1532 ok_v_build_osenv
, /* {virt=VAL_BUILD_OSENV} */
1534 ok_v_COLUMNS
, /* {notempty=1,posnum=1,env=1} */
1535 ok_v_charset_7bit
, /* {lower=1,notempty=1,defval=CHARSET_7BIT} */
1536 /* But unused without HAVE_ICONV, we use ok_vlook(CHARSET_8BIT_OKEY)! */
1537 ok_v_charset_8bit
, /* {lower=1,notempty=1,defval=CHARSET_8BIT} */
1538 ok_v_charset_unknown_8bit
, /* {lower=1} */
1540 ok_b_colour_disable
,
1542 ok_v_contact_mail
, /* {virt=VAL_CONTACT_MAIL} */
1543 ok_v_contact_web
, /* {virt=VAL_CONTACT_WEB} */
1544 ok_v_crt
, /* {posnum=1} */
1545 ok_v_customhdr
, /* {nocntrls=1} */
1547 ok_v_DEAD
, /* {notempty=1,env=1,defval=VAL_DEAD} */
1548 ok_v_datefield
, /* {i3val="%Y-%m-%d %H:%M"} */
1549 ok_v_datefield_markout_older
, /* {i3val="%Y-%m-%d"} */
1550 ok_b_debug
, /* {vip=1} */
1551 ok_b_disposition_notification_send
,
1553 ok_b_dotlock_ignore_error
,
1555 ok_v_EDITOR
, /* {env=1,notempty=1,defval=VAL_EDITOR} */
1561 ok_v_escape
, /* {defval=n_ESCAPE} */
1565 ok_v_features
, /* {virt=VAL_FEATURES} */
1567 ok_v_folder
, /* {vip=1} */
1568 ok_v_folder_resolved
, /* {rdonly=1,nodel=1} */
1571 ok_v_followup_to_honour
,
1572 ok_b_forward_as_attachment
,
1573 ok_v_forward_inject_head
,
1578 ok_v_HOME
, /* {vip=1,nodel=1,notempty=1,import=1} */
1579 ok_b_header
, /* {i3val=TRU1} */
1584 ok_b_history_gabby_persist
,
1585 ok_v_history_size
, /* {notempty=1,posnum=1} */
1590 ok_v_ifs
, /* {vip=1,defval=" \t\n"} */
1591 ok_v_ifs_ws
, /* {vip=1,rdonly=1,nodel=1,i3val=" \t\n"} */
1598 ok_b_keep_content_length
,
1601 ok_v_LANG
, /* {vip=1,env=1,notempty=1} */
1602 ok_v_LC_ALL
, /* {name=LC_ALL,vip=1,env=1,notempty=1} */
1603 ok_v_LC_CTYPE
, /* {name=LC_CTYPE,vip=1,env=1,notempty=1} */
1604 ok_v_LINES
, /* {notempty=1,posnum=1,env=1} */
1605 ok_v_LISTER
, /* {env=1,notempty=1,defval=VAL_LISTER} */
1606 ok_v_LOGNAME
, /* {rdonly=1,import=1} */
1607 ok_b_line_editor_disable
,
1608 ok_b_line_editor_no_defaults
,
1609 ok_v_log_prefix
, /* {nodel=1,i3val=VAL_UAGENT ": "} */
1611 ok_v_MAIL
, /* {env=1} */
1612 ok_v_MAILRC
, /* {import=1,notempty=1,defval=VAL_MAILRC} */
1613 ok_b_MAILX_NO_SYSTEM_RC
, /* {name=MAILX_NO_SYSTEM_RC,import=1} */
1614 ok_v_MBOX
, /* {env=1,notempty=1,defval=VAL_MBOX} */
1615 ok_v_mailbox_resolved
, /* {nolopts=1,rdonly=1,nodel=1} */
1616 ok_v_mailbox_display
, /* {nolopts=1,rdonly=1,nodel=1} */
1617 ok_v_mailx_extra_rc
,
1620 ok_b_memdebug
, /* {vip=1} */
1621 ok_b_message_id_disable
,
1622 ok_v_message_inject_head
,
1623 ok_v_message_inject_tail
,
1625 ok_b_mime_allow_text_controls
,
1626 ok_b_mime_alternative_favour_rich
,
1627 ok_v_mime_counter_evidence
, /* {posnum=1} */
1629 ok_v_mimetypes_load_control
,
1630 ok_v_mta
, /* {notempty=1,defval=VAL_MTA} */
1632 ok_b_mta_no_default_arguments
,
1633 ok_v_mta_argv0
, /* {notempty=1,defval=VAL_MTA_ARGV0} */
1635 /* TODO likely temporary hook data, v15 drop */
1636 ok_v_mailx_command
, /* {rdonly=1} */
1637 ok_v_mailx_subject
, /* {rdonly=1} */
1638 ok_v_mailx_from
, /* {rdonly=1} */
1639 ok_v_mailx_sender
, /* {rdonly=1} */
1640 ok_v_mailx_to
, /* {rdonly=1} */
1641 ok_v_mailx_cc
, /* {rdonly=1} */
1642 ok_v_mailx_bcc
, /* {rdonly=1} */
1643 ok_v_mailx_raw_to
, /* {rdonly=1} */
1644 ok_v_mailx_raw_cc
, /* {rdonly=1} */
1645 ok_v_mailx_raw_bcc
, /* {rdonly=1} */
1646 ok_v_mailx_orig_from
, /* {rdonly=1} */
1647 ok_v_mailx_orig_to
, /* {rdonly=1} */
1648 ok_v_mailx_orig_cc
, /* {rdonly=1} */
1649 ok_v_mailx_orig_bcc
, /* {rdonly=1} */
1651 ok_v_NAIL_EXTRA_RC
, /* {name=NAIL_EXTRA_RC} */
1652 ok_b_NAIL_NO_SYSTEM_RC
, /* {name=NAIL_NO_SYSTEM_RC,import=1} */
1653 ok_v_NAIL_HEAD
, /* {name=NAIL_HEAD} */
1654 ok_v_NAIL_HISTFILE
, /* {name=NAIL_HISTFILE} */
1655 ok_v_NAIL_HISTSIZE
, /* {name=NAIL_HISTSIZE,notempty=1,num=1} */
1656 ok_v_NAIL_TAIL
, /* {name=NAIL_TAIL} */
1657 ok_v_NETRC
, /* {env=1,notempty=1,defval=VAL_NETRC} */
1663 ok_v_on_account_cleanup
, /* {notempty=1} */
1664 ok_v_on_compose_cleanup
, /* {notempty=1} */
1665 ok_v_on_compose_enter
, /* {notempty=1} */
1666 ok_v_on_compose_leave
, /* {notempty=1} */
1667 ok_v_on_compose_splice
, /* {notempty=1} */
1668 ok_v_on_compose_splice_shell
, /* {notempty=1} */
1669 ok_v_on_resend_cleanup
, /* {notempty=1} */
1670 ok_v_on_resend_enter
, /* {notempty=1} */
1673 ok_v_PAGER
, /* {env=1,notempty=1,defval=VAL_PAGER} */
1674 ok_v_PATH
, /* {nodel=1,import=1} */
1675 ok_b_POSIXLY_CORRECT
, /* {vip=1,import=1,name=POSIXLY_CORRECT} */
1680 ok_b_pop3_bulk_load
,
1681 ok_v_pop3_keepalive
, /* {notempty=1,posnum=1} */
1683 ok_b_pop3_use_starttls
,
1684 ok_b_posix
, /* {vip=1} */
1685 ok_b_print_alternatives
,
1686 ok_v_prompt
, /* {i3val="? "} */
1687 ok_v_prompt2
, /* {i3val=".. "} */
1691 ok_b_quote_as_attachment
,
1694 ok_b_r_option_implicit
,
1695 ok_b_recipients_in_cc
,
1699 ok_b_reply_in_same_charset
,
1702 ok_v_reply_to
, /* {notempty=1} */
1703 ok_v_reply_to_honour
,
1704 ok_b_rfc822_body_from_
, /* {name=rfc822-body-from_} */
1706 ok_v_SHELL
, /* {import=1,notempty=1,defval=VAL_SHELL} */
1707 ok_b_SYSV3
, /* {env=1} */
1708 ok_b_save
, /* {i3val=TRU1} */
1709 ok_v_screen
, /* {notempty=1,posnum=1} */
1711 ok_v_sendcharsets
, /* {lower=1} */
1712 ok_b_sendcharsets_else_ttycharset
,
1715 ok_v_sendmail_arguments
,
1716 ok_b_sendmail_no_default_arguments
,
1717 ok_v_sendmail_progname
,
1725 ok_b_skipemptybody
, /* {vip=1} */
1728 ok_v_smime_ca_flags
,
1729 ok_b_smime_ca_no_defaults
,
1732 ok_v_smime_crl_file
,
1733 /* smime-encrypt-USER@HOST */
1734 ok_b_smime_force_encryption
,
1735 ok_b_smime_no_default_ca
,
1737 ok_v_smime_sign_cert
,
1738 ok_v_smime_sign_include_certs
,
1739 ok_v_smime_sign_message_digest
,
1742 ok_v_smtp_auth_password
,
1743 ok_v_smtp_auth_user
,
1745 ok_b_smtp_use_starttls
,
1746 ok_v_SOURCE_DATE_EPOCH
, /* {\} */
1747 /* {name=SOURCE_DATE_EPOCH,rdonly=1,import=1,notempty=1,posnum=1} */
1748 ok_v_socks_proxy
, /* {notempty=1} */
1749 ok_v_spam_interface
,
1750 ok_v_spam_maxsize
, /* {notempty=1,posnum=1} */
1752 ok_v_spamc_arguments
,
1756 ok_v_spamfilter_ham
,
1757 ok_v_spamfilter_noham
,
1758 ok_v_spamfilter_nospam
,
1759 ok_v_spamfilter_rate
,
1760 ok_v_spamfilter_rate_scanscore
,
1761 ok_v_spamfilter_spam
,
1765 ok_b_ssl_ca_no_defaults
,
1767 ok_v_ssl_cipher_list
,
1768 ok_v_ssl_config_file
,
1774 ok_b_ssl_no_default_ca
,
1781 ok_v_TERM
, /* {env=1} */
1782 ok_v_TMPDIR
, /* {import=1,vip=1,notempty=1,defval=VAL_TMPDIR} */
1784 ok_b_termcap_ca_mode
,
1785 ok_b_termcap_disable
,
1786 ok_v_toplines
, /* {notempty=1,num=1,defval="5"} */
1788 ok_v_ttycharset
, /* {lower=1,notempty=1,defval=CHARSET_8BIT} */
1789 ok_b_typescript_mode
, /* {vip=1} */
1791 ok_v_USER
, /* {rdonly=1,import=1} */
1792 ok_v_umask
, /* {vip=1,nodel=1,posnum=1,i3val="0077"} */
1795 ok_v_VISUAL
, /* {env=1,notempty=1,defval=VAL_VISUAL} */
1797 ok_b_verbose
, /* {vip=1} */
1798 ok_v_version
, /* {virt=n_VERSION} */
1799 ok_v_version_date
, /* {virt=n_VERSION_DATE} */
1800 ok_v_version_major
, /* {virt=n_VERSION_MAJOR} */
1801 ok_v_version_minor
, /* {virt=n_VERSION_MINOR} */
1802 ok_v_version_update
, /* {virt=n_VERSION_UPDATE} */
1804 ok_b_writebackedited
1806 , /* Obsolete IMAP related non-sorted */
1811 ok_v_imap_keepalive
,
1812 ok_v_imap_list_depth
,
1813 ok_b_imap_use_starttls
1816 /* Locale-independent character classes */
1830 char *s
; /* the string's content */
1831 size_t l
; /* the stings's length */
1835 char *s_dat
; /*@ May contain NULs, not automatically terminated */
1836 ui32_t s_len
; /*@ gth of string */
1837 ui32_t s_auto
: 1; /* Stored in auto-reclaimed storage? */
1838 ui32_t s_size
: 31; /* of .s_dat, -1 */
1842 struct n_strlist
*sl_next
;
1844 char sl_dat
[n_VFIELD_SIZE(0)];
1846 #define n_STRLIST_ALLOC(SZ) /* XXX -> nailfuns.h (and pimp interface) */\
1847 n_alloc(n_VSTRUCT_SIZEOF(struct n_strlist, sl_dat) + (SZ) +1)
1848 #define n_STRLIST_AUTOREC_ALLOC(SZ) \
1849 n_autorec_alloc(n_VSTRUCT_SIZEOF(struct n_strlist, sl_dat) + (SZ) +1)
1850 #define n_STRLIST_LOFI_ALLOC(SZ) \
1851 n_lofi_alloc(n_VSTRUCT_SIZEOF(struct n_strlist, sl_dat) + (SZ) +1)
1854 struct str bi_start
; /* Start of (possibly) bidirectional text */
1855 struct str bi_end
; /* End of ... */
1856 size_t bi_pad
; /* No of visual columns to reserve for BIDI pad */
1859 struct n_cmd_arg_desc
{
1860 char cad_name
[12]; /* Name of command */
1861 ui32_t cad_no
; /* Number of entries in cad_ent_flags */
1862 /* [enum n_cmd_arg_desc_flags,arg-dep] */
1863 ui32_t cad_ent_flags
[n_VFIELD_SIZE(0)][2];
1865 /* ISO C(99) doesn't allow initialization of "flex array" */
1866 #define n_CMD_ARG_DESC_SUBCLASS_DEF(CMD,NO,VAR) \
1867 struct n_cmd_arg_desc_ ## CMD {\
1870 ui32_t cad_ent_flags[NO][2];\
1871 } const VAR = { #CMD "\0", NO,
1872 #define n_CMD_ARG_DESC_SUBCLASS_DEF_END }
1873 #define n_CMD_ARG_DESC_SUBCLASS_CAST(P) ((struct n_cmd_arg_desc const*)P)
1875 struct n_cmd_arg_ctx
{
1876 struct n_cmd_arg_desc
const *cac_desc
; /* Input: description of command */
1877 char const *cac_indat
; /* Input that shall be parsed */
1878 size_t cac_inlen
; /* Input length (UIZ_MAX: do a strlen()) */
1879 size_t cac_no
; /* Output: number of parsed arguments */
1880 struct n_cmd_arg
*cac_arg
; /* Output: parsed arguments */
1881 char const *cac_vput
; /* "Output": vput prefix used: varname */
1884 struct n_cmd_arg
{/* TODO incomplete, misses getmsglist() */
1885 struct n_cmd_arg
*ca_next
;
1886 char const *ca_indat
; /*[PRIV] Pointer into n_cmd_arg_ctx.cac_indat */
1887 size_t ca_inlen
; /*[PRIV] of .ca_indat of this arg (not terminated) */
1888 ui32_t ca_ent_flags
[2]; /* Copy of n_cmd_arg_desc.cad_ent_flags[X] */
1889 ui32_t ca_arg_flags
; /* [Output: _WYSH: copy of parse result flags] */
1892 struct str ca_str
; /* _STRING, _WYSH */
1893 } ca_arg
; /* Output: parsed result */
1897 char const *cd_name
; /* Name of command */
1898 int (*cd_func
)(void*); /* Implementor of command */
1899 enum n_cmd_arg_flags cd_caflags
;
1900 si16_t cd_msgflag
; /* Required flags of msgs */
1901 si16_t cd_msgmask
; /* Relevant flags of msgs */
1902 struct n_cmd_arg_desc
const *cd_cadp
;
1903 #ifdef HAVE_DOCSTRINGS
1904 char const *cd_doc
; /* One line doc for command */
1907 /* Yechh, can't initialize unions */
1908 #define cd_minargs cd_msgflag /* Minimum argcount for WYSH/WYRA/RAWLIST */
1909 #define cd_maxargs cd_msgmask /* Max argcount for WYSH/WYRA/RAWLIST */
1912 struct n_colour_env
{
1913 struct n_colour_env
*ce_last
;
1914 bool_t ce_enabled
; /* Colour enabled on this level */
1915 ui8_t ce_ctx
; /* enum n_colour_ctx */
1916 ui8_t ce_ispipe
; /* .ce_outfp known to be a pipe */
1919 struct a_colour_map
*ce_current
; /* Active colour or NULL */
1922 struct n_colour_pen
;
1926 char const *url_input
; /* Input as given (really) */
1928 ui8_t url_cproto
; /* enum cproto as given */
1930 ui16_t url_portno
; /* atoi .url_port or default, host endian */
1931 char const *url_port
; /* Port (if given) or NULL */
1932 char url_proto
[14]; /* Communication protocol as 'xy\0//' */
1933 ui8_t url_proto_len
; /* Length of .url_proto ('\0' index) */
1934 ui8_t url_proto_xlen
; /* .. if '\0' is replaced with ':' */
1935 struct str url_user
; /* User, exactly as given / looked up */
1936 struct str url_user_enc
; /* User, urlxenc()oded */
1937 struct str url_pass
; /* Pass (urlxdec()oded) or NULL */
1938 /* TODO we don't know whether .url_host is a name or an address. Us
1939 * TODO Net::IPAddress::fromString() to check that, then set
1940 * TODO n_URL_HOST_IS_NAME solely based on THAT! Until then,
1941 * TODO n_URL_HOST_IS_NAME ONLY set if n_URL_TLS_MASK and HAVE_GETADDRINFO */
1942 struct str url_host
; /* Service hostname TODO we don't know */
1943 struct str url_path
; /* Path suffix or NULL */
1944 /* TODO: url_get_component(url *, enum COMPONENT, str *store) */
1945 struct str url_h_p
; /* .url_host[:.url_port] */
1946 /* .url_user@.url_host
1947 * Note: for CPROTO_SMTP this may resolve HOST via *smtp-hostname* (->
1948 * *hostname*)! (And may later be overwritten according to *from*!) */
1950 struct str url_u_h_p
; /* .url_user@.url_host[:.url_port] */
1951 struct str url_eu_h_p
; /* .url_user_enc@.url_host[:.url_port] */
1952 char const *url_p_u_h_p
; /* .url_proto://.url_u_h_p */
1953 char const *url_p_eu_h_p
; /* .url_proto://.url_eu_h_p */
1954 char const *url_p_eu_h_p_p
; /* .url_proto://.url_eu_h_p[/.url_path] */
1958 enum cproto cc_cproto
; /* Communication protocol */
1959 enum authtype cc_authtype
; /* Desired authentication */
1960 char const *cc_auth
; /* Authentication type as string */
1961 struct str cc_user
; /* User (urlxdec()oded) or NULL */
1962 struct str cc_pass
; /* Password (urlxdec()oded) or NULL */
1966 struct n_dotlock_info
{
1967 char const *di_file_name
; /* Mailbox to lock */
1968 char const *di_lock_name
; /* .di_file_name + .lock */
1969 char const *di_hostname
; /* ..filled in parent (due resolver delays) */
1970 char const *di_randstr
; /* ..ditto, random string */
1971 size_t di_pollmsecs
; /* Delay in between locking attempts */
1972 struct stat
*di_stb
;
1977 char const *ft_ext_dat
; /* Extension this handles, without first period */
1979 char const *ft_load_dat
; /* And the load and save command strings */
1981 char const *ft_save_dat
;
1985 struct n_go_data_ctx
{
1986 /* The memory pool may be inherited from outer context, so we
1987 * .gdc_mempool may be NE .gdc__mempool_buf */
1989 void *gdc_ifcond
; /* Saved state of conditional stack */
1991 struct n_colour_env
*gdc_colour
;
1992 bool_t gdc_colour_active
;
1993 ui8_t gdc__colour_pad
[7];
1994 # define n_COLOUR_IS_ACTIVE() \
1995 (/*n_go_data->gc_data.gdc_colour != NULL &&*/\
1996 /*n_go_data->gc_data.gdc_colour->ce_enabled*/ n_go_data->gdc_colour_active)
1998 char gdc__mempool_buf
[n_MEMORY_POOL_TYPE_SIZEOF
];
2000 n_MCTA(n_MEMORY_POOL_TYPE_SIZEOF
% sizeof(void*) == 0,
2001 "Inacceptible size of n_go_data_ctx.gdc_mempool")
2003 struct mime_handler
{
2004 enum mime_handler_flags mh_flags
;
2005 struct str mh_msg
; /* Message describing this command */
2006 /* XXX union{} the following? */
2007 char const *mh_shell_cmd
; /* For MIME_HDL_CMD */
2008 int (*mh_ptf
)(void); /* PTF main() for MIME_HDL_PTF */
2012 FILE *qf_os
; /* Output stream */
2013 char const *qf_pfix
;
2014 ui32_t qf_pfix_len
; /* Length of prefix: 0: bypass */
2015 ui32_t qf_qfold_min
; /* Simple way: wrote prefix? */
2016 /* TODO quoteflt.qf_nl_last is a hack that i have introduced so that we
2017 * TODO finally can gracefully place a newline last in the visual display.
2018 * TODO I.e., for cases where quoteflt shouldn't be used at all ;} */
2019 bool_t qf_nl_last
; /* Last thing written/seen was NL */
2020 #ifndef HAVE_QUOTE_FOLD
2024 ui8_t qf_state
; /* *quote-fold* state machine */
2025 bool_t qf_brk_isws
; /* Breakpoint is at WS */
2026 ui32_t qf_qfold_max
; /* Otherwise: line lengths */
2027 ui32_t qf_wscnt
; /* Whitespace count */
2028 ui32_t qf_brkl
; /* Breakpoint */
2029 ui32_t qf_brkw
; /* Visual width, breakpoint */
2030 ui32_t qf_datw
; /* Current visual output line width */
2031 struct str qf_dat
; /* Current visual output line */
2032 struct str qf_currq
; /* Current quote, compressed */
2033 mbstate_t qf_mbps
[2];
2037 #ifdef HAVE_FILTER_HTML_TAGSOUP
2039 FILE *hf_os
; /* Output stream */
2041 ui32_t hf_lmax
; /* Maximum byte +1 in .hf_line/4 */
2042 ui32_t hf_len
; /* Current bytes in .hf_line */
2043 ui32_t hf_last_ws
; /* Last whitespace on line (fold purposes) */
2044 ui32_t hf_mboff
; /* Last offset for "mbtowc" */
2045 ui32_t hf_mbwidth
; /* We count characters not bytes if possible */
2046 char *hf_line
; /* Output line buffer - MUST be last field! */
2047 si32_t hf_href_dist
; /* Count of lines since last HREF flush */
2048 ui32_t hf_href_no
; /* HREF sequence number */
2049 struct htmlflt_href
*hf_hrefs
;
2050 struct htmlflt_tag
const *hf_ign_tag
; /* Tag that will end ignore mode */
2051 char *hf_curr
; /* Current cursor into .hf_bdat */
2052 char *hf_bmax
; /* Maximum byte in .hf_bdat +1 */
2053 char *hf_bdat
; /* (Temporary) Tag content data storage */
2057 struct search_expr
{
2058 char const *ss_where
; /* ..to search for the expr. (not always used) */
2059 char const *ss_sexpr
; /* String search expr.; NULL: use .ss_regex */
2065 /* This is somewhat temporary for pre v15 */
2067 ui32_t sm_flags
; /* enum n_sigman_flags */
2069 struct n_sigman
*sm_outer
;
2070 sighandler_type sm_ohup
;
2071 sighandler_type sm_oint
;
2072 sighandler_type sm_oquit
;
2073 sighandler_type sm_oterm
;
2074 sighandler_type sm_opipe
;
2083 struct termios_state
{
2084 struct termios ts_tios
;
2087 bool_t ts_needs_reset
;
2090 #define termios_state_reset() \
2092 if (termios_state.ts_needs_reset) {\
2093 tcsetattr(STDIN_FILENO, TCSADRAIN, &termios_state.ts_tios);\
2094 termios_state.ts_needs_reset = FAL0;\
2099 struct n_termcap_value
{
2100 enum n_termcap_captype tv_captype
;
2102 union n_termcap_value_data
{
2105 char const *tvd_string
;
2110 struct n_visual_info_ctx
{
2111 char const *vic_indat
; /*I Input data */
2112 size_t vic_inlen
; /*I If UIZ_MAX, strlen(.vic_indat) */
2113 char const *vic_oudat
; /*O remains */
2115 size_t vic_chars_seen
; /*O number of characters processed */
2116 size_t vic_bytes_seen
; /*O number of bytes passed */
2117 size_t vic_vi_width
; /*[O] visual width of the entire range */
2118 wc_t
*vic_woudat
; /*[O] if so requested */
2119 size_t vic_woulen
; /*[O] entries in .vic_woudat, if used */
2120 wc_t vic_waccu
; /*O The last wchar_t/char processed (if any) */
2121 enum n_visual_info_flags vic_flags
; /*O Copy of parse flags */
2123 #ifdef HAVE_C90AMEND1
2124 mbstate_t *vic_mbstate
; /*IO .vic_mbs_def used if NULL */
2125 mbstate_t vic_mbs_def
;
2129 struct time_current
{
2136 struct sock
{ /* data associated with a socket */
2137 int s_fd
; /* file descriptor */
2139 int s_use_ssl
; /* SSL is used */
2141 void *s_ssl
; /* SSL object */
2144 char *s_wbuf
; /* for buffered writes */
2145 int s_wbufsize
; /* allocated size of s_buf */
2146 int s_wbufpos
; /* position of first empty data byte */
2147 char *s_rbufptr
; /* read pointer to s_rbuf */
2148 int s_rsz
; /* size of last read in s_rbuf */
2149 char const *s_desc
; /* description of error messages */
2150 void (*s_onclose
)(void); /* execute on close */
2151 char s_rbuf
[LINESIZE
+ 1]; /* for buffered reads */
2156 struct ccred sc_cred
;
2157 struct sock sc_sock
;
2162 MB_NONE
= 000, /* no reply expected */
2163 MB_COMD
= 001, /* command reply expected */
2164 MB_MULT
= 002, /* multiline reply expected */
2165 MB_PREAUTH
= 004, /* not in authenticated state */
2166 MB_BYE
= 010, /* may accept a BYE state */
2167 MB_FROM__WARNED
= 1<<4 /* MBOX with invalid from seen & logged */
2169 FILE *mb_itf
; /* temp file with messages, read open */
2170 FILE *mb_otf
; /* same, write open */
2171 char *mb_sorted
; /* sort method */
2173 MB_VOID
, /* no type (e. g. connection failed) */
2174 MB_FILE
, /* local file */
2175 MB_POP3
, /* POP3 mailbox */
2176 MB_IMAP
, /* IMAP mailbox */
2177 MB_CACHE
, /* IMAP cache */
2178 MB_MAILDIR
/* maildir folder */
2179 } mb_type
; /* type of mailbox */
2181 MB_DELE
= 01, /* may delete messages in mailbox */
2182 MB_EDIT
= 02 /* may edit messages in mailbox */
2184 int mb_threaded
; /* mailbox has been threaded */
2188 MB_UIDPLUS
= 001 /* supports IMAP UIDPLUS */
2190 unsigned long mb_uidvalidity
; /* IMAP unique identifier validity */
2191 char *mb_imap_account
; /* name of current IMAP account */
2192 char *mb_imap_pass
; /* xxx v15-compat URL workaround */
2193 char *mb_imap_mailbox
; /* name of current IMAP mailbox */
2194 char *mb_cache_directory
; /* name of cache directory */
2195 char mb_imap_delim
[8]; /* Directory separator(s), [0] += replacer */
2197 struct sock mb_sock
; /* socket structure */
2201 NEED_UNSPEC
, /* unspecified need, don't fetch */
2202 NEED_HEADER
, /* need the header of a message */
2203 NEED_BODY
/* need header and body of a message */
2207 CI_NOTHING
, /* Nothing downloaded yet */
2208 CI_HAVE_HEADER
= 1u<<0, /* Header is downloaded */
2209 CI_HAVE_BODY
= 1u<<1, /* Entire message is downloaded */
2210 CI_HAVE_MASK
= CI_HAVE_HEADER
| CI_HAVE_BODY
,
2211 CI_MIME_ERRORS
= 1u<<2, /* Defective MIME structure */
2212 CI_EXPANDED
= 1u<<3, /* Container part (pk7m) exploded into X */
2213 CI_SIGNED
= 1u<<4, /* Has a signature.. */
2214 CI_SIGNED_OK
= 1u<<5, /* ..verified ok.. */
2215 CI_SIGNED_BAD
= 1u<<6, /* ..verified bad (missing key).. */
2216 CI_ENCRYPTED
= 1u<<7, /* Is encrypted.. */
2217 CI_ENCRYPTED_OK
= 1u<<8, /* ..decryption possible/ok.. */
2218 CI_ENCRYPTED_BAD
= 1u<<9 /* ..not possible/ok */
2221 /* Note: flags that are used in obs-imap-cache.c may not change */
2223 MUSED
= 1u<<0, /* entry is used, but this bit isn't */
2224 MDELETED
= 1u<<1, /* entry has been deleted */
2225 MSAVED
= 1u<<2, /* entry has been saved */
2226 MTOUCH
= 1u<<3, /* entry has been noticed */
2227 MPRESERVE
= 1u<<4, /* keep entry in sys mailbox */
2228 MMARK
= 1u<<5, /* message is marked! */
2229 MODIFY
= 1u<<6, /* message has been modified */
2230 MNEW
= 1u<<7, /* message has never been seen */
2231 MREAD
= 1u<<8, /* message has been read sometime. */
2232 MSTATUS
= 1u<<9, /* message status has changed */
2233 MBOX
= 1u<<10, /* Send this to mbox, regardless */
2234 MNOFROM
= 1u<<11, /* no From line */
2235 MHIDDEN
= 1u<<12, /* message is hidden to user */
2236 MFULLYCACHED
= 1u<<13, /* IMAP cached */
2237 MBOXED
= 1u<<14, /* message has been sent to mbox */
2238 MUNLINKED
= 1u<<15, /* Unlinked from IMAP cache */
2239 MNEWEST
= 1u<<16, /* message is very new (newmail) */
2240 MFLAG
= 1u<<17, /* message has been flagged recently */
2241 MUNFLAG
= 1u<<18, /* message has been unflagged */
2242 MFLAGGED
= 1u<<19, /* message is `flagged' */
2243 MANSWER
= 1u<<20, /* message has been answered recently */
2244 MUNANSWER
= 1u<<21, /* message has been unanswered */
2245 MANSWERED
= 1u<<22, /* message is `answered' */
2246 MDRAFT
= 1u<<23, /* message has been drafted recently */
2247 MUNDRAFT
= 1u<<24, /* message has been undrafted */
2248 MDRAFTED
= 1u<<25, /* message is marked as `draft' */
2249 MOLDMARK
= 1u<<26, /* messages was marked previously */
2250 MSPAM
= 1u<<27, /* message is classified as spam */
2251 MSPAMUNSURE
= 1u<<28 /* message may be spam, but it is unsure */
2253 #define MMNORM (MDELETED | MSAVED | MHIDDEN)
2254 #define MMNDEL (MDELETED | MHIDDEN)
2256 #define visible(mp) (((mp)->m_flag & MMNDEL) == 0)
2260 enum content_info m_content_info
;
2262 ui32_t m_spamscore
; /* Spam score as int, 24:8 bits */
2264 int m_block
; /* block number of this part */
2265 size_t m_offset
; /* offset in block of part */
2266 size_t m_size
; /* Bytes in the part */
2267 size_t m_xsize
; /* Bytes in the full part */
2268 long m_lines
; /* Lines in the message: write format! */
2269 long m_xlines
; /* Lines in the full message; ditto */
2270 time_t m_time
; /* time the message was sent */
2271 char const *m_from
; /* message sender */
2272 struct mimepart
*m_nextpart
; /* next part at same level */
2273 struct mimepart
*m_multipart
; /* parts of multipart */
2274 struct mimepart
*m_parent
; /* enclosing multipart part */
2275 char const *m_ct_type
; /* content-type */
2276 char const *m_ct_type_plain
; /* content-type without specs */
2277 char const *m_ct_type_usr_ovwr
; /* Forcefully overwritten one */
2278 enum mimecontent m_mimecontent
; /* ..in enum */
2279 char const *m_charset
;
2280 char const *m_ct_enc
; /* Content-Transfer-Encoding */
2281 enum mime_enc m_mime_enc
; /* ..in enum */
2282 char *m_partstring
; /* Part level string */
2283 char *m_filename
; /* ..of attachment */
2284 char const *m_content_description
;
2285 struct mime_handler
*m_handler
; /* MIME handler if yet classified */
2289 enum mflag m_flag
; /* flags */
2290 enum content_info m_content_info
;
2292 ui32_t m_spamscore
; /* Spam score as int, 24:8 bits */
2294 int m_block
; /* block number of this message */
2295 size_t m_offset
; /* offset in block of message */
2296 size_t m_size
; /* Bytes in the message */
2297 size_t m_xsize
; /* Bytes in the full message */
2298 long m_lines
; /* Lines in the message */
2299 long m_xlines
; /* Lines in the full message */
2300 time_t m_time
; /* time the message was sent */
2301 time_t m_date
; /* time in the 'Date' field */
2302 unsigned m_idhash
; /* hash on Message-ID for threads */
2303 struct message
*m_child
; /* first child of this message */
2304 struct message
*m_younger
; /* younger brother of this message */
2305 struct message
*m_elder
; /* elder brother of this message */
2306 struct message
*m_parent
; /* parent of this message */
2307 unsigned m_level
; /* thread level of message */
2308 long m_threadpos
; /* position in threaded display */
2310 unsigned long m_uid
; /* IMAP unique identifier */
2312 char const *m_maildir_file
; /* original maildir file of msg */
2313 ui32_t m_maildir_hash
; /* hash of file name in maildir sub */
2314 int m_collapsed
; /* collapsed thread information */
2317 /* Given a file address, determine the block number it represents */
2318 #define mailx_blockof(off) ((int) ((off) / 4096))
2319 #define mailx_offsetof(off) ((int) ((off) % 4096))
2320 #define mailx_positionof(block, offset) ((off_t)(block) * 4096 + (offset))
2322 enum gfield
{ /* TODO -> enum m_grab_head, m_GH_xy */
2324 GTO
= 1u<<0, /* Grab To: line */
2325 GSUBJECT
= 1u<<1, /* Likewise, Subject: line */
2326 GCC
= 1u<<2, /* And the Cc: line */
2327 GBCC
= 1u<<3, /* And also the Bcc: line */
2329 GNL
= 1u<<4, /* Print blank line after */
2330 GDEL
= 1u<<5, /* Entity removed from list */
2331 GCOMMA
= 1u<<6, /* detract() puts in commas */
2332 GUA
= 1u<<7, /* User-Agent field */
2333 GMIME
= 1u<<8, /* MIME 1.0 fields */
2334 GMSGID
= 1u<<9, /* a Message-ID */
2335 GNAMEONLY
= 1u<<10, /* detract() does NOT use fullnames */
2337 GIDENT
= 1u<<11, /* From:, Reply-To:, MFT: (user headers) */
2338 GREF
= 1u<<12, /* References:, In-Reply-To:, (Message-ID:) */
2339 GDATE
= 1u<<13, /* Date: field */
2340 GFULL
= 1u<<14, /* Include full names, comments etc. */
2341 GSKIN
= 1u<<15, /* Skin names */
2342 GEXTRA
= 1u<<16, /* Extra fields (mostly like GIDENT XXX) */
2343 GFILES
= 1u<<17, /* Include filename and pipe addresses */
2344 GFULLEXTRA
= 1u<<18 /* Only with GFULL: GFULL less address */
2346 #define GMASK (GTO | GSUBJECT | GCC | GBCC)
2350 HF_LIST_REPLY
= 1<< 0,
2351 HF_MFT_SENDER
= 1<< 1, /* Add ourselves to Mail-Followup-To: */
2352 HF_RECIPIENT_RECORD
= 1<<10, /* Save message in file named after rec. */
2356 /* Structure used to pass about the current state of a message (header) */
2357 struct n_header_field
{
2358 struct n_header_field
*hf_next
;
2359 ui32_t hf_nl
; /* Field-name length */
2360 ui32_t hf_bl
; /* Field-body length*/
2361 char hf_dat
[n_VFIELD_SIZE(0)];
2365 ui32_t h_flags
; /* enum header_flags bits */
2367 char *h_subject
; /* Subject string */
2368 char const *h_charset
; /* preferred charset */
2369 struct name
*h_from
; /* overridden "From:" field */
2370 struct name
*h_sender
; /* overridden "Sender:" field */
2371 struct name
*h_to
; /* Dynamic "To:" string */
2372 struct name
*h_cc
; /* Carbon copies string */
2373 struct name
*h_bcc
; /* Blind carbon copies */
2374 struct name
*h_ref
; /* References (possibly overridden) */
2375 struct attachment
*h_attach
; /* MIME attachments */
2376 struct name
*h_reply_to
; /* overridden "Reply-To:" field */
2377 struct name
*h_message_id
; /* overridden "Message-ID:" field */
2378 struct name
*h_in_reply_to
;/* overridden "In-Reply-To:" field */
2379 struct name
*h_mft
; /* Mail-Followup-To */
2380 char const *h_list_post
; /* Address from List-Post:, for `Lreply' */
2381 struct n_header_field
*h_user_headers
;
2382 struct n_header_field
*h_custom_headers
; /* (Cached result) */
2383 /* Raw/original versions of the header(s). If any */
2384 char const *h_mailx_command
;
2385 struct name
*h_mailx_raw_to
;
2386 struct name
*h_mailx_raw_cc
;
2387 struct name
*h_mailx_raw_bcc
;
2388 struct name
*h_mailx_orig_from
;
2389 struct name
*h_mailx_orig_to
;
2390 struct name
*h_mailx_orig_cc
;
2391 struct name
*h_mailx_orig_bcc
;
2394 /* Handling of namelist nodes used in processing the recipients of mail and
2395 * aliases, inspection of mail-addresses and all that kind of stuff */
2397 NAME_NAME_SALLOC
= 1u<<0, /* .n_name is doped */
2398 NAME_FULLNAME_SALLOC
= 1u<<1, /* .n_fullname is doped */
2399 NAME_SKINNED
= 1u<<2, /* Is actually skin()ned */
2400 NAME_IDNA
= 1u<<3, /* IDNA was applied */
2402 NAME_ADDRSPEC_CHECKED
= 1u<<4, /* Address has been .. and */
2403 NAME_ADDRSPEC_ISFILE
= 1u<<5, /* ..is a file path */
2404 NAME_ADDRSPEC_ISPIPE
= 1u<<6, /* ..is a command for piping */
2405 NAME_ADDRSPEC_ISFILEORPIPE
= NAME_ADDRSPEC_ISFILE
| NAME_ADDRSPEC_ISPIPE
,
2406 NAME_ADDRSPEC_ISNAME
= 1u<<7, /* ..is an alias name */
2407 NAME_ADDRSPEC_ISADDR
= 1u<<8, /* ..is a mail network address */
2409 NAME_ADDRSPEC_ERR_EMPTY
= 1u<<9, /* An empty string (or NULL) */
2410 NAME_ADDRSPEC_ERR_ATSEQ
= 1u<<10, /* Weird @ sequence */
2411 NAME_ADDRSPEC_ERR_CHAR
= 1u<<11, /* Invalid character */
2412 NAME_ADDRSPEC_ERR_IDNA
= 1u<<12, /* IDNA convertion failed */
2413 NAME_ADDRSPEC_ERR_NAME
= 1u<<13, /* Alias with invalid content */
2414 NAME_ADDRSPEC_INVALID
= NAME_ADDRSPEC_ERR_EMPTY
|
2415 NAME_ADDRSPEC_ERR_ATSEQ
| NAME_ADDRSPEC_ERR_CHAR
|
2416 NAME_ADDRSPEC_ERR_IDNA
| NAME_ADDRSPEC_ERR_NAME
,
2418 /* Error storage (we must fit in 31-bit) */
2420 _NAME_MAXWC
= 0x1FFFF,
2421 _NAME_MASKWC
= _NAME_MAXWC
<< _NAME_SHIFTWC
2422 /* Bit 31 (32) == SI32_MIN temporarily used */
2425 /* In the !_ERR_EMPTY case, the failing character can be queried */
2426 #define NAME_ADDRSPEC_ERR_GETWC(F) \
2427 ((((unsigned int)(F) & _NAME_MASKWC) >> _NAME_SHIFTWC) & _NAME_MAXWC)
2428 #define NAME_ADDRSPEC_ERR_SET(F, E, WC) \
2430 (F) = ((F) & ~(NAME_ADDRSPEC_INVALID | _NAME_MASKWC)) |\
2431 (E) | (((unsigned int)(WC) & _NAME_MAXWC) << _NAME_SHIFTWC);\
2435 struct name
*n_flink
; /* Forward link in list. */
2436 struct name
*n_blink
; /* Backward list link */
2437 enum gfield n_type
; /* From which list it came */
2438 ui32_t n_flags
; /* enum nameflags */
2439 char *n_name
; /* This fella's address */
2440 char *n_fullname
; /* Ditto, unless GFULL including comment */
2441 char *n_fullextra
; /* GFULL, without address */
2445 /* Input string as given (maybe replaced with a fixed one!) */
2446 char const *ag_input
;
2447 size_t ag_ilen
; /* strlen() of input */
2448 size_t ag_iaddr_start
; /* Start of *addr-spec* in .ag_input */
2449 size_t ag_iaddr_aend
; /* ..and one past its end */
2450 char *ag_skinned
; /* Output (alloced if !=.ag_input) */
2451 size_t ag_slen
; /* strlen() of .ag_skinned */
2452 size_t ag_sdom_start
; /* Start of domain in .ag_skinned, */
2453 enum nameflags ag_n_flags
; /* enum nameflags of .ag_skinned */
2456 /* MIME attachments */
2458 AC_DEFAULT
, /* _get_lc() -> _iter_*() */
2459 AC_FIX_INCS
, /* "charset=".a_input_charset (nocnv) */
2460 AC_TMPFILE
/* attachment.a_tmpf is converted */
2463 enum n_attach_error
{
2465 n_ATTACH_ERR_FILE_OPEN
,
2466 n_ATTACH_ERR_ICONV_FAILED
,
2467 n_ATTACH_ERR_ICONV_NAVAIL
,
2472 struct attachment
*a_flink
; /* Forward link in list. */
2473 struct attachment
*a_blink
; /* Backward list link */
2474 char const *a_path_user
; /* Path as given (maybe including iconv spec) */
2475 char const *a_path
; /* Path as opened */
2476 char const *a_path_bname
; /* Basename of path as opened */
2477 char const *a_name
; /* File name to be stored (EQ a_path_bname) */
2478 char const *a_content_type
; /* content type */
2479 char const *a_content_disposition
; /* content disposition */
2480 struct name
*a_content_id
; /* content id */
2481 char const *a_content_description
; /* content description */
2482 char const *a_input_charset
; /* Interpretation depends on .a_conv */
2483 char const *a_charset
; /* ... */
2484 FILE *a_tmpf
; /* If AC_TMPFILE */
2485 enum attach_conv a_conv
; /* User chosen conversion */
2486 int a_msgno
; /* message number */
2490 struct header
*sb_hp
;
2493 struct str sb_signer
; /* USER@HOST for signing+ */
2495 struct ccred sb_ccred
;
2498 /* For saving the current directory and later returning */
2503 char cw_wd
[PATH_MAX
];
2508 * Global variable declarations
2510 * These become instantiated in main.c.
2514 #ifdef n_MAIN_SOURCE
2515 # ifndef HAVE_AMALGAMATION
2524 #ifndef HAVE_AMALGAMATION
2525 VL
char const n_month_names
[12 + 1][4];
2526 VL
char const n_weekday_names
[7 + 1][4];
2528 VL
char const n_uagent
[sizeof VAL_UAGENT
];
2529 VL
char const n_error
[sizeof n_ERROR
];
2530 VL
char const n_path_devnull
[sizeof n_PATH_DEVNULL
];
2531 VL
char const n_reproducible_name
[sizeof "reproducible_build"];
2532 VL
char const n_unirepl
[sizeof n_UNIREPL
];
2533 VL
char const n_empty
[1];
2534 VL
char const n_0
[2];
2535 VL
char const n_1
[2];
2536 VL
char const n_m1
[3]; /* -1 */
2537 VL
char const n_qm
[2]; /* Question-mark ? */
2538 VL
char const n_em
[2]; /* Exclamation-mark ! */
2539 VL
char const n_star
[2]; /* Asterisk * */
2540 VL
char const n_at
[2]; /* Commercial at @ */
2541 VL
char const n_ns
[2]; /* Number sign # */
2542 VL ui16_t
const n_class_char
[1 + 0x7F];
2548 VL
FILE *n_tty_fp
; /* Our terminal output TODO input channel */
2549 VL
void *n_readctl_overlay
; /* `readctl' overlay (see c_readctl()) */
2551 VL ui32_t n_mb_cur_max
; /* Value of MB_CUR_MAX */
2552 VL ui32_t n_realscreenheight
; /* The real screen height */
2553 VL ui32_t n_scrnwidth
; /* Screen width/guess; also n_SCRNWIDTH_LIST */
2554 VL ui32_t n_scrnheight
; /* Screen height/guess (for header summary+) */
2556 VL
char const *n_progname
; /* Our name */
2558 VL gid_t n_group_id
; /* getgid() and getuid() */
2560 VL pid_t n_pid
; /* getpid() (lazy initialized) */
2562 VL
int n_exit_status
; /* Program exit status TODO long term: ex_no */
2563 VL ui32_t n_poption
; /* Bits of enum n_program_option */
2564 VL
char const *n_poption_arg_Mm
; /* Argument for -[Mm] aka n_PO_[Mm]_FLAG */
2565 VL
struct name
*n_poption_arg_r
; /* Argument to -r option */
2566 VL
char const **n_smopts
; /* MTA options from command line */
2567 VL
size_t n_smopts_cnt
; /* Entries in n_smopts */
2569 /* The current execution data context */
2570 VL
struct n_go_data_ctx
*n_go_data
;
2571 VL ui32_t n_psonce
; /* Bits of enum n_program_state_once */
2572 VL ui32_t n_pstate
; /* Bits of enum n_program_state */
2573 /* TODO "cmd_tab.h ARG_EM set"-storage (n_[01..]) as long as we don't have a
2574 * TODO struct CmdCtx where each command has its own ARGC/ARGV, errno and exit
2575 * TODO status and may-place-in-history bit, need to manage a global bypass.. */
2576 VL si32_t n_pstate_err_no
; /* What backs $! n_ERR_* TODO ..HACK */
2577 VL si32_t n_pstate_ex_no
; /* What backs $? n_EX_* TODO ..HACK ->64-bit */
2578 #define n_err_no errno /* Don't use errno directly, for later XXX */
2580 /* XXX stylish sorting */
2581 VL
int msgCount
; /* Count of messages read in */
2582 VL
struct mailbox mb
; /* Current mailbox */
2583 VL
char mailname
[PATH_MAX
]; /* Name of current file TODO URL/object*/
2584 VL
char displayname
[80 - 16]; /* Prettyfied for display TODO URL/obj*/
2585 VL
char prevfile
[PATH_MAX
]; /* Name of previous file TODO URL/obj */
2586 VL off_t mailsize
; /* Size of system mailbox */
2587 VL
struct message
*dot
; /* Pointer to current message */
2588 VL
struct message
*prevdot
; /* Previous current message */
2589 VL
struct message
*message
; /* The actual message structure */
2590 VL
struct message
*threadroot
; /* first threaded message */
2591 VL
int *n_msgvec
; /* Folder setmsize(), list.c res. store*/
2593 VL
int imap_created_mailbox
; /* hack to get feedback from imap */
2596 VL
struct time_current time_current
; /* time(3); send: mail1() XXXcarrier */
2597 VL
struct termios_state termios_state
; /* getpassword(); see commands().. */
2600 VL
enum ssl_verify_level ssl_verify_level
; /* SSL verification level */
2607 VL
volatile int interrupts
; /* TODO rid! */
2608 VL sighandler_type dflpipe
;
2611 * Finally, let's include the function prototypes XXX embed
2614 #ifndef n_PRIVSEP_SOURCE
2615 # include "nailfuns.h"
2618 #endif /* n_NAIL_H */