xref: /vim-8.2.3635/src/vim.h (revision 1d69ef41)
1 /* vi:set ts=8 sts=4 sw=4 noet:
2  *
3  * VIM - Vi IMproved	by Bram Moolenaar
4  *
5  * Do ":help uganda"  in Vim to read copying and usage conditions.
6  * Do ":help credits" in Vim to see a list of people who contributed.
7  */
8 
9 #ifndef VIM__H
10 # define VIM__H
11 
12 #include "protodef.h"
13 
14 // _WIN32 is defined as 1 when the compilation target is 32-bit or 64-bit.
15 // Note: If you want to check for 64-bit use the _WIN64 macro.
16 #if defined(WIN32) || defined(_WIN32)
17 # define MSWIN
18 #endif
19 
20 #ifdef MSWIN
21 # include <io.h>
22 #endif
23 
24 // ============ the header file puzzle: order matters =========
25 
26 #ifdef HAVE_CONFIG_H	// GNU autoconf (or something else) was here
27 # include "auto/config.h"
28 # define HAVE_PATHDEF
29 
30 /*
31  * Check if configure correctly managed to find sizeof(int).  If this failed,
32  * it becomes zero.  This is likely a problem of not being able to run the
33  * test program.  Other items from configure may also be wrong then!
34  */
35 # if (VIM_SIZEOF_INT == 0)
36 #  error configure did not run properly.  Check auto/config.log.
37 # endif
38 
39 # if (defined(__linux__) && !defined(__ANDROID__)) || defined(__CYGWIN__)
40 // Needed for strptime().  Needs to be done early, since header files can
41 // include other header files and end up including time.h, where these symbols
42 // matter for Vim.
43 // 700 is needed for mkdtemp().
44 #  ifndef _XOPEN_SOURCE
45 #   define _XOPEN_SOURCE    700
46 
47 // On old systems, defining _XOPEN_SOURCE causes _BSD_SOURCE, _SVID_SOURCE
48 // and/or // _DEFAULT_SOURCE not to be defined, so do that here.  Those are
49 // needed to include nanosecond-resolution timestamps in struct stat.  On new
50 // systems, _DEFAULT_SOURCE is needed to avoid warning messages about using
51 // deprecated _BSD_SOURCE or _SVID_SOURCE.
52 #   ifndef _BSD_SOURCE
53 #    define _BSD_SOURCE 1
54 #   endif
55 #   ifndef _SVID_SOURCE
56 #    define _SVID_SOURCE 1
57 #   endif
58 #   ifndef _DEFAULT_SOURCE
59 #    define _DEFAULT_SOURCE 1
60 #   endif
61 #  endif
62 # endif
63 
64 /*
65  * Cygwin may have fchdir() in a newer release, but in most versions it
66  * doesn't work well and avoiding it keeps the binary backward compatible.
67  */
68 # if defined(__CYGWIN32__) && defined(HAVE_FCHDIR)
69 #  undef HAVE_FCHDIR
70 # endif
71 
72 // We may need to define the uint32_t on non-Unix system, but using the same
73 // identifier causes conflicts.  Therefore use UINT32_T.
74 # define UINT32_TYPEDEF uint32_t
75 #endif
76 
77 // for INT_MAX, LONG_MAX et al.
78 #include <limits.h>
79 
80 #if !defined(UINT32_TYPEDEF)
81 # if defined(uint32_t)  // this doesn't catch typedefs, unfortunately
82 #  define UINT32_TYPEDEF uint32_t
83 # else
84   // Fall back to assuming unsigned int is 32 bit.  If this is wrong then the
85   // test in blowfish.c will fail.
86 #  define UINT32_TYPEDEF unsigned int
87 # endif
88 #endif
89 
90 // user ID of root is usually zero, but not for everybody
91 #ifdef __TANDEM
92 # ifndef _TANDEM_SOURCE
93 #  define _TANDEM_SOURCE
94 # endif
95 # include <floss.h>
96 # define ROOT_UID 65535
97 # define OLDXAW
98 # if (_TANDEM_ARCH_ == 2 && __H_Series_RVU >= 621)
99 #  define SA_ONSTACK_COMPATIBILITY
100 # endif
101 #else
102 # define ROOT_UID 0
103 #endif
104 
105 /*
106  * MACOS_X	    compiling for Mac OS X
107  * MACOS_X_DARWIN   integrating the darwin feature into MACOS_X
108  */
109 #if defined(MACOS_X_DARWIN) && !defined(MACOS_X)
110 # define MACOS_X
111 #endif
112 // Unless made through the Makefile enforce GUI on Mac
113 #if defined(MACOS_X) && !defined(HAVE_CONFIG_H)
114 # define UNIX
115 #endif
116 
117 #if defined(FEAT_GUI_MOTIF) \
118     || defined(FEAT_GUI_GTK) \
119     || defined(FEAT_GUI_ATHENA) \
120     || defined(FEAT_GUI_HAIKU) \
121     || defined(FEAT_GUI_MSWIN) \
122     || defined(FEAT_GUI_PHOTON)
123 # define FEAT_GUI_ENABLED  // also defined with NO_X11_INCLUDES
124 # if !defined(FEAT_GUI) && !defined(NO_X11_INCLUDES)
125 #  define FEAT_GUI
126 # endif
127 #endif
128 
129 // Check support for rendering options
130 #ifdef FEAT_GUI
131 # if defined(FEAT_DIRECTX)
132 #  define FEAT_RENDER_OPTIONS
133 # endif
134 #endif
135 
136 /*
137  * VIM_SIZEOF_INT is used in feature.h, and the system-specific included files
138  * need items from feature.h.  Therefore define VIM_SIZEOF_INT here.
139  */
140 #ifdef MSWIN
141 # define VIM_SIZEOF_INT 4
142 #endif
143 
144 #ifdef AMIGA
145   // Be conservative about sizeof(int). It could be 4 too.
146 # ifndef FEAT_GUI_GTK	// avoid problems when generating prototypes
147 #  ifdef __GNUC__
148 #   define VIM_SIZEOF_INT	4
149 #  else
150 #   define VIM_SIZEOF_INT	2
151 #  endif
152 # endif
153 #endif
154 #if defined(MACOS_X) && !defined(HAVE_CONFIG_H)
155 #  define VIM_SIZEOF_INT __SIZEOF_INT__
156 #endif
157 
158 #if VIM_SIZEOF_INT < 4 && !defined(PROTO)
159 # error Vim only works with 32 bit int or larger
160 #endif
161 
162 /*
163  * #defines for optionals and features
164  * Also defines FEAT_TINY, FEAT_SMALL, etc. when FEAT_HUGE is defined.
165  */
166 #include "feature.h"
167 
168 #if defined(MACOS_X_DARWIN)
169 # if defined(FEAT_SMALL) && !defined(FEAT_CLIPBOARD)
170 #  define FEAT_CLIPBOARD
171 # endif
172 #endif
173 
174 // +x11 is only enabled when it's both available and wanted.
175 #if defined(HAVE_X11) && defined(WANT_X11)
176 # define FEAT_X11
177 #endif
178 
179 #ifdef NO_X11_INCLUDES
180     // In os_mac_conv.c and os_macosx.m NO_X11_INCLUDES is defined to avoid
181     // X11 headers.  Disable all X11 related things to avoid conflicts.
182 # ifdef FEAT_X11
183 #  undef FEAT_X11
184 # endif
185 # ifdef FEAT_GUI_X11
186 #  undef FEAT_GUI_X11
187 # endif
188 # ifdef FEAT_XCLIPBOARD
189 #  undef FEAT_XCLIPBOARD
190 # endif
191 # ifdef FEAT_GUI_MOTIF
192 #  undef FEAT_GUI_MOTIF
193 # endif
194 # ifdef FEAT_GUI_ATHENA
195 #  undef FEAT_GUI_ATHENA
196 # endif
197 # ifdef FEAT_GUI_GTK
198 #  undef FEAT_GUI_GTK
199 # endif
200 # ifdef FEAT_BEVAL_TIP
201 #  undef FEAT_BEVAL_TIP
202 # endif
203 # ifdef FEAT_XIM
204 #  undef FEAT_XIM
205 # endif
206 # ifdef FEAT_CLIENTSERVER
207 #  undef FEAT_CLIENTSERVER
208 # endif
209 #endif
210 
211 // The Mac conversion stuff doesn't work under X11.
212 #if defined(MACOS_X_DARWIN)
213 # define MACOS_CONVERT
214 #endif
215 
216 // Can't use "PACKAGE" here, conflicts with a Perl include file.
217 #ifndef VIMPACKAGE
218 # define VIMPACKAGE	"vim"
219 #endif
220 
221 /*
222  * Find out if function definitions should include argument types
223  */
224 #ifdef AZTEC_C
225 # include <functions.h>
226 #endif
227 
228 #ifdef SASC
229 # include <clib/exec_protos.h>
230 #endif
231 
232 #ifdef _DCC
233 # include <clib/exec_protos.h>
234 #endif
235 
236 #ifdef __HAIKU__
237 # include "os_haiku.h"
238 # define __ARGS(x)  x
239 #endif
240 
241 #if (defined(UNIX) || defined(VMS)) \
242 	&& (!defined(MACOS_X) || defined(HAVE_CONFIG_H))
243 # include "os_unix.h"	    // bring lots of system header files
244 #endif
245 
246 // Mark unused function arguments with UNUSED, so that gcc -Wunused-parameter
247 // can be used to check for mistakes.
248 #if defined(HAVE_ATTRIBUTE_UNUSED) || defined(__MINGW32__)
249 # if !defined(UNUSED)
250 #  define UNUSED __attribute__((unused))
251 # endif
252 #else
253 # define UNUSED
254 #endif
255 
256 // Used to check for "sun", "__sun" is used by newer compilers.
257 #if defined(__sun)
258 # define SUN_SYSTEM
259 #endif
260 
261 // If we're compiling in C++ (currently only KVim), the system
262 // headers must have the correct prototypes or nothing will build.
263 // Conversely, our prototypes might clash due to throw() specifiers and
264 // cause compilation failures even though the headers are correct.  For
265 // a concrete example, gcc-3.2 enforces exception specifications, and
266 // glibc-2.2.5 has them in their system headers.
267 #if !defined(__cplusplus) && defined(UNIX) \
268 	&& !defined(MACOS_X) // MACOS_X doesn't yet support osdef.h
269 # include "auto/osdef.h"	// bring missing declarations in
270 #endif
271 
272 #ifdef AMIGA
273 # include "os_amiga.h"
274 #endif
275 
276 #ifdef MSWIN
277 # include "os_win32.h"
278 #endif
279 
280 #if defined(MACOS_X)
281 # include "os_mac.h"
282 #endif
283 
284 #ifdef __QNX__
285 # include "os_qnx.h"
286 #endif
287 
288 #ifdef X_LOCALE
289 # include <X11/Xlocale.h>
290 #else
291 # ifdef HAVE_LOCALE_H
292 #  include <locale.h>
293 # endif
294 #endif
295 
296 /*
297  * Maximum length of a path (for non-unix systems) Make it a bit long, to stay
298  * on the safe side.  But not too long to put on the stack.
299  */
300 #ifndef MAXPATHL
301 # ifdef MAXPATHLEN
302 #  define MAXPATHL  MAXPATHLEN
303 # else
304 #  define MAXPATHL  256
305 # endif
306 #endif
307 #ifdef BACKSLASH_IN_FILENAME
308 # define PATH_ESC_CHARS ((char_u *)" \t\n*?[{`%#'\"|!<")
309 # define BUFFER_ESC_CHARS ((char_u *)" \t\n*?[`%#'\"|!<")
310 #else
311 # ifdef VMS
312     // VMS allows a lot of characters in the file name
313 #  define PATH_ESC_CHARS ((char_u *)" \t\n*?{`\\%#'\"|!")
314 #  define SHELL_ESC_CHARS ((char_u *)" \t\n*?{`\\%#'|!()&")
315 # else
316 #  define PATH_ESC_CHARS ((char_u *)" \t\n*?[{`$\\%#'\"|!<")
317 #  define SHELL_ESC_CHARS ((char_u *)" \t\n*?[{`$\\%#'\"|!<>();&")
318 # endif
319 #  define BUFFER_ESC_CHARS ((char_u *)" \t\n*?[`$\\%#'\"|!<")
320 #endif
321 
322 // length of a buffer to store a number in ASCII (64 bits binary + NUL)
323 #define NUMBUFLEN 65
324 
325 // flags for vim_str2nr()
326 #define STR2NR_BIN  0x01
327 #define STR2NR_OCT  0x02
328 #define STR2NR_HEX  0x04
329 #define STR2NR_OOCT 0x08    // Octal with prefix "0o": 0o777
330 #define STR2NR_ALL (STR2NR_BIN + STR2NR_OCT + STR2NR_HEX + STR2NR_OOCT)
331 #define STR2NR_NO_OCT (STR2NR_BIN + STR2NR_HEX + STR2NR_OOCT)
332 
333 #define STR2NR_FORCE 0x80   // only when ONE of the above is used
334 
335 #define STR2NR_QUOTE 0x10   // ignore embedded single quotes
336 
337 /*
338  * Shorthand for unsigned variables. Many systems, but not all, have u_char
339  * already defined, so we use char_u to avoid trouble.
340  */
341 typedef unsigned char	char_u;
342 typedef unsigned short	short_u;
343 typedef unsigned int	int_u;
344 
345 // Make sure long_u is big enough to hold a pointer.
346 // On Win64, longs are 32 bits and pointers are 64 bits.
347 // For printf() and scanf(), we need to take care of long_u specifically.
348 #ifdef _WIN64
349 typedef unsigned __int64	long_u;
350 typedef		 __int64	long_i;
351 # define SCANF_HEX_LONG_U       "%llx"
352 # define SCANF_DECIMAL_LONG_U   "%llu"
353 # define PRINTF_HEX_LONG_U      "0x%llx"
354 #else
355   // Microsoft-specific. The __w64 keyword should be specified on any typedefs
356   // that change size between 32-bit and 64-bit platforms.  For any such type,
357   // __w64 should appear only on the 32-bit definition of the typedef.
358   // Define __w64 as an empty token for everything but MSVC 7.x or later.
359 # if !defined(_MSC_VER)	|| (_MSC_VER < 1300)
360 #  define __w64
361 # endif
362 typedef unsigned long __w64	long_u;
363 typedef		 long __w64     long_i;
364 # define SCANF_HEX_LONG_U       "%lx"
365 # define SCANF_DECIMAL_LONG_U   "%lu"
366 # define PRINTF_HEX_LONG_U      "0x%lx"
367 #endif
368 #define PRINTF_DECIMAL_LONG_U SCANF_DECIMAL_LONG_U
369 
370 /*
371  * Only systems which use configure will have SIZEOF_OFF_T and VIM_SIZEOF_LONG
372  * defined, which is ok since those are the same systems which can have
373  * varying sizes for off_t.  The other systems will continue to use "%ld" to
374  * print off_t since off_t is simply a typedef to long for them.
375  */
376 #if defined(SIZEOF_OFF_T) && (SIZEOF_OFF_T > VIM_SIZEOF_LONG)
377 # define LONG_LONG_OFF_T
378 #endif
379 
380 /*
381  * We use 64-bit file functions here, if available.  E.g. ftello() returns
382  * off_t instead of long, which helps if long is 32 bit and off_t is 64 bit.
383  * We assume that when fseeko() is available then ftello() is too.
384  * Note that Windows has different function names.
385  */
386 #if (defined(_MSC_VER) && (_MSC_VER >= 1300)) || defined(__MINGW32__)
387 typedef __int64 off_T;
388 # ifdef __MINGW32__
389 #  define vim_lseek lseek64
390 #  define vim_fseek fseeko64
391 #  define vim_ftell ftello64
392 # else
393 #  define vim_lseek _lseeki64
394 #  define vim_fseek _fseeki64
395 #  define vim_ftell _ftelli64
396 # endif
397 #else
398 # ifdef PROTO
399 typedef long off_T;
400 # else
401 typedef off_t off_T;
402 # endif
403 # ifdef HAVE_FSEEKO
404 #  define vim_lseek lseek
405 #  define vim_ftell ftello
406 #  define vim_fseek fseeko
407 # else
408 #  define vim_lseek lseek
409 #  define vim_ftell ftell
410 #  define vim_fseek(a, b, c)	fseek(a, (long)b, c)
411 # endif
412 #endif
413 
414 /*
415  * The characters and attributes cached for the screen.
416  */
417 typedef char_u schar_T;
418 typedef unsigned short sattr_T;
419 #define MAX_TYPENR 65535
420 
421 /*
422  * The u8char_T can hold one decoded UTF-8 character.
423  * We use 32 bits, since some Asian characters don't fit in 16 bits.
424  */
425 typedef unsigned int u8char_T;	// int is 32 bits or more
426 
427 #ifndef UNIX		    // For Unix this is included in os_unix.h
428 # include <stdio.h>
429 # include <ctype.h>
430 #endif
431 
432 #include "ascii.h"
433 #include "keymap.h"
434 #include "termdefs.h"
435 #include "macros.h"
436 
437 #ifdef LATTICE
438 # include <sys/types.h>
439 # include <sys/stat.h>
440 #endif
441 #ifdef _DCC
442 # include <sys/stat.h>
443 #endif
444 #if defined(MSWIN)
445 # include <sys/stat.h>
446 #endif
447 
448 #if defined(HAVE_ERRNO_H) || defined(MSWIN)
449 # include <errno.h>
450 #endif
451 
452 /*
453  * Allow other (non-unix) systems to configure themselves now
454  * These are also in os_unix.h, because osdef.sh needs them there.
455  */
456 #ifndef UNIX
457 // Note: Some systems need both string.h and strings.h (Savage).  If the
458 // system can't handle this, define NO_STRINGS_WITH_STRING_H.
459 # ifdef HAVE_STRING_H
460 #  include <string.h>
461 # endif
462 # if defined(HAVE_STRINGS_H) && !defined(NO_STRINGS_WITH_STRING_H)
463 #  include <strings.h>
464 # endif
465 # ifdef HAVE_STAT_H
466 #  include <stat.h>
467 # endif
468 # ifdef HAVE_STDLIB_H
469 #  include <stdlib.h>
470 # endif
471 #endif // NON-UNIX
472 
473 #include <assert.h>
474 
475 #ifdef HAVE_STDINT_H
476 # include <stdint.h>
477 #endif
478 #ifdef HAVE_INTTYPES_H
479 # include <inttypes.h>
480 #endif
481 #ifdef HAVE_WCTYPE_H
482 # include <wctype.h>
483 #endif
484 #include <stdarg.h>
485 
486 // for offsetof()
487 #include <stddef.h>
488 
489 #if defined(HAVE_SYS_SELECT_H) && \
490 	(!defined(HAVE_SYS_TIME_H) || defined(SYS_SELECT_WITH_SYS_TIME))
491 # include <sys/select.h>
492 #endif
493 
494 #ifndef HAVE_SELECT
495 # ifdef HAVE_SYS_POLL_H
496 #  include <sys/poll.h>
497 # elif defined(MSWIN)
498 #  define HAVE_SELECT
499 # else
500 #  ifdef HAVE_POLL_H
501 #   include <poll.h>
502 #  endif
503 # endif
504 #endif
505 
506 #ifdef HAVE_SODIUM
507 # include <sodium.h>
508 #endif
509 
510 // ================ end of the header file puzzle ===============
511 
512 /*
513  * For dynamically loaded imm library. Currently, only for Win32.
514  */
515 #ifdef DYNAMIC_IME
516 # ifndef FEAT_MBYTE_IME
517 #  define FEAT_MBYTE_IME
518 # endif
519 #endif
520 
521 /*
522  * For dynamically loaded gettext library.  Currently, only for Win32.
523  */
524 #ifdef DYNAMIC_GETTEXT
525 # ifndef FEAT_GETTEXT
526 #  define FEAT_GETTEXT
527 # endif
528 // These are in os_win32.c
529 extern char *(*dyn_libintl_gettext)(const char *msgid);
530 extern char *(*dyn_libintl_ngettext)(const char *msgid, const char *msgid_plural, unsigned long n);
531 extern char *(*dyn_libintl_bindtextdomain)(const char *domainname, const char *dirname);
532 extern char *(*dyn_libintl_bind_textdomain_codeset)(const char *domainname, const char *codeset);
533 extern char *(*dyn_libintl_textdomain)(const char *domainname);
534 extern int (*dyn_libintl_wputenv)(const wchar_t *envstring);
535 #endif
536 
537 
538 /*
539  * The _() stuff is for using gettext().  It is a no-op when libintl.h is not
540  * found or the +multilang feature is disabled.
541  * Use NGETTEXT(single, multi, number) to get plural behavior:
542  * - single - message for singular form
543  * - multi  - message for plural form
544  * - number - the count
545  */
546 #ifdef FEAT_GETTEXT
547 # ifdef DYNAMIC_GETTEXT
548 #  define _(x) (*dyn_libintl_gettext)((char *)(x))
549 #  define NGETTEXT(x, xs, n) (*dyn_libintl_ngettext)((char *)(x), (char *)(xs), (n))
550 #  define N_(x) x
551 #  define bindtextdomain(domain, dir) (*dyn_libintl_bindtextdomain)((domain), (dir))
552 #  define bind_textdomain_codeset(domain, codeset) (*dyn_libintl_bind_textdomain_codeset)((domain), (codeset))
553 #  if !defined(HAVE_BIND_TEXTDOMAIN_CODESET)
554 #   define HAVE_BIND_TEXTDOMAIN_CODESET 1
555 #  endif
556 #  define textdomain(domain) (*dyn_libintl_textdomain)(domain)
557 #  define libintl_wputenv(envstring) (*dyn_libintl_wputenv)(envstring)
558 # else
559 #  include <libintl.h>
560 #  define _(x) gettext((char *)(x))
561 #  define NGETTEXT(x, xs, n) ngettext((x), (xs), (n))
562 #  ifdef gettext_noop
563 #   define N_(x) gettext_noop(x)
564 #  else
565 #   define N_(x) x
566 #  endif
567 # endif
568 #else
569 # define _(x) ((char *)(x))
570 # define NGETTEXT(x, xs, n) (((n) == 1) ? (char *)(x) : (char *)(xs))
571 # define N_(x) x
572 # ifdef bindtextdomain
573 #  undef bindtextdomain
574 # endif
575 # define bindtextdomain(x, y) // empty
576 # ifdef bind_textdomain_codeset
577 #  undef bind_textdomain_codeset
578 # endif
579 # define bind_textdomain_codeset(x, y) // empty
580 # ifdef textdomain
581 #  undef textdomain
582 # endif
583 # define textdomain(x) // empty
584 #endif
585 
586 /*
587  * flags for update_screen()
588  * The higher the value, the higher the priority
589  */
590 #define VALID_NO_UPDATE		 5  // no new changes, keep the command line if
591 				    // possible
592 #define VALID			10  // buffer not changed, or changes marked
593 				    // with b_mod_*
594 #define INVERTED		20  // redisplay inverted part that changed
595 #define INVERTED_ALL		25  // redisplay whole inverted part
596 #define REDRAW_TOP		30  // display first w_upd_rows screen lines
597 #define SOME_VALID		35  // like NOT_VALID but may scroll
598 #define NOT_VALID		40  // buffer needs complete redraw
599 #define CLEAR			50  // screen messed up, clear it
600 
601 // flags for screen_line()
602 #define SLF_RIGHTLEFT	1
603 #define SLF_POPUP	2
604 
605 #define MB_FILLER_CHAR '<'  // character used when a double-width character
606 			    // doesn't fit.
607 
608 /*
609  * Flags for w_valid.
610  * These are set when something in a window structure becomes invalid, except
611  * when the cursor is moved.  Call check_cursor_moved() before testing one of
612  * the flags.
613  * These are reset when that thing has been updated and is valid again.
614  *
615  * Every function that invalidates one of these must call one of the
616  * invalidate_* functions.
617  *
618  * w_valid is supposed to be used only in screen.c.  From other files, use the
619  * functions that set or reset the flags.
620  *
621  * VALID_BOTLINE    VALID_BOTLINE_AP
622  *     on		on		w_botline valid
623  *     off		on		w_botline approximated
624  *     off		off		w_botline not valid
625  *     on		off		not possible
626  */
627 #define VALID_WROW	0x01	// w_wrow (window row) is valid
628 #define VALID_WCOL	0x02	// w_wcol (window col) is valid
629 #define VALID_VIRTCOL	0x04	// w_virtcol (file col) is valid
630 #define VALID_CHEIGHT	0x08	// w_cline_height and w_cline_folded valid
631 #define VALID_CROW	0x10	// w_cline_row is valid
632 #define VALID_BOTLINE	0x20	// w_botine and w_empty_rows are valid
633 #define VALID_BOTLINE_AP 0x40	// w_botine is approximated
634 #define VALID_TOPLINE	0x80	// w_topline is valid (for cursor position)
635 
636 // Values for w_popup_flags.
637 #define POPF_IS_POPUP	0x01	// this is a popup window
638 #define POPF_HIDDEN	0x02	// popup is not displayed
639 #define POPF_CURSORLINE	0x04	// popup is highlighting at the cursorline
640 #define POPF_ON_CMDLINE	0x08	// popup overlaps command line
641 #define POPF_DRAG	0x10	// popup can be moved by dragging
642 #define POPF_RESIZE	0x20	// popup can be resized by dragging
643 #define POPF_MAPPING	0x40	// mapping keys
644 #define POPF_INFO	0x80	// used for info of popup menu
645 #define POPF_INFO_MENU	0x100	// align info popup with popup menu
646 #define POPF_POSINVERT	0x200	// vertical position can be inverted
647 
648 // flags used in w_popup_handled
649 #define POPUP_HANDLED_1	    0x01    // used by mouse_find_win()
650 #define POPUP_HANDLED_2	    0x02    // used by popup_do_filter()
651 #define POPUP_HANDLED_3	    0x04    // used by popup_check_cursor_pos()
652 #define POPUP_HANDLED_4	    0x08    // used by may_update_popup_mask()
653 #define POPUP_HANDLED_5	    0x10    // used by update_popups()
654 
655 /*
656  * Terminal highlighting attribute bits.
657  * Attributes above HL_ALL are used for syntax highlighting.
658  */
659 #define HL_NORMAL		0x00
660 #define HL_INVERSE		0x01
661 #define HL_BOLD			0x02
662 #define HL_ITALIC		0x04
663 #define HL_UNDERLINE		0x08
664 #define HL_UNDERCURL		0x10
665 #define HL_STANDOUT		0x20
666 #define HL_NOCOMBINE		0x40
667 #define HL_STRIKETHROUGH	0x80
668 #define HL_ALL			0xff
669 
670 // special attribute addition: Put message in history
671 #define MSG_HIST		0x1000
672 
673 /*
674  * values for State
675  *
676  * The lower bits up to 0x20 are used to distinguish normal/visual/op_pending
677  * and cmdline/insert+replace mode.  This is used for mapping.  If none of
678  * these bits are set, no mapping is done.
679  * The upper bits are used to distinguish between other states.
680  */
681 #define NORMAL		0x01	// Normal mode, command expected
682 #define VISUAL		0x02	// Visual mode - use get_real_state()
683 #define OP_PENDING	0x04	// Normal mode, operator is pending - use
684 				// get_real_state()
685 #define CMDLINE		0x08	// Editing command line
686 #define INSERT		0x10	// Insert mode
687 #define LANGMAP		0x20	// Language mapping, can be combined with
688 				// INSERT and CMDLINE
689 
690 #define REPLACE_FLAG	0x40	// Replace mode flag
691 #define REPLACE		(REPLACE_FLAG + INSERT)
692 #define VREPLACE_FLAG	0x80	// Virtual-replace mode flag
693 #define VREPLACE	(REPLACE_FLAG + VREPLACE_FLAG + INSERT)
694 #define LREPLACE	(REPLACE_FLAG + LANGMAP)
695 
696 #define NORMAL_BUSY	(0x100 + NORMAL) // Normal mode, busy with a command
697 #define HITRETURN	(0x200 + NORMAL) // waiting for return or command
698 #define ASKMORE		0x300	// Asking if you want --more--
699 #define SETWSIZE	0x400	// window size has changed
700 #define ABBREV		0x500	// abbreviation instead of mapping
701 #define EXTERNCMD	0x600	// executing an external command
702 #define SHOWMATCH	(0x700 + INSERT) // show matching paren
703 #define CONFIRM		0x800	// ":confirm" prompt
704 #define SELECTMODE	0x1000	// Select mode, only for mappings
705 #define TERMINAL        0x2000  // Terminal mode
706 #define MODE_ALL	0xffff
707 
708 #define MODE_MAX_LENGTH	4	// max mode length returned in mode()
709 
710 // all mode bits used for mapping
711 #define MAP_ALL_MODES	(0x3f | SELECTMODE | TERMINAL)
712 
713 // directions
714 #define FORWARD			1
715 #define BACKWARD		(-1)
716 #define FORWARD_FILE		3
717 #define BACKWARD_FILE		(-3)
718 
719 // return values for functions
720 #if !(defined(OK) && (OK == 1))
721 // OK already defined to 1 in MacOS X curses, skip this
722 # define OK			1
723 #endif
724 #define FAIL			0
725 #define NOTDONE			2   // not OK or FAIL but skipped
726 
727 // flags for b_flags
728 #define BF_RECOVERED	0x01	// buffer has been recovered
729 #define BF_CHECK_RO	0x02	// need to check readonly when loading file
730 				// into buffer (set by ":e", may be reset by
731 				// ":buf"
732 #define BF_NEVERLOADED	0x04	// file has never been loaded into buffer,
733 				// many variables still need to be set
734 #define BF_NOTEDITED	0x08	// Set when file name is changed after
735 				// starting to edit, reset when file is
736 				// written out.
737 #define BF_NEW		0x10	// file didn't exist when editing started
738 #define BF_NEW_W	0x20	// Warned for BF_NEW and file created
739 #define BF_READERR	0x40	// got errors while reading the file
740 #define BF_DUMMY	0x80	// dummy buffer, only used internally
741 #define BF_PRESERVED	0x100	// ":preserve" was used
742 #define BF_SYN_SET	0x200	// 'syntax' option was set
743 #define BF_NO_SEA	0x400	// no swap_exists_action (ATTENTION prompt)
744 
745 // Mask to check for flags that prevent normal writing
746 #define BF_WRITE_MASK	(BF_NOTEDITED + BF_NEW + BF_READERR)
747 
748 /*
749  * values for xp_context when doing command line completion
750  */
751 #define EXPAND_UNSUCCESSFUL	(-2)
752 #define EXPAND_OK		(-1)
753 #define EXPAND_NOTHING		0
754 #define EXPAND_COMMANDS		1
755 #define EXPAND_FILES		2
756 #define EXPAND_DIRECTORIES	3
757 #define EXPAND_SETTINGS		4
758 #define EXPAND_BOOL_SETTINGS	5
759 #define EXPAND_TAGS		6
760 #define EXPAND_OLD_SETTING	7
761 #define EXPAND_HELP		8
762 #define EXPAND_BUFFERS		9
763 #define EXPAND_EVENTS		10
764 #define EXPAND_MENUS		11
765 #define EXPAND_SYNTAX		12
766 #define EXPAND_HIGHLIGHT	13
767 #define EXPAND_AUGROUP		14
768 #define EXPAND_USER_VARS	15
769 #define EXPAND_MAPPINGS		16
770 #define EXPAND_TAGS_LISTFILES	17
771 #define EXPAND_FUNCTIONS	18
772 #define EXPAND_USER_FUNC	19
773 #define EXPAND_EXPRESSION	20
774 #define EXPAND_MENUNAMES	21
775 #define EXPAND_USER_COMMANDS	22
776 #define EXPAND_USER_CMD_FLAGS	23
777 #define EXPAND_USER_NARGS	24
778 #define EXPAND_USER_COMPLETE	25
779 #define EXPAND_ENV_VARS		26
780 #define EXPAND_LANGUAGE		27
781 #define EXPAND_COLORS		28
782 #define EXPAND_COMPILER		29
783 #define EXPAND_USER_DEFINED	30
784 #define EXPAND_USER_LIST	31
785 #define EXPAND_SHELLCMD		32
786 #define EXPAND_CSCOPE		33
787 #define EXPAND_SIGN		34
788 #define EXPAND_PROFILE		35
789 #define EXPAND_BEHAVE		36
790 #define EXPAND_FILETYPE		37
791 #define EXPAND_FILES_IN_PATH	38
792 #define EXPAND_OWNSYNTAX	39
793 #define EXPAND_LOCALES		40
794 #define EXPAND_HISTORY		41
795 #define EXPAND_USER		42
796 #define EXPAND_SYNTIME		43
797 #define EXPAND_USER_ADDR_TYPE	44
798 #define EXPAND_PACKADD		45
799 #define EXPAND_MESSAGES		46
800 #define EXPAND_MAPCLEAR		47
801 #define EXPAND_ARGLIST		48
802 #define EXPAND_DIFF_BUFFERS	49
803 #define EXPAND_DISASSEMBLE	50
804 
805 // Values for exmode_active (0 is no exmode)
806 #define EXMODE_NORMAL		1
807 #define EXMODE_VIM		2
808 
809 // Values for nextwild() and ExpandOne().  See ExpandOne() for meaning.
810 #define WILD_FREE		1
811 #define WILD_EXPAND_FREE	2
812 #define WILD_EXPAND_KEEP	3
813 #define WILD_NEXT		4
814 #define WILD_PREV		5
815 #define WILD_ALL		6
816 #define WILD_LONGEST		7
817 #define WILD_ALL_KEEP		8
818 
819 #define WILD_LIST_NOTFOUND	    0x01
820 #define WILD_HOME_REPLACE	    0x02
821 #define WILD_USE_NL		    0x04
822 #define WILD_NO_BEEP		    0x08
823 #define WILD_ADD_SLASH		    0x10
824 #define WILD_KEEP_ALL		    0x20
825 #define WILD_SILENT		    0x40
826 #define WILD_ESCAPE		    0x80
827 #define WILD_ICASE		    0x100
828 #define WILD_ALLLINKS		    0x200
829 #define WILD_IGNORE_COMPLETESLASH   0x400
830 #define WILD_NOERROR		    0x800  // sets EW_NOERROR
831 #define WILD_BUFLASTUSED	    0x1000
832 #define BUF_DIFF_FILTER		    0x2000
833 
834 // Flags for expand_wildcards()
835 #define EW_DIR		0x01	// include directory names
836 #define EW_FILE		0x02	// include file names
837 #define EW_NOTFOUND	0x04	// include not found names
838 #define EW_ADDSLASH	0x08	// append slash to directory name
839 #define EW_KEEPALL	0x10	// keep all matches
840 #define EW_SILENT	0x20	// don't print "1 returned" from shell
841 #define EW_EXEC		0x40	// executable files
842 #define EW_PATH		0x80	// search in 'path' too
843 #define EW_ICASE	0x100	// ignore case
844 #define EW_NOERROR	0x200	// no error for bad regexp
845 #define EW_NOTWILD	0x400	// add match with literal name if exists
846 #define EW_KEEPDOLLAR	0x800	// do not escape $, $var is expanded
847 // Note: mostly EW_NOTFOUND and EW_SILENT are mutually exclusive: EW_NOTFOUND
848 // is used when executing commands and EW_SILENT for interactive expanding.
849 #define EW_ALLLINKS	0x1000	// also links not pointing to existing file
850 #define EW_SHELLCMD	0x2000	// called from expand_shellcmd(), don't check
851 				// if executable is in $PATH
852 #define EW_DODOT	0x4000	// also files starting with a dot
853 #define EW_EMPTYOK	0x8000	// no matches is not an error
854 #define EW_NOTENV	0x10000	// do not expand environment variables
855 
856 // Flags for find_file_*() functions.
857 #define FINDFILE_FILE	0	// only files
858 #define FINDFILE_DIR	1	// only directories
859 #define FINDFILE_BOTH	2	// files and directories
860 
861 #define W_ENDCOL(wp)	(wp->w_wincol + wp->w_width)
862 #ifdef FEAT_MENU
863 # define W_WINROW(wp)	(wp->w_winrow + wp->w_winbar_height)
864 #else
865 # define W_WINROW(wp)	(wp->w_winrow)
866 #endif
867 
868 // Values for the find_pattern_in_path() function args 'type' and 'action':
869 #define FIND_ANY	1
870 #define FIND_DEFINE	2
871 #define CHECK_PATH	3
872 
873 #define ACTION_SHOW	1
874 #define ACTION_GOTO	2
875 #define ACTION_SPLIT	3
876 #define ACTION_SHOW_ALL	4
877 #define ACTION_EXPAND	5
878 
879 #ifdef FEAT_SYN_HL
880 # define SST_MIN_ENTRIES 150	// minimal size for state stack array
881 # define SST_MAX_ENTRIES 1000	// maximal size for state stack array
882 # define SST_FIX_STATES	 7	// size of sst_stack[].
883 # define SST_DIST	 16	// normal distance between entries
884 # define SST_INVALID	(synstate_T *)-1	// invalid syn_state pointer
885 
886 # define HL_CONTAINED	0x01	// not used on toplevel
887 # define HL_TRANSP	0x02	// has no highlighting
888 # define HL_ONELINE	0x04	// match within one line only
889 # define HL_HAS_EOL	0x08	// end pattern that matches with $
890 # define HL_SYNC_HERE	0x10	// sync point after this item (syncing only)
891 # define HL_SYNC_THERE	0x20	// sync point at current line (syncing only)
892 # define HL_MATCH	0x40	// use match ID instead of item ID
893 # define HL_SKIPNL	0x80	// nextgroup can skip newlines
894 # define HL_SKIPWHITE	0x100	// nextgroup can skip white space
895 # define HL_SKIPEMPTY	0x200	// nextgroup can skip empty lines
896 # define HL_KEEPEND	0x400	// end match always kept
897 # define HL_EXCLUDENL	0x800	// exclude NL from match
898 # define HL_DISPLAY	0x1000	// only used for displaying, not syncing
899 # define HL_FOLD	0x2000	// define fold
900 # define HL_EXTEND	0x4000	// ignore a keepend
901 # define HL_MATCHCONT	0x8000	// match continued from previous line
902 # define HL_TRANS_CONT	0x10000 // transparent item without contains arg
903 # define HL_CONCEAL	0x20000 // can be concealed
904 # define HL_CONCEALENDS	0x40000 // can be concealed
905 #endif
906 
907 // Values for 'options' argument in do_search() and searchit()
908 #define SEARCH_REV    0x01  // go in reverse of previous dir.
909 #define SEARCH_ECHO   0x02  // echo the search command and handle options
910 #define SEARCH_MSG    0x0c  // give messages (yes, it's not 0x04)
911 #define SEARCH_NFMSG  0x08  // give all messages except not found
912 #define SEARCH_OPT    0x10  // interpret optional flags
913 #define SEARCH_HIS    0x20  // put search pattern in history
914 #define SEARCH_END    0x40  // put cursor at end of match
915 #define SEARCH_NOOF   0x80  // don't add offset to position
916 #define SEARCH_START 0x100  // start search without col offset
917 #define SEARCH_MARK  0x200  // set previous context mark
918 #define SEARCH_KEEP  0x400  // keep previous search pattern
919 #define SEARCH_PEEK  0x800  // peek for typed char, cancel search
920 #define SEARCH_COL  0x1000  // start at specified column instead of zero
921 
922 // Values for find_ident_under_cursor()
923 #define FIND_IDENT	1	// find identifier (word)
924 #define FIND_STRING	2	// find any string (WORD)
925 #define FIND_EVAL	4	// include "->", "[]" and "."
926 #define FIND_NOERROR	8	// no error when no word found
927 
928 // Values for file_name_in_line()
929 #define FNAME_MESS	1	// give error message
930 #define FNAME_EXP	2	// expand to path
931 #define FNAME_HYP	4	// check for hypertext link
932 #define FNAME_INCL	8	// apply 'includeexpr'
933 #define FNAME_REL	16	// ".." and "./" are relative to the (current)
934 				// file instead of the current directory
935 #define FNAME_UNESC	32	// remove backslashes used for escaping
936 
937 // Values for buflist_getfile()
938 #define GETF_SETMARK	0x01	// set pcmark before jumping
939 #define GETF_ALT	0x02	// jumping to alternate file (not buf num)
940 #define GETF_SWITCH	0x04	// respect 'switchbuf' settings when jumping
941 
942 // Return values of getfile()
943 #define GETFILE_ERROR	    1	// normal error
944 #define GETFILE_NOT_WRITTEN 2	// "not written" error
945 #define GETFILE_SAME_FILE   0	// success, same file
946 #define GETFILE_OPEN_OTHER -1	// success, opened another file
947 #define GETFILE_UNUSED	    8
948 #define GETFILE_SUCCESS(x)  ((x) <= 0)
949 
950 // Values for buflist_new() flags
951 #define BLN_CURBUF	1	// may re-use curbuf for new buffer
952 #define BLN_LISTED	2	// put new buffer in buffer list
953 #define BLN_DUMMY	4	// allocating dummy buffer
954 #define BLN_NEW		8	// create a new buffer
955 #define BLN_NOOPT	16	// don't copy options to existing buffer
956 #define BLN_DUMMY_OK	32	// also find an existing dummy buffer
957 #define BLN_REUSE	64	// may re-use number from buf_reuse
958 #define BLN_NOCURWIN	128	// buffer is not associated with curwin
959 
960 // Values for in_cinkeys()
961 #define KEY_OPEN_FORW	0x101
962 #define KEY_OPEN_BACK	0x102
963 #define KEY_COMPLETE	0x103	// end of completion
964 
965 // Values for "noremap" argument of ins_typebuf().  Also used for
966 // map->m_noremap and menu->noremap[].
967 #define REMAP_YES	0	// allow remapping
968 #define REMAP_NONE	-1	// no remapping
969 #define REMAP_SCRIPT	-2	// remap script-local mappings only
970 #define REMAP_SKIP	-3	// no remapping for first char
971 
972 // Values for mch_call_shell() second argument
973 #define SHELL_FILTER	1	// filtering text
974 #define SHELL_EXPAND	2	// expanding wildcards
975 #define SHELL_COOKED	4	// set term to cooked mode
976 #define SHELL_DOOUT	8	// redirecting output
977 #define SHELL_SILENT	16	// don't print error returned by command
978 #define SHELL_READ	32	// read lines and insert into buffer
979 #define SHELL_WRITE	64	// write lines from buffer
980 
981 // Values returned by mch_nodetype()
982 #define NODE_NORMAL	0	// file or directory, check with mch_isdir()
983 #define NODE_WRITABLE	1	// something we can write to (character
984 				// device, fifo, socket, ..)
985 #define NODE_OTHER	2	// non-writable thing (e.g., block device)
986 
987 // Values for readfile() flags
988 #define READ_NEW	0x01	// read a file into a new buffer
989 #define READ_FILTER	0x02	// read filter output
990 #define READ_STDIN	0x04	// read from stdin
991 #define READ_BUFFER	0x08	// read from curbuf (converting stdin)
992 #define READ_DUMMY	0x10	// reading into a dummy buffer
993 #define READ_KEEP_UNDO	0x20	// keep undo info
994 #define READ_FIFO	0x40	// read from fifo or socket
995 #define READ_NOWINENTER 0x80	// do not trigger BufWinEnter
996 
997 // Values for change_indent()
998 #define INDENT_SET	1	// set indent
999 #define INDENT_INC	2	// increase indent
1000 #define INDENT_DEC	3	// decrease indent
1001 
1002 // Values for flags argument for findmatchlimit()
1003 #define FM_BACKWARD	0x01	// search backwards
1004 #define FM_FORWARD	0x02	// search forwards
1005 #define FM_BLOCKSTOP	0x04	// stop at start/end of block
1006 #define FM_SKIPCOMM	0x08	// skip comments
1007 
1008 // Values for action argument for do_buffer() and close_buffer()
1009 #define DOBUF_GOTO	0	// go to specified buffer
1010 #define DOBUF_SPLIT	1	// split window and go to specified buffer
1011 #define DOBUF_UNLOAD	2	// unload specified buffer(s)
1012 #define DOBUF_DEL	3	// delete specified buffer(s) from buflist
1013 #define DOBUF_WIPE	4	// delete specified buffer(s) really
1014 #define DOBUF_WIPE_REUSE 5	// like DOBUF_WIPE an keep number for reuse
1015 
1016 // Values for start argument for do_buffer()
1017 #define DOBUF_CURRENT	0	// "count" buffer from current buffer
1018 #define DOBUF_FIRST	1	// "count" buffer from first buffer
1019 #define DOBUF_LAST	2	// "count" buffer from last buffer
1020 #define DOBUF_MOD	3	// "count" mod. buffer from current buffer
1021 
1022 // Values for flags argument of do_buffer()
1023 #define DOBUF_FORCEIT	1	// :cmd!
1024 #define DOBUF_NOPOPUP	2	// skip popup window buffers
1025 
1026 // Values for sub_cmd and which_pat argument for search_regcomp()
1027 // Also used for which_pat argument for searchit()
1028 #define RE_SEARCH	0	// save/use pat in/from search_pattern
1029 #define RE_SUBST	1	// save/use pat in/from subst_pattern
1030 #define RE_BOTH		2	// save pat in both patterns
1031 #define RE_LAST		2	// use last used pattern if "pat" is NULL
1032 
1033 // Second argument for vim_regcomp().
1034 #define RE_MAGIC	1	// 'magic' option
1035 #define RE_STRING	2	// match in string instead of buffer text
1036 #define RE_STRICT	4	// don't allow [abc] without ]
1037 #define RE_AUTO		8	// automatic engine selection
1038 
1039 #ifdef FEAT_SYN_HL
1040 // values for reg_do_extmatch
1041 # define REX_SET	1	// to allow \z\(...\),
1042 # define REX_USE	2	// to allow \z\1 et al.
1043 # define REX_ALL	(REX_SET | REX_USE)
1044 #endif
1045 
1046 // Return values for fullpathcmp()
1047 // Note: can use (fullpathcmp() & FPC_SAME) to check for equal files
1048 #define FPC_SAME	1	// both exist and are the same file.
1049 #define FPC_DIFF	2	// both exist and are different files.
1050 #define FPC_NOTX	4	// both don't exist.
1051 #define FPC_DIFFX	6	// one of them doesn't exist.
1052 #define FPC_SAMEX	7	// both don't exist and file names are same.
1053 
1054 // flags for do_ecmd()
1055 #define ECMD_HIDE	0x01	// don't free the current buffer
1056 #define ECMD_SET_HELP	0x02	// set b_help flag of (new) buffer before
1057 				// opening file
1058 #define ECMD_OLDBUF	0x04	// use existing buffer if it exists
1059 #define ECMD_FORCEIT	0x08	// ! used in Ex command
1060 #define ECMD_ADDBUF	0x10	// don't edit, just add to buffer list
1061 #define ECMD_ALTBUF	0x20	// like ECMD_ADDBUF and set the alternate file
1062 #define ECMD_NOWINENTER	0x40	// do not trigger BufWinEnter
1063 
1064 // for lnum argument in do_ecmd()
1065 #define ECMD_LASTL	(linenr_T)0	// use last position in loaded file
1066 #define ECMD_LAST	(linenr_T)-1	// use last position in all files
1067 #define ECMD_ONE	(linenr_T)1	// use first line
1068 
1069 // flags for do_cmdline()
1070 #define DOCMD_VERBOSE	0x01	// included command in error message
1071 #define DOCMD_NOWAIT	0x02	// don't call wait_return() and friends
1072 #define DOCMD_REPEAT	0x04	// repeat exec. until getline() returns NULL
1073 #define DOCMD_KEYTYPED	0x08	// don't reset KeyTyped
1074 #define DOCMD_EXCRESET	0x10	// reset exception environment (for debugging)
1075 #define DOCMD_KEEPLINE  0x20	// keep typed line for repeating with "."
1076 #define DOCMD_RANGEOK	0240	// can use a range without ":" in Vim9 script
1077 
1078 // flags for beginline()
1079 #define BL_WHITE	1	// cursor on first non-white in the line
1080 #define BL_SOL		2	// use 'sol' option
1081 #define BL_FIX		4	// don't leave cursor on a NUL
1082 
1083 // flags for mf_sync()
1084 #define MFS_ALL		1	// also sync blocks with negative numbers
1085 #define MFS_STOP	2	// stop syncing when a character is available
1086 #define MFS_FLUSH	4	// flushed file to disk
1087 #define MFS_ZERO	8	// only write block 0
1088 
1089 // flags for buf_copy_options()
1090 #define BCO_ENTER	1	// going to enter the buffer
1091 #define BCO_ALWAYS	2	// always copy the options
1092 #define BCO_NOHELP	4	// don't touch the help related options
1093 
1094 // flags for do_put()
1095 #define PUT_FIXINDENT	1	// make indent look nice
1096 #define PUT_CURSEND	2	// leave cursor after end of new text
1097 #define PUT_CURSLINE	4	// leave cursor on last line of new text
1098 #define PUT_LINE	8	// put register as lines
1099 #define PUT_LINE_SPLIT	16	// split line for linewise register
1100 #define PUT_LINE_FORWARD 32	// put linewise register below Visual sel.
1101 #define PUT_BLOCK_INNER 64      // in block mode, do not add trailing spaces
1102 
1103 // flags for set_indent()
1104 #define SIN_CHANGED	1	// call changed_bytes() when line changed
1105 #define SIN_INSERT	2	// insert indent before existing text
1106 #define SIN_UNDO	4	// save line for undo before changing it
1107 
1108 // flags for insertchar()
1109 #define INSCHAR_FORMAT	1	// force formatting
1110 #define INSCHAR_DO_COM	2	// format comments
1111 #define INSCHAR_CTRLV	4	// char typed just after CTRL-V
1112 #define INSCHAR_NO_FEX	8	// don't use 'formatexpr'
1113 #define INSCHAR_COM_LIST 16	// format comments with list/2nd line indent
1114 
1115 // flags for open_line()
1116 #define OPENLINE_DELSPACES  1	// delete spaces after cursor
1117 #define OPENLINE_DO_COM	    2	// format comments
1118 #define OPENLINE_KEEPTRAIL  4	// keep trailing spaces
1119 #define OPENLINE_MARKFIX    8	// fix mark positions
1120 #define OPENLINE_COM_LIST  16	// format comments with list/2nd line indent
1121 
1122 // There are five history tables:
1123 #define HIST_CMD	0	// colon commands
1124 #define HIST_SEARCH	1	// search commands
1125 #define HIST_EXPR	2	// expressions (from entering = register)
1126 #define HIST_INPUT	3	// input() lines
1127 #define HIST_DEBUG	4	// debug commands
1128 #define HIST_COUNT	5	// number of history tables
1129 
1130 // The type numbers are fixed for backwards compatibility.
1131 #define BARTYPE_VERSION 1
1132 #define BARTYPE_HISTORY 2
1133 #define BARTYPE_REGISTER 3
1134 #define BARTYPE_MARK 4
1135 
1136 #define VIMINFO_VERSION 4
1137 #define VIMINFO_VERSION_WITH_HISTORY 2
1138 #define VIMINFO_VERSION_WITH_REGISTERS 3
1139 #define VIMINFO_VERSION_WITH_MARKS 4
1140 
1141 /*
1142  * Values for do_tag().
1143  */
1144 #define DT_TAG		1	// jump to newer position or same tag again
1145 #define DT_POP		2	// jump to older position
1146 #define DT_NEXT		3	// jump to next match of same tag
1147 #define DT_PREV		4	// jump to previous match of same tag
1148 #define DT_FIRST	5	// jump to first match of same tag
1149 #define DT_LAST		6	// jump to first match of same tag
1150 #define DT_SELECT	7	// jump to selection from list
1151 #define DT_HELP		8	// like DT_TAG, but no wildcards
1152 #define DT_JUMP		9	// jump to new tag or selection from list
1153 #define DT_CSCOPE	10	// cscope find command (like tjump)
1154 #define DT_LTAG		11	// tag using location list
1155 #define DT_FREE		99	// free cached matches
1156 
1157 /*
1158  * flags for find_tags().
1159  */
1160 #define TAG_HELP	1	// only search for help tags
1161 #define TAG_NAMES	2	// only return name of tag
1162 #define	TAG_REGEXP	4	// use tag pattern as regexp
1163 #define	TAG_NOIC	8	// don't always ignore case
1164 #ifdef FEAT_CSCOPE
1165 # define TAG_CSCOPE	16	// cscope tag
1166 #endif
1167 #define TAG_VERBOSE	32	// message verbosity
1168 #define TAG_INS_COMP	64	// Currently doing insert completion
1169 #define TAG_KEEP_LANG	128	// keep current language
1170 #define TAG_NO_TAGFUNC	256	// do not use 'tagfunc'
1171 
1172 #define TAG_MANY	300	// When finding many tags (for completion),
1173 				// find up to this many tags
1174 
1175 /*
1176  * Types of dialogs passed to do_vim_dialog().
1177  */
1178 #define VIM_GENERIC	0
1179 #define VIM_ERROR	1
1180 #define VIM_WARNING	2
1181 #define VIM_INFO	3
1182 #define VIM_QUESTION	4
1183 #define VIM_LAST_TYPE	4	// sentinel value
1184 
1185 /*
1186  * Return values for functions like gui_yesnocancel()
1187  */
1188 #define VIM_YES		2
1189 #define VIM_NO		3
1190 #define VIM_CANCEL	4
1191 #define VIM_ALL		5
1192 #define VIM_DISCARDALL  6
1193 
1194 /*
1195  * arguments for win_split()
1196  */
1197 #define WSP_ROOM	1	// require enough room
1198 #define WSP_VERT	2	// split vertically
1199 #define WSP_TOP		4	// window at top-left of shell
1200 #define WSP_BOT		8	// window at bottom-right of shell
1201 #define WSP_HELP	16	// creating the help window
1202 #define WSP_BELOW	32	// put new window below/right
1203 #define WSP_ABOVE	64	// put new window above/left
1204 #define WSP_NEWLOC	128	// don't copy location list
1205 
1206 /*
1207  * arguments for gui_set_shellsize()
1208  */
1209 #define RESIZE_VERT	1	// resize vertically
1210 #define RESIZE_HOR	2	// resize horizontally
1211 #define RESIZE_BOTH	15	// resize in both directions
1212 
1213 /*
1214  * flags for check_changed()
1215  */
1216 #define CCGD_AW		1	// do autowrite if buffer was changed
1217 #define CCGD_MULTWIN	2	// check also when several wins for the buf
1218 #define CCGD_FORCEIT	4	// ! used
1219 #define CCGD_ALLBUF	8	// may write all buffers
1220 #define CCGD_EXCMD	16	// may suggest using !
1221 
1222 /*
1223  * "flags" values for option-setting functions.
1224  * When OPT_GLOBAL and OPT_LOCAL are both missing, set both local and global
1225  * values, get local value.
1226  */
1227 #define OPT_FREE	0x01	// free old value if it was allocated
1228 #define OPT_GLOBAL	0x02	// use global value
1229 #define OPT_LOCAL	0x04	// use local value
1230 #define OPT_MODELINE	0x08	// option in modeline
1231 #define OPT_WINONLY	0x10	// only set window-local options
1232 #define OPT_NOWIN	0x20	// don't set window-local options
1233 #define OPT_ONECOLUMN	0x40	// list options one per line
1234 #define OPT_NO_REDRAW	0x80	// ignore redraw flags on option
1235 #define OPT_SKIPRTP	0x100	// "skiprtp" in 'sessionoptions'
1236 
1237 // Magic chars used in confirm dialog strings
1238 #define DLG_BUTTON_SEP	'\n'
1239 #define DLG_HOTKEY_CHAR	'&'
1240 
1241 // Values for "starting"
1242 #define NO_SCREEN	2	// no screen updating yet
1243 #define NO_BUFFERS	1	// not all buffers loaded yet
1244 //			0	   not starting anymore
1245 
1246 // Values for swap_exists_action: what to do when swap file already exists
1247 #define SEA_NONE	0	// don't use dialog
1248 #define SEA_DIALOG	1	// use dialog when possible
1249 #define SEA_QUIT	2	// quit editing the file
1250 #define SEA_RECOVER	3	// recover the file
1251 
1252 /*
1253  * Minimal size for block 0 of a swap file.
1254  * NOTE: This depends on size of struct block0! It's not done with a sizeof(),
1255  * because struct block0 is defined in memline.c (Sorry).
1256  * The maximal block size is arbitrary.
1257  */
1258 #define MIN_SWAP_PAGE_SIZE 1048
1259 #define MAX_SWAP_PAGE_SIZE 50000
1260 
1261 // Special values for current_sctx.sc_sid.
1262 #define SID_MODELINE	-1	// when using a modeline
1263 #define SID_CMDARG	-2	// for "--cmd" argument
1264 #define SID_CARG	-3	// for "-c" argument
1265 #define SID_ENV		-4	// for sourcing environment variable
1266 #define SID_ERROR	-5	// option was reset because of an error
1267 #define SID_NONE	-6	// don't set scriptID
1268 #define SID_WINLAYOUT	-7	// changing window size
1269 
1270 /*
1271  * Events for autocommands.
1272  */
1273 enum auto_event
1274 {
1275     EVENT_BUFADD = 0,		// after adding a buffer to the buffer list
1276     EVENT_BUFDELETE,		// deleting a buffer from the buffer list
1277     EVENT_BUFENTER,		// after entering a buffer
1278     EVENT_BUFFILEPOST,		// after renaming a buffer
1279     EVENT_BUFFILEPRE,		// before renaming a buffer
1280     EVENT_BUFHIDDEN,		// just after buffer becomes hidden
1281     EVENT_BUFLEAVE,		// before leaving a buffer
1282     EVENT_BUFNEW,		// after creating any buffer
1283     EVENT_BUFNEWFILE,		// when creating a buffer for a new file
1284     EVENT_BUFREADCMD,		// read buffer using command
1285     EVENT_BUFREADPOST,		// after reading a buffer
1286     EVENT_BUFREADPRE,		// before reading a buffer
1287     EVENT_BUFUNLOAD,		// just before unloading a buffer
1288     EVENT_BUFWINENTER,		// after showing a buffer in a window
1289     EVENT_BUFWINLEAVE,		// just after buffer removed from window
1290     EVENT_BUFWIPEOUT,		// just before really deleting a buffer
1291     EVENT_BUFWRITECMD,		// write buffer using command
1292     EVENT_BUFWRITEPOST,		// after writing a buffer
1293     EVENT_BUFWRITEPRE,		// before writing a buffer
1294     EVENT_CMDLINECHANGED,	// command line was modified
1295     EVENT_CMDLINEENTER,		// after entering the command line
1296     EVENT_CMDLINELEAVE,		// before leaving the command line
1297     EVENT_CMDUNDEFINED,		// command undefined
1298     EVENT_CMDWINENTER,		// after entering the cmdline window
1299     EVENT_CMDWINLEAVE,		// before leaving the cmdline window
1300     EVENT_COLORSCHEME,		// after loading a colorscheme
1301     EVENT_COLORSCHEMEPRE,	// before loading a colorscheme
1302     EVENT_COMPLETECHANGED,	// after completion popup menu changed
1303     EVENT_COMPLETEDONE,		// after finishing insert complete
1304     EVENT_COMPLETEDONEPRE,	// idem, before clearing info
1305     EVENT_CURSORHOLD,		// cursor in same position for a while
1306     EVENT_CURSORHOLDI,		// idem, in Insert mode
1307     EVENT_CURSORMOVED,		// cursor was moved
1308     EVENT_CURSORMOVEDI,		// cursor was moved in Insert mode
1309     EVENT_DIFFUPDATED,		// after diffs were updated
1310     EVENT_DIRCHANGED,		// after user changed directory
1311     EVENT_ENCODINGCHANGED,	// after changing the 'encoding' option
1312     EVENT_EXITPRE,		// before exiting
1313     EVENT_FILEAPPENDCMD,	// append to a file using command
1314     EVENT_FILEAPPENDPOST,	// after appending to a file
1315     EVENT_FILEAPPENDPRE,	// before appending to a file
1316     EVENT_FILECHANGEDRO,	// before first change to read-only file
1317     EVENT_FILECHANGEDSHELL,	// after shell command that changed file
1318     EVENT_FILECHANGEDSHELLPOST,	// after (not) reloading changed file
1319     EVENT_FILEREADCMD,		// read from a file using command
1320     EVENT_FILEREADPOST,		// after reading a file
1321     EVENT_FILEREADPRE,		// before reading a file
1322     EVENT_FILETYPE,		// new file type detected (user defined)
1323     EVENT_FILEWRITECMD,		// write to a file using command
1324     EVENT_FILEWRITEPOST,	// after writing a file
1325     EVENT_FILEWRITEPRE,		// before writing a file
1326     EVENT_FILTERREADPOST,	// after reading from a filter
1327     EVENT_FILTERREADPRE,	// before reading from a filter
1328     EVENT_FILTERWRITEPOST,	// after writing to a filter
1329     EVENT_FILTERWRITEPRE,	// before writing to a filter
1330     EVENT_FOCUSGAINED,		// got the focus
1331     EVENT_FOCUSLOST,		// lost the focus to another app
1332     EVENT_FUNCUNDEFINED,	// if calling a function which doesn't exist
1333     EVENT_GUIENTER,		// after starting the GUI
1334     EVENT_GUIFAILED,		// after starting the GUI failed
1335     EVENT_INSERTCHANGE,		// when changing Insert/Replace mode
1336     EVENT_INSERTCHARPRE,	// before inserting a char
1337     EVENT_INSERTENTER,		// when entering Insert mode
1338     EVENT_INSERTLEAVEPRE,	// just before leaving Insert mode
1339     EVENT_INSERTLEAVE,		// just after leaving Insert mode
1340     EVENT_MENUPOPUP,		// just before popup menu is displayed
1341     EVENT_MODECHANGED,		// after changing the mode
1342     EVENT_OPTIONSET,		// option was set
1343     EVENT_QUICKFIXCMDPOST,	// after :make, :grep etc.
1344     EVENT_QUICKFIXCMDPRE,	// before :make, :grep etc.
1345     EVENT_QUITPRE,		// before :quit
1346     EVENT_REMOTEREPLY,		// upon string reception from a remote vim
1347     EVENT_SAFESTATE,		// going to wait for a character
1348     EVENT_SAFESTATEAGAIN,	// still waiting for a character
1349     EVENT_SESSIONLOADPOST,	// after loading a session file
1350     EVENT_SHELLCMDPOST,		// after ":!cmd"
1351     EVENT_SHELLFILTERPOST,	// after ":1,2!cmd", ":w !cmd", ":r !cmd".
1352     EVENT_SIGUSR1,		// after the SIGUSR1 signal
1353     EVENT_SOURCECMD,		// sourcing a Vim script using command
1354     EVENT_SOURCEPRE,		// before sourcing a Vim script
1355     EVENT_SOURCEPOST,		// after sourcing a Vim script
1356     EVENT_SPELLFILEMISSING,	// spell file missing
1357     EVENT_STDINREADPOST,	// after reading from stdin
1358     EVENT_STDINREADPRE,		// before reading from stdin
1359     EVENT_SWAPEXISTS,		// found existing swap file
1360     EVENT_SYNTAX,		// syntax selected
1361     EVENT_TABCLOSED,		// after closing a tab page
1362     EVENT_TABENTER,		// after entering a tab page
1363     EVENT_TABLEAVE,		// before leaving a tab page
1364     EVENT_TABNEW,		// when entering a new tab page
1365     EVENT_TERMCHANGED,		// after changing 'term'
1366     EVENT_TERMINALOPEN,		// after a terminal buffer was created
1367     EVENT_TERMINALWINOPEN,	// after a terminal buffer was created and
1368 				// entering its window
1369     EVENT_TERMRESPONSE,		// after setting "v:termresponse"
1370     EVENT_TEXTCHANGED,		// text was modified not in Insert mode
1371     EVENT_TEXTCHANGEDI,         // text was modified in Insert mode
1372     EVENT_TEXTCHANGEDP,         // TextChangedI with popup menu visible
1373     EVENT_TEXTYANKPOST,		// after some text was yanked
1374     EVENT_USER,			// user defined autocommand
1375     EVENT_VIMENTER,		// after starting Vim
1376     EVENT_VIMLEAVE,		// before exiting Vim
1377     EVENT_VIMLEAVEPRE,		// before exiting Vim and writing .viminfo
1378     EVENT_VIMRESIZED,		// after Vim window was resized
1379     EVENT_WINENTER,		// after entering a window
1380     EVENT_WINLEAVE,		// before leaving a window
1381     EVENT_WINNEW,		// when entering a new window
1382     EVENT_WINCLOSED,		// after closing a window
1383     EVENT_VIMSUSPEND,		// before Vim is suspended
1384     EVENT_VIMRESUME,		// after Vim is resumed
1385 
1386     NUM_EVENTS			// MUST be the last one
1387 };
1388 
1389 typedef enum auto_event event_T;
1390 
1391 /*
1392  * Values for index in highlight_attr[].
1393  * When making changes, also update HL_FLAGS below!  And update the default
1394  * value of 'highlight' in option.c.
1395  */
1396 typedef enum
1397 {
1398     HLF_8 = 0	    // Meta & special keys listed with ":map", text that is
1399 		    // displayed different from what it is
1400     , HLF_EOB	    // after the last line in the buffer
1401     , HLF_AT	    // @ characters at end of screen, characters that
1402 		    // don't really exist in the text
1403     , HLF_D	    // directories in CTRL-D listing
1404     , HLF_E	    // error messages
1405     , HLF_H	    // obsolete, ignored
1406     , HLF_I	    // incremental search
1407     , HLF_L	    // last search string
1408     , HLF_M	    // "--More--" message
1409     , HLF_CM	    // Mode (e.g., "-- INSERT --")
1410     , HLF_N	    // line number for ":number" and ":#" commands
1411     , HLF_LNA	    // LineNrAbove
1412     , HLF_LNB	    // LineNrBelow
1413     , HLF_CLN	    // current line number
1414     , HLF_R	    // return to continue message and yes/no questions
1415     , HLF_S	    // status lines
1416     , HLF_SNC	    // status lines of not-current windows
1417     , HLF_C	    // column to separate vertically split windows
1418     , HLF_T	    // Titles for output from ":set all", ":autocmd" etc.
1419     , HLF_V	    // Visual mode
1420     , HLF_VNC	    // Visual mode, autoselecting and not clipboard owner
1421     , HLF_W	    // warning messages
1422     , HLF_WM	    // Wildmenu highlight
1423     , HLF_FL	    // Folded line
1424     , HLF_FC	    // Fold column
1425     , HLF_ADD	    // Added diff line
1426     , HLF_CHD	    // Changed diff line
1427     , HLF_DED	    // Deleted diff line
1428     , HLF_TXD	    // Text Changed in diff line
1429     , HLF_CONCEAL   // Concealed text
1430     , HLF_SC	    // Sign column
1431     , HLF_SPB	    // SpellBad
1432     , HLF_SPC	    // SpellCap
1433     , HLF_SPR	    // SpellRare
1434     , HLF_SPL	    // SpellLocal
1435     , HLF_PNI	    // popup menu normal item
1436     , HLF_PSI	    // popup menu selected item
1437     , HLF_PSB	    // popup menu scrollbar
1438     , HLF_PST	    // popup menu scrollbar thumb
1439     , HLF_TP	    // tabpage line
1440     , HLF_TPS	    // tabpage line selected
1441     , HLF_TPF	    // tabpage line filler
1442     , HLF_CUC	    // 'cursorcolumn'
1443     , HLF_CUL	    // 'cursorline'
1444     , HLF_MC	    // 'colorcolumn'
1445     , HLF_QFL	    // quickfix window line currently selected
1446     , HLF_ST	    // status lines of terminal windows
1447     , HLF_STNC	    // status lines of not-current terminal windows
1448     , HLF_COUNT	    // MUST be the last one
1449 } hlf_T;
1450 
1451 // The HL_FLAGS must be in the same order as the HLF_ enums!
1452 // When changing this also adjust the default for 'highlight'.
1453 #define HL_FLAGS {'8', '~', '@', 'd', 'e', 'h', 'i', 'l', 'm', 'M', \
1454 		  'n', 'a', 'b', 'N', 'r', 's', 'S', 'c', 't', 'v', 'V', \
1455 		  'w', 'W', 'f', 'F', 'A', 'C', 'D', 'T', '-', '>', \
1456 		  'B', 'P', 'R', 'L', \
1457 		  '+', '=', 'x', 'X', '*', '#', '_', '!', '.', 'o', 'q', \
1458 		  'z', 'Z'}
1459 
1460 /*
1461  * Boolean constants
1462  */
1463 #ifndef TRUE
1464 # define FALSE	0	    // note: this is an int, not a long!
1465 # define TRUE	1
1466 #endif
1467 
1468 #define MAYBE	2	    // sometimes used for a variant on TRUE
1469 
1470 #ifndef UINT32_T
1471 typedef UINT32_TYPEDEF UINT32_T;
1472 #endif
1473 
1474 /*
1475  * Operator IDs; The order must correspond to opchars[] in ops.c!
1476  */
1477 #define OP_NOP		0	// no pending operation
1478 #define OP_DELETE	1	// "d"  delete operator
1479 #define OP_YANK		2	// "y"  yank operator
1480 #define OP_CHANGE	3	// "c"  change operator
1481 #define OP_LSHIFT	4	// "<"  left shift operator
1482 #define OP_RSHIFT	5	// ">"  right shift operator
1483 #define OP_FILTER	6	// "!"  filter operator
1484 #define OP_TILDE	7	// "g~" switch case operator
1485 #define OP_INDENT	8	// "="  indent operator
1486 #define OP_FORMAT	9	// "gq" format operator
1487 #define OP_COLON	10	// ":"  colon operator
1488 #define OP_UPPER	11	// "gU" make upper case operator
1489 #define OP_LOWER	12	// "gu" make lower case operator
1490 #define OP_JOIN		13	// "J"  join operator, only for Visual mode
1491 #define OP_JOIN_NS	14	// "gJ"  join operator, only for Visual mode
1492 #define OP_ROT13	15	// "g?" rot-13 encoding
1493 #define OP_REPLACE	16	// "r"  replace chars, only for Visual mode
1494 #define OP_INSERT	17	// "I"  Insert column, only for Visual mode
1495 #define OP_APPEND	18	// "A"  Append column, only for Visual mode
1496 #define OP_FOLD		19	// "zf" define a fold
1497 #define OP_FOLDOPEN	20	// "zo" open folds
1498 #define OP_FOLDOPENREC	21	// "zO" open folds recursively
1499 #define OP_FOLDCLOSE	22	// "zc" close folds
1500 #define OP_FOLDCLOSEREC	23	// "zC" close folds recursively
1501 #define OP_FOLDDEL	24	// "zd" delete folds
1502 #define OP_FOLDDELREC	25	// "zD" delete folds recursively
1503 #define OP_FORMAT2	26	// "gw" format operator, keeps cursor pos
1504 #define OP_FUNCTION	27	// "g@" call 'operatorfunc'
1505 #define OP_NR_ADD	28	// "<C-A>" Add to the number or alphabetic
1506 				// character (OP_ADD conflicts with Perl)
1507 #define OP_NR_SUB	29	// "<C-X>" Subtract from the number or
1508 				// alphabetic character
1509 
1510 /*
1511  * Motion types, used for operators and for yank/delete registers.
1512  */
1513 #define MCHAR	0		// character-wise movement/register
1514 #define MLINE	1		// line-wise movement/register
1515 #define MBLOCK	2		// block-wise register
1516 
1517 #define MAUTO	0xff		// Decide between MLINE/MCHAR
1518 
1519 /*
1520  * Minimum screen size
1521  */
1522 #define MIN_COLUMNS	12	// minimal columns for screen
1523 #define MIN_LINES	2	// minimal lines for screen
1524 #define STATUS_HEIGHT	1	// height of a status line under a window
1525 #ifdef FEAT_MENU		// height of a status line under a window
1526 # define WINBAR_HEIGHT(wp)	(wp)->w_winbar_height
1527 # define VISIBLE_HEIGHT(wp)	((wp)->w_height + (wp)->w_winbar_height)
1528 #else
1529 # define WINBAR_HEIGHT(wp)	0
1530 # define VISIBLE_HEIGHT(wp)	(wp)->w_height
1531 #endif
1532 #define QF_WINHEIGHT	10	// default height for quickfix window
1533 
1534 /*
1535  * Buffer sizes
1536  */
1537 #ifndef CMDBUFFSIZE
1538 # define CMDBUFFSIZE	256	// size of the command processing buffer
1539 #endif
1540 
1541 #define LSIZE	    512		// max. size of a line in the tags file
1542 
1543 #define IOSIZE	   (1024+1)	// file i/o and sprintf buffer size
1544 
1545 #define DIALOG_MSG_SIZE 1000	// buffer size for dialog_msg()
1546 
1547 #define MSG_BUF_LEN 480	// length of buffer for small messages
1548 #define MSG_BUF_CLEN  (MSG_BUF_LEN / 6)    // cell length (worst case: utf-8
1549 					   // takes 6 bytes for one cell)
1550 
1551 #define FOLD_TEXT_LEN  51	// buffer size for get_foldtext()
1552 
1553 // Size of the buffer used for tgetent().  Unfortunately this is largely
1554 // undocumented, some systems use 1024.  Using a buffer that is too small
1555 // causes a buffer overrun and a crash.  Use the maximum known value to stay
1556 // on the safe side.
1557 #define TBUFSZ 2048		// buffer size for termcap entry
1558 
1559 /*
1560  * Maximum length of key sequence to be mapped.
1561  * Must be able to hold an Amiga resize report.
1562  */
1563 #define MAXMAPLEN   50
1564 
1565 // Size in bytes of the hash used in the undo file.
1566 #define UNDO_HASH_SIZE 32
1567 
1568 #ifdef HAVE_FCNTL_H
1569 # include <fcntl.h>
1570 #endif
1571 
1572 #ifdef BINARY_FILE_IO
1573 # define WRITEBIN   "wb"	// no CR-LF translation
1574 # define READBIN    "rb"
1575 # define APPENDBIN  "ab"
1576 #else
1577 # define WRITEBIN   "w"
1578 # define READBIN    "r"
1579 # define APPENDBIN  "a"
1580 #endif
1581 
1582 /*
1583  * EMX doesn't have a global way of making open() use binary I/O.
1584  * Use O_BINARY for all open() calls.
1585  */
1586 #if defined(__CYGWIN32__)
1587 # define O_EXTRA    O_BINARY
1588 #else
1589 # define O_EXTRA    0
1590 #endif
1591 
1592 #ifndef O_NOFOLLOW
1593 # define O_NOFOLLOW 0
1594 #endif
1595 
1596 #ifndef W_OK
1597 # define W_OK 2		// for systems that don't have W_OK in unistd.h
1598 #endif
1599 #ifndef R_OK
1600 # define R_OK 4		// for systems that don't have R_OK in unistd.h
1601 #endif
1602 
1603 // Allocate memory for one type and cast the returned pointer to have the
1604 // compiler check the types.
1605 #define ALLOC_ONE(type)  (type *)alloc(sizeof(type))
1606 #define ALLOC_MULT(type, count)  (type *)alloc(sizeof(type) * (count))
1607 #define ALLOC_CLEAR_ONE(type)  (type *)alloc_clear(sizeof(type))
1608 #define ALLOC_CLEAR_MULT(type, count)  (type *)alloc_clear(sizeof(type) * (count))
1609 #define LALLOC_CLEAR_ONE(type)  (type *)lalloc_clear(sizeof(type), FALSE)
1610 #define LALLOC_CLEAR_MULT(type, count)  (type *)lalloc_clear(sizeof(type) * (count), FALSE)
1611 #define LALLOC_MULT(type, count)  (type *)lalloc(sizeof(type) * (count), FALSE)
1612 
1613 #ifdef HAVE_MEMSET
1614 # define vim_memset(ptr, c, size)   memset((ptr), (c), (size))
1615 #else
1616 void *vim_memset(void *, int, size_t);
1617 #endif
1618 #define CLEAR_FIELD(field)  vim_memset(&(field), 0, sizeof(field))
1619 #define CLEAR_POINTER(ptr)  vim_memset((ptr), 0, sizeof(*(ptr)))
1620 
1621 /*
1622  * defines to avoid typecasts from (char_u *) to (char *) and back
1623  * (vim_strchr() and vim_strrchr() are now in alloc.c)
1624  */
1625 #define STRLEN(s)	    strlen((char *)(s))
1626 #define STRCPY(d, s)	    strcpy((char *)(d), (char *)(s))
1627 #define STRNCPY(d, s, n)    strncpy((char *)(d), (char *)(s), (size_t)(n))
1628 #define STRCMP(d, s)	    strcmp((char *)(d), (char *)(s))
1629 #define STRNCMP(d, s, n)    strncmp((char *)(d), (char *)(s), (size_t)(n))
1630 #ifdef HAVE_STRCASECMP
1631 # define STRICMP(d, s)	    strcasecmp((char *)(d), (char *)(s))
1632 #else
1633 # ifdef HAVE_STRICMP
1634 #  define STRICMP(d, s)	    stricmp((char *)(d), (char *)(s))
1635 # else
1636 #  define STRICMP(d, s)	    vim_stricmp((char *)(d), (char *)(s))
1637 # endif
1638 #endif
1639 #ifdef HAVE_STRCOLL
1640 # define STRCOLL(d, s)     strcoll((char *)(d), (char *)(s))
1641 #else
1642 # define STRCOLL(d, s)     strcmp((char *)(d), (char *)(s))
1643 #endif
1644 
1645 // Like strcpy() but allows overlapped source and destination.
1646 #define STRMOVE(d, s)	    mch_memmove((d), (s), STRLEN(s) + 1)
1647 
1648 #ifdef HAVE_STRNCASECMP
1649 # define STRNICMP(d, s, n)  strncasecmp((char *)(d), (char *)(s), (size_t)(n))
1650 #else
1651 # ifdef HAVE_STRNICMP
1652 #  define STRNICMP(d, s, n) strnicmp((char *)(d), (char *)(s), (size_t)(n))
1653 # else
1654 #  define STRNICMP(d, s, n) vim_strnicmp((char *)(d), (char *)(s), (size_t)(n))
1655 # endif
1656 #endif
1657 
1658 // We need to call mb_stricmp() even when we aren't dealing with a multi-byte
1659 // encoding because mb_stricmp() takes care of all ascii and non-ascii
1660 // encodings, including characters with umlauts in latin1, etc., while
1661 // STRICMP() only handles the system locale version, which often does not
1662 // handle non-ascii properly.
1663 
1664 # define MB_STRICMP(d, s)	mb_strnicmp((char_u *)(d), (char_u *)(s), (int)MAXCOL)
1665 # define MB_STRNICMP(d, s, n)	mb_strnicmp((char_u *)(d), (char_u *)(s), (int)(n))
1666 
1667 #define STRCAT(d, s)	    strcat((char *)(d), (char *)(s))
1668 #define STRNCAT(d, s, n)    strncat((char *)(d), (char *)(s), (size_t)(n))
1669 
1670 #ifdef HAVE_STRPBRK
1671 # define vim_strpbrk(s, cs) (char_u *)strpbrk((char *)(s), (char *)(cs))
1672 #endif
1673 
1674 #define OUT_STR(s)		    out_str((char_u *)(s))
1675 #define OUT_STR_NF(s)		    out_str_nf((char_u *)(s))
1676 
1677 #ifdef FEAT_GUI
1678 # ifdef FEAT_TERMGUICOLORS
1679 #  define GUI_FUNCTION(f)	    (gui.in_use ? gui_##f : termgui_##f)
1680 #  define GUI_FUNCTION2(f, pixel)   (gui.in_use \
1681 				    ?  ((pixel) != INVALCOLOR \
1682 					? gui_##f((pixel)) \
1683 					: INVALCOLOR) \
1684 				    : termgui_##f((pixel)))
1685 #  define USE_24BIT		    (gui.in_use || p_tgc)
1686 # else
1687 #  define GUI_FUNCTION(f)	    gui_##f
1688 #  define GUI_FUNCTION2(f,pixel)    ((pixel) != INVALCOLOR \
1689 				     ? gui_##f((pixel)) \
1690 				     : INVALCOLOR)
1691 #  define USE_24BIT		    gui.in_use
1692 # endif
1693 #else
1694 # ifdef FEAT_TERMGUICOLORS
1695 #  define GUI_FUNCTION(f)	    termgui_##f
1696 #  define GUI_FUNCTION2(f, pixel)   termgui_##f((pixel))
1697 #  define USE_24BIT		    p_tgc
1698 # endif
1699 #endif
1700 #ifdef FEAT_TERMGUICOLORS
1701 # define IS_CTERM		    (t_colors > 1 || p_tgc)
1702 #else
1703 # define IS_CTERM		    (t_colors > 1)
1704 #endif
1705 #ifdef GUI_FUNCTION
1706 # define GUI_MCH_GET_RGB	    GUI_FUNCTION(mch_get_rgb)
1707 # define GUI_MCH_GET_RGB2(pixel)    GUI_FUNCTION2(mch_get_rgb, (pixel))
1708 # define GUI_MCH_GET_COLOR	    GUI_FUNCTION(mch_get_color)
1709 # define GUI_GET_COLOR		    GUI_FUNCTION(get_color)
1710 #endif
1711 
1712 // Prefer using emsgf(), because perror() may send the output to the wrong
1713 // destination and mess up the screen.
1714 #ifdef HAVE_STRERROR
1715 # define PERROR(msg)		    (void)semsg("%s: %s", (char *)msg, strerror(errno))
1716 #else
1717 # define PERROR(msg)		    do_perror(msg)
1718 #endif
1719 
1720 typedef long	linenr_T;		// line number type
1721 typedef int	colnr_T;		// column number type
1722 typedef unsigned short disptick_T;	// display tick type
1723 
1724 /*
1725  * Well, you won't believe it, but some S/390 machines ("host", now also known
1726  * as zServer) use 31 bit pointers. There are also some newer machines, that
1727  * use 64 bit pointers. I don't know how to distinguish between 31 and 64 bit
1728  * machines, so the best way is to assume 31 bits whenever we detect OS/390
1729  * Unix.
1730  * With this we restrict the maximum line length to 1073741823. I guess this is
1731  * not a real problem. BTW:  Longer lines are split.
1732  */
1733 #ifdef __MVS__
1734 # define MAXCOL (0x3fffffffL)		// maximum column number, 30 bits
1735 # define MAXLNUM (0x3fffffffL)		// maximum (invalid) line number
1736 #else
1737 # define MAXCOL  INT_MAX		// maximum column number
1738 # define MAXLNUM LONG_MAX		// maximum (invalid) line number
1739 #endif
1740 
1741 #define SHOWCMD_COLS 10			// columns needed by shown command
1742 
1743 typedef void	    *vim_acl_T;		// dummy to pass an ACL to a function
1744 
1745 #ifndef mch_memmove
1746 # define mch_memmove(to, from, len) memmove((char*)(to), (char*)(from), (size_t)(len))
1747 #endif
1748 
1749 /*
1750  * fnamecmp() is used to compare file names.
1751  * On some systems case in a file name does not matter, on others it does.
1752  * (this does not account for maximum name lengths and things like "../dir",
1753  * thus it is not 100% accurate!)
1754  */
1755 #define fnamecmp(x, y) vim_fnamecmp((char_u *)(x), (char_u *)(y))
1756 #define fnamencmp(x, y, n) vim_fnamencmp((char_u *)(x), (char_u *)(y), (size_t)(n))
1757 
1758 #if defined(UNIX) || defined(FEAT_GUI) || defined(VMS) \
1759 	|| defined(FEAT_CLIENTSERVER)
1760 # define USE_INPUT_BUF
1761 #endif
1762 
1763 #ifndef EINTR
1764 # define read_eintr(fd, buf, count) vim_read((fd), (buf), (count))
1765 # define write_eintr(fd, buf, count) vim_write((fd), (buf), (count))
1766 #endif
1767 
1768 #ifdef MSWIN
1769 // On MS-Windows the third argument isn't size_t.  This matters for Win64,
1770 // where sizeof(size_t)==8, not 4
1771 # define vim_read(fd, buf, count)   read((fd), (char *)(buf), (unsigned int)(count))
1772 # define vim_write(fd, buf, count)  write((fd), (char *)(buf), (unsigned int)(count))
1773 #else
1774 # define vim_read(fd, buf, count)   read((fd), (char *)(buf), (size_t) (count))
1775 # define vim_write(fd, buf, count)  write((fd), (char *)(buf), (size_t) (count))
1776 #endif
1777 
1778 /*
1779  * Enums need a typecast to be used as array index (for Ultrix).
1780  */
1781 #define HL_ATTR(n)	highlight_attr[(int)(n)]
1782 #define TERM_STR(n)	term_strings[(int)(n)]
1783 
1784 /*
1785  * EXTERN is only defined in main.c.  That's where global variables are
1786  * actually defined and initialized.
1787  */
1788 #ifndef EXTERN
1789 # define EXTERN extern
1790 # define INIT(x)
1791 # define INIT2(a, b)
1792 # define INIT3(a, b, c)
1793 # define INIT4(a, b, c, d)
1794 # define INIT5(a, b, c, d, e)
1795 # define INIT6(a, b, c, d, e, f)
1796 #else
1797 # ifndef INIT
1798 #  define INIT(x) x
1799 #  define INIT2(a, b) = {a, b}
1800 #  define INIT3(a, b, c) = {a, b, c}
1801 #  define INIT4(a, b, c, d) = {a, b, c, d}
1802 #  define INIT5(a, b, c, d, e) = {a, b, c, d, e}
1803 #  define INIT6(a, b, c, d, e, f) = {a, b, c, d, e, f}
1804 #  define DO_INIT
1805 # endif
1806 #endif
1807 
1808 #define MAX_MCO	6	// maximum value for 'maxcombine'
1809 
1810 // Maximum number of bytes in a multi-byte character.  It can be one 32-bit
1811 // character of up to 6 bytes, or one 16-bit character of up to three bytes
1812 // plus six following composing characters of three bytes each.
1813 #define MB_MAXBYTES	21
1814 
1815 #if (defined(FEAT_PROFILE) || defined(FEAT_RELTIME)) && !defined(PROTO)
1816 # ifdef MSWIN
1817 typedef LARGE_INTEGER proftime_T;
1818 # else
1819 typedef struct timeval proftime_T;
1820 # endif
1821 #else
1822 typedef int proftime_T;	    // dummy for function prototypes
1823 #endif
1824 
1825 // Type of compilation passed to compile_def_function()
1826 typedef enum {
1827     CT_NONE,	    // use df_instr
1828     CT_PROFILE,	    // use df_instr_prof
1829     CT_DEBUG	    // use df_instr_debug, overrules CT_PROFILE
1830 } compiletype_T;
1831 
1832 // Keep in sync with INSTRUCTIONS().
1833 #ifdef FEAT_PROFILE
1834 # define COMPILE_TYPE(ufunc) (debug_break_level > 0 \
1835 	|| may_break_in_function(ufunc) \
1836 		? CT_DEBUG \
1837 		: do_profiling == PROF_YES && (ufunc)->uf_profiling \
1838 			? CT_PROFILE : CT_NONE)
1839 #else
1840 # define COMPILE_TYPE(ufunc) debug_break_level > 0 \
1841 	|| may_break_in_function(ufunc) \
1842 		? CT_DEBUG \
1843 		: CT_NONE
1844 #endif
1845 
1846 /*
1847  * When compiling with 32 bit Perl time_t is 32 bits in the Perl code but 64
1848  * bits elsewhere.  That causes memory corruption.  Define time_T and use it
1849  * for global variables to avoid that.
1850  */
1851 #ifdef PROTO
1852 typedef long  time_T;
1853 #else
1854 # ifdef MSWIN
1855 typedef __time64_t  time_T;
1856 # else
1857 typedef time_t	    time_T;
1858 # endif
1859 #endif
1860 
1861 #ifdef _WIN64
1862 typedef __int64 sock_T;
1863 #else
1864 typedef int sock_T;
1865 #endif
1866 
1867 // Include option.h before structs.h, because the number of window-local and
1868 // buffer-local options is used there.
1869 #include "option.h"	// options and default values
1870 
1871 #include "beval.h"	// BalloonEval
1872 
1873 // Note that gui.h is included by structs.h
1874 
1875 #include "structs.h"	// defines many structures
1876 
1877 #include "alloc.h"
1878 
1879 // Values for "do_profiling".
1880 #define PROF_NONE	0	// profiling not started
1881 #define PROF_YES	1	// profiling busy
1882 #define PROF_PAUSED	2	// profiling paused
1883 
1884 
1885 // Codes for mouse button events in lower three bits:
1886 #define MOUSE_LEFT	0x00
1887 #define MOUSE_MIDDLE	0x01
1888 #define MOUSE_RIGHT	0x02
1889 #define MOUSE_RELEASE	0x03
1890 
1891 // bit masks for modifiers:
1892 #define MOUSE_SHIFT	0x04
1893 #define MOUSE_ALT	0x08
1894 #define MOUSE_CTRL	0x10
1895 
1896 // mouse buttons that are handled like a key press (GUI only)
1897 // Note that the scroll wheel keys are inverted: MOUSE_5 scrolls lines up but
1898 // the result of this is that the window moves down, similarly MOUSE_6 scrolls
1899 // columns left but the window moves right.
1900 #define MOUSE_4	0x100	// scroll wheel down
1901 #define MOUSE_5	0x200	// scroll wheel up
1902 
1903 #define MOUSE_X1	0x300 // Mouse-button X1 (6th)
1904 #define MOUSE_X2	0x400 // Mouse-button X2
1905 
1906 #define MOUSE_6	0x500	// scroll wheel left
1907 #define MOUSE_7	0x600	// scroll wheel right
1908 
1909 #define MOUSE_MOVE 0x700    // report mouse moved
1910 
1911 // 0x20 is reserved by xterm
1912 #define MOUSE_DRAG_XTERM   0x40
1913 
1914 #define MOUSE_DRAG	(0x40 | MOUSE_RELEASE)
1915 
1916 // Lowest button code for using the mouse wheel (xterm only)
1917 #define MOUSEWHEEL_LOW		0x60
1918 
1919 #define MOUSE_CLICK_MASK	0x03
1920 
1921 #define NUM_MOUSE_CLICKS(code) \
1922     (((unsigned)((code) & 0xC0) >> 6) + 1)
1923 
1924 #define SET_NUM_MOUSE_CLICKS(code, num) \
1925     (code) = ((code) & 0x3f) | ((((num) - 1) & 3) << 6)
1926 
1927 // Added to mouse column for GUI when 'mousefocus' wants to give focus to a
1928 // window by simulating a click on its status line.  We could use up to 128 *
1929 // 128 = 16384 columns, now it's reduced to 10000.
1930 #define MOUSE_COLOFF 10000
1931 
1932 /*
1933  * jump_to_mouse() returns one of first four these values, possibly with
1934  * some of the other three added.
1935  */
1936 #define IN_UNKNOWN		0
1937 #define IN_BUFFER		1
1938 #define IN_STATUS_LINE		2	// on status or command line
1939 #define IN_SEP_LINE		4	// on vertical separator line
1940 #define IN_OTHER_WIN		8	// in other window but can't go there
1941 #define CURSOR_MOVED		0x100
1942 #define MOUSE_FOLD_CLOSE	0x200	// clicked on '-' in fold column
1943 #define MOUSE_FOLD_OPEN		0x400	// clicked on '+' in fold column
1944 #define MOUSE_WINBAR		0x800	// in window toolbar
1945 
1946 // flags for jump_to_mouse()
1947 #define MOUSE_FOCUS		0x01	// need to stay in this window
1948 #define MOUSE_MAY_VIS		0x02	// may start Visual mode
1949 #define MOUSE_DID_MOVE		0x04	// only act when mouse has moved
1950 #define MOUSE_SETPOS		0x08	// only set current mouse position
1951 #define MOUSE_MAY_STOP_VIS	0x10	// may stop Visual mode
1952 #define MOUSE_RELEASED		0x20	// button was released
1953 
1954 #if defined(UNIX) && defined(HAVE_GETTIMEOFDAY) && defined(HAVE_SYS_TIME_H)
1955 # define CHECK_DOUBLE_CLICK 1	// Checking for double clicks ourselves.
1956 #endif
1957 
1958 
1959 // defines for eval_vars()
1960 #define VALID_PATH		1
1961 #define VALID_HEAD		2
1962 
1963 // Defines for Vim variables.  These must match vimvars[] in evalvars.c!
1964 #define VV_COUNT	0
1965 #define VV_COUNT1	1
1966 #define VV_PREVCOUNT	2
1967 #define VV_ERRMSG	3
1968 #define VV_WARNINGMSG	4
1969 #define VV_STATUSMSG	5
1970 #define VV_SHELL_ERROR	6
1971 #define VV_THIS_SESSION	7
1972 #define VV_VERSION	8
1973 #define VV_LNUM		9
1974 #define VV_TERMRESPONSE	10
1975 #define VV_FNAME	11
1976 #define VV_LANG		12
1977 #define VV_LC_TIME	13
1978 #define VV_CTYPE	14
1979 #define VV_CC_FROM	15
1980 #define VV_CC_TO	16
1981 #define VV_FNAME_IN	17
1982 #define VV_FNAME_OUT	18
1983 #define VV_FNAME_NEW	19
1984 #define VV_FNAME_DIFF	20
1985 #define VV_CMDARG	21
1986 #define VV_FOLDSTART	22
1987 #define VV_FOLDEND	23
1988 #define VV_FOLDDASHES	24
1989 #define VV_FOLDLEVEL	25
1990 #define VV_PROGNAME	26
1991 #define VV_SEND_SERVER	27
1992 #define VV_DYING	28
1993 #define VV_EXCEPTION	29
1994 #define VV_THROWPOINT	30
1995 #define VV_REG		31
1996 #define VV_CMDBANG	32
1997 #define VV_INSERTMODE	33
1998 #define VV_VAL		34
1999 #define VV_KEY		35
2000 #define VV_PROFILING	36
2001 #define VV_FCS_REASON	37
2002 #define VV_FCS_CHOICE	38
2003 #define VV_BEVAL_BUFNR	39
2004 #define VV_BEVAL_WINNR	40
2005 #define VV_BEVAL_WINID	41
2006 #define VV_BEVAL_LNUM	42
2007 #define VV_BEVAL_COL	43
2008 #define VV_BEVAL_TEXT	44
2009 #define VV_SCROLLSTART	45
2010 #define VV_SWAPNAME	46
2011 #define VV_SWAPCHOICE	47
2012 #define VV_SWAPCOMMAND	48
2013 #define VV_CHAR		49
2014 #define VV_MOUSE_WIN	50
2015 #define VV_MOUSE_WINID	51
2016 #define VV_MOUSE_LNUM   52
2017 #define VV_MOUSE_COL	53
2018 #define VV_OP		54
2019 #define VV_SEARCHFORWARD 55
2020 #define VV_HLSEARCH	56
2021 #define VV_OLDFILES	57
2022 #define VV_WINDOWID	58
2023 #define VV_PROGPATH	59
2024 #define VV_COMPLETED_ITEM 60
2025 #define VV_OPTION_NEW   61
2026 #define VV_OPTION_OLD   62
2027 #define VV_OPTION_OLDLOCAL 63
2028 #define VV_OPTION_OLDGLOBAL 64
2029 #define VV_OPTION_COMMAND 65
2030 #define VV_OPTION_TYPE  66
2031 #define VV_ERRORS	67
2032 #define VV_FALSE	68
2033 #define VV_TRUE		69
2034 #define VV_NONE		70
2035 #define VV_NULL		71
2036 #define VV_NUMBERMAX	72
2037 #define VV_NUMBERMIN	73
2038 #define VV_NUMBERSIZE	74
2039 #define VV_VIM_DID_ENTER 75
2040 #define VV_TESTING	76
2041 #define VV_TYPE_NUMBER	77
2042 #define VV_TYPE_STRING	78
2043 #define VV_TYPE_FUNC	79
2044 #define VV_TYPE_LIST	80
2045 #define VV_TYPE_DICT	81
2046 #define VV_TYPE_FLOAT	82
2047 #define VV_TYPE_BOOL	83
2048 #define VV_TYPE_NONE	84
2049 #define VV_TYPE_JOB	85
2050 #define VV_TYPE_CHANNEL	86
2051 #define VV_TYPE_BLOB	87
2052 #define VV_TERMRFGRESP	88
2053 #define VV_TERMRBGRESP	89
2054 #define VV_TERMU7RESP	90
2055 #define VV_TERMSTYLERESP 91
2056 #define VV_TERMBLINKRESP 92
2057 #define VV_EVENT	93
2058 #define VV_VERSIONLONG	94
2059 #define VV_ECHOSPACE	95
2060 #define VV_ARGV		96
2061 #define VV_COLLATE      97
2062 #define VV_EXITING	98
2063 #define VV_COLORNAMES   99
2064 #define VV_SIZEOFINT	100
2065 #define VV_SIZEOFLONG	101
2066 #define VV_SIZEOFPOINTER 102
2067 #define VV_LEN		103	// number of v: vars
2068 
2069 // used for v_number in VAR_BOOL and VAR_SPECIAL
2070 #define VVAL_FALSE	0L	// VAR_BOOL
2071 #define VVAL_TRUE	1L	// VAR_BOOL
2072 #define VVAL_NONE	2L	// VAR_SPECIAL
2073 #define VVAL_NULL	3L	// VAR_SPECIAL
2074 
2075 // Type values for type().
2076 #define VAR_TYPE_NUMBER	    0
2077 #define VAR_TYPE_STRING	    1
2078 #define VAR_TYPE_FUNC	    2
2079 #define VAR_TYPE_LIST	    3
2080 #define VAR_TYPE_DICT	    4
2081 #define VAR_TYPE_FLOAT	    5
2082 #define VAR_TYPE_BOOL	    6
2083 #define VAR_TYPE_NONE	    7
2084 #define VAR_TYPE_JOB	    8
2085 #define VAR_TYPE_CHANNEL    9
2086 #define VAR_TYPE_BLOB	    10
2087 #define VAR_TYPE_INSTR	    11
2088 
2089 #define DICT_MAXNEST 100	// maximum nesting of lists and dicts
2090 
2091 #ifdef FEAT_CLIPBOARD
2092 
2093 // VIM_ATOM_NAME is the older Vim-specific selection type for X11.  Still
2094 // supported for when a mix of Vim versions is used. VIMENC_ATOM_NAME includes
2095 // the encoding to support Vims using different 'encoding' values.
2096 # define VIM_ATOM_NAME "_VIM_TEXT"
2097 # define VIMENC_ATOM_NAME "_VIMENC_TEXT"
2098 
2099 // Selection states for modeless selection
2100 # define SELECT_CLEARED		0
2101 # define SELECT_IN_PROGRESS	1
2102 # define SELECT_DONE		2
2103 
2104 # define SELECT_MODE_CHAR	0
2105 # define SELECT_MODE_WORD	1
2106 # define SELECT_MODE_LINE	2
2107 
2108 # ifdef FEAT_GUI_MSWIN
2109 #  ifdef FEAT_OLE
2110 #   define WM_OLE (WM_APP+0)
2111 #  endif
2112 # endif
2113 
2114 // Info about selected text
2115 typedef struct
2116 {
2117     int		available;	// Is clipboard available?
2118     int		owned;		// Flag: do we own the selection?
2119     pos_T	start;		// Start of selected area
2120     pos_T	end;		// End of selected area
2121     int		vmode;		// Visual mode character
2122 
2123     // Fields for selection that doesn't use Visual mode
2124     short_u	origin_row;
2125     short_u	origin_start_col;
2126     short_u	origin_end_col;
2127     short_u	word_start_col;
2128     short_u	word_end_col;
2129 #ifdef FEAT_PROP_POPUP
2130     // limits for selection inside a popup window
2131     short_u	min_col;
2132     short_u	max_col;
2133     short_u	min_row;
2134     short_u	max_row;
2135 #endif
2136 
2137     pos_T	prev;		// Previous position
2138     short_u	state;		// Current selection state
2139     short_u	mode;		// Select by char, word, or line.
2140 
2141 # if defined(FEAT_GUI_X11) || defined(FEAT_XCLIPBOARD)
2142     Atom	sel_atom;	// PRIMARY/CLIPBOARD selection ID
2143 # endif
2144 
2145 # ifdef FEAT_GUI_GTK
2146     GdkAtom     gtk_sel_atom;	// PRIMARY/CLIPBOARD selection ID
2147 # endif
2148 
2149 # if defined(MSWIN) || defined(FEAT_CYGWIN_WIN32_CLIPBOARD)
2150     int_u	format;		// Vim's own special clipboard format
2151     int_u	format_raw;	// Vim's raw text clipboard format
2152 # endif
2153 # ifdef FEAT_GUI_HAIKU
2154     // No clipboard at the moment. TODO?
2155 # endif
2156 } Clipboard_T;
2157 #else
2158 typedef int Clipboard_T;	// This is required for the prototypes.
2159 #endif
2160 
2161 // Use 64-bit stat structure if available.
2162 #if (defined(_MSC_VER) && (_MSC_VER >= 1300)) || defined(__MINGW32__)
2163 # define HAVE_STAT64
2164 typedef struct _stat64 stat_T;
2165 #else
2166 typedef struct stat stat_T;
2167 #endif
2168 
2169 #if (defined(__GNUC__) || defined(__clang__)) && !defined(__MINGW32__)
2170 # define ATTRIBUTE_FORMAT_PRINTF(fmt_idx, arg_idx) \
2171     __attribute__((format(printf, fmt_idx, arg_idx)))
2172 #else
2173 # define ATTRIBUTE_FORMAT_PRINTF(fmt_idx, arg_idx)
2174 #endif
2175 
2176 #if defined(__GNUC__) || defined(__clang__)
2177 # define likely(x)      __builtin_expect((x), 1)
2178 # define unlikely(x)    __builtin_expect((x), 0)
2179 # define ATTRIBUTE_COLD __attribute__((cold))
2180 #else
2181 # define unlikely(x)  (x)
2182 # define likely(x)    (x)
2183 # define ATTRIBUTE_COLD
2184 #endif
2185 
2186 typedef enum {
2187     ASSERT_EQUAL,
2188     ASSERT_NOTEQUAL,
2189     ASSERT_MATCH,
2190     ASSERT_NOTMATCH,
2191     ASSERT_OTHER
2192 } assert_type_T;
2193 
2194 // Mode for bracketed_paste().
2195 typedef enum {
2196     PASTE_INSERT,	// insert mode
2197     PASTE_CMDLINE,	// command line
2198     PASTE_EX,		// ex mode line
2199     PASTE_ONE_CHAR	// return first character
2200 } paste_mode_T;
2201 
2202 // Argument for flush_buffers().
2203 typedef enum {
2204     FLUSH_MINIMAL,
2205     FLUSH_TYPEAHEAD,	// flush current typebuf contents
2206     FLUSH_INPUT		// flush typebuf and inchar() input
2207 } flush_buffers_T;
2208 
2209 // Argument for prepare_tagpreview()
2210 typedef enum {
2211     USEPOPUP_NONE,
2212     USEPOPUP_NORMAL,	// use info popup
2213     USEPOPUP_HIDDEN	// use info popup initially hidden
2214 } use_popup_T;
2215 
2216 // Argument for estack_sfile().
2217 typedef enum {
2218     ESTACK_NONE,
2219     ESTACK_SFILE,
2220     ESTACK_STACK
2221 } estack_arg_T;
2222 
2223 // Flags for assignment functions.
2224 #define ASSIGN_FINAL	0x01  // ":final"
2225 #define ASSIGN_CONST	0x02  // ":const"
2226 #define ASSIGN_NO_DECL	0x04  // "name = expr" without ":let"/":const"/":final"
2227 #define ASSIGN_DECL	0x08  // may declare variable if it does not exist
2228 #define ASSIGN_UNPACK	0x10  // using [a, b] = list
2229 #define ASSIGN_NO_MEMBER_TYPE 0x20 // use "any" for list and dict member type
2230 #define ASSIGN_FOR_LOOP 0x40 // assigning to loop variable
2231 
2232 #include "ex_cmds.h"	    // Ex command defines
2233 #include "spell.h"	    // spell checking stuff
2234 
2235 #include "proto.h"	    // function prototypes
2236 
2237 // This has to go after the include of proto.h, as proto/gui.pro declares
2238 // functions of these names. The declarations would break if the defines had
2239 // been seen at that stage.  But it must be before globals.h, where error_ga
2240 // is declared.
2241 #if !defined(MSWIN) && !defined(FEAT_GUI_X11) && !defined(FEAT_GUI_HAIKU) \
2242 	&& !defined(FEAT_GUI_GTK) && !defined(PROTO)
2243 # define mch_errmsg(str)	fprintf(stderr, "%s", (str))
2244 # define display_errors()	fflush(stderr)
2245 # define mch_msg(str)		printf("%s", (str))
2246 #else
2247 # define USE_MCH_ERRMSG
2248 #endif
2249 
2250 # if defined(FEAT_EVAL) \
2251 	&& (!defined(FEAT_GUI_MSWIN) \
2252 	     || !(defined(FEAT_MBYTE_IME) || defined(GLOBAL_IME)))
2253 // Whether IME is supported by im_get_status() defined in mbyte.c.
2254 // For Win32 GUI it's in gui_w32.c when FEAT_MBYTE_IME or GLOBAL_IME is defined.
2255 # define IME_WITHOUT_XIM
2256 #endif
2257 
2258 #if defined(FEAT_XIM) \
2259 	|| defined(IME_WITHOUT_XIM) \
2260 	|| (defined(FEAT_GUI_MSWIN) \
2261 	    && (defined(FEAT_MBYTE_IME) || defined(GLOBAL_IME)))
2262 // im_set_active() is available
2263 # define HAVE_INPUT_METHOD
2264 #endif
2265 
2266 #ifndef FEAT_LINEBREAK
2267 // Without the 'numberwidth' option line numbers are always 7 chars.
2268 # define number_width(x) 7
2269 #endif
2270 
2271 // This must come after including proto.h.
2272 // For VMS this is defined in macros.h.
2273 #if !defined(MSWIN) && !defined(VMS)
2274 # define mch_open(n, m, p)	open((n), (m), (p))
2275 # define mch_fopen(n, p)	fopen((n), (p))
2276 #endif
2277 
2278 #include "globals.h"	    // global variables and messages
2279 #include "errors.h"	    // error messages
2280 
2281 /*
2282  * If console dialog not supported, but GUI dialog is, use the GUI one.
2283  */
2284 #if defined(FEAT_GUI_DIALOG) && !defined(FEAT_CON_DIALOG)
2285 # define do_dialog gui_mch_dialog
2286 #endif
2287 
2288 /*
2289  * Default filters for gui_mch_browse().
2290  * The filters are almost system independent.  Except for the difference
2291  * between "*" and "*.*" for MSDOS-like systems.
2292  * NOTE: Motif only uses the very first pattern.  Therefore
2293  * BROWSE_FILTER_DEFAULT should start with a "*" pattern.
2294  */
2295 #ifdef FEAT_BROWSE
2296 # ifdef BACKSLASH_IN_FILENAME
2297 #  define BROWSE_FILTER_MACROS \
2298 	(char_u *)N_("Vim macro files (*.vim)\t*.vim\nAll Files (*.*)\t*.*\n")
2299 #  define BROWSE_FILTER_ALL_FILES (char_u *)N_("All Files (*.*)\t*.*\n")
2300 #  define BROWSE_FILTER_DEFAULT \
2301 	(char_u *)N_("All Files (*.*)\t*.*\nC source (*.c, *.h)\t*.c;*.h\nC++ source (*.cpp, *.hpp)\t*.cpp;*.hpp\nVB code (*.bas, *.frm)\t*.bas;*.frm\nVim files (*.vim, _vimrc, _gvimrc)\t*.vim;_vimrc;_gvimrc\n")
2302 # else
2303 #  define BROWSE_FILTER_MACROS \
2304 	(char_u *)N_("Vim macro files (*.vim)\t*.vim\nAll Files (*)\t*\n")
2305 #  define BROWSE_FILTER_ALL_FILES (char_u *)N_("All Files (*)\t*\n")
2306 #  define BROWSE_FILTER_DEFAULT \
2307 	(char_u *)N_("All Files (*)\t*\nC source (*.c, *.h)\t*.c;*.h\nC++ source (*.cpp, *.hpp)\t*.cpp;*.hpp\nVim files (*.vim, _vimrc, _gvimrc)\t*.vim;_vimrc;_gvimrc\n")
2308 # endif
2309 # define BROWSE_SAVE 1	    // flag for do_browse()
2310 # define BROWSE_DIR 2	    // flag for do_browse()
2311 #endif
2312 
2313 #ifdef _MSC_VER
2314 // Avoid useless warning "conversion from X to Y of greater size".
2315  #pragma warning(disable : 4312)
2316 // Avoid warning for old style function declarators
2317  #pragma warning(disable : 4131)
2318 // Avoid warning for conversion to type with smaller range
2319  #pragma warning(disable : 4244)
2320 // Avoid warning for conversion to larger size
2321  #pragma warning(disable : 4306)
2322 // Avoid warning for unreferenced formal parameter
2323  #pragma warning(disable : 4100)
2324 // Avoid warning for differs in indirection to slightly different base type
2325  #pragma warning(disable : 4057)
2326 // Avoid warning for constant conditional expression
2327  #pragma warning(disable : 4127)
2328 // Avoid warning for assignment within conditional
2329  #pragma warning(disable : 4706)
2330 #endif
2331 
2332 // Note: a NULL argument for vim_realloc() is not portable, don't use it.
2333 #if defined(MEM_PROFILE)
2334 # define vim_realloc(ptr, size)  mem_realloc((ptr), (size))
2335 #else
2336 # define vim_realloc(ptr, size)  realloc((ptr), (size))
2337 #endif
2338 
2339 /*
2340  * Return byte length of character that starts with byte "b".
2341  * Returns 1 for a single-byte character.
2342  * MB_BYTE2LEN_CHECK() can be used to count a special key as one byte.
2343  * Don't call MB_BYTE2LEN(b) with b < 0 or b > 255!
2344  */
2345 #define MB_BYTE2LEN(b)		mb_bytelen_tab[b]
2346 #define MB_BYTE2LEN_CHECK(b)	(((b) < 0 || (b) > 255) ? 1 : mb_bytelen_tab[b])
2347 
2348 // properties used in enc_canon_table[] (first three mutually exclusive)
2349 #define ENC_8BIT	0x01
2350 #define ENC_DBCS	0x02
2351 #define ENC_UNICODE	0x04
2352 
2353 #define ENC_ENDIAN_B	0x10	    // Unicode: Big endian
2354 #define ENC_ENDIAN_L	0x20	    // Unicode: Little endian
2355 
2356 #define ENC_2BYTE	0x40	    // Unicode: UCS-2
2357 #define ENC_4BYTE	0x80	    // Unicode: UCS-4
2358 #define ENC_2WORD	0x100	    // Unicode: UTF-16
2359 
2360 #define ENC_LATIN1	0x200	    // Latin1
2361 #define ENC_LATIN9	0x400	    // Latin9
2362 #define ENC_MACROMAN	0x800	    // Mac Roman (not Macro Man! :-)
2363 
2364 #ifdef USE_ICONV
2365 # ifndef EILSEQ
2366 #  define EILSEQ 123
2367 # endif
2368 # ifdef DYNAMIC_ICONV
2369 // On Win32 iconv.dll is dynamically loaded.
2370 #  define ICONV_ERRNO (*iconv_errno())
2371 #  define ICONV_E2BIG  7
2372 #  define ICONV_EINVAL 22
2373 #  define ICONV_EILSEQ 42
2374 # else
2375 #  define ICONV_ERRNO errno
2376 #  define ICONV_E2BIG  E2BIG
2377 #  define ICONV_EINVAL EINVAL
2378 #  define ICONV_EILSEQ EILSEQ
2379 # endif
2380 #endif
2381 
2382 #define SIGN_BYTE 1	    // byte value used where sign is displayed;
2383 			    // attribute value is sign type
2384 
2385 #ifdef FEAT_NETBEANS_INTG
2386 # define MULTISIGN_BYTE 2   // byte value used where sign is displayed if
2387 			    // multiple signs exist on the line
2388 #endif
2389 
2390 #if defined(FEAT_GUI) && defined(FEAT_XCLIPBOARD)
2391 # ifdef FEAT_GUI_GTK
2392    // Avoid using a global variable for the X display.  It's ugly
2393    // and is likely to cause trouble in multihead environments.
2394 #  define X_DISPLAY	((gui.in_use) ? gui_mch_get_display() : xterm_dpy)
2395 # else
2396 #  define X_DISPLAY	(gui.in_use ? gui.dpy : xterm_dpy)
2397 # endif
2398 #else
2399 # ifdef FEAT_GUI
2400 #  ifdef FEAT_GUI_GTK
2401 #   define X_DISPLAY	((gui.in_use) ? gui_mch_get_display() : (Display *)NULL)
2402 #  else
2403 #   define X_DISPLAY	gui.dpy
2404 #  endif
2405 # else
2406 #  define X_DISPLAY	xterm_dpy
2407 # endif
2408 #endif
2409 
2410 #if defined(FEAT_BROWSE) && defined(GTK_CHECK_VERSION)
2411 # if GTK_CHECK_VERSION(2,4,0)
2412 #  define USE_FILE_CHOOSER
2413 # endif
2414 #endif
2415 
2416 #ifdef FEAT_GUI_GTK
2417 # if !GTK_CHECK_VERSION(2,14,0)
2418 #  define gtk_widget_get_window(wid)	((wid)->window)
2419 #  define gtk_plug_get_socket_window(wid)	((wid)->socket_window)
2420 #  define gtk_selection_data_get_data(sel)	((sel)->data)
2421 #  define gtk_selection_data_get_data_type(sel)	((sel)->type)
2422 #  define gtk_selection_data_get_format(sel)	((sel)->format)
2423 #  define gtk_selection_data_get_length(sel)	((sel)->length)
2424 #  define gtk_adjustment_set_lower(adj, low) \
2425     do { (adj)->lower = low; } while (0)
2426 #  define gtk_adjustment_set_upper(adj, up) \
2427     do { (adj)->upper = up; } while (0)
2428 #  define gtk_adjustment_set_page_size(adj, size) \
2429     do { (adj)->page_size = size; } while (0)
2430 #  define gtk_adjustment_set_page_increment(adj, inc) \
2431     do { (adj)->page_increment = inc; } while (0)
2432 #  define gtk_adjustment_set_step_increment(adj, inc) \
2433     do { (adj)->step_increment = inc; } while (0)
2434 # endif
2435 # if !GTK_CHECK_VERSION(2,16,0)
2436 #  define gtk_selection_data_get_selection(sel)	((sel)->selection)
2437 # endif
2438 # if !GTK_CHECK_VERSION(2,18,0)
2439 #  define gtk_widget_get_allocation(wid, alloc) \
2440     do { *(alloc) = (wid)->allocation; } while (0)
2441 #  define gtk_widget_set_allocation(wid, alloc) \
2442     do { (wid)->allocation = *(alloc); } while (0)
2443 #  define gtk_widget_get_has_window(wid)	!GTK_WIDGET_NO_WINDOW(wid)
2444 #  define gtk_widget_get_sensitive(wid)	GTK_WIDGET_SENSITIVE(wid)
2445 #  define gtk_widget_get_visible(wid)	GTK_WIDGET_VISIBLE(wid)
2446 #  define gtk_widget_has_focus(wid)	GTK_WIDGET_HAS_FOCUS(wid)
2447 #  define gtk_widget_set_window(wid, win) \
2448     do { (wid)->window = (win); } while (0)
2449 #  define gtk_widget_set_can_default(wid, can) \
2450     do { if (can) { GTK_WIDGET_SET_FLAGS(wid, GTK_CAN_DEFAULT); } \
2451 	else { GTK_WIDGET_UNSET_FLAGS(wid, GTK_CAN_DEFAULT); } } while (0)
2452 #  define gtk_widget_set_can_focus(wid, can) \
2453     do { if (can) { GTK_WIDGET_SET_FLAGS(wid, GTK_CAN_FOCUS); } \
2454 	else { GTK_WIDGET_UNSET_FLAGS(wid, GTK_CAN_FOCUS); } } while (0)
2455 #  define gtk_widget_set_visible(wid, vis) \
2456     do { if (vis) { gtk_widget_show(wid); } \
2457 	else { gtk_widget_hide(wid); } } while (0)
2458 # endif
2459 # if !GTK_CHECK_VERSION(2,20,0)
2460 #  define gtk_widget_get_mapped(wid)	GTK_WIDGET_MAPPED(wid)
2461 #  define gtk_widget_get_realized(wid)	GTK_WIDGET_REALIZED(wid)
2462 #  define gtk_widget_set_mapped(wid, map) \
2463     do { if (map) { GTK_WIDGET_SET_FLAGS(wid, GTK_MAPPED); } \
2464 	else { GTK_WIDGET_UNSET_FLAGS(wid, GTK_MAPPED); } } while (0)
2465 #  define gtk_widget_set_realized(wid, rea) \
2466     do { if (rea) { GTK_WIDGET_SET_FLAGS(wid, GTK_REALIZED); } \
2467 	else { GTK_WIDGET_UNSET_FLAGS(wid, GTK_REALIZED); } } while (0)
2468 # endif
2469 #endif
2470 
2471 #ifndef FEAT_NETBEANS_INTG
2472 # undef NBDEBUG
2473 #endif
2474 #ifdef NBDEBUG // Netbeans debugging.
2475 # include "nbdebug.h"
2476 #else
2477 # define nbdebug(a)
2478 #endif
2479 
2480 #ifdef IN_PERL_FILE
2481   /*
2482    * Avoid clashes between Perl and Vim namespace.
2483    */
2484 # undef NORMAL
2485 # undef STRLEN
2486 # undef FF
2487 # undef OP_DELETE
2488 # undef OP_JOIN
2489   // remove MAX and MIN, included by glib.h, redefined by sys/param.h
2490 # ifdef MAX
2491 #  undef MAX
2492 # endif
2493 # ifdef MIN
2494 #  undef MIN
2495 # endif
2496   // We use _() for gettext(), Perl uses it for function prototypes...
2497 # ifdef _
2498 #  undef _
2499 # endif
2500 # ifdef DEBUG
2501 #  undef DEBUG
2502 # endif
2503 # ifdef _DEBUG
2504 #  undef _DEBUG
2505 # endif
2506 # ifdef instr
2507 #  undef instr
2508 # endif
2509   // bool may cause trouble on some old versions of Mac OS X but is required
2510   // on a few other systems and for Perl
2511 # if (defined(MACOS_X) && !defined(MAC_OS_X_VERSION_10_6)) \
2512 				       && defined(bool) && !defined(FEAT_PERL)
2513 #  undef bool
2514 # endif
2515 
2516 #endif
2517 
2518 // values for vim_handle_signal() that are not a signal
2519 #define SIGNAL_BLOCK	-1
2520 #define SIGNAL_UNBLOCK  -2
2521 #if !defined(UNIX) && !defined(VMS)
2522 # define vim_handle_signal(x) 0
2523 #endif
2524 
2525 // flags for skip_vimgrep_pat()
2526 #define VGR_GLOBAL	1
2527 #define VGR_NOJUMP	2
2528 #define VGR_FUZZY	4
2529 
2530 // behavior for bad character, "++bad=" argument
2531 #define BAD_REPLACE	'?'	// replace it with '?' (default)
2532 #define BAD_KEEP	-1	// leave it
2533 #define BAD_DROP	-2	// erase it
2534 
2535 // last argument for do_source()
2536 #define DOSO_NONE	0
2537 #define DOSO_VIMRC	1	// loading vimrc file
2538 #define DOSO_GVIMRC	2	// loading gvimrc file
2539 
2540 // flags for read_viminfo() and children
2541 #define VIF_WANT_INFO	    1	// load non-mark info
2542 #define VIF_WANT_MARKS	    2	// load file marks
2543 #define VIF_ONLY_CURBUF	    4	// bail out after loading marks for curbuf
2544 #define VIF_FORCEIT	    8	// overwrite info already read
2545 #define VIF_GET_OLDFILES    16	// load v:oldfiles
2546 
2547 // flags for buf_freeall()
2548 #define BFA_DEL		 1	// buffer is going to be deleted
2549 #define BFA_WIPE	 2	// buffer is going to be wiped out
2550 #define BFA_KEEP_UNDO	 4	// do not free undo information
2551 #define BFA_IGNORE_ABORT 8	// do not abort for aborting()
2552 
2553 // direction for nv_mousescroll() and ins_mousescroll()
2554 #define MSCR_DOWN	0	// DOWN must be FALSE
2555 #define MSCR_UP		1
2556 #define MSCR_LEFT	-1
2557 #define MSCR_RIGHT	-2
2558 
2559 #define KEYLEN_PART_KEY -1	// keylen value for incomplete key-code
2560 #define KEYLEN_PART_MAP -2	// keylen value for incomplete mapping
2561 #define KEYLEN_REMOVED  9999	// keylen value for removed sequence
2562 
2563 // Return values from win32_fileinfo().
2564 #define FILEINFO_OK	     0
2565 #define FILEINFO_ENC_FAIL    1	// enc_to_utf16() failed
2566 #define FILEINFO_READ_FAIL   2	// CreateFile() failed
2567 #define FILEINFO_INFO_FAIL   3	// GetFileInformationByHandle() failed
2568 
2569 // Return value from get_option_value_strict
2570 #define SOPT_BOOL	0x01	// Boolean option
2571 #define SOPT_NUM	0x02	// Number option
2572 #define SOPT_STRING	0x04	// String option
2573 #define SOPT_GLOBAL	0x08	// Option has global value
2574 #define SOPT_WIN	0x10	// Option has window-local value
2575 #define SOPT_BUF	0x20	// Option has buffer-local value
2576 #define SOPT_UNSET	0x40	// Option does not have local value set
2577 
2578 // Option types for various functions in option.c
2579 #define SREQ_GLOBAL	0	// Request global option
2580 #define SREQ_WIN	1	// Request window-local option
2581 #define SREQ_BUF	2	// Request buffer-local option
2582 
2583 // Flags for get_reg_contents
2584 #define GREG_NO_EXPR	1	// Do not allow expression register
2585 #define GREG_EXPR_SRC	2	// Return expression itself for "=" register
2586 #define GREG_LIST	4	// Return list
2587 
2588 // Character used as separated in autoload function/variable names.
2589 #define AUTOLOAD_CHAR '#'
2590 
2591 #ifdef FEAT_JOB_CHANNEL
2592 # define MAX_OPEN_CHANNELS 10
2593 #else
2594 # define MAX_OPEN_CHANNELS 0
2595 #endif
2596 
2597 #if defined(MSWIN)
2598 # define MAX_NAMED_PIPE_SIZE 65535
2599 #endif
2600 
2601 // Options for json_encode() and json_decode.
2602 #define JSON_JS		1   // use JS instead of JSON
2603 #define JSON_NO_NONE	2   // v:none item not allowed
2604 #define JSON_NL		4   // append a NL
2605 
2606 // Used for flags of do_in_path()
2607 #define DIP_ALL	    0x01	// all matches, not just the first one
2608 #define DIP_DIR	    0x02	// find directories instead of files.
2609 #define DIP_ERR	    0x04	// give an error message when none found.
2610 #define DIP_START   0x08	// also use "start" directory in 'packpath'
2611 #define DIP_OPT	    0x10	// also use "opt" directory in 'packpath'
2612 #define DIP_NORTP   0x20	// do not use 'runtimepath'
2613 #define DIP_NOAFTER 0x40	// skip "after" directories
2614 #define DIP_AFTER   0x80	// only use "after" directories
2615 
2616 // Lowest number used for window ID. Cannot have this many windows.
2617 #define LOWEST_WIN_ID 1000
2618 
2619 // Used by the garbage collector.
2620 #define COPYID_INC 2
2621 #define COPYID_MASK (~0x1)
2622 
2623 // Values for trans_function_name() argument:
2624 #define TFN_INT		0x01	// internal function name OK
2625 #define TFN_QUIET	0x02	// no error messages
2626 #define TFN_NO_AUTOLOAD	0x04	// do not use script autoloading
2627 #define TFN_NO_DEREF	0x08	// do not dereference a Funcref
2628 #define TFN_READ_ONLY	0x10	// will not change the var
2629 #define TFN_NO_DECL	0x20	// only used for GLV_NO_DECL
2630 #define TFN_COMPILING	0x40	// only used for GLV_COMPILING
2631 
2632 // Values for get_lval() flags argument:
2633 #define GLV_QUIET	TFN_QUIET	// no error messages
2634 #define GLV_NO_AUTOLOAD	TFN_NO_AUTOLOAD	// do not use script autoloading
2635 #define GLV_READ_ONLY	TFN_READ_ONLY	// will not change the var
2636 #define GLV_NO_DECL	TFN_NO_DECL	// assignment without :var or :let
2637 #define GLV_COMPILING	TFN_COMPILING	// variable may be defined later
2638 
2639 #define DO_NOT_FREE_CNT 99999	// refcount for dict or list that should not
2640 				// be freed.
2641 
2642 // errors for when calling a function
2643 #define FCERR_UNKNOWN	0
2644 #define FCERR_TOOMANY	1
2645 #define FCERR_TOOFEW	2
2646 #define FCERR_SCRIPT	3
2647 #define FCERR_DICT	4
2648 #define FCERR_NONE	5
2649 #define FCERR_OTHER	6
2650 #define FCERR_DELETED	7
2651 #define FCERR_NOTMETHOD	8   // function cannot be used as a method
2652 
2653 // fixed buffer length for fname_trans_sid()
2654 #define FLEN_FIXED 40
2655 
2656 // flags for find_name_end()
2657 #define FNE_INCL_BR	1	// include [] in name
2658 #define FNE_CHECK_START	2	// check name starts with valid character
2659 
2660 // BSD is supposed to cover FreeBSD and similar systems.
2661 #if (defined(SUN_SYSTEM) || defined(BSD) || defined(__FreeBSD_kernel__)) \
2662 	&& (defined(S_ISCHR) || defined(S_IFCHR))
2663 # define OPEN_CHR_FILES
2664 #endif
2665 
2666 // stat macros
2667 #ifndef S_ISDIR
2668 # ifdef S_IFDIR
2669 #  define S_ISDIR(m)	(((m) & S_IFMT) == S_IFDIR)
2670 # else
2671 #  define S_ISDIR(m)	0
2672 # endif
2673 #endif
2674 #ifndef S_ISREG
2675 # ifdef S_IFREG
2676 #  define S_ISREG(m)	(((m) & S_IFMT) == S_IFREG)
2677 # else
2678 #  define S_ISREG(m)	0
2679 # endif
2680 #endif
2681 #ifndef S_ISBLK
2682 # ifdef S_IFBLK
2683 #  define S_ISBLK(m)	(((m) & S_IFMT) == S_IFBLK)
2684 # else
2685 #  define S_ISBLK(m)	0
2686 # endif
2687 #endif
2688 #ifndef S_ISSOCK
2689 # ifdef S_IFSOCK
2690 #  define S_ISSOCK(m)	(((m) & S_IFMT) == S_IFSOCK)
2691 # else
2692 #  define S_ISSOCK(m)	0
2693 # endif
2694 #endif
2695 #ifndef S_ISFIFO
2696 # ifdef S_IFIFO
2697 #  define S_ISFIFO(m)	(((m) & S_IFMT) == S_IFIFO)
2698 # else
2699 #  define S_ISFIFO(m)	0
2700 # endif
2701 #endif
2702 #ifndef S_ISCHR
2703 # ifdef S_IFCHR
2704 #  define S_ISCHR(m)	(((m) & S_IFMT) == S_IFCHR)
2705 # else
2706 #  define S_ISCHR(m)	0
2707 # endif
2708 #endif
2709 #ifndef S_ISLNK
2710 # ifdef S_IFLNK
2711 #  define S_ISLNK(m)	(((m) & S_IFMT) == S_IFLNK)
2712 # else
2713 #  define S_ISLNK(m)	0
2714 # endif
2715 #endif
2716 
2717 #if defined(HAVE_GETTIMEOFDAY) && defined(HAVE_SYS_TIME_H)
2718 # define ELAPSED_TIMEVAL
2719 # define ELAPSED_INIT(v) gettimeofday(&v, NULL)
2720 # define ELAPSED_FUNC(v) elapsed(&v)
2721 typedef struct timeval elapsed_T;
2722 long elapsed(struct timeval *start_tv);
2723 #elif defined(MSWIN)
2724 # define ELAPSED_TICKCOUNT
2725 # define ELAPSED_INIT(v) v = GetTickCount()
2726 # define ELAPSED_FUNC(v) elapsed(v)
2727 # ifdef PROTO
2728 typedef int DWORD;
2729 # endif
2730 typedef DWORD elapsed_T;
2731 # ifndef PROTO
2732 long elapsed(DWORD start_tick);
2733 # endif
2734 #endif
2735 
2736 // Replacement for nchar used by nv_replace().
2737 #define REPLACE_CR_NCHAR    -1
2738 #define REPLACE_NL_NCHAR    -2
2739 
2740 // flags for term_start()
2741 #define TERM_START_NOJOB	1
2742 #define TERM_START_FORCEIT	2
2743 #define TERM_START_SYSTEM	4
2744 
2745 // Used for icon/title save and restore.
2746 #define SAVE_RESTORE_TITLE	1
2747 #define SAVE_RESTORE_ICON	2
2748 #define SAVE_RESTORE_BOTH	(SAVE_RESTORE_TITLE | SAVE_RESTORE_ICON)
2749 
2750 // Flags for adjust_prop_columns()
2751 #define APC_SAVE_FOR_UNDO	1   // call u_savesub() before making changes
2752 #define APC_SUBSTITUTE		2   // text is replaced, not inserted
2753 
2754 #define CLIP_ZINDEX 32000
2755 
2756 // Flags for replace_termcodes()
2757 #define REPTERM_FROM_PART	1
2758 #define REPTERM_DO_LT		2
2759 #define REPTERM_SPECIAL		4
2760 #define REPTERM_NO_SIMPLIFY	8
2761 
2762 // Flags for find_special_key()
2763 #define FSK_KEYCODE	0x01	// prefer key code, e.g. K_DEL instead of DEL
2764 #define FSK_KEEP_X_KEY	0x02	// don't translate xHome to Home key
2765 #define FSK_IN_STRING	0x04	// TRUE in string, double quote is escaped
2766 #define FSK_SIMPLIFY	0x08	// simplify <C-H> and <A-x>
2767 
2768 // Flags for the readdirex function, how to sort the result
2769 #define READDIR_SORT_NONE	0  // do not sort
2770 #define READDIR_SORT_BYTE	1  // sort by byte order (strcmp), default
2771 #define READDIR_SORT_IC		2  // sort ignoring case (strcasecmp)
2772 #define READDIR_SORT_COLLATE	3  // sort according to collation (strcoll)
2773 
2774 // Flags for mch_delay.
2775 #define MCH_DELAY_IGNOREINPUT	1
2776 #define MCH_DELAY_SETTMODE	2
2777 
2778 // Flags for eval_variable().
2779 #define EVAL_VAR_VERBOSE	1   // may give error message
2780 #define EVAL_VAR_NOAUTOLOAD	2   // do not use script autoloading
2781 #define EVAL_VAR_IMPORT		4   // may return special variable for import
2782 
2783 // Maximum number of characters that can be fuzzy matched
2784 #define MAX_FUZZY_MATCHES	256
2785 
2786 // flags for equal_type()
2787 #define ETYPE_ARG_UNKNOWN 1
2788 
2789 // flags used by user commands and :autocmd
2790 #define UC_BUFFER	1	// -buffer: local to current buffer
2791 #define UC_VIM9		2	// {} argument: Vim9 syntax.
2792 
2793 // flags used by vim_strsave_escaped()
2794 #define VSE_NONE	0
2795 #define VSE_SHELL	1	// escape for a shell command
2796 #define VSE_BUFFER	2	// escape for a ":buffer" command
2797 
2798 #endif // VIM__H
2799