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