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