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