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