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