nail.h

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