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 - 2015 Steffen (Daode) Nurpmeso <sdaoden@users.sf.net>.
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>
84 #ifdef HAVE_OPENSSL_MD5
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)
152 #if BUFSIZ + 0 > 2560 /* TODO simply use BUFSIZ? */
153 # define LINESIZE BUFSIZ /* max readable line width */
155 # define LINESIZE 2560
157 #define BUFFER_SIZE (BUFSIZ >= (1u << 13) ? BUFSIZ : (1u << 14))
159 /* Network protocol newline */
160 #define NETNL "\015\012"
161 #define NETLINE(X) X NETNL
163 /* Number of Not-Yet-Dead calls that are remembered */
164 #if defined HAVE_DEBUG || defined HAVE_DEVEL || defined HAVE_NYD2
166 # define NYD_CALLS_MAX (25 * 84)
167 # elif defined HAVE_DEVEL
168 # define NYD_CALLS_MAX (25 * 42)
170 # define NYD_CALLS_MAX (25 * 10)
174 #define APPEND /* New mail goes to end of mailbox */
175 #define CBAD (-15555)
176 #define DOTLOCK_TRIES 5 /* Number of open(2) calls for dotlock */
177 #define FILE_LOCK_TRIES 10 /* Maximum tries before n_file_lock() fails */
178 #define ERRORS_MAX 1000 /* Maximum error ring entries TODO configable*/
179 #define ESCAPE '~' /* Default escape for sending */
180 #define HIST_SIZE 242 /* tty.c: history list default size */
181 #define HSHSIZE 23 /* Hash prime TODO make dynamic, obsolete */
182 #define MAXARGC 1024 /* Maximum list of raw strings */
183 #define MAXEXP 25 /* Maximum expansion of aliases */
184 #define PROMPT_BUFFER_SIZE 80 /* getprompt() bufsize (> 3!) */
185 #define REFERENCES_MAX 20 /* Maximum entries in References: */
186 #define FTMP_OPEN_TRIES 10 /* Maximum number of Ftmp() open(2) tries */
188 #define ACCOUNT_NULL "null" /* Name of "null" account */
190 /* Some environment variables for pipe hooks */
191 #define AGENT_USER "NAIL_USER"
192 #define AGENT_USER_ENC "NAIL_USER_ENC"
193 #define AGENT_HOST "NAIL_HOST"
194 #define AGENT_HOST_PORT "NAIL_HOST_PORT"
198 # define n_COLOUR(X) X
203 /* Special FD requests for run_command() / start_command() */
204 #define COMMAND_FD_PASS -1
205 #define COMMAND_FD_NULL -2
208 #define FROM_DATEBUF 64 /* Size of RFC 4155 From_ line date */
209 #define DATE_DAYSYEAR 365L
210 #define DATE_SECSMIN 60L
211 #define DATE_MINSHOUR 60L
212 #define DATE_HOURSDAY 24L
213 #define DATE_SECSDAY (DATE_SECSMIN * DATE_MINSHOUR * DATE_HOURSDAY)
215 /* *indentprefix* default as of POSIX */
216 #define INDENT_DEFAULT "\t"
218 /* Default *encoding* as enum mime_enc below */
219 #define MIME_DEFAULT_ENCODING MIMEE_QP
221 /* Maximum allowed line length in a mail before QP folding is necessary), and
222 * the real limit we go for */
223 #define MIME_LINELEN_MAX 998 /* Plus CRLF */
224 #define MIME_LINELEN_LIMIT (MIME_LINELEN_MAX - 48)
227 #define MIME_LINELEN 78 /* Plus CRLF */
229 /* And in headers which contain an encoded word according to RFC 2047 there is
230 * yet another limit; also RFC 2045: 6.7, (5). */
231 #define MIME_LINELEN_RFC2047 76
233 /* Locations of mime.types(5) */
234 #define MIME_TYPES_USR "~/.mime.types"
235 #define MIME_TYPES_SYS "/etc/mime.types"
237 /* Fallback MIME charsets, if *charset-7bit* and *charset-8bit* or not set.
238 * (Keep in SYNC: ./nail.1:"Character sets", ./nail.h:CHARSET_*!) */
239 #define CHARSET_7BIT "US-ASCII"
241 # define CHARSET_8BIT "UTF-8"
242 # define CHARSET_8BIT_OKEY charset_8bit
244 # define CHARSET_8BIT "ISO-8859-1"
245 # define CHARSET_8BIT_OKEY ttycharset
248 /* Some environment variables for pipe hooks etc. */
249 #define NAILENV_TMPDIR "NAIL_TMPDIR"
250 #define NAILENV_FILENAME "NAIL_FILENAME"
251 #define NAILENV_FILENAME_GENERATED "NAIL_FILENAME_GENERATED"
252 #define NAILENV_FILENAME_TEMPORARY "NAIL_FILENAME_TEMPORARY"
253 #define NAILENV_CONTENT "NAIL_CONTENT"
254 #define NAILENV_CONTENT_EVIDENCE "NAIL_CONTENT_EVIDENCE"
256 /* Is *W* a quoting (ASCII only) character? */
258 ((W) == L'>' || (W) == L'|' || (W) == L'}' || (W) == L':')
260 /* Maximum number of quote characters (not bytes!) that'll be used on
261 * follow lines when compressing leading quote characters */
264 /* How much spaces should a <tab> count when *quote-fold*ing? (power-of-two!) */
265 #define QUOTE_TAB_SPACES 8
267 /* Maximum size of a message that is passed through to the spam system */
268 #define SPAM_MAXSIZE 420000
270 /* String dope: dynamic buffer size, and size of the single builtin one that's
271 * used first; note that these value include the size of the structure */
272 #define SBUFFER_SIZE ((0x10000u >> 1u) - 0x400)
273 #define SBUFFER_BUILTIN (0x10000u >> 1u)
275 /* Switch indicating necessity of terminal access interface (termcap.c) */
276 #if defined HAVE_TERMCAP || defined HAVE_COLOUR || defined HAVE_MLE
281 * OS, CC support, generic macros etc.
284 /* OS: we're not a library, only set what needs special treatment somewhere */
285 #define OS_DRAGONFLY 0
291 # define OS_DRAGONFLY 1
292 #elif defined __solaris__ || defined __sun
293 # if defined __SVR4 || defined __svr4__
295 # define OS_SOLARIS 1
304 #define PREREQ_CLANG(X,Y) 0
306 #define PREREQ_GCC(X,Y) 0
308 #define PREREQ_TCC(X,Y) 0
314 # define PREREQ_CLANG(X,Y) \
315 (__clang_major__ + 0 > (X) || \
316 (__clang_major__ + 0 == (X) && __clang_minor__ + 0 >= (Y)))
317 # define __EXTEN __extension__
319 #elif defined __GNUC__
323 # define PREREQ_GCC(X,Y) \
324 (__GNUC__ + 0 > (X) || (__GNUC__ + 0 == (X) && __GNUC_MINOR__ + 0 >= (Y)))
325 # define __EXTEN __extension__
327 #elif defined __TINYC__
336 /* Suppress some technical warnings via #pragma's unless developing.
337 * XXX Wild guesses: clang(1) 1.7 and (OpenBSD) gcc(1) 4.2.1 don't work */
339 # if PREREQ_CLANG(3, 4)
340 # pragma clang diagnostic ignored "-Wunused-result"
341 # pragma clang diagnostic ignored "-Wformat"
342 # elif PREREQ_GCC(4, 7)
343 # pragma GCC diagnostic ignored "-Wunused-local-typedefs"
344 # pragma GCC diagnostic ignored "-Wunused-result"
345 # pragma GCC diagnostic ignored "-Wformat"
349 /* For injection macros like DBG(), NATCH_CHAR() */
352 #define EMPTY_FILE() typedef int CONCAT(avoid_empty_file__, n_FILE);
354 /* Pointer to size_t */
355 #define PTR2SIZE(X) ((size_t)(uintptr_t)(X))
357 /* Pointer comparison (types from below) */
358 #define PTRCMP(A,C,B) ((uintptr_t)(A) C (uintptr_t)(B))
360 /* Ditto, compare (maybe mixed-signed) integers cases to T bits, unsigned;
361 * Note: doesn't sign-extend correctly, that's still up to the caller */
362 #define UICMP(T,A,C,B) ((ui ## T ## _t)(A) C (ui ## T ## _t)(B))
364 /* Align something to a size/boundary that cannot cause just any problem */
365 #define n_ALIGN(X) (((X) + 2*sizeof(void*)) & ~((2*sizeof(void*)) - 1))
367 /* Members in constant array */
369 # define NELEM(A) (sizeof(A) / sizeof(A[0]))
372 /* sizeof() for member fields */
373 #define SIZEOF_FIELD(T,F) sizeof(((T *)NULL)->F)
375 /* Casts-away (*NOT* cast-away) */
376 #define UNUSED(X) ((void)(X))
377 #define UNCONST(P) ((void*)(uintptr_t)(void const*)(P))
378 #define UNVOLATILE(P) ((void*)(uintptr_t)(void volatile*)(P))
379 #define UNXXX(T,C,P) ((T)(uintptr_t)(C)(P))
381 /* __STDC_VERSION__ is ISO C99, so also use __STDC__, which should work */
382 #if defined __STDC__ || defined __STDC_VERSION__ /*|| defined __cplusplus*/
383 # define STRING(X) #X
384 # define XSTRING(X) STRING(X)
385 # define CONCAT(S1,S2) _CONCAT(S1, S2)
386 # define _CONCAT(S1,S2) S1 ## S2
388 # define STRING(X) "X"
389 # define XSTRING STRING
390 # define CONCAT(S1,S2) S1/**/S2
393 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
394 # define n_FIELD_INITN(N) CONCAT(., N) =
395 # define n_FIELD_INITI(I) [I] =
397 # define n_FIELD_INITN(N)
398 # define n_FIELD_INITI(N)
401 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
402 # define VFIELD_SIZE(X)
403 # define VFIELD_SIZEOF(T,F) (0)
404 # define VSTRUCT_SIZEOF(T,F) sizeof(T)
406 # define VFIELD_SIZE(X) \
407 ((X) == 0 ? sizeof(size_t) \
408 : ((ssize_t)(X) < 0 ? sizeof(size_t) - ABS(X) : (size_t)(X)))
409 # define VFIELD_SIZEOF(T,F) SIZEOF_FIELD(T, F)
410 # define VSTRUCT_SIZEOF(T,F) (sizeof(T) - SIZEOF_FIELD(T, F))
414 # define SINLINE n_INLINE /* TODO obsolete */
416 # define SINLINE static
420 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
421 # define __FUN__ __func__
422 #elif CC_CLANG || PREREQ_GCC(3, 4)
423 # define __FUN__ __extension__ __FUNCTION__
425 # define __FUN__ uagent /* Something that is not a literal */
428 #if defined __predict_true && defined __predict_false
429 # define LIKELY(X) __predict_true(X)
430 # define UNLIKELY(X) __predict_false(X)
431 #elif CC_CLANG || PREREQ_GCC(2, 96)
432 # define LIKELY(X) __builtin_expect(X, 1)
433 # define UNLIKELY(X) __builtin_expect(X, 0)
435 # define LIKELY(X) (X)
436 # define UNLIKELY(X) (X)
439 #undef HAVE_NATCH_CHAR
441 #if defined HAVE_SETLOCALE && defined HAVE_C90AMEND1 && defined HAVE_WCWIDTH
442 # define HAVE_NATCH_CHAR
443 # define NATCH_CHAR(X) X
445 # define NATCH_CHAR(X)
448 /* Compile-Time-Assert
449 * Problem is that some compilers warn on unused local typedefs, so add
450 * a special local CTA to overcome this */
451 #define CTA(TEST) _CTA_1(TEST, n_FILE, __LINE__)
452 #define LCTA(TEST) _LCTA_1(TEST, n_FILE, __LINE__)
454 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 201112L
455 # define n_CTA(T,M) _Static_assert(T, M)
456 # define n_LCTA(T,M) _Static_assert(T, M)
458 # define n_CTA(T,M) _CTA_1(T, n_FILE, __LINE__)
459 # define n_LCTA(T,M) _LCTA_1(T, n_FILE, __LINE__)
461 #define n_CTAV(T) n_CTA(T, "Unexpected value of constant")
462 #define n_LCTAV(T) n_LCTA(T, "Unexpected value of constant")
465 # define n_MCTA(T,M) n_CTA(T, M);
470 #define _CTA_1(T,F,L) _CTA_2(T, F, L)
471 #define _CTA_2(T,F,L) \
472 typedef char ASSERTION_failed_in_file_## F ## _at_line_ ## L[(T) ? 1 : -1]
473 #define _LCTA_1(T,F,L) _LCTA_2(T, F, L)
474 #define _LCTA_2(T,F,L) \
476 typedef char ASSERTION_failed_in_file_## F ## _at_line_ ## L[(T) ? 1 : -1];\
477 ASSERTION_failed_in_file_## F ## _at_line_ ## L __i_am_unused__;\
478 UNUSED(__i_am_unused__);\
481 #define UNINIT(N,V) N = V
484 #define ISPOW2(X) ((((X) - 1) & (X)) == 0)
486 #define MIN(A, B) ((A) < (B) ? (A) : (B))
488 #define MAX(A, B) ((A) < (B) ? (B) : (A))
490 #define ABS(A) ((A) < 0 ? -(A) : (A))
492 /* Create a bit mask for the bit range LO..HI -- HI can't use highest bit! */
493 #define n_BITENUM_MASK(LO,HI) (((1u << ((HI) + 1)) - 1) & ~((1u << (LO)) - 1))
499 # define assert(X) UNUSED(0)
502 # define DBGOR(X,Y) Y
506 # define DBGOR(X,Y) X
509 /* Translation (init in main.c) */
522 # define UI8_MAX UINT8_MAX
523 # define SI8_MIN INT8_MIN
524 # define SI8_MAX INT8_MAX
525 typedef uint8_t ui8_t
;
526 typedef int8_t si8_t
;
527 #elif UCHAR_MAX != 255
528 # error UCHAR_MAX must be 255
530 # define UI8_MAX UCHAR_MAX
531 # define SI8_MIN CHAR_MIN
532 # define SI8_MAX CHAR_MAX
533 typedef unsigned char ui8_t
;
534 typedef signed char si8_t
;
537 #if !defined PRIu8 || !defined PRId8
545 # define UI16_MAX UINT16_MAX
546 # define SI16_MIN INT16_MIN
547 # define SI16_MAX INT16_MAX
548 typedef uint16_t ui16_t
;
549 typedef int16_t si16_t
;
550 #elif USHRT_MAX != 0xFFFFu
551 # error USHRT_MAX must be 0xFFFF
553 # define UI16_MAX USHRT_MAX
554 # define SI16_MIN SHRT_MIN
555 # define SI16_MAX SHRT_MAX
556 typedef unsigned short ui16_t
;
557 typedef signed short si16_t
;
560 #if !defined PRIu16 || !defined PRId16
563 # if UI16_MAX == UINT_MAX
573 # define UI32_MAX UINT32_MAX
574 # define SI32_MIN INT32_MIN
575 # define SI32_MAX INT32_MAX
576 typedef uint32_t ui32_t
;
577 typedef int32_t si32_t
;
578 #elif ULONG_MAX == 0xFFFFFFFFu
579 # define UI32_MAX ULONG_MAX
580 # define SI32_MIN LONG_MIN
581 # define SI32_MAX LONG_MAX
582 typedef unsigned long int ui32_t
;
583 typedef signed long int si32_t
;
584 #elif UINT_MAX != 0xFFFFFFFFu
585 # error UINT_MAX must be 0xFFFFFFFF
587 # define UI32_MAX UINT_MAX
588 # define SI32_MIN INT_MIN
589 # define SI32_MAX INT_MAX
590 typedef unsigned int ui32_t
;
591 typedef signed int si32_t
;
594 #if !defined PRIu32 || !defined PRId32
597 # if UI32_MAX == ULONG_MAX
607 # define UI64_MAX UINT64_MAX
608 # define SI64_MIN INT64_MIN
609 # define SI64_MAX INT64_MAX
610 typedef uint64_t ui64_t
;
611 typedef int64_t si64_t
;
612 #elif ULONG_MAX <= 0xFFFFFFFFu
613 # if !defined ULLONG_MAX || (ULLONG_MAX >> 31) < 0xFFFFFFFFu
614 # error We need a 64 bit integer
616 # define UI64_MAX ULLONG_MAX
617 # define SI64_MIN LLONG_MIN
618 # define SI64_MAX LLONG_MAX
619 __EXTEN
typedef unsigned long long ui64_t
;
620 __EXTEN
typedef signed long long si64_t
;
623 # define UI64_MAX ULONG_MAX
624 # define SI64_MIN LONG_MIN
625 # define SI64_MAX LONG_MAX
626 typedef unsigned long ui64_t
;
627 typedef signed long si64_t
;
630 #if !defined PRIu64 || !defined PRId64 || !defined PRIX64
634 # if defined ULLONG_MAX && UI64_MAX == ULLONG_MAX
635 # define PRIu64 "llu"
636 # define PRId64 "lld"
637 # define PRIX64 "llX"
645 /* (So that we can use UICMP() for size_t comparison, too) */
646 typedef size_t uiz_t
;
647 typedef ssize_t siz_t
;
651 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
654 # define UIZ_MAX SIZE_MAX
655 #elif defined SIZE_MAX
656 /* UnixWare has size_t as unsigned as required but uses a signed limit
657 * constant (which is thus false!) */
658 # if SIZE_MAX == UI64_MAX || SIZE_MAX == SI64_MAX
659 # define PRIuZ PRIu64
660 # define PRIdZ PRId64
661 n_MCTA(sizeof(size_t) == sizeof(ui64_t
),
662 "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
663 # elif SIZE_MAX == UI32_MAX || SIZE_MAX == SI32_MAX
664 # define PRIuZ PRIu32
665 # define PRIdZ PRId32
666 n_MCTA(sizeof(size_t) == sizeof(ui32_t
),
667 "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
669 # error SIZE_MAX is neither UI64_MAX nor UI32_MAX (please report this)
671 # define UIZ_MAX SIZE_MAX
676 n_MCTA(sizeof(size_t) == sizeof(unsigned long),
677 "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
678 # define UIZ_MAX ULONG_MAX
683 # define uintptr_t size_t
684 # define UINTPTR_MAX SIZE_MAX
686 # define uintptr_t unsigned long
687 # define UINTPTR_MAX ULONG_MAX
691 #if !defined PRIuPTR || !defined PRIXPTR
694 # if UINTPTR_MAX == ULONG_MAX
695 # define PRIuPTR "lu"
696 # define PRIXPTR "lX"
703 #ifdef HAVE_C90AMEND1
704 typedef wchar_t wc_t
;
705 # define n_WC_C(X) L ## X
707 typedef char wc_t
; /* Yep: really 8-bit char */
711 enum {FAL0
, TRU1
, TRUM1
= -1};
712 typedef si8_t bool_t
;
714 /* Add shorter aliases for "normal" integers */
715 typedef unsigned long ul_i
;
716 typedef unsigned int ui_i
;
717 typedef unsigned short us_i
;
718 typedef unsigned char uc_i
;
720 typedef signed long sl_i
;
721 typedef signed int si_i
;
722 typedef signed short ss_i
;
723 typedef signed char sc_i
;
725 typedef void ( *sighandler_type
)(int);
728 AUTHTYPE_NONE
= 1<<0,
729 AUTHTYPE_PLAIN
= 1<<1, /* POP3: APOP is covered by this */
730 AUTHTYPE_LOGIN
= 1<<2,
731 AUTHTYPE_CRAM_MD5
= 1<<3,
732 AUTHTYPE_GSSAPI
= 1<<4
735 enum expand_addr_flags
{
736 EAF_NONE
= 0, /* -> EAF_NOFILE | EAF_NOPIPE */
737 EAF_RESTRICT
= 1<<0, /* "restrict" (do unless interaktive / -[~#]) */
738 EAF_FAIL
= 1<<1, /* "fail" */
739 /* Bits reused by enum expand_addr_check_mode! */
740 EAF_FILE
= 1<<3, /* +"file" targets */
741 EAF_PIPE
= 1<<4, /* +"pipe" command pipe targets */
742 EAF_NAME
= 1<<5, /* +"name"s (non-address) names / MTA aliases */
743 EAF_ADDR
= 1<<6, /* +"addr" network address (contain "@") */
745 EAF_TARGET_MASK
= EAF_FILE
| EAF_PIPE
| EAF_NAME
| EAF_ADDR
,
746 EAF_RESTRICT_TARGETS
= EAF_NAME
| EAF_ADDR
/* (default set if not set) */
749 enum expand_addr_check_mode
{
750 EACM_NONE
= 0, /* Don't care about *expandaddr* */
751 EACM_NORMAL
= 1<<0, /* Use our normal *expandaddr* checking */
752 EACM_STRICT
= 1<<1, /* Never allow any file or pipe addresse */
753 EACM_MODE_MASK
= 0x3, /* _NORMAL and _STRICT are mutual! */
755 EACM_NOLOG
= 1<<2, /* Don't log check errors */
757 /* Some special overwrites of EAF_TARGETs.
758 * May NOT clash with EAF_* bits which may be ORd to these here! */
763 enum n_cmd_arg_desc_flags
{/* TODO incomplete, misses getmsglist() */
765 n_CMD_ARG_DESC_STRING
= 1<<0, /* A !blankspacechar() string */
766 n_CMD_ARG_DESC_WYSH
= 1<<1, /* sh(1)ell-style quoted */
768 n__CMD_ARG_DESC_TYPE_MASK
= n_CMD_ARG_DESC_STRING
| n_CMD_ARG_DESC_WYSH
,
770 /* - Optional flags */
771 /* It is not an error if an optional argument is missing; once an argument
772 * has been declared optional only optional arguments may follow */
773 n_CMD_ARG_DESC_OPTION
= 1<<16,
774 /* GREEDY: parse as many of that type as possible; must be last entry */
775 n_CMD_ARG_DESC_GREEDY
= 1<<17,
776 /* Honour an overall "stop" request in one of the arguments (\c@ or #) */
777 n_CMD_ARG_DESC_HONOUR_STOP
= 1<<18,
779 n__CMD_ARG_DESC_FLAG_MASK
= n_CMD_ARG_DESC_OPTION
| n_CMD_ARG_DESC_GREEDY
|
780 n_CMD_ARG_DESC_HONOUR_STOP
784 /* We do have several contexts of colour IDs; since only one of them can be
785 * active at any given time let's share the value range */
795 n_COLOUR_ID_SUM_DOTMARK
= 0,
796 n_COLOUR_ID_SUM_HEADER
,
797 n_COLOUR_ID_SUM_THREAD
,
799 /* Message display */
800 n_COLOUR_ID_VIEW_FROM_
= 0,
801 n_COLOUR_ID_VIEW_HEADER
,
802 n_COLOUR_ID_VIEW_MSGINFO
,
803 n_COLOUR_ID_VIEW_PARTINFO
,
805 /* Mailx-Line-Editor */
806 n_COLOUR_ID_MLE_POSITION
= 0,
807 n_COLOUR_ID_MLE_PROMPT
,
809 n__COLOUR_IDS
= n_COLOUR_ID_VIEW_PARTINFO
+ 1
812 /* Colour preconditions, let's call them tags, cannot be an enum because for
813 * message display they are the actual header name of the current header. Thus
814 * let's use constants of pseudo pointers */
815 # define n_COLOUR_TAG_SUM_DOT ((char*)-2)
816 # define n_COLOUR_TAG_SUM_OLDER ((char*)-3)
817 #endif /* HAVE_COLOUR */
820 CONV_NONE
, /* no conversion */
821 CONV_7BIT
, /* no conversion, is 7bit */
822 CONV_FROMQP
, /* convert from quoted-printable */
823 CONV_TOQP
, /* convert to quoted-printable */
824 CONV_8BIT
, /* convert to 8bit (iconv) */
825 CONV_FROMB64
, /* convert from base64 */
826 CONV_FROMB64_T
, /* convert from base64/text */
827 CONV_TOB64
, /* convert to base64 */
828 CONV_FROMHDR
, /* convert from RFC1522 format */
829 CONV_TOHDR
, /* convert to RFC1522 format */
830 CONV_TOHDR_A
/* convert addresses for header */
838 enum n_dotlock_state
{
840 n_DLS_CANT_CHDIR
, /* Failed to chdir(2) into desired path */
841 n_DLS_NAMETOOLONG
, /* Lock file name would be too long */
842 n_DLS_ROFS
, /* Read-only filesystem (no error, mailbox RO) */
843 n_DLS_NOPERM
, /* No permission to creat lock file */
844 n_DLS_NOEXEC
, /* Privilege separated dotlocker not found */
845 n_DLS_PRIVFAILED
, /* Rising privileges failed in dotlocker */
846 n_DLS_EXIST
, /* Lock file already exists, stale lock? */
847 n_DLS_FISHY
, /* Something makes us think bad of situation */
848 n_DLS_DUNNO
, /* Catch-all error */
849 n_DLS_PING
, /* Not an error, but have to wait for lock */
850 n_DLS_ABANDON
= 1<<7 /* ORd to any but _NONE: give up, don't retry */
854 EXIT_OK
= EXIT_SUCCESS
,
855 EXIT_ERR
= EXIT_FAILURE
,
856 EXIT_USE
= 64, /* sysexits.h:EX_USAGE */
857 EXIT_NOUSER
= 67, /* :EX_NOUSER */
858 EXIT_COLL_ABORT
= 1<<1, /* Message collection was aborted */
859 EXIT_SEND_ERROR
= 1<<2 /* Unspecified send error occurred */
864 FEDIT_SYSBOX
= 1<<0, /* %: prefix */
865 FEDIT_RDONLY
= 1<<1, /* Readonly (per-box, OPT_R_FLAG is global) */
866 FEDIT_NEWMAIL
= 1<<2 /* `newmail' operation TODO OBSOLETE THIS! */
870 FEXP_FULL
, /* Full expansion */
871 FEXP_NOPROTO
= 1<<0, /* TODO no which_protocol() to decide expansion */
872 FEXP_LOCAL
= 1<<1, /* Result must be local file/maildir */
873 FEXP_NSHORTCUT
= 1<<2, /* Don't expand shortcuts */
874 FEXP_SILENT
= 1<<3, /* Don't print but only return errors */
875 FEXP_MULTIOK
= 1<<4, /* Expansion to many entries is ok */
876 FEXP_NSHELL
= 1<<5, /* Don't do shell word exp. (but ~/, $VAR) */
877 FEXP_NVAR
= 1<<6 /* ..not even $VAR expansion */
880 enum n_file_lock_type
{
886 MIME_UNKNOWN
, /* unknown content */
887 MIME_SUBHDR
, /* inside a multipart subheader */
888 MIME_822
, /* message/rfc822 content */
889 MIME_MESSAGE
, /* other message/ content */
890 MIME_TEXT_PLAIN
, /* text/plain content */
891 MIME_TEXT_HTML
, /* text/html content */
892 MIME_TEXT
, /* other text/ content */
893 MIME_ALTERNATIVE
, /* multipart/alternative content */
894 MIME_RELATED
, /* mime/related (RFC 2387) */
895 MIME_DIGEST
, /* multipart/digest content */
896 MIME_MULTI
, /* other multipart/ content */
897 MIME_PKCS7
, /* PKCS7 content */
898 MIME_DISCARD
/* content is discarded */
901 enum mime_counter_evidence
{
903 MIMECE_SET
= 1<<0, /* *mime-counter-evidence* was set */
904 MIMECE_BIN_OVWR
= 1<<1, /* appli../octet-stream: check, ovw if possible */
905 MIMECE_ALL_OVWR
= 1<<2, /* all: check, ovw if possible */
906 MIMECE_BIN_PARSE
= 1<<3 /* appli../octet-stream: classify contents last */
909 /* Content-Transfer-Encodings as defined in RFC 2045:
910 * - Quoted-Printable, section 6.7
911 * - Base64, section 6.8 */
912 #define QP_LINESIZE (4 * 19) /* Max. compliant QP linesize */
914 #define B64_LINESIZE (4 * 19) /* Max. compliant Base64 linesize */
915 #define B64_ENCODE_INPUT_PER_LINE 57 /* Max. input for Base64 encode/line */
918 MIMEE_NONE
, /* message is not in MIME format */
919 MIMEE_BIN
, /* message is in binary encoding */
920 MIMEE_8B
, /* message is in 8bit encoding */
921 MIMEE_7B
, /* message is in 7bit encoding */
922 MIMEE_QP
, /* message is quoted-printable */
923 MIMEE_B64
/* message is in base64 encoding */
926 /* xxx QP came later, maybe rewrite all to use mime_enc_flags directly? */
927 enum mime_enc_flags
{
929 MIMEEF_SALLOC
= 1<<0, /* Use salloc(), not srealloc().. */
930 /* ..result .s,.l point to user buffer of *_LINESIZE+[+[+]] bytes instead */
932 MIMEEF_CRLF
= 1<<2, /* (encode) Append "\r\n" to lines */
933 MIMEEF_LF
= 1<<3, /* (encode) Append "\n" to lines */
934 /* (encode) If one of _CRLF/_LF is set, honour *_LINESIZE+[+[+]] and
935 * inject the desired line-ending whenever a linewrap is desired */
936 MIMEEF_MULTILINE
= 1<<4,
937 /* (encode) Quote with header rules, do not generate soft NL breaks?
938 * For mustquote(), specifies wether special RFC 2047 header rules
939 * should be used instead */
940 MIMEEF_ISHEAD
= 1<<5,
941 /* (encode) Ditto; for mustquote() this furtherly fine-tunes behaviour in
942 * that characters which would not be reported as "must-quote" when
943 * detecting wether quoting is necessary at all will be reported as
944 * "must-quote" if they have to be encoded in an encoded word */
945 MIMEEF_ISENCWORD
= 1<<6,
950 QP_NONE
= MIMEEF_NONE
,
951 QP_SALLOC
= MIMEEF_SALLOC
,
953 QP_ISHEAD
= MIMEEF_ISHEAD
,
954 QP_ISENCWORD
= MIMEEF_ISENCWORD
958 B64_NONE
= MIMEEF_NONE
,
959 B64_SALLOC
= MIMEEF_SALLOC
,
960 B64_BUF
= MIMEEF_BUF
,
961 B64_CRLF
= MIMEEF_CRLF
,
963 B64_MULTILINE
= MIMEEF_MULTILINE
,
964 /* Not used, but for clarity only */
965 B64_ISHEAD
= MIMEEF_ISHEAD
,
966 B64_ISENCWORD
= MIMEEF_ISENCWORD
,
967 /* Special version of Base64, "Base64URL", according to RFC 4648.
968 * Only supported for encoding! */
969 B64_RFC4648URL
= 1<<(__MIMEEF_LAST
+1),
970 /* Don't use any ("=") padding;
971 * may NOT be used with any of _CRLF, _LF or _MULTILINE */
972 B64_NOPAD
= 1<<(__MIMEEF_LAST
+2)
975 enum mime_parse_flags
{
977 MIME_PARSE_DECRYPT
= 1<<0,
978 MIME_PARSE_PARTS
= 1<<1
981 enum mime_handler_flags
{
982 MIME_HDL_NULL
, /* No pipe- mimetype handler, go away */
983 MIME_HDL_CMD
, /* Normal command */
984 MIME_HDL_TEXT
, /* @ special cmd to force treatment as text */
985 MIME_HDL_PTF
, /* A special pointer-to-function handler */
986 MIME_HDL_MSG
, /* Display msg (returned as command string) */
987 MIME_HDL_TYPE_MASK
= 7,
988 MIME_HDL_ISQUOTE
= 1<<4, /* Is quote action (we have info, keep it!) */
989 MIME_HDL_NOQUOTE
= 1<<5, /* No MIME for quoting */
990 MIME_HDL_ALWAYS
= 1<<6, /* Handler shall run for multi-msg actions */
991 MIME_HDL_ASYNC
= 1<<7, /* Should run asynchronously */
992 MIME_HDL_NEEDSTERM
= 1<<8, /* Takes over terminal */
993 MIME_HDL_TMPF
= 1<<9, /* Create temporary file (zero-sized) */
994 MIME_HDL_TMPF_FILL
= 1<<10, /* Fill in the msg body content */
995 MIME_HDL_TMPF_UNLINK
= 1<<11 /* Delete it later again */
999 MLIST_OTHER
= 0, /* Normal address */
1000 MLIST_KNOWN
= 1, /* A known `mlist' */
1001 MLIST_SUBSCRIBED
= -1 /* A `mlsubscribe'd list */
1012 OF_CLOEXEC
= 1<<7, /* TODO not used, always implied! CHANGE!! */
1013 OF_UNLINK
= 1<<8, /* Only for Ftmp(): unlink(2) after creation */
1014 OF_HOLDSIGS
= 1<<9, /* Mutual with OF_UNLINK - await Ftmp_free() */
1015 OF_REGISTER
= 1<<10, /* Register file in our file table */
1016 OF_REGISTER_UNLINK
= 1<<11, /* unlink(2) upon unreg.; _REGISTER asserted! */
1017 OF_SUFFIX
= 1<<12 /* Ftmp() name hint is mandatory! extension! */
1025 enum okey_xlook_mode
{
1026 OXM_PLAIN
= 1<<0, /* Plain key always tested */
1027 OXM_H_P
= 1<<1, /* Check PLAIN-.url_h_p */
1028 OXM_U_H_P
= 1<<2, /* Check PLAIN-.url_u_h_p */
1032 /* <0 means "stop" unless *prompt* extensions are enabled. */
1034 PROMPT_STOP
= -1, /* \c */
1035 /* *prompt* extensions: \$, \@ etc. */
1041 PROTO_FILE
, /* refers to a local file */
1042 PROTO_POP3
, /* is a pop3 server string */
1043 PROTO_MAILDIR
, /* refers to a maildir folder */
1044 PROTO_UNKNOWN
/* unknown protocol */
1048 SEND_MBOX
, /* no conversion to perform */
1049 SEND_RFC822
, /* no conversion, no From_ line */
1050 SEND_TODISP
, /* convert to displayable form */
1051 SEND_TODISP_ALL
, /* same, include all MIME parts */
1052 SEND_SHOW
, /* convert to 'show' command form */
1053 SEND_TOSRCH
, /* convert for IMAP SEARCH */
1054 SEND_TOFILE
, /* convert for saving body to a file */
1055 SEND_TOPIPE
, /* convert for pipe-content/subc. */
1056 SEND_QUOTE
, /* convert for quoting */
1057 SEND_QUOTE_ALL
, /* same, include all MIME parts */
1058 SEND_DECRYPT
/* decrypt */
1061 enum n_shexp_parse_flags
{
1063 /* Don't perform any expansions or interpret backslash escape sequences etc.
1064 * Output may be NULL, otherwise the possibly trimmed non-expanded input is
1066 n_SHEXP_PARSE_DRYRUN
= 1<<0,
1067 n_SHEXP_PARSE_TRUNC
= 1<<1, /* Truncate result storage on entry */
1068 n_SHEXP_PARSE_TRIMSPACE
= 1<<2, /* Ignore space surrounding tokens */
1069 n_SHEXP_PARSE_LOG
= 1<<3, /* Log errors */
1070 n_SHEXP_PARSE_LOG_D_V
= 1<<4, /* Log errors if OPT_D_V */
1071 n_SHEXP_PARSE_IFS_ADD_COMMA
= 1<<5, /* Add comma , to normal "IFS" */
1072 n_SHEXP_PARSE_IFS_IS_COMMA
= 1<<6, /* Let comma , be the sole "IFS" */
1073 n_SHEXP_PARSE_IGNORE_EMPTY
= 1<<7, /* Ignore empty tokens, start over */
1074 n__SHEXP_PARSE_LAST
= 7
1079 /* We have produced some output (or would have, with _PARSE_DRYRUN).
1080 * Note that empty quotes like '' produce no output but set this bit */
1081 n_SHEXP_STATE_OUTPUT
= 1<<2,
1082 /* Don't call the parser again (\c0 or # comment seen; out of input).
1083 * Not (necessarily) mutual with _OUTPUT) */
1084 n_SHEXP_STATE_STOP
= 1<<1,
1085 n_SHEXP_STATE_UNICODE
= 1<<3, /* \[Uu] used */
1086 n_SHEXP_STATE_CONTROL
= 1<<4, /* Control characters seen */
1088 n_SHEXP_STATE_ERR_CONTROL
= 1<<16, /* \c notation with invalid argument */
1089 n_SHEXP_STATE_ERR_UNICODE
= 1<<17, /* Valid \[Uu] used and !OPT_UNICODE */
1090 n_SHEXP_STATE_ERR_NUMBER
= 1<<18, /* Bad number (\[UuXx]) */
1091 n_SHEXP_STATE_ERR_BRACE
= 1<<19, /* _QUOTEOPEN + no } brace for ${VAR */
1092 n_SHEXP_STATE_ERR_BADSUB
= 1<<20, /* Empty/bad ${} substitution */
1093 n_SHEXP_STATE_ERR_QUOTEOPEN
= 1<<21, /* Quote remains open at EOS */
1095 n_SHEXP_STATE_ERR_MASK
= n_BITENUM_MASK(16, 21)
1098 enum n_sigman_flags
{
1100 n_SIGMAN_HUP
= 1<<0,
1101 n_SIGMAN_INT
= 1<<1,
1102 n_SIGMAN_QUIT
= 1<<2,
1103 n_SIGMAN_TERM
= 1<<3,
1104 n_SIGMAN_PIPE
= 1<<4,
1106 n_SIGMAN_IGN_HUP
= 1<<5,
1107 n_SIGMAN_IGN_INT
= 1<<6,
1108 n_SIGMAN_IGN_QUIT
= 1<<7,
1109 n_SIGMAN_IGN_TERM
= 1<<8,
1111 n_SIGMAN_ALL
= 0xFF,
1112 /* Mostly for _leave() reraise flags */
1113 n_SIGMAN_VIPSIGS
= n_SIGMAN_HUP
| n_SIGMAN_INT
| n_SIGMAN_QUIT
|
1115 n_SIGMAN_NTTYOUT_PIPE
= 1<<16,
1116 n_SIGMAN_VIPSIGS_NTTYOUT
= n_SIGMAN_HUP
| n_SIGMAN_INT
| n_SIGMAN_QUIT
|
1117 n_SIGMAN_TERM
| n_SIGMAN_NTTYOUT_PIPE
,
1119 n__SIGMAN_PING
= 1<<17
1123 enum ssl_verify_level
{
1132 TD_NONE
, /* no display conversion */
1133 TD_ISPR
= 1<<0, /* use isprint() checks */
1134 TD_ICONV
= 1<<1, /* use iconv() */
1135 TD_DELCTRL
= 1<<2, /* delete control characters */
1138 * NOTE: _TD_EOF and _TD_BUFCOPY may be ORd with enum conversion and
1139 * enum sendaction, and may thus NOT clash with their bit range!
1141 _TD_EOF
= 1<<14, /* EOF seen, last round! */
1142 _TD_BUFCOPY
= 1<<15 /* Buffer may be constant, copy it */
1146 enum n_termcap_captype
{
1147 n_TERMCAP_CAPTYPE_NONE
= 0,
1148 /* Internally we share the bitspace, so ensure no value ends up as 0 */
1149 n_TERMCAP_CAPTYPE_BOOL
= 1,
1150 n_TERMCAP_CAPTYPE_NUMERIC
,
1151 n_TERMCAP_CAPTYPE_STRING
,
1152 n__TERMCAP_CAPTYPE_MAX
1155 /* Termcap commands; different to queries commands perform actions.
1156 * Commands are resolved upon init time, and are all termcap(5)-compatible,
1157 * therefore we use the short termcap(5) names.
1158 * Note this is parsed by mk-tcap-map.pl, which expects the syntax
1159 * "CONSTANT, COMMENT" where COMMENT is "Capname/TCap-Code, TYPE[, FLAGS]",
1160 * and one of Capname and TCap-Code may be the string "-" meaning ENOENT;
1161 * a | vertical bar or end-of-comment ends processing; see termcap.c.
1162 * We may use the free-form part after | for the "Variable String" and notes on
1163 * necessary termcap_cmd() arguments; if those are in [] brackets they are not
1164 * regular but are only used when the command, i.e., its effect, is somehow
1165 * simulated / faked by a builtin fallback implementation.
1166 * Availability of builtin fallback indicated by leading @ (at-sign) */
1168 # ifdef HAVE_TERMCAP
1169 n_TERMCAP_CMD_te
, /* rmcup/te, STRING | exit_ca_mode: -,- */
1170 n_TERMCAP_CMD_ti
, /* smcup/ti, STRING | enter_ca_mode: -,- */
1172 n_TERMCAP_CMD_ks
, /* smkx/ks, STRING | keypad_xmit: -,- */
1173 n_TERMCAP_CMD_ke
, /* rmkx/ke, STRING | keypad_local: -,- */
1175 n_TERMCAP_CMD_cd
, /* ed/cd, STRING | clr_eos: -,- */
1176 n_TERMCAP_CMD_cl
, /* clear/cl, STRING | clear_screen(+home): -,- */
1177 n_TERMCAP_CMD_ho
, /* home/ho, STRING | cursor_home: -,- */
1181 n_TERMCAP_CMD_ce
, /* el/ce, STRING | @ clr_eol: [start-column],- */
1182 n_TERMCAP_CMD_ch
, /* hpa/ch, STRING, IDX1 | column_address: column,- */
1183 n_TERMCAP_CMD_cr
, /* cr/cr, STRING | @ carriage_return: -,- */
1184 n_TERMCAP_CMD_le
, /* cub1/le, STRING, CNT | @ cursor_left: count,- */
1185 n_TERMCAP_CMD_nd
, /* cuf1/nd, STRING, CNT | @ cursor_right: count,- */
1189 n__TERMCAP_CMD_MASK
= (1<<24) - 1,
1191 /* Only perform command if ca-mode is used */
1192 n_TERMCAP_CMD_FLAG_CA_MODE
= 1<<29,
1193 /* I/O should be flushed after command completed */
1194 n_TERMCAP_CMD_FLAG_FLUSH
= 1<<30
1197 /* Termcap queries; a query is a command that returns a struct n_termcap_value.
1198 * Queries are resolved once they are used first, and may not be termcap(5)-
1199 * compatible, therefore we use terminfo(5) names.
1200 * Note this is parsed by mk-tcap-map.pl, which expects the syntax
1201 * "CONSTANT, COMMENT" where COMMENT is "Capname/TCap-Code, TYPE[, FLAGS]",
1202 * and one of Capname and TCap-Code may be the string "-" meaning ENOENT;
1203 * a | vertical bar or end-of-comment ends processing; see termcap.c.
1204 * We may use the free-form part after | for the "Variable String" and notes.
1205 * The "xkey | X:" keys are Dickey's xterm extensions, see (our) manual */
1206 enum n_termcap_query
{
1208 n_TERMCAP_QUERY_colors
, /* colors/Co, NUMERIC | max_colors */
1211 /* --mk-tcap-map--: only KEY_BINDINGS follow. DON'T CHANGE THIS LINE! */
1212 /* Update the `bind' manual on change! */
1213 # ifdef HAVE_KEY_BINDINGS
1214 n_TERMCAP_QUERY_key_backspace
, /* kbs/kb, STRING */
1215 n_TERMCAP_QUERY_key_dc
, /* kdch1/kD, STRING | delete-character */
1216 n_TERMCAP_QUERY_key_sdc
, /* kDC / *4, STRING | ..shifted */
1217 n_TERMCAP_QUERY_key_eol
, /* kel/kE, STRING | clear-to-end-of-line */
1218 n_TERMCAP_QUERY_key_exit
, /* kext/@9, STRING */
1219 n_TERMCAP_QUERY_key_ic
, /* kich1/kI, STRING | insert character */
1220 n_TERMCAP_QUERY_key_sic
, /* kIC/#3, STRING | ..shifted */
1221 n_TERMCAP_QUERY_key_home
, /* khome/kh, STRING */
1222 n_TERMCAP_QUERY_key_shome
, /* kHOM/#2, STRING | ..shifted */
1223 n_TERMCAP_QUERY_key_end
, /* kend/@7, STRING */
1224 n_TERMCAP_QUERY_key_send
, /* kEND / *7, STRING | ..shifted */
1225 n_TERMCAP_QUERY_key_npage
, /* knp/kN, STRING */
1226 n_TERMCAP_QUERY_key_ppage
, /* kpp/kP, STRING */
1227 n_TERMCAP_QUERY_key_left
, /* kcub1/kl, STRING */
1228 n_TERMCAP_QUERY_key_sleft
, /* kLFT/#4, STRING | ..shifted */
1229 n_TERMCAP_QUERY_xkey_aleft
, /* kLFT3/-, STRING | X: Alt+left */
1230 n_TERMCAP_QUERY_xkey_cleft
, /* kLFT5/-, STRING | X: Control+left */
1231 n_TERMCAP_QUERY_key_right
, /* kcuf1/kr, STRING */
1232 n_TERMCAP_QUERY_key_sright
, /* kRIT/%i, STRING | ..shifted */
1233 n_TERMCAP_QUERY_xkey_aright
, /* kRIT3/-, STRING | X: Alt+right */
1234 n_TERMCAP_QUERY_xkey_cright
, /* kRIT5/-, STRING | X: Control+right */
1235 n_TERMCAP_QUERY_key_down
, /* kcud1/kd, STRING */
1236 n_TERMCAP_QUERY_xkey_sdown
, /* kDN/-, STRING | ..shifted */
1237 n_TERMCAP_QUERY_xkey_adown
, /* kDN3/-, STRING | X: Alt+down */
1238 n_TERMCAP_QUERY_xkey_cdown
, /* kDN5/-, STRING | X: Control+down */
1239 n_TERMCAP_QUERY_key_up
, /* kcuu1/ku, STRING */
1240 n_TERMCAP_QUERY_xkey_sup
, /* kUP/-, STRING | ..shifted */
1241 n_TERMCAP_QUERY_xkey_aup
, /* kUP3/-, STRING | X: Alt+up */
1242 n_TERMCAP_QUERY_xkey_cup
, /* kUP5/-, STRING | X: Control+up */
1243 n_TERMCAP_QUERY_kf0
, /* kf0/k0, STRING */
1244 n_TERMCAP_QUERY_kf1
, /* kf1/k1, STRING */
1245 n_TERMCAP_QUERY_kf2
, /* kf2/k2, STRING */
1246 n_TERMCAP_QUERY_kf3
, /* kf3/k3, STRING */
1247 n_TERMCAP_QUERY_kf4
, /* kf4/k4, STRING */
1248 n_TERMCAP_QUERY_kf5
, /* kf5/k5, STRING */
1249 n_TERMCAP_QUERY_kf6
, /* kf6/k6, STRING */
1250 n_TERMCAP_QUERY_kf7
, /* kf7/k7, STRING */
1251 n_TERMCAP_QUERY_kf8
, /* kf8/k8, STRING */
1252 n_TERMCAP_QUERY_kf9
, /* kf9/k9, STRING */
1253 n_TERMCAP_QUERY_kf10
, /* kf10/k;, STRING */
1254 n_TERMCAP_QUERY_kf11
, /* kf11/F1, STRING */
1255 n_TERMCAP_QUERY_kf12
, /* kf12/F2, STRING */
1256 n_TERMCAP_QUERY_kf13
, /* kf13/F3, STRING */
1257 n_TERMCAP_QUERY_kf14
, /* kf14/F4, STRING */
1258 n_TERMCAP_QUERY_kf15
, /* kf15/F5, STRING */
1259 n_TERMCAP_QUERY_kf16
, /* kf16/F6, STRING */
1260 n_TERMCAP_QUERY_kf17
, /* kf17/F7, STRING */
1261 n_TERMCAP_QUERY_kf18
, /* kf18/F8, STRING */
1262 n_TERMCAP_QUERY_kf19
, /* kf19/F9, STRING */
1263 # endif /* HAVE_KEY_BINDINGS */
1265 n__TERMCAP_QUERY_MAX
1267 #endif /* n_HAVE_TCAP */
1269 enum n_visual_info_flags
{
1271 n_VISUAL_INFO_ONE_CHAR
= 1<<0, /* Step only one char, then return */
1272 n_VISUAL_INFO_SKIP_ERRORS
= 1<<1, /* Treat via replacement, step byte */
1273 n_VISUAL_INFO_WIDTH_QUERY
= 1<<2, /* Detect visual character widths */
1275 /* Rest only with HAVE_C90AMEND1, mutual with _ONE_CHAR */
1276 n_VISUAL_INFO_WOUT_CREATE
= 1<<8, /* Use/create .vic_woudat */
1277 n_VISUAL_INFO_WOUT_SALLOC
= 1<<9, /* ..salloc() it first */
1278 /* Only visuals into .vic_woudat - implies _WIDTH_QUERY */
1279 n_VISUAL_INFO_WOUT_PRINTABLE
= 1<<10,
1280 n__VISUAL_INFO_FLAGS
= n_VISUAL_INFO_WOUT_CREATE
|
1281 n_VISUAL_INFO_WOUT_SALLOC
| n_VISUAL_INFO_WOUT_PRINTABLE
1286 OPT_DEBUG
= 1u<< 0, /* -d / *debug* */
1287 OPT_VERB
= 1u<< 1, /* -v / *verbose* */
1288 OPT_VERBVERB
= 1u<< 2, /* .. even more verbosity */
1289 OPT_EXISTONLY
= 1u<< 3, /* -e */
1290 OPT_HEADERSONLY
= 1u<<4, /* -H */
1291 OPT_HEADERLIST
= 1u<< 5, /* -L */
1292 OPT_QUICKRUN_MASK
= OPT_EXISTONLY
| OPT_HEADERSONLY
| OPT_HEADERLIST
,
1293 OPT_E_FLAG
= 1u<< 7, /* -E / *skipemptybody* */
1294 OPT_F_FLAG
= 1u<< 8, /* -F */
1295 OPT_Mm_FLAG
= 1u<< 9, /* -M or -m (plus option_Mm_arg) */
1296 OPT_N_FLAG
= 1u<<10, /* -N / *header* */
1297 OPT_R_FLAG
= 1u<<11, /* -R */
1298 OPT_r_FLAG
= 1u<<12, /* -r (plus option_r_arg) */
1299 OPT_t_FLAG
= 1u<<13, /* -t */
1300 OPT_TILDE_FLAG
= 1u<<14, /* -~ */
1301 OPT_BATCH_FLAG
= 1u<<15, /* -# */
1304 OPT_MEMDEBUG
= 1<<16, /* *memdebug* */
1307 OPT_SENDMODE
= 1u<<17, /* Usage case forces send mode */
1309 OPT_TTYOUT
= 1u<<19,
1310 OPT_INTERACTIVE
= 1u<<20,
1311 OPT_UNICODE
= 1u<<21, /* We're in an UTF-8 environment */
1312 OPT_ENC_MBSTATE
= 1u<<22, /* Multibyte environment with shift states */
1314 /* Some easy-access shortcuts */
1315 OPT_D_V
= OPT_DEBUG
| OPT_VERB
,
1316 OPT_D_VV
= OPT_DEBUG
| OPT_VERBVERB
,
1317 OPT_D_V_VV
= OPT_DEBUG
| OPT_VERB
| OPT_VERBVERB
1320 #define OBSOLETE(X) \
1322 if (options & OPT_D_V_VV)\
1323 n_err("%s: %s\n", _("Obsoletion warning"), X);\
1325 #define OBSOLETE2(X,Y) \
1327 if (options & OPT_D_V_VV)\
1328 n_err("%s: %s: %s\n", _("Obsoletion warning"), X, Y);\
1331 enum program_state
{
1333 PS_STARTED
= 1<< 0, /* main.c startup code passed, functional */
1334 PS_ROOT
= 1<<30, /* Temporary "bypass any checks" bit */
1336 PS_EXIT
= 1<< 1, /* Exit request pending */
1337 PS_SOURCING
= 1<< 2, /* During load() or `source' */
1338 PS_RECURSED
= 1<< 3, /* State machine recursed, e.g. `~:CMD' */
1339 PS_ROBOT
= 1<< 4, /* State machine in non-interactive state */
1341 PS_EVAL_ERROR
= 1<< 5, /* Last evaluate() command failed */
1343 PS_HOOK_NEWMAIL
= 1<< 6,
1345 PS_HOOK_MASK
= PS_HOOK_NEWMAIL
| PS_HOOK
,
1347 PS_EDIT
= 1<< 8, /* Current mailbox not a "system mailbox" */
1348 PS_SETFILE_OPENED
= 1<< 9, /* (hack) setfile() opened a new box */
1349 PS_SAW_COMMAND
= 1<<10, /* ..after mailbox switch */
1351 PS_DID_PRINT_DOT
= 1<<12, /* Current message has been printed */
1353 PS_SIGWINCH_PEND
= 1<<14, /* Need update of $COLUMNS/$LINES */
1354 PS_PSTATE_PENDMASK
= PS_SIGWINCH_PEND
, /* pstate housekeeping needed */
1356 PS_ARGLIST_MASK
= n_BITENUM_MASK(17, 18),
1357 PS_MSGLIST_SAW_NO
= 1<<17, /* Last *LIST saw numerics */
1358 PS_MSGLIST_DIRECT
= 1<<18, /* One msg was directly chosen by number */
1359 PS_WYSHLIST_SAW_UNICODE
= 1<<17, /* ARG_WYSHLIST saw \[Uu] */
1360 PS_WYSHLIST_SAW_CONTROL
= 1<<18, /* ..saw C0+ control characters */
1362 PS_EXPAND_MULTIRESULT
= 1<<19, /* Last fexpand() with MULTIOK had .. */
1364 PS_HEADER_NEEDED_MIME
= 1<<20, /* mime_write_tohdr() needed x TODO HACK! */
1366 PS_COLOUR_ACTIVE
= 1<<22, /* n_colour_env_create().._gut() cycle */
1368 /* Various first-time-init switches */
1369 PS_ERRORS_NOTED
= 1<<24, /* Ring of `errors' content, print msg */
1370 PS_t_FLAG
= 1<<26, /* OPT_t_FLAG made persistant */
1371 PS_TERMCAP_DISABLE
= 1<<27, /* HAVE_TERMCAP: *termcap-disable* was set */
1372 PS_TERMCAP_CA_MODE
= 1<<28, /* HAVE_TERMCAP: ca_mode available & used */
1373 PS_HISTORY_LOADED
= 1<<29 /* Command line editor history loaded */
1376 /* A large enum with all the boolean and value options a.k.a their keys.
1377 * Only the constant keys are in here, to be looked up via ok_[bv]look(),
1378 * ok_[bv]set() and ok_[bv]clear().
1380 * - see the comments in accmacvar.c before changing *anything* in here!
1381 * - virt= implies rdonly,nodel
1382 * - import= implies env
1383 * - defval= implies notempty
1384 * - num and posnum are mutual exclusive
1385 * - most default VAL_ues come from in from build system via ./make.rc
1386 * (Keep in SYNC: ./nail.h:okeys, ./nail.rc, ./nail.1:"Initial settings") */
1388 /* TODO likely temporary hook data, v15 drop */
1389 ok_v_on_compose_enter
,
1390 ok_v_on_compose_leave
,
1392 ok_v_compose_sender
,
1396 ok_v_compose_subject
,
1398 ok_b_add_file_recipients
,
1399 ok_v_agent_shell_lookup
,
1408 ok_b_asksub
, /* {i3val=TRU1} */
1409 ok_b_attachment_ask_content_description
,
1410 ok_b_attachment_ask_content_disposition
,
1411 ok_b_attachment_ask_content_id
,
1412 ok_b_attachment_ask_content_type
,
1422 ok_b_batch_exit_on_error
,
1430 ok_v_COLUMNS
, /* {notempty=1,posnum=1,env=1} */
1433 ok_v_charset_unknown_8bit
,
1435 ok_b_colour_disable
,
1437 ok_v_crt
, /* {posnum=1} */
1438 ok_v_customhdr
, /* {nocntrls=1} */
1440 ok_v_DEAD
, /* {env=1,defval=VAL_DEAD} */
1442 ok_v_datefield_markout_older
,
1443 ok_b_debug
, /* {vip=1} */
1444 ok_b_disposition_notification_send
,
1446 ok_b_dotlock_ignore_error
,
1448 ok_v_EDITOR
, /* {env=1,defval=VAL_EDITOR} */
1458 ok_v_features
, /* {virt=_features} */
1460 ok_v_folder
, /* {vip=1} */
1461 ok_v__folder_resolved
, /* {rdonly=1,nodel=1} */
1464 ok_v_followup_to_honour
,
1465 ok_b_forward_as_attachment
,
1470 ok_v_HOME
, /* {vip=1,nodel=1,import=1} */
1471 ok_b_header
, /* {vip=1,i3val=TRU1} */
1476 ok_b_history_gabby_persist
,
1477 ok_v_history_size
, /* {notempty=1,num=1} */
1487 ok_b_keep_content_length
,
1490 ok_v_LINES
, /* {notempty=1,posnum=1,env=1} */
1491 ok_v_LISTER
, /* {env=1,defval=VAL_LISTER} */
1492 ok_v_LOGNAME
, /* {rdonly=1,import=1} */
1493 ok_b_line_editor_disable
,
1495 ok_v_MAIL
, /* {env=1} */
1496 ok_v_MAILRC
, /* {import=1,defval=VAL_MAILRC} */
1497 ok_v_MBOX
, /* {env=1,defval=VAL_MBOX} */
1500 ok_b_memdebug
, /* {vip=1} */
1501 ok_b_message_id_disable
,
1502 ok_v_message_inject_head
,
1503 ok_v_message_inject_tail
,
1505 ok_b_mime_allow_text_controls
,
1506 ok_b_mime_alternative_favour_rich
,
1507 ok_v_mime_counter_evidence
, /* {posnum=1} */
1508 ok_v_mimetypes_load_control
,
1510 ok_v_NAIL_EXTRA_RC
, /* {name=NAIL_EXTRA_RC} */
1511 ok_b_NAIL_NO_SYSTEM_RC
, /* {import=1} */
1512 ok_v_NAIL_HEAD
, /* {name=NAIL_HEAD} */
1513 ok_v_NAIL_HISTFILE
, /* {name=NAIL_HISTFILE} */
1514 ok_v_NAIL_HISTSIZE
, /* {name=NAIL_HISTSIZE,notempty=1,num=1} */
1515 ok_v_NAIL_TAIL
, /* {name=NAIL_TAIL} */
1516 ok_v_NETRC
, /* {env=1,defval=VAL_NETRC} */
1524 ok_v_PAGER
, /* {env=1,defval=VAL_PAGER} */
1525 ok_v_PATH
, /* {nodel=1,import=1} */
1530 ok_b_pop3_bulk_load
,
1531 ok_v_pop3_keepalive
,
1533 ok_b_pop3_use_starttls
,
1534 ok_b_print_alternatives
,
1535 ok_v_prompt
, /* {i3val="\\& "} */
1539 ok_b_quote_as_attachment
,
1542 ok_b_recipients_in_cc
,
1545 ok_b_reply_in_same_charset
,
1548 ok_v_reply_to_honour
,
1549 ok_b_rfc822_body_from_
, /* {name=rfc822-body-from_} */
1551 ok_v_SHELL
, /* {import=1,defval=VAL_SHELL} */
1552 ok_b_SYSV3
, /* {env=1} */
1553 ok_b_save
, /* {i3val=TRU1} */
1554 ok_v_screen
, /* {notempty=1,posnum=1} */
1557 ok_b_sendcharsets_else_ttycharset
,
1559 ok_v_sendmail
, /* {defval=VAL_SENDMAIL} */
1560 ok_v_sendmail_arguments
,
1561 ok_b_sendmail_no_default_arguments
,
1562 ok_v_sendmail_progname
, /* {defval=VAL_SENDMAIL_PROGNAME} */
1570 ok_b_skipemptybody
, /* {vip=1} */
1575 ok_v_smime_crl_file
,
1576 /* smime-encrypt-USER@HOST */
1577 ok_b_smime_force_encryption
,
1578 ok_b_smime_no_default_ca
,
1580 ok_v_smime_sign_cert
,
1581 ok_v_smime_sign_include_certs
,
1582 ok_v_smime_sign_message_digest
,
1585 ok_v_smtp_auth_password
,
1586 ok_v_smtp_auth_user
,
1588 ok_b_smtp_use_starttls
,
1589 ok_v_spam_interface
,
1590 ok_v_spam_maxsize
, /* {notempty=1,posnum=1} */
1592 ok_v_spamc_arguments
,
1596 ok_v_spamfilter_ham
,
1597 ok_v_spamfilter_noham
,
1598 ok_v_spamfilter_nospam
,
1599 ok_v_spamfilter_rate
,
1600 ok_v_spamfilter_rate_scanscore
,
1601 ok_v_spamfilter_spam
,
1605 ok_v_ssl_cipher_list
,
1606 ok_v_ssl_config_file
,
1611 ok_b_ssl_no_default_ca
,
1618 ok_v_TERM
, /* {env=1} */
1619 ok_v_TMPDIR
, /* {vip=1,import=1,defval=VAL_TMPDIR} */
1621 ok_b_termcap_disable
,
1622 ok_v_toplines
, /* {notempty=1,posnum=1,defval="5"} */
1625 ok_v_USER
, /* {rdonly=1,import=1} */
1626 ok_v_umask
, /* {vip=1,nodel=1,posnum=1,i3val="0077"} */
1629 ok_v_VISUAL
, /* {env=1,defval=VAL_VISUAL} */
1631 ok_b_verbose
, /* {vip=1} */
1632 ok_v_version
, /* {virt=VERSION} */
1633 ok_v_version_major
, /* {virt=VERSION_MAJOR} */
1634 ok_v_version_minor
, /* {virt=VERSION_MINOR} */
1635 ok_v_version_update
, /* {virt=VERSION_UPDATE} */
1637 ok_b_writebackedited
1640 /* Locale-independent character classes */
1654 char *s
; /* the string's content */
1655 size_t l
; /* the stings's length */
1659 char *s_dat
; /*@ May contain NULs, not automatically terminated */
1660 ui32_t s_len
; /*@ gth of string */
1661 #ifdef HAVE_BYTE_ORDER_LITTLE
1662 ui32_t s_auto
: 1; /* Stored in auto-reclaimed storage? */
1664 ui32_t s_size
: 31; /* of .s_dat, -1 */
1665 #ifndef HAVE_BYTE_ORDER_LITTLE
1671 struct n_strlist
*sl_next
;
1673 char sl_dat
[VFIELD_SIZE(0)];
1675 #define n_STRLIST_MALLOC(SZ) /* XXX -> nailfuns.h (and pimp interface) */\
1676 smalloc(sizeof(struct n_strlist) - \
1677 VFIELD_SIZEOF(struct n_strlist, sl_dat) + (SZ) +1)
1680 struct str bi_start
; /* Start of (possibly) bidirectional text */
1681 struct str bi_end
; /* End of ... */
1682 size_t bi_pad
; /* No of visual columns to reserve for BIDI pad */
1685 struct n_cmd_arg_desc
{
1686 char cad_name
[12]; /* Name of command */
1687 ui32_t cad_no
; /* Number of entries in cad_ent_flags */
1688 /* [enum n_cmd_arg_desc_flags,arg-dep] */
1689 ui32_t cad_ent_flags
[VFIELD_SIZE(0)][2];
1691 /* ISO C(99) doesn't allow initialization of "flex array" */
1692 #define n_CMD_ARG_DESC_SUBCLASS_DEF(CMD,NO,VAR) \
1693 struct n_cmd_arg_desc_ ## CMD {\
1696 ui32_t cad_ent_flags[NO][2];\
1697 } const VAR = { #CMD, NO,
1698 #define n_CMD_ARG_DESC_SUBCLASS_DEF_END }
1699 #define n_CMD_ARG_DESC_SUBCLASS_CAST(P) ((struct n_cmd_arg_desc const*)P)
1701 struct n_cmd_arg_ctx
{
1702 struct n_cmd_arg_desc
const *cac_desc
;
1703 char const *cac_indat
; /* Input that shall be parsed */
1704 size_t cac_inlen
; /* Input length (UIZ_MAX: do a strlen()) */
1705 size_t cac_no
; /* Output: number of parsed arguments */
1706 struct n_cmd_arg
*cac_arg
; /* Output: parsed arguments */
1709 struct n_cmd_arg
{/* TODO incomplete, misses getmsglist() */
1710 struct n_cmd_arg
*ca_next
;
1711 char const *ca_indat
; /* Pointer into n_cmd_arg_ctx.cac_indat */
1712 size_t ca_inlen
; /* of .ca_indat of this arg (not terminated) */
1713 ui32_t ca_ent_flags
[2]; /* Copy of n_cmd_arg_desc.cad_ent_flags[X] */
1714 ui32_t ca_arg_flags
; /* [Output: _WYSH: copy of parse result flags] */
1717 struct str ca_str
; /* _STRING, _WYSH */
1718 } ca_arg
; /* Output: parsed result */
1722 struct n_colour_pen
;
1726 char const *url_input
; /* Input as given (really) */
1727 enum cproto url_cproto
; /* Communication protocol as given */
1728 bool_t url_needs_tls
; /* Wether the protocol uses SSL/TLS */
1729 bool_t url_had_user
; /* Wether .url_user was part of the URL */
1730 ui16_t url_portno
; /* atoi .url_port or default, host endian */
1731 char const *url_port
; /* Port (if given) or NULL */
1732 char url_proto
[14]; /* Communication protocol as 'xy\0//' */
1733 ui8_t url_proto_len
; /* Length of .url_proto ('\0' index) */
1734 ui8_t url_proto_xlen
; /* .. if '\0' is replaced with ':' */
1735 struct str url_user
; /* User, exactly as given / looked up */
1736 struct str url_user_enc
; /* User, urlxenc()oded */
1737 struct str url_pass
; /* Pass (urlxdec()oded) or NULL */
1738 struct str url_host
; /* Service hostname */
1739 struct str url_path
; /* Path suffix or NULL */
1740 /* TODO: url_get_component(url *, enum COMPONENT, str *store) */
1741 struct str url_h_p
; /* .url_host[:.url_port] */
1742 /* .url_user@.url_host
1743 * Note: for CPROTO_SMTP this may resolve HOST via *smtp-hostname* (->
1744 * *hostname*)! (And may later be overwritten according to *from*!) */
1746 struct str url_u_h_p
; /* .url_user@.url_host[:.url_port] */
1747 struct str url_eu_h_p
; /* .url_user_enc@.url_host[:.url_port] */
1748 char const *url_p_u_h_p
; /* .url_proto://.url_u_h_p */
1749 char const *url_p_eu_h_p
; /* .url_proto://.url_eu_h_p */
1750 char const *url_p_eu_h_p_p
; /* .url_proto://.url_eu_h_p[/.url_path] */
1754 enum cproto cc_cproto
; /* Communication protocol */
1755 enum authtype cc_authtype
; /* Desired authentication */
1756 char const *cc_auth
; /* Authentication type as string */
1757 struct str cc_user
; /* User (urlxdec()oded) or NULL */
1758 struct str cc_pass
; /* Password (urlxdec()oded) or NULL */
1762 struct n_dotlock_info
{
1763 char const *di_file_name
; /* Mailbox to lock */
1764 char const *di_lock_name
; /* .di_file_name + .lock */
1765 char const *di_hostname
; /* ..filled in parent (due resolver delays) */
1766 char const *di_randstr
; /* ..ditto, random string */
1767 size_t di_pollmsecs
; /* Delay in between locking attempts */
1768 struct stat
*di_stb
;
1772 /* Execution context bundles */
1775 void *l_smem
; /* salloc() memory TODO -> memraw? */
1776 /* TODO our new per-exec-ctx memory "allocators" are yet very dumb.
1777 * TODO for v15 those should not be wrapping nodes but real allocators */
1778 struct n_mem_raw
*l_memraw
; /* n_mem_alloc() (/ n_mem_free()) */
1779 struct n_mem_wrap
*l_memwrap
; /* n_mem_wrap() (/ n_mem_unwrap()) */
1783 struct n_mem_raw
*mr_prev
;
1784 struct n_mem_raw
*mr_next
;
1785 char mr_buf
[VFIELD_SIZE(0)];
1789 struct n_mem_wrap
*mw_prev
;
1790 struct n_mem_wrap
*mw_next
;
1792 void (*mw_dtor
)(void *obj
);
1795 struct mime_handler
{
1796 enum mime_handler_flags mh_flags
;
1797 struct str mh_msg
; /* Message describing this command */
1798 /* XXX union{} the following? */
1799 char const *mh_shell_cmd
; /* For MIME_HDL_CMD */
1800 int (*mh_ptf
)(void); /* PTF main() for MIME_HDL_PTF */
1804 FILE *qf_os
; /* Output stream */
1805 char const *qf_pfix
;
1806 ui32_t qf_pfix_len
; /* Length of prefix: 0: bypass */
1807 ui32_t qf_qfold_min
; /* Simple way: wrote prefix? */
1808 #ifdef HAVE_QUOTE_FOLD
1809 ui32_t qf_qfold_max
; /* Otherwise: line lengths */
1810 ui8_t qf_state
; /* *quote-fold* state machine */
1811 bool_t qf_brk_isws
; /* Breakpoint is at WS */
1813 ui32_t qf_wscnt
; /* Whitespace count */
1814 ui32_t qf_brkl
; /* Breakpoint */
1815 ui32_t qf_brkw
; /* Visual width, breakpoint */
1816 ui32_t qf_datw
; /* Current visual output line width */
1817 struct str qf_dat
; /* Current visual output line */
1818 struct str qf_currq
; /* Current quote, compressed */
1819 mbstate_t qf_mbps
[2];
1823 #ifdef HAVE_FILTER_HTML_TAGSOUP
1825 FILE *hf_os
; /* Output stream */
1827 ui32_t hf_lmax
; /* Maximum byte +1 in .hf_line/4 */
1828 ui32_t hf_len
; /* Current bytes in .hf_line */
1829 ui32_t hf_last_ws
; /* Last whitespace on line (fold purposes) */
1830 ui32_t hf_mboff
; /* Last offset for "mbtowc" */
1831 ui32_t hf_mbwidth
; /* We count characters not bytes if possible */
1832 char *hf_line
; /* Output line buffer - MUST be last field! */
1833 si32_t hf_href_dist
; /* Count of lines since last HREF flush */
1834 ui32_t hf_href_no
; /* HREF sequence number */
1835 struct htmlflt_href
*hf_hrefs
;
1836 struct htmlflt_tag
const *hf_ign_tag
; /* Tag that will end ignore mode */
1837 char *hf_curr
; /* Current cursor into .hf_bdat */
1838 char *hf_bmax
; /* Maximum byte in .hf_bdat +1 */
1839 char *hf_bdat
; /* (Temporary) Tag content data storage */
1843 struct search_expr
{
1844 char const *ss_where
; /* ..to search for the expr. (not always used) */
1845 char const *ss_sexpr
; /* String search expr.; NULL: use .ss_regex */
1851 /* This is somewhat temporary for pre v15 */
1853 ui32_t sm_flags
; /* enum n_sigman_flags */
1855 struct n_sigman
*sm_outer
;
1856 sighandler_type sm_ohup
;
1857 sighandler_type sm_oint
;
1858 sighandler_type sm_oquit
;
1859 sighandler_type sm_oterm
;
1860 sighandler_type sm_opipe
;
1864 struct termios_state
{
1865 struct termios ts_tios
;
1868 bool_t ts_needs_reset
;
1871 #define termios_state_reset() \
1873 if (termios_state.ts_needs_reset) {\
1874 tcsetattr(0, TCSADRAIN, &termios_state.ts_tios);\
1875 termios_state.ts_needs_reset = FAL0;\
1880 struct n_termcap_value
{
1881 enum n_termcap_captype tv_captype
;
1883 union n_termcap_value_data
{
1886 char const *tvd_string
;
1891 struct n_visual_info_ctx
{
1892 char const *vic_indat
; /*I Input data */
1893 size_t vic_inlen
; /*I If UIZ_MAX, strlen(.vic_indat) */
1894 char const *vic_oudat
; /*O remains */
1896 size_t vic_chars_seen
; /*O number of characters processed */
1897 size_t vic_bytes_seen
; /*O number of bytes passed */
1898 size_t vic_vi_width
; /*[O] visual width of the entire range */
1899 wc_t
*vic_woudat
; /*[O] if so requested */
1900 size_t vic_woulen
; /*[O] entries in .vic_woudat, if used */
1901 wc_t vic_waccu
; /*O The last wchar_t/char processed (if any) */
1902 enum n_visual_info_flags vic_flags
; /*O Copy of parse flags */
1904 #ifdef HAVE_C90AMEND1
1905 mbstate_t *vic_mbstate
; /*IO .vic_mbs_def used if NULL */
1906 mbstate_t vic_mbs_def
;
1910 struct time_current
{
1917 struct sock
{ /* data associated with a socket */
1918 int s_fd
; /* file descriptor */
1920 int s_use_ssl
; /* SSL is used */
1921 # ifdef HAVE_OPENSSL
1922 void *s_ssl
; /* SSL object */
1925 char *s_wbuf
; /* for buffered writes */
1926 int s_wbufsize
; /* allocated size of s_buf */
1927 int s_wbufpos
; /* position of first empty data byte */
1928 char *s_rbufptr
; /* read pointer to s_rbuf */
1929 int s_rsz
; /* size of last read in s_rbuf */
1930 char const *s_desc
; /* description of error messages */
1931 void (*s_onclose
)(void); /* execute on close */
1932 char s_rbuf
[LINESIZE
+ 1]; /* for buffered reads */
1937 struct ccred sc_cred
;
1938 struct sock sc_sock
;
1943 MB_NONE
= 000, /* no reply expected */
1944 MB_COMD
= 001, /* command reply expected */
1945 MB_MULT
= 002, /* multiline reply expected */
1946 MB_PREAUTH
= 004, /* not in authenticated state */
1947 MB_BYE
= 010 /* may accept a BYE state */
1949 FILE *mb_itf
; /* temp file with messages, read open */
1950 FILE *mb_otf
; /* same, write open */
1951 char *mb_sorted
; /* sort method */
1953 MB_VOID
, /* no type (e. g. connection failed) */
1954 MB_FILE
, /* local file */
1955 MB_POP3
, /* POP3 mailbox */
1956 MB_MAILDIR
/* maildir folder */
1957 } mb_type
; /* type of mailbox */
1959 MB_DELE
= 01, /* may delete messages in mailbox */
1960 MB_EDIT
= 02 /* may edit messages in mailbox */
1962 int mb_threaded
; /* mailbox has been threaded */
1963 struct sock mb_sock
; /* socket structure */
1967 NEED_UNSPEC
, /* unspecified need, don't fetch */
1968 NEED_HEADER
, /* need the header of a message */
1969 NEED_BODY
/* need header and body of a message */
1973 HAVE_NOTHING
, /* nothing downloaded yet */
1974 HAVE_HEADER
= 01, /* header is downloaded */
1975 HAVE_BODY
= 02 /* entire message is downloaded */
1978 /* flag bits. Attention: Flags that are used in cache.c may not change */
1980 MUSED
= (1<< 0), /* entry is used, but this bit isn't */
1981 MDELETED
= (1<< 1), /* entry has been deleted */
1982 MSAVED
= (1<< 2), /* entry has been saved */
1983 MTOUCH
= (1<< 3), /* entry has been noticed */
1984 MPRESERVE
= (1<< 4), /* keep entry in sys mailbox */
1985 MMARK
= (1<< 5), /* message is marked! */
1986 MODIFY
= (1<< 6), /* message has been modified */
1987 MNEW
= (1<< 7), /* message has never been seen */
1988 MREAD
= (1<< 8), /* message has been read sometime. */
1989 MSTATUS
= (1<< 9), /* message status has changed */
1990 MBOX
= (1<<10), /* Send this to mbox, regardless */
1991 MNOFROM
= (1<<11), /* no From line */
1992 MHIDDEN
= (1<<12), /* message is hidden to user */
1993 MBOXED
= (1<<13), /* message has been sent to mbox */
1994 MNEWEST
= (1<<14), /* message is very new (newmail) */
1995 MFLAG
= (1<<15), /* message has been flagged recently */
1996 MUNFLAG
= (1<<16), /* message has been unflagged */
1997 MFLAGGED
= (1<<17), /* message is `flagged' */
1998 MANSWER
= (1<<18), /* message has been answered recently */
1999 MUNANSWER
= (1<<19), /* message has been unanswered */
2000 MANSWERED
= (1<<20), /* message is `answered' */
2001 MDRAFT
= (1<<21), /* message has been drafted recently */
2002 MUNDRAFT
= (1<<22), /* message has been undrafted */
2003 MDRAFTED
= (1<<23), /* message is marked as `draft' */
2004 MOLDMARK
= (1<<24), /* messages was marked previously */
2005 MSPAM
= (1<<25), /* message is classified as spam */
2006 MSPAMUNSURE
= (1<<26) /* message may be spam, but it is unsure */
2008 #define MMNORM (MDELETED | MSAVED | MHIDDEN)
2009 #define MMNDEL (MDELETED | MHIDDEN)
2011 #define visible(mp) (((mp)->m_flag & MMNDEL) == 0)
2014 enum mflag m_flag
; /* flags */
2015 enum havespec m_have
; /* downloaded parts of the part */
2017 ui32_t m_spamscore
; /* Spam score as int, 24:8 bits */
2019 int m_block
; /* block number of this part */
2020 size_t m_offset
; /* offset in block of part */
2021 size_t m_size
; /* Bytes in the part */
2022 size_t m_xsize
; /* Bytes in the full part */
2023 long m_lines
; /* Lines in the message */
2024 long m_xlines
; /* Lines in the full message */
2025 time_t m_time
; /* time the message was sent */
2026 char const *m_from
; /* message sender */
2027 struct mimepart
*m_nextpart
; /* next part at same level */
2028 struct mimepart
*m_multipart
; /* parts of multipart */
2029 struct mimepart
*m_parent
; /* enclosing multipart part */
2030 char const *m_ct_type
; /* content-type */
2031 char const *m_ct_type_plain
; /* content-type without specs */
2032 char const *m_ct_type_usr_ovwr
; /* Forcefully overwritten one */
2033 enum mimecontent m_mimecontent
; /* same in enum */
2034 char const *m_charset
; /* charset */
2035 char const *m_ct_enc
; /* content-transfer-encoding */
2036 enum mime_enc m_mime_enc
; /* same in enum */
2037 char *m_partstring
; /* part level string */
2038 char *m_filename
; /* attachment filename */
2042 enum mflag m_flag
; /* flags */
2043 enum havespec m_have
; /* downloaded parts of the message */
2045 ui32_t m_spamscore
; /* Spam score as int, 24:8 bits */
2047 int m_block
; /* block number of this message */
2048 size_t m_offset
; /* offset in block of message */
2049 size_t m_size
; /* Bytes in the message */
2050 size_t m_xsize
; /* Bytes in the full message */
2051 long m_lines
; /* Lines in the message */
2052 long m_xlines
; /* Lines in the full message */
2053 time_t m_time
; /* time the message was sent */
2054 time_t m_date
; /* time in the 'Date' field */
2055 unsigned m_idhash
; /* hash on Message-ID for threads */
2056 struct message
*m_child
; /* first child of this message */
2057 struct message
*m_younger
; /* younger brother of this message */
2058 struct message
*m_elder
; /* elder brother of this message */
2059 struct message
*m_parent
; /* parent of this message */
2060 unsigned m_level
; /* thread level of message */
2061 long m_threadpos
; /* position in threaded display */
2062 char *m_maildir_file
; /* original maildir file of msg */
2063 ui32_t m_maildir_hash
; /* hash of file name in maildir sub */
2064 int m_collapsed
; /* collapsed thread information */
2067 /* Given a file address, determine the block number it represents */
2068 #define mailx_blockof(off) ((int) ((off) / 4096))
2069 #define mailx_offsetof(off) ((int) ((off) % 4096))
2070 #define mailx_positionof(block, offset) ((off_t)(block) * 4096 + (offset))
2072 /* Argument types */
2074 ARG_MSGLIST
= 0, /* Message list type */
2075 ARG_STRLIST
= 1, /* A pure string */
2076 ARG_RAWLIST
= 2, /* getrawlist(), old style */
2077 ARG_NOLIST
= 3, /* Just plain 0 */
2078 ARG_NDMLIST
= 4, /* Message list, no defaults */
2079 ARG_WYSHLIST
= 5, /* getrawlist(), sh(1) compatible */
2080 ARG_WYRALIST
= 6, /* _RAWLIST or _WYSHLIST (with `wysh') */
2081 ARG_ARGMASK
= 7, /* Mask of the above */
2083 ARG_A
= 1u<< 4, /* Needs an active mailbox */
2084 ARG_F
= 1u<< 5, /* Is a conditional command */
2085 ARG_H
= 1u<< 6, /* Never place in history */
2086 ARG_I
= 1u<< 7, /* Interactive command bit */
2087 ARG_M
= 1u<< 8, /* Legal from send mode bit */
2088 ARG_P
= 1u<< 9, /* Autoprint dot after command */
2089 ARG_R
= 1u<<10, /* Cannot be called from collect / recursion */
2090 ARG_S
= 1u<<11, /* Cannot be called unless PS_STARTED (POSIX) */
2091 ARG_T
= 1u<<12, /* Is a transparent command */
2092 ARG_V
= 1u<<13, /* Places data in temporary_arg_v_store */
2093 ARG_W
= 1u<<14, /* Invalid when read only bit */
2094 ARG_O
= 1u<<15 /* OBSOLETE()d command */
2098 GTO
= 1<< 0, /* Grab To: line */
2099 GSUBJECT
= 1<< 1, /* Likewise, Subject: line */
2100 GCC
= 1<< 2, /* And the Cc: line */
2101 GBCC
= 1<< 3, /* And also the Bcc: line */
2103 GNL
= 1<< 4, /* Print blank line after */
2104 GDEL
= 1<< 5, /* Entity removed from list */
2105 GCOMMA
= 1<< 6, /* detract() puts in commas */
2106 GUA
= 1<< 7, /* User-Agent field */
2107 GMIME
= 1<< 8, /* MIME 1.0 fields */
2108 GMSGID
= 1<< 9, /* a Message-ID */
2109 GNAMEONLY
= 1<<10, /* detract() does NOT use fullnames */
2111 GIDENT
= 1<<11, /* From:, Reply-To:, MFT: (user headers) */
2112 GREF
= 1<<12, /* References:, In-Reply-To:, (Message-ID:) */
2113 GDATE
= 1<<13, /* Date: field */
2114 GFULL
= 1<<14, /* Include full names, comments etc. */
2115 GSKIN
= 1<<15, /* Skin names */
2116 GEXTRA
= 1<<16, /* Extra fields (mostly like GIDENT XXX) */
2117 GFILES
= 1<<17, /* Include filename and pipe addresses */
2118 GFULLEXTRA
= 1<<18 /* Only with GFULL: GFULL less address */
2120 #define GMASK (GTO | GSUBJECT | GCC | GBCC)
2124 HF_LIST_REPLY
= 1<< 0,
2125 HF_MFT_SENDER
= 1<< 1, /* Add ourselves to Mail-Followup-To: */
2126 HF_RECIPIENT_RECORD
= 1<<10, /* Save message in file named after rec. */
2130 /* Structure used to pass about the current state of a message (header) */
2131 struct n_header_field
{
2132 struct n_header_field
*hf_next
;
2133 ui32_t hf_nl
; /* Field-name length */
2134 ui32_t hf_bl
; /* Field-body length*/
2135 char hf_dat
[VFIELD_SIZE(0)];
2139 ui32_t h_flags
; /* enum header_flags bits */
2141 struct name
*h_to
; /* Dynamic "To:" string */
2142 char *h_subject
; /* Subject string */
2143 struct name
*h_cc
; /* Carbon copies string */
2144 struct name
*h_bcc
; /* Blind carbon copies */
2145 struct name
*h_ref
; /* References (possibly overridden) */
2146 struct attachment
*h_attach
; /* MIME attachments */
2147 char *h_charset
; /* preferred charset */
2148 struct name
*h_from
; /* overridden "From:" field */
2149 struct name
*h_sender
; /* overridden "Sender:" field */
2150 struct name
*h_replyto
; /* overridden "Reply-To:" field */
2151 struct name
*h_message_id
; /* overridden "Message-ID:" field */
2152 struct name
*h_in_reply_to
;/* overridden "In-Reply-To:" field */
2153 struct name
*h_mft
; /* Mail-Followup-To */
2154 char const *h_list_post
; /* Address from List-Post:, for `Lreply' */
2155 struct n_header_field
*h_user_headers
;
2156 struct n_header_field
*h_custom_headers
; /* (Cached result) */
2159 /* Handling of namelist nodes used in processing the recipients of mail and
2160 * aliases, inspection of mail-addresses and all that kind of stuff */
2162 NAME_NAME_SALLOC
= 1<< 0, /* .n_name is doped */
2163 NAME_FULLNAME_SALLOC
= 1<< 1, /* .n_fullname is doped */
2164 NAME_SKINNED
= 1<< 2, /* Is actually skin()ned */
2165 NAME_IDNA
= 1<< 3, /* IDNA was applied */
2167 NAME_ADDRSPEC_CHECKED
= 1<< 4, /* Address has been .. and */
2168 NAME_ADDRSPEC_ISFILE
= 1<< 5, /* ..is a file path */
2169 NAME_ADDRSPEC_ISPIPE
= 1<< 6, /* ..is a command for piping */
2170 NAME_ADDRSPEC_ISFILEORPIPE
= NAME_ADDRSPEC_ISFILE
| NAME_ADDRSPEC_ISPIPE
,
2171 NAME_ADDRSPEC_ISNAME
= 1<< 7, /* ..is a valid mail network address */
2172 NAME_ADDRSPEC_ISADDR
= 1<< 8, /* ..is a valid mail network address */
2174 NAME_ADDRSPEC_ERR_EMPTY
= 1<< 9, /* An empty string (or NULL) */
2175 NAME_ADDRSPEC_ERR_ATSEQ
= 1<<10, /* Weird @ sequence */
2176 NAME_ADDRSPEC_ERR_CHAR
= 1<<11, /* Invalid character */
2177 NAME_ADDRSPEC_ERR_IDNA
= 1<<12, /* IDNA convertion failed */
2178 NAME_ADDRSPEC_INVALID
= NAME_ADDRSPEC_ERR_EMPTY
|
2179 NAME_ADDRSPEC_ERR_ATSEQ
| NAME_ADDRSPEC_ERR_CHAR
|
2180 NAME_ADDRSPEC_ERR_IDNA
,
2182 /* Error storage (we must fit in 31-bit) */
2184 _NAME_MAXWC
= 0x3FFFF,
2185 _NAME_MASKWC
= _NAME_MAXWC
<< _NAME_SHIFTWC
2188 /* In the !_ERR_EMPTY case, the failing character can be queried */
2189 #define NAME_ADDRSPEC_ERR_GETWC(F) \
2190 ((((unsigned int)(F) & _NAME_MASKWC) >> _NAME_SHIFTWC) & _NAME_MAXWC)
2191 #define NAME_ADDRSPEC_ERR_SET(F, E, WC) \
2193 (F) = ((F) & ~(NAME_ADDRSPEC_INVALID | _NAME_MASKWC)) |\
2194 (E) | (((unsigned int)(WC) & _NAME_MAXWC) << _NAME_SHIFTWC);\
2198 struct name
*n_flink
; /* Forward link in list. */
2199 struct name
*n_blink
; /* Backward list link */
2200 enum gfield n_type
; /* From which list it came */
2201 enum nameflags n_flags
; /* enum nameflags */
2202 char *n_name
; /* This fella's address */
2203 char *n_fullname
; /* Ditto, unless GFULL including comment */
2204 char *n_fullextra
; /* GFULL, without address */
2208 char const *ag_input
; /* Input string as given */
2209 size_t ag_ilen
; /* strlen() of input */
2210 size_t ag_iaddr_start
; /* Start of *addr-spec* in .ag_input */
2211 size_t ag_iaddr_aend
; /* ..and one past its end */
2212 char *ag_skinned
; /* Output (alloced if !=.ag_input) */
2213 size_t ag_slen
; /* strlen() of .ag_skinned */
2214 size_t ag_sdom_start
; /* Start of domain in .ag_skinned, */
2215 enum nameflags ag_n_flags
; /* enum nameflags of .ag_skinned */
2218 /* MIME attachments */
2220 AC_DEFAULT
, /* _get_lc() -> _iter_*() */
2221 AC_FIX_OUTCS
, /* _get_lc() -> "charset=" .a_charset */
2222 AC_FIX_INCS
, /* "charset=".a_input_charset (nocnv) */
2223 AC_TMPFILE
/* attachment.a_tmpf is converted */
2227 struct attachment
*a_flink
; /* Forward link in list. */
2228 struct attachment
*a_blink
; /* Backward list link */
2229 char const *a_name
; /* file name */
2230 char const *a_content_type
; /* content type */
2231 char const *a_content_disposition
; /* content disposition */
2232 char const *a_content_id
; /* content id */
2233 char const *a_content_description
; /* content description */
2234 char const *a_input_charset
; /* Interpretation depends on .a_conv */
2235 char const *a_charset
; /* ... */
2236 FILE *a_tmpf
; /* If AC_TMPFILE */
2237 enum attach_conv a_conv
; /* User chosen conversion */
2238 int a_msgno
; /* message number */
2242 struct header
*sb_hp
;
2245 struct str sb_signer
; /* USER@HOST for signing+ */
2247 struct ccred sb_ccred
;
2250 /* Structure of the hash table of ignored header fields */
2252 int i_count
; /* Number of entries */
2254 struct ignored
*i_link
; /* Next ignored field in bucket */
2255 char *i_field
; /* This ignored field */
2259 /* For saving the current directory and later returning */
2264 char cw_wd
[PATH_MAX
];
2269 * Global variable declarations
2271 * These become instantiated in main.c.
2275 #ifdef n_MAIN_SOURCE
2276 # ifndef HAVE_AMALGAMATION
2285 VL
int mb_cur_max
; /* Value of MB_CUR_MAX */
2286 VL
int realscreenheight
; /* The real screen height */
2287 VL
int scrnwidth
; /* Screen width, or best guess */
2288 VL
int scrnheight
; /* Screen height/guess (4 header) */
2290 VL
char const *myname
; /* My login name */
2291 VL
char const *progname
; /* Our name */
2292 VL
char const *tempdir
; /* The temporary directory */
2294 VL gid_t group_id
; /* getgid() and getuid() */
2297 VL
int exit_status
; /* Exit status */
2298 VL ui32_t options
; /* Bits of enum user_options */
2299 VL
char const *option_Mm_arg
; /* Argument for -[Mm] aka OPT_[Mm]_FLAG */
2300 VL
struct name
*option_r_arg
; /* Argument to -r option */
2301 VL
char const **smopts
; /* sendmail(1) opts from commline */
2302 VL
size_t smopts_cnt
; /* Entries in smopts */
2304 VL ui32_t pstate
; /* Bits of enum program_state */
2305 VL
size_t noreset
; /* String resets suspended (recursive) */
2307 /* XXX stylish sorting */
2308 VL
int msgCount
; /* Count of messages read in */
2309 VL
struct mailbox mb
; /* Current mailbox */
2310 VL
int image
; /* File descriptor for msg image */
2311 VL
char mailname
[PATH_MAX
]; /* Name of current file TODO URL/object*/
2312 VL
char displayname
[80 - 40]; /* Prettyfied for display TODO URL/obj*/
2313 VL
char prevfile
[PATH_MAX
]; /* Name of previous file TODO URL/obj */
2314 VL
char const *account_name
; /* Current account name or NULL */
2315 VL off_t mailsize
; /* Size of system mailbox */
2316 VL
struct message
*dot
; /* Pointer to current message */
2317 VL
struct message
*prevdot
; /* Previous current message */
2318 VL
struct message
*message
; /* The actual message structure */
2319 VL
struct message
*threadroot
; /* first threaded message */
2320 VL
int *n_msgvec
; /* Folder setmsize(), list.c res. store*/
2322 VL
struct ignoretab ignore
[2]; /* ignored and retained fields
2323 * 0 is ignore, 1 is retain */
2324 VL
struct ignoretab saveignore
[2]; /* ignored and retained fields
2325 * on save to folder */
2326 VL
struct ignoretab allignore
[2]; /* special, ignore all headers */
2327 VL
struct ignoretab fwdignore
[2]; /* fields to ignore for forwarding */
2329 VL
struct time_current time_current
; /* time(3); send: mail1() XXXcarrier */
2330 VL
struct termios_state termios_state
; /* getpassword(); see commands().. */
2333 VL
enum ssl_verify_level ssl_verify_level
; /* SSL verification level */
2340 VL sigjmp_buf srbuf
;
2342 VL sighandler_type dflpipe
;
2344 /* TODO Temporary hacks unless the codebase doesn't jump and uses pass-by-value
2345 * TODO carrier structs instead of locals */
2346 VL
char *temporary_arg_v_store
;
2347 /* TODO temporary storage to overcome which_protocol() mess (for PROTO_FILE) */
2348 VL
char const *temporary_protocol_ext
;
2350 /* The remaining variables need initialization */
2352 #ifndef HAVE_AMALGAMATION
2353 VL
char const month_names
[12 + 1][4];
2354 VL
char const weekday_names
[7 + 1][4];
2356 VL
char const uagent
[sizeof UAGENT
];
2358 VL ui16_t
const class_char
[1 + 0x7F];
2362 * Finally, let's include the function prototypes XXX embed
2365 #ifndef n_PRIVSEP_SOURCE
2366 # include "nailfuns.h"