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