collect(), `~:': un"gabby" this command escape
[s-mailx.git] / config.h
blob95cf12c7709658fe3db8a52fea8014c2ed1154e8
1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
2 *@ Some constants etc. for which adjustments may be desired.
3 *@ This is included after all the (system) headers.
5 * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
6 * Copyright (c) 2012 - 2018 Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
7 */
8 /*
9 * Copyright (c) 1980, 1993
10 * The Regents of the University of California. All rights reserved.
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.
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.
36 #ifndef n_CONFIG_H
37 # define n_CONFIG_H
39 #define ACCOUNT_NULL "null" /* Name of "null" account */
40 #define DOTLOCK_TRIES 5 /* Number of open(2) calls for dotlock */
41 #define FILE_LOCK_TRIES 10 /* Maximum tries before n_file_lock() fails */
42 #define FILE_LOCK_MILLIS 200 /* If UIZ_MAX, fall back to that */
43 #define n_ERROR "ERROR" /* Is-error? Also as n_error[] */
44 #define ERRORS_MAX 1000 /* Maximum error ring entries TODO configable*/
45 #define n_ESCAPE "~" /* Default escape for sending (POSIX) */
46 #define FTMP_OPEN_TRIES 10 /* Maximum number of Ftmp() open(2) tries */
47 #define HSHSIZE 23 /* Hash prime TODO make dynamic, obsolete */
48 #define n_IMAP_DELIM "/." /* Directory separator ([0] == replacer, too) */
49 #define n_MAILDIR_SEPARATOR ':' /* Flag separator character */
50 #define n_MAXARGC 512 /* Maximum list of raw strings TODO dyn vector! */
51 #define n_ALIAS_MAXEXP 25 /* Maximum expansion of aliases */
52 #define n_PATH_DEVNULL "/dev/null" /* Note: manual uses /dev/null as such */
53 #define REFERENCES_MAX 20 /* Maximum entries in References: */
54 #define n_SIGSUSPEND_NOT_WAITPID 1 /* Not waitpid(2), but sigsuspend(2) */
55 #define n_UNIREPL "\xEF\xBF\xBD" /* Unicode replacement 0xFFFD in UTF-8 */
56 #define n_VEXPR_REGEX_MAX 16 /* Maximum address. `vexpr' regex(7) matches */
58 /* * */
60 /* Fallback MIME charsets, if *charset-7bit* and *charset-8bit* are not set.
61 * Note: must be lowercase!
62 * (Keep in SYNC: ./nail.1:"Character sets", ./config.h:CHARSET_*!) */
63 #define CHARSET_7BIT "us-ascii"
64 #ifdef HAVE_ICONV
65 # define CHARSET_8BIT "utf-8"
66 # define CHARSET_8BIT_OKEY charset_8bit
67 #else
68 # define CHARSET_8BIT "iso-8859-1"
69 # define CHARSET_8BIT_OKEY ttycharset
70 #endif
72 #ifndef HOST_NAME_MAX
73 # ifdef _POSIX_HOST_NAME_MAX
74 # define HOST_NAME_MAX _POSIX_HOST_NAME_MAX
75 # else
76 # define HOST_NAME_MAX 255
77 # endif
78 #endif
80 /* Supported IDNA implementations */
81 #define n_IDNA_IMPL_LIBIDN2 0
82 #define n_IDNA_IMPL_LIBIDN 1
83 #define n_IDNA_IMPL_IDNKIT 2
85 /* Max readable line width TODO simply use BUFSIZ? */
86 #if BUFSIZ + 0 > 2560
87 # define LINESIZE BUFSIZ
88 #else
89 # define LINESIZE 2560
90 #endif
91 #define BUFFER_SIZE (BUFSIZ >= (1u << 13) ? BUFSIZ : (1u << 14))
93 /* Auto-reclaimed memory storage: size of the buffers. Maximum auto-reclaimed
94 * storage is that value /2, which is n_CTA()ed to be > 1024 */
95 #define n_MEMORY_AUTOREC_SIZE 0x2000u
96 /* Ugly, but avoid dynamic allocation for the management structure! */
97 #define n_MEMORY_POOL_TYPE_SIZEOF (7 * sizeof(void*))
99 /* Default *mime-encoding* as enum mime_enc */
100 #define MIME_DEFAULT_ENCODING MIMEE_QP
102 /* Maximum allowed line length in a mail before QP folding is necessary), and
103 * the real limit we go for */
104 #define MIME_LINELEN_MAX 998 /* Plus CRLF */
105 #define MIME_LINELEN_LIMIT (MIME_LINELEN_MAX - 48)
107 /* Ditto, SHOULD */
108 #define MIME_LINELEN 78 /* Plus CRLF */
110 /* And in headers which contain an encoded word according to RFC 2047 there is
111 * yet another limit; also RFC 2045: 6.7, (5). */
112 #define MIME_LINELEN_RFC2047 76
114 /* TODO PATH_MAX: fixed-size buffer is always wrong (think NFS) */
115 #ifndef PATH_MAX
116 # ifdef MAXPATHLEN
117 # define PATH_MAX MAXPATHLEN
118 # else
119 # define PATH_MAX 1024 /* _XOPEN_PATH_MAX POSIX 2008/Cor 1-2013 */
120 # endif
121 #endif
123 /* Some environment variables for pipe hooks etc. */
124 #define n_PIPEENV_FILENAME "MAILX_FILENAME"
125 #define n_PIPEENV_FILENAME_GENERATED "MAILX_FILENAME_GENERATED"
126 #define n_PIPEENV_FILENAME_TEMPORARY "MAILX_FILENAME_TEMPORARY"
127 #define n_PIPEENV_CONTENT "MAILX_CONTENT"
128 #define n_PIPEENV_CONTENT_EVIDENCE "MAILX_CONTENT_EVIDENCE"
129 #define n_PIPEENV_EXTERNAL_BODY_URL "MAILX_EXTERNAL_BODY_URL"
131 /* Maximum number of quote characters (not bytes!) that'll be used on
132 * follow lines when compressing leading quote characters */
133 #define n_QUOTE_MAX 42u
135 /* How much spaces should a <tab> count when *quote-fold*ing? (power-of-two!) */
136 #define n_QUOTE_TAB_SPACES 8
138 /* Supported (external) PRG implementations */
139 #define n_RANDOM_IMPL_BUILTIN 0
140 #define n_RANDOM_IMPL_ARC4 1
141 #define n_RANDOM_IMPL_SSL 2
142 #define n_RANDOM_IMPL_GETRANDOM 3 /* (both, syscall + library) */
143 #define n_RANDOM_IMPL_URANDOM 4
145 /* For long iterative output, like `list', tabulator-completion, etc.,
146 * determine the screen width that should be used */
147 #define n_SCRNWIDTH_FOR_LISTS ((size_t)n_scrnwidth - ((size_t)n_scrnwidth >> 3))
149 /* Smells fishy after, or asks for shell expansion, dependent on context */
150 #define n_SHEXP_MAGIC_PATH_CHARS "|&;<>{}()[]*?$`'\"\\"
152 /* Port to native MS-Windows and to ancient UNIX */
153 #if !defined S_ISDIR && defined S_IFDIR && defined S_IFMT
154 # define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)
155 #endif
157 /* Maximum size of a message that is passed through to the spam system */
158 #define SPAM_MAXSIZE 420000
160 #ifndef NAME_MAX
161 # ifdef _POSIX_NAME_MAX
162 # define NAME_MAX _POSIX_NAME_MAX
163 # else
164 # define NAME_MAX 14
165 # endif
166 #endif
167 #if NAME_MAX + 0 < 8
168 # error NAME_MAX is too small
169 #endif
171 #ifndef STDIN_FILENO
172 # define STDIN_FILENO 0
173 #endif
174 #ifndef STDOUT_FILENO
175 # define STDOUT_FILENO 1
176 #endif
177 #ifndef STDERR_FILENO
178 # define STDERR_FILENO 2
179 #endif
181 #ifdef O_CLOEXEC
182 # define _O_CLOEXEC O_CLOEXEC
183 # define _CLOEXEC_SET(FD) do {;} while(0)
184 #else
185 # define _O_CLOEXEC 0
186 # define _CLOEXEC_SET(FD) n_fd_cloexec_set(FD)
187 #endif
189 #ifdef O_NOCTTY
190 # define n_O_NOCTTY O_NOCTTY
191 #else
192 # define n_O_NOCTTY 0
193 #endif
194 #ifdef O_NOFOLLOW
195 # define n_O_NOFOLLOW O_NOFOLLOW
196 #else
197 # define n_O_NOFOLLOW 0
198 #endif
199 #define n_O_NOXY_BITS (n_O_NOCTTY | n_O_NOFOLLOW)
201 #ifdef NSIG_MAX
202 # undef NSIG
203 # define NSIG NSIG_MAX
204 #elif !defined NSIG
205 # define NSIG ((sizeof(sigset_t) * 8) - 1)
206 #endif
208 /* * */
210 /* Switch indicating necessity of terminal access interface (termcap.c) */
211 #if defined HAVE_TERMCAP || defined HAVE_COLOUR || defined HAVE_MLE
212 # define n_HAVE_TCAP
213 #endif
215 /* Whether we shall do our memory debug thing */
216 #if (defined HAVE_DEBUG || defined HAVE_DEVEL) && !defined HAVE_NOMEMDBG
217 # define HAVE_MEMORY_DEBUG
218 #endif
220 /* Number of Not-Yet-Dead calls that are remembered */
221 #if defined HAVE_DEBUG || defined HAVE_DEVEL || defined HAVE_NYD2
222 # ifdef HAVE_NYD2
223 # define NYD_CALLS_MAX (25 * 84)
224 # elif defined HAVE_DEVEL
225 # define NYD_CALLS_MAX (25 * 42)
226 # else
227 # define NYD_CALLS_MAX (25 * 10)
228 # endif
229 #endif
231 #endif /* n_CONFIG_H */
232 /* s-it-mode */