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