1/* vi:set ts=8 sts=4 sw=4:
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/* use fastcall for Borland, when compiling for Win32 (not for DOS16) */
13#if defined(__BORLANDC__) && defined(WIN32) && !defined(DEBUG)
14#if defined(FEAT_PERL) || \
15    defined(FEAT_PYTHON) || \
16    defined(FEAT_PYTHON3) || \
17    defined(FEAT_RUBY) || \
18    defined(FEAT_TCL) || \
19    defined(FEAT_MZSCHEME) || \
20    defined(DYNAMIC_GETTEXT) || \
21    defined(DYNAMIC_ICONV) || \
22    defined(DYNAMIC_IME) || \
23    defined(XPM)
24  #pragma option -pc
25# else
26  #pragma option -pr
27# endif
28#endif
29
30/* ============ the header file puzzle (ca. 50-100 pieces) ========= */
31
32#ifdef HAVE_CONFIG_H	/* GNU autoconf (or something else) was here */
33# include "auto/config.h"
34# define HAVE_PATHDEF
35
36/*
37 * Check if configure correctly managed to find sizeof(int).  If this failed,
38 * it becomes zero.  This is likely a problem of not being able to run the
39 * test program.  Other items from configure may also be wrong then!
40 */
41# if (SIZEOF_INT == 0)
42    Error: configure did not run properly.  Check auto/config.log.
43# endif
44
45/*
46 * Cygwin may have fchdir() in a newer release, but in most versions it
47 * doesn't work well and avoiding it keeps the binary backward compatible.
48 */
49# if defined(__CYGWIN32__) && defined(HAVE_FCHDIR)
50#  undef HAVE_FCHDIR
51# endif
52
53/* We may need to define the uint32_t on non-Unix system, but using the same
54 * identifier causes conflicts.  Therefore use UINT32_T. */
55# define UINT32_TYPEDEF uint32_t
56#endif
57
58#if !defined(UINT32_TYPEDEF)
59# if defined(uint32_t)  /* this doesn't catch typedefs, unfortunately */
60#  define UINT32_TYPEDEF uint32_t
61# else
62  /* Fall back to assuming unsigned int is 32 bit.  If this is wrong then the
63   * test in blowfish.c will fail. */
64#  define UINT32_TYPEDEF unsigned int
65# endif
66#endif
67
68/* user ID of root is usually zero, but not for everybody */
69#ifdef __TANDEM
70# ifndef _TANDEM_SOURCE
71#  define _TANDEM_SOURCE
72# endif
73# include <floss.h>
74# define ROOT_UID 65535
75#else
76# define ROOT_UID 0
77#endif
78
79#ifdef __EMX__		/* hand-edited config.h for OS/2 with EMX */
80# include "os_os2_cfg.h"
81#endif
82
83/*
84 * MACOS_CLASSIC compiling for MacOS prior to MacOS X
85 * MACOS_X_UNIX  compiling for MacOS X (using os_unix.c)
86 * MACOS_X       compiling for MacOS X (using os_unix.c)
87 * MACOS	 compiling for either one
88 */
89#if defined(macintosh) && !defined(MACOS_CLASSIC)
90# define MACOS_CLASSIC
91#endif
92#if defined(MACOS_X_UNIX)
93# define MACOS_X
94# ifndef HAVE_CONFIG_H
95#  define UNIX
96# endif
97# ifndef FEAT_CLIPBOARD
98#  define FEAT_CLIPBOARD
99# endif
100#endif
101#if defined(MACOS_X) || defined(MACOS_CLASSIC)
102#  define MACOS
103#endif
104#if defined(MACOS_X) && defined(MACOS_CLASSIC)
105    Error: To compile for both MACOS X and Classic use a Classic Carbon
106#endif
107/* Unless made through the Makefile enforce GUI on Mac */
108#if defined(MACOS) && !defined(HAVE_CONFIG_H)
109# define FEAT_GUI_MAC
110#endif
111
112#if defined(FEAT_GUI_MOTIF) \
113    || defined(FEAT_GUI_GTK) \
114    || defined(FEAT_GUI_ATHENA) \
115    || defined(FEAT_GUI_MAC) \
116    || defined(FEAT_GUI_W32) \
117    || defined(FEAT_GUI_W16) \
118    || defined(FEAT_GUI_PHOTON)
119# if !defined(FEAT_GUI) && !defined(NO_X11_INCLUDES)
120#  define FEAT_GUI
121# endif
122#endif
123
124/* Visual Studio 2005 has 'deprecated' many of the standard CRT functions */
125#if _MSC_VER >= 1400
126# define _CRT_SECURE_NO_DEPRECATE
127# define _CRT_NONSTDC_NO_DEPRECATE
128#endif
129
130#if defined(FEAT_GUI_W32) || defined(FEAT_GUI_W16)
131# define FEAT_GUI_MSWIN
132#endif
133#if defined(WIN16) || defined(WIN32) || defined(_WIN64)
134# define MSWIN
135#endif
136/* Practically everything is common to both Win32 and Win64 */
137#if defined(WIN32) || defined(_WIN64)
138# define WIN3264
139#endif
140
141/*
142 * SIZEOF_INT is used in feature.h, and the system-specific included files
143 * need items from feature.h.  Therefore define SIZEOF_INT here.
144 */
145#ifdef WIN3264
146# define SIZEOF_INT 4
147#endif
148#ifdef MSDOS
149# ifdef DJGPP
150#  ifndef FEAT_GUI_GTK		/* avoid problems when generating prototypes */
151#   define SIZEOF_INT 4		/* 32 bit ints */
152#  endif
153#  define DOS32
154#  define FEAT_CLIPBOARD
155# else
156#  ifndef FEAT_GUI_GTK		/* avoid problems when generating prototypes */
157#   define SIZEOF_INT 2		/* 16 bit ints */
158#  endif
159#  define SMALL_MALLOC		/* 16 bit storage allocation */
160#  define DOS16
161# endif
162#endif
163
164#ifdef AMIGA
165  /* Be conservative about sizeof(int). It could be 4 too. */
166# ifndef FEAT_GUI_GTK	/* avoid problems when generating prototypes */
167#  ifdef __GNUC__
168#   define SIZEOF_INT	4
169#  else
170#   define SIZEOF_INT	2
171#  endif
172# endif
173#endif
174#ifdef MACOS
175# if defined(__POWERPC__) || defined(MACOS_X) || defined(__fourbyteints__) \
176  || defined(__MRC__) || defined(__SC__) || defined(__APPLE_CC__)/* MPW Compilers */
177#  define SIZEOF_INT 4
178# else
179#  define SIZEOF_INT 2
180# endif
181#endif
182#ifdef RISCOS
183# define SIZEOF_INT 4
184#endif
185
186
187#include "feature.h"	/* #defines for optionals and features */
188
189/* +x11 is only enabled when it's both available and wanted. */
190#if defined(HAVE_X11) && defined(WANT_X11)
191# define FEAT_X11
192#endif
193
194#ifdef NO_X11_INCLUDES
195    /* In os_mac_conv.c NO_X11_INCLUDES is defined to avoid X11 headers.
196     * Disable all X11 related things to avoid conflicts. */
197# ifdef FEAT_X11
198#  undef FEAT_X11
199# endif
200# ifdef FEAT_GUI_X11
201#  undef FEAT_GUI_X11
202# endif
203# ifdef FEAT_XCLIPBOARD
204#  undef FEAT_XCLIPBOARD
205# endif
206# ifdef FEAT_GUI_MOTIF
207#  undef FEAT_GUI_MOTIF
208# endif
209# ifdef FEAT_GUI_ATHENA
210#  undef FEAT_GUI_ATHENA
211# endif
212# ifdef FEAT_GUI_GTK
213#  undef FEAT_GUI_GTK
214# endif
215# ifdef FEAT_BEVAL_TIP
216#  undef FEAT_BEVAL_TIP
217# endif
218# ifdef FEAT_XIM
219#  undef FEAT_XIM
220# endif
221# ifdef FEAT_CLIENTSERVER
222#  undef FEAT_CLIENTSERVER
223# endif
224#endif
225
226/* The Mac conversion stuff doesn't work under X11. */
227#if defined(FEAT_MBYTE) && defined(MACOS_X)
228# define MACOS_CONVERT
229#endif
230
231/* Can't use "PACKAGE" here, conflicts with a Perl include file. */
232#ifndef VIMPACKAGE
233# define VIMPACKAGE	"vim"
234#endif
235
236/*
237 * Find out if function definitions should include argument types
238 */
239#ifdef AZTEC_C
240# include <functions.h>
241# define __ARGS(x)  x
242#endif
243
244#ifdef SASC
245# include <clib/exec_protos.h>
246# define __ARGS(x)  x
247#endif
248
249#ifdef _DCC
250# include <clib/exec_protos.h>
251# define __ARGS(x)  x
252#endif
253
254#ifdef __TURBOC__
255# define __ARGS(x) x
256#endif
257
258#ifdef __BEOS__
259# include "os_beos.h"
260# define __ARGS(x)  x
261#endif
262
263#if (defined(UNIX) || defined(__EMX__) || defined(VMS)) \
264	&& (!defined(MACOS_X) || defined(HAVE_CONFIG_H))
265# include "os_unix.h"	    /* bring lots of system header files */
266#endif
267
268#if defined(MACOS) && (defined(__MRC__) || defined(__SC__))
269   /* Apple's Compilers support prototypes */
270# define __ARGS(x) x
271#endif
272#ifndef __ARGS
273# if defined(__STDC__) || defined(__GNUC__) || defined(WIN3264)
274#  define __ARGS(x) x
275# else
276#  define __ARGS(x) ()
277# endif
278#endif
279
280/* __ARGS and __PARMS are the same thing. */
281#ifndef __PARMS
282# define __PARMS(x) __ARGS(x)
283#endif
284
285/* Mark unused function arguments with UNUSED, so that gcc -Wunused-parameter
286 * can be used to check for mistakes. */
287#ifdef HAVE_ATTRIBUTE_UNUSED
288# define UNUSED __attribute__((unused))
289#else
290# define UNUSED
291#endif
292
293/* if we're compiling in C++ (currently only KVim), the system
294 * headers must have the correct prototypes or nothing will build.
295 * conversely, our prototypes might clash due to throw() specifiers and
296 * cause compilation failures even though the headers are correct.  For
297 * a concrete example, gcc-3.2 enforces exception specifications, and
298 * glibc-2.2.5 has them in their system headers.
299 */
300#if !defined(__cplusplus) && defined(UNIX) \
301  && !defined(MACOS_X) /* MACOS_X doesn't yet support osdef.h */
302# include "auto/osdef.h"	/* bring missing declarations in */
303#endif
304
305#ifdef __EMX__
306# define    getcwd  _getcwd2
307# define    chdir   _chdir2
308# undef	    CHECK_INODE
309#endif
310
311#ifdef AMIGA
312# include "os_amiga.h"
313#endif
314
315#ifdef MSDOS
316# include "os_msdos.h"
317#endif
318
319#ifdef WIN16
320# include "os_win16.h"
321#endif
322
323#ifdef WIN3264
324# include "os_win32.h"
325#endif
326
327#ifdef __MINT__
328# include "os_mint.h"
329#endif
330
331#if defined(MACOS)
332# if defined(__MRC__) || defined(__SC__) /* MPW Compilers */
333#  define HAVE_SETENV
334# endif
335# include "os_mac.h"
336#endif
337
338#ifdef RISCOS
339# include "os_riscos.h"
340#endif
341
342#ifdef __QNX__
343# include "os_qnx.h"
344#endif
345
346#ifdef FEAT_SUN_WORKSHOP
347# include "workshop.h"
348#endif
349
350#ifdef X_LOCALE
351# include <X11/Xlocale.h>
352#else
353# ifdef HAVE_LOCALE_H
354#  include <locale.h>
355# endif
356#endif
357
358/*
359 * Maximum length of a path (for non-unix systems) Make it a bit long, to stay
360 * on the safe side.  But not too long to put on the stack.
361 */
362#ifndef MAXPATHL
363# ifdef MAXPATHLEN
364#  define MAXPATHL  MAXPATHLEN
365# else
366#  define MAXPATHL  256
367# endif
368#endif
369#ifdef BACKSLASH_IN_FILENAME
370# define PATH_ESC_CHARS ((char_u *)" \t\n*?[{`%#'\"|!<")
371#else
372# ifdef VMS
373    /* VMS allows a lot of characters in the file name */
374#  define PATH_ESC_CHARS ((char_u *)" \t\n*?{`\\%#'\"|!")
375#  define SHELL_ESC_CHARS ((char_u *)" \t\n*?{`\\%#'|!()&")
376# else
377#  define PATH_ESC_CHARS ((char_u *)" \t\n*?[{`$\\%#'\"|!<")
378#  define SHELL_ESC_CHARS ((char_u *)" \t\n*?[{`$\\%#'\"|!<>();&")
379# endif
380#endif
381
382#define NUMBUFLEN 30	    /* length of a buffer to store a number in ASCII */
383
384/*
385 * Shorthand for unsigned variables. Many systems, but not all, have u_char
386 * already defined, so we use char_u to avoid trouble.
387 */
388typedef unsigned char	char_u;
389typedef unsigned short	short_u;
390typedef unsigned int	int_u;
391/* Make sure long_u is big enough to hold a pointer.
392 * On Win64, longs are 32 bits and pointers are 64 bits.
393 * For printf() and scanf(), we need to take care of long_u specifically. */
394#ifdef _WIN64
395typedef unsigned __int64	long_u;
396typedef		 __int64	long_i;
397# define SCANF_HEX_LONG_U       "%Ix"
398# define SCANF_DECIMAL_LONG_U   "%Iu"
399# define PRINTF_HEX_LONG_U      "0x%Ix"
400#else
401  /* Microsoft-specific. The __w64 keyword should be specified on any typedefs
402   * that change size between 32-bit and 64-bit platforms.  For any such type,
403   * __w64 should appear only on the 32-bit definition of the typedef.
404   * Define __w64 as an empty token for everything but MSVC 7.x or later.
405   */
406# if !defined(_MSC_VER)	|| (_MSC_VER < 1300)
407#  define __w64
408# endif
409typedef unsigned long __w64	long_u;
410typedef		 long __w64     long_i;
411# define SCANF_HEX_LONG_U       "%lx"
412# define SCANF_DECIMAL_LONG_U   "%lu"
413# define PRINTF_HEX_LONG_U      "0x%lx"
414#endif
415#define PRINTF_DECIMAL_LONG_U SCANF_DECIMAL_LONG_U
416
417/*
418 * Only systems which use configure will have SIZEOF_OFF_T and SIZEOF_LONG
419 * defined, which is ok since those are the same systems which can have
420 * varying sizes for off_t.  The other systems will continue to use "%ld" to
421 * print off_t since off_t is simply a typedef to long for them.
422 */
423#if defined(SIZEOF_OFF_T) && (SIZEOF_OFF_T > SIZEOF_LONG)
424# define LONG_LONG_OFF_T
425#endif
426
427/*
428 * The characters and attributes cached for the screen.
429 */
430typedef char_u schar_T;
431#ifdef FEAT_SYN_HL
432typedef unsigned short sattr_T;
433# define MAX_TYPENR 65535
434#else
435typedef unsigned char sattr_T;
436# define MAX_TYPENR 255
437#endif
438
439/*
440 * The u8char_T can hold one decoded UTF-8 character.
441 * We normally use 32 bits now, since some Asian characters don't fit in 16
442 * bits.  u8char_T is only used for displaying, it could be 16 bits to save
443 * memory.
444 */
445#ifdef FEAT_MBYTE
446# ifdef UNICODE16
447typedef unsigned short u8char_T;    /* short should be 16 bits */
448# else
449#  if SIZEOF_INT >= 4
450typedef unsigned int u8char_T;	    /* int is 32 bits */
451#  else
452typedef unsigned long u8char_T;	    /* long should be 32 bits or more */
453#  endif
454# endif
455#endif
456
457#ifndef UNIX		    /* For Unix this is included in os_unix.h */
458# include <stdio.h>
459# include <ctype.h>
460#endif
461
462#include "ascii.h"
463#include "keymap.h"
464#include "term.h"
465#include "macros.h"
466
467#ifdef LATTICE
468# include <sys/types.h>
469# include <sys/stat.h>
470#endif
471#ifdef _DCC
472# include <sys/stat.h>
473#endif
474#if defined(MSDOS) || defined(MSWIN)
475# include <sys/stat.h>
476#endif
477
478/*
479 * Allow other (non-unix) systems to configure themselves now
480 * These are also in os_unix.h, because osdef.sh needs them there.
481 */
482#ifndef UNIX
483/* Note: Some systems need both string.h and strings.h (Savage).  If the
484 * system can't handle this, define NO_STRINGS_WITH_STRING_H. */
485# ifdef HAVE_STRING_H
486#  include <string.h>
487# endif
488# if defined(HAVE_STRINGS_H) && !defined(NO_STRINGS_WITH_STRING_H)
489#   include <strings.h>
490# endif
491# ifdef HAVE_STAT_H
492#  include <stat.h>
493# endif
494# ifdef HAVE_STDLIB_H
495#  include <stdlib.h>
496# endif
497#endif /* NON-UNIX */
498
499#include <assert.h>
500
501#ifdef HAVE_STDINT_H
502# include <stdint.h>
503#endif
504#ifdef HAVE_INTTYPES_H
505# include <inttypes.h>
506#endif
507#ifdef HAVE_WCTYPE_H
508# include <wctype.h>
509#endif
510#ifdef HAVE_STDARG_H
511# include <stdarg.h>
512#endif
513
514# if defined(HAVE_SYS_SELECT_H) && \
515	(!defined(HAVE_SYS_TIME_H) || defined(SYS_SELECT_WITH_SYS_TIME))
516#  include <sys/select.h>
517# endif
518
519# ifndef HAVE_SELECT
520#  ifdef HAVE_SYS_POLL_H
521#   include <sys/poll.h>
522#   define HAVE_POLL
523#  else
524#   ifdef HAVE_POLL_H
525#    include <poll.h>
526#    define HAVE_POLL
527#   endif
528#  endif
529# endif
530
531/* ================ end of the header file puzzle =============== */
532
533/*
534 * For dynamically loaded imm library. Currently, only for Win32.
535 */
536#ifdef DYNAMIC_IME
537# ifndef FEAT_MBYTE_IME
538#  define FEAT_MBYTE_IME
539# endif
540#endif
541
542/*
543 * Check input method control.
544 */
545#if defined(FEAT_XIM) \
546    || (defined(FEAT_GUI) && (defined(FEAT_MBYTE_IME) || defined(GLOBAL_IME))) \
547    || (defined(FEAT_GUI_MAC) && defined(FEAT_MBYTE))
548# define USE_IM_CONTROL
549#endif
550
551/*
552 * For dynamically loaded gettext library.  Currently, only for Win32.
553 */
554#ifdef DYNAMIC_GETTEXT
555# ifndef FEAT_GETTEXT
556#  define FEAT_GETTEXT
557# endif
558/* These are in os_win32.c */
559extern char *(*dyn_libintl_gettext)(const char *msgid);
560extern char *(*dyn_libintl_bindtextdomain)(const char *domainname, const char *dirname);
561extern char *(*dyn_libintl_bind_textdomain_codeset)(const char *domainname, const char *codeset);
562extern char *(*dyn_libintl_textdomain)(const char *domainname);
563#endif
564
565
566/*
567 * The _() stuff is for using gettext().  It is a no-op when libintl.h is not
568 * found or the +multilang feature is disabled.
569 */
570#ifdef FEAT_GETTEXT
571# ifdef DYNAMIC_GETTEXT
572#  define _(x) (*dyn_libintl_gettext)((char *)(x))
573#  define N_(x) x
574#  define bindtextdomain(domain, dir) (*dyn_libintl_bindtextdomain)((domain), (dir))
575#  define bind_textdomain_codeset(domain, codeset) (*dyn_libintl_bind_textdomain_codeset)((domain), (codeset))
576#  if !defined(HAVE_BIND_TEXTDOMAIN_CODESET)
577#   define HAVE_BIND_TEXTDOMAIN_CODESET 1
578#  endif
579#  define textdomain(domain) (*dyn_libintl_textdomain)(domain)
580# else
581#  include <libintl.h>
582#  define _(x) gettext((char *)(x))
583#  ifdef gettext_noop
584#   define N_(x) gettext_noop(x)
585#  else
586#   define N_(x) x
587#  endif
588# endif
589#else
590# define _(x) ((char *)(x))
591# define N_(x) x
592# ifdef bindtextdomain
593#  undef bindtextdomain
594# endif
595# define bindtextdomain(x, y) /* empty */
596# ifdef bind_textdomain_codeset
597#  undef bind_textdomain_codeset
598# endif
599# define bind_textdomain_codeset(x, y) /* empty */
600# ifdef textdomain
601#  undef textdomain
602# endif
603# define textdomain(x) /* empty */
604#endif
605
606/*
607 * flags for update_screen()
608 * The higher the value, the higher the priority
609 */
610#define VALID			10  /* buffer not changed, or changes marked
611				       with b_mod_* */
612#define INVERTED		20  /* redisplay inverted part that changed */
613#define INVERTED_ALL		25  /* redisplay whole inverted part */
614#define REDRAW_TOP		30  /* display first w_upd_rows screen lines */
615#define SOME_VALID		35  /* like NOT_VALID but may scroll */
616#define NOT_VALID		40  /* buffer needs complete redraw */
617#define CLEAR			50  /* screen messed up, clear it */
618
619/*
620 * Flags for w_valid.
621 * These are set when something in a window structure becomes invalid, except
622 * when the cursor is moved.  Call check_cursor_moved() before testing one of
623 * the flags.
624 * These are reset when that thing has been updated and is valid again.
625 *
626 * Every function that invalidates one of these must call one of the
627 * invalidate_* functions.
628 *
629 * w_valid is supposed to be used only in screen.c.  From other files, use the
630 * functions that set or reset the flags.
631 *
632 * VALID_BOTLINE    VALID_BOTLINE_AP
633 *     on		on		w_botline valid
634 *     off		on		w_botline approximated
635 *     off		off		w_botline not valid
636 *     on		off		not possible
637 */
638#define VALID_WROW	0x01	/* w_wrow (window row) is valid */
639#define VALID_WCOL	0x02	/* w_wcol (window col) is valid */
640#define VALID_VIRTCOL	0x04	/* w_virtcol (file col) is valid */
641#define VALID_CHEIGHT	0x08	/* w_cline_height and w_cline_folded valid */
642#define VALID_CROW	0x10	/* w_cline_row is valid */
643#define VALID_BOTLINE	0x20	/* w_botine and w_empty_rows are valid */
644#define VALID_BOTLINE_AP 0x40	/* w_botine is approximated */
645#define VALID_TOPLINE	0x80	/* w_topline is valid (for cursor position) */
646
647/*
648 * Terminal highlighting attribute bits.
649 * Attributes above HL_ALL are used for syntax highlighting.
650 */
651#define HL_NORMAL		0x00
652#define HL_INVERSE		0x01
653#define HL_BOLD			0x02
654#define HL_ITALIC		0x04
655#define HL_UNDERLINE		0x08
656#define HL_UNDERCURL		0x10
657#define HL_STANDOUT		0x20
658#define HL_ALL			0x3f
659
660/* special attribute addition: Put message in history */
661#define MSG_HIST		0x1000
662
663/*
664 * values for State
665 *
666 * The lower bits up to 0x20 are used to distinguish normal/visual/op_pending
667 * and cmdline/insert+replace mode.  This is used for mapping.  If none of
668 * these bits are set, no mapping is done.
669 * The upper bits are used to distinguish between other states.
670 */
671#define NORMAL		0x01	/* Normal mode, command expected */
672#define VISUAL		0x02	/* Visual mode - use get_real_state() */
673#define OP_PENDING	0x04	/* Normal mode, operator is pending - use
674				   get_real_state() */
675#define CMDLINE		0x08	/* Editing command line */
676#define INSERT		0x10	/* Insert mode */
677#define LANGMAP		0x20	/* Language mapping, can be combined with
678				   INSERT and CMDLINE */
679
680#define REPLACE_FLAG	0x40	/* Replace mode flag */
681#define REPLACE		(REPLACE_FLAG + INSERT)
682#ifdef FEAT_VREPLACE
683# define VREPLACE_FLAG	0x80	/* Virtual-replace mode flag */
684# define VREPLACE	(REPLACE_FLAG + VREPLACE_FLAG + INSERT)
685#endif
686#define LREPLACE	(REPLACE_FLAG + LANGMAP)
687
688#define NORMAL_BUSY	(0x100 + NORMAL) /* Normal mode, busy with a command */
689#define HITRETURN	(0x200 + NORMAL) /* waiting for return or command */
690#define ASKMORE		0x300	/* Asking if you want --more-- */
691#define SETWSIZE	0x400	/* window size has changed */
692#define ABBREV		0x500	/* abbreviation instead of mapping */
693#define EXTERNCMD	0x600	/* executing an external command */
694#define SHOWMATCH	(0x700 + INSERT) /* show matching paren */
695#define CONFIRM		0x800	/* ":confirm" prompt */
696#define SELECTMODE	0x1000	/* Select mode, only for mappings */
697
698#define MAP_ALL_MODES	(0x3f | SELECTMODE)	/* all mode bits used for
699						 * mapping */
700
701/* directions */
702#define FORWARD			1
703#define BACKWARD		(-1)
704#define FORWARD_FILE		3
705#define BACKWARD_FILE		(-3)
706
707/* return values for functions */
708#if !(defined(OK) && (OK == 1))
709/* OK already defined to 1 in MacOS X curses, skip this */
710# define OK			1
711#endif
712#define FAIL			0
713#define NOTDONE			2   /* not OK or FAIL but skipped */
714
715/* flags for b_flags */
716#define BF_RECOVERED	0x01	/* buffer has been recovered */
717#define BF_CHECK_RO	0x02	/* need to check readonly when loading file
718				   into buffer (set by ":e", may be reset by
719				   ":buf" */
720#define BF_NEVERLOADED	0x04	/* file has never been loaded into buffer,
721				   many variables still need to be set */
722#define BF_NOTEDITED	0x08	/* Set when file name is changed after
723				   starting to edit, reset when file is
724				   written out. */
725#define BF_NEW		0x10	/* file didn't exist when editing started */
726#define BF_NEW_W	0x20	/* Warned for BF_NEW and file created */
727#define BF_READERR	0x40	/* got errors while reading the file */
728#define BF_DUMMY	0x80	/* dummy buffer, only used internally */
729#define BF_PRESERVED	0x100	/* ":preserve" was used */
730
731/* Mask to check for flags that prevent normal writing */
732#define BF_WRITE_MASK	(BF_NOTEDITED + BF_NEW + BF_READERR)
733
734/*
735 * values for xp_context when doing command line completion
736 */
737#define EXPAND_UNSUCCESSFUL	(-2)
738#define EXPAND_OK		(-1)
739#define EXPAND_NOTHING		0
740#define EXPAND_COMMANDS		1
741#define EXPAND_FILES		2
742#define EXPAND_DIRECTORIES	3
743#define EXPAND_SETTINGS		4
744#define EXPAND_BOOL_SETTINGS	5
745#define EXPAND_TAGS		6
746#define EXPAND_OLD_SETTING	7
747#define EXPAND_HELP		8
748#define EXPAND_BUFFERS		9
749#define EXPAND_EVENTS		10
750#define EXPAND_MENUS		11
751#define EXPAND_SYNTAX		12
752#define EXPAND_HIGHLIGHT	13
753#define EXPAND_AUGROUP		14
754#define EXPAND_USER_VARS	15
755#define EXPAND_MAPPINGS		16
756#define EXPAND_TAGS_LISTFILES	17
757#define EXPAND_FUNCTIONS	18
758#define EXPAND_USER_FUNC	19
759#define EXPAND_EXPRESSION	20
760#define EXPAND_MENUNAMES	21
761#define EXPAND_USER_COMMANDS	22
762#define EXPAND_USER_CMD_FLAGS	23
763#define EXPAND_USER_NARGS	24
764#define EXPAND_USER_COMPLETE	25
765#define EXPAND_ENV_VARS		26
766#define EXPAND_LANGUAGE		27
767#define EXPAND_COLORS		28
768#define EXPAND_COMPILER		29
769#define EXPAND_USER_DEFINED	30
770#define EXPAND_USER_LIST	31
771#define EXPAND_SHELLCMD		32
772#define EXPAND_CSCOPE		33
773#define EXPAND_SIGN		34
774#define EXPAND_PROFILE		35
775#define EXPAND_BEHAVE		36
776#define EXPAND_FILETYPE		37
777#define EXPAND_FILES_IN_PATH	38
778#define EXPAND_OWNSYNTAX	39
779
780/* Values for exmode_active (0 is no exmode) */
781#define EXMODE_NORMAL		1
782#define EXMODE_VIM		2
783
784/* Values for nextwild() and ExpandOne().  See ExpandOne() for meaning. */
785#define WILD_FREE		1
786#define WILD_EXPAND_FREE	2
787#define WILD_EXPAND_KEEP	3
788#define WILD_NEXT		4
789#define WILD_PREV		5
790#define WILD_ALL		6
791#define WILD_LONGEST		7
792
793#define WILD_LIST_NOTFOUND	1
794#define WILD_HOME_REPLACE	2
795#define WILD_USE_NL		4
796#define WILD_NO_BEEP		8
797#define WILD_ADD_SLASH		16
798#define WILD_KEEP_ALL		32
799#define WILD_SILENT		64
800#define WILD_ESCAPE		128
801
802/* Flags for expand_wildcards() */
803#define EW_DIR		0x01	/* include directory names */
804#define EW_FILE		0x02	/* include file names */
805#define EW_NOTFOUND	0x04	/* include not found names */
806#define EW_ADDSLASH	0x08	/* append slash to directory name */
807#define EW_KEEPALL	0x10	/* keep all matches */
808#define EW_SILENT	0x20	/* don't print "1 returned" from shell */
809#define EW_EXEC		0x40	/* executable files */
810#define EW_PATH		0x80	/* search in 'path' too */
811/* Note: mostly EW_NOTFOUND and EW_SILENT are mutually exclusive: EW_NOTFOUND
812 * is used when executing commands and EW_SILENT for interactive expanding. */
813
814/* Flags for find_file_*() functions. */
815#define FINDFILE_FILE	0	/* only files */
816#define FINDFILE_DIR	1	/* only directories */
817#define FINDFILE_BOTH	2	/* files and directories */
818
819#ifdef FEAT_VERTSPLIT
820# define W_WINCOL(wp)	(wp->w_wincol)
821# define W_WIDTH(wp)	(wp->w_width)
822# define W_ENDCOL(wp)	(wp->w_wincol + wp->w_width)
823# define W_VSEP_WIDTH(wp) (wp->w_vsep_width)
824#else
825# define W_WINCOL(wp)	0
826# define W_WIDTH(wp)	Columns
827# define W_ENDCOL(wp)	Columns
828# define W_VSEP_WIDTH(wp) 0
829#endif
830#ifdef FEAT_WINDOWS
831# define W_STATUS_HEIGHT(wp) (wp->w_status_height)
832# define W_WINROW(wp)	(wp->w_winrow)
833#else
834# define W_STATUS_HEIGHT(wp) 0
835# define W_WINROW(wp)	0
836#endif
837
838#ifdef NO_EXPANDPATH
839# define gen_expand_wildcards mch_expand_wildcards
840#endif
841
842/* Values for the find_pattern_in_path() function args 'type' and 'action': */
843#define FIND_ANY	1
844#define FIND_DEFINE	2
845#define CHECK_PATH	3
846
847#define ACTION_SHOW	1
848#define ACTION_GOTO	2
849#define ACTION_SPLIT	3
850#define ACTION_SHOW_ALL	4
851#ifdef FEAT_INS_EXPAND
852# define ACTION_EXPAND	5
853#endif
854
855#ifdef FEAT_SYN_HL
856# define SST_MIN_ENTRIES 150	/* minimal size for state stack array */
857# ifdef FEAT_GUI_W16
858#  define SST_MAX_ENTRIES 500	/* (only up to 64K blocks) */
859# else
860#  define SST_MAX_ENTRIES 1000	/* maximal size for state stack array */
861# endif
862# define SST_FIX_STATES	 7	/* size of sst_stack[]. */
863# define SST_DIST	 16	/* normal distance between entries */
864# define SST_INVALID	(synstate_T *)-1	/* invalid syn_state pointer */
865
866# define HL_CONTAINED	0x01	/* not used on toplevel */
867# define HL_TRANSP	0x02	/* has no highlighting	*/
868# define HL_ONELINE	0x04	/* match within one line only */
869# define HL_HAS_EOL	0x08	/* end pattern that matches with $ */
870# define HL_SYNC_HERE	0x10	/* sync point after this item (syncing only) */
871# define HL_SYNC_THERE	0x20	/* sync point at current line (syncing only) */
872# define HL_MATCH	0x40	/* use match ID instead of item ID */
873# define HL_SKIPNL	0x80	/* nextgroup can skip newlines */
874# define HL_SKIPWHITE	0x100	/* nextgroup can skip white space */
875# define HL_SKIPEMPTY	0x200	/* nextgroup can skip empty lines */
876# define HL_KEEPEND	0x400	/* end match always kept */
877# define HL_EXCLUDENL	0x800	/* exclude NL from match */
878# define HL_DISPLAY	0x1000	/* only used for displaying, not syncing */
879# define HL_FOLD	0x2000	/* define fold */
880# define HL_EXTEND	0x4000	/* ignore a keepend */
881# define HL_MATCHCONT	0x8000	/* match continued from previous line */
882# define HL_TRANS_CONT	0x10000 /* transparent item without contains arg */
883# define HL_CONCEAL	0x20000 /* can be concealed */
884# define HL_CONCEALENDS	0x40000 /* can be concealed */
885#endif
886
887/* Values for 'options' argument in do_search() and searchit() */
888#define SEARCH_REV    0x01  /* go in reverse of previous dir. */
889#define SEARCH_ECHO   0x02  /* echo the search command and handle options */
890#define SEARCH_MSG    0x0c  /* give messages (yes, it's not 0x04) */
891#define SEARCH_NFMSG  0x08  /* give all messages except not found */
892#define SEARCH_OPT    0x10  /* interpret optional flags */
893#define SEARCH_HIS    0x20  /* put search pattern in history */
894#define SEARCH_END    0x40  /* put cursor at end of match */
895#define SEARCH_NOOF   0x80  /* don't add offset to position */
896#define SEARCH_START 0x100  /* start search without col offset */
897#define SEARCH_MARK  0x200  /* set previous context mark */
898#define SEARCH_KEEP  0x400  /* keep previous search pattern */
899#define SEARCH_PEEK  0x800  /* peek for typed char, cancel search */
900
901/* Values for find_ident_under_cursor() */
902#define FIND_IDENT	1	/* find identifier (word) */
903#define FIND_STRING	2	/* find any string (WORD) */
904#define FIND_EVAL	4	/* include "->", "[]" and "." */
905
906/* Values for file_name_in_line() */
907#define FNAME_MESS	1	/* give error message */
908#define FNAME_EXP	2	/* expand to path */
909#define FNAME_HYP	4	/* check for hypertext link */
910#define FNAME_INCL	8	/* apply 'includeexpr' */
911#define FNAME_REL	16	/* ".." and "./" are relative to the (current)
912				   file instead of the current directory */
913
914/* Values for buflist_getfile() */
915#define GETF_SETMARK	0x01	/* set pcmark before jumping */
916#define GETF_ALT	0x02	/* jumping to alternate file (not buf num) */
917#define GETF_SWITCH	0x04	/* respect 'switchbuf' settings when jumping */
918
919/* Values for buflist_new() flags */
920#define BLN_CURBUF	1	/* May re-use curbuf for new buffer */
921#define BLN_LISTED	2	/* Put new buffer in buffer list */
922#define BLN_DUMMY	4	/* Allocating dummy buffer */
923
924/* Values for in_cinkeys() */
925#define KEY_OPEN_FORW	0x101
926#define KEY_OPEN_BACK	0x102
927#define KEY_COMPLETE	0x103	/* end of completion */
928
929/* Values for "noremap" argument of ins_typebuf().  Also used for
930 * map->m_noremap and menu->noremap[]. */
931#define REMAP_YES	0	/* allow remapping */
932#define REMAP_NONE	-1	/* no remapping */
933#define REMAP_SCRIPT	-2	/* remap script-local mappings only */
934#define REMAP_SKIP	-3	/* no remapping for first char */
935
936/* Values for mch_call_shell() second argument */
937#define SHELL_FILTER	1	/* filtering text */
938#define SHELL_EXPAND	2	/* expanding wildcards */
939#define SHELL_COOKED	4	/* set term to cooked mode */
940#define SHELL_DOOUT	8	/* redirecting output */
941#define SHELL_SILENT	16	/* don't print error returned by command */
942#define SHELL_READ	32	/* read lines and insert into buffer */
943#define SHELL_WRITE	64	/* write lines from buffer */
944
945/* Values returned by mch_nodetype() */
946#define NODE_NORMAL	0	/* file or directory, check with mch_isdir()*/
947#define NODE_WRITABLE	1	/* something we can write to (character
948				   device, fifo, socket, ..) */
949#define NODE_OTHER	2	/* non-writable thing (e.g., block device) */
950
951/* Values for readfile() flags */
952#define READ_NEW	0x01	/* read a file into a new buffer */
953#define READ_FILTER	0x02	/* read filter output */
954#define READ_STDIN	0x04	/* read from stdin */
955#define READ_BUFFER	0x08	/* read from curbuf (converting stdin) */
956#define READ_DUMMY	0x10	/* reading into a dummy buffer */
957#define READ_KEEP_UNDO	0x20	/* keep undo info*/
958
959/* Values for change_indent() */
960#define INDENT_SET	1	/* set indent */
961#define INDENT_INC	2	/* increase indent */
962#define INDENT_DEC	3	/* decrease indent */
963
964/* Values for flags argument for findmatchlimit() */
965#define FM_BACKWARD	0x01	/* search backwards */
966#define FM_FORWARD	0x02	/* search forwards */
967#define FM_BLOCKSTOP	0x04	/* stop at start/end of block */
968#define FM_SKIPCOMM	0x08	/* skip comments */
969
970/* Values for action argument for do_buffer() */
971#define DOBUF_GOTO	0	/* go to specified buffer */
972#define DOBUF_SPLIT	1	/* split window and go to specified buffer */
973#define DOBUF_UNLOAD	2	/* unload specified buffer(s) */
974#define DOBUF_DEL	3	/* delete specified buffer(s) from buflist */
975#define DOBUF_WIPE	4	/* delete specified buffer(s) really */
976
977/* Values for start argument for do_buffer() */
978#define DOBUF_CURRENT	0	/* "count" buffer from current buffer */
979#define DOBUF_FIRST	1	/* "count" buffer from first buffer */
980#define DOBUF_LAST	2	/* "count" buffer from last buffer */
981#define DOBUF_MOD	3	/* "count" mod. buffer from current buffer */
982
983/* Values for sub_cmd and which_pat argument for search_regcomp() */
984/* Also used for which_pat argument for searchit() */
985#define RE_SEARCH	0	/* save/use pat in/from search_pattern */
986#define RE_SUBST	1	/* save/use pat in/from subst_pattern */
987#define RE_BOTH		2	/* save pat in both patterns */
988#define RE_LAST		2	/* use last used pattern if "pat" is NULL */
989
990/* Second argument for vim_regcomp(). */
991#define RE_MAGIC	1	/* 'magic' option */
992#define RE_STRING	2	/* match in string instead of buffer text */
993#define RE_STRICT	4	/* don't allow [abc] without ] */
994
995#ifdef FEAT_SYN_HL
996/* values for reg_do_extmatch */
997# define REX_SET	1	/* to allow \z\(...\), */
998# define REX_USE	2	/* to allow \z\1 et al. */
999#endif
1000
1001/* Return values for fullpathcmp() */
1002/* Note: can use (fullpathcmp() & FPC_SAME) to check for equal files */
1003#define FPC_SAME	1	/* both exist and are the same file. */
1004#define FPC_DIFF	2	/* both exist and are different files. */
1005#define FPC_NOTX	4	/* both don't exist. */
1006#define FPC_DIFFX	6	/* one of them doesn't exist. */
1007#define FPC_SAMEX	7	/* both don't exist and file names are same. */
1008
1009/* flags for do_ecmd() */
1010#define ECMD_HIDE	0x01	/* don't free the current buffer */
1011#define ECMD_SET_HELP	0x02	/* set b_help flag of (new) buffer before
1012				   opening file */
1013#define ECMD_OLDBUF	0x04	/* use existing buffer if it exists */
1014#define ECMD_FORCEIT	0x08	/* ! used in Ex command */
1015#define ECMD_ADDBUF	0x10	/* don't edit, just add to buffer list */
1016
1017/* for lnum argument in do_ecmd() */
1018#define ECMD_LASTL	(linenr_T)0	/* use last position in loaded file */
1019#define ECMD_LAST	(linenr_T)-1	/* use last position in all files */
1020#define ECMD_ONE	(linenr_T)1	/* use first line */
1021
1022/* flags for do_cmdline() */
1023#define DOCMD_VERBOSE	0x01	/* included command in error message */
1024#define DOCMD_NOWAIT	0x02	/* don't call wait_return() and friends */
1025#define DOCMD_REPEAT	0x04	/* repeat exec. until getline() returns NULL */
1026#define DOCMD_KEYTYPED	0x08	/* don't reset KeyTyped */
1027#define DOCMD_EXCRESET	0x10	/* reset exception environment (for debugging)*/
1028#define DOCMD_KEEPLINE  0x20	/* keep typed line for repeating with "." */
1029
1030/* flags for beginline() */
1031#define BL_WHITE	1	/* cursor on first non-white in the line */
1032#define BL_SOL		2	/* use 'sol' option */
1033#define BL_FIX		4	/* don't leave cursor on a NUL */
1034
1035/* flags for mf_sync() */
1036#define MFS_ALL		1	/* also sync blocks with negative numbers */
1037#define MFS_STOP	2	/* stop syncing when a character is available */
1038#define MFS_FLUSH	4	/* flushed file to disk */
1039#define MFS_ZERO	8	/* only write block 0 */
1040
1041/* flags for buf_copy_options() */
1042#define BCO_ENTER	1	/* going to enter the buffer */
1043#define BCO_ALWAYS	2	/* always copy the options */
1044#define BCO_NOHELP	4	/* don't touch the help related options */
1045
1046/* flags for do_put() */
1047#define PUT_FIXINDENT	1	/* make indent look nice */
1048#define PUT_CURSEND	2	/* leave cursor after end of new text */
1049#define PUT_CURSLINE	4	/* leave cursor on last line of new text */
1050#define PUT_LINE	8	/* put register as lines */
1051#define PUT_LINE_SPLIT	16	/* split line for linewise register */
1052#define PUT_LINE_FORWARD 32	/* put linewise register below Visual sel. */
1053
1054/* flags for set_indent() */
1055#define SIN_CHANGED	1	/* call changed_bytes() when line changed */
1056#define SIN_INSERT	2	/* insert indent before existing text */
1057#define SIN_UNDO	4	/* save line for undo before changing it */
1058
1059/* flags for insertchar() */
1060#define INSCHAR_FORMAT	1	/* force formatting */
1061#define INSCHAR_DO_COM	2	/* format comments */
1062#define INSCHAR_CTRLV	4	/* char typed just after CTRL-V */
1063#define INSCHAR_NO_FEX	8	/* don't use 'formatexpr' */
1064
1065/* flags for open_line() */
1066#define OPENLINE_DELSPACES  1	/* delete spaces after cursor */
1067#define OPENLINE_DO_COM	    2	/* format comments */
1068#define OPENLINE_KEEPTRAIL  4	/* keep trailing spaces */
1069#define OPENLINE_MARKFIX    8	/* fix mark positions */
1070
1071/*
1072 * There are four history tables:
1073 */
1074#define HIST_CMD	0	/* colon commands */
1075#define HIST_SEARCH	1	/* search commands */
1076#define HIST_EXPR	2	/* expressions (from entering = register) */
1077#define HIST_INPUT	3	/* input() lines */
1078#define HIST_DEBUG	4	/* debug commands */
1079#define HIST_COUNT	5	/* number of history tables */
1080
1081/*
1082 * Flags for chartab[].
1083 */
1084#define CT_CELL_MASK	0x07	/* mask: nr of display cells (1, 2 or 4) */
1085#define CT_PRINT_CHAR	0x10	/* flag: set for printable chars */
1086#define CT_ID_CHAR	0x20	/* flag: set for ID chars */
1087#define CT_FNAME_CHAR	0x40	/* flag: set for file name chars */
1088
1089/*
1090 * Values for do_tag().
1091 */
1092#define DT_TAG		1	/* jump to newer position or same tag again */
1093#define DT_POP		2	/* jump to older position */
1094#define DT_NEXT		3	/* jump to next match of same tag */
1095#define DT_PREV		4	/* jump to previous match of same tag */
1096#define DT_FIRST	5	/* jump to first match of same tag */
1097#define DT_LAST		6	/* jump to first match of same tag */
1098#define DT_SELECT	7	/* jump to selection from list */
1099#define DT_HELP		8	/* like DT_TAG, but no wildcards */
1100#define DT_JUMP		9	/* jump to new tag or selection from list */
1101#define DT_CSCOPE	10	/* cscope find command (like tjump) */
1102#define DT_LTAG		11	/* tag using location list */
1103#define DT_FREE		99	/* free cached matches */
1104
1105/*
1106 * flags for find_tags().
1107 */
1108#define TAG_HELP	1	/* only search for help tags */
1109#define TAG_NAMES	2	/* only return name of tag */
1110#define	TAG_REGEXP	4	/* use tag pattern as regexp */
1111#define	TAG_NOIC	8	/* don't always ignore case */
1112#ifdef FEAT_CSCOPE
1113# define TAG_CSCOPE	16	/* cscope tag */
1114#endif
1115#define TAG_VERBOSE	32	/* message verbosity */
1116#define TAG_INS_COMP	64	/* Currently doing insert completion */
1117#define TAG_KEEP_LANG	128	/* keep current language */
1118
1119#define TAG_MANY	300	/* When finding many tags (for completion),
1120				   find up to this many tags */
1121
1122/*
1123 * Types of dialogs passed to do_vim_dialog().
1124 */
1125#define VIM_GENERIC	0
1126#define VIM_ERROR	1
1127#define VIM_WARNING	2
1128#define VIM_INFO	3
1129#define VIM_QUESTION	4
1130#define VIM_LAST_TYPE	4	/* sentinel value */
1131
1132/*
1133 * Return values for functions like gui_yesnocancel()
1134 */
1135#define VIM_YES		2
1136#define VIM_NO		3
1137#define VIM_CANCEL	4
1138#define VIM_ALL		5
1139#define VIM_DISCARDALL  6
1140
1141/*
1142 * arguments for win_split()
1143 */
1144#define WSP_ROOM	1	/* require enough room */
1145#define WSP_VERT	2	/* split vertically */
1146#define WSP_TOP		4	/* window at top-left of shell */
1147#define WSP_BOT		8	/* window at bottom-right of shell */
1148#define WSP_HELP	16	/* creating the help window */
1149#define WSP_BELOW	32	/* put new window below/right */
1150#define WSP_ABOVE	64	/* put new window above/left */
1151#define WSP_NEWLOC	128	/* don't copy location list */
1152
1153/*
1154 * arguments for gui_set_shellsize()
1155 */
1156#define RESIZE_VERT	1	/* resize vertically */
1157#define RESIZE_HOR	2	/* resize horizontally */
1158#define RESIZE_BOTH	15	/* resize in both directions */
1159
1160/*
1161 * "flags" values for option-setting functions.
1162 * When OPT_GLOBAL and OPT_LOCAL are both missing, set both local and global
1163 * values, get local value.
1164 */
1165#define OPT_FREE	1	/* free old value if it was allocated */
1166#define OPT_GLOBAL	2	/* use global value */
1167#define OPT_LOCAL	4	/* use local value */
1168#define OPT_MODELINE	8	/* option in modeline */
1169#define OPT_WINONLY	16	/* only set window-local options */
1170#define OPT_NOWIN	32	/* don't set window-local options */
1171
1172/* Magic chars used in confirm dialog strings */
1173#define DLG_BUTTON_SEP	'\n'
1174#define DLG_HOTKEY_CHAR	'&'
1175
1176/* Values for "starting" */
1177#define NO_SCREEN	2	/* no screen updating yet */
1178#define NO_BUFFERS	1	/* not all buffers loaded yet */
1179/*			0	   not starting anymore */
1180
1181/* Values for swap_exists_action: what to do when swap file already exists */
1182#define SEA_NONE	0	/* don't use dialog */
1183#define SEA_DIALOG	1	/* use dialog when possible */
1184#define SEA_QUIT	2	/* quit editing the file */
1185#define SEA_RECOVER	3	/* recover the file */
1186
1187/*
1188 * Minimal size for block 0 of a swap file.
1189 * NOTE: This depends on size of struct block0! It's not done with a sizeof(),
1190 * because struct block0 is defined in memline.c (Sorry).
1191 * The maximal block size is arbitrary.
1192 */
1193#define MIN_SWAP_PAGE_SIZE 1048
1194#define MAX_SWAP_PAGE_SIZE 50000
1195
1196/* Special values for current_SID. */
1197#define SID_MODELINE	-1	/* when using a modeline */
1198#define SID_CMDARG	-2	/* for "--cmd" argument */
1199#define SID_CARG	-3	/* for "-c" argument */
1200#define SID_ENV		-4	/* for sourcing environment variable */
1201#define SID_ERROR	-5	/* option was reset because of an error */
1202#define SID_NONE	-6	/* don't set scriptID */
1203
1204/*
1205 * Events for autocommands.
1206 */
1207enum auto_event
1208{
1209    EVENT_BUFADD = 0,		/* after adding a buffer to the buffer list */
1210    EVENT_BUFNEW,		/* after creating any buffer */
1211    EVENT_BUFDELETE,		/* deleting a buffer from the buffer list */
1212    EVENT_BUFWIPEOUT,		/* just before really deleting a buffer */
1213    EVENT_BUFENTER,		/* after entering a buffer */
1214    EVENT_BUFFILEPOST,		/* after renaming a buffer */
1215    EVENT_BUFFILEPRE,		/* before renaming a buffer */
1216    EVENT_BUFLEAVE,		/* before leaving a buffer */
1217    EVENT_BUFNEWFILE,		/* when creating a buffer for a new file */
1218    EVENT_BUFREADPOST,		/* after reading a buffer */
1219    EVENT_BUFREADPRE,		/* before reading a buffer */
1220    EVENT_BUFREADCMD,		/* read buffer using command */
1221    EVENT_BUFUNLOAD,		/* just before unloading a buffer */
1222    EVENT_BUFHIDDEN,		/* just after buffer becomes hidden */
1223    EVENT_BUFWINENTER,		/* after showing a buffer in a window */
1224    EVENT_BUFWINLEAVE,		/* just after buffer removed from window */
1225    EVENT_BUFWRITEPOST,		/* after writing a buffer */
1226    EVENT_BUFWRITEPRE,		/* before writing a buffer */
1227    EVENT_BUFWRITECMD,		/* write buffer using command */
1228    EVENT_CMDWINENTER,		/* after entering the cmdline window */
1229    EVENT_CMDWINLEAVE,		/* before leaving the cmdline window */
1230    EVENT_COLORSCHEME,		/* after loading a colorscheme */
1231    EVENT_FILEAPPENDPOST,	/* after appending to a file */
1232    EVENT_FILEAPPENDPRE,	/* before appending to a file */
1233    EVENT_FILEAPPENDCMD,	/* append to a file using command */
1234    EVENT_FILECHANGEDSHELL,	/* after shell command that changed file */
1235    EVENT_FILECHANGEDSHELLPOST,	/* after (not) reloading changed file */
1236    EVENT_FILECHANGEDRO,	/* before first change to read-only file */
1237    EVENT_FILEREADPOST,		/* after reading a file */
1238    EVENT_FILEREADPRE,		/* before reading a file */
1239    EVENT_FILEREADCMD,		/* read from a file using command */
1240    EVENT_FILETYPE,		/* new file type detected (user defined) */
1241    EVENT_FILEWRITEPOST,	/* after writing a file */
1242    EVENT_FILEWRITEPRE,		/* before writing a file */
1243    EVENT_FILEWRITECMD,		/* write to a file using command */
1244    EVENT_FILTERREADPOST,	/* after reading from a filter */
1245    EVENT_FILTERREADPRE,	/* before reading from a filter */
1246    EVENT_FILTERWRITEPOST,	/* after writing to a filter */
1247    EVENT_FILTERWRITEPRE,	/* before writing to a filter */
1248    EVENT_FOCUSGAINED,		/* got the focus */
1249    EVENT_FOCUSLOST,		/* lost the focus to another app */
1250    EVENT_GUIENTER,		/* after starting the GUI */
1251    EVENT_GUIFAILED,		/* after starting the GUI failed */
1252    EVENT_INSERTCHANGE,		/* when changing Insert/Replace mode */
1253    EVENT_INSERTENTER,		/* when entering Insert mode */
1254    EVENT_INSERTLEAVE,		/* when leaving Insert mode */
1255    EVENT_MENUPOPUP,		/* just before popup menu is displayed */
1256    EVENT_QUICKFIXCMDPOST,	/* after :make, :grep etc */
1257    EVENT_QUICKFIXCMDPRE,	/* before :make, :grep etc */
1258    EVENT_SESSIONLOADPOST,	/* after loading a session file */
1259    EVENT_STDINREADPOST,	/* after reading from stdin */
1260    EVENT_STDINREADPRE,		/* before reading from stdin */
1261    EVENT_SYNTAX,		/* syntax selected */
1262    EVENT_TERMCHANGED,		/* after changing 'term' */
1263    EVENT_TERMRESPONSE,		/* after setting "v:termresponse" */
1264    EVENT_USER,			/* user defined autocommand */
1265    EVENT_VIMENTER,		/* after starting Vim */
1266    EVENT_VIMLEAVE,		/* before exiting Vim */
1267    EVENT_VIMLEAVEPRE,		/* before exiting Vim and writing .viminfo */
1268    EVENT_VIMRESIZED,		/* after Vim window was resized */
1269    EVENT_WINENTER,		/* after entering a window */
1270    EVENT_WINLEAVE,		/* before leaving a window */
1271    EVENT_ENCODINGCHANGED,	/* after changing the 'encoding' option */
1272    EVENT_CURSORHOLD,		/* cursor in same position for a while */
1273    EVENT_CURSORHOLDI,		/* idem, in Insert mode */
1274    EVENT_FUNCUNDEFINED,	/* if calling a function which doesn't exist */
1275    EVENT_REMOTEREPLY,		/* upon string reception from a remote vim */
1276    EVENT_SWAPEXISTS,		/* found existing swap file */
1277    EVENT_SOURCEPRE,		/* before sourcing a Vim script */
1278    EVENT_SOURCECMD,		/* sourcing a Vim script using command */
1279    EVENT_SPELLFILEMISSING,	/* spell file missing */
1280    EVENT_CURSORMOVED,		/* cursor was moved */
1281    EVENT_CURSORMOVEDI,		/* cursor was moved in Insert mode */
1282    EVENT_TABLEAVE,		/* before leaving a tab page */
1283    EVENT_TABENTER,		/* after entering a tab page */
1284    EVENT_SHELLCMDPOST,		/* after ":!cmd" */
1285    EVENT_SHELLFILTERPOST,	/* after ":1,2!cmd", ":w !cmd", ":r !cmd". */
1286    NUM_EVENTS			/* MUST be the last one */
1287};
1288
1289typedef enum auto_event event_T;
1290
1291/*
1292 * Values for index in highlight_attr[].
1293 * When making changes, also update HL_FLAGS below!  And update the default
1294 * value of 'highlight' in option.c.
1295 */
1296typedef enum
1297{
1298    HLF_8 = 0	    /* Meta & special keys listed with ":map", text that is
1299		       displayed different from what it is */
1300    , HLF_AT	    /* @ and ~ characters at end of screen, characters that
1301		       don't really exist in the text */
1302    , HLF_D	    /* directories in CTRL-D listing */
1303    , HLF_E	    /* error messages */
1304    , HLF_H	    /* obsolete, ignored */
1305    , HLF_I	    /* incremental search */
1306    , HLF_L	    /* last search string */
1307    , HLF_M	    /* "--More--" message */
1308    , HLF_CM	    /* Mode (e.g., "-- INSERT --") */
1309    , HLF_N	    /* line number for ":number" and ":#" commands */
1310    , HLF_R	    /* return to continue message and yes/no questions */
1311    , HLF_S	    /* status lines */
1312    , HLF_SNC	    /* status lines of not-current windows */
1313    , HLF_C	    /* column to separate vertically split windows */
1314    , HLF_T	    /* Titles for output from ":set all", ":autocmd" etc. */
1315    , HLF_V	    /* Visual mode */
1316    , HLF_VNC	    /* Visual mode, autoselecting and not clipboard owner */
1317    , HLF_W	    /* warning messages */
1318    , HLF_WM	    /* Wildmenu highlight */
1319    , HLF_FL	    /* Folded line */
1320    , HLF_FC	    /* Fold column */
1321    , HLF_ADD	    /* Added diff line */
1322    , HLF_CHD	    /* Changed diff line */
1323    , HLF_DED	    /* Deleted diff line */
1324    , HLF_TXD	    /* Text Changed in diff line */
1325    , HLF_CONCEAL   /* Concealed text */
1326    , HLF_SC	    /* Sign column */
1327    , HLF_SPB	    /* SpellBad */
1328    , HLF_SPC	    /* SpellCap */
1329    , HLF_SPR	    /* SpellRare */
1330    , HLF_SPL	    /* SpellLocal */
1331    , HLF_PNI	    /* popup menu normal item */
1332    , HLF_PSI	    /* popup menu selected item */
1333    , HLF_PSB	    /* popup menu scrollbar */
1334    , HLF_PST	    /* popup menu scrollbar thumb */
1335    , HLF_TP	    /* tabpage line */
1336    , HLF_TPS	    /* tabpage line selected */
1337    , HLF_TPF	    /* tabpage line filler */
1338    , HLF_CUC	    /* 'cursurcolumn' */
1339    , HLF_CUL	    /* 'cursurline' */
1340    , HLF_MC	    /* 'colorcolumn' */
1341    , HLF_COUNT	    /* MUST be the last one */
1342} hlf_T;
1343
1344/* The HL_FLAGS must be in the same order as the HLF_ enums!
1345 * When changing this also adjust the default for 'highlight'. */
1346#define HL_FLAGS {'8', '@', 'd', 'e', 'h', 'i', 'l', 'm', 'M', \
1347		  'n', 'r', 's', 'S', 'c', 't', 'v', 'V', 'w', 'W', \
1348		  'f', 'F', 'A', 'C', 'D', 'T', '-', '>', \
1349		  'B', 'P', 'R', 'L', \
1350		  '+', '=', 'x', 'X', '*', '#', '_', '!', '.', 'o'}
1351
1352/*
1353 * Boolean constants
1354 */
1355#ifndef TRUE
1356# define FALSE	0	    /* note: this is an int, not a long! */
1357# define TRUE	1
1358#endif
1359
1360#define MAYBE	2	    /* sometimes used for a variant on TRUE */
1361
1362#ifndef UINT32_T
1363typedef UINT32_TYPEDEF UINT32_T;
1364#endif
1365
1366/*
1367 * Operator IDs; The order must correspond to opchars[] in ops.c!
1368 */
1369#define OP_NOP		0	/* no pending operation */
1370#define OP_DELETE	1	/* "d"  delete operator */
1371#define OP_YANK		2	/* "y"  yank operator */
1372#define OP_CHANGE	3	/* "c"  change operator */
1373#define OP_LSHIFT	4	/* "<"  left shift operator */
1374#define OP_RSHIFT	5	/* ">"  right shift operator */
1375#define OP_FILTER	6	/* "!"  filter operator */
1376#define OP_TILDE	7	/* "g~" switch case operator */
1377#define OP_INDENT	8	/* "="  indent operator */
1378#define OP_FORMAT	9	/* "gq" format operator */
1379#define OP_COLON	10	/* ":"  colon operator */
1380#define OP_UPPER	11	/* "gU" make upper case operator */
1381#define OP_LOWER	12	/* "gu" make lower case operator */
1382#define OP_JOIN		13	/* "J"  join operator, only for Visual mode */
1383#define OP_JOIN_NS	14	/* "gJ"  join operator, only for Visual mode */
1384#define OP_ROT13	15	/* "g?" rot-13 encoding */
1385#define OP_REPLACE	16	/* "r"  replace chars, only for Visual mode */
1386#define OP_INSERT	17	/* "I"  Insert column, only for Visual mode */
1387#define OP_APPEND	18	/* "A"  Append column, only for Visual mode */
1388#define OP_FOLD		19	/* "zf" define a fold */
1389#define OP_FOLDOPEN	20	/* "zo" open folds */
1390#define OP_FOLDOPENREC	21	/* "zO" open folds recursively */
1391#define OP_FOLDCLOSE	22	/* "zc" close folds */
1392#define OP_FOLDCLOSEREC	23	/* "zC" close folds recursively */
1393#define OP_FOLDDEL	24	/* "zd" delete folds */
1394#define OP_FOLDDELREC	25	/* "zD" delete folds recursively */
1395#define OP_FORMAT2	26	/* "gw" format operator, keeps cursor pos */
1396#define OP_FUNCTION	27	/* "g@" call 'operatorfunc' */
1397
1398/*
1399 * Motion types, used for operators and for yank/delete registers.
1400 */
1401#define MCHAR	0		/* character-wise movement/register */
1402#define MLINE	1		/* line-wise movement/register */
1403#define MBLOCK	2		/* block-wise register */
1404
1405#define MAUTO	0xff		/* Decide between MLINE/MCHAR */
1406
1407/*
1408 * Minimum screen size
1409 */
1410#define MIN_COLUMNS	12	/* minimal columns for screen */
1411#define MIN_LINES	2	/* minimal lines for screen */
1412#define STATUS_HEIGHT	1	/* height of a status line under a window */
1413#define QF_WINHEIGHT	10	/* default height for quickfix window */
1414
1415/*
1416 * Buffer sizes
1417 */
1418#ifndef CMDBUFFSIZE
1419# define CMDBUFFSIZE	256	/* size of the command processing buffer */
1420#endif
1421
1422#define LSIZE	    512		/* max. size of a line in the tags file */
1423
1424#define IOSIZE	   (1024+1)	/* file i/o and sprintf buffer size */
1425
1426#ifdef FEAT_MBYTE
1427# define MSG_BUF_LEN 480	/* length of buffer for small messages */
1428# define MSG_BUF_CLEN  (MSG_BUF_LEN / 6)    /* cell length (worst case: utf-8
1429					       takes 6 bytes for one cell) */
1430#else
1431# define MSG_BUF_LEN 80		/* length of buffer for small messages */
1432# define MSG_BUF_CLEN  MSG_BUF_LEN	    /* cell length */
1433#endif
1434
1435/* Size of the buffer used for tgetent().  Unfortunately this is largely
1436 * undocumented, some systems use 1024.  Using a buffer that is too small
1437 * causes a buffer overrun and a crash.  Use the maximum known value to stay
1438 * on the safe side. */
1439#define TBUFSZ 2048		/* buffer size for termcap entry */
1440
1441/*
1442 * Maximum length of key sequence to be mapped.
1443 * Must be able to hold an Amiga resize report.
1444 */
1445#define MAXMAPLEN   50
1446
1447/* Size in bytes of the hash used in the undo file. */
1448#define UNDO_HASH_SIZE 32
1449
1450#ifdef HAVE_FCNTL_H
1451# include <fcntl.h>
1452#endif
1453
1454#ifdef BINARY_FILE_IO
1455# define WRITEBIN   "wb"	/* no CR-LF translation */
1456# define READBIN    "rb"
1457# define APPENDBIN  "ab"
1458#else
1459# define WRITEBIN   "w"
1460# define READBIN    "r"
1461# define APPENDBIN  "a"
1462#endif
1463
1464/*
1465 * EMX doesn't have a global way of making open() use binary I/O.
1466 * Use O_BINARY for all open() calls.
1467 */
1468#if defined(__EMX__) || defined(__CYGWIN32__)
1469# define O_EXTRA    O_BINARY
1470#else
1471# define O_EXTRA    0
1472#endif
1473
1474#ifndef O_NOFOLLOW
1475# define O_NOFOLLOW 0
1476#endif
1477
1478#ifndef W_OK
1479# define W_OK 2		/* for systems that don't have W_OK in unistd.h */
1480#endif
1481#ifndef R_OK
1482# define R_OK 4		/* for systems that don't have R_OK in unistd.h */
1483#endif
1484
1485/*
1486 * defines to avoid typecasts from (char_u *) to (char *) and back
1487 * (vim_strchr() and vim_strrchr() are now in alloc.c)
1488 */
1489#define STRLEN(s)	    strlen((char *)(s))
1490#define STRCPY(d, s)	    strcpy((char *)(d), (char *)(s))
1491#define STRNCPY(d, s, n)    strncpy((char *)(d), (char *)(s), (size_t)(n))
1492#define STRCMP(d, s)	    strcmp((char *)(d), (char *)(s))
1493#define STRNCMP(d, s, n)    strncmp((char *)(d), (char *)(s), (size_t)(n))
1494#ifdef HAVE_STRCASECMP
1495# define STRICMP(d, s)	    strcasecmp((char *)(d), (char *)(s))
1496#else
1497# ifdef HAVE_STRICMP
1498#  define STRICMP(d, s)	    stricmp((char *)(d), (char *)(s))
1499# else
1500#  define STRICMP(d, s)	    vim_stricmp((char *)(d), (char *)(s))
1501# endif
1502#endif
1503
1504/* Like strcpy() but allows overlapped source and destination. */
1505#define STRMOVE(d, s)	    mch_memmove((d), (s), STRLEN(s) + 1)
1506
1507#ifdef HAVE_STRNCASECMP
1508# define STRNICMP(d, s, n)  strncasecmp((char *)(d), (char *)(s), (size_t)(n))
1509#else
1510# ifdef HAVE_STRNICMP
1511#  define STRNICMP(d, s, n) strnicmp((char *)(d), (char *)(s), (size_t)(n))
1512# else
1513#  define STRNICMP(d, s, n) vim_strnicmp((char *)(d), (char *)(s), (size_t)(n))
1514# endif
1515#endif
1516
1517#ifdef FEAT_MBYTE
1518/* We need to call mb_stricmp() even when we aren't dealing with a multi-byte
1519 * encoding because mb_stricmp() takes care of all ascii and non-ascii
1520 * encodings, including characters with umlauts in latin1, etc., while
1521 * STRICMP() only handles the system locale version, which often does not
1522 * handle non-ascii properly. */
1523
1524# define MB_STRICMP(d, s)	mb_strnicmp((char_u *)(d), (char_u *)(s), (int)MAXCOL)
1525# define MB_STRNICMP(d, s, n)	mb_strnicmp((char_u *)(d), (char_u *)(s), (int)(n))
1526#else
1527# define MB_STRICMP(d, s)	STRICMP((d), (s))
1528# define MB_STRNICMP(d, s, n)	STRNICMP((d), (s), (n))
1529#endif
1530
1531#define STRCAT(d, s)	    strcat((char *)(d), (char *)(s))
1532#define STRNCAT(d, s, n)    strncat((char *)(d), (char *)(s), (size_t)(n))
1533
1534#ifdef HAVE_STRPBRK
1535# define vim_strpbrk(s, cs) (char_u *)strpbrk((char *)(s), (char *)(cs))
1536#endif
1537
1538#define MSG(s)			    msg((char_u *)(s))
1539#define MSG_ATTR(s, attr)	    msg_attr((char_u *)(s), (attr))
1540#define EMSG(s)			    emsg((char_u *)(s))
1541#define EMSG2(s, p)		    emsg2((char_u *)(s), (char_u *)(p))
1542#define EMSG3(s, p, q)		    emsg3((char_u *)(s), (char_u *)(p), (char_u *)(q))
1543#define EMSGN(s, n)		    emsgn((char_u *)(s), (long)(n))
1544#define EMSGU(s, n)		    emsgu((char_u *)(s), (long_u)(n))
1545#define OUT_STR(s)		    out_str((char_u *)(s))
1546#define OUT_STR_NF(s)		    out_str_nf((char_u *)(s))
1547#define MSG_PUTS(s)		    msg_puts((char_u *)(s))
1548#define MSG_PUTS_ATTR(s, a)	    msg_puts_attr((char_u *)(s), (a))
1549#define MSG_PUTS_TITLE(s)	    msg_puts_title((char_u *)(s))
1550#define MSG_PUTS_LONG(s)	    msg_puts_long_attr((char_u *)(s), 0)
1551#define MSG_PUTS_LONG_ATTR(s, a)    msg_puts_long_attr((char_u *)(s), (a))
1552
1553/* Prefer using emsg3(), because perror() may send the output to the wrong
1554 * destination and mess up the screen. */
1555#ifdef HAVE_STRERROR
1556# define PERROR(msg)		    (void)emsg3((char_u *)"%s: %s", (char_u *)msg, (char_u *)strerror(errno))
1557#else
1558# define PERROR(msg)		    perror(msg)
1559#endif
1560
1561typedef long	linenr_T;		/* line number type */
1562typedef int	colnr_T;		/* column number type */
1563typedef unsigned short disptick_T;	/* display tick type */
1564
1565#define MAXLNUM (0x7fffffffL)		/* maximum (invalid) line number */
1566
1567/*
1568 * Well, you won't believe it, but some S/390 machines ("host", now also known
1569 * as zServer) use 31 bit pointers. There are also some newer machines, that
1570 * use 64 bit pointers. I don't know how to distinguish between 31 and 64 bit
1571 * machines, so the best way is to assume 31 bits whenever we detect OS/390
1572 * Unix.
1573 * With this we restrict the maximum line length to 1073741823. I guess this is
1574 * not a real problem. BTW:  Longer lines are split.
1575 */
1576#if SIZEOF_INT >= 4
1577# ifdef __MVS__
1578#  define MAXCOL (0x3fffffffL)		/* maximum column number, 30 bits */
1579# else
1580#  define MAXCOL (0x7fffffffL)		/* maximum column number, 31 bits */
1581# endif
1582#else
1583# define MAXCOL	(0x7fff)		/* maximum column number, 15 bits */
1584#endif
1585
1586#define SHOWCMD_COLS 10			/* columns needed by shown command */
1587#define STL_MAX_ITEM 80			/* max nr of %<flag> in statusline */
1588
1589typedef void	    *vim_acl_T;		/* dummy to pass an ACL to a function */
1590
1591/*
1592 * Include a prototype for mch_memmove(), it may not be in alloc.pro.
1593 */
1594#ifdef VIM_MEMMOVE
1595void mch_memmove __ARGS((void *, void *, size_t));
1596#else
1597# ifndef mch_memmove
1598#  define mch_memmove(to, from, len) memmove(to, from, len)
1599# endif
1600#endif
1601
1602/*
1603 * fnamecmp() is used to compare file names.
1604 * On some systems case in a file name does not matter, on others it does.
1605 * (this does not account for maximum name lengths and things like "../dir",
1606 * thus it is not 100% accurate!)
1607 */
1608#ifdef CASE_INSENSITIVE_FILENAME
1609# ifdef BACKSLASH_IN_FILENAME
1610#  define fnamecmp(x, y) vim_fnamecmp((x), (y))
1611#  define fnamencmp(x, y, n) vim_fnamencmp((x), (y), (size_t)(n))
1612# else
1613#  define fnamecmp(x, y) MB_STRICMP((x), (y))
1614#  define fnamencmp(x, y, n) MB_STRNICMP((x), (y), (n))
1615# endif
1616#else
1617# define fnamecmp(x, y) strcmp((char *)(x), (char *)(y))
1618# define fnamencmp(x, y, n) strncmp((char *)(x), (char *)(y), (size_t)(n))
1619#endif
1620
1621#ifdef HAVE_MEMSET
1622# define vim_memset(ptr, c, size)   memset((ptr), (c), (size))
1623#else
1624void *vim_memset __ARGS((void *, int, size_t));
1625#endif
1626
1627#ifdef HAVE_MEMCMP
1628# define vim_memcmp(p1, p2, len)   memcmp((p1), (p2), (len))
1629#else
1630# ifdef HAVE_BCMP
1631#  define vim_memcmp(p1, p2, len)   bcmp((p1), (p2), (len))
1632# else
1633int vim_memcmp __ARGS((void *, void *, size_t));
1634#  define VIM_MEMCMP
1635# endif
1636#endif
1637
1638#if defined(UNIX) || defined(FEAT_GUI) || defined(OS2) || defined(VMS) \
1639	|| defined(FEAT_CLIENTSERVER)
1640# define USE_INPUT_BUF
1641#endif
1642
1643#ifdef MSWIN
1644/* On MS-Windows the third argument isn't size_t.  This matters for Win64,
1645 * where sizeof(size_t)==8, not 4 */
1646# define vim_read(fd, buf, count)   read((fd), (char *)(buf), (unsigned int)(count))
1647# define vim_write(fd, buf, count)  write((fd), (char *)(buf), (unsigned int)(count))
1648#else
1649# define vim_read(fd, buf, count)   read((fd), (char *)(buf), (size_t) (count))
1650# define vim_write(fd, buf, count)  write((fd), (char *)(buf), (size_t) (count))
1651#endif
1652
1653/*
1654 * Enums need a typecast to be used as array index (for Ultrix).
1655 */
1656#define hl_attr(n)	highlight_attr[(int)(n)]
1657#define term_str(n)	term_strings[(int)(n)]
1658
1659/*
1660 * vim_iswhite() is used for "^" and the like. It differs from isspace()
1661 * because it doesn't include <CR> and <LF> and the like.
1662 */
1663#define vim_iswhite(x)	((x) == ' ' || (x) == '\t')
1664
1665/*
1666 * EXTERN is only defined in main.c.  That's where global variables are
1667 * actually defined and initialized.
1668 */
1669#ifndef EXTERN
1670# define EXTERN extern
1671# define INIT(x)
1672#else
1673# ifndef INIT
1674#  define INIT(x) x
1675#  define DO_INIT
1676# endif
1677#endif
1678
1679#ifdef FEAT_MBYTE
1680# define MAX_MCO	6	/* maximum value for 'maxcombine' */
1681
1682/* Maximum number of bytes in a multi-byte character.  It can be one 32-bit
1683 * character of up to 6 bytes, or one 16-bit character of up to three bytes
1684 * plus six following composing characters of three bytes each. */
1685# define MB_MAXBYTES	21
1686#endif
1687
1688#if (defined(FEAT_PROFILE) || defined(FEAT_RELTIME)) && !defined(PROTO)
1689# ifdef WIN3264
1690typedef LARGE_INTEGER proftime_T;
1691# else
1692typedef struct timeval proftime_T;
1693# endif
1694#else
1695typedef int proftime_T;	    /* dummy for function prototypes */
1696#endif
1697
1698/* Include option.h before structs.h, because the number of window-local and
1699 * buffer-local options is used there. */
1700#include "option.h"	    /* options and default values */
1701
1702/* Note that gui.h is included by structs.h */
1703
1704#include "structs.h"	    /* file that defines many structures */
1705
1706/* Values for "do_profiling". */
1707#define PROF_NONE	0	/* profiling not started */
1708#define PROF_YES	1	/* profiling busy */
1709#define PROF_PAUSED	2	/* profiling paused */
1710
1711#ifdef FEAT_MOUSE
1712
1713/* Codes for mouse button events in lower three bits: */
1714# define MOUSE_LEFT	0x00
1715# define MOUSE_MIDDLE	0x01
1716# define MOUSE_RIGHT	0x02
1717# define MOUSE_RELEASE	0x03
1718
1719/* bit masks for modifiers: */
1720# define MOUSE_SHIFT	0x04
1721# define MOUSE_ALT	0x08
1722# define MOUSE_CTRL	0x10
1723
1724/* mouse buttons that are handled like a key press (GUI only) */
1725/* Note that the scroll wheel keys are inverted: MOUSE_5 scrolls lines up but
1726 * the result of this is that the window moves down, similarly MOUSE_6 scrolls
1727 * columns left but the window moves right. */
1728# define MOUSE_4	0x100	/* scroll wheel down */
1729# define MOUSE_5	0x200	/* scroll wheel up */
1730
1731# define MOUSE_X1	0x300 /* Mouse-button X1 (6th) */
1732# define MOUSE_X2	0x400 /* Mouse-button X2 */
1733
1734# define MOUSE_6	0x500	/* scroll wheel left */
1735# define MOUSE_7	0x600	/* scroll wheel right */
1736
1737/* 0x20 is reserved by xterm */
1738# define MOUSE_DRAG_XTERM   0x40
1739
1740# define MOUSE_DRAG	(0x40 | MOUSE_RELEASE)
1741
1742/* Lowest button code for using the mouse wheel (xterm only) */
1743# define MOUSEWHEEL_LOW		0x60
1744
1745# define MOUSE_CLICK_MASK	0x03
1746
1747# define NUM_MOUSE_CLICKS(code) \
1748    (((unsigned)((code) & 0xC0) >> 6) + 1)
1749
1750# define SET_NUM_MOUSE_CLICKS(code, num) \
1751    (code) = ((code) & 0x3f) | ((((num) - 1) & 3) << 6)
1752
1753/* Added to mouse column for GUI when 'mousefocus' wants to give focus to a
1754 * window by simulating a click on its status line.  We could use up to 128 *
1755 * 128 = 16384 columns, now it's reduced to 10000. */
1756# define MOUSE_COLOFF 10000
1757
1758/*
1759 * jump_to_mouse() returns one of first four these values, possibly with
1760 * some of the other three added.
1761 */
1762# define IN_UNKNOWN		0
1763# define IN_BUFFER		1
1764# define IN_STATUS_LINE		2	/* on status or command line */
1765# define IN_SEP_LINE		4	/* on vertical separator line */
1766# define IN_OTHER_WIN		8	/* in other window but can't go there */
1767# define CURSOR_MOVED		0x100
1768# define MOUSE_FOLD_CLOSE	0x200	/* clicked on '-' in fold column */
1769# define MOUSE_FOLD_OPEN	0x400	/* clicked on '+' in fold column */
1770
1771/* flags for jump_to_mouse() */
1772# define MOUSE_FOCUS		0x01	/* need to stay in this window */
1773# define MOUSE_MAY_VIS		0x02	/* may start Visual mode */
1774# define MOUSE_DID_MOVE		0x04	/* only act when mouse has moved */
1775# define MOUSE_SETPOS		0x08	/* only set current mouse position */
1776# define MOUSE_MAY_STOP_VIS	0x10	/* may stop Visual mode */
1777# define MOUSE_RELEASED		0x20	/* button was released */
1778
1779# if defined(UNIX) && defined(HAVE_GETTIMEOFDAY) && defined(HAVE_SYS_TIME_H)
1780#  define CHECK_DOUBLE_CLICK 1	/* Checking for double clicks ourselves. */
1781# endif
1782
1783#endif /* FEAT_MOUSE */
1784
1785/* defines for eval_vars() */
1786#define VALID_PATH		1
1787#define VALID_HEAD		2
1788
1789/* Defines for Vim variables.  These must match vimvars[] in eval.c! */
1790#define VV_COUNT	0
1791#define VV_COUNT1	1
1792#define VV_PREVCOUNT	2
1793#define VV_ERRMSG	3
1794#define VV_WARNINGMSG	4
1795#define VV_STATUSMSG	5
1796#define VV_SHELL_ERROR	6
1797#define VV_THIS_SESSION	7
1798#define VV_VERSION	8
1799#define VV_LNUM		9
1800#define VV_TERMRESPONSE	10
1801#define VV_FNAME	11
1802#define VV_LANG		12
1803#define VV_LC_TIME	13
1804#define VV_CTYPE	14
1805#define VV_CC_FROM	15
1806#define VV_CC_TO	16
1807#define VV_FNAME_IN	17
1808#define VV_FNAME_OUT	18
1809#define VV_FNAME_NEW	19
1810#define VV_FNAME_DIFF	20
1811#define VV_CMDARG	21
1812#define VV_FOLDSTART	22
1813#define VV_FOLDEND	23
1814#define VV_FOLDDASHES	24
1815#define VV_FOLDLEVEL	25
1816#define VV_PROGNAME	26
1817#define VV_SEND_SERVER	27
1818#define VV_DYING	28
1819#define VV_EXCEPTION	29
1820#define VV_THROWPOINT	30
1821#define VV_REG		31
1822#define VV_CMDBANG	32
1823#define VV_INSERTMODE	33
1824#define VV_VAL		34
1825#define VV_KEY		35
1826#define VV_PROFILING	36
1827#define VV_FCS_REASON	37
1828#define VV_FCS_CHOICE	38
1829#define VV_BEVAL_BUFNR	39
1830#define VV_BEVAL_WINNR	40
1831#define VV_BEVAL_LNUM	41
1832#define VV_BEVAL_COL	42
1833#define VV_BEVAL_TEXT	43
1834#define VV_SCROLLSTART	44
1835#define VV_SWAPNAME	45
1836#define VV_SWAPCHOICE	46
1837#define VV_SWAPCOMMAND	47
1838#define VV_CHAR		48
1839#define VV_MOUSE_WIN	49
1840#define VV_MOUSE_LNUM   50
1841#define VV_MOUSE_COL	51
1842#define VV_OP		52
1843#define VV_SEARCHFORWARD 53
1844#define VV_OLDFILES	54
1845#define VV_LEN		55	/* number of v: vars */
1846
1847#ifdef FEAT_CLIPBOARD
1848
1849/* VIM_ATOM_NAME is the older Vim-specific selection type for X11.  Still
1850 * supported for when a mix of Vim versions is used. VIMENC_ATOM_NAME includes
1851 * the encoding to support Vims using different 'encoding' values. */
1852#define VIM_ATOM_NAME "_VIM_TEXT"
1853#define VIMENC_ATOM_NAME "_VIMENC_TEXT"
1854
1855/* Selection states for modeless selection */
1856# define SELECT_CLEARED		0
1857# define SELECT_IN_PROGRESS	1
1858# define SELECT_DONE		2
1859
1860# define SELECT_MODE_CHAR	0
1861# define SELECT_MODE_WORD	1
1862# define SELECT_MODE_LINE	2
1863
1864# ifdef FEAT_GUI_W32
1865#  ifdef FEAT_OLE
1866#   define WM_OLE (WM_APP+0)
1867#  endif
1868#  ifdef FEAT_NETBEANS_INTG
1869    /* message for Netbeans socket event */
1870#   define WM_NETBEANS (WM_APP+1)
1871#  endif
1872# endif
1873
1874/* Info about selected text */
1875typedef struct VimClipboard
1876{
1877    int		available;	/* Is clipboard available? */
1878    int		owned;		/* Flag: do we own the selection? */
1879    pos_T	start;		/* Start of selected area */
1880    pos_T	end;		/* End of selected area */
1881    int		vmode;		/* Visual mode character */
1882
1883    /* Fields for selection that doesn't use Visual mode */
1884    short_u	origin_row;
1885    short_u	origin_start_col;
1886    short_u	origin_end_col;
1887    short_u	word_start_col;
1888    short_u	word_end_col;
1889
1890    pos_T	prev;		/* Previous position */
1891    short_u	state;		/* Current selection state */
1892    short_u	mode;		/* Select by char, word, or line. */
1893
1894# if defined(FEAT_GUI_X11) || defined(FEAT_XCLIPBOARD)
1895    Atom	sel_atom;	/* PRIMARY/CLIPBOARD selection ID */
1896# endif
1897
1898# ifdef FEAT_GUI_GTK
1899    GdkAtom     gtk_sel_atom;	/* PRIMARY/CLIPBOARD selection ID */
1900# endif
1901
1902# ifdef MSWIN
1903    int_u	format;		/* Vim's own special clipboard format */
1904    int_u	format_raw;	/* Vim's raw text clipboard format */
1905# endif
1906} VimClipboard;
1907#else
1908typedef int VimClipboard;	/* This is required for the prototypes. */
1909#endif
1910
1911#ifdef __BORLANDC__
1912/* work around a bug in the Borland 'stat' function: */
1913# include <io.h>	    /* for access() */
1914
1915# define stat(a,b) (access(a,0) ? -1 : stat(a,b))
1916#endif
1917
1918#include "ex_cmds.h"	    /* Ex command defines */
1919#include "proto.h"	    /* function prototypes */
1920
1921/* This has to go after the include of proto.h, as proto/gui.pro declares
1922 * functions of these names. The declarations would break if the defines had
1923 * been seen at that stage.  But it must be before globals.h, where error_ga
1924 * is declared. */
1925#if !defined(FEAT_GUI_W32) && !defined(FEAT_GUI_X11) \
1926	&& !defined(FEAT_GUI_GTK) && !defined(FEAT_GUI_MAC)
1927# define mch_errmsg(str)	fprintf(stderr, "%s", (str))
1928# define display_errors()	fflush(stderr)
1929# define mch_msg(str)		printf("%s", (str))
1930#else
1931# define USE_MCH_ERRMSG
1932#endif
1933
1934#ifndef FEAT_MBYTE
1935# define after_pathsep(b, p)	vim_ispathsep(*((p) - 1))
1936# define transchar_byte(c)	transchar(c)
1937#endif
1938
1939#ifndef FEAT_LINEBREAK
1940/* Without the 'numberwidth' option line numbers are always 7 chars. */
1941# define number_width(x) 7
1942#endif
1943
1944
1945#include "globals.h"	    /* global variables and messages */
1946
1947#ifdef FEAT_SNIFF
1948# include "if_sniff.h"
1949#endif
1950
1951#ifndef FEAT_VIRTUALEDIT
1952# define getvvcol(w, p, s, c, e) getvcol(w, p, s, c, e)
1953# define virtual_active() 0
1954# define virtual_op FALSE
1955#endif
1956
1957/*
1958 * If console dialog not supported, but GUI dialog is, use the GUI one.
1959 */
1960#if defined(FEAT_GUI_DIALOG) && !defined(FEAT_CON_DIALOG)
1961# define do_dialog gui_mch_dialog
1962#endif
1963
1964/*
1965 * Default filters for gui_mch_browse().
1966 * The filters are almost system independent.  Except for the difference
1967 * between "*" and "*.*" for MSDOS-like systems.
1968 * NOTE: Motif only uses the very first pattern.  Therefore
1969 * BROWSE_FILTER_DEFAULT should start with a "*" pattern.
1970 */
1971#ifdef FEAT_BROWSE
1972# ifdef BACKSLASH_IN_FILENAME
1973#  define BROWSE_FILTER_MACROS \
1974	(char_u *)"Vim macro files (*.vim)\t*.vim\nAll Files (*.*)\t*.*\n"
1975#  define BROWSE_FILTER_ALL_FILES (char_u *)"All Files (*.*)\t*.*\n"
1976#  define BROWSE_FILTER_DEFAULT \
1977	(char_u *)"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"
1978# else
1979#  define BROWSE_FILTER_MACROS \
1980	(char_u *)"Vim macro files (*.vim)\t*.vim\nAll Files (*)\t*\n"
1981#  define BROWSE_FILTER_ALL_FILES (char_u *)"All Files (*)\t*\n"
1982#  define BROWSE_FILTER_DEFAULT \
1983	(char_u *)"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"
1984# endif
1985# define BROWSE_SAVE 1	    /* flag for do_browse() */
1986# define BROWSE_DIR 2	    /* flag for do_browse() */
1987#endif
1988
1989/* stop using fastcall for Borland */
1990#if defined(__BORLANDC__) && defined(WIN32) && !defined(DEBUG)
1991 #pragma option -p.
1992#endif
1993
1994#ifdef _MSC_VER
1995/* Avoid useless warning "conversion from X to Y of greater size". */
1996 #pragma warning(disable : 4312)
1997#endif
1998
1999#if defined(MEM_PROFILE)
2000# define vim_realloc(ptr, size)  mem_realloc((ptr), (size))
2001#else
2002# define vim_realloc(ptr, size)  realloc((ptr), (size))
2003#endif
2004
2005/*
2006 * The following macros stop display/event loop nesting at the wrong time.
2007 */
2008#ifdef ALT_X_INPUT
2009# define ALT_INPUT_LOCK_OFF	suppress_alternate_input = FALSE
2010# define ALT_INPUT_LOCK_ON	suppress_alternate_input = TRUE
2011#endif
2012
2013#ifdef FEAT_MBYTE
2014/*
2015 * Return byte length of character that starts with byte "b".
2016 * Returns 1 for a single-byte character.
2017 * MB_BYTE2LEN_CHECK() can be used to count a special key as one byte.
2018 * Don't call MB_BYTE2LEN(b) with b < 0 or b > 255!
2019 */
2020# define MB_BYTE2LEN(b)		mb_bytelen_tab[b]
2021# define MB_BYTE2LEN_CHECK(b)	(((b) < 0 || (b) > 255) ? 1 : mb_bytelen_tab[b])
2022#endif
2023
2024#if defined(FEAT_MBYTE) || defined(FEAT_POSTSCRIPT)
2025/* properties used in enc_canon_table[] (first three mutually exclusive) */
2026# define ENC_8BIT	0x01
2027# define ENC_DBCS	0x02
2028# define ENC_UNICODE	0x04
2029
2030# define ENC_ENDIAN_B	0x10	    /* Unicode: Big endian */
2031# define ENC_ENDIAN_L	0x20	    /* Unicode: Little endian */
2032
2033# define ENC_2BYTE	0x40	    /* Unicode: UCS-2 */
2034# define ENC_4BYTE	0x80	    /* Unicode: UCS-4 */
2035# define ENC_2WORD	0x100	    /* Unicode: UTF-16 */
2036
2037# define ENC_LATIN1	0x200	    /* Latin1 */
2038# define ENC_LATIN9	0x400	    /* Latin9 */
2039# define ENC_MACROMAN	0x800	    /* Mac Roman (not Macro Man! :-) */
2040#endif
2041
2042#ifdef FEAT_MBYTE
2043# ifdef USE_ICONV
2044#  ifndef EILSEQ
2045#   define EILSEQ 123
2046#  endif
2047#  ifdef DYNAMIC_ICONV
2048/* On Win32 iconv.dll is dynamically loaded. */
2049#   define ICONV_ERRNO (*iconv_errno())
2050#   define ICONV_E2BIG  7
2051#   define ICONV_EINVAL 22
2052#   define ICONV_EILSEQ 42
2053#  else
2054#   define ICONV_ERRNO errno
2055#   define ICONV_E2BIG  E2BIG
2056#   define ICONV_EINVAL EINVAL
2057#   define ICONV_EILSEQ EILSEQ
2058#  endif
2059# endif
2060
2061#endif
2062
2063/* ISSYMLINK(mode) tests if a file is a symbolic link. */
2064#if (defined(S_IFMT) && defined(S_IFLNK)) || defined(S_ISLNK)
2065# define HAVE_ISSYMLINK
2066# if defined(S_IFMT) && defined(S_IFLNK)
2067#  define ISSYMLINK(mode) (((mode) & S_IFMT) == S_IFLNK)
2068# else
2069#  define ISSYMLINK(mode) S_ISLNK(mode)
2070# endif
2071#endif
2072
2073#define SIGN_BYTE 1	    /* byte value used where sign is displayed;
2074			       attribute value is sign type */
2075
2076#ifdef FEAT_NETBEANS_INTG
2077# define MULTISIGN_BYTE 2   /* byte value used where sign is displayed if
2078			       multiple signs exist on the line */
2079#endif
2080
2081#if defined(FEAT_GUI) && defined(FEAT_XCLIPBOARD)
2082# ifdef FEAT_GUI_GTK
2083   /* Avoid using a global variable for the X display.  It's ugly
2084    * and is likely to cause trouble in multihead environments. */
2085#  define X_DISPLAY	((gui.in_use) ? gui_mch_get_display() : xterm_dpy)
2086# else
2087#  define X_DISPLAY	(gui.in_use ? gui.dpy : xterm_dpy)
2088# endif
2089#else
2090# ifdef FEAT_GUI
2091#  ifdef FEAT_GUI_GTK
2092#   define X_DISPLAY	((gui.in_use) ? gui_mch_get_display() : (Display *)NULL)
2093#  else
2094#   define X_DISPLAY	gui.dpy
2095#  endif
2096# else
2097#  define X_DISPLAY	xterm_dpy
2098# endif
2099#endif
2100
2101#ifndef FEAT_NETBEANS_INTG
2102# undef NBDEBUG
2103#endif
2104#ifdef NBDEBUG /* Netbeans debugging. */
2105# include "nbdebug.h"
2106#else
2107# define nbdebug(a)
2108#endif
2109
2110#ifdef IN_PERL_FILE
2111  /*
2112   * Avoid clashes between Perl and Vim namespace.
2113   */
2114# undef NORMAL
2115# undef STRLEN
2116# undef FF
2117# undef OP_DELETE
2118# undef OP_JOIN
2119# ifdef __BORLANDC__
2120#  define NOPROTO 1
2121# endif
2122  /* remove MAX and MIN, included by glib.h, redefined by sys/param.h */
2123# ifdef MAX
2124#  undef MAX
2125# endif
2126# ifdef MIN
2127#  undef MIN
2128# endif
2129  /* We use _() for gettext(), Perl uses it for function prototypes... */
2130# ifdef _
2131#  undef _
2132# endif
2133# ifdef DEBUG
2134#  undef DEBUG
2135# endif
2136# ifdef _DEBUG
2137#  undef _DEBUG
2138# endif
2139# ifdef instr
2140#  undef instr
2141# endif
2142  /* bool may cause trouble on MACOS but is required on a few other systems
2143   * and for Perl */
2144# if defined(bool) && defined(MACOS) && !defined(FEAT_PERL)
2145#  undef bool
2146# endif
2147
2148# ifdef __BORLANDC__
2149  /* Borland has the structure stati64 but not _stati64 */
2150#  define _stati64 stati64
2151# endif
2152
2153# include <EXTERN.h>
2154# include <perl.h>
2155# include <XSUB.h>
2156#endif
2157
2158/* values for vim_handle_signal() that are not a signal */
2159#define SIGNAL_BLOCK	-1
2160#define SIGNAL_UNBLOCK  -2
2161#if !defined(UNIX) && !defined(VMS) && !defined(OS2)
2162# define vim_handle_signal(x) 0
2163#endif
2164
2165/* flags for skip_vimgrep_pat() */
2166#define VGR_GLOBAL	1
2167#define VGR_NOJUMP	2
2168
2169/* behavior for bad character, "++bad=" argument */
2170#define BAD_REPLACE	'?'	/* replace it with '?' (default) */
2171#define BAD_KEEP	-1	/* leave it */
2172#define BAD_DROP	-2	/* erase it */
2173
2174/* last argument for do_source() */
2175#define DOSO_NONE	0
2176#define DOSO_VIMRC	1	/* loading vimrc file */
2177#define DOSO_GVIMRC	2	/* loading gvimrc file */
2178
2179/* flags for read_viminfo() and children */
2180#define VIF_WANT_INFO		1	/* load non-mark info */
2181#define VIF_WANT_MARKS		2	/* load file marks */
2182#define VIF_FORCEIT		4	/* overwrite info already read */
2183#define VIF_GET_OLDFILES	8	/* load v:oldfiles */
2184
2185/* flags for buf_freeall() */
2186#define BFA_DEL		1	/* buffer is going to be deleted */
2187#define BFA_WIPE	2	/* buffer is going to be wiped out */
2188#define BFA_KEEP_UNDO	4	/* do not free undo information */
2189
2190/* direction for nv_mousescroll() and ins_mousescroll() */
2191#define MSCR_DOWN	0	/* DOWN must be FALSE */
2192#define MSCR_UP		1
2193#define MSCR_LEFT	-1
2194#define MSCR_RIGHT	-2
2195
2196#endif /* VIM__H */
2197