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