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