Add n_SHEXP_PARSE_META_KEEP (for `vput')
[s-mailx.git] / nail.h
blob94d7868ca4e8729863790870d41157cbef387e70
1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
2 *@ Header inclusion, macros, constants, types and the global var declarations.
4 * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
5 * Copyright (c) 2012 - 2017 Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
6 */
7 /*
8 * Copyright (c) 1980, 1993
9 * The Regents of the University of California. All rights reserved.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
37 * Mail -- a mail program
39 * Author: Kurt Shoens (UCB) March 25, 1978
42 #include "config.h"
44 #include <sys/stat.h>
45 #include <sys/types.h>
47 #ifdef HAVE_GETTIMEOFDAY
48 # include <sys/time.h>
49 #endif
51 #include <errno.h>
52 #include <fcntl.h>
53 #include <limits.h>
54 #include <setjmp.h>
55 #include <signal.h>
56 #include <stdarg.h>
57 #include <stdio.h>
58 #include <stdlib.h>
59 #include <string.h>
60 #include <termios.h>
61 #include <time.h>
62 #include <unistd.h>
64 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
65 # include <stdint.h>
66 #else
67 # include <inttypes.h>
68 #endif
70 #ifdef HAVE_C90AMEND1
71 # include <wchar.h>
72 # include <wctype.h>
73 #endif
74 #ifdef HAVE_DEBUG
75 # include <assert.h>
76 #endif
77 #ifdef HAVE_ICONV
78 # include <iconv.h>
79 #endif
80 #ifdef HAVE_REGEX
81 # include <regex.h>
82 #endif
84 #ifdef HAVE_XSSL_MD5
85 # include <openssl/md5.h>
86 #endif
89 * Constants, some nail-specific macros
92 #if !defined NI_MAXHOST
93 # define NI_MAXHOST 1025
94 #endif
96 /* TODO PATH_MAX: fixed-size buffer is always wrong (think NFS) */
97 #ifndef PATH_MAX
98 # ifdef MAXPATHLEN
99 # define PATH_MAX MAXPATHLEN
100 # else
101 # define PATH_MAX 1024 /* _XOPEN_PATH_MAX POSIX 2008/Cor 1-2013 */
102 # endif
103 #endif
105 #ifndef HOST_NAME_MAX
106 # ifdef _POSIX_HOST_NAME_MAX
107 # define HOST_NAME_MAX _POSIX_HOST_NAME_MAX
108 # else
109 # define HOST_NAME_MAX 255
110 # endif
111 #endif
113 #ifndef NAME_MAX
114 # ifdef _POSIX_NAME_MAX
115 # define NAME_MAX _POSIX_NAME_MAX
116 # else
117 # define NAME_MAX 14
118 # endif
119 #endif
120 #if NAME_MAX < 8
121 # error NAME_MAX too small
122 #endif
124 #ifndef STDIN_FILENO
125 # define STDIN_FILENO 0
126 #endif
127 #ifndef STDOUT_FILENO
128 # define STDOUT_FILENO 1
129 #endif
130 #ifndef STDERR_FILENO
131 # define STDERR_FILENO 2
132 #endif
134 #ifdef NSIG_MAX
135 # undef NSIG
136 # define NSIG NSIG_MAX
137 #elif !defined NSIG
138 # define NSIG ((sizeof(sigset_t) * 8) - 1)
139 #endif
141 #ifdef O_CLOEXEC
142 # define _O_CLOEXEC O_CLOEXEC
143 # define _CLOEXEC_SET(FD) do {;} while(0)
144 #else
145 # define _O_CLOEXEC 0
146 # define _CLOEXEC_SET(FD) \
147 do { (void)fcntl((FD), F_SETFD, FD_CLOEXEC); } while (0)
148 #endif
150 #ifdef O_NOFOLLOW
151 # define n_O_NOFOLLOW O_NOFOLLOW
152 #else
153 # define n_O_NOFOLLOW 0
154 #endif
156 /* */
158 #if BUFSIZ + 0 > 2560 /* TODO simply use BUFSIZ? */
159 # define LINESIZE BUFSIZ /* max readable line width */
160 #else
161 # define LINESIZE 2560
162 #endif
163 #define BUFFER_SIZE (BUFSIZ >= (1u << 13) ? BUFSIZ : (1u << 14))
165 /* Network protocol newline */
166 #define NETNL "\015\012"
167 #define NETLINE(X) X NETNL
169 /* Number of Not-Yet-Dead calls that are remembered */
170 #if defined HAVE_DEBUG || defined HAVE_DEVEL || defined HAVE_NYD2
171 # ifdef HAVE_NYD2
172 # define NYD_CALLS_MAX (25 * 84)
173 # elif defined HAVE_DEVEL
174 # define NYD_CALLS_MAX (25 * 42)
175 # else
176 # define NYD_CALLS_MAX (25 * 10)
177 # endif
178 #endif
180 #define APPEND /* New mail goes to end of mailbox */
181 #define CBAD (-15555)
182 #define DOTLOCK_TRIES 5 /* Number of open(2) calls for dotlock */
183 #define FILE_LOCK_TRIES 10 /* Maximum tries before n_file_lock() fails */
184 #define FILE_LOCK_MILLIS 200 /* If UIZ_MAX, fall back to that */
185 #define n_ERROR "ERROR" /* Is-error? Also as n_error[] */
186 #define ERRORS_MAX 1000 /* Maximum error ring entries TODO configable*/
187 #define n_ESCAPE '~' /* Default escape for sending */
188 #define HSHSIZE 23 /* Hash prime TODO make dynamic, obsolete */
189 #define n_MAXARGC 512 /* Maximum list of raw strings */
190 #define MAXEXP 25 /* Maximum expansion of aliases */
191 #define REFERENCES_MAX 20 /* Maximum entries in References: */
192 #define n_UNIREPL "\xEF\xBF\xBD" /* 0xFFFD in UTF-8 */
193 #define FTMP_OPEN_TRIES 10 /* Maximum number of Ftmp() open(2) tries */
194 #define n_VEXPR_REGEX_MAX 10 /* Maximum address. `vexpr' regex(7) matches */
196 #define ACCOUNT_NULL "null" /* Name of "null" account */
198 /* Special FD requests for n_child_run(), n_child_start() */
199 #define n_CHILD_FD_PASS -1
200 #define n_CHILD_FD_NULL -2
202 /* Colour stuff */
203 #ifdef HAVE_COLOUR
204 # define n_COLOUR(X) X
205 #else
206 # define n_COLOUR(X)
207 #endif
209 /* */
210 #define n_FROM_DATEBUF 64 /* Size of RFC 4155 From_ line date */
211 #define n_DATE_DAYSYEAR 365u
212 #define n_DATE_MILLISSEC 1000u
213 #define n_DATE_SECSMIN 60u
214 #define n_DATE_MINSHOUR 60u
215 #define n_DATE_HOURSDAY 24u
216 #define n_DATE_SECSHOUR (n_DATE_SECSMIN * n_DATE_MINSHOUR)
217 #define n_DATE_SECSDAY (n_DATE_SECSHOUR * n_DATE_HOURSDAY)
219 /* *indentprefix* default as of POSIX */
220 #define INDENT_DEFAULT "\t"
222 /* Auto-reclaimed memory storage: size of the buffers. Maximum auto-reclaimed
223 * storage is that value /2, which is n_CTA()ed to be > 1024 */
224 #define n_MEMORY_AUTOREC_SIZE 0x2000u
225 /* Ugly, but avoid dynamic allocation for the management structure! */
226 #define n_MEMORY_POOL_TYPE_SIZEOF (7 * sizeof(void*))
228 /* Default *encoding* as enum mime_enc below */
229 #define MIME_DEFAULT_ENCODING MIMEE_B64
231 /* Maximum allowed line length in a mail before QP folding is necessary), and
232 * the real limit we go for */
233 #define MIME_LINELEN_MAX 998 /* Plus CRLF */
234 #define MIME_LINELEN_LIMIT (MIME_LINELEN_MAX - 48)
236 /* Ditto, SHOULD */
237 #define MIME_LINELEN 78 /* Plus CRLF */
239 /* And in headers which contain an encoded word according to RFC 2047 there is
240 * yet another limit; also RFC 2045: 6.7, (5). */
241 #define MIME_LINELEN_RFC2047 76
243 /* Locations of mime.types(5) */
244 #define MIME_TYPES_USR "~/.mime.types"
245 #define MIME_TYPES_SYS "/etc/mime.types"
247 /* Fallback MIME charsets, if *charset-7bit* and *charset-8bit* or not set.
248 * Note: must be lowercase! Changes affect enum okeys!
249 * (Keep in SYNC: ./nail.1:"Character sets", ./nail.h:CHARSET_*!) */
250 #define CHARSET_7BIT "us-ascii"
251 #ifdef HAVE_ICONV
252 # define CHARSET_8BIT "utf-8"
253 # define CHARSET_8BIT_OKEY charset_8bit
254 #else
255 # define CHARSET_8BIT "iso-8859-1"
256 # define CHARSET_8BIT_OKEY ttycharset
257 #endif
259 /* Some environment variables for pipe hooks etc. */
260 #define n_PIPEENV_FILENAME "MAILX_FILENAME"
261 #define n_PIPEENV_FILENAME_GENERATED "MAILX_FILENAME_GENERATED"
262 #define n_PIPEENV_FILENAME_TEMPORARY "MAILX_FILENAME_TEMPORARY"
263 #define n_PIPEENV_CONTENT "MAILX_CONTENT"
264 #define n_PIPEENV_CONTENT_EVIDENCE "MAILX_CONTENT_EVIDENCE"
266 /* Is *W* a quoting (ASCII only) character? */
267 #define ISQUOTE(W) \
268 ((W) == n_WC_C('>') || (W) == n_WC_C('|') ||\
269 (W) == n_WC_C('}') || (W) == n_WC_C(':'))
271 /* Maximum number of quote characters (not bytes!) that'll be used on
272 * follow lines when compressing leading quote characters */
273 #define QUOTE_MAX 42
275 /* How much spaces should a <tab> count when *quote-fold*ing? (power-of-two!) */
276 #define QUOTE_TAB_SPACES 8
278 /* For long iterative output, like `list', tabulator-completion, etc.,
279 * determine the screen width that should be used */
280 #define n_SCRNWIDTH_FOR_LISTS ((size_t)n_scrnwidth - ((size_t)n_scrnwidth >> 3))
282 /* Smells fishy after, or asks for shell expansion, dependent on context */
283 #define n_SHEXP_MAGIC_PATH_CHARS "|&;<>{}()[]*?$`'\"\\"
285 /* Maximum size of a message that is passed through to the spam system */
286 #define SPAM_MAXSIZE 420000
288 /* Switch indicating necessity of terminal access interface (termcap.c) */
289 #if defined HAVE_TERMCAP || defined HAVE_COLOUR || defined HAVE_MLE
290 # define n_HAVE_TCAP
291 #endif
294 * OS, CC support, generic macros etc.
297 #define n_ISPOW2(X) ((((X) - 1) & (X)) == 0)
298 #define n_MIN(A,B) ((A) < (B) ? (A) : (B))
299 #define n_MAX(A,B) ((A) < (B) ? (B) : (A))
300 #define n_CLIP(X,A,B) (((X) <= (A)) ? (A) : (((X) >= (B)) ? (B) : (X)))
301 #define n_ABS(A) ((A) < 0 ? -(A) : (A))
303 /* OS: we're not a library, only set what needs special treatment somewhere */
304 #define n_OS_DRAGONFLY 0
305 #define n_OS_OPENBSD 0
306 #define n_OS_SOLARIS 0
307 #define n_OS_SUNOS 0
309 #ifdef __DragonFly__
310 # undef n_OS_DRAGONFLY
311 # define n_OS_DRAGONFLY 1
312 #elif defined __OpenBSD__
313 # undef n_OS_OPENBSD
314 # define n_OS_OPENBSD 1
315 #elif defined __solaris__ || defined __sun
316 # if defined __SVR4 || defined __svr4__
317 # undef n_OS_SOLARIS
318 # define n_OS_SOLARIS 1
319 # else
320 # undef n_OS_SUNOS
321 # define n_OS_SUNOS 1
322 # endif
323 #endif
325 /* CC */
326 #define CC_CLANG 0
327 #define PREREQ_CLANG(X,Y) 0
328 #define CC_GCC 0
329 #define PREREQ_GCC(X,Y) 0
330 #define CC_TCC 0
331 #define PREREQ_TCC(X,Y) 0
333 #ifdef __clang__
334 # undef CC_CLANG
335 # undef PREREQ_CLANG
336 # define CC_CLANG 1
337 # define PREREQ_CLANG(X,Y) \
338 (__clang_major__ + 0 > (X) || \
339 (__clang_major__ + 0 == (X) && __clang_minor__ + 0 >= (Y)))
340 # define __EXTEN __extension__
342 #elif defined __GNUC__
343 # undef CC_GCC
344 # undef PREREQ_GCC
345 # define CC_GCC 1
346 # define PREREQ_GCC(X,Y) \
347 (__GNUC__ + 0 > (X) || (__GNUC__ + 0 == (X) && __GNUC_MINOR__ + 0 >= (Y)))
348 # define __EXTEN __extension__
350 #elif defined __TINYC__
351 # undef CC_TCC
352 # define CC_TCC 1
353 #endif
355 #ifndef __EXTEN
356 # define __EXTEN
357 #endif
359 /* Suppress some technical warnings via #pragma's unless developing.
360 * XXX Wild guesses: clang(1) 1.7 and (OpenBSD) gcc(1) 4.2.1 don't work */
361 #ifndef HAVE_DEVEL
362 # if PREREQ_CLANG(3, 4)
363 # pragma clang diagnostic ignored "-Wassign-enum"
364 # pragma clang diagnostic ignored "-Wdisabled-macro-expansion"
365 # pragma clang diagnostic ignored "-Wformat"
366 # pragma clang diagnostic ignored "-Wunused-result"
367 # elif PREREQ_GCC(4, 7)
368 # pragma GCC diagnostic ignored "-Wunused-local-typedefs"
369 # pragma GCC diagnostic ignored "-Wunused-result"
370 # pragma GCC diagnostic ignored "-Wformat"
371 # endif
372 #endif
374 /* For injection macros like DBG(), n_NATCH_CHAR() */
375 #define COMMA ,
377 #define EMPTY_FILE() typedef int n_CONCAT(avoid_empty_file__, n_FILE);
379 /* Pointer to size_t */
380 #define PTR2SIZE(X) ((size_t)(uintptr_t)(X))
382 /* Pointer comparison (types from below) */
383 #define PTRCMP(A,C,B) ((uintptr_t)(A) C (uintptr_t)(B))
385 /* Ditto, compare (maybe mixed-signed) integers cases to T bits, unsigned;
386 * Note: doesn't sign-extend correctly, that's still up to the caller */
387 #define UICMP(T,A,C,B) ((ui ## T ## _t)(A) C (ui ## T ## _t)(B))
389 /* Align something to a size/boundary that cannot cause just any problem */
390 #define n_ALIGN(X) (((X) + 2*sizeof(void*)) & ~((2*sizeof(void*)) - 1))
391 #define n_ALIGN_SMALL(X) \
392 (((X) + n_MAX(sizeof(size_t), sizeof(void*))) &\
393 ~(n_MAX(sizeof(size_t), sizeof(void*)) - 1))
395 /* Members in constant array */
396 #define n_NELEM(A) (sizeof(A) / sizeof((A)[0]))
398 /* sizeof() for member fields */
399 #define n_SIZEOF_FIELD(T,F) sizeof(((T *)NULL)->F)
401 /* Casts-away (*NOT* cast-away) */
402 #define n_UNUSED(X) ((void)(X))
403 #define n_UNCONST(P) ((void*)(uintptr_t)(void const*)(P))
404 #define n_UNVOLATILE(P) ((void*)(uintptr_t)(void volatile*)(P))
405 /* To avoid warnings with modern compilers for "char*i; *(si32_t*)i=;" */
406 #define n_UNALIGN(T,P) ((T)(uintptr_t)(P))
407 #define n_UNXXX(T,C,P) ((T)(uintptr_t)(C)(P))
409 /* __STDC_VERSION__ is ISO C99, so also use __STDC__, which should work */
410 #if defined __STDC__ || defined __STDC_VERSION__ /*|| defined __cplusplus*/
411 # define n_STRING(X) #X
412 # define n_XSTRING(X) n_STRING(X)
413 # define n_CONCAT(S1,S2) n__CONCAT_1(S1, S2)
414 # define n__CONCAT_1(S1,S2) S1 ## S2
415 #else
416 # define n_STRING(X) "X"
417 # define n_XSTRING STRING
418 # define n_CONCAT(S1,S2) S1/* won't work out */S2
419 #endif
421 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
422 # define n_FIELD_INITN(N) CONCAT(., N) =
423 # define n_FIELD_INITI(I) [I] =
424 #else
425 # define n_FIELD_INITN(N)
426 # define n_FIELD_INITI(N)
427 #endif
429 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
430 # define n_VFIELD_SIZE(X)
431 # define n_VSTRUCT_SIZEOF(T,F) sizeof(T)
432 #else
433 # define n_VFIELD_SIZE(X) \
434 ((X) == 0 ? sizeof(size_t) \
435 : ((ssize_t)(X) < 0 ? sizeof(size_t) - n_ABS(X) : (size_t)(X)))
436 # define n_VSTRUCT_SIZEOF(T,F) (sizeof(T) - n_SIZEOF_FIELD(T, F))
437 #endif
439 #ifdef HAVE_INLINE
440 # define SINLINE n_INLINE /* TODO obsolete */
441 #else
442 # define SINLINE static
443 #endif
445 #undef __FUN__
446 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
447 # define __FUN__ __func__
448 #elif CC_CLANG || PREREQ_GCC(3, 4)
449 # define __FUN__ __extension__ __FUNCTION__
450 #else
451 # define __FUN__ n_uagent /* Something that is not a literal */
452 #endif
454 #if defined __predict_true && defined __predict_false
455 # define n_LIKELY(X) __predict_true(X)
456 # define n_UNLIKELY(X) __predict_false(X)
457 #elif CC_CLANG || PREREQ_GCC(2, 96)
458 # define n_LIKELY(X) __builtin_expect(X, 1)
459 # define n_UNLIKELY(X) __builtin_expect(X, 0)
460 #else
461 # define n_LIKELY(X) (X)
462 # define n_UNLIKELY(X) (X)
463 #endif
465 #undef HAVE_NATCH_CHAR
466 #if defined HAVE_SETLOCALE && defined HAVE_C90AMEND1 && defined HAVE_WCWIDTH
467 # define HAVE_NATCH_CHAR
468 # define n_NATCH_CHAR(X) X
469 #else
470 # define n_NATCH_CHAR(X)
471 #endif
473 /* Compile-Time-Assert
474 * Problem is that some compilers warn on unused local typedefs, so add
475 * a special local CTA to overcome this */
476 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 201112L
477 # define n_CTA(T,M) _Static_assert(T, M)
478 # define n_LCTA(T,M) _Static_assert(T, M)
479 #else
480 # define n_CTA(T,M) n__CTA_1(T, n_FILE, __LINE__)
481 # define n_LCTA(T,M) n__LCTA_1(T, n_FILE, __LINE__)
482 #endif
483 #define n_CTAV(T) n_CTA(T, "Unexpected value of constant")
484 #define n_LCTAV(T) n_LCTA(T, "Unexpected value of constant")
486 #ifdef n_MAIN_SOURCE
487 # define n_MCTA(T,M) n_CTA(T, M);
488 #else
489 # define n_MCTA(T,M)
490 #endif
492 #define n__CTA_1(T,F,L) n__CTA_2(T, F, L)
493 #define n__CTA_2(T,F,L) \
494 typedef char ASSERTION_failed_in_file_## F ## _at_line_ ## L[(T) ? 1 : -1]
495 #define n__LCTA_1(T,F,L) n__LCTA_2(T, F, L)
496 #define n__LCTA_2(T,F,L) \
497 do{\
498 typedef char ASSERTION_failed_in_file_## F ## _at_line_ ## L[(T) ? 1 : -1];\
499 ASSERTION_failed_in_file_## F ## _at_line_ ## L __i_am_unused__;\
500 n_UNUSED(__i_am_unused__);\
501 }while(0)
503 #define n_UNINIT(N,V) N = V
505 /* Create a bit mask for the bit range LO..HI -- HI can't use highest bit! */
506 #define n_BITENUM_MASK(LO,HI) (((1u << ((HI) + 1)) - 1) & ~((1u << (LO)) - 1))
508 #undef DBG
509 #undef NDBG
510 #ifndef HAVE_DEBUG
511 # undef assert
512 # define assert(X) n_UNUSED(0)
513 # define DBG(X)
514 # define NDBG(X) X
515 # define DBGOR(X,Y) Y
516 #else
517 # define DBG(X) X
518 # define NDBG(X)
519 # define DBGOR(X,Y) X
520 #endif
522 /* Translation (init in main.c): may NOT set errno! */
523 #undef _
524 #undef N_
525 #undef V_
526 #define _(S) S
527 #define N_(S) S
528 #define V_(S) S
531 * Types TODO v15: n_XX_t
534 #ifdef UINT8_MAX
535 # define UI8_MAX UINT8_MAX
536 # define SI8_MIN INT8_MIN
537 # define SI8_MAX INT8_MAX
538 typedef uint8_t ui8_t;
539 typedef int8_t si8_t;
540 #elif UCHAR_MAX != 255
541 # error UCHAR_MAX must be 255
542 #else
543 # define UI8_MAX UCHAR_MAX
544 # define SI8_MIN CHAR_MIN
545 # define SI8_MAX CHAR_MAX
546 typedef unsigned char ui8_t;
547 typedef signed char si8_t;
548 #endif
550 #if !defined PRIu8 || !defined PRId8
551 # undef PRIu8
552 # undef PRId8
553 # define PRIu8 "hhu"
554 # define PRId8 "hhd"
555 #endif
557 #ifdef UINT16_MAX
558 # define UI16_MAX UINT16_MAX
559 # define SI16_MIN INT16_MIN
560 # define SI16_MAX INT16_MAX
561 typedef uint16_t ui16_t;
562 typedef int16_t si16_t;
563 #elif USHRT_MAX != 0xFFFFu
564 # error USHRT_MAX must be 0xFFFF
565 #else
566 # define UI16_MAX USHRT_MAX
567 # define SI16_MIN SHRT_MIN
568 # define SI16_MAX SHRT_MAX
569 typedef unsigned short ui16_t;
570 typedef signed short si16_t;
571 #endif
573 #if !defined PRIu16 || !defined PRId16
574 # undef PRIu16
575 # undef PRId16
576 # if UI16_MAX == UINT_MAX
577 # define PRIu16 "u"
578 # define PRId16 "d"
579 # else
580 # define PRIu16 "hu"
581 # define PRId16 "hd"
582 # endif
583 #endif
585 #ifdef UINT32_MAX
586 # define UI32_MAX UINT32_MAX
587 # define SI32_MIN INT32_MIN
588 # define SI32_MAX INT32_MAX
589 typedef uint32_t ui32_t;
590 typedef int32_t si32_t;
591 #elif ULONG_MAX == 0xFFFFFFFFu
592 # define UI32_MAX ULONG_MAX
593 # define SI32_MIN LONG_MIN
594 # define SI32_MAX LONG_MAX
595 typedef unsigned long int ui32_t;
596 typedef signed long int si32_t;
597 #elif UINT_MAX != 0xFFFFFFFFu
598 # error UINT_MAX must be 0xFFFFFFFF
599 #else
600 # define UI32_MAX UINT_MAX
601 # define SI32_MIN INT_MIN
602 # define SI32_MAX INT_MAX
603 typedef unsigned int ui32_t;
604 typedef signed int si32_t;
605 #endif
607 #if !defined PRIu32 || !defined PRId32
608 # undef PRIu32
609 # undef PRId32
610 # if UI32_MAX == ULONG_MAX
611 # define PRIu32 "lu"
612 # define PRId32 "ld"
613 # else
614 # define PRIu32 "u"
615 # define PRId32 "d"
616 # endif
617 #endif
619 #ifdef UINT64_MAX
620 # define UI64_MAX UINT64_MAX
621 # define SI64_MIN INT64_MIN
622 # define SI64_MAX INT64_MAX
623 typedef uint64_t ui64_t;
624 typedef int64_t si64_t;
625 #elif ULONG_MAX <= 0xFFFFFFFFu
626 # if !defined ULLONG_MAX || (ULLONG_MAX >> 31) < 0xFFFFFFFFu
627 # error We need a 64 bit integer
628 # else
629 # define UI64_MAX ULLONG_MAX
630 # define SI64_MIN LLONG_MIN
631 # define SI64_MAX LLONG_MAX
632 __EXTEN typedef unsigned long long ui64_t;
633 __EXTEN typedef signed long long si64_t;
634 # endif
635 #else
636 # define UI64_MAX ULONG_MAX
637 # define SI64_MIN LONG_MIN
638 # define SI64_MAX LONG_MAX
639 typedef unsigned long ui64_t;
640 typedef signed long si64_t;
641 #endif
643 /* PRIo64 for `vexpr' */
644 #if !defined PRIu64 || !defined PRId64 || !defined PRIX64 || !defined PRIo64
645 # undef PRIu64
646 # undef PRId64
647 # undef PRIX64
648 # undef PRIo64
649 # if defined ULLONG_MAX && UI64_MAX == ULLONG_MAX
650 # define PRIu64 "llu"
651 # define PRId64 "lld"
652 # define PRIX64 "llX"
653 # define PRIo64 "llo"
654 # else
655 # define PRIu64 "lu"
656 # define PRId64 "ld"
657 # define PRIX64 "lX"
658 # define PRIo64 "lo"
659 # endif
660 #endif
662 /* (So that we can use UICMP() for size_t comparison, too) */
663 typedef size_t uiz_t;
664 typedef ssize_t siz_t;
666 #undef PRIuZ
667 #undef PRIdZ
668 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
669 # define PRIuZ "zu"
670 # define PRIdZ "zd"
671 # define UIZ_MAX SIZE_MAX
672 #elif defined SIZE_MAX
673 /* UnixWare has size_t as unsigned as required but uses a signed limit
674 * constant (which is thus false!) */
675 # if SIZE_MAX == UI64_MAX || SIZE_MAX == SI64_MAX
676 # define PRIuZ PRIu64
677 # define PRIdZ PRId64
678 n_MCTA(sizeof(size_t) == sizeof(ui64_t),
679 "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
680 # elif SIZE_MAX == UI32_MAX || SIZE_MAX == SI32_MAX
681 # define PRIuZ PRIu32
682 # define PRIdZ PRId32
683 n_MCTA(sizeof(size_t) == sizeof(ui32_t),
684 "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
685 # else
686 # error SIZE_MAX is neither UI64_MAX nor UI32_MAX (please report this)
687 # endif
688 # define UIZ_MAX SIZE_MAX
689 #endif
690 #ifndef PRIuZ
691 # define PRIuZ "lu"
692 # define PRIdZ "ld"
693 n_MCTA(sizeof(size_t) == sizeof(unsigned long),
694 "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
695 # define UIZ_MAX ULONG_MAX
696 #endif
698 #ifndef UINTPTR_MAX
699 # ifdef SIZE_MAX
700 # define uintptr_t size_t
701 # define UINTPTR_MAX SIZE_MAX
702 # else
703 # define uintptr_t unsigned long
704 # define UINTPTR_MAX ULONG_MAX
705 # endif
706 #endif
708 #if !defined PRIuPTR || !defined PRIXPTR
709 # undef PRIuPTR
710 # undef PRIXPTR
711 # if UINTPTR_MAX == ULONG_MAX
712 # define PRIuPTR "lu"
713 # define PRIXPTR "lX"
714 # else
715 # define PRIuPTR "u"
716 # define PRIXPTR "X"
717 # endif
718 #endif
720 #ifdef HAVE_C90AMEND1
721 typedef wchar_t wc_t;
722 # define n_WC_C(X) L ## X
723 #else
724 typedef char wc_t; /* Yep: really 8-bit char */
725 # define n_WC_C(X) X
726 #endif
728 enum {FAL0, TRU1, TRUM1 = -1};
729 typedef si8_t bool_t;
731 /* Add shorter aliases for "normal" integers TODO v15 -> n_XX_t */
732 typedef unsigned long ul_i;
733 typedef unsigned int ui_i;
734 typedef unsigned short us_i;
735 typedef unsigned char uc_i;
737 typedef signed long sl_i;
738 typedef signed int si_i;
739 typedef signed short ss_i;
740 typedef signed char sc_i;
742 typedef void ( *sighandler_type)(int); /* TODO v15 obsolete */
743 typedef void ( *n_sighdl_t)(int);
745 enum authtype {
746 AUTHTYPE_NONE = 1<<0,
747 AUTHTYPE_PLAIN = 1<<1, /* POP3: APOP is covered by this */
748 AUTHTYPE_LOGIN = 1<<2,
749 AUTHTYPE_CRAM_MD5 = 1<<3,
750 AUTHTYPE_GSSAPI = 1<<4
753 enum expand_addr_flags {
754 EAF_NONE = 0, /* -> EAF_NOFILE | EAF_NOPIPE */
755 EAF_RESTRICT = 1<<0, /* "restrict" (do unless interaktive / -[~#]) */
756 EAF_FAIL = 1<<1, /* "fail" */
757 EAF_FAILINVADDR = 1<<2, /* "failinvaddr" */
758 /* TODO HACK! In pre-v15 we have a control flow problem (it is a general
759 * TODO design problem): if collect() calls makeheader(), e.g., for -t or
760 * TODO because of ~e diting, then that will checkaddr() and that will
761 * TODO remove invalid headers. However, this code path does not know
762 * TODO about keeping track of senderrors unless a pointer has been passed,
763 * TODO but which it doesn't for ~e, and shall not, too. Thus, invalid
764 * TODO addresses may be automatically removed, silently, and noone will
765 * TODO ever know, in particular not regarding "failinvaddr".
766 * TODO The hacky solution is this bit -- which can ONLY be used for fields
767 * TODO which will be subject to namelist_vaporise_head() later on!! --,
768 * TODO if it is set (by extract_header()) then checkaddr() will NOT strip
769 * TODO invalid headers off IF it deals with a NULL senderror pointer */
770 EAF_MAYKEEP = 1<<3,
771 /* Bits reused by enum expand_addr_check_mode! */
772 EAF_FILE = 1<<4, /* +"file" targets */
773 EAF_PIPE = 1<<5, /* +"pipe" command pipe targets */
774 EAF_NAME = 1<<6, /* +"name"s (non-address) names / MTA aliases */
775 EAF_ADDR = 1<<7, /* +"addr" network address (contain "@") */
777 EAF_TARGET_MASK = EAF_FILE | EAF_PIPE | EAF_NAME | EAF_ADDR,
778 EAF_RESTRICT_TARGETS = EAF_NAME | EAF_ADDR /* (default set if not set) */
781 enum expand_addr_check_mode {
782 EACM_NONE = 0, /* Don't care about *expandaddr* */
783 EACM_NORMAL = 1<<0, /* Use our normal *expandaddr* checking */
784 EACM_STRICT = 1<<1, /* Never allow any file or pipe addresse */
785 EACM_MODE_MASK = 0x3, /* _NORMAL and _STRICT are mutual! */
787 EACM_NOLOG = 1<<2, /* Don't log check errors */
789 /* Some special overwrites of EAF_TARGETs.
790 * May NOT clash with EAF_* bits which may be ORd to these here! */
792 EACM_NONAME = 1<<16
795 enum n_cmd_arg_desc_flags{/* TODO incomplete, misses getmsglist() */
796 /* - A type */
797 n_CMD_ARG_DESC_STRING = 1<<0, /* A !blankspacechar() string */
798 n_CMD_ARG_DESC_WYSH = 1<<1, /* sh(1)ell-style quoted */
800 n__CMD_ARG_DESC_TYPE_MASK = n_CMD_ARG_DESC_STRING | n_CMD_ARG_DESC_WYSH,
802 /* - Optional flags */
803 /* It is not an error if an optional argument is missing; once an argument
804 * has been declared optional only optional arguments may follow */
805 n_CMD_ARG_DESC_OPTION = 1<<16,
806 /* GREEDY: parse as many of that type as possible; must be last entry */
807 n_CMD_ARG_DESC_GREEDY = 1<<17,
808 /* Honour an overall "stop" request in one of the arguments (\c@ or #) */
809 n_CMD_ARG_DESC_HONOUR_STOP = 1<<18,
811 n__CMD_ARG_DESC_FLAG_MASK = n_CMD_ARG_DESC_OPTION | n_CMD_ARG_DESC_GREEDY |
812 n_CMD_ARG_DESC_HONOUR_STOP
815 #ifdef HAVE_COLOUR
816 /* We do have several contexts of colour IDs; since only one of them can be
817 * active at any given time let's share the value range */
818 enum n_colour_ctx{
819 n_COLOUR_CTX_SUM,
820 n_COLOUR_CTX_VIEW,
821 n_COLOUR_CTX_MLE,
822 n__COLOUR_CTX_MAX1
825 enum n_colour_id{
826 /* Header summary */
827 n_COLOUR_ID_SUM_DOTMARK = 0,
828 n_COLOUR_ID_SUM_HEADER,
829 n_COLOUR_ID_SUM_THREAD,
831 /* Message display */
832 n_COLOUR_ID_VIEW_FROM_ = 0,
833 n_COLOUR_ID_VIEW_HEADER,
834 n_COLOUR_ID_VIEW_MSGINFO,
835 n_COLOUR_ID_VIEW_PARTINFO,
837 /* Mailx-Line-Editor */
838 n_COLOUR_ID_MLE_POSITION = 0,
839 n_COLOUR_ID_MLE_PROMPT,
841 n__COLOUR_IDS = n_COLOUR_ID_VIEW_PARTINFO + 1
844 /* Colour preconditions, let's call them tags, cannot be an enum because for
845 * message display they are the actual header name of the current header. Thus
846 * let's use constants of pseudo pointers */
847 # define n_COLOUR_TAG_SUM_DOT ((char*)-2)
848 # define n_COLOUR_TAG_SUM_OLDER ((char*)-3)
849 #endif /* HAVE_COLOUR */
851 enum conversion {
852 CONV_NONE, /* no conversion */
853 CONV_7BIT, /* no conversion, is 7bit */
854 CONV_FROMQP, /* convert from quoted-printable */
855 CONV_TOQP, /* convert to quoted-printable */
856 CONV_8BIT, /* convert to 8bit (iconv) */
857 CONV_FROMB64, /* convert from base64 */
858 CONV_FROMB64_T, /* convert from base64/text */
859 CONV_TOB64, /* convert to base64 */
860 CONV_FROMHDR, /* convert from RFC1522 format */
861 CONV_TOHDR, /* convert to RFC1522 format */
862 CONV_TOHDR_A /* convert addresses for header */
865 enum cproto {
866 CPROTO_CCRED, /* Special dummy credential proto (S/MIME etc.) */
867 CPROTO_SMTP,
868 CPROTO_POP3
871 enum n_dotlock_state{
872 n_DLS_NONE,
873 n_DLS_CANT_CHDIR, /* Failed to chdir(2) into desired path */
874 n_DLS_NAMETOOLONG, /* Lock file name would be too long */
875 n_DLS_ROFS, /* Read-only filesystem (no error, mailbox RO) */
876 n_DLS_NOPERM, /* No permission to creat lock file */
877 n_DLS_NOEXEC, /* Privilege separated dotlocker not found */
878 n_DLS_PRIVFAILED, /* Rising privileges failed in dotlocker */
879 n_DLS_EXIST, /* Lock file already exists, stale lock? */
880 n_DLS_FISHY, /* Something makes us think bad of situation */
881 n_DLS_DUNNO, /* Catch-all error */
882 n_DLS_PING, /* Not an error, but have to wait for lock */
883 n_DLS_ABANDON = 1<<7 /* ORd to any but _NONE: give up, don't retry */
886 /* enum n_err_number from config.h via mk-conf.sh, which is in sync with
887 * n_err_to_doc(), n_err_to_name() and n_err_from_name() */
889 enum n_exit_status{
890 n_EXIT_OK = EXIT_SUCCESS,
891 n_EXIT_ERR = EXIT_FAILURE,
892 n_EXIT_USE = 64, /* sysexits.h:EX_USAGE */
893 n_EXIT_NOUSER = 67, /* :EX_NOUSER */
894 n_EXIT_COLL_ABORT = 1<<1, /* Message collection was aborted */
895 n_EXIT_SEND_ERROR = 1<<2 /* Unspecified send error occurred */
898 enum fedit_mode {
899 FEDIT_NONE = 0,
900 FEDIT_SYSBOX = 1<<0, /* %: prefix */
901 FEDIT_RDONLY = 1<<1, /* Readonly (per-box, n_OPT_R_FLAG is global) */
902 FEDIT_NEWMAIL = 1<<2 /* `newmail' operation TODO OBSOLETE THIS! */
905 enum fexp_mode {
906 FEXP_FULL, /* Full expansion */
907 FEXP_NOPROTO = 1<<0, /* TODO no which_protocol() to decide expansion */
908 FEXP_SILENT = 1<<1, /* Don't print but only return errors */
909 FEXP_MULTIOK = 1<<2, /* Expansion to many entries is ok */
910 FEXP_LOCAL = 1<<3, /* Result must be local file/maildir */
911 FEXP_NSHORTCUT = 1<<4, /* Don't expand shortcuts */
912 FEXP_NSPECIAL = 1<<5, /* No %,#,& specials */
913 FEXP_NFOLDER = 1<<6, /* NSPECIAL and no + folder, too */
914 FEXP_NSHELL = 1<<7, /* Don't do shell word exp. (but ~/, $VAR) */
915 FEXP_NVAR = 1<<8 /* ..not even $VAR expansion */
918 enum n_file_lock_type{
919 FLT_READ,
920 FLT_WRITE
923 enum n_go_input_flags{
924 n_GO_INPUT_NONE,
925 n_GO_INPUT_CTX_BASE = 0, /* Generic shared base: don't use! */
926 n_GO_INPUT_CTX_DEFAULT = 1, /* Default input */
927 n_GO_INPUT_CTX_COMPOSE = 2, /* Compose mode input */
928 n__GO_INPUT_CTX_MASK = 3,
929 n__GO_INPUT_CTX_MAX1 = n_GO_INPUT_CTX_COMPOSE + 1,
931 n_GO_INPUT_HOLDALLSIGS = 1u<<8, /* hold_all_sigs() active TODO */
932 n_GO_INPUT_FORCE_STDIN = 1u<<9, /* Even in macro, use stdin (`read')! */
933 n_GO_INPUT_NL_ESC = 1u<<10, /* Support "\\$" line continuation */
934 n_GO_INPUT_NL_FOLLOW = 1u<<11, /* ..on such a follow line */
935 n_GO_INPUT_PROMPT_NONE = 1u<<12, /* Don't print prompt */
936 n_GO_INPUT_PROMPT_EVAL = 1u<<13, /* Instead, evaluate *prompt* */
937 #if 0
938 n_GO_INPUT_DROP_TRAIL_SPC = 1u<<14, /* Drop any trailing space */
939 n_GO_INPUT_DROP_LEAD_SPC = 1u<<15, /* ..leading ones */
940 n_GO_INPUT_TRIM_SPACE = n_GO_INPUT_DROP_TRAIL_SPC | n_GO_INPUT_DROP_LEAD_SPC,
941 #endif
943 n_GO_INPUT_HIST_ADD = 1u<<16, /* Add the result to history list */
944 n_GO_INPUT_HIST_GABBY = 1u<<17, /* Consider history entry as gabby */
946 n__GO_FREEBIT = 24
949 enum n_go_input_inject_flags{
950 n_GO_INPUT_INJECT_NONE = 0,
951 n_GO_INPUT_INJECT_COMMIT = 1u<<0, /* Auto-commit input */
952 n_GO_INPUT_INJECT_HISTORY = 1u<<1 /* Allow history addition */
955 enum n_iconv_flags{
956 n_ICONV_NONE = 0,
957 n_ICONV_IGN_ILSEQ = 1<<0, /* Ignore EILSEQ in input (replacement char) */
958 n_ICONV_IGN_NOREVERSE = 1<<1, /* .. non-reversible conversions in output */
959 n_ICONV_UNIREPL = 1<<2, /* Use Unicode replacement 0xFFFD = EF BF BD */
960 n_ICONV_DEFAULT = n_ICONV_IGN_ILSEQ | n_ICONV_IGN_NOREVERSE,
961 n_ICONV_UNIDEFAULT = n_ICONV_DEFAULT | n_ICONV_UNIREPL
964 /* Special ignore (where _TYPE is covered by POSIX `ignore' / `retain').
965 * _ALL is very special in that it doesn't have a backing object.
966 * Go over enum to avoid cascads of (different) CC warnings for used CTA()s */
967 #define n_IGNORE_ALL ((struct n_ignore*)n__IGNORE_ALL)
968 #define n_IGNORE_TYPE ((struct n_ignore*)n__IGNORE_TYPE)
969 #define n_IGNORE_SAVE ((struct n_ignore*)n__IGNORE_SAVE)
970 #define n_IGNORE_FWD ((struct n_ignore*)n__IGNORE_FWD)
971 #define n_IGNORE_TOP ((struct n_ignore*)n__IGNORE_TOP)
973 enum{
974 n__IGNORE_ALL = -2,
975 n__IGNORE_TYPE = -3,
976 n__IGNORE_SAVE = -4,
977 n__IGNORE_FWD = -5,
978 n__IGNORE_TOP = -6,
979 n__IGNORE_ADJUST = 3,
980 n__IGNORE_MAX = 6 - n__IGNORE_ADJUST
983 enum n_idec_mode{
984 n_IDEC_MODE_NONE,
985 n_IDEC_MODE_SIGNED_TYPE = 1<<0, /* To choose limits, error constants etc. */
986 #if 0
987 n_IDEC_MODE_SIGN_FORCE_SIGNED_TYPE = 1<<2,
988 #endif
989 n_IDEC_MODE_LIMIT_8BIT = 1<<3, /* Saturate if result exceeds 8-bit */
990 n_IDEC_MODE_LIMIT_16BIT = 2<<3,
991 n_IDEC_MODE_LIMIT_32BIT = 3<<3,
992 n__IDEC_MODE_LIMIT_MASK = 3<<3,
993 n_IDEC_MODE_LIMIT_NOERROR = 1<<5, /* Not an error if limit is excessed! */
994 /* These bits are duplicated in the _state result bits! */
995 n__IDEC_MODE_MASK = (1<<6) - 1
998 enum n_idec_state{
999 n_IDEC_STATE_NONE,
1000 /* Malformed input, no usable result has been stored */
1001 n_IDEC_STATE_EINVAL = 1<<8,
1002 /* Bad character according to base, but we have seen some good before,
1003 * otherwise _EINVAL would have been used */
1004 n_IDEC_STATE_EBASE = 2<<8,
1005 n_IDEC_STATE_EOVERFLOW = 3<<8, /* Result too large */
1006 n_IDEC_STATE_EMASK = (3<<8), /* Any errors, that is */
1007 n_IDEC_STATE_SEEN_MINUS = 1<<16, /* Seen - in input? */
1008 n_IDEC_STATE_CONSUMED = 1<<17, /* All the input buffer was consumed */
1009 n__IDEC_PRIVATE_SHIFT1 = 24
1011 n_MCTA(n__IDEC_MODE_MASK <= (1<<8) - 1, "Shared bit range overlaps")
1013 enum mimecontent {
1014 MIME_UNKNOWN, /* unknown content */
1015 MIME_SUBHDR, /* inside a multipart subheader */
1016 MIME_822, /* message/rfc822 content */
1017 MIME_MESSAGE, /* other message/ content */
1018 MIME_TEXT_PLAIN, /* text/plain content */
1019 MIME_TEXT_HTML, /* text/html content */
1020 MIME_TEXT, /* other text/ content */
1021 MIME_ALTERNATIVE, /* multipart/alternative content */
1022 MIME_RELATED, /* mime/related (RFC 2387) */
1023 MIME_DIGEST, /* multipart/digest content */
1024 MIME_SIGNED, /* multipart/signed */
1025 MIME_ENCRYPTED, /* multipart/encrypted */
1026 MIME_MULTI, /* other multipart/ content */
1027 MIME_PKCS7, /* PKCS7 content */
1028 MIME_DISCARD /* content is discarded */
1031 enum mime_counter_evidence {
1032 MIMECE_NONE,
1033 MIMECE_SET = 1<<0, /* *mime-counter-evidence* was set */
1034 MIMECE_BIN_OVWR = 1<<1, /* appli../octet-stream: check, ovw if possible */
1035 MIMECE_ALL_OVWR = 1<<2, /* all: check, ovw if possible */
1036 MIMECE_BIN_PARSE = 1<<3 /* appli../octet-stream: classify contents last */
1039 /* Content-Transfer-Encodings as defined in RFC 2045:
1040 * - Quoted-Printable, section 6.7
1041 * - Base64, section 6.8 */
1042 #define QP_LINESIZE (4 * 19) /* Max. compliant QP linesize */
1044 #define B64_LINESIZE (4 * 19) /* Max. compliant Base64 linesize */
1045 #define B64_ENCODE_INPUT_PER_LINE 57 /* Max. input for Base64 encode/line */
1047 enum mime_enc {
1048 MIMEE_NONE, /* message is not in MIME format */
1049 MIMEE_BIN, /* message is in binary encoding */
1050 MIMEE_8B, /* message is in 8bit encoding */
1051 MIMEE_7B, /* message is in 7bit encoding */
1052 MIMEE_QP, /* message is quoted-printable */
1053 MIMEE_B64 /* message is in base64 encoding */
1056 /* xxx QP came later, maybe rewrite all to use mime_enc_flags directly? */
1057 enum mime_enc_flags {
1058 MIMEEF_NONE,
1059 MIMEEF_SALLOC = 1<<0, /* Use salloc(), not srealloc().. */
1060 /* ..result .s,.l point to user buffer of *_LINESIZE+[+[+]] bytes instead */
1061 MIMEEF_BUF = 1<<1,
1062 MIMEEF_CRLF = 1<<2, /* (encode) Append "\r\n" to lines */
1063 MIMEEF_LF = 1<<3, /* (encode) Append "\n" to lines */
1064 /* (encode) If one of _CRLF/_LF is set, honour *_LINESIZE+[+[+]] and
1065 * inject the desired line-ending whenever a linewrap is desired */
1066 MIMEEF_MULTILINE = 1<<4,
1067 /* (encode) Quote with header rules, do not generate soft NL breaks?
1068 * For mustquote(), specifies whether special RFC 2047 header rules
1069 * should be used instead */
1070 MIMEEF_ISHEAD = 1<<5,
1071 /* (encode) Ditto; for mustquote() this furtherly fine-tunes behaviour in
1072 * that characters which would not be reported as "must-quote" when
1073 * detecting whether quoting is necessary at all will be reported as
1074 * "must-quote" if they have to be encoded in an encoded word */
1075 MIMEEF_ISENCWORD = 1<<6,
1076 __MIMEEF_LAST = 6
1079 enum qpflags {
1080 QP_NONE = MIMEEF_NONE,
1081 QP_SALLOC = MIMEEF_SALLOC,
1082 QP_BUF = MIMEEF_BUF,
1083 QP_ISHEAD = MIMEEF_ISHEAD,
1084 QP_ISENCWORD = MIMEEF_ISENCWORD
1087 enum b64flags {
1088 B64_NONE = MIMEEF_NONE,
1089 B64_SALLOC = MIMEEF_SALLOC,
1090 B64_BUF = MIMEEF_BUF,
1091 B64_CRLF = MIMEEF_CRLF,
1092 B64_LF = MIMEEF_LF,
1093 B64_MULTILINE = MIMEEF_MULTILINE,
1094 /* Not used, but for clarity only */
1095 B64_ISHEAD = MIMEEF_ISHEAD,
1096 B64_ISENCWORD = MIMEEF_ISENCWORD,
1097 /* Special version of Base64, "Base64URL", according to RFC 4648.
1098 * Only supported for encoding! */
1099 B64_RFC4648URL = 1<<(__MIMEEF_LAST+1),
1100 /* Don't use any ("=") padding;
1101 * may NOT be used with any of _CRLF, _LF or _MULTILINE */
1102 B64_NOPAD = 1<<(__MIMEEF_LAST+2)
1105 enum mime_parse_flags {
1106 MIME_PARSE_NONE = 0,
1107 MIME_PARSE_DECRYPT = 1<<0,
1108 MIME_PARSE_PARTS = 1<<1,
1109 MIME_PARSE_SHALLOW = 1<<2
1112 enum mime_handler_flags {
1113 MIME_HDL_NULL, /* No pipe- mimetype handler, go away */
1114 MIME_HDL_CMD, /* Normal command */
1115 MIME_HDL_TEXT, /* @ special cmd to force treatment as text */
1116 MIME_HDL_PTF, /* A special pointer-to-function handler */
1117 MIME_HDL_MSG, /* Display msg (returned as command string) */
1118 MIME_HDL_TYPE_MASK = 7,
1119 MIME_HDL_ISQUOTE = 1<<4, /* Is quote action (we have info, keep it!) */
1120 MIME_HDL_NOQUOTE = 1<<5, /* No MIME for quoting */
1121 MIME_HDL_ALWAYS = 1<<6, /* Handler shall run for multi-msg actions */
1122 MIME_HDL_ASYNC = 1<<7, /* Should run asynchronously */
1123 MIME_HDL_NEEDSTERM = 1<<8, /* Takes over terminal */
1124 MIME_HDL_TMPF = 1<<9, /* Create temporary file (zero-sized) */
1125 MIME_HDL_TMPF_FILL = 1<<10, /* Fill in the msg body content */
1126 MIME_HDL_TMPF_UNLINK = 1<<11 /* Delete it later again */
1129 enum mlist_state {
1130 MLIST_OTHER = 0, /* Normal address */
1131 MLIST_KNOWN = 1, /* A known `mlist' */
1132 MLIST_SUBSCRIBED = -1 /* A `mlsubscribe'd list */
1135 enum oflags {
1136 OF_RDONLY = 1<<0,
1137 OF_WRONLY = 1<<1,
1138 OF_RDWR = 1<<2,
1139 OF_APPEND = 1<<3,
1140 OF_CREATE = 1<<4,
1141 OF_TRUNC = 1<<5,
1142 OF_EXCL = 1<<6,
1143 OF_CLOEXEC = 1<<7, /* TODO not used, always implied! CHANGE!! */
1144 OF_UNLINK = 1<<8, /* Only for Ftmp(): unlink(2) after creation */
1145 OF_HOLDSIGS = 1<<9, /* Mutual with OF_UNLINK - await Ftmp_free() */
1146 OF_REGISTER = 1<<10, /* Register file in our file table */
1147 OF_REGISTER_UNLINK = 1<<11, /* unlink(2) upon unreg.; _REGISTER asserted! */
1148 OF_SUFFIX = 1<<12 /* Ftmp() name hint is mandatory! extension! */
1151 enum okay {
1152 STOP = 0,
1153 OKAY = 1
1156 enum okey_xlook_mode {
1157 OXM_PLAIN = 1<<0, /* Plain key always tested */
1158 OXM_H_P = 1<<1, /* Check PLAIN-.url_h_p */
1159 OXM_U_H_P = 1<<2, /* Check PLAIN-.url_u_h_p */
1160 OXM_ALL = 0x7
1163 /* <0 means "stop" unless *prompt* extensions are enabled. */
1164 enum prompt_exp {
1165 PROMPT_STOP = -1, /* \c */
1166 /* *prompt* extensions: \$, \@ etc. */
1167 PROMPT_DOLLAR = -2,
1168 PROMPT_AT = -3
1171 enum protocol {
1172 PROTO_FILE, /* refers to a local file */
1173 PROTO_POP3, /* is a pop3 server string */
1174 PROTO_MAILDIR, /* refers to a maildir folder */
1175 PROTO_UNKNOWN /* unknown protocol */
1178 enum sendaction {
1179 SEND_MBOX, /* no conversion to perform */
1180 SEND_RFC822, /* no conversion, no From_ line */
1181 SEND_TODISP, /* convert to displayable form */
1182 SEND_TODISP_ALL, /* same, include all MIME parts */
1183 SEND_SHOW, /* convert to 'show' command form */
1184 SEND_TOSRCH, /* convert for IMAP SEARCH */
1185 SEND_TOFILE, /* convert for saving body to a file */
1186 SEND_TOPIPE, /* convert for pipe-content/subc. */
1187 SEND_QUOTE, /* convert for quoting */
1188 SEND_QUOTE_ALL, /* same, include all MIME parts */
1189 SEND_DECRYPT /* decrypt */
1192 enum n_shexp_parse_flags{
1193 n_SHEXP_PARSE_NONE,
1194 /* Don't perform expansions or interpret reverse solidus escape sequences.
1195 * Output may be NULL, otherwise the possibly trimmed non-expanded input is
1196 * used as output (implies _PARSE_META_KEEP) */
1197 n_SHEXP_PARSE_DRYRUN = 1u<<0,
1198 n_SHEXP_PARSE_TRUNC = 1u<<1, /* Truncate result storage on entry */
1199 n_SHEXP_PARSE_TRIMSPACE = 1u<<2, /* Ignore space surrounding tokens */
1200 n_SHEXP_PARSE_LOG = 1u<<3, /* Log errors */
1201 n_SHEXP_PARSE_LOG_D_V = 1u<<4, /* Log errors if n_OPT_D_V */
1202 n_SHEXP_PARSE_IFS_ADD_COMMA = 1u<<5, /* Add comma , to normal "IFS" */
1203 n_SHEXP_PARSE_IFS_IS_COMMA = 1u<<6, /* Let comma , be the sole "IFS" */
1204 n_SHEXP_PARSE_IGNORE_EMPTY = 1u<<7, /* Ignore empty tokens, start over */
1206 /* Implicitly open quotes, and ditto closing. _AUTO_FIXED may only be used
1207 * if an auto-quote-mode is enabled, implies _AUTO_CLOSE and causes the
1208 * quote mode to be permanently active (cannot be closed) */
1209 n_SHEXP_PARSE_QUOTE_AUTO_FIXED = 1u<<8,
1210 n_SHEXP_PARSE_QUOTE_AUTO_SQ = 1u<<9,
1211 n_SHEXP_PARSE_QUOTE_AUTO_DQ = 1u<<10,
1212 n_SHEXP_PARSE_QUOTE_AUTO_DSQ = 1u<<11,
1213 n_SHEXP_PARSE_QUOTE_AUTO_CLOSE = 1u<<12, /* Ignore an open quote at EOS */
1214 n__SHEXP_PARSE_QUOTE_AUTO_MASK = n_SHEXP_PARSE_QUOTE_AUTO_SQ |
1215 n_SHEXP_PARSE_QUOTE_AUTO_DQ | n_SHEXP_PARSE_QUOTE_AUTO_DSQ,
1217 /* Recognize metacharacters to separate tokens */
1218 n_SHEXP_PARSE_META_VERTBAR = 1u<<13,
1219 n_SHEXP_PARSE_META_AMPERSAND = 1u<<14,
1220 /* Interpret ; as a sequencing operator, go_input_inject() remainder */
1221 n_SHEXP_PARSE_META_SEMICOLON = 1u<<15,
1222 /* LPAREN, RPAREN, LESSTHAN, GREATERTHAN */
1224 /* Keep the metacharacter (or IFS character), do not skip over it */
1225 n_SHEXP_PARSE_META_KEEP = 1u<<16,
1227 n__SHEXP_PARSE_LAST = 16
1230 enum n_shexp_state{
1231 n_SHEXP_STATE_NONE,
1232 /* We have produced some output (or would have, with _PARSE_DRYRUN).
1233 * Note that empty quotes like '' produce no output but set this bit */
1234 n_SHEXP_STATE_OUTPUT = 1<<2,
1235 /* Don't call the parser again (\c0 or # comment seen; out of input).
1236 * Not (necessarily) mutual with _OUTPUT) */
1237 n_SHEXP_STATE_STOP = 1<<1,
1238 n_SHEXP_STATE_UNICODE = 1<<3, /* \[Uu] used */
1239 n_SHEXP_STATE_CONTROL = 1<<4, /* Control characters seen */
1240 n_SHEXP_STATE_META_VERTBAR = 1<<5, /* Metacharacter | follows/ed */
1241 n_SHEXP_STATE_META_AMPERSAND = 1<<6, /* Metacharacter & follows/ed */
1242 n_SHEXP_STATE_META_SEMICOLON = 1<<7, /* Metacharacter ; follows/ed */
1244 n_SHEXP_STATE_ERR_CONTROL = 1<<16, /* \c notation with invalid argument */
1245 n_SHEXP_STATE_ERR_UNICODE = 1<<17, /* Valid \[Uu] used and !n_PSO_UNICODE */
1246 n_SHEXP_STATE_ERR_NUMBER = 1<<18, /* Bad number (\[UuXx]) */
1247 n_SHEXP_STATE_ERR_BRACE = 1<<19, /* _QUOTEOPEN + no } brace for ${VAR */
1248 n_SHEXP_STATE_ERR_IDENTIFIER = 1<<20, /* Invalid identifier */
1249 n_SHEXP_STATE_ERR_BADSUB = 1<<21, /* Empty/bad ${} substitution */
1250 n_SHEXP_STATE_ERR_QUOTEOPEN = 1<<22, /* Quote remains open at EOS */
1252 n_SHEXP_STATE_ERR_MASK = n_BITENUM_MASK(16, 22)
1255 enum n_sigman_flags{
1256 n_SIGMAN_NONE = 0,
1257 n_SIGMAN_HUP = 1<<0,
1258 n_SIGMAN_INT = 1<<1,
1259 n_SIGMAN_QUIT = 1<<2,
1260 n_SIGMAN_TERM = 1<<3,
1261 n_SIGMAN_PIPE = 1<<4,
1263 n_SIGMAN_IGN_HUP = 1<<5,
1264 n_SIGMAN_IGN_INT = 1<<6,
1265 n_SIGMAN_IGN_QUIT = 1<<7,
1266 n_SIGMAN_IGN_TERM = 1<<8,
1268 n_SIGMAN_ALL = 0xFF,
1269 /* Mostly for _leave() reraise flags */
1270 n_SIGMAN_VIPSIGS = n_SIGMAN_HUP | n_SIGMAN_INT | n_SIGMAN_QUIT |
1271 n_SIGMAN_TERM,
1272 n_SIGMAN_NTTYOUT_PIPE = 1<<16,
1273 n_SIGMAN_VIPSIGS_NTTYOUT = n_SIGMAN_HUP | n_SIGMAN_INT | n_SIGMAN_QUIT |
1274 n_SIGMAN_TERM | n_SIGMAN_NTTYOUT_PIPE,
1276 n__SIGMAN_PING = 1<<17
1279 #ifdef HAVE_SSL
1280 enum ssl_verify_level {
1281 SSL_VERIFY_IGNORE,
1282 SSL_VERIFY_WARN,
1283 SSL_VERIFY_ASK,
1284 SSL_VERIFY_STRICT
1286 #endif
1288 enum tdflags {
1289 TD_NONE, /* no display conversion */
1290 TD_ISPR = 1<<0, /* use isprint() checks */
1291 TD_ICONV = 1<<1, /* use iconv() */
1292 TD_DELCTRL = 1<<2, /* delete control characters */
1295 * NOTE: _TD_EOF and _TD_BUFCOPY may be ORd with enum conversion and
1296 * enum sendaction, and may thus NOT clash with their bit range!
1298 _TD_EOF = 1<<14, /* EOF seen, last round! */
1299 _TD_BUFCOPY = 1<<15 /* Buffer may be constant, copy it */
1302 #ifdef n_HAVE_TCAP
1303 enum n_termcap_captype{
1304 n_TERMCAP_CAPTYPE_NONE = 0,
1305 /* Internally we share the bitspace, so ensure no value ends up as 0 */
1306 n_TERMCAP_CAPTYPE_BOOL = 1,
1307 n_TERMCAP_CAPTYPE_NUMERIC,
1308 n_TERMCAP_CAPTYPE_STRING,
1309 n__TERMCAP_CAPTYPE_MAX1
1312 /* Termcap commands; different to queries commands perform actions.
1313 * Commands are resolved upon init time, and are all termcap(5)-compatible,
1314 * therefore we use the short termcap(5) names.
1315 * Note this is parsed by mk-tcap-map.pl, which expects the syntax
1316 * "CONSTANT, COMMENT" where COMMENT is "Capname/TCap-Code, TYPE[, FLAGS]",
1317 * and one of Capname and TCap-Code may be the string "-" meaning ENOENT;
1318 * a | vertical bar or end-of-comment ends processing; see termcap.c.
1319 * We may use the free-form part after | for the "Variable String" and notes on
1320 * necessary termcap_cmd() arguments; if those are in [] brackets they are not
1321 * regular but are only used when the command, i.e., its effect, is somehow
1322 * simulated / faked by a builtin fallback implementation.
1323 * Availability of builtin fallback indicated by leading @ (at-sign) */
1324 enum n_termcap_cmd{
1325 # ifdef HAVE_TERMCAP
1326 n_TERMCAP_CMD_te, /* rmcup/te, STRING | exit_ca_mode: -,- */
1327 n_TERMCAP_CMD_ti, /* smcup/ti, STRING | enter_ca_mode: -,- */
1329 n_TERMCAP_CMD_ks, /* smkx/ks, STRING | keypad_xmit: -,- */
1330 n_TERMCAP_CMD_ke, /* rmkx/ke, STRING | keypad_local: -,- */
1332 n_TERMCAP_CMD_cd, /* ed/cd, STRING | clr_eos: -,- */
1333 n_TERMCAP_CMD_cl, /* clear/cl, STRING | clear_screen(+home): -,- */
1334 n_TERMCAP_CMD_ho, /* home/ho, STRING | cursor_home: -,- */
1335 # endif
1337 # ifdef HAVE_MLE
1338 n_TERMCAP_CMD_ce, /* el/ce, STRING | @ clr_eol: [start-column],- */
1339 n_TERMCAP_CMD_ch, /* hpa/ch, STRING, IDX1 | column_address: column,- */
1340 n_TERMCAP_CMD_cr, /* cr/cr, STRING | @ carriage_return: -,- */
1341 n_TERMCAP_CMD_le, /* cub1/le, STRING, CNT | @ cursor_left: count,- */
1342 n_TERMCAP_CMD_nd, /* cuf1/nd, STRING, CNT | @ cursor_right: count,- */
1343 # endif
1345 n__TERMCAP_CMD_MAX1,
1346 n__TERMCAP_CMD_MASK = (1<<24) - 1,
1348 /* Only perform command if ca-mode is used */
1349 n_TERMCAP_CMD_FLAG_CA_MODE = 1<<29,
1350 /* I/O should be flushed after command completed */
1351 n_TERMCAP_CMD_FLAG_FLUSH = 1<<30
1354 /* Termcap queries; a query is a command that returns a struct n_termcap_value.
1355 * Queries are resolved once they are used first, and may not be termcap(5)-
1356 * compatible, therefore we use terminfo(5) names.
1357 * Note this is parsed by mk-tcap-map.pl, which expects the syntax
1358 * "CONSTANT, COMMENT" where COMMENT is "Capname/TCap-Code, TYPE[, FLAGS]",
1359 * and one of Capname and TCap-Code may be the string "-" meaning ENOENT;
1360 * a | vertical bar or end-of-comment ends processing; see termcap.c.
1361 * We may use the free-form part after | for the "Variable String" and notes.
1362 * The "xkey | X:" keys are Dickey's xterm extensions, see (our) manual */
1363 enum n_termcap_query{
1364 # ifdef HAVE_COLOUR
1365 n_TERMCAP_QUERY_colors, /* colors/Co, NUMERIC | max_colors */
1366 # endif
1368 /* --mk-tcap-map--: only KEY_BINDINGS follow. DON'T CHANGE THIS LINE! */
1369 /* Update the `bind' manual on change! */
1370 # ifdef HAVE_KEY_BINDINGS
1371 n_TERMCAP_QUERY_key_backspace, /* kbs/kb, STRING */
1372 n_TERMCAP_QUERY_key_dc, /* kdch1/kD, STRING | delete-character */
1373 n_TERMCAP_QUERY_key_sdc, /* kDC / *4, STRING | ..shifted */
1374 n_TERMCAP_QUERY_key_eol, /* kel/kE, STRING | clear-to-end-of-line */
1375 n_TERMCAP_QUERY_key_exit, /* kext/@9, STRING */
1376 n_TERMCAP_QUERY_key_ic, /* kich1/kI, STRING | insert character */
1377 n_TERMCAP_QUERY_key_sic, /* kIC/#3, STRING | ..shifted */
1378 n_TERMCAP_QUERY_key_home, /* khome/kh, STRING */
1379 n_TERMCAP_QUERY_key_shome, /* kHOM/#2, STRING | ..shifted */
1380 n_TERMCAP_QUERY_key_end, /* kend/@7, STRING */
1381 n_TERMCAP_QUERY_key_send, /* kEND / *7, STRING | ..shifted */
1382 n_TERMCAP_QUERY_key_npage, /* knp/kN, STRING */
1383 n_TERMCAP_QUERY_key_ppage, /* kpp/kP, STRING */
1384 n_TERMCAP_QUERY_key_left, /* kcub1/kl, STRING */
1385 n_TERMCAP_QUERY_key_sleft, /* kLFT/#4, STRING | ..shifted */
1386 n_TERMCAP_QUERY_xkey_aleft, /* kLFT3/-, STRING | X: Alt+left */
1387 n_TERMCAP_QUERY_xkey_cleft, /* kLFT5/-, STRING | X: Control+left */
1388 n_TERMCAP_QUERY_key_right, /* kcuf1/kr, STRING */
1389 n_TERMCAP_QUERY_key_sright, /* kRIT/%i, STRING | ..shifted */
1390 n_TERMCAP_QUERY_xkey_aright, /* kRIT3/-, STRING | X: Alt+right */
1391 n_TERMCAP_QUERY_xkey_cright, /* kRIT5/-, STRING | X: Control+right */
1392 n_TERMCAP_QUERY_key_down, /* kcud1/kd, STRING */
1393 n_TERMCAP_QUERY_xkey_sdown, /* kDN/-, STRING | ..shifted */
1394 n_TERMCAP_QUERY_xkey_adown, /* kDN3/-, STRING | X: Alt+down */
1395 n_TERMCAP_QUERY_xkey_cdown, /* kDN5/-, STRING | X: Control+down */
1396 n_TERMCAP_QUERY_key_up, /* kcuu1/ku, STRING */
1397 n_TERMCAP_QUERY_xkey_sup, /* kUP/-, STRING | ..shifted */
1398 n_TERMCAP_QUERY_xkey_aup, /* kUP3/-, STRING | X: Alt+up */
1399 n_TERMCAP_QUERY_xkey_cup, /* kUP5/-, STRING | X: Control+up */
1400 n_TERMCAP_QUERY_kf0, /* kf0/k0, STRING */
1401 n_TERMCAP_QUERY_kf1, /* kf1/k1, STRING */
1402 n_TERMCAP_QUERY_kf2, /* kf2/k2, STRING */
1403 n_TERMCAP_QUERY_kf3, /* kf3/k3, STRING */
1404 n_TERMCAP_QUERY_kf4, /* kf4/k4, STRING */
1405 n_TERMCAP_QUERY_kf5, /* kf5/k5, STRING */
1406 n_TERMCAP_QUERY_kf6, /* kf6/k6, STRING */
1407 n_TERMCAP_QUERY_kf7, /* kf7/k7, STRING */
1408 n_TERMCAP_QUERY_kf8, /* kf8/k8, STRING */
1409 n_TERMCAP_QUERY_kf9, /* kf9/k9, STRING */
1410 n_TERMCAP_QUERY_kf10, /* kf10/k;, STRING */
1411 n_TERMCAP_QUERY_kf11, /* kf11/F1, STRING */
1412 n_TERMCAP_QUERY_kf12, /* kf12/F2, STRING */
1413 n_TERMCAP_QUERY_kf13, /* kf13/F3, STRING */
1414 n_TERMCAP_QUERY_kf14, /* kf14/F4, STRING */
1415 n_TERMCAP_QUERY_kf15, /* kf15/F5, STRING */
1416 n_TERMCAP_QUERY_kf16, /* kf16/F6, STRING */
1417 n_TERMCAP_QUERY_kf17, /* kf17/F7, STRING */
1418 n_TERMCAP_QUERY_kf18, /* kf18/F8, STRING */
1419 n_TERMCAP_QUERY_kf19, /* kf19/F9, STRING */
1420 # endif /* HAVE_KEY_BINDINGS */
1422 n__TERMCAP_QUERY_MAX1
1424 #endif /* n_HAVE_TCAP */
1426 enum n_url_flags{
1427 n_URL_TLS_REQUIRED = 1<<0, /* Whether protocol always uses SSL/TLS.. */
1428 n_URL_TLS_OPTIONAL = 1<<1, /* ..may later upgrade to SSL/TLS */
1429 n_URL_TLS_MASK = n_URL_TLS_REQUIRED | n_URL_TLS_OPTIONAL,
1430 n_URL_HAD_USER = 1<<2, /* Whether .url_user was part of the URL */
1431 n_URL_HOST_IS_NAME = 1<<3 /* .url_host not numeric address */
1434 enum n_visual_info_flags{
1435 n_VISUAL_INFO_NONE,
1436 n_VISUAL_INFO_ONE_CHAR = 1<<0, /* Step only one char, then return */
1437 n_VISUAL_INFO_SKIP_ERRORS = 1<<1, /* Treat via replacement, step byte */
1438 n_VISUAL_INFO_WIDTH_QUERY = 1<<2, /* Detect visual character widths */
1440 /* Rest only with HAVE_C90AMEND1, mutual with _ONE_CHAR */
1441 n_VISUAL_INFO_WOUT_CREATE = 1<<8, /* Use/create .vic_woudat */
1442 n_VISUAL_INFO_WOUT_SALLOC = 1<<9, /* ..salloc() it first */
1443 /* Only visuals into .vic_woudat - implies _WIDTH_QUERY */
1444 n_VISUAL_INFO_WOUT_PRINTABLE = 1<<10,
1445 n__VISUAL_INFO_FLAGS = n_VISUAL_INFO_WOUT_CREATE |
1446 n_VISUAL_INFO_WOUT_SALLOC | n_VISUAL_INFO_WOUT_PRINTABLE
1449 enum n_program_option{
1450 n_PO_DEBUG = 1u<<0, /* -d / *debug* */
1451 n_PO_VERB = 1u<<1, /* -v / *verbose* */
1452 n_PO_VERBVERB = 1u<<2, /* .. even more verbosity */
1453 n_PO_EXISTONLY = 1u<<3, /* -e */
1454 n_PO_HEADERSONLY = 1u<<4, /* -H */
1455 n_PO_HEADERLIST = 1u<<5, /* -L */
1456 n_PO_QUICKRUN_MASK = n_PO_EXISTONLY | n_PO_HEADERSONLY | n_PO_HEADERLIST,
1457 n_PO_E_FLAG = 1u<<6, /* -E / *skipemptybody* */
1458 n_PO_F_FLAG = 1u<<7, /* -F */
1459 n_PO_Mm_FLAG = 1u<<8, /* -M or -m (plus n_poption_arg_Mm) */
1460 n_PO_R_FLAG = 1u<<9, /* -R */
1461 n_PO_r_FLAG = 1u<<10, /* -r (plus n_poption_arg_r) */
1462 n_PO_t_FLAG = 1u<<11, /* -t */
1463 n_PO_TILDE_FLAG = 1u<<12, /* -~ */
1464 n_PO_BATCH_FLAG = 1u<<13, /* -# */
1466 /* */
1467 n_PO_MEMDEBUG = 1<<24, /* *memdebug* */
1469 /* Some easy-access shortcuts */
1470 n_PO_D_V = n_PO_DEBUG | n_PO_VERB,
1471 n_PO_D_VV = n_PO_DEBUG | n_PO_VERBVERB,
1472 n_PO_D_V_VV = n_PO_DEBUG | n_PO_VERB | n_PO_VERBVERB
1475 #define n_OBSOLETE(X) \
1476 do{\
1477 if(n_poption & n_PO_D_V_VV)\
1478 n_err("%s: %s\n", _("Obsoletion warning"), X);\
1479 }while(0)
1480 #define n_OBSOLETE2(X,Y) \
1481 do{\
1482 if(n_poption & n_PO_D_V_VV)\
1483 n_err("%s: %s: %s\n", _("Obsoletion warning"), X, Y);\
1484 }while(0)
1486 /* Program state bits which may regulary fluctuate */
1487 enum n_program_state{
1488 n_PS_ROOT = 1u<<30, /* Temporary "bypass any checks" bit */
1489 #define n_PS_ROOT_BLOCK(ACT) \
1490 do{\
1491 bool_t a___reset___ = !(n_pstate & n_PS_ROOT);\
1492 n_pstate |= n_PS_ROOT;\
1493 ACT;\
1494 if(a___reset___)\
1495 n_pstate &= ~n_PS_ROOT;\
1496 }while(0)
1498 /* XXX These are internal to the state machine and do not belong here,
1499 * XXX yet this was the easiest (accessible) approach */
1500 n_PS_ERR_XIT = 1u<<0, /* Unless `ignerr' seen -> n_PSO_XIT */
1501 n_PS_ERR_QUIT = 1u<<1, /* ..ditto: -> n_PSO_QUIT */
1502 n_PS_ERR_EXIT_MASK = n_PS_ERR_XIT | n_PS_ERR_QUIT,
1504 n_PS_SOURCING = 1u<<2, /* During load() or `source' */
1505 n_PS_ROBOT = 1u<<3, /* .. even more robotic */
1506 n_PS_COMPOSE_MODE = 1u<<4, /* State machine recursed */
1507 n_PS_COMPOSE_FORKHOOK = 1u<<5, /* A hook running in a subprocess */
1509 n_PS_HOOK_NEWMAIL = 1u<<7,
1510 n_PS_HOOK = 1u<<8,
1511 n_PS_HOOK_MASK = n_PS_HOOK_NEWMAIL | n_PS_HOOK,
1513 n_PS_EDIT = 1u<<9, /* Current mailbox no "system mailbox" */
1514 n_PS_SETFILE_OPENED = 1u<<10, /* (hack) setfile() opened a new box */
1515 n_PS_SAW_COMMAND = 1u<<11, /* ..after mailbox switch */
1516 n_PS_DID_PRINT_DOT = 1u<<12, /* Current message has been printed */
1518 n_PS_SIGWINCH_PEND = 1u<<13, /* Need update of $COLUMNS/$LINES */
1519 n_PS_PSTATE_PENDMASK = n_PS_SIGWINCH_PEND, /* pstate housekeeping needed */
1521 n_PS_ARGLIST_MASK = n_BITENUM_MASK(14, 16),
1522 n_PS_ARGMOD_VPUT = 1u<<16, /* "vput" modifier TODO struct CmdCtx */
1523 n_PS_MSGLIST_GABBY = 1u<<14, /* getmsglist() saw something gabby */
1524 n_PS_MSGLIST_DIRECT = 1u<<15, /* A msg was directly chosen by number */
1525 /* TODO HACK: until v15 PS_MSGLIST_SAW_NO is an indication whether an entry
1526 * TODO may be placed in the history or not (grep this, see commands()),
1527 * TODO so avoid reusing this bit */
1528 n_PS_WYSHLIST_SAW_CONTROL = 1u<<15, /* ..saw C0+ control characters */
1530 n_PS_EXPAND_MULTIRESULT = 1u<<17, /* Last fexpand() with MULTIOK had .. */
1531 n_PS_ERRORS_PROMPT = 1u<<18, /* New error to be reported in prompt */
1533 /* Bad hacks */
1534 n_PS_HEADER_NEEDED_MIME = 1u<<19, /* mime_write_tohdr() not ASCII clean */
1535 n_PS_READLINE_NL = 1u<<20 /* readline_input()+ saw a \n */
1538 /* Various states set once, and first time messages or initializers */
1539 enum n_program_state_once{
1540 /* Exit request pending (quick) */
1541 n_PSO_XIT = 1u<<0,
1542 n_PSO_QUIT = 1u<<1,
1543 n_PSO_EXIT_MASK = n_PSO_XIT | n_PSO_QUIT,
1545 /* Pre _STARTED */
1546 n_PSO_SENDMODE = 1u<<2,
1547 n_PSO_INTERACTIVE = 1u<<3,
1548 n_PSO_TTYIN = 1u<<4,
1549 n_PSO_TTYOUT = 1u<<5, /* TODO should be TTYERR! */
1551 n_PSO_UNICODE = 1u<<8,
1552 n_PSO_ENC_MBSTATE = 1u<<9,
1554 /* main.c startup code passed, we are functional! */
1555 n_PSO_STARTED = 1u<<15,
1557 /* (Likely) Post _STARTED */
1558 n_PSO_ATTACH_QUOTE_NOTED = 1u<<16,
1559 n_PSO_ERRORS_NOTED = 1u<<17,
1560 n_PSO_TERMCAP_DISABLE = 1u<<18,
1561 n_PSO_TERMCAP_CA_MODE = 1u<<19,
1562 n_PSO_LINE_EDITOR_INIT = 1u<<20,
1564 /* A subtile hack which works in conjunction with n_OPT_t_FLAG so as to
1565 * allow to have multiple states regarding the related header setup */
1566 n_PSO_t_FLAG = 1u<<30
1569 /* A large enum with all the boolean and value options a.k.a their keys.
1570 * Only the constant keys are in here, to be looked up via ok_[bv]look(),
1571 * ok_[bv]set() and ok_[bv]clear().
1572 * Notes:
1573 * - see the comments in accmacvar.c before changing *anything* in here!
1574 * - virt= implies rdonly,nodel
1575 * - import= implies env
1576 * - defval= implies notempty
1577 * - num and posnum are mutual exclusive
1578 * - most default VAL_ues come from in from build system via ./make.rc
1579 * (Keep in SYNC: ./nail.h:okeys, ./nail.rc, ./nail.1:"Initial settings") */
1580 enum okeys {
1581 /* This is used for all macro(-local) variables etc., i.e.,
1582 * [*@#]|[1-9][0-9]*, in order to have something with correct properties.
1583 * It is also used for the ${^.+} multiplexer */
1584 ok_v___special_param, /* {nolopts=1,rdonly=1,nodel=1} */
1585 /*__qm/__em aka ?/! should be num=1 but that more expensive than what now */
1586 ok_v___qm, /* {name=?,nolopts=1,rdonly=1,nodel=1} */
1587 ok_v___em, /* {name=!,nolopts=1,rdonly=1,nodel=1} */
1589 ok_v_account, /* {nolopts=1,rdonly=1,nodel=1} */
1590 ok_b_add_file_recipients,
1591 ok_v_agent_shell_lookup,
1592 ok_b_allnet,
1593 ok_v_alternates, /* {nolopts=1,rdonly=1,nodel=1} */
1594 ok_b_append,
1595 ok_b_ask,
1596 ok_b_askatend,
1597 ok_b_askattach,
1598 ok_b_askbcc,
1599 ok_b_askcc,
1600 ok_b_asksign,
1601 ok_b_asksub, /* {i3val=TRU1} */
1602 ok_v_attrlist,
1603 ok_v_autobcc,
1604 ok_v_autocc,
1605 ok_b_autocollapse,
1606 ok_b_autoprint,
1607 ok_b_autothread,
1608 ok_v_autosort,
1610 ok_b_bang,
1611 ok_b_batch_exit_on_error,
1612 ok_v_bind_timeout, /* {notempty=1,posnum=1} */
1613 ok_b_bsdannounce,
1614 ok_b_bsdcompat,
1615 ok_b_bsdflags,
1616 ok_b_bsdheadline,
1617 ok_b_bsdmsgs,
1618 ok_b_bsdorder,
1620 ok_v_COLUMNS, /* {notempty=1,posnum=1,env=1} */
1621 ok_v_charset_7bit, /* {lower=1,defval=CHARSET_7BIT} */
1622 /* But unused without HAVE_ICONV, we use ok_vlook(CHARSET_8BIT_OKEY)! */
1623 ok_v_charset_8bit, /* {lower=1,defval=CHARSET_8BIT} */
1624 ok_v_charset_unknown_8bit, /* {lower=1} */
1625 ok_v_cmd,
1626 ok_b_colour_disable,
1627 ok_b_colour_pager,
1628 ok_v_crt, /* {posnum=1} */
1629 ok_v_customhdr, /* {nocntrls=1} */
1631 /* TODO likely temporary hook data, v15 drop */
1632 ok_v_compose_from, /* {rdonly=1} */
1633 ok_v_compose_sender, /* {rdonly=1} */
1634 ok_v_compose_to, /* {rdonly=1} */
1635 ok_v_compose_cc, /* {rdonly=1} */
1636 ok_v_compose_bcc, /* {rdonly=1} */
1637 ok_v_compose_subject, /* {rdonly=1} */
1639 ok_v_DEAD, /* {notempty=1,env=1,defval=VAL_DEAD} */
1640 ok_v_datefield, /* {i3val="%Y-%m-%d %H:%M"} */
1641 ok_v_datefield_markout_older, /* {i3val="%Y-%m-%d"} */
1642 ok_b_debug, /* {vip=1} */
1643 ok_b_disposition_notification_send,
1644 ok_b_dot,
1645 ok_b_dotlock_ignore_error,
1647 ok_v_EDITOR, /* {env=1,defval=VAL_EDITOR} */
1648 ok_b_editalong,
1649 ok_b_editheaders,
1650 ok_b_emptystart,
1651 ok_v_encoding,
1652 ok_b_errexit,
1653 ok_v_escape,
1654 ok_v_expandaddr,
1655 ok_v_expandargv,
1657 ok_v_features, /* {virt=VAL_FEATURES} */
1658 ok_b_flipr,
1659 ok_v_folder, /* {vip=1} */
1660 ok_v_folder_resolved, /* {rdonly=1,nodel=1} */
1661 ok_v_folder_hook,
1662 ok_b_followup_to,
1663 ok_v_followup_to_honour,
1664 ok_b_forward_as_attachment,
1665 ok_v_from,
1666 ok_b_fullnames,
1667 ok_v_fwdheading,
1669 ok_v_HOME, /* {vip=1,nodel=1,notempty=1,import=1} */
1670 ok_b_header, /* {i3val=TRU1} */
1671 ok_v_headline,
1672 ok_v_headline_bidi,
1673 ok_v_history_file,
1674 ok_b_history_gabby,
1675 ok_b_history_gabby_persist,
1676 ok_v_history_size, /* {notempty=1,posnum=1} */
1677 ok_b_hold,
1678 ok_v_hostname,
1680 ok_b_idna_disable,
1681 ok_b_ignore,
1682 ok_b_ignoreeof,
1683 ok_v_inbox,
1684 ok_v_indentprefix,
1686 ok_b_keep,
1687 ok_b_keep_content_length,
1688 ok_b_keepsave,
1690 ok_v_LINES, /* {notempty=1,posnum=1,env=1} */
1691 ok_v_LISTER, /* {env=1,defval=VAL_LISTER} */
1692 ok_v_LOGNAME, /* {rdonly=1,import=1} */
1693 ok_b_line_editor_disable,
1694 ok_b_line_editor_no_defaults,
1695 ok_v_log_prefix, /* {nodel=1,i3val=VAL_UAGENT ": "} */
1697 ok_v_MAIL, /* {env=1} */
1698 ok_v_MAILRC, /* {import=1,defval=VAL_MAILRC} */
1699 ok_b_MAILX_NO_SYSTEM_RC, /* {name=MAILX_NO_SYSTEM_RC,import=1} */
1700 ok_v_MBOX, /* {env=1,defval=VAL_MBOX} */
1701 ok_v_mailbox_resolved, /* {nolopts=1,rdonly=1,nodel=1} */
1702 ok_v_mailbox_display, /* {nolopts=1,rdonly=1,nodel=1} */
1703 ok_v_mailx_extra_rc,
1704 ok_b_markanswered,
1705 ok_b_mbox_rfc4155,
1706 ok_b_memdebug, /* {vip=1} */
1707 ok_b_message_id_disable,
1708 ok_v_message_inject_head,
1709 ok_v_message_inject_tail,
1710 ok_b_metoo,
1711 ok_b_mime_allow_text_controls,
1712 ok_b_mime_alternative_favour_rich,
1713 ok_v_mime_counter_evidence, /* {posnum=1} */
1714 ok_v_mimetypes_load_control,
1715 /* TODO: v15 (not yet due to <-> sendmail): {defval=VAL_MTA} */
1716 ok_v_mta,
1717 ok_v_mta_arguments,
1718 ok_b_mta_no_default_arguments,
1719 /* TODO v15: (not yet due to <-> sendmail-progname {defval=VAL_MTA_ARGV0} */
1720 ok_v_mta_argv0,
1722 ok_v_NAIL_EXTRA_RC, /* {name=NAIL_EXTRA_RC} */
1723 ok_b_NAIL_NO_SYSTEM_RC, /* {name=NAIL_NO_SYSTEM_RC,import=1} */
1724 ok_v_NAIL_HEAD, /* {name=NAIL_HEAD} */
1725 ok_v_NAIL_HISTFILE, /* {name=NAIL_HISTFILE} */
1726 ok_v_NAIL_HISTSIZE, /* {name=NAIL_HISTSIZE,notempty=1,num=1} */
1727 ok_v_NAIL_TAIL, /* {name=NAIL_TAIL} */
1728 ok_v_NETRC, /* {env=1,defval=VAL_NETRC} */
1729 ok_b_netrc_lookup,
1730 ok_v_netrc_pipe,
1731 ok_v_newfolders,
1732 ok_v_newmail,
1734 ok_v_on_compose_enter, /* {notempty=1} */
1735 ok_v_on_compose_leave, /* {notempty=1} */
1736 ok_v_on_compose_splice, /* {notempty=1} */
1737 ok_v_on_compose_splice_shell, /* {notempty=1} */
1738 ok_b_outfolder,
1740 ok_v_PAGER, /* {env=1,defval=VAL_PAGER} */
1741 ok_v_PATH, /* {nodel=1,import=1} */
1742 ok_b_POSIXLY_CORRECT, /* {vip=1,import=1,name=POSIXLY_CORRECT} */
1743 ok_b_page,
1744 ok_v_password,
1745 ok_b_piperaw,
1746 ok_v_pop3_auth,
1747 ok_b_pop3_bulk_load,
1748 ok_v_pop3_keepalive, /* {notempty=1,posnum=1} */
1749 ok_b_pop3_no_apop,
1750 ok_b_pop3_use_starttls,
1751 ok_b_posix, /* {vip=1} */
1752 ok_b_print_alternatives,
1753 ok_v_prompt, /* {i3val="? "} */
1754 ok_v_prompt2, /* {i3val=".. "} */
1756 ok_b_quiet,
1757 ok_v_quote,
1758 ok_b_quote_as_attachment,
1759 ok_v_quote_fold,
1761 ok_b_r_option_implicit,
1762 ok_b_recipients_in_cc,
1763 ok_v_record,
1764 ok_b_record_resent,
1765 ok_b_reply_in_same_charset,
1766 ok_v_reply_strings,
1767 ok_v_replyto,
1768 ok_v_reply_to_honour,
1769 ok_b_rfc822_body_from_, /* {name=rfc822-body-from_} */
1771 ok_v_SHELL, /* {import=1,defval=VAL_SHELL} */
1772 ok_b_SYSV3, /* {env=1} */
1773 ok_b_save, /* {i3val=TRU1} */
1774 ok_v_screen, /* {notempty=1,posnum=1} */
1775 ok_b_searchheaders,
1776 ok_v_sendcharsets, /* {lower=1} */
1777 ok_b_sendcharsets_else_ttycharset,
1778 ok_v_sender,
1779 ok_v_sendmail,
1780 ok_v_sendmail_arguments,
1781 ok_b_sendmail_no_default_arguments,
1782 ok_v_sendmail_progname,
1783 ok_b_sendwait,
1784 ok_b_showlast,
1785 ok_b_showname,
1786 ok_b_showto,
1787 ok_v_Sign,
1788 ok_v_sign,
1789 ok_v_signature,
1790 ok_b_skipemptybody, /* {vip=1} */
1791 ok_v_smime_ca_dir,
1792 ok_v_smime_ca_file,
1793 ok_v_smime_ca_flags,
1794 ok_b_smime_ca_no_defaults,
1795 ok_v_smime_cipher,
1796 ok_v_smime_crl_dir,
1797 ok_v_smime_crl_file,
1798 /* smime-encrypt-USER@HOST */
1799 ok_b_smime_force_encryption,
1800 ok_b_smime_no_default_ca,
1801 ok_b_smime_sign,
1802 ok_v_smime_sign_cert,
1803 ok_v_smime_sign_include_certs,
1804 ok_v_smime_sign_message_digest,
1805 ok_v_smtp,
1806 ok_v_smtp_auth,
1807 ok_v_smtp_auth_password,
1808 ok_v_smtp_auth_user,
1809 ok_v_smtp_hostname,
1810 ok_b_smtp_use_starttls,
1811 ok_v_SOURCE_DATE_EPOCH,/*{name=SOURCE_DATE_EPOCH,env=1,notempty=1,posnum=1}*/
1812 ok_v_spam_interface,
1813 ok_v_spam_maxsize, /* {notempty=1,posnum=1} */
1814 ok_v_spamc_command,
1815 ok_v_spamc_arguments,
1816 ok_v_spamc_user,
1817 ok_v_spamd_socket,
1818 ok_v_spamd_user,
1819 ok_v_spamfilter_ham,
1820 ok_v_spamfilter_noham,
1821 ok_v_spamfilter_nospam,
1822 ok_v_spamfilter_rate,
1823 ok_v_spamfilter_rate_scanscore,
1824 ok_v_spamfilter_spam,
1825 ok_v_ssl_ca_dir,
1826 ok_v_ssl_ca_file,
1827 ok_v_ssl_ca_flags,
1828 ok_b_ssl_ca_no_defaults,
1829 ok_v_ssl_cert,
1830 ok_v_ssl_cipher_list,
1831 ok_v_ssl_config_file,
1832 ok_v_ssl_crl_dir,
1833 ok_v_ssl_crl_file,
1834 ok_v_ssl_key,
1835 ok_v_ssl_method,
1836 ok_b_ssl_no_default_ca,
1837 ok_v_ssl_protocol,
1838 ok_v_ssl_rand_egd,
1839 ok_v_ssl_rand_file,
1840 ok_v_ssl_verify,
1841 ok_v_stealthmua,
1843 ok_v_TERM, /* {env=1} */
1844 ok_v_TMPDIR, /* {import=1,vip=1,notempty=1,defval=VAL_TMPDIR} */
1845 ok_v_termcap,
1846 ok_b_termcap_disable,
1847 ok_v_toplines, /* {notempty=1,num=1,defval="5"} */
1848 ok_b_topsqueeze,
1849 ok_v_ttycharset, /* {lower=1,defval=CHARSET_8BIT} */
1850 ok_b_typescript_mode, /* {vip=1} */
1852 ok_v_USER, /* {rdonly=1,import=1} */
1853 ok_v_umask, /* {vip=1,nodel=1,posnum=1,i3val="0077"} */
1854 ok_v_user,
1856 ok_v_VISUAL, /* {env=1,defval=VAL_VISUAL} */
1857 ok_b_v15_compat,
1858 ok_b_verbose, /* {vip=1} */
1859 ok_v_version, /* {virt=n_VERSION} */
1860 ok_v_version_major, /* {virt=n_VERSION_MAJOR} */
1861 ok_v_version_minor, /* {virt=n_VERSION_MINOR} */
1862 ok_v_version_update, /* {virt=n_VERSION_UPDATE} */
1864 ok_b_writebackedited
1867 /* Locale-independent character classes */
1868 enum {
1869 C_CNTRL = 1<<0,
1870 C_BLANK = 1<<1,
1871 C_WHITE = 1<<2,
1872 C_SPACE = 1<<3,
1873 C_PUNCT = 1<<4,
1874 C_OCTAL = 1<<5,
1875 C_DIGIT = 1<<6,
1876 C_UPPER = 1<<7,
1877 C_LOWER = 1<<8
1880 struct str {
1881 char *s; /* the string's content */
1882 size_t l; /* the stings's length */
1885 struct n_string{
1886 char *s_dat; /*@ May contain NULs, not automatically terminated */
1887 ui32_t s_len; /*@ gth of string */
1888 ui32_t s_auto : 1; /* Stored in auto-reclaimed storage? */
1889 ui32_t s_size : 31; /* of .s_dat, -1 */
1892 struct n_strlist{
1893 struct n_strlist *sl_next;
1894 size_t sl_len;
1895 char sl_dat[n_VFIELD_SIZE(0)];
1897 #define n_STRLIST_MALLOC(SZ) /* XXX -> nailfuns.h (and pimp interface) */\
1898 smalloc(n_VSTRUCT_SIZEOF(struct n_strlist, sl_dat) + (SZ) +1)
1900 struct bidi_info {
1901 struct str bi_start; /* Start of (possibly) bidirectional text */
1902 struct str bi_end; /* End of ... */
1903 size_t bi_pad; /* No of visual columns to reserve for BIDI pad */
1906 struct n_cmd_arg_desc{
1907 char cad_name[12]; /* Name of command */
1908 ui32_t cad_no; /* Number of entries in cad_ent_flags */
1909 /* [enum n_cmd_arg_desc_flags,arg-dep] */
1910 ui32_t cad_ent_flags[n_VFIELD_SIZE(0)][2];
1912 /* ISO C(99) doesn't allow initialization of "flex array" */
1913 #define n_CMD_ARG_DESC_SUBCLASS_DEF(CMD,NO,VAR) \
1914 struct n_cmd_arg_desc_ ## CMD {\
1915 char cad_name[12];\
1916 ui32_t cad_no;\
1917 ui32_t cad_ent_flags[NO][2];\
1918 } const VAR = { #CMD, NO,
1919 #define n_CMD_ARG_DESC_SUBCLASS_DEF_END }
1920 #define n_CMD_ARG_DESC_SUBCLASS_CAST(P) ((struct n_cmd_arg_desc const*)P)
1922 struct n_cmd_arg_ctx{
1923 struct n_cmd_arg_desc const *cac_desc;
1924 char const *cac_indat; /* Input that shall be parsed */
1925 size_t cac_inlen; /* Input length (UIZ_MAX: do a strlen()) */
1926 size_t cac_no; /* Output: number of parsed arguments */
1927 struct n_cmd_arg *cac_arg; /* Output: parsed arguments */
1930 struct n_cmd_arg{/* TODO incomplete, misses getmsglist() */
1931 struct n_cmd_arg *ca_next;
1932 char const *ca_indat; /* Pointer into n_cmd_arg_ctx.cac_indat */
1933 size_t ca_inlen; /* of .ca_indat of this arg (not terminated) */
1934 ui32_t ca_ent_flags[2]; /* Copy of n_cmd_arg_desc.cad_ent_flags[X] */
1935 ui32_t ca_arg_flags; /* [Output: _WYSH: copy of parse result flags] */
1936 ui8_t ca__dummy[4];
1937 union{
1938 struct str ca_str; /* _STRING, _WYSH */
1939 } ca_arg; /* Output: parsed result */
1942 #ifdef HAVE_COLOUR
1943 struct n_colour_env{
1944 struct n_colour_env *ce_last;
1945 bool_t ce_enabled; /* Colour enabled on this level */
1946 ui8_t ce_ctx; /* enum n_colour_ctx */
1947 ui8_t ce_ispipe; /* .ce_outfp known to be a pipe */
1948 ui8_t ce__pad[5];
1949 FILE *ce_outfp;
1950 struct a_colour_map *ce_current; /* Active colour or NULL */
1953 struct n_colour_pen;
1954 #endif
1956 struct url {
1957 char const *url_input; /* Input as given (really) */
1958 ui32_t url_flags;
1959 ui8_t url_cproto; /* enum cproto as given */
1960 ui8_t url__pad1[1];
1961 ui16_t url_portno; /* atoi .url_port or default, host endian */
1962 char const *url_port; /* Port (if given) or NULL */
1963 char url_proto[14]; /* Communication protocol as 'xy\0//' */
1964 ui8_t url_proto_len; /* Length of .url_proto ('\0' index) */
1965 ui8_t url_proto_xlen; /* .. if '\0' is replaced with ':' */
1966 struct str url_user; /* User, exactly as given / looked up */
1967 struct str url_user_enc; /* User, urlxenc()oded */
1968 struct str url_pass; /* Pass (urlxdec()oded) or NULL */
1969 /* TODO we don't know whether .url_host is a name or an address. Us
1970 * TODO Net::IPAddress::fromString() to check that, then set
1971 * TODO n_URL_HOST_IS_NAME solely based on THAT! Until then,
1972 * TODO n_URL_HOST_IS_NAME ONLY set if n_URL_TLS_MASK and HAVE_GETADDRINFO */
1973 struct str url_host; /* Service hostname TODO we don't know */
1974 struct str url_path; /* Path suffix or NULL */
1975 /* TODO: url_get_component(url *, enum COMPONENT, str *store) */
1976 struct str url_h_p; /* .url_host[:.url_port] */
1977 /* .url_user@.url_host
1978 * Note: for CPROTO_SMTP this may resolve HOST via *smtp-hostname* (->
1979 * *hostname*)! (And may later be overwritten according to *from*!) */
1980 struct str url_u_h;
1981 struct str url_u_h_p; /* .url_user@.url_host[:.url_port] */
1982 struct str url_eu_h_p; /* .url_user_enc@.url_host[:.url_port] */
1983 char const *url_p_u_h_p; /* .url_proto://.url_u_h_p */
1984 char const *url_p_eu_h_p; /* .url_proto://.url_eu_h_p */
1985 char const *url_p_eu_h_p_p; /* .url_proto://.url_eu_h_p[/.url_path] */
1988 struct ccred {
1989 enum cproto cc_cproto; /* Communication protocol */
1990 enum authtype cc_authtype; /* Desired authentication */
1991 char const *cc_auth; /* Authentication type as string */
1992 struct str cc_user; /* User (urlxdec()oded) or NULL */
1993 struct str cc_pass; /* Password (urlxdec()oded) or NULL */
1996 #ifdef HAVE_DOTLOCK
1997 struct n_dotlock_info{
1998 char const *di_file_name; /* Mailbox to lock */
1999 char const *di_lock_name; /* .di_file_name + .lock */
2000 char const *di_hostname; /* ..filled in parent (due resolver delays) */
2001 char const *di_randstr; /* ..ditto, random string */
2002 size_t di_pollmsecs; /* Delay in between locking attempts */
2003 struct stat *di_stb;
2005 #endif
2007 struct n_go_data_ctx{
2008 /* The memory pool may be inherited from outer context, so we
2009 * .gdc_mempool may be NE .gdc__mempool_buf */
2010 void *gdc_mempool;
2011 void *gdc_ifcond; /* Saved state of conditional stack */
2012 #ifdef HAVE_COLOUR
2013 struct n_colour_env *gdc_colour;
2014 bool_t gdc_colour_active;
2015 ui8_t gdc__colour_pad[7];
2016 # define n_COLOUR_IS_ACTIVE() \
2017 (/*n_go_data->gc_data.gdc_colour != NULL &&*/\
2018 /*n_go_data->gc_data.gdc_colour->ce_enabled*/ n_go_data->gdc_colour_active)
2019 #endif
2020 char gdc__mempool_buf[n_MEMORY_POOL_TYPE_SIZEOF];
2022 n_MCTA(n_MEMORY_POOL_TYPE_SIZEOF % sizeof(void*) == 0,
2023 "Inacceptible size of n_go_data_ctx.gdc_mempool")
2025 struct mime_handler {
2026 enum mime_handler_flags mh_flags;
2027 struct str mh_msg; /* Message describing this command */
2028 /* XXX union{} the following? */
2029 char const *mh_shell_cmd; /* For MIME_HDL_CMD */
2030 int (*mh_ptf)(void); /* PTF main() for MIME_HDL_PTF */
2033 struct quoteflt {
2034 FILE *qf_os; /* Output stream */
2035 char const *qf_pfix;
2036 ui32_t qf_pfix_len; /* Length of prefix: 0: bypass */
2037 ui32_t qf_qfold_min; /* Simple way: wrote prefix? */
2038 /* TODO quoteflt.qf_nl_last is a hack that i have introduced so that we
2039 * TODO finally can gracefully place a newline last in the visual display.
2040 * TODO I.e., for cases where quoteflt shouldn't be used at all ;} */
2041 bool_t qf_nl_last; /* Last thing written/seen was NL */
2042 #ifndef HAVE_QUOTE_FOLD
2043 ui8_t __dummy[7];
2044 #else
2045 ui8_t __dummy[1];
2046 ui8_t qf_state; /* *quote-fold* state machine */
2047 bool_t qf_brk_isws; /* Breakpoint is at WS */
2048 ui32_t qf_qfold_max; /* Otherwise: line lengths */
2049 ui32_t qf_wscnt; /* Whitespace count */
2050 ui32_t qf_brkl; /* Breakpoint */
2051 ui32_t qf_brkw; /* Visual width, breakpoint */
2052 ui32_t qf_datw; /* Current visual output line width */
2053 struct str qf_dat; /* Current visual output line */
2054 struct str qf_currq; /* Current quote, compressed */
2055 mbstate_t qf_mbps[2];
2056 #endif
2059 #ifdef HAVE_FILTER_HTML_TAGSOUP
2060 struct htmlflt {
2061 FILE *hf_os; /* Output stream */
2062 ui32_t hf_flags;
2063 ui32_t hf_lmax; /* Maximum byte +1 in .hf_line/4 */
2064 ui32_t hf_len; /* Current bytes in .hf_line */
2065 ui32_t hf_last_ws; /* Last whitespace on line (fold purposes) */
2066 ui32_t hf_mboff; /* Last offset for "mbtowc" */
2067 ui32_t hf_mbwidth; /* We count characters not bytes if possible */
2068 char *hf_line; /* Output line buffer - MUST be last field! */
2069 si32_t hf_href_dist; /* Count of lines since last HREF flush */
2070 ui32_t hf_href_no; /* HREF sequence number */
2071 struct htmlflt_href *hf_hrefs;
2072 struct htmlflt_tag const *hf_ign_tag; /* Tag that will end ignore mode */
2073 char *hf_curr; /* Current cursor into .hf_bdat */
2074 char *hf_bmax; /* Maximum byte in .hf_bdat +1 */
2075 char *hf_bdat; /* (Temporary) Tag content data storage */
2077 #endif
2079 struct search_expr {
2080 char const *ss_where; /* ..to search for the expr. (not always used) */
2081 char const *ss_sexpr; /* String search expr.; NULL: use .ss_regex */
2082 #ifdef HAVE_REGEX
2083 regex_t ss_regex;
2084 #endif
2087 /* This is somewhat temporary for pre v15 */
2088 struct n_sigman{
2089 ui32_t sm_flags; /* enum n_sigman_flags */
2090 int sm_signo;
2091 struct n_sigman *sm_outer;
2092 sighandler_type sm_ohup;
2093 sighandler_type sm_oint;
2094 sighandler_type sm_oquit;
2095 sighandler_type sm_oterm;
2096 sighandler_type sm_opipe;
2097 sigjmp_buf sm_jump;
2100 struct termios_state {
2101 struct termios ts_tios;
2102 char *ts_linebuf;
2103 size_t ts_linesize;
2104 bool_t ts_needs_reset;
2107 #define termios_state_reset() \
2108 do {\
2109 if (termios_state.ts_needs_reset) {\
2110 tcsetattr(STDIN_FILENO, TCSADRAIN, &termios_state.ts_tios);\
2111 termios_state.ts_needs_reset = FAL0;\
2113 } while (0)
2115 #ifdef n_HAVE_TCAP
2116 struct n_termcap_value{
2117 enum n_termcap_captype tv_captype;
2118 ui8_t tv__dummy[4];
2119 union n_termcap_value_data{
2120 bool_t tvd_bool;
2121 ui32_t tvd_numeric;
2122 char const *tvd_string;
2123 } tv_data;
2125 #endif
2127 struct n_visual_info_ctx{
2128 char const *vic_indat; /*I Input data */
2129 size_t vic_inlen; /*I If UIZ_MAX, strlen(.vic_indat) */
2130 char const *vic_oudat; /*O remains */
2131 size_t vic_oulen;
2132 size_t vic_chars_seen; /*O number of characters processed */
2133 size_t vic_bytes_seen; /*O number of bytes passed */
2134 size_t vic_vi_width; /*[O] visual width of the entire range */
2135 wc_t *vic_woudat; /*[O] if so requested */
2136 size_t vic_woulen; /*[O] entries in .vic_woudat, if used */
2137 wc_t vic_waccu; /*O The last wchar_t/char processed (if any) */
2138 enum n_visual_info_flags vic_flags; /*O Copy of parse flags */
2139 /* TODO bidi */
2140 #ifdef HAVE_C90AMEND1
2141 mbstate_t *vic_mbstate; /*IO .vic_mbs_def used if NULL */
2142 mbstate_t vic_mbs_def;
2143 #endif
2146 struct time_current {
2147 time_t tc_time;
2148 struct tm tc_gm;
2149 struct tm tc_local;
2150 char tc_ctime[32];
2153 struct sock { /* data associated with a socket */
2154 int s_fd; /* file descriptor */
2155 #ifdef HAVE_SSL
2156 int s_use_ssl; /* SSL is used */
2157 # ifdef HAVE_XSSL
2158 void *s_ssl; /* SSL object */
2159 # endif
2160 #endif
2161 char *s_wbuf; /* for buffered writes */
2162 int s_wbufsize; /* allocated size of s_buf */
2163 int s_wbufpos; /* position of first empty data byte */
2164 char *s_rbufptr; /* read pointer to s_rbuf */
2165 int s_rsz; /* size of last read in s_rbuf */
2166 char const *s_desc; /* description of error messages */
2167 void (*s_onclose)(void); /* execute on close */
2168 char s_rbuf[LINESIZE + 1]; /* for buffered reads */
2171 struct sockconn {
2172 struct url sc_url;
2173 struct ccred sc_cred;
2174 struct sock sc_sock;
2177 struct mailbox {
2178 enum {
2179 MB_NONE = 000, /* no reply expected */
2180 MB_COMD = 001, /* command reply expected */
2181 MB_MULT = 002, /* multiline reply expected */
2182 MB_PREAUTH = 004, /* not in authenticated state */
2183 MB_BYE = 010, /* may accept a BYE state */
2184 MB_FROM__WARNED = 1<<4 /* MBOX with invalid from seen & logged */
2185 } mb_active;
2186 FILE *mb_itf; /* temp file with messages, read open */
2187 FILE *mb_otf; /* same, write open */
2188 char *mb_sorted; /* sort method */
2189 enum {
2190 MB_VOID, /* no type (e. g. connection failed) */
2191 MB_FILE, /* local file */
2192 MB_POP3, /* POP3 mailbox */
2193 MB_MAILDIR /* maildir folder */
2194 } mb_type; /* type of mailbox */
2195 enum {
2196 MB_DELE = 01, /* may delete messages in mailbox */
2197 MB_EDIT = 02 /* may edit messages in mailbox */
2198 } mb_perm;
2199 int mb_threaded; /* mailbox has been threaded */
2200 struct sock mb_sock; /* socket structure */
2203 enum needspec {
2204 NEED_UNSPEC, /* unspecified need, don't fetch */
2205 NEED_HEADER, /* need the header of a message */
2206 NEED_BODY /* need header and body of a message */
2209 enum content_info {
2210 CI_NOTHING, /* Nothing downloaded yet */
2211 CI_HAVE_HEADER = 1<<0, /* Header is downloaded */
2212 CI_HAVE_BODY = 1<<1, /* Entire message is downloaded */
2213 CI_MIME_ERRORS = 1<<2, /* Defective MIME structure */
2214 CI_EXPANDED = 1<<3, /* Container part (pk7m) exploded into X */
2215 CI_SIGNED = 1<<4, /* Has a signature.. */
2216 CI_SIGNED_OK = 1<<5, /* ..verified ok.. */
2217 CI_SIGNED_BAD = 1<<6, /* ..verified bad (missing key).. */
2218 CI_ENCRYPTED = 1<<7, /* Is encrypted.. */
2219 CI_ENCRYPTED_OK = 1<<8, /* ..decryption possible/ok.. */
2220 CI_ENCRYPTED_BAD = 1<<9 /* ..not possible/ok */
2223 /* flag bits. Attention: Flags that are used in cache.c may not change */
2224 enum mflag {
2225 MUSED = (1<< 0), /* entry is used, but this bit isn't */
2226 MDELETED = (1<< 1), /* entry has been deleted */
2227 MSAVED = (1<< 2), /* entry has been saved */
2228 MTOUCH = (1<< 3), /* entry has been noticed */
2229 MPRESERVE = (1<< 4), /* keep entry in sys mailbox */
2230 MMARK = (1<< 5), /* message is marked! */
2231 MODIFY = (1<< 6), /* message has been modified */
2232 MNEW = (1<< 7), /* message has never been seen */
2233 MREAD = (1<< 8), /* message has been read sometime. */
2234 MSTATUS = (1<< 9), /* message status has changed */
2235 MBOX = (1<<10), /* Send this to mbox, regardless */
2236 MNOFROM = (1<<11), /* no From line */
2237 MHIDDEN = (1<<12), /* message is hidden to user */
2238 MBOXED = (1<<13), /* message has been sent to mbox */
2239 MNEWEST = (1<<14), /* message is very new (newmail) */
2240 MFLAG = (1<<15), /* message has been flagged recently */
2241 MUNFLAG = (1<<16), /* message has been unflagged */
2242 MFLAGGED = (1<<17), /* message is `flagged' */
2243 MANSWER = (1<<18), /* message has been answered recently */
2244 MUNANSWER = (1<<19), /* message has been unanswered */
2245 MANSWERED = (1<<20), /* message is `answered' */
2246 MDRAFT = (1<<21), /* message has been drafted recently */
2247 MUNDRAFT = (1<<22), /* message has been undrafted */
2248 MDRAFTED = (1<<23), /* message is marked as `draft' */
2249 MOLDMARK = (1<<24), /* messages was marked previously */
2250 MSPAM = (1<<25), /* message is classified as spam */
2251 MSPAMUNSURE = (1<<26) /* 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)
2258 struct mimepart {
2259 enum mflag m_flag;
2260 enum content_info m_content_info;
2261 #ifdef HAVE_SPAM
2262 ui32_t m_spamscore; /* Spam score as int, 24:8 bits */
2263 #endif
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 */
2288 struct message {
2289 enum mflag m_flag; /* flags */
2290 enum content_info m_content_info;
2291 #ifdef HAVE_SPAM
2292 ui32_t m_spamscore; /* Spam score as int, 24:8 bits */
2293 #endif
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 */
2309 char *m_maildir_file; /* original maildir file of msg */
2310 ui32_t m_maildir_hash; /* hash of file name in maildir sub */
2311 int m_collapsed; /* collapsed thread information */
2314 /* Given a file address, determine the block number it represents */
2315 #define mailx_blockof(off) ((int) ((off) / 4096))
2316 #define mailx_offsetof(off) ((int) ((off) % 4096))
2317 #define mailx_positionof(block, offset) ((off_t)(block) * 4096 + (offset))
2319 enum n_cmd_arg_flags{ /* TODO Most of these need to change, in fact in v15
2320 * TODO i rather see the mechanism that is used in c_bind() extended and used
2321 * TODO anywhere, i.e. n_cmd_arg_parse() */
2322 n_CMD_ARG_TYPE_MSGLIST = 0, /* Message list type */
2323 n_CMD_ARG_TYPE_NDMLIST = 1, /* Message list, no defaults */
2324 n_CMD_ARG_TYPE_RAWDAT = 2, /* The plain string in an argv[] */
2325 n_CMD_ARG_TYPE_STRING = 3, /* A pure string TODO obsolete */
2326 n_CMD_ARG_TYPE_WYSH = 4, /* getrawlist(), sh(1) compatible */
2327 n_CMD_ARG_TYPE_RAWLIST = 5, /* getrawlist(), old style TODO obsolete */
2328 n_CMD_ARG_TYPE_WYRA = 6, /* _RAWLIST or _WYSH (with `wysh') TODO obs. */
2329 n_CMD_ARG_TYPE_MASK = 7, /* Mask of the above */
2331 n_CMD_ARG_A = 1u<< 4, /* Needs an active mailbox */
2332 n_CMD_ARG_F = 1u<< 5, /* Is a conditional command */
2333 n_CMD_ARG_G = 1u<< 6, /* Is supposed to produce "gabby" history */
2334 n_CMD_ARG_H = 1u<< 7, /* Never place in `history' */
2335 n_CMD_ARG_I = 1u<< 8, /* Interactive command bit */
2336 n_CMD_ARG_M = 1u<< 9, /* Legal from send mode bit */
2337 n_CMD_ARG_O = 1u<<10, /* n_OBSOLETE()d command */
2338 n_CMD_ARG_P = 1u<<11, /* Autoprint dot after command */
2339 n_CMD_ARG_R = 1u<<12, /* Cannot be called in compose mode recursion */
2340 n_CMD_ARG_S = 1u<<13, /* Cannot be called pre-n_PSO_STARTED (POSIX) */
2341 n_CMD_ARG_T = 1u<<14, /* Is a transparent command */
2342 n_CMD_ARG_V = 1u<<15, /* Supports `vput' prefix (only WYSH/WYRA) */
2343 n_CMD_ARG_W = 1u<<16, /* Invalid when read only bit */
2344 n_CMD_ARG_X = 1u<<17, /* Valid command in n_PS_COMPOSE_FORKHOOK mode */
2345 n_CMD_ARG_EM = 1u<<30 /* If error: n_pstate_err_no (4 $! aka. ok_v___em) */
2348 enum gfield {
2349 GTO = 1<< 0, /* Grab To: line */
2350 GSUBJECT = 1<< 1, /* Likewise, Subject: line */
2351 GCC = 1<< 2, /* And the Cc: line */
2352 GBCC = 1<< 3, /* And also the Bcc: line */
2354 GNL = 1<< 4, /* Print blank line after */
2355 GDEL = 1<< 5, /* Entity removed from list */
2356 GCOMMA = 1<< 6, /* detract() puts in commas */
2357 GUA = 1<< 7, /* User-Agent field */
2358 GMIME = 1<< 8, /* MIME 1.0 fields */
2359 GMSGID = 1<< 9, /* a Message-ID */
2360 GNAMEONLY = 1<<10, /* detract() does NOT use fullnames */
2362 GIDENT = 1<<11, /* From:, Reply-To:, MFT: (user headers) */
2363 GREF = 1<<12, /* References:, In-Reply-To:, (Message-ID:) */
2364 GDATE = 1<<13, /* Date: field */
2365 GFULL = 1<<14, /* Include full names, comments etc. */
2366 GSKIN = 1<<15, /* Skin names */
2367 GEXTRA = 1<<16, /* Extra fields (mostly like GIDENT XXX) */
2368 GFILES = 1<<17, /* Include filename and pipe addresses */
2369 GFULLEXTRA = 1<<18 /* Only with GFULL: GFULL less address */
2371 #define GMASK (GTO | GSUBJECT | GCC | GBCC)
2373 enum header_flags {
2374 HF_NONE = 0,
2375 HF_LIST_REPLY = 1<< 0,
2376 HF_MFT_SENDER = 1<< 1, /* Add ourselves to Mail-Followup-To: */
2377 HF_RECIPIENT_RECORD = 1<<10, /* Save message in file named after rec. */
2378 HF__NEXT_SHIFT = 11
2381 /* Structure used to pass about the current state of a message (header) */
2382 struct n_header_field{
2383 struct n_header_field *hf_next;
2384 ui32_t hf_nl; /* Field-name length */
2385 ui32_t hf_bl; /* Field-body length*/
2386 char hf_dat[n_VFIELD_SIZE(0)];
2389 struct header {
2390 ui32_t h_flags; /* enum header_flags bits */
2391 ui32_t h_dummy;
2392 struct name *h_to; /* Dynamic "To:" string */
2393 char *h_subject; /* Subject string */
2394 struct name *h_cc; /* Carbon copies string */
2395 struct name *h_bcc; /* Blind carbon copies */
2396 struct name *h_ref; /* References (possibly overridden) */
2397 struct attachment *h_attach; /* MIME attachments */
2398 char const *h_charset; /* preferred charset */
2399 struct name *h_from; /* overridden "From:" field */
2400 struct name *h_sender; /* overridden "Sender:" field */
2401 struct name *h_replyto; /* overridden "Reply-To:" field */
2402 struct name *h_message_id; /* overridden "Message-ID:" field */
2403 struct name *h_in_reply_to;/* overridden "In-Reply-To:" field */
2404 struct name *h_mft; /* Mail-Followup-To */
2405 char const *h_list_post; /* Address from List-Post:, for `Lreply' */
2406 struct n_header_field *h_user_headers;
2407 struct n_header_field *h_custom_headers; /* (Cached result) */
2410 /* Handling of namelist nodes used in processing the recipients of mail and
2411 * aliases, inspection of mail-addresses and all that kind of stuff */
2412 enum nameflags {
2413 NAME_NAME_SALLOC = 1<< 0, /* .n_name is doped */
2414 NAME_FULLNAME_SALLOC = 1<< 1, /* .n_fullname is doped */
2415 NAME_SKINNED = 1<< 2, /* Is actually skin()ned */
2416 NAME_IDNA = 1<< 3, /* IDNA was applied */
2418 NAME_ADDRSPEC_CHECKED = 1<< 4, /* Address has been .. and */
2419 NAME_ADDRSPEC_ISFILE = 1<< 5, /* ..is a file path */
2420 NAME_ADDRSPEC_ISPIPE = 1<< 6, /* ..is a command for piping */
2421 NAME_ADDRSPEC_ISFILEORPIPE = NAME_ADDRSPEC_ISFILE | NAME_ADDRSPEC_ISPIPE,
2422 NAME_ADDRSPEC_ISNAME = 1<< 7, /* ..is an alias name */
2423 NAME_ADDRSPEC_ISADDR = 1<< 8, /* ..is a mail network address */
2425 NAME_ADDRSPEC_ERR_EMPTY = 1<< 9, /* An empty string (or NULL) */
2426 NAME_ADDRSPEC_ERR_ATSEQ = 1<<10, /* Weird @ sequence */
2427 NAME_ADDRSPEC_ERR_CHAR = 1<<11, /* Invalid character */
2428 NAME_ADDRSPEC_ERR_IDNA = 1<<12, /* IDNA convertion failed */
2429 NAME_ADDRSPEC_ERR_NAME = 1<<13, /* Alias with invalid content */
2430 NAME_ADDRSPEC_INVALID = NAME_ADDRSPEC_ERR_EMPTY |
2431 NAME_ADDRSPEC_ERR_ATSEQ | NAME_ADDRSPEC_ERR_CHAR |
2432 NAME_ADDRSPEC_ERR_IDNA | NAME_ADDRSPEC_ERR_NAME,
2434 /* Error storage (we must fit in 31-bit) */
2435 _NAME_SHIFTWC = 14,
2436 _NAME_MAXWC = 0x1FFFF,
2437 _NAME_MASKWC = _NAME_MAXWC << _NAME_SHIFTWC
2440 /* In the !_ERR_EMPTY case, the failing character can be queried */
2441 #define NAME_ADDRSPEC_ERR_GETWC(F) \
2442 ((((unsigned int)(F) & _NAME_MASKWC) >> _NAME_SHIFTWC) & _NAME_MAXWC)
2443 #define NAME_ADDRSPEC_ERR_SET(F, E, WC) \
2444 do {\
2445 (F) = ((F) & ~(NAME_ADDRSPEC_INVALID | _NAME_MASKWC)) |\
2446 (E) | (((unsigned int)(WC) & _NAME_MAXWC) << _NAME_SHIFTWC);\
2447 } while (0)
2449 struct name {
2450 struct name *n_flink; /* Forward link in list. */
2451 struct name *n_blink; /* Backward list link */
2452 enum gfield n_type; /* From which list it came */
2453 enum nameflags n_flags; /* enum nameflags */
2454 char *n_name; /* This fella's address */
2455 char *n_fullname; /* Ditto, unless GFULL including comment */
2456 char *n_fullextra; /* GFULL, without address */
2459 struct n_addrguts{
2460 /* Input string as given (maybe replaced with a fixed one!) */
2461 char const *ag_input;
2462 size_t ag_ilen; /* strlen() of input */
2463 size_t ag_iaddr_start; /* Start of *addr-spec* in .ag_input */
2464 size_t ag_iaddr_aend; /* ..and one past its end */
2465 char *ag_skinned; /* Output (alloced if !=.ag_input) */
2466 size_t ag_slen; /* strlen() of .ag_skinned */
2467 size_t ag_sdom_start; /* Start of domain in .ag_skinned, */
2468 enum nameflags ag_n_flags; /* enum nameflags of .ag_skinned */
2471 /* MIME attachments */
2472 enum attach_conv {
2473 AC_DEFAULT, /* _get_lc() -> _iter_*() */
2474 AC_FIX_INCS, /* "charset=".a_input_charset (nocnv) */
2475 AC_TMPFILE /* attachment.a_tmpf is converted */
2478 enum n_attach_error{
2479 n_ATTACH_ERR_NONE,
2480 n_ATTACH_ERR_FILE_OPEN,
2481 n_ATTACH_ERR_ICONV_FAILED,
2482 n_ATTACH_ERR_ICONV_NAVAIL,
2483 n_ATTACH_ERR_OTHER
2486 struct attachment {
2487 struct attachment *a_flink; /* Forward link in list. */
2488 struct attachment *a_blink; /* Backward list link */
2489 char const *a_path_user; /* Path as given (maybe including iconv spec) */
2490 char const *a_path; /* Path as opened */
2491 char const *a_path_bname; /* Basename of path as opened */
2492 char const *a_name; /* File name to be stored (EQ a_path_bname) */
2493 char const *a_content_type; /* content type */
2494 char const *a_content_disposition; /* content disposition */
2495 struct name *a_content_id; /* content id */
2496 char const *a_content_description; /* content description */
2497 char const *a_input_charset; /* Interpretation depends on .a_conv */
2498 char const *a_charset; /* ... */
2499 FILE *a_tmpf; /* If AC_TMPFILE */
2500 enum attach_conv a_conv; /* User chosen conversion */
2501 int a_msgno; /* message number */
2504 struct sendbundle {
2505 struct header *sb_hp;
2506 struct name *sb_to;
2507 FILE *sb_input;
2508 struct str sb_signer; /* USER@HOST for signing+ */
2509 struct url sb_url;
2510 struct ccred sb_ccred;
2513 /* For saving the current directory and later returning */
2514 struct cw {
2515 #ifdef HAVE_FCHDIR
2516 int cw_fd;
2517 #else
2518 char cw_wd[PATH_MAX];
2519 #endif
2523 * Global variable declarations
2525 * These become instantiated in main.c.
2528 #undef VL
2529 #ifdef n_MAIN_SOURCE
2530 # ifndef HAVE_AMALGAMATION
2531 # define VL
2532 # else
2533 # define VL static
2534 # endif
2535 #else
2536 # define VL extern
2537 #endif
2539 #ifndef HAVE_AMALGAMATION
2540 VL char const n_month_names[12 + 1][4];
2541 VL char const n_weekday_names[7 + 1][4];
2543 VL char const n_uagent[sizeof VAL_UAGENT];
2544 VL char const n_error[sizeof n_ERROR];
2545 VL char const n_unirepl[sizeof n_UNIREPL];
2546 VL char const n_empty[1];
2547 VL char const n_0[2];
2548 VL char const n_1[2];
2549 VL char const n_m1[3]; /* -1 */
2550 VL char const n_qm[2]; /* Question-mark ? */
2551 VL char const n_em[2]; /* Exclamation-mark ! */
2552 VL char const n_star[2]; /* Asterisk * */
2553 VL char const n_at[2]; /* Commercial at @ */
2554 VL char const n_ns[2]; /* Number sign # */
2555 VL ui16_t const n_class_char[1 + 0x7F];
2556 #endif
2558 VL FILE *n_stdin;
2559 VL FILE *n_stdout;
2560 VL FILE *n_stderr;
2561 VL FILE *n_tty_fp; /* Our terminal output TODO input channel */
2563 VL ui32_t n_mb_cur_max; /* Value of MB_CUR_MAX */
2564 VL ui32_t n_realscreenheight; /* The real screen height */
2565 VL ui32_t n_scrnwidth; /* Screen width/guess; also n_SCRNWIDTH_LIST */
2566 VL ui32_t n_scrnheight; /* Screen height/guess (for header summary+) */
2568 VL char const *n_progname; /* Our name */
2570 VL gid_t n_group_id; /* getgid() and getuid() */
2571 VL uid_t n_user_id;
2573 VL int n_exit_status; /* Program exit status TODO long term: ex_no */
2574 VL ui32_t n_poption; /* Bits of enum n_program_option */
2575 VL char const *n_poption_arg_Mm; /* Argument for -[Mm] aka n_PO_[Mm]_FLAG */
2576 VL struct name *n_poption_arg_r; /* Argument to -r option */
2577 VL char const **n_smopts; /* MTA options from command line */
2578 VL size_t n_smopts_cnt; /* Entries in n_smopts */
2580 /* The current execution data context */
2581 VL struct n_go_data_ctx *n_go_data;
2582 VL ui32_t n_psonce; /* Bits of enum n_program_state_once */
2583 VL ui32_t n_pstate; /* Bits of enum n_program_state */
2584 /* TODO "cmd_tab.h ARG_EM set"-storage (n_[01..]) as long as we don't have a
2585 * TODO struct CmdCtx where each command has its own ARGC/ARGV, errno and exit
2586 * TODO status and may-place-in-history bit, need to manage a global bypass.. */
2587 VL si32_t n_pstate_err_no; /* What backs $! n_ERR_* TODO ..HACK */
2588 VL si32_t n_pstate_ex_no; /* What backs $? n_EX_* TODO ..HACK ->64-bit */
2589 #define n_err_no errno /* Don't use errno directly, for later XXX */
2591 /* XXX stylish sorting */
2592 VL int msgCount; /* Count of messages read in */
2593 VL struct mailbox mb; /* Current mailbox */
2594 VL char mailname[PATH_MAX]; /* Name of current file TODO URL/object*/
2595 VL char displayname[80 - 40]; /* Prettyfied for display TODO URL/obj*/
2596 VL char prevfile[PATH_MAX]; /* Name of previous file TODO URL/obj */
2597 VL off_t mailsize; /* Size of system mailbox */
2598 VL struct message *dot; /* Pointer to current message */
2599 VL struct message *prevdot; /* Previous current message */
2600 VL struct message *message; /* The actual message structure */
2601 VL struct message *threadroot; /* first threaded message */
2602 VL int *n_msgvec; /* Folder setmsize(), list.c res. store*/
2604 VL struct time_current time_current; /* time(3); send: mail1() XXXcarrier */
2605 VL struct termios_state termios_state; /* getpassword(); see commands().. */
2607 #ifdef HAVE_SSL
2608 VL enum ssl_verify_level ssl_verify_level; /* SSL verification level */
2609 #endif
2611 #ifdef HAVE_ICONV
2612 VL iconv_t iconvd;
2613 #endif
2615 VL volatile int interrupts; /* TODO rid! */
2616 VL sighandler_type dflpipe;
2618 /* TODO temporary storage to overcome which_protocol() mess (for PROTO_FILE) */
2619 VL char const *temporary_protocol_ext;
2622 * Finally, let's include the function prototypes XXX embed
2625 #ifndef n_PRIVSEP_SOURCE
2626 # include "nailfuns.h"
2627 #endif
2629 /* s-it-mode */