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