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