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