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