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