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