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