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