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