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