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