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