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