xref: /vim-8.2.3635/src/vim.h (revision 57e4ee4d)
1 /* vi:set ts=8 sts=4 sw=4:
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 /* use fastcall for Borland, when compiling for Win32 (not for DOS16) */
13 #if defined(__BORLANDC__) && defined(WIN32) && !defined(DEBUG)
14 #if defined(FEAT_PERL) || \
15     defined(FEAT_PYTHON) || \
16     defined(FEAT_PYTHON3) || \
17     defined(FEAT_RUBY) || \
18     defined(FEAT_TCL) || \
19     defined(FEAT_MZSCHEME) || \
20     defined(DYNAMIC_GETTEXT) || \
21     defined(DYNAMIC_ICONV) || \
22     defined(DYNAMIC_IME) || \
23     defined(XPM)
24   #pragma option -pc
25 # else
26   #pragma option -pr
27 # endif
28 #endif
29 
30 #if defined(MSDOS) || defined(WIN16) || defined(WIN32) || defined(_WIN64) \
31 	|| defined(__EMX__)
32 # include "vimio.h"
33 #endif
34 
35 /* ============ the header file puzzle (ca. 50-100 pieces) ========= */
36 
37 #ifdef HAVE_CONFIG_H	/* GNU autoconf (or something else) was here */
38 # include "auto/config.h"
39 # define HAVE_PATHDEF
40 
41 /*
42  * Check if configure correctly managed to find sizeof(int).  If this failed,
43  * it becomes zero.  This is likely a problem of not being able to run the
44  * test program.  Other items from configure may also be wrong then!
45  */
46 # if (SIZEOF_INT == 0)
47     Error: configure did not run properly.  Check auto/config.log.
48 # endif
49 
50 /*
51  * Cygwin may have fchdir() in a newer release, but in most versions it
52  * doesn't work well and avoiding it keeps the binary backward compatible.
53  */
54 # if defined(__CYGWIN32__) && defined(HAVE_FCHDIR)
55 #  undef HAVE_FCHDIR
56 # endif
57 
58 /* We may need to define the uint32_t on non-Unix system, but using the same
59  * identifier causes conflicts.  Therefore use UINT32_T. */
60 # define UINT32_TYPEDEF uint32_t
61 #endif
62 
63 #if !defined(UINT32_TYPEDEF)
64 # if defined(uint32_t)  /* this doesn't catch typedefs, unfortunately */
65 #  define UINT32_TYPEDEF uint32_t
66 # else
67   /* Fall back to assuming unsigned int is 32 bit.  If this is wrong then the
68    * test in blowfish.c will fail. */
69 #  define UINT32_TYPEDEF unsigned int
70 # endif
71 #endif
72 
73 /* user ID of root is usually zero, but not for everybody */
74 #ifdef __TANDEM
75 # ifndef _TANDEM_SOURCE
76 #  define _TANDEM_SOURCE
77 # endif
78 # include <floss.h>
79 # define ROOT_UID 65535
80 #else
81 # define ROOT_UID 0
82 #endif
83 
84 #ifdef __EMX__		/* hand-edited config.h for OS/2 with EMX */
85 # include "os_os2_cfg.h"
86 #endif
87 
88 /*
89  * MACOS_CLASSIC compiling for MacOS prior to MacOS X
90  * MACOS_X_UNIX  compiling for MacOS X (using os_unix.c)
91  * MACOS_X       compiling for MacOS X (using os_unix.c)
92  * MACOS	 compiling for either one
93  */
94 #if defined(macintosh) && !defined(MACOS_CLASSIC)
95 # define MACOS_CLASSIC
96 #endif
97 #if defined(MACOS_X_UNIX)
98 # define MACOS_X
99 # ifndef HAVE_CONFIG_H
100 #  define UNIX
101 # endif
102 # ifndef FEAT_CLIPBOARD
103 #  define FEAT_CLIPBOARD
104 # endif
105 #endif
106 #if defined(MACOS_X) || defined(MACOS_CLASSIC)
107 #  define MACOS
108 #endif
109 #if defined(MACOS_X) && defined(MACOS_CLASSIC)
110     Error: To compile for both MACOS X and Classic use a Classic Carbon
111 #endif
112 /* Unless made through the Makefile enforce GUI on Mac */
113 #if defined(MACOS) && !defined(HAVE_CONFIG_H)
114 # define FEAT_GUI_MAC
115 #endif
116 
117 #if defined(FEAT_GUI_MOTIF) \
118     || defined(FEAT_GUI_GTK) \
119     || defined(FEAT_GUI_ATHENA) \
120     || defined(FEAT_GUI_MAC) \
121     || defined(FEAT_GUI_W32) \
122     || defined(FEAT_GUI_W16) \
123     || defined(FEAT_GUI_PHOTON)
124 # define FEAT_GUI_ENABLED  /* also defined with NO_X11_INCLUDES */
125 # if !defined(FEAT_GUI) && !defined(NO_X11_INCLUDES)
126 #  define FEAT_GUI
127 # endif
128 #endif
129 
130 /* Visual Studio 2005 has 'deprecated' many of the standard CRT functions */
131 #if _MSC_VER >= 1400
132 # define _CRT_SECURE_NO_DEPRECATE
133 # define _CRT_NONSTDC_NO_DEPRECATE
134 #endif
135 
136 #if defined(FEAT_GUI_W32) || defined(FEAT_GUI_W16)
137 # define FEAT_GUI_MSWIN
138 #endif
139 #if defined(WIN16) || defined(WIN32) || defined(_WIN64)
140 # define MSWIN
141 #endif
142 /* Practically everything is common to both Win32 and Win64 */
143 #if defined(WIN32) || defined(_WIN64)
144 # define WIN3264
145 #endif
146 
147 /*
148  * SIZEOF_INT is used in feature.h, and the system-specific included files
149  * need items from feature.h.  Therefore define SIZEOF_INT here.
150  */
151 #ifdef WIN3264
152 # define SIZEOF_INT 4
153 #endif
154 #ifdef MSDOS
155 # ifdef DJGPP
156 #  ifndef FEAT_GUI_GTK		/* avoid problems when generating prototypes */
157 #   define SIZEOF_INT 4		/* 32 bit ints */
158 #  endif
159 #  define DOS32
160 #  define FEAT_CLIPBOARD
161 # else
162 #  ifndef FEAT_GUI_GTK		/* avoid problems when generating prototypes */
163 #   define SIZEOF_INT 2		/* 16 bit ints */
164 #  endif
165 #  define SMALL_MALLOC		/* 16 bit storage allocation */
166 #  define DOS16
167 # endif
168 #endif
169 
170 #ifdef AMIGA
171   /* Be conservative about sizeof(int). It could be 4 too. */
172 # ifndef FEAT_GUI_GTK	/* avoid problems when generating prototypes */
173 #  ifdef __GNUC__
174 #   define SIZEOF_INT	4
175 #  else
176 #   define SIZEOF_INT	2
177 #  endif
178 # endif
179 #endif
180 #ifdef MACOS
181 # if defined(__POWERPC__) || defined(MACOS_X) || defined(__fourbyteints__) \
182   || defined(__MRC__) || defined(__SC__) || defined(__APPLE_CC__)/* MPW Compilers */
183 #  define SIZEOF_INT 4
184 # else
185 #  define SIZEOF_INT 2
186 # endif
187 #endif
188 
189 
190 #include "feature.h"	/* #defines for optionals and features */
191 
192 /* +x11 is only enabled when it's both available and wanted. */
193 #if defined(HAVE_X11) && defined(WANT_X11)
194 # define FEAT_X11
195 #endif
196 
197 #ifdef NO_X11_INCLUDES
198     /* In os_mac_conv.c and os_macosx.m NO_X11_INCLUDES is defined to avoid
199      * X11 headers.  Disable all X11 related things to avoid conflicts. */
200 # ifdef FEAT_X11
201 #  undef FEAT_X11
202 # endif
203 # ifdef FEAT_GUI_X11
204 #  undef FEAT_GUI_X11
205 # endif
206 # ifdef FEAT_XCLIPBOARD
207 #  undef FEAT_XCLIPBOARD
208 # endif
209 # ifdef FEAT_GUI_MOTIF
210 #  undef FEAT_GUI_MOTIF
211 # endif
212 # ifdef FEAT_GUI_ATHENA
213 #  undef FEAT_GUI_ATHENA
214 # endif
215 # ifdef FEAT_GUI_GTK
216 #  undef FEAT_GUI_GTK
217 # endif
218 # ifdef FEAT_BEVAL_TIP
219 #  undef FEAT_BEVAL_TIP
220 # endif
221 # ifdef FEAT_XIM
222 #  undef FEAT_XIM
223 # endif
224 # ifdef FEAT_CLIENTSERVER
225 #  undef FEAT_CLIENTSERVER
226 # endif
227 #endif
228 
229 /* The Mac conversion stuff doesn't work under X11. */
230 #if defined(FEAT_MBYTE) && defined(MACOS_X)
231 # define MACOS_CONVERT
232 #endif
233 
234 /* Can't use "PACKAGE" here, conflicts with a Perl include file. */
235 #ifndef VIMPACKAGE
236 # define VIMPACKAGE	"vim"
237 #endif
238 
239 /*
240  * Find out if function definitions should include argument types
241  */
242 #ifdef AZTEC_C
243 # include <functions.h>
244 # define __ARGS(x)  x
245 #endif
246 
247 #ifdef SASC
248 # include <clib/exec_protos.h>
249 # define __ARGS(x)  x
250 #endif
251 
252 #ifdef _DCC
253 # include <clib/exec_protos.h>
254 # define __ARGS(x)  x
255 #endif
256 
257 #ifdef __TURBOC__
258 # define __ARGS(x) x
259 #endif
260 
261 #ifdef __BEOS__
262 # include "os_beos.h"
263 # define __ARGS(x)  x
264 #endif
265 
266 #if (defined(UNIX) || defined(__EMX__) || defined(VMS)) \
267 	&& (!defined(MACOS_X) || defined(HAVE_CONFIG_H))
268 # include "os_unix.h"	    /* bring lots of system header files */
269 #endif
270 
271 #if defined(MACOS) && (defined(__MRC__) || defined(__SC__))
272    /* Apple's Compilers support prototypes */
273 # define __ARGS(x) x
274 #endif
275 #ifndef __ARGS
276 # if defined(__STDC__) || defined(__GNUC__) || defined(WIN3264)
277 #  define __ARGS(x) x
278 # else
279 #  define __ARGS(x) ()
280 # endif
281 #endif
282 
283 /* __ARGS and __PARMS are the same thing. */
284 #ifndef __PARMS
285 # define __PARMS(x) __ARGS(x)
286 #endif
287 
288 /* Mark unused function arguments with UNUSED, so that gcc -Wunused-parameter
289  * can be used to check for mistakes. */
290 #ifdef HAVE_ATTRIBUTE_UNUSED
291 # define UNUSED __attribute__((unused))
292 #else
293 # define UNUSED
294 #endif
295 
296 /* if we're compiling in C++ (currently only KVim), the system
297  * headers must have the correct prototypes or nothing will build.
298  * conversely, our prototypes might clash due to throw() specifiers and
299  * cause compilation failures even though the headers are correct.  For
300  * a concrete example, gcc-3.2 enforces exception specifications, and
301  * glibc-2.2.5 has them in their system headers.
302  */
303 #if !defined(__cplusplus) && defined(UNIX) \
304   && !defined(MACOS_X) /* MACOS_X doesn't yet support osdef.h */
305 # include "auto/osdef.h"	/* bring missing declarations in */
306 #endif
307 
308 #ifdef __EMX__
309 # define    getcwd  _getcwd2
310 # define    chdir   _chdir2
311 # undef	    CHECK_INODE
312 #endif
313 
314 #ifdef AMIGA
315 # include "os_amiga.h"
316 #endif
317 
318 #ifdef MSDOS
319 # include "os_msdos.h"
320 #endif
321 
322 #ifdef WIN16
323 # include "os_win16.h"
324 #endif
325 
326 #ifdef WIN3264
327 # include "os_win32.h"
328 #endif
329 
330 #ifdef __MINT__
331 # include "os_mint.h"
332 #endif
333 
334 #if defined(MACOS)
335 # if defined(__MRC__) || defined(__SC__) /* MPW Compilers */
336 #  define HAVE_SETENV
337 # endif
338 # include "os_mac.h"
339 #endif
340 
341 #ifdef __QNX__
342 # include "os_qnx.h"
343 #endif
344 
345 #ifdef FEAT_SUN_WORKSHOP
346 # include "workshop.h"
347 #endif
348 
349 #ifdef X_LOCALE
350 # include <X11/Xlocale.h>
351 #else
352 # ifdef HAVE_LOCALE_H
353 #  include <locale.h>
354 # endif
355 #endif
356 
357 /*
358  * Maximum length of a path (for non-unix systems) Make it a bit long, to stay
359  * on the safe side.  But not too long to put on the stack.
360  */
361 #ifndef MAXPATHL
362 # ifdef MAXPATHLEN
363 #  define MAXPATHL  MAXPATHLEN
364 # else
365 #  define MAXPATHL  256
366 # endif
367 #endif
368 #ifdef BACKSLASH_IN_FILENAME
369 # define PATH_ESC_CHARS ((char_u *)" \t\n*?[{`%#'\"|!<")
370 #else
371 # ifdef VMS
372     /* VMS allows a lot of characters in the file name */
373 #  define PATH_ESC_CHARS ((char_u *)" \t\n*?{`\\%#'\"|!")
374 #  define SHELL_ESC_CHARS ((char_u *)" \t\n*?{`\\%#'|!()&")
375 # else
376 #  define PATH_ESC_CHARS ((char_u *)" \t\n*?[{`$\\%#'\"|!<")
377 #  define SHELL_ESC_CHARS ((char_u *)" \t\n*?[{`$\\%#'\"|!<>();&")
378 # endif
379 #endif
380 
381 #define NUMBUFLEN 30	    /* length of a buffer to store a number in ASCII */
382 
383 /*
384  * Shorthand for unsigned variables. Many systems, but not all, have u_char
385  * already defined, so we use char_u to avoid trouble.
386  */
387 typedef unsigned char	char_u;
388 typedef unsigned short	short_u;
389 typedef unsigned int	int_u;
390 /* Make sure long_u is big enough to hold a pointer.
391  * On Win64, longs are 32 bits and pointers are 64 bits.
392  * For printf() and scanf(), we need to take care of long_u specifically. */
393 #ifdef _WIN64
394 typedef unsigned __int64	long_u;
395 typedef		 __int64	long_i;
396 # define SCANF_HEX_LONG_U       "%Ix"
397 # define SCANF_DECIMAL_LONG_U   "%Iu"
398 # define PRINTF_HEX_LONG_U      "0x%Ix"
399 #else
400   /* Microsoft-specific. The __w64 keyword should be specified on any typedefs
401    * that change size between 32-bit and 64-bit platforms.  For any such type,
402    * __w64 should appear only on the 32-bit definition of the typedef.
403    * Define __w64 as an empty token for everything but MSVC 7.x or later.
404    */
405 # if !defined(_MSC_VER)	|| (_MSC_VER < 1300)
406 #  define __w64
407 # endif
408 typedef unsigned long __w64	long_u;
409 typedef		 long __w64     long_i;
410 # define SCANF_HEX_LONG_U       "%lx"
411 # define SCANF_DECIMAL_LONG_U   "%lu"
412 # define PRINTF_HEX_LONG_U      "0x%lx"
413 #endif
414 #define PRINTF_DECIMAL_LONG_U SCANF_DECIMAL_LONG_U
415 
416 /*
417  * Only systems which use configure will have SIZEOF_OFF_T and SIZEOF_LONG
418  * defined, which is ok since those are the same systems which can have
419  * varying sizes for off_t.  The other systems will continue to use "%ld" to
420  * print off_t since off_t is simply a typedef to long for them.
421  */
422 #if defined(SIZEOF_OFF_T) && (SIZEOF_OFF_T > SIZEOF_LONG)
423 # define LONG_LONG_OFF_T
424 #endif
425 
426 /*
427  * The characters and attributes cached for the screen.
428  */
429 typedef char_u schar_T;
430 #ifdef FEAT_SYN_HL
431 typedef unsigned short sattr_T;
432 # define MAX_TYPENR 65535
433 #else
434 typedef unsigned char sattr_T;
435 # define MAX_TYPENR 255
436 #endif
437 
438 /*
439  * The u8char_T can hold one decoded UTF-8 character.
440  * We normally use 32 bits now, since some Asian characters don't fit in 16
441  * bits.  u8char_T is only used for displaying, it could be 16 bits to save
442  * memory.
443  */
444 #ifdef FEAT_MBYTE
445 # ifdef UNICODE16
446 typedef unsigned short u8char_T;    /* short should be 16 bits */
447 # else
448 #  if SIZEOF_INT >= 4
449 typedef unsigned int u8char_T;	    /* int is 32 bits */
450 #  else
451 typedef unsigned long u8char_T;	    /* long should be 32 bits or more */
452 #  endif
453 # endif
454 #endif
455 
456 #ifndef UNIX		    /* For Unix this is included in os_unix.h */
457 # include <stdio.h>
458 # include <ctype.h>
459 #endif
460 
461 #include "ascii.h"
462 #include "keymap.h"
463 #include "term.h"
464 #include "macros.h"
465 
466 #ifdef LATTICE
467 # include <sys/types.h>
468 # include <sys/stat.h>
469 #endif
470 #ifdef _DCC
471 # include <sys/stat.h>
472 #endif
473 #if defined(MSDOS) || defined(MSWIN)
474 # include <sys/stat.h>
475 #endif
476 
477 #if defined(HAVE_ERRNO_H) || defined(DJGPP) || defined(WIN16) \
478 	|| defined(WIN32) || defined(_WIN64) || defined(__EMX__)
479 # include <errno.h>
480 #endif
481 
482 /*
483  * Allow other (non-unix) systems to configure themselves now
484  * These are also in os_unix.h, because osdef.sh needs them there.
485  */
486 #ifndef UNIX
487 /* Note: Some systems need both string.h and strings.h (Savage).  If the
488  * system can't handle this, define NO_STRINGS_WITH_STRING_H. */
489 # ifdef HAVE_STRING_H
490 #  include <string.h>
491 # endif
492 # if defined(HAVE_STRINGS_H) && !defined(NO_STRINGS_WITH_STRING_H)
493 #   include <strings.h>
494 # endif
495 # ifdef HAVE_STAT_H
496 #  include <stat.h>
497 # endif
498 # ifdef HAVE_STDLIB_H
499 #  include <stdlib.h>
500 # endif
501 #endif /* NON-UNIX */
502 
503 #include <assert.h>
504 
505 #ifdef HAVE_STDINT_H
506 # include <stdint.h>
507 #endif
508 #ifdef HAVE_INTTYPES_H
509 # include <inttypes.h>
510 #endif
511 #ifdef HAVE_WCTYPE_H
512 # include <wctype.h>
513 #endif
514 #ifdef HAVE_STDARG_H
515 # include <stdarg.h>
516 #endif
517 
518 # if defined(HAVE_SYS_SELECT_H) && \
519 	(!defined(HAVE_SYS_TIME_H) || defined(SYS_SELECT_WITH_SYS_TIME))
520 #  include <sys/select.h>
521 # endif
522 
523 # ifndef HAVE_SELECT
524 #  ifdef HAVE_SYS_POLL_H
525 #   include <sys/poll.h>
526 #   define HAVE_POLL
527 #  else
528 #   ifdef HAVE_POLL_H
529 #    include <poll.h>
530 #    define HAVE_POLL
531 #   endif
532 #  endif
533 # endif
534 
535 /* ================ end of the header file puzzle =============== */
536 
537 /*
538  * For dynamically loaded imm library. Currently, only for Win32.
539  */
540 #ifdef DYNAMIC_IME
541 # ifndef FEAT_MBYTE_IME
542 #  define FEAT_MBYTE_IME
543 # endif
544 #endif
545 
546 /*
547  * Check input method control.
548  */
549 #if defined(FEAT_XIM) \
550     || (defined(FEAT_GUI) && (defined(FEAT_MBYTE_IME) || defined(GLOBAL_IME))) \
551     || (defined(FEAT_GUI_MAC) && defined(FEAT_MBYTE))
552 # define USE_IM_CONTROL
553 #endif
554 
555 /*
556  * For dynamically loaded gettext library.  Currently, only for Win32.
557  */
558 #ifdef DYNAMIC_GETTEXT
559 # ifndef FEAT_GETTEXT
560 #  define FEAT_GETTEXT
561 # endif
562 /* These are in os_win32.c */
563 extern char *(*dyn_libintl_gettext)(const char *msgid);
564 extern char *(*dyn_libintl_bindtextdomain)(const char *domainname, const char *dirname);
565 extern char *(*dyn_libintl_bind_textdomain_codeset)(const char *domainname, const char *codeset);
566 extern char *(*dyn_libintl_textdomain)(const char *domainname);
567 #endif
568 
569 
570 /*
571  * The _() stuff is for using gettext().  It is a no-op when libintl.h is not
572  * found or the +multilang feature is disabled.
573  */
574 #ifdef FEAT_GETTEXT
575 # ifdef DYNAMIC_GETTEXT
576 #  define _(x) (*dyn_libintl_gettext)((char *)(x))
577 #  define N_(x) x
578 #  define bindtextdomain(domain, dir) (*dyn_libintl_bindtextdomain)((domain), (dir))
579 #  define bind_textdomain_codeset(domain, codeset) (*dyn_libintl_bind_textdomain_codeset)((domain), (codeset))
580 #  if !defined(HAVE_BIND_TEXTDOMAIN_CODESET)
581 #   define HAVE_BIND_TEXTDOMAIN_CODESET 1
582 #  endif
583 #  define textdomain(domain) (*dyn_libintl_textdomain)(domain)
584 # else
585 #  include <libintl.h>
586 #  define _(x) gettext((char *)(x))
587 #  ifdef gettext_noop
588 #   define N_(x) gettext_noop(x)
589 #  else
590 #   define N_(x) x
591 #  endif
592 # endif
593 #else
594 # define _(x) ((char *)(x))
595 # define N_(x) x
596 # ifdef bindtextdomain
597 #  undef bindtextdomain
598 # endif
599 # define bindtextdomain(x, y) /* empty */
600 # ifdef bind_textdomain_codeset
601 #  undef bind_textdomain_codeset
602 # endif
603 # define bind_textdomain_codeset(x, y) /* empty */
604 # ifdef textdomain
605 #  undef textdomain
606 # endif
607 # define textdomain(x) /* empty */
608 #endif
609 
610 /*
611  * flags for update_screen()
612  * The higher the value, the higher the priority
613  */
614 #define VALID			10  /* buffer not changed, or changes marked
615 				       with b_mod_* */
616 #define INVERTED		20  /* redisplay inverted part that changed */
617 #define INVERTED_ALL		25  /* redisplay whole inverted part */
618 #define REDRAW_TOP		30  /* display first w_upd_rows screen lines */
619 #define SOME_VALID		35  /* like NOT_VALID but may scroll */
620 #define NOT_VALID		40  /* buffer needs complete redraw */
621 #define CLEAR			50  /* screen messed up, clear it */
622 
623 /*
624  * Flags for w_valid.
625  * These are set when something in a window structure becomes invalid, except
626  * when the cursor is moved.  Call check_cursor_moved() before testing one of
627  * the flags.
628  * These are reset when that thing has been updated and is valid again.
629  *
630  * Every function that invalidates one of these must call one of the
631  * invalidate_* functions.
632  *
633  * w_valid is supposed to be used only in screen.c.  From other files, use the
634  * functions that set or reset the flags.
635  *
636  * VALID_BOTLINE    VALID_BOTLINE_AP
637  *     on		on		w_botline valid
638  *     off		on		w_botline approximated
639  *     off		off		w_botline not valid
640  *     on		off		not possible
641  */
642 #define VALID_WROW	0x01	/* w_wrow (window row) is valid */
643 #define VALID_WCOL	0x02	/* w_wcol (window col) is valid */
644 #define VALID_VIRTCOL	0x04	/* w_virtcol (file col) is valid */
645 #define VALID_CHEIGHT	0x08	/* w_cline_height and w_cline_folded valid */
646 #define VALID_CROW	0x10	/* w_cline_row is valid */
647 #define VALID_BOTLINE	0x20	/* w_botine and w_empty_rows are valid */
648 #define VALID_BOTLINE_AP 0x40	/* w_botine is approximated */
649 #define VALID_TOPLINE	0x80	/* w_topline is valid (for cursor position) */
650 
651 /*
652  * Terminal highlighting attribute bits.
653  * Attributes above HL_ALL are used for syntax highlighting.
654  */
655 #define HL_NORMAL		0x00
656 #define HL_INVERSE		0x01
657 #define HL_BOLD			0x02
658 #define HL_ITALIC		0x04
659 #define HL_UNDERLINE		0x08
660 #define HL_UNDERCURL		0x10
661 #define HL_STANDOUT		0x20
662 #define HL_ALL			0x3f
663 
664 /* special attribute addition: Put message in history */
665 #define MSG_HIST		0x1000
666 
667 /*
668  * values for State
669  *
670  * The lower bits up to 0x20 are used to distinguish normal/visual/op_pending
671  * and cmdline/insert+replace mode.  This is used for mapping.  If none of
672  * these bits are set, no mapping is done.
673  * The upper bits are used to distinguish between other states.
674  */
675 #define NORMAL		0x01	/* Normal mode, command expected */
676 #define VISUAL		0x02	/* Visual mode - use get_real_state() */
677 #define OP_PENDING	0x04	/* Normal mode, operator is pending - use
678 				   get_real_state() */
679 #define CMDLINE		0x08	/* Editing command line */
680 #define INSERT		0x10	/* Insert mode */
681 #define LANGMAP		0x20	/* Language mapping, can be combined with
682 				   INSERT and CMDLINE */
683 
684 #define REPLACE_FLAG	0x40	/* Replace mode flag */
685 #define REPLACE		(REPLACE_FLAG + INSERT)
686 #ifdef FEAT_VREPLACE
687 # define VREPLACE_FLAG	0x80	/* Virtual-replace mode flag */
688 # define VREPLACE	(REPLACE_FLAG + VREPLACE_FLAG + INSERT)
689 #endif
690 #define LREPLACE	(REPLACE_FLAG + LANGMAP)
691 
692 #define NORMAL_BUSY	(0x100 + NORMAL) /* Normal mode, busy with a command */
693 #define HITRETURN	(0x200 + NORMAL) /* waiting for return or command */
694 #define ASKMORE		0x300	/* Asking if you want --more-- */
695 #define SETWSIZE	0x400	/* window size has changed */
696 #define ABBREV		0x500	/* abbreviation instead of mapping */
697 #define EXTERNCMD	0x600	/* executing an external command */
698 #define SHOWMATCH	(0x700 + INSERT) /* show matching paren */
699 #define CONFIRM		0x800	/* ":confirm" prompt */
700 #define SELECTMODE	0x1000	/* Select mode, only for mappings */
701 
702 #define MAP_ALL_MODES	(0x3f | SELECTMODE)	/* all mode bits used for
703 						 * mapping */
704 
705 /* directions */
706 #define FORWARD			1
707 #define BACKWARD		(-1)
708 #define FORWARD_FILE		3
709 #define BACKWARD_FILE		(-3)
710 
711 /* return values for functions */
712 #if !(defined(OK) && (OK == 1))
713 /* OK already defined to 1 in MacOS X curses, skip this */
714 # define OK			1
715 #endif
716 #define FAIL			0
717 #define NOTDONE			2   /* not OK or FAIL but skipped */
718 
719 /* flags for b_flags */
720 #define BF_RECOVERED	0x01	/* buffer has been recovered */
721 #define BF_CHECK_RO	0x02	/* need to check readonly when loading file
722 				   into buffer (set by ":e", may be reset by
723 				   ":buf" */
724 #define BF_NEVERLOADED	0x04	/* file has never been loaded into buffer,
725 				   many variables still need to be set */
726 #define BF_NOTEDITED	0x08	/* Set when file name is changed after
727 				   starting to edit, reset when file is
728 				   written out. */
729 #define BF_NEW		0x10	/* file didn't exist when editing started */
730 #define BF_NEW_W	0x20	/* Warned for BF_NEW and file created */
731 #define BF_READERR	0x40	/* got errors while reading the file */
732 #define BF_DUMMY	0x80	/* dummy buffer, only used internally */
733 #define BF_PRESERVED	0x100	/* ":preserve" was used */
734 
735 /* Mask to check for flags that prevent normal writing */
736 #define BF_WRITE_MASK	(BF_NOTEDITED + BF_NEW + BF_READERR)
737 
738 /*
739  * values for xp_context when doing command line completion
740  */
741 #define EXPAND_UNSUCCESSFUL	(-2)
742 #define EXPAND_OK		(-1)
743 #define EXPAND_NOTHING		0
744 #define EXPAND_COMMANDS		1
745 #define EXPAND_FILES		2
746 #define EXPAND_DIRECTORIES	3
747 #define EXPAND_SETTINGS		4
748 #define EXPAND_BOOL_SETTINGS	5
749 #define EXPAND_TAGS		6
750 #define EXPAND_OLD_SETTING	7
751 #define EXPAND_HELP		8
752 #define EXPAND_BUFFERS		9
753 #define EXPAND_EVENTS		10
754 #define EXPAND_MENUS		11
755 #define EXPAND_SYNTAX		12
756 #define EXPAND_HIGHLIGHT	13
757 #define EXPAND_AUGROUP		14
758 #define EXPAND_USER_VARS	15
759 #define EXPAND_MAPPINGS		16
760 #define EXPAND_TAGS_LISTFILES	17
761 #define EXPAND_FUNCTIONS	18
762 #define EXPAND_USER_FUNC	19
763 #define EXPAND_EXPRESSION	20
764 #define EXPAND_MENUNAMES	21
765 #define EXPAND_USER_COMMANDS	22
766 #define EXPAND_USER_CMD_FLAGS	23
767 #define EXPAND_USER_NARGS	24
768 #define EXPAND_USER_COMPLETE	25
769 #define EXPAND_ENV_VARS		26
770 #define EXPAND_LANGUAGE		27
771 #define EXPAND_COLORS		28
772 #define EXPAND_COMPILER		29
773 #define EXPAND_USER_DEFINED	30
774 #define EXPAND_USER_LIST	31
775 #define EXPAND_SHELLCMD		32
776 #define EXPAND_CSCOPE		33
777 #define EXPAND_SIGN		34
778 #define EXPAND_PROFILE		35
779 #define EXPAND_BEHAVE		36
780 #define EXPAND_FILETYPE		37
781 #define EXPAND_FILES_IN_PATH	38
782 #define EXPAND_OWNSYNTAX	39
783 #define EXPAND_LOCALES		40
784 #define EXPAND_HISTORY		41
785 #define EXPAND_USER		42
786 
787 /* Values for exmode_active (0 is no exmode) */
788 #define EXMODE_NORMAL		1
789 #define EXMODE_VIM		2
790 
791 /* Values for nextwild() and ExpandOne().  See ExpandOne() for meaning. */
792 #define WILD_FREE		1
793 #define WILD_EXPAND_FREE	2
794 #define WILD_EXPAND_KEEP	3
795 #define WILD_NEXT		4
796 #define WILD_PREV		5
797 #define WILD_ALL		6
798 #define WILD_LONGEST		7
799 #define WILD_ALL_KEEP		8
800 
801 #define WILD_LIST_NOTFOUND	1
802 #define WILD_HOME_REPLACE	2
803 #define WILD_USE_NL		4
804 #define WILD_NO_BEEP		8
805 #define WILD_ADD_SLASH		16
806 #define WILD_KEEP_ALL		32
807 #define WILD_SILENT		64
808 #define WILD_ESCAPE		128
809 #define WILD_ICASE		256
810 
811 /* Flags for expand_wildcards() */
812 #define EW_DIR		0x01	/* include directory names */
813 #define EW_FILE		0x02	/* include file names */
814 #define EW_NOTFOUND	0x04	/* include not found names */
815 #define EW_ADDSLASH	0x08	/* append slash to directory name */
816 #define EW_KEEPALL	0x10	/* keep all matches */
817 #define EW_SILENT	0x20	/* don't print "1 returned" from shell */
818 #define EW_EXEC		0x40	/* executable files */
819 #define EW_PATH		0x80	/* search in 'path' too */
820 #define EW_ICASE	0x100	/* ignore case */
821 #define EW_NOERROR	0x200	/* no error for bad regexp */
822 #define EW_NOTWILD	0x400	/* add match with literal name if exists */
823 /* Note: mostly EW_NOTFOUND and EW_SILENT are mutually exclusive: EW_NOTFOUND
824  * is used when executing commands and EW_SILENT for interactive expanding. */
825 
826 /* Flags for find_file_*() functions. */
827 #define FINDFILE_FILE	0	/* only files */
828 #define FINDFILE_DIR	1	/* only directories */
829 #define FINDFILE_BOTH	2	/* files and directories */
830 
831 #ifdef FEAT_VERTSPLIT
832 # define W_WINCOL(wp)	(wp->w_wincol)
833 # define W_WIDTH(wp)	(wp->w_width)
834 # define W_ENDCOL(wp)	(wp->w_wincol + wp->w_width)
835 # define W_VSEP_WIDTH(wp) (wp->w_vsep_width)
836 #else
837 # define W_WINCOL(wp)	0
838 # define W_WIDTH(wp)	Columns
839 # define W_ENDCOL(wp)	Columns
840 # define W_VSEP_WIDTH(wp) 0
841 #endif
842 #ifdef FEAT_WINDOWS
843 # define W_STATUS_HEIGHT(wp) (wp->w_status_height)
844 # define W_WINROW(wp)	(wp->w_winrow)
845 #else
846 # define W_STATUS_HEIGHT(wp) 0
847 # define W_WINROW(wp)	0
848 #endif
849 
850 #ifdef NO_EXPANDPATH
851 # define gen_expand_wildcards mch_expand_wildcards
852 #endif
853 
854 /* Values for the find_pattern_in_path() function args 'type' and 'action': */
855 #define FIND_ANY	1
856 #define FIND_DEFINE	2
857 #define CHECK_PATH	3
858 
859 #define ACTION_SHOW	1
860 #define ACTION_GOTO	2
861 #define ACTION_SPLIT	3
862 #define ACTION_SHOW_ALL	4
863 #ifdef FEAT_INS_EXPAND
864 # define ACTION_EXPAND	5
865 #endif
866 
867 #ifdef FEAT_SYN_HL
868 # define SST_MIN_ENTRIES 150	/* minimal size for state stack array */
869 # ifdef FEAT_GUI_W16
870 #  define SST_MAX_ENTRIES 500	/* (only up to 64K blocks) */
871 # else
872 #  define SST_MAX_ENTRIES 1000	/* maximal size for state stack array */
873 # endif
874 # define SST_FIX_STATES	 7	/* size of sst_stack[]. */
875 # define SST_DIST	 16	/* normal distance between entries */
876 # define SST_INVALID	(synstate_T *)-1	/* invalid syn_state pointer */
877 
878 # define HL_CONTAINED	0x01	/* not used on toplevel */
879 # define HL_TRANSP	0x02	/* has no highlighting	*/
880 # define HL_ONELINE	0x04	/* match within one line only */
881 # define HL_HAS_EOL	0x08	/* end pattern that matches with $ */
882 # define HL_SYNC_HERE	0x10	/* sync point after this item (syncing only) */
883 # define HL_SYNC_THERE	0x20	/* sync point at current line (syncing only) */
884 # define HL_MATCH	0x40	/* use match ID instead of item ID */
885 # define HL_SKIPNL	0x80	/* nextgroup can skip newlines */
886 # define HL_SKIPWHITE	0x100	/* nextgroup can skip white space */
887 # define HL_SKIPEMPTY	0x200	/* nextgroup can skip empty lines */
888 # define HL_KEEPEND	0x400	/* end match always kept */
889 # define HL_EXCLUDENL	0x800	/* exclude NL from match */
890 # define HL_DISPLAY	0x1000	/* only used for displaying, not syncing */
891 # define HL_FOLD	0x2000	/* define fold */
892 # define HL_EXTEND	0x4000	/* ignore a keepend */
893 # define HL_MATCHCONT	0x8000	/* match continued from previous line */
894 # define HL_TRANS_CONT	0x10000 /* transparent item without contains arg */
895 # define HL_CONCEAL	0x20000 /* can be concealed */
896 # define HL_CONCEALENDS	0x40000 /* can be concealed */
897 #endif
898 
899 /* Values for 'options' argument in do_search() and searchit() */
900 #define SEARCH_REV    0x01  /* go in reverse of previous dir. */
901 #define SEARCH_ECHO   0x02  /* echo the search command and handle options */
902 #define SEARCH_MSG    0x0c  /* give messages (yes, it's not 0x04) */
903 #define SEARCH_NFMSG  0x08  /* give all messages except not found */
904 #define SEARCH_OPT    0x10  /* interpret optional flags */
905 #define SEARCH_HIS    0x20  /* put search pattern in history */
906 #define SEARCH_END    0x40  /* put cursor at end of match */
907 #define SEARCH_NOOF   0x80  /* don't add offset to position */
908 #define SEARCH_START 0x100  /* start search without col offset */
909 #define SEARCH_MARK  0x200  /* set previous context mark */
910 #define SEARCH_KEEP  0x400  /* keep previous search pattern */
911 #define SEARCH_PEEK  0x800  /* peek for typed char, cancel search */
912 
913 /* Values for find_ident_under_cursor() */
914 #define FIND_IDENT	1	/* find identifier (word) */
915 #define FIND_STRING	2	/* find any string (WORD) */
916 #define FIND_EVAL	4	/* include "->", "[]" and "." */
917 
918 /* Values for file_name_in_line() */
919 #define FNAME_MESS	1	/* give error message */
920 #define FNAME_EXP	2	/* expand to path */
921 #define FNAME_HYP	4	/* check for hypertext link */
922 #define FNAME_INCL	8	/* apply 'includeexpr' */
923 #define FNAME_REL	16	/* ".." and "./" are relative to the (current)
924 				   file instead of the current directory */
925 
926 /* Values for buflist_getfile() */
927 #define GETF_SETMARK	0x01	/* set pcmark before jumping */
928 #define GETF_ALT	0x02	/* jumping to alternate file (not buf num) */
929 #define GETF_SWITCH	0x04	/* respect 'switchbuf' settings when jumping */
930 
931 /* Values for buflist_new() flags */
932 #define BLN_CURBUF	1	/* May re-use curbuf for new buffer */
933 #define BLN_LISTED	2	/* Put new buffer in buffer list */
934 #define BLN_DUMMY	4	/* Allocating dummy buffer */
935 
936 /* Values for in_cinkeys() */
937 #define KEY_OPEN_FORW	0x101
938 #define KEY_OPEN_BACK	0x102
939 #define KEY_COMPLETE	0x103	/* end of completion */
940 
941 /* Values for "noremap" argument of ins_typebuf().  Also used for
942  * map->m_noremap and menu->noremap[]. */
943 #define REMAP_YES	0	/* allow remapping */
944 #define REMAP_NONE	-1	/* no remapping */
945 #define REMAP_SCRIPT	-2	/* remap script-local mappings only */
946 #define REMAP_SKIP	-3	/* no remapping for first char */
947 
948 /* Values for mch_call_shell() second argument */
949 #define SHELL_FILTER	1	/* filtering text */
950 #define SHELL_EXPAND	2	/* expanding wildcards */
951 #define SHELL_COOKED	4	/* set term to cooked mode */
952 #define SHELL_DOOUT	8	/* redirecting output */
953 #define SHELL_SILENT	16	/* don't print error returned by command */
954 #define SHELL_READ	32	/* read lines and insert into buffer */
955 #define SHELL_WRITE	64	/* write lines from buffer */
956 
957 /* Values returned by mch_nodetype() */
958 #define NODE_NORMAL	0	/* file or directory, check with mch_isdir()*/
959 #define NODE_WRITABLE	1	/* something we can write to (character
960 				   device, fifo, socket, ..) */
961 #define NODE_OTHER	2	/* non-writable thing (e.g., block device) */
962 
963 /* Values for readfile() flags */
964 #define READ_NEW	0x01	/* read a file into a new buffer */
965 #define READ_FILTER	0x02	/* read filter output */
966 #define READ_STDIN	0x04	/* read from stdin */
967 #define READ_BUFFER	0x08	/* read from curbuf (converting stdin) */
968 #define READ_DUMMY	0x10	/* reading into a dummy buffer */
969 #define READ_KEEP_UNDO	0x20	/* keep undo info*/
970 
971 /* Values for change_indent() */
972 #define INDENT_SET	1	/* set indent */
973 #define INDENT_INC	2	/* increase indent */
974 #define INDENT_DEC	3	/* decrease indent */
975 
976 /* Values for flags argument for findmatchlimit() */
977 #define FM_BACKWARD	0x01	/* search backwards */
978 #define FM_FORWARD	0x02	/* search forwards */
979 #define FM_BLOCKSTOP	0x04	/* stop at start/end of block */
980 #define FM_SKIPCOMM	0x08	/* skip comments */
981 
982 /* Values for action argument for do_buffer() */
983 #define DOBUF_GOTO	0	/* go to specified buffer */
984 #define DOBUF_SPLIT	1	/* split window and go to specified buffer */
985 #define DOBUF_UNLOAD	2	/* unload specified buffer(s) */
986 #define DOBUF_DEL	3	/* delete specified buffer(s) from buflist */
987 #define DOBUF_WIPE	4	/* delete specified buffer(s) really */
988 
989 /* Values for start argument for do_buffer() */
990 #define DOBUF_CURRENT	0	/* "count" buffer from current buffer */
991 #define DOBUF_FIRST	1	/* "count" buffer from first buffer */
992 #define DOBUF_LAST	2	/* "count" buffer from last buffer */
993 #define DOBUF_MOD	3	/* "count" mod. buffer from current buffer */
994 
995 /* Values for sub_cmd and which_pat argument for search_regcomp() */
996 /* Also used for which_pat argument for searchit() */
997 #define RE_SEARCH	0	/* save/use pat in/from search_pattern */
998 #define RE_SUBST	1	/* save/use pat in/from subst_pattern */
999 #define RE_BOTH		2	/* save pat in both patterns */
1000 #define RE_LAST		2	/* use last used pattern if "pat" is NULL */
1001 
1002 /* Second argument for vim_regcomp(). */
1003 #define RE_MAGIC	1	/* 'magic' option */
1004 #define RE_STRING	2	/* match in string instead of buffer text */
1005 #define RE_STRICT	4	/* don't allow [abc] without ] */
1006 
1007 #ifdef FEAT_SYN_HL
1008 /* values for reg_do_extmatch */
1009 # define REX_SET	1	/* to allow \z\(...\), */
1010 # define REX_USE	2	/* to allow \z\1 et al. */
1011 #endif
1012 
1013 /* Return values for fullpathcmp() */
1014 /* Note: can use (fullpathcmp() & FPC_SAME) to check for equal files */
1015 #define FPC_SAME	1	/* both exist and are the same file. */
1016 #define FPC_DIFF	2	/* both exist and are different files. */
1017 #define FPC_NOTX	4	/* both don't exist. */
1018 #define FPC_DIFFX	6	/* one of them doesn't exist. */
1019 #define FPC_SAMEX	7	/* both don't exist and file names are same. */
1020 
1021 /* flags for do_ecmd() */
1022 #define ECMD_HIDE	0x01	/* don't free the current buffer */
1023 #define ECMD_SET_HELP	0x02	/* set b_help flag of (new) buffer before
1024 				   opening file */
1025 #define ECMD_OLDBUF	0x04	/* use existing buffer if it exists */
1026 #define ECMD_FORCEIT	0x08	/* ! used in Ex command */
1027 #define ECMD_ADDBUF	0x10	/* don't edit, just add to buffer list */
1028 
1029 /* for lnum argument in do_ecmd() */
1030 #define ECMD_LASTL	(linenr_T)0	/* use last position in loaded file */
1031 #define ECMD_LAST	(linenr_T)-1	/* use last position in all files */
1032 #define ECMD_ONE	(linenr_T)1	/* use first line */
1033 
1034 /* flags for do_cmdline() */
1035 #define DOCMD_VERBOSE	0x01	/* included command in error message */
1036 #define DOCMD_NOWAIT	0x02	/* don't call wait_return() and friends */
1037 #define DOCMD_REPEAT	0x04	/* repeat exec. until getline() returns NULL */
1038 #define DOCMD_KEYTYPED	0x08	/* don't reset KeyTyped */
1039 #define DOCMD_EXCRESET	0x10	/* reset exception environment (for debugging)*/
1040 #define DOCMD_KEEPLINE  0x20	/* keep typed line for repeating with "." */
1041 
1042 /* flags for beginline() */
1043 #define BL_WHITE	1	/* cursor on first non-white in the line */
1044 #define BL_SOL		2	/* use 'sol' option */
1045 #define BL_FIX		4	/* don't leave cursor on a NUL */
1046 
1047 /* flags for mf_sync() */
1048 #define MFS_ALL		1	/* also sync blocks with negative numbers */
1049 #define MFS_STOP	2	/* stop syncing when a character is available */
1050 #define MFS_FLUSH	4	/* flushed file to disk */
1051 #define MFS_ZERO	8	/* only write block 0 */
1052 
1053 /* flags for buf_copy_options() */
1054 #define BCO_ENTER	1	/* going to enter the buffer */
1055 #define BCO_ALWAYS	2	/* always copy the options */
1056 #define BCO_NOHELP	4	/* don't touch the help related options */
1057 
1058 /* flags for do_put() */
1059 #define PUT_FIXINDENT	1	/* make indent look nice */
1060 #define PUT_CURSEND	2	/* leave cursor after end of new text */
1061 #define PUT_CURSLINE	4	/* leave cursor on last line of new text */
1062 #define PUT_LINE	8	/* put register as lines */
1063 #define PUT_LINE_SPLIT	16	/* split line for linewise register */
1064 #define PUT_LINE_FORWARD 32	/* put linewise register below Visual sel. */
1065 
1066 /* flags for set_indent() */
1067 #define SIN_CHANGED	1	/* call changed_bytes() when line changed */
1068 #define SIN_INSERT	2	/* insert indent before existing text */
1069 #define SIN_UNDO	4	/* save line for undo before changing it */
1070 
1071 /* flags for insertchar() */
1072 #define INSCHAR_FORMAT	1	/* force formatting */
1073 #define INSCHAR_DO_COM	2	/* format comments */
1074 #define INSCHAR_CTRLV	4	/* char typed just after CTRL-V */
1075 #define INSCHAR_NO_FEX	8	/* don't use 'formatexpr' */
1076 #define INSCHAR_COM_LIST 16	/* format comments with list/2nd line indent */
1077 
1078 /* flags for open_line() */
1079 #define OPENLINE_DELSPACES  1	/* delete spaces after cursor */
1080 #define OPENLINE_DO_COM	    2	/* format comments */
1081 #define OPENLINE_KEEPTRAIL  4	/* keep trailing spaces */
1082 #define OPENLINE_MARKFIX    8	/* fix mark positions */
1083 #define OPENLINE_COM_LIST  16	/* format comments with list/2nd line indent */
1084 
1085 /*
1086  * There are four history tables:
1087  */
1088 #define HIST_CMD	0	/* colon commands */
1089 #define HIST_SEARCH	1	/* search commands */
1090 #define HIST_EXPR	2	/* expressions (from entering = register) */
1091 #define HIST_INPUT	3	/* input() lines */
1092 #define HIST_DEBUG	4	/* debug commands */
1093 #define HIST_COUNT	5	/* number of history tables */
1094 
1095 /*
1096  * Flags for chartab[].
1097  */
1098 #define CT_CELL_MASK	0x07	/* mask: nr of display cells (1, 2 or 4) */
1099 #define CT_PRINT_CHAR	0x10	/* flag: set for printable chars */
1100 #define CT_ID_CHAR	0x20	/* flag: set for ID chars */
1101 #define CT_FNAME_CHAR	0x40	/* flag: set for file name chars */
1102 
1103 /*
1104  * Values for do_tag().
1105  */
1106 #define DT_TAG		1	/* jump to newer position or same tag again */
1107 #define DT_POP		2	/* jump to older position */
1108 #define DT_NEXT		3	/* jump to next match of same tag */
1109 #define DT_PREV		4	/* jump to previous match of same tag */
1110 #define DT_FIRST	5	/* jump to first match of same tag */
1111 #define DT_LAST		6	/* jump to first match of same tag */
1112 #define DT_SELECT	7	/* jump to selection from list */
1113 #define DT_HELP		8	/* like DT_TAG, but no wildcards */
1114 #define DT_JUMP		9	/* jump to new tag or selection from list */
1115 #define DT_CSCOPE	10	/* cscope find command (like tjump) */
1116 #define DT_LTAG		11	/* tag using location list */
1117 #define DT_FREE		99	/* free cached matches */
1118 
1119 /*
1120  * flags for find_tags().
1121  */
1122 #define TAG_HELP	1	/* only search for help tags */
1123 #define TAG_NAMES	2	/* only return name of tag */
1124 #define	TAG_REGEXP	4	/* use tag pattern as regexp */
1125 #define	TAG_NOIC	8	/* don't always ignore case */
1126 #ifdef FEAT_CSCOPE
1127 # define TAG_CSCOPE	16	/* cscope tag */
1128 #endif
1129 #define TAG_VERBOSE	32	/* message verbosity */
1130 #define TAG_INS_COMP	64	/* Currently doing insert completion */
1131 #define TAG_KEEP_LANG	128	/* keep current language */
1132 
1133 #define TAG_MANY	300	/* When finding many tags (for completion),
1134 				   find up to this many tags */
1135 
1136 /*
1137  * Types of dialogs passed to do_vim_dialog().
1138  */
1139 #define VIM_GENERIC	0
1140 #define VIM_ERROR	1
1141 #define VIM_WARNING	2
1142 #define VIM_INFO	3
1143 #define VIM_QUESTION	4
1144 #define VIM_LAST_TYPE	4	/* sentinel value */
1145 
1146 /*
1147  * Return values for functions like gui_yesnocancel()
1148  */
1149 #define VIM_YES		2
1150 #define VIM_NO		3
1151 #define VIM_CANCEL	4
1152 #define VIM_ALL		5
1153 #define VIM_DISCARDALL  6
1154 
1155 /*
1156  * arguments for win_split()
1157  */
1158 #define WSP_ROOM	1	/* require enough room */
1159 #define WSP_VERT	2	/* split vertically */
1160 #define WSP_TOP		4	/* window at top-left of shell */
1161 #define WSP_BOT		8	/* window at bottom-right of shell */
1162 #define WSP_HELP	16	/* creating the help window */
1163 #define WSP_BELOW	32	/* put new window below/right */
1164 #define WSP_ABOVE	64	/* put new window above/left */
1165 #define WSP_NEWLOC	128	/* don't copy location list */
1166 
1167 /*
1168  * arguments for gui_set_shellsize()
1169  */
1170 #define RESIZE_VERT	1	/* resize vertically */
1171 #define RESIZE_HOR	2	/* resize horizontally */
1172 #define RESIZE_BOTH	15	/* resize in both directions */
1173 
1174 /*
1175  * "flags" values for option-setting functions.
1176  * When OPT_GLOBAL and OPT_LOCAL are both missing, set both local and global
1177  * values, get local value.
1178  */
1179 #define OPT_FREE	1	/* free old value if it was allocated */
1180 #define OPT_GLOBAL	2	/* use global value */
1181 #define OPT_LOCAL	4	/* use local value */
1182 #define OPT_MODELINE	8	/* option in modeline */
1183 #define OPT_WINONLY	16	/* only set window-local options */
1184 #define OPT_NOWIN	32	/* don't set window-local options */
1185 
1186 /* Magic chars used in confirm dialog strings */
1187 #define DLG_BUTTON_SEP	'\n'
1188 #define DLG_HOTKEY_CHAR	'&'
1189 
1190 /* Values for "starting" */
1191 #define NO_SCREEN	2	/* no screen updating yet */
1192 #define NO_BUFFERS	1	/* not all buffers loaded yet */
1193 /*			0	   not starting anymore */
1194 
1195 /* Values for swap_exists_action: what to do when swap file already exists */
1196 #define SEA_NONE	0	/* don't use dialog */
1197 #define SEA_DIALOG	1	/* use dialog when possible */
1198 #define SEA_QUIT	2	/* quit editing the file */
1199 #define SEA_RECOVER	3	/* recover the file */
1200 
1201 /*
1202  * Minimal size for block 0 of a swap file.
1203  * NOTE: This depends on size of struct block0! It's not done with a sizeof(),
1204  * because struct block0 is defined in memline.c (Sorry).
1205  * The maximal block size is arbitrary.
1206  */
1207 #define MIN_SWAP_PAGE_SIZE 1048
1208 #define MAX_SWAP_PAGE_SIZE 50000
1209 
1210 /* Special values for current_SID. */
1211 #define SID_MODELINE	-1	/* when using a modeline */
1212 #define SID_CMDARG	-2	/* for "--cmd" argument */
1213 #define SID_CARG	-3	/* for "-c" argument */
1214 #define SID_ENV		-4	/* for sourcing environment variable */
1215 #define SID_ERROR	-5	/* option was reset because of an error */
1216 #define SID_NONE	-6	/* don't set scriptID */
1217 
1218 /*
1219  * Events for autocommands.
1220  */
1221 enum auto_event
1222 {
1223     EVENT_BUFADD = 0,		/* after adding a buffer to the buffer list */
1224     EVENT_BUFNEW,		/* after creating any buffer */
1225     EVENT_BUFDELETE,		/* deleting a buffer from the buffer list */
1226     EVENT_BUFWIPEOUT,		/* just before really deleting a buffer */
1227     EVENT_BUFENTER,		/* after entering a buffer */
1228     EVENT_BUFFILEPOST,		/* after renaming a buffer */
1229     EVENT_BUFFILEPRE,		/* before renaming a buffer */
1230     EVENT_BUFLEAVE,		/* before leaving a buffer */
1231     EVENT_BUFNEWFILE,		/* when creating a buffer for a new file */
1232     EVENT_BUFREADPOST,		/* after reading a buffer */
1233     EVENT_BUFREADPRE,		/* before reading a buffer */
1234     EVENT_BUFREADCMD,		/* read buffer using command */
1235     EVENT_BUFUNLOAD,		/* just before unloading a buffer */
1236     EVENT_BUFHIDDEN,		/* just after buffer becomes hidden */
1237     EVENT_BUFWINENTER,		/* after showing a buffer in a window */
1238     EVENT_BUFWINLEAVE,		/* just after buffer removed from window */
1239     EVENT_BUFWRITEPOST,		/* after writing a buffer */
1240     EVENT_BUFWRITEPRE,		/* before writing a buffer */
1241     EVENT_BUFWRITECMD,		/* write buffer using command */
1242     EVENT_CMDWINENTER,		/* after entering the cmdline window */
1243     EVENT_CMDWINLEAVE,		/* before leaving the cmdline window */
1244     EVENT_COLORSCHEME,		/* after loading a colorscheme */
1245     EVENT_COMPLETEDONE,		/* after finishing insert complete */
1246     EVENT_FILEAPPENDPOST,	/* after appending to a file */
1247     EVENT_FILEAPPENDPRE,	/* before appending to a file */
1248     EVENT_FILEAPPENDCMD,	/* append to a file using command */
1249     EVENT_FILECHANGEDSHELL,	/* after shell command that changed file */
1250     EVENT_FILECHANGEDSHELLPOST,	/* after (not) reloading changed file */
1251     EVENT_FILECHANGEDRO,	/* before first change to read-only file */
1252     EVENT_FILEREADPOST,		/* after reading a file */
1253     EVENT_FILEREADPRE,		/* before reading a file */
1254     EVENT_FILEREADCMD,		/* read from a file using command */
1255     EVENT_FILETYPE,		/* new file type detected (user defined) */
1256     EVENT_FILEWRITEPOST,	/* after writing a file */
1257     EVENT_FILEWRITEPRE,		/* before writing a file */
1258     EVENT_FILEWRITECMD,		/* write to a file using command */
1259     EVENT_FILTERREADPOST,	/* after reading from a filter */
1260     EVENT_FILTERREADPRE,	/* before reading from a filter */
1261     EVENT_FILTERWRITEPOST,	/* after writing to a filter */
1262     EVENT_FILTERWRITEPRE,	/* before writing to a filter */
1263     EVENT_FOCUSGAINED,		/* got the focus */
1264     EVENT_FOCUSLOST,		/* lost the focus to another app */
1265     EVENT_GUIENTER,		/* after starting the GUI */
1266     EVENT_GUIFAILED,		/* after starting the GUI failed */
1267     EVENT_INSERTCHANGE,		/* when changing Insert/Replace mode */
1268     EVENT_INSERTENTER,		/* when entering Insert mode */
1269     EVENT_INSERTLEAVE,		/* when leaving Insert mode */
1270     EVENT_MENUPOPUP,		/* just before popup menu is displayed */
1271     EVENT_QUICKFIXCMDPOST,	/* after :make, :grep etc. */
1272     EVENT_QUICKFIXCMDPRE,	/* before :make, :grep etc. */
1273     EVENT_QUITPRE,		/* before :quit */
1274     EVENT_SESSIONLOADPOST,	/* after loading a session file */
1275     EVENT_STDINREADPOST,	/* after reading from stdin */
1276     EVENT_STDINREADPRE,		/* before reading from stdin */
1277     EVENT_SYNTAX,		/* syntax selected */
1278     EVENT_TERMCHANGED,		/* after changing 'term' */
1279     EVENT_TERMRESPONSE,		/* after setting "v:termresponse" */
1280     EVENT_USER,			/* user defined autocommand */
1281     EVENT_VIMENTER,		/* after starting Vim */
1282     EVENT_VIMLEAVE,		/* before exiting Vim */
1283     EVENT_VIMLEAVEPRE,		/* before exiting Vim and writing .viminfo */
1284     EVENT_VIMRESIZED,		/* after Vim window was resized */
1285     EVENT_WINENTER,		/* after entering a window */
1286     EVENT_WINLEAVE,		/* before leaving a window */
1287     EVENT_ENCODINGCHANGED,	/* after changing the 'encoding' option */
1288     EVENT_INSERTCHARPRE,	/* before inserting a char */
1289     EVENT_CURSORHOLD,		/* cursor in same position for a while */
1290     EVENT_CURSORHOLDI,		/* idem, in Insert mode */
1291     EVENT_FUNCUNDEFINED,	/* if calling a function which doesn't exist */
1292     EVENT_REMOTEREPLY,		/* upon string reception from a remote vim */
1293     EVENT_SWAPEXISTS,		/* found existing swap file */
1294     EVENT_SOURCEPRE,		/* before sourcing a Vim script */
1295     EVENT_SOURCECMD,		/* sourcing a Vim script using command */
1296     EVENT_SPELLFILEMISSING,	/* spell file missing */
1297     EVENT_CURSORMOVED,		/* cursor was moved */
1298     EVENT_CURSORMOVEDI,		/* cursor was moved in Insert mode */
1299     EVENT_TABLEAVE,		/* before leaving a tab page */
1300     EVENT_TABENTER,		/* after entering a tab page */
1301     EVENT_SHELLCMDPOST,		/* after ":!cmd" */
1302     EVENT_SHELLFILTERPOST,	/* after ":1,2!cmd", ":w !cmd", ":r !cmd". */
1303     NUM_EVENTS			/* MUST be the last one */
1304 };
1305 
1306 typedef enum auto_event event_T;
1307 
1308 /*
1309  * Values for index in highlight_attr[].
1310  * When making changes, also update HL_FLAGS below!  And update the default
1311  * value of 'highlight' in option.c.
1312  */
1313 typedef enum
1314 {
1315     HLF_8 = 0	    /* Meta & special keys listed with ":map", text that is
1316 		       displayed different from what it is */
1317     , HLF_AT	    /* @ and ~ characters at end of screen, characters that
1318 		       don't really exist in the text */
1319     , HLF_D	    /* directories in CTRL-D listing */
1320     , HLF_E	    /* error messages */
1321     , HLF_H	    /* obsolete, ignored */
1322     , HLF_I	    /* incremental search */
1323     , HLF_L	    /* last search string */
1324     , HLF_M	    /* "--More--" message */
1325     , HLF_CM	    /* Mode (e.g., "-- INSERT --") */
1326     , HLF_N	    /* line number for ":number" and ":#" commands */
1327     , HLF_CLN	    /* current line number */
1328     , HLF_R	    /* return to continue message and yes/no questions */
1329     , HLF_S	    /* status lines */
1330     , HLF_SNC	    /* status lines of not-current windows */
1331     , HLF_C	    /* column to separate vertically split windows */
1332     , HLF_T	    /* Titles for output from ":set all", ":autocmd" etc. */
1333     , HLF_V	    /* Visual mode */
1334     , HLF_VNC	    /* Visual mode, autoselecting and not clipboard owner */
1335     , HLF_W	    /* warning messages */
1336     , HLF_WM	    /* Wildmenu highlight */
1337     , HLF_FL	    /* Folded line */
1338     , HLF_FC	    /* Fold column */
1339     , HLF_ADD	    /* Added diff line */
1340     , HLF_CHD	    /* Changed diff line */
1341     , HLF_DED	    /* Deleted diff line */
1342     , HLF_TXD	    /* Text Changed in diff line */
1343     , HLF_CONCEAL   /* Concealed text */
1344     , HLF_SC	    /* Sign column */
1345     , HLF_SPB	    /* SpellBad */
1346     , HLF_SPC	    /* SpellCap */
1347     , HLF_SPR	    /* SpellRare */
1348     , HLF_SPL	    /* SpellLocal */
1349     , HLF_PNI	    /* popup menu normal item */
1350     , HLF_PSI	    /* popup menu selected item */
1351     , HLF_PSB	    /* popup menu scrollbar */
1352     , HLF_PST	    /* popup menu scrollbar thumb */
1353     , HLF_TP	    /* tabpage line */
1354     , HLF_TPS	    /* tabpage line selected */
1355     , HLF_TPF	    /* tabpage line filler */
1356     , HLF_CUC	    /* 'cursurcolumn' */
1357     , HLF_CUL	    /* 'cursurline' */
1358     , HLF_MC	    /* 'colorcolumn' */
1359     , HLF_COUNT	    /* MUST be the last one */
1360 } hlf_T;
1361 
1362 /* The HL_FLAGS must be in the same order as the HLF_ enums!
1363  * When changing this also adjust the default for 'highlight'. */
1364 #define HL_FLAGS {'8', '@', 'd', 'e', 'h', 'i', 'l', 'm', 'M', \
1365 		  'n', 'N', 'r', 's', 'S', 'c', 't', 'v', 'V', 'w', 'W', \
1366 		  'f', 'F', 'A', 'C', 'D', 'T', '-', '>', \
1367 		  'B', 'P', 'R', 'L', \
1368 		  '+', '=', 'x', 'X', '*', '#', '_', '!', '.', 'o'}
1369 
1370 /*
1371  * Boolean constants
1372  */
1373 #ifndef TRUE
1374 # define FALSE	0	    /* note: this is an int, not a long! */
1375 # define TRUE	1
1376 #endif
1377 
1378 #define MAYBE	2	    /* sometimes used for a variant on TRUE */
1379 
1380 #ifndef UINT32_T
1381 typedef UINT32_TYPEDEF UINT32_T;
1382 #endif
1383 
1384 /*
1385  * Operator IDs; The order must correspond to opchars[] in ops.c!
1386  */
1387 #define OP_NOP		0	/* no pending operation */
1388 #define OP_DELETE	1	/* "d"  delete operator */
1389 #define OP_YANK		2	/* "y"  yank operator */
1390 #define OP_CHANGE	3	/* "c"  change operator */
1391 #define OP_LSHIFT	4	/* "<"  left shift operator */
1392 #define OP_RSHIFT	5	/* ">"  right shift operator */
1393 #define OP_FILTER	6	/* "!"  filter operator */
1394 #define OP_TILDE	7	/* "g~" switch case operator */
1395 #define OP_INDENT	8	/* "="  indent operator */
1396 #define OP_FORMAT	9	/* "gq" format operator */
1397 #define OP_COLON	10	/* ":"  colon operator */
1398 #define OP_UPPER	11	/* "gU" make upper case operator */
1399 #define OP_LOWER	12	/* "gu" make lower case operator */
1400 #define OP_JOIN		13	/* "J"  join operator, only for Visual mode */
1401 #define OP_JOIN_NS	14	/* "gJ"  join operator, only for Visual mode */
1402 #define OP_ROT13	15	/* "g?" rot-13 encoding */
1403 #define OP_REPLACE	16	/* "r"  replace chars, only for Visual mode */
1404 #define OP_INSERT	17	/* "I"  Insert column, only for Visual mode */
1405 #define OP_APPEND	18	/* "A"  Append column, only for Visual mode */
1406 #define OP_FOLD		19	/* "zf" define a fold */
1407 #define OP_FOLDOPEN	20	/* "zo" open folds */
1408 #define OP_FOLDOPENREC	21	/* "zO" open folds recursively */
1409 #define OP_FOLDCLOSE	22	/* "zc" close folds */
1410 #define OP_FOLDCLOSEREC	23	/* "zC" close folds recursively */
1411 #define OP_FOLDDEL	24	/* "zd" delete folds */
1412 #define OP_FOLDDELREC	25	/* "zD" delete folds recursively */
1413 #define OP_FORMAT2	26	/* "gw" format operator, keeps cursor pos */
1414 #define OP_FUNCTION	27	/* "g@" call 'operatorfunc' */
1415 
1416 /*
1417  * Motion types, used for operators and for yank/delete registers.
1418  */
1419 #define MCHAR	0		/* character-wise movement/register */
1420 #define MLINE	1		/* line-wise movement/register */
1421 #define MBLOCK	2		/* block-wise register */
1422 
1423 #define MAUTO	0xff		/* Decide between MLINE/MCHAR */
1424 
1425 /*
1426  * Minimum screen size
1427  */
1428 #define MIN_COLUMNS	12	/* minimal columns for screen */
1429 #define MIN_LINES	2	/* minimal lines for screen */
1430 #define STATUS_HEIGHT	1	/* height of a status line under a window */
1431 #define QF_WINHEIGHT	10	/* default height for quickfix window */
1432 
1433 /*
1434  * Buffer sizes
1435  */
1436 #ifndef CMDBUFFSIZE
1437 # define CMDBUFFSIZE	256	/* size of the command processing buffer */
1438 #endif
1439 
1440 #define LSIZE	    512		/* max. size of a line in the tags file */
1441 
1442 #define IOSIZE	   (1024+1)	/* file i/o and sprintf buffer size */
1443 
1444 #define DIALOG_MSG_SIZE 1000	/* buffer size for dialog_msg() */
1445 
1446 #ifdef FEAT_MBYTE
1447 # define MSG_BUF_LEN 480	/* length of buffer for small messages */
1448 # define MSG_BUF_CLEN  (MSG_BUF_LEN / 6)    /* cell length (worst case: utf-8
1449 					       takes 6 bytes for one cell) */
1450 #else
1451 # define MSG_BUF_LEN 80		/* length of buffer for small messages */
1452 # define MSG_BUF_CLEN  MSG_BUF_LEN	    /* cell length */
1453 #endif
1454 
1455 /* Size of the buffer used for tgetent().  Unfortunately this is largely
1456  * undocumented, some systems use 1024.  Using a buffer that is too small
1457  * causes a buffer overrun and a crash.  Use the maximum known value to stay
1458  * on the safe side. */
1459 #define TBUFSZ 2048		/* buffer size for termcap entry */
1460 
1461 /*
1462  * Maximum length of key sequence to be mapped.
1463  * Must be able to hold an Amiga resize report.
1464  */
1465 #define MAXMAPLEN   50
1466 
1467 /* Size in bytes of the hash used in the undo file. */
1468 #define UNDO_HASH_SIZE 32
1469 
1470 #ifdef HAVE_FCNTL_H
1471 # include <fcntl.h>
1472 #endif
1473 
1474 #ifdef BINARY_FILE_IO
1475 # define WRITEBIN   "wb"	/* no CR-LF translation */
1476 # define READBIN    "rb"
1477 # define APPENDBIN  "ab"
1478 #else
1479 # define WRITEBIN   "w"
1480 # define READBIN    "r"
1481 # define APPENDBIN  "a"
1482 #endif
1483 
1484 /*
1485  * EMX doesn't have a global way of making open() use binary I/O.
1486  * Use O_BINARY for all open() calls.
1487  */
1488 #if defined(__EMX__) || defined(__CYGWIN32__)
1489 # define O_EXTRA    O_BINARY
1490 #else
1491 # define O_EXTRA    0
1492 #endif
1493 
1494 #ifndef O_NOFOLLOW
1495 # define O_NOFOLLOW 0
1496 #endif
1497 
1498 #ifndef W_OK
1499 # define W_OK 2		/* for systems that don't have W_OK in unistd.h */
1500 #endif
1501 #ifndef R_OK
1502 # define R_OK 4		/* for systems that don't have R_OK in unistd.h */
1503 #endif
1504 
1505 /*
1506  * defines to avoid typecasts from (char_u *) to (char *) and back
1507  * (vim_strchr() and vim_strrchr() are now in alloc.c)
1508  */
1509 #define STRLEN(s)	    strlen((char *)(s))
1510 #define STRCPY(d, s)	    strcpy((char *)(d), (char *)(s))
1511 #define STRNCPY(d, s, n)    strncpy((char *)(d), (char *)(s), (size_t)(n))
1512 #define STRCMP(d, s)	    strcmp((char *)(d), (char *)(s))
1513 #define STRNCMP(d, s, n)    strncmp((char *)(d), (char *)(s), (size_t)(n))
1514 #ifdef HAVE_STRCASECMP
1515 # define STRICMP(d, s)	    strcasecmp((char *)(d), (char *)(s))
1516 #else
1517 # ifdef HAVE_STRICMP
1518 #  define STRICMP(d, s)	    stricmp((char *)(d), (char *)(s))
1519 # else
1520 #  define STRICMP(d, s)	    vim_stricmp((char *)(d), (char *)(s))
1521 # endif
1522 #endif
1523 
1524 /* Like strcpy() but allows overlapped source and destination. */
1525 #define STRMOVE(d, s)	    mch_memmove((d), (s), STRLEN(s) + 1)
1526 
1527 #ifdef HAVE_STRNCASECMP
1528 # define STRNICMP(d, s, n)  strncasecmp((char *)(d), (char *)(s), (size_t)(n))
1529 #else
1530 # ifdef HAVE_STRNICMP
1531 #  define STRNICMP(d, s, n) strnicmp((char *)(d), (char *)(s), (size_t)(n))
1532 # else
1533 #  define STRNICMP(d, s, n) vim_strnicmp((char *)(d), (char *)(s), (size_t)(n))
1534 # endif
1535 #endif
1536 
1537 #ifdef FEAT_MBYTE
1538 /* We need to call mb_stricmp() even when we aren't dealing with a multi-byte
1539  * encoding because mb_stricmp() takes care of all ascii and non-ascii
1540  * encodings, including characters with umlauts in latin1, etc., while
1541  * STRICMP() only handles the system locale version, which often does not
1542  * handle non-ascii properly. */
1543 
1544 # define MB_STRICMP(d, s)	mb_strnicmp((char_u *)(d), (char_u *)(s), (int)MAXCOL)
1545 # define MB_STRNICMP(d, s, n)	mb_strnicmp((char_u *)(d), (char_u *)(s), (int)(n))
1546 #else
1547 # define MB_STRICMP(d, s)	STRICMP((d), (s))
1548 # define MB_STRNICMP(d, s, n)	STRNICMP((d), (s), (n))
1549 #endif
1550 
1551 #define STRCAT(d, s)	    strcat((char *)(d), (char *)(s))
1552 #define STRNCAT(d, s, n)    strncat((char *)(d), (char *)(s), (size_t)(n))
1553 
1554 #ifdef HAVE_STRPBRK
1555 # define vim_strpbrk(s, cs) (char_u *)strpbrk((char *)(s), (char *)(cs))
1556 #endif
1557 
1558 #define MSG(s)			    msg((char_u *)(s))
1559 #define MSG_ATTR(s, attr)	    msg_attr((char_u *)(s), (attr))
1560 #define EMSG(s)			    emsg((char_u *)(s))
1561 #define EMSG2(s, p)		    emsg2((char_u *)(s), (char_u *)(p))
1562 #define EMSG3(s, p, q)		    emsg3((char_u *)(s), (char_u *)(p), (char_u *)(q))
1563 #define EMSGN(s, n)		    emsgn((char_u *)(s), (long)(n))
1564 #define EMSGU(s, n)		    emsgu((char_u *)(s), (long_u)(n))
1565 #define OUT_STR(s)		    out_str((char_u *)(s))
1566 #define OUT_STR_NF(s)		    out_str_nf((char_u *)(s))
1567 #define MSG_PUTS(s)		    msg_puts((char_u *)(s))
1568 #define MSG_PUTS_ATTR(s, a)	    msg_puts_attr((char_u *)(s), (a))
1569 #define MSG_PUTS_TITLE(s)	    msg_puts_title((char_u *)(s))
1570 #define MSG_PUTS_LONG(s)	    msg_puts_long_attr((char_u *)(s), 0)
1571 #define MSG_PUTS_LONG_ATTR(s, a)    msg_puts_long_attr((char_u *)(s), (a))
1572 
1573 /* Prefer using emsg3(), because perror() may send the output to the wrong
1574  * destination and mess up the screen. */
1575 #ifdef HAVE_STRERROR
1576 # define PERROR(msg)		    (void)emsg3((char_u *)"%s: %s", (char_u *)msg, (char_u *)strerror(errno))
1577 #else
1578 # define PERROR(msg)		    perror(msg)
1579 #endif
1580 
1581 typedef long	linenr_T;		/* line number type */
1582 typedef int	colnr_T;		/* column number type */
1583 typedef unsigned short disptick_T;	/* display tick type */
1584 
1585 #define MAXLNUM (0x7fffffffL)		/* maximum (invalid) line number */
1586 
1587 /*
1588  * Well, you won't believe it, but some S/390 machines ("host", now also known
1589  * as zServer) use 31 bit pointers. There are also some newer machines, that
1590  * use 64 bit pointers. I don't know how to distinguish between 31 and 64 bit
1591  * machines, so the best way is to assume 31 bits whenever we detect OS/390
1592  * Unix.
1593  * With this we restrict the maximum line length to 1073741823. I guess this is
1594  * not a real problem. BTW:  Longer lines are split.
1595  */
1596 #if SIZEOF_INT >= 4
1597 # ifdef __MVS__
1598 #  define MAXCOL (0x3fffffffL)		/* maximum column number, 30 bits */
1599 # else
1600 #  define MAXCOL (0x7fffffffL)		/* maximum column number, 31 bits */
1601 # endif
1602 #else
1603 # define MAXCOL	(0x7fff)		/* maximum column number, 15 bits */
1604 #endif
1605 
1606 #define SHOWCMD_COLS 10			/* columns needed by shown command */
1607 #define STL_MAX_ITEM 80			/* max nr of %<flag> in statusline */
1608 
1609 typedef void	    *vim_acl_T;		/* dummy to pass an ACL to a function */
1610 
1611 /*
1612  * Include a prototype for mch_memmove(), it may not be in alloc.pro.
1613  */
1614 #ifdef VIM_MEMMOVE
1615 void mch_memmove __ARGS((void *, void *, size_t));
1616 #else
1617 # ifndef mch_memmove
1618 #  define mch_memmove(to, from, len) memmove(to, from, len)
1619 # endif
1620 #endif
1621 
1622 /*
1623  * fnamecmp() is used to compare file names.
1624  * On some systems case in a file name does not matter, on others it does.
1625  * (this does not account for maximum name lengths and things like "../dir",
1626  * thus it is not 100% accurate!)
1627  */
1628 #ifdef CASE_INSENSITIVE_FILENAME
1629 # ifdef BACKSLASH_IN_FILENAME
1630 #  define fnamecmp(x, y) vim_fnamecmp((x), (y))
1631 #  define fnamencmp(x, y, n) vim_fnamencmp((x), (y), (size_t)(n))
1632 # else
1633 #  define fnamecmp(x, y) MB_STRICMP((x), (y))
1634 #  define fnamencmp(x, y, n) MB_STRNICMP((x), (y), (n))
1635 # endif
1636 #else
1637 # define fnamecmp(x, y) strcmp((char *)(x), (char *)(y))
1638 # define fnamencmp(x, y, n) strncmp((char *)(x), (char *)(y), (size_t)(n))
1639 #endif
1640 
1641 #ifdef HAVE_MEMSET
1642 # define vim_memset(ptr, c, size)   memset((ptr), (c), (size))
1643 #else
1644 void *vim_memset __ARGS((void *, int, size_t));
1645 #endif
1646 
1647 #ifdef HAVE_MEMCMP
1648 # define vim_memcmp(p1, p2, len)   memcmp((p1), (p2), (len))
1649 #else
1650 # ifdef HAVE_BCMP
1651 #  define vim_memcmp(p1, p2, len)   bcmp((p1), (p2), (len))
1652 # else
1653 int vim_memcmp __ARGS((void *, void *, size_t));
1654 #  define VIM_MEMCMP
1655 # endif
1656 #endif
1657 
1658 #if defined(UNIX) || defined(FEAT_GUI) || defined(OS2) || defined(VMS) \
1659 	|| defined(FEAT_CLIENTSERVER)
1660 # define USE_INPUT_BUF
1661 #endif
1662 
1663 #ifndef EINTR
1664 # define read_eintr(fd, buf, count) vim_read((fd), (buf), (count))
1665 # define write_eintr(fd, buf, count) vim_write((fd), (buf), (count))
1666 #endif
1667 
1668 #ifdef MSWIN
1669 /* On MS-Windows the third argument isn't size_t.  This matters for Win64,
1670  * where sizeof(size_t)==8, not 4 */
1671 # define vim_read(fd, buf, count)   read((fd), (char *)(buf), (unsigned int)(count))
1672 # define vim_write(fd, buf, count)  write((fd), (char *)(buf), (unsigned int)(count))
1673 #else
1674 # define vim_read(fd, buf, count)   read((fd), (char *)(buf), (size_t) (count))
1675 # define vim_write(fd, buf, count)  write((fd), (char *)(buf), (size_t) (count))
1676 #endif
1677 
1678 /*
1679  * Enums need a typecast to be used as array index (for Ultrix).
1680  */
1681 #define hl_attr(n)	highlight_attr[(int)(n)]
1682 #define term_str(n)	term_strings[(int)(n)]
1683 
1684 /*
1685  * vim_iswhite() is used for "^" and the like. It differs from isspace()
1686  * because it doesn't include <CR> and <LF> and the like.
1687  */
1688 #define vim_iswhite(x)	((x) == ' ' || (x) == '\t')
1689 
1690 /*
1691  * EXTERN is only defined in main.c.  That's where global variables are
1692  * actually defined and initialized.
1693  */
1694 #ifndef EXTERN
1695 # define EXTERN extern
1696 # define INIT(x)
1697 #else
1698 # ifndef INIT
1699 #  define INIT(x) x
1700 #  define DO_INIT
1701 # endif
1702 #endif
1703 
1704 #ifdef FEAT_MBYTE
1705 # define MAX_MCO	6	/* maximum value for 'maxcombine' */
1706 
1707 /* Maximum number of bytes in a multi-byte character.  It can be one 32-bit
1708  * character of up to 6 bytes, or one 16-bit character of up to three bytes
1709  * plus six following composing characters of three bytes each. */
1710 # define MB_MAXBYTES	21
1711 #else
1712 # define MB_MAXBYTES	1
1713 #endif
1714 
1715 #if (defined(FEAT_PROFILE) || defined(FEAT_RELTIME)) && !defined(PROTO)
1716 # ifdef WIN3264
1717 typedef LARGE_INTEGER proftime_T;
1718 # else
1719 typedef struct timeval proftime_T;
1720 # endif
1721 #else
1722 typedef int proftime_T;	    /* dummy for function prototypes */
1723 #endif
1724 
1725 /* Include option.h before structs.h, because the number of window-local and
1726  * buffer-local options is used there. */
1727 #include "option.h"	    /* options and default values */
1728 
1729 /* Note that gui.h is included by structs.h */
1730 
1731 #include "structs.h"	    /* file that defines many structures */
1732 
1733 /* Values for "do_profiling". */
1734 #define PROF_NONE	0	/* profiling not started */
1735 #define PROF_YES	1	/* profiling busy */
1736 #define PROF_PAUSED	2	/* profiling paused */
1737 
1738 #ifdef FEAT_MOUSE
1739 
1740 /* Codes for mouse button events in lower three bits: */
1741 # define MOUSE_LEFT	0x00
1742 # define MOUSE_MIDDLE	0x01
1743 # define MOUSE_RIGHT	0x02
1744 # define MOUSE_RELEASE	0x03
1745 
1746 /* bit masks for modifiers: */
1747 # define MOUSE_SHIFT	0x04
1748 # define MOUSE_ALT	0x08
1749 # define MOUSE_CTRL	0x10
1750 
1751 /* mouse buttons that are handled like a key press (GUI only) */
1752 /* Note that the scroll wheel keys are inverted: MOUSE_5 scrolls lines up but
1753  * the result of this is that the window moves down, similarly MOUSE_6 scrolls
1754  * columns left but the window moves right. */
1755 # define MOUSE_4	0x100	/* scroll wheel down */
1756 # define MOUSE_5	0x200	/* scroll wheel up */
1757 
1758 # define MOUSE_X1	0x300 /* Mouse-button X1 (6th) */
1759 # define MOUSE_X2	0x400 /* Mouse-button X2 */
1760 
1761 # define MOUSE_6	0x500	/* scroll wheel left */
1762 # define MOUSE_7	0x600	/* scroll wheel right */
1763 
1764 /* 0x20 is reserved by xterm */
1765 # define MOUSE_DRAG_XTERM   0x40
1766 
1767 # define MOUSE_DRAG	(0x40 | MOUSE_RELEASE)
1768 
1769 /* Lowest button code for using the mouse wheel (xterm only) */
1770 # define MOUSEWHEEL_LOW		0x60
1771 
1772 # define MOUSE_CLICK_MASK	0x03
1773 
1774 # define NUM_MOUSE_CLICKS(code) \
1775     (((unsigned)((code) & 0xC0) >> 6) + 1)
1776 
1777 # define SET_NUM_MOUSE_CLICKS(code, num) \
1778     (code) = ((code) & 0x3f) | ((((num) - 1) & 3) << 6)
1779 
1780 /* Added to mouse column for GUI when 'mousefocus' wants to give focus to a
1781  * window by simulating a click on its status line.  We could use up to 128 *
1782  * 128 = 16384 columns, now it's reduced to 10000. */
1783 # define MOUSE_COLOFF 10000
1784 
1785 /*
1786  * jump_to_mouse() returns one of first four these values, possibly with
1787  * some of the other three added.
1788  */
1789 # define IN_UNKNOWN		0
1790 # define IN_BUFFER		1
1791 # define IN_STATUS_LINE		2	/* on status or command line */
1792 # define IN_SEP_LINE		4	/* on vertical separator line */
1793 # define IN_OTHER_WIN		8	/* in other window but can't go there */
1794 # define CURSOR_MOVED		0x100
1795 # define MOUSE_FOLD_CLOSE	0x200	/* clicked on '-' in fold column */
1796 # define MOUSE_FOLD_OPEN	0x400	/* clicked on '+' in fold column */
1797 
1798 /* flags for jump_to_mouse() */
1799 # define MOUSE_FOCUS		0x01	/* need to stay in this window */
1800 # define MOUSE_MAY_VIS		0x02	/* may start Visual mode */
1801 # define MOUSE_DID_MOVE		0x04	/* only act when mouse has moved */
1802 # define MOUSE_SETPOS		0x08	/* only set current mouse position */
1803 # define MOUSE_MAY_STOP_VIS	0x10	/* may stop Visual mode */
1804 # define MOUSE_RELEASED		0x20	/* button was released */
1805 
1806 # if defined(UNIX) && defined(HAVE_GETTIMEOFDAY) && defined(HAVE_SYS_TIME_H)
1807 #  define CHECK_DOUBLE_CLICK 1	/* Checking for double clicks ourselves. */
1808 # endif
1809 
1810 #endif /* FEAT_MOUSE */
1811 
1812 /* defines for eval_vars() */
1813 #define VALID_PATH		1
1814 #define VALID_HEAD		2
1815 
1816 /* Defines for Vim variables.  These must match vimvars[] in eval.c! */
1817 #define VV_COUNT	0
1818 #define VV_COUNT1	1
1819 #define VV_PREVCOUNT	2
1820 #define VV_ERRMSG	3
1821 #define VV_WARNINGMSG	4
1822 #define VV_STATUSMSG	5
1823 #define VV_SHELL_ERROR	6
1824 #define VV_THIS_SESSION	7
1825 #define VV_VERSION	8
1826 #define VV_LNUM		9
1827 #define VV_TERMRESPONSE	10
1828 #define VV_FNAME	11
1829 #define VV_LANG		12
1830 #define VV_LC_TIME	13
1831 #define VV_CTYPE	14
1832 #define VV_CC_FROM	15
1833 #define VV_CC_TO	16
1834 #define VV_FNAME_IN	17
1835 #define VV_FNAME_OUT	18
1836 #define VV_FNAME_NEW	19
1837 #define VV_FNAME_DIFF	20
1838 #define VV_CMDARG	21
1839 #define VV_FOLDSTART	22
1840 #define VV_FOLDEND	23
1841 #define VV_FOLDDASHES	24
1842 #define VV_FOLDLEVEL	25
1843 #define VV_PROGNAME	26
1844 #define VV_SEND_SERVER	27
1845 #define VV_DYING	28
1846 #define VV_EXCEPTION	29
1847 #define VV_THROWPOINT	30
1848 #define VV_REG		31
1849 #define VV_CMDBANG	32
1850 #define VV_INSERTMODE	33
1851 #define VV_VAL		34
1852 #define VV_KEY		35
1853 #define VV_PROFILING	36
1854 #define VV_FCS_REASON	37
1855 #define VV_FCS_CHOICE	38
1856 #define VV_BEVAL_BUFNR	39
1857 #define VV_BEVAL_WINNR	40
1858 #define VV_BEVAL_LNUM	41
1859 #define VV_BEVAL_COL	42
1860 #define VV_BEVAL_TEXT	43
1861 #define VV_SCROLLSTART	44
1862 #define VV_SWAPNAME	45
1863 #define VV_SWAPCHOICE	46
1864 #define VV_SWAPCOMMAND	47
1865 #define VV_CHAR		48
1866 #define VV_MOUSE_WIN	49
1867 #define VV_MOUSE_LNUM   50
1868 #define VV_MOUSE_COL	51
1869 #define VV_OP		52
1870 #define VV_SEARCHFORWARD 53
1871 #define VV_OLDFILES	54
1872 #define VV_WINDOWID	55
1873 #define VV_LEN		56	/* number of v: vars */
1874 
1875 #ifdef FEAT_CLIPBOARD
1876 
1877 /* VIM_ATOM_NAME is the older Vim-specific selection type for X11.  Still
1878  * supported for when a mix of Vim versions is used. VIMENC_ATOM_NAME includes
1879  * the encoding to support Vims using different 'encoding' values. */
1880 #define VIM_ATOM_NAME "_VIM_TEXT"
1881 #define VIMENC_ATOM_NAME "_VIMENC_TEXT"
1882 
1883 /* Selection states for modeless selection */
1884 # define SELECT_CLEARED		0
1885 # define SELECT_IN_PROGRESS	1
1886 # define SELECT_DONE		2
1887 
1888 # define SELECT_MODE_CHAR	0
1889 # define SELECT_MODE_WORD	1
1890 # define SELECT_MODE_LINE	2
1891 
1892 # ifdef FEAT_GUI_W32
1893 #  ifdef FEAT_OLE
1894 #   define WM_OLE (WM_APP+0)
1895 #  endif
1896 #  ifdef FEAT_NETBEANS_INTG
1897     /* message for Netbeans socket event */
1898 #   define WM_NETBEANS (WM_APP+1)
1899 #  endif
1900 # endif
1901 
1902 /* Info about selected text */
1903 typedef struct VimClipboard
1904 {
1905     int		available;	/* Is clipboard available? */
1906     int		owned;		/* Flag: do we own the selection? */
1907     pos_T	start;		/* Start of selected area */
1908     pos_T	end;		/* End of selected area */
1909     int		vmode;		/* Visual mode character */
1910 
1911     /* Fields for selection that doesn't use Visual mode */
1912     short_u	origin_row;
1913     short_u	origin_start_col;
1914     short_u	origin_end_col;
1915     short_u	word_start_col;
1916     short_u	word_end_col;
1917 
1918     pos_T	prev;		/* Previous position */
1919     short_u	state;		/* Current selection state */
1920     short_u	mode;		/* Select by char, word, or line. */
1921 
1922 # if defined(FEAT_GUI_X11) || defined(FEAT_XCLIPBOARD)
1923     Atom	sel_atom;	/* PRIMARY/CLIPBOARD selection ID */
1924 # endif
1925 
1926 # ifdef FEAT_GUI_GTK
1927     GdkAtom     gtk_sel_atom;	/* PRIMARY/CLIPBOARD selection ID */
1928 # endif
1929 
1930 # ifdef MSWIN
1931     int_u	format;		/* Vim's own special clipboard format */
1932     int_u	format_raw;	/* Vim's raw text clipboard format */
1933 # endif
1934 } VimClipboard;
1935 #else
1936 typedef int VimClipboard;	/* This is required for the prototypes. */
1937 #endif
1938 
1939 #ifdef __BORLANDC__
1940 /* work around a bug in the Borland 'stat' function: */
1941 # include <io.h>	    /* for access() */
1942 
1943 # define stat(a,b) (access(a,0) ? -1 : stat(a,b))
1944 #endif
1945 
1946 #include "ex_cmds.h"	    /* Ex command defines */
1947 #include "proto.h"	    /* function prototypes */
1948 
1949 /* This has to go after the include of proto.h, as proto/gui.pro declares
1950  * functions of these names. The declarations would break if the defines had
1951  * been seen at that stage.  But it must be before globals.h, where error_ga
1952  * is declared. */
1953 #if !defined(FEAT_GUI_W32) && !defined(FEAT_GUI_X11) \
1954 	&& !defined(FEAT_GUI_GTK) && !defined(FEAT_GUI_MAC)
1955 # define mch_errmsg(str)	fprintf(stderr, "%s", (str))
1956 # define display_errors()	fflush(stderr)
1957 # define mch_msg(str)		printf("%s", (str))
1958 #else
1959 # define USE_MCH_ERRMSG
1960 #endif
1961 
1962 #ifndef FEAT_MBYTE
1963 # define after_pathsep(b, p)	vim_ispathsep(*((p) - 1))
1964 # define transchar_byte(c)	transchar(c)
1965 #endif
1966 
1967 #ifndef FEAT_LINEBREAK
1968 /* Without the 'numberwidth' option line numbers are always 7 chars. */
1969 # define number_width(x) 7
1970 #endif
1971 
1972 
1973 #include "globals.h"	    /* global variables and messages */
1974 
1975 #ifdef FEAT_SNIFF
1976 # include "if_sniff.h"
1977 #endif
1978 
1979 #ifndef FEAT_VIRTUALEDIT
1980 # define getvvcol(w, p, s, c, e) getvcol(w, p, s, c, e)
1981 # define virtual_active() 0
1982 # define virtual_op FALSE
1983 #endif
1984 
1985 /*
1986  * If console dialog not supported, but GUI dialog is, use the GUI one.
1987  */
1988 #if defined(FEAT_GUI_DIALOG) && !defined(FEAT_CON_DIALOG)
1989 # define do_dialog gui_mch_dialog
1990 #endif
1991 
1992 /*
1993  * Default filters for gui_mch_browse().
1994  * The filters are almost system independent.  Except for the difference
1995  * between "*" and "*.*" for MSDOS-like systems.
1996  * NOTE: Motif only uses the very first pattern.  Therefore
1997  * BROWSE_FILTER_DEFAULT should start with a "*" pattern.
1998  */
1999 #ifdef FEAT_BROWSE
2000 # ifdef BACKSLASH_IN_FILENAME
2001 #  define BROWSE_FILTER_MACROS \
2002 	(char_u *)"Vim macro files (*.vim)\t*.vim\nAll Files (*.*)\t*.*\n"
2003 #  define BROWSE_FILTER_ALL_FILES (char_u *)"All Files (*.*)\t*.*\n"
2004 #  define BROWSE_FILTER_DEFAULT \
2005 	(char_u *)"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"
2006 # else
2007 #  define BROWSE_FILTER_MACROS \
2008 	(char_u *)"Vim macro files (*.vim)\t*.vim\nAll Files (*)\t*\n"
2009 #  define BROWSE_FILTER_ALL_FILES (char_u *)"All Files (*)\t*\n"
2010 #  define BROWSE_FILTER_DEFAULT \
2011 	(char_u *)"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"
2012 # endif
2013 # define BROWSE_SAVE 1	    /* flag for do_browse() */
2014 # define BROWSE_DIR 2	    /* flag for do_browse() */
2015 #endif
2016 
2017 /* stop using fastcall for Borland */
2018 #if defined(__BORLANDC__) && defined(WIN32) && !defined(DEBUG)
2019  #pragma option -p.
2020 #endif
2021 
2022 #ifdef _MSC_VER
2023 /* Avoid useless warning "conversion from X to Y of greater size". */
2024  #pragma warning(disable : 4312)
2025 #endif
2026 
2027 /* Note: a NULL argument for vim_realloc() is not portable, don't use it. */
2028 #if defined(MEM_PROFILE)
2029 # define vim_realloc(ptr, size)  mem_realloc((ptr), (size))
2030 #else
2031 # define vim_realloc(ptr, size)  realloc((ptr), (size))
2032 #endif
2033 
2034 /*
2035  * The following macros stop display/event loop nesting at the wrong time.
2036  */
2037 #ifdef ALT_X_INPUT
2038 # define ALT_INPUT_LOCK_OFF	suppress_alternate_input = FALSE
2039 # define ALT_INPUT_LOCK_ON	suppress_alternate_input = TRUE
2040 #endif
2041 
2042 #ifdef FEAT_MBYTE
2043 /*
2044  * Return byte length of character that starts with byte "b".
2045  * Returns 1 for a single-byte character.
2046  * MB_BYTE2LEN_CHECK() can be used to count a special key as one byte.
2047  * Don't call MB_BYTE2LEN(b) with b < 0 or b > 255!
2048  */
2049 # define MB_BYTE2LEN(b)		mb_bytelen_tab[b]
2050 # define MB_BYTE2LEN_CHECK(b)	(((b) < 0 || (b) > 255) ? 1 : mb_bytelen_tab[b])
2051 #endif
2052 
2053 #if defined(FEAT_MBYTE) || defined(FEAT_POSTSCRIPT)
2054 /* properties used in enc_canon_table[] (first three mutually exclusive) */
2055 # define ENC_8BIT	0x01
2056 # define ENC_DBCS	0x02
2057 # define ENC_UNICODE	0x04
2058 
2059 # define ENC_ENDIAN_B	0x10	    /* Unicode: Big endian */
2060 # define ENC_ENDIAN_L	0x20	    /* Unicode: Little endian */
2061 
2062 # define ENC_2BYTE	0x40	    /* Unicode: UCS-2 */
2063 # define ENC_4BYTE	0x80	    /* Unicode: UCS-4 */
2064 # define ENC_2WORD	0x100	    /* Unicode: UTF-16 */
2065 
2066 # define ENC_LATIN1	0x200	    /* Latin1 */
2067 # define ENC_LATIN9	0x400	    /* Latin9 */
2068 # define ENC_MACROMAN	0x800	    /* Mac Roman (not Macro Man! :-) */
2069 #endif
2070 
2071 #ifdef FEAT_MBYTE
2072 # ifdef USE_ICONV
2073 #  ifndef EILSEQ
2074 #   define EILSEQ 123
2075 #  endif
2076 #  ifdef DYNAMIC_ICONV
2077 /* On Win32 iconv.dll is dynamically loaded. */
2078 #   define ICONV_ERRNO (*iconv_errno())
2079 #   define ICONV_E2BIG  7
2080 #   define ICONV_EINVAL 22
2081 #   define ICONV_EILSEQ 42
2082 #  else
2083 #   define ICONV_ERRNO errno
2084 #   define ICONV_E2BIG  E2BIG
2085 #   define ICONV_EINVAL EINVAL
2086 #   define ICONV_EILSEQ EILSEQ
2087 #  endif
2088 # endif
2089 
2090 #endif
2091 
2092 /* ISSYMLINK(mode) tests if a file is a symbolic link. */
2093 #if (defined(S_IFMT) && defined(S_IFLNK)) || defined(S_ISLNK)
2094 # define HAVE_ISSYMLINK
2095 # if defined(S_IFMT) && defined(S_IFLNK)
2096 #  define ISSYMLINK(mode) (((mode) & S_IFMT) == S_IFLNK)
2097 # else
2098 #  define ISSYMLINK(mode) S_ISLNK(mode)
2099 # endif
2100 #endif
2101 
2102 #define SIGN_BYTE 1	    /* byte value used where sign is displayed;
2103 			       attribute value is sign type */
2104 
2105 #ifdef FEAT_NETBEANS_INTG
2106 # define MULTISIGN_BYTE 2   /* byte value used where sign is displayed if
2107 			       multiple signs exist on the line */
2108 #endif
2109 
2110 #if defined(FEAT_GUI) && defined(FEAT_XCLIPBOARD)
2111 # ifdef FEAT_GUI_GTK
2112    /* Avoid using a global variable for the X display.  It's ugly
2113     * and is likely to cause trouble in multihead environments. */
2114 #  define X_DISPLAY	((gui.in_use) ? gui_mch_get_display() : xterm_dpy)
2115 # else
2116 #  define X_DISPLAY	(gui.in_use ? gui.dpy : xterm_dpy)
2117 # endif
2118 #else
2119 # ifdef FEAT_GUI
2120 #  ifdef FEAT_GUI_GTK
2121 #   define X_DISPLAY	((gui.in_use) ? gui_mch_get_display() : (Display *)NULL)
2122 #  else
2123 #   define X_DISPLAY	gui.dpy
2124 #  endif
2125 # else
2126 #  define X_DISPLAY	xterm_dpy
2127 # endif
2128 #endif
2129 
2130 #if defined(FEAT_BROWSE) && defined(GTK_CHECK_VERSION)
2131 # if GTK_CHECK_VERSION(2,4,0)
2132 #  define USE_FILE_CHOOSER
2133 # endif
2134 #endif
2135 
2136 #ifndef FEAT_NETBEANS_INTG
2137 # undef NBDEBUG
2138 #endif
2139 #ifdef NBDEBUG /* Netbeans debugging. */
2140 # include "nbdebug.h"
2141 #else
2142 # define nbdebug(a)
2143 #endif
2144 
2145 #ifdef IN_PERL_FILE
2146   /*
2147    * Avoid clashes between Perl and Vim namespace.
2148    */
2149 # undef NORMAL
2150 # undef STRLEN
2151 # undef FF
2152 # undef OP_DELETE
2153 # undef OP_JOIN
2154 # ifdef __BORLANDC__
2155 #  define NOPROTO 1
2156 # endif
2157   /* remove MAX and MIN, included by glib.h, redefined by sys/param.h */
2158 # ifdef MAX
2159 #  undef MAX
2160 # endif
2161 # ifdef MIN
2162 #  undef MIN
2163 # endif
2164   /* We use _() for gettext(), Perl uses it for function prototypes... */
2165 # ifdef _
2166 #  undef _
2167 # endif
2168 # ifdef DEBUG
2169 #  undef DEBUG
2170 # endif
2171 # ifdef _DEBUG
2172 #  undef _DEBUG
2173 # endif
2174 # ifdef instr
2175 #  undef instr
2176 # endif
2177   /* bool may cause trouble on MACOS but is required on a few other systems
2178    * and for Perl */
2179 # if defined(bool) && defined(MACOS) && !defined(FEAT_PERL)
2180 #  undef bool
2181 # endif
2182 
2183 # ifdef __BORLANDC__
2184   /* Borland has the structure stati64 but not _stati64 */
2185 #  define _stati64 stati64
2186 # endif
2187 
2188 # include <EXTERN.h>
2189 # include <perl.h>
2190 # include <XSUB.h>
2191 #endif
2192 
2193 /* values for vim_handle_signal() that are not a signal */
2194 #define SIGNAL_BLOCK	-1
2195 #define SIGNAL_UNBLOCK  -2
2196 #if !defined(UNIX) && !defined(VMS) && !defined(OS2)
2197 # define vim_handle_signal(x) 0
2198 #endif
2199 
2200 /* flags for skip_vimgrep_pat() */
2201 #define VGR_GLOBAL	1
2202 #define VGR_NOJUMP	2
2203 
2204 /* behavior for bad character, "++bad=" argument */
2205 #define BAD_REPLACE	'?'	/* replace it with '?' (default) */
2206 #define BAD_KEEP	-1	/* leave it */
2207 #define BAD_DROP	-2	/* erase it */
2208 
2209 /* last argument for do_source() */
2210 #define DOSO_NONE	0
2211 #define DOSO_VIMRC	1	/* loading vimrc file */
2212 #define DOSO_GVIMRC	2	/* loading gvimrc file */
2213 
2214 /* flags for read_viminfo() and children */
2215 #define VIF_WANT_INFO		1	/* load non-mark info */
2216 #define VIF_WANT_MARKS		2	/* load file marks */
2217 #define VIF_FORCEIT		4	/* overwrite info already read */
2218 #define VIF_GET_OLDFILES	8	/* load v:oldfiles */
2219 
2220 /* flags for buf_freeall() */
2221 #define BFA_DEL		1	/* buffer is going to be deleted */
2222 #define BFA_WIPE	2	/* buffer is going to be wiped out */
2223 #define BFA_KEEP_UNDO	4	/* do not free undo information */
2224 
2225 /* direction for nv_mousescroll() and ins_mousescroll() */
2226 #define MSCR_DOWN	0	/* DOWN must be FALSE */
2227 #define MSCR_UP		1
2228 #define MSCR_LEFT	-1
2229 #define MSCR_RIGHT	-2
2230 
2231 #define KEYLEN_PART_KEY -1	/* keylen value for incomplete key-code */
2232 #define KEYLEN_PART_MAP -2	/* keylen value for incomplete mapping */
2233 #define KEYLEN_REMOVED  9999	/* keylen value for removed sequence */
2234 
2235 /* Return values from win32_fileinfo(). */
2236 #define FILEINFO_OK	     0
2237 #define FILEINFO_ENC_FAIL    1	/* enc_to_utf16() failed */
2238 #define FILEINFO_READ_FAIL   2	/* CreateFile() failed */
2239 #define FILEINFO_INFO_FAIL   3	/* GetFileInformationByHandle() failed */
2240 
2241 #endif /* VIM__H */
2242