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