blob: 488f2708438aead6bb9e63e737d50295778b9287 [file] [log] [blame]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001/* 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
Bram Moolenaara06ecab2016-07-16 14:47:36 +020012/* use fastcall for Borland, when compiling for Win32 */
Bram Moolenaar071d4272004-06-13 20:20:40 +000013#if defined(__BORLANDC__) && defined(WIN32) && !defined(DEBUG)
14#if defined(FEAT_PERL) || \
15 defined(FEAT_PYTHON) || \
Bram Moolenaarbd5e15f2010-07-17 21:19:38 +020016 defined(FEAT_PYTHON3) || \
Bram Moolenaar071d4272004-06-13 20:20:40 +000017 defined(FEAT_RUBY) || \
18 defined(FEAT_TCL) || \
Bram Moolenaar325b7a22004-07-05 15:58:32 +000019 defined(FEAT_MZSCHEME) || \
Bram Moolenaar071d4272004-06-13 20:20:40 +000020 defined(DYNAMIC_GETTEXT) || \
21 defined(DYNAMIC_ICONV) || \
22 defined(DYNAMIC_IME) || \
23 defined(XPM)
Bram Moolenaaraab21c32005-01-25 21:46:35 +000024 #pragma option -pc
Bram Moolenaar071d4272004-06-13 20:20:40 +000025# else
Bram Moolenaaraab21c32005-01-25 21:46:35 +000026 #pragma option -pr
Bram Moolenaar071d4272004-06-13 20:20:40 +000027# endif
28#endif
29
Bram Moolenaara06ecab2016-07-16 14:47:36 +020030#if defined(WIN32) || defined(_WIN64)
Bram Moolenaar9c263032010-12-17 18:06:06 +010031# include "vimio.h"
32#endif
33
Bram Moolenaar071d4272004-06-13 20:20:40 +000034/* ============ the header file puzzle (ca. 50-100 pieces) ========= */
35
36#ifdef HAVE_CONFIG_H /* GNU autoconf (or something else) was here */
37# include "auto/config.h"
38# define HAVE_PATHDEF
39
40/*
Bram Moolenaarc1762cc2007-05-10 16:56:30 +000041 * Check if configure correctly managed to find sizeof(int). If this failed,
Bram Moolenaar071d4272004-06-13 20:20:40 +000042 * it becomes zero. This is likely a problem of not being able to run the
43 * test program. Other items from configure may also be wrong then!
44 */
Bram Moolenaara2aa31a2014-02-23 22:52:40 +010045# if (VIM_SIZEOF_INT == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +000046 Error: configure did not run properly. Check auto/config.log.
47# endif
48
49/*
Bram Moolenaarc1762cc2007-05-10 16:56:30 +000050 * Cygwin may have fchdir() in a newer release, but in most versions it
Bram Moolenaar071d4272004-06-13 20:20:40 +000051 * doesn't work well and avoiding it keeps the binary backward compatible.
52 */
53# if defined(__CYGWIN32__) && defined(HAVE_FCHDIR)
54# undef HAVE_FCHDIR
55# endif
Bram Moolenaarfa7584c2010-05-19 21:57:45 +020056
57/* We may need to define the uint32_t on non-Unix system, but using the same
58 * identifier causes conflicts. Therefore use UINT32_T. */
Bram Moolenaar7db5fc82010-05-24 11:59:29 +020059# define UINT32_TYPEDEF uint32_t
Bram Moolenaarfa7584c2010-05-19 21:57:45 +020060#endif
61
Bram Moolenaar7db5fc82010-05-24 11:59:29 +020062#if !defined(UINT32_TYPEDEF)
Bram Moolenaarfa7584c2010-05-19 21:57:45 +020063# if defined(uint32_t) /* this doesn't catch typedefs, unfortunately */
Bram Moolenaar7db5fc82010-05-24 11:59:29 +020064# define UINT32_TYPEDEF uint32_t
Bram Moolenaarfa7584c2010-05-19 21:57:45 +020065# else
66 /* Fall back to assuming unsigned int is 32 bit. If this is wrong then the
67 * test in blowfish.c will fail. */
Bram Moolenaar7db5fc82010-05-24 11:59:29 +020068# define UINT32_TYPEDEF unsigned int
Bram Moolenaarfa7584c2010-05-19 21:57:45 +020069# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +000070#endif
71
Bram Moolenaar311d9822007-02-27 15:48:28 +000072/* user ID of root is usually zero, but not for everybody */
73#ifdef __TANDEM
Bram Moolenaar25153e12010-02-24 14:47:08 +010074# ifndef _TANDEM_SOURCE
75# define _TANDEM_SOURCE
76# endif
Bram Moolenaar311d9822007-02-27 15:48:28 +000077# include <floss.h>
78# define ROOT_UID 65535
Bram Moolenaar03305f32014-03-24 19:44:09 +010079# define OLDXAW
80# if (_TANDEM_ARCH_ == 2 && __H_Series_RVU >= 621)
81# define SA_ONSTACK_COMPATIBILITY
82# endif
Bram Moolenaar311d9822007-02-27 15:48:28 +000083#else
84# define ROOT_UID 0
85#endif
86
Bram Moolenaar071d4272004-06-13 20:20:40 +000087/*
88 * MACOS_CLASSIC compiling for MacOS prior to MacOS X
89 * MACOS_X_UNIX compiling for MacOS X (using os_unix.c)
Bram Moolenaarcef9dcc2005-12-06 19:50:41 +000090 * MACOS_X compiling for MacOS X (using os_unix.c)
Bram Moolenaar071d4272004-06-13 20:20:40 +000091 * MACOS compiling for either one
92 */
93#if defined(macintosh) && !defined(MACOS_CLASSIC)
Bram Moolenaar34162142007-05-12 13:12:19 +000094# define MACOS_CLASSIC
Bram Moolenaar071d4272004-06-13 20:20:40 +000095#endif
96#if defined(MACOS_X_UNIX)
97# define MACOS_X
98# ifndef HAVE_CONFIG_H
99# define UNIX
100# endif
Bram Moolenaar164fca32010-07-14 13:58:07 +0200101# ifndef FEAT_CLIPBOARD
102# define FEAT_CLIPBOARD
Bram Moolenaar3437b912013-07-03 19:52:53 +0200103# if defined(FEAT_SMALL) && !defined(FEAT_MOUSE)
104# define FEAT_MOUSE
105# endif
Bram Moolenaar164fca32010-07-14 13:58:07 +0200106# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000107#endif
108#if defined(MACOS_X) || defined(MACOS_CLASSIC)
Bram Moolenaar08ed30e2013-01-17 17:17:26 +0100109# define MACOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000110#endif
111#if defined(MACOS_X) && defined(MACOS_CLASSIC)
112 Error: To compile for both MACOS X and Classic use a Classic Carbon
113#endif
114/* Unless made through the Makefile enforce GUI on Mac */
115#if defined(MACOS) && !defined(HAVE_CONFIG_H)
116# define FEAT_GUI_MAC
117#endif
118
Bram Moolenaar071d4272004-06-13 20:20:40 +0000119#if defined(FEAT_GUI_MOTIF) \
120 || defined(FEAT_GUI_GTK) \
121 || defined(FEAT_GUI_ATHENA) \
122 || defined(FEAT_GUI_MAC) \
123 || defined(FEAT_GUI_W32) \
Bram Moolenaarcef9dcc2005-12-06 19:50:41 +0000124 || defined(FEAT_GUI_PHOTON)
Bram Moolenaar9a4d7fd2011-06-13 02:04:00 +0200125# define FEAT_GUI_ENABLED /* also defined with NO_X11_INCLUDES */
Bram Moolenaarab79bcb2004-07-18 21:34:53 +0000126# if !defined(FEAT_GUI) && !defined(NO_X11_INCLUDES)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000127# define FEAT_GUI
128# endif
129#endif
130
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +0200131/* Check support for rendering options */
132#ifdef FEAT_GUI
133# if defined(FEAT_DIRECTX)
134# define FEAT_RENDER_OPTIONS
135# endif
136#endif
137
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000138/* Visual Studio 2005 has 'deprecated' many of the standard CRT functions */
139#if _MSC_VER >= 1400
140# define _CRT_SECURE_NO_DEPRECATE
141# define _CRT_NONSTDC_NO_DEPRECATE
142#endif
143
Bram Moolenaare89ff042016-02-20 22:17:05 +0100144#if defined(FEAT_GUI_W32)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145# define FEAT_GUI_MSWIN
146#endif
Bram Moolenaarcf7164a2016-02-20 13:55:06 +0100147#if defined(WIN32) || defined(_WIN64)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000148# define MSWIN
149#endif
150/* Practically everything is common to both Win32 and Win64 */
151#if defined(WIN32) || defined(_WIN64)
152# define WIN3264
153#endif
154
155/*
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100156 * VIM_SIZEOF_INT is used in feature.h, and the system-specific included files
157 * need items from feature.h. Therefore define VIM_SIZEOF_INT here.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000158 */
159#ifdef WIN3264
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100160# define VIM_SIZEOF_INT 4
Bram Moolenaar071d4272004-06-13 20:20:40 +0000161#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000162
163#ifdef AMIGA
164 /* Be conservative about sizeof(int). It could be 4 too. */
165# ifndef FEAT_GUI_GTK /* avoid problems when generating prototypes */
166# ifdef __GNUC__
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100167# define VIM_SIZEOF_INT 4
Bram Moolenaar071d4272004-06-13 20:20:40 +0000168# else
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100169# define VIM_SIZEOF_INT 2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000170# endif
171# endif
172#endif
173#ifdef MACOS
Bram Moolenaar2a0449d2006-02-20 21:27:21 +0000174# if defined(__POWERPC__) || defined(MACOS_X) || defined(__fourbyteints__) \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000175 || defined(__MRC__) || defined(__SC__) || defined(__APPLE_CC__)/* MPW Compilers */
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100176# define VIM_SIZEOF_INT 4
Bram Moolenaar071d4272004-06-13 20:20:40 +0000177# else
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100178# define VIM_SIZEOF_INT 2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000179# endif
180#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000181
182
183#include "feature.h" /* #defines for optionals and features */
184
185/* +x11 is only enabled when it's both available and wanted. */
186#if defined(HAVE_X11) && defined(WANT_X11)
187# define FEAT_X11
188#endif
189
Bram Moolenaarab79bcb2004-07-18 21:34:53 +0000190#ifdef NO_X11_INCLUDES
Bram Moolenaar423f9722010-10-10 17:08:43 +0200191 /* In os_mac_conv.c and os_macosx.m NO_X11_INCLUDES is defined to avoid
192 * X11 headers. Disable all X11 related things to avoid conflicts. */
Bram Moolenaarab79bcb2004-07-18 21:34:53 +0000193# ifdef FEAT_X11
194# undef FEAT_X11
195# endif
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000196# ifdef FEAT_GUI_X11
197# undef FEAT_GUI_X11
198# endif
Bram Moolenaarab79bcb2004-07-18 21:34:53 +0000199# ifdef FEAT_XCLIPBOARD
200# undef FEAT_XCLIPBOARD
201# endif
202# ifdef FEAT_GUI_MOTIF
203# undef FEAT_GUI_MOTIF
204# endif
205# ifdef FEAT_GUI_ATHENA
206# undef FEAT_GUI_ATHENA
207# endif
208# ifdef FEAT_GUI_GTK
209# undef FEAT_GUI_GTK
210# endif
211# ifdef FEAT_BEVAL_TIP
212# undef FEAT_BEVAL_TIP
213# endif
214# ifdef FEAT_XIM
215# undef FEAT_XIM
216# endif
217# ifdef FEAT_CLIENTSERVER
218# undef FEAT_CLIENTSERVER
219# endif
220#endif
221
Bram Moolenaardb003512006-03-15 22:48:35 +0000222/* The Mac conversion stuff doesn't work under X11. */
223#if defined(FEAT_MBYTE) && defined(MACOS_X)
224# define MACOS_CONVERT
225#endif
226
Bram Moolenaar071d4272004-06-13 20:20:40 +0000227/* Can't use "PACKAGE" here, conflicts with a Perl include file. */
228#ifndef VIMPACKAGE
229# define VIMPACKAGE "vim"
230#endif
231
232/*
233 * Find out if function definitions should include argument types
234 */
235#ifdef AZTEC_C
236# include <functions.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +0000237#endif
238
239#ifdef SASC
240# include <clib/exec_protos.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +0000241#endif
242
243#ifdef _DCC
244# include <clib/exec_protos.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +0000245#endif
246
247#ifdef __BEOS__
248# include "os_beos.h"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000249#endif
250
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200251#if (defined(UNIX) || defined(VMS)) \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000252 && (!defined(MACOS_X) || defined(HAVE_CONFIG_H))
253# include "os_unix.h" /* bring lots of system header files */
254#endif
255
Bram Moolenaar0c094b92009-05-14 20:20:33 +0000256/* Mark unused function arguments with UNUSED, so that gcc -Wunused-parameter
257 * can be used to check for mistakes. */
258#ifdef HAVE_ATTRIBUTE_UNUSED
259# define UNUSED __attribute__((unused))
260#else
261# define UNUSED
262#endif
263
Bram Moolenaar843ee412004-06-30 16:16:41 +0000264/* if we're compiling in C++ (currently only KVim), the system
265 * headers must have the correct prototypes or nothing will build.
266 * conversely, our prototypes might clash due to throw() specifiers and
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000267 * cause compilation failures even though the headers are correct. For
Bram Moolenaar843ee412004-06-30 16:16:41 +0000268 * a concrete example, gcc-3.2 enforces exception specifications, and
269 * glibc-2.2.5 has them in their system headers.
270 */
271#if !defined(__cplusplus) && defined(UNIX) \
272 && !defined(MACOS_X) /* MACOS_X doesn't yet support osdef.h */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000273# include "auto/osdef.h" /* bring missing declarations in */
274#endif
275
Bram Moolenaar071d4272004-06-13 20:20:40 +0000276#ifdef AMIGA
277# include "os_amiga.h"
278#endif
279
Bram Moolenaar071d4272004-06-13 20:20:40 +0000280#ifdef WIN3264
281# include "os_win32.h"
282#endif
283
284#ifdef __MINT__
285# include "os_mint.h"
286#endif
287
288#if defined(MACOS)
289# if defined(__MRC__) || defined(__SC__) /* MPW Compilers */
290# define HAVE_SETENV
291# endif
292# include "os_mac.h"
293#endif
294
Bram Moolenaar071d4272004-06-13 20:20:40 +0000295#ifdef __QNX__
296# include "os_qnx.h"
297#endif
298
299#ifdef FEAT_SUN_WORKSHOP
300# include "workshop.h"
301#endif
302
303#ifdef X_LOCALE
304# include <X11/Xlocale.h>
305#else
306# ifdef HAVE_LOCALE_H
307# include <locale.h>
308# endif
309#endif
310
311/*
312 * Maximum length of a path (for non-unix systems) Make it a bit long, to stay
313 * on the safe side. But not too long to put on the stack.
314 */
315#ifndef MAXPATHL
316# ifdef MAXPATHLEN
317# define MAXPATHL MAXPATHLEN
318# else
319# define MAXPATHL 256
320# endif
321#endif
322#ifdef BACKSLASH_IN_FILENAME
Bram Moolenaaraebaf892008-05-28 14:49:58 +0000323# define PATH_ESC_CHARS ((char_u *)" \t\n*?[{`%#'\"|!<")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000324#else
Bram Moolenaar03cd93a2008-11-20 09:27:32 +0000325# ifdef VMS
326 /* VMS allows a lot of characters in the file name */
327# define PATH_ESC_CHARS ((char_u *)" \t\n*?{`\\%#'\"|!")
328# define SHELL_ESC_CHARS ((char_u *)" \t\n*?{`\\%#'|!()&")
329# else
330# define PATH_ESC_CHARS ((char_u *)" \t\n*?[{`$\\%#'\"|!<")
331# define SHELL_ESC_CHARS ((char_u *)" \t\n*?[{`$\\%#'\"|!<>();&")
332# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000333#endif
334
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100335/* length of a buffer to store a number in ASCII (64 bits binary + NUL) */
336#define NUMBUFLEN 65
337
338/* flags for vim_str2nr() */
339#define STR2NR_BIN 1
340#define STR2NR_OCT 2
341#define STR2NR_HEX 4
342#define STR2NR_ALL (STR2NR_BIN + STR2NR_OCT + STR2NR_HEX)
343#define STR2NR_FORCE 8 /* only when ONE of the above is used */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000344
345/*
346 * Shorthand for unsigned variables. Many systems, but not all, have u_char
347 * already defined, so we use char_u to avoid trouble.
348 */
349typedef unsigned char char_u;
350typedef unsigned short short_u;
351typedef unsigned int int_u;
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000352/* Make sure long_u is big enough to hold a pointer.
Bram Moolenaare6a91fd2008-07-24 18:51:11 +0000353 * On Win64, longs are 32 bits and pointers are 64 bits.
354 * For printf() and scanf(), we need to take care of long_u specifically. */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000355#ifdef _WIN64
Bram Moolenaar55d5c032010-07-17 23:52:29 +0200356typedef unsigned __int64 long_u;
357typedef __int64 long_i;
Bram Moolenaarcb4cef22008-03-16 15:04:34 +0000358# define SCANF_HEX_LONG_U "%Ix"
359# define SCANF_DECIMAL_LONG_U "%Iu"
360# define PRINTF_HEX_LONG_U "0x%Ix"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000361#else
Bram Moolenaare6a91fd2008-07-24 18:51:11 +0000362 /* Microsoft-specific. The __w64 keyword should be specified on any typedefs
363 * that change size between 32-bit and 64-bit platforms. For any such type,
364 * __w64 should appear only on the 32-bit definition of the typedef.
365 * Define __w64 as an empty token for everything but MSVC 7.x or later.
366 */
367# if !defined(_MSC_VER) || (_MSC_VER < 1300)
Bram Moolenaar03cd93a2008-11-20 09:27:32 +0000368# define __w64
Bram Moolenaare6a91fd2008-07-24 18:51:11 +0000369# endif
370typedef unsigned long __w64 long_u;
371typedef long __w64 long_i;
Bram Moolenaarcb4cef22008-03-16 15:04:34 +0000372# define SCANF_HEX_LONG_U "%lx"
373# define SCANF_DECIMAL_LONG_U "%lu"
374# define PRINTF_HEX_LONG_U "0x%lx"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000375#endif
Bram Moolenaarcb4cef22008-03-16 15:04:34 +0000376#define PRINTF_DECIMAL_LONG_U SCANF_DECIMAL_LONG_U
Bram Moolenaar071d4272004-06-13 20:20:40 +0000377
378/*
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100379 * Only systems which use configure will have SIZEOF_OFF_T and VIM_SIZEOF_LONG
Bram Moolenaar914703b2010-05-31 21:59:46 +0200380 * defined, which is ok since those are the same systems which can have
381 * varying sizes for off_t. The other systems will continue to use "%ld" to
382 * print off_t since off_t is simply a typedef to long for them.
383 */
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100384#if defined(SIZEOF_OFF_T) && (SIZEOF_OFF_T > VIM_SIZEOF_LONG)
Bram Moolenaar914703b2010-05-31 21:59:46 +0200385# define LONG_LONG_OFF_T
386#endif
387
388/*
Bram Moolenaar8767f522016-07-01 17:17:39 +0200389 * We use 64-bit file functions here, if available. E.g. ftello() returns
390 * off_t instead of long, which helps if long is 32 bit and off_t is 64 bit.
391 * We assume that when fseeko() is available then ftello() is too.
392 * Note that Windows has different function names.
393 */
394#if (defined(_MSC_VER) && (_MSC_VER >= 1300)) || defined(__MINGW32__)
395typedef __int64 off_T;
396# ifdef __MINGW32__
397# define vim_lseek lseek64
398# define vim_fseek fseeko64
399# define vim_ftell ftello64
400# else
401# define vim_lseek _lseeki64
402# define vim_fseek _fseeki64
403# define vim_ftell _ftelli64
404# endif
405#else
406typedef off_t off_T;
407# ifdef HAVE_FSEEKO
408# define vim_lseek lseek
409# define vim_ftell ftello
410# define vim_fseek fseeko
411# else
412# define vim_lseek lseek
413# define vim_ftell ftell
414# define vim_fseek(a, b, c) fseek(a, (long)b, c)
415# endif
416#endif
417
418/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000419 * The characters and attributes cached for the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000420 */
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000421typedef char_u schar_T;
Bram Moolenaar3918c952005-03-15 22:34:55 +0000422#ifdef FEAT_SYN_HL
423typedef unsigned short sattr_T;
424# define MAX_TYPENR 65535
425#else
426typedef unsigned char sattr_T;
427# define MAX_TYPENR 255
428#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000429
430/*
431 * The u8char_T can hold one decoded UTF-8 character.
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000432 * We normally use 32 bits now, since some Asian characters don't fit in 16
433 * bits. u8char_T is only used for displaying, it could be 16 bits to save
434 * memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000435 */
436#ifdef FEAT_MBYTE
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000437# ifdef UNICODE16
438typedef unsigned short u8char_T; /* short should be 16 bits */
439# else
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100440# if VIM_SIZEOF_INT >= 4
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000441typedef unsigned int u8char_T; /* int is 32 bits */
442# else
443typedef unsigned long u8char_T; /* long should be 32 bits or more */
444# endif
445# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000446#endif
447
448#ifndef UNIX /* For Unix this is included in os_unix.h */
449# include <stdio.h>
450# include <ctype.h>
451#endif
452
453#include "ascii.h"
454#include "keymap.h"
455#include "term.h"
456#include "macros.h"
457
458#ifdef LATTICE
459# include <sys/types.h>
460# include <sys/stat.h>
461#endif
462#ifdef _DCC
463# include <sys/stat.h>
464#endif
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100465#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000466# include <sys/stat.h>
467#endif
468
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100469#if defined(HAVE_ERRNO_H) \
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200470 || defined(WIN32) || defined(_WIN64)
Bram Moolenaarb57aa922010-12-17 20:24:01 +0100471# include <errno.h>
472#endif
473
Bram Moolenaar071d4272004-06-13 20:20:40 +0000474/*
475 * Allow other (non-unix) systems to configure themselves now
476 * These are also in os_unix.h, because osdef.sh needs them there.
477 */
478#ifndef UNIX
479/* Note: Some systems need both string.h and strings.h (Savage). If the
480 * system can't handle this, define NO_STRINGS_WITH_STRING_H. */
481# ifdef HAVE_STRING_H
482# include <string.h>
483# endif
484# if defined(HAVE_STRINGS_H) && !defined(NO_STRINGS_WITH_STRING_H)
Bram Moolenaar08ed30e2013-01-17 17:17:26 +0100485# include <strings.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +0000486# endif
487# ifdef HAVE_STAT_H
488# include <stat.h>
489# endif
490# ifdef HAVE_STDLIB_H
491# include <stdlib.h>
492# endif
493#endif /* NON-UNIX */
494
495#include <assert.h>
496
Bram Moolenaarfa7584c2010-05-19 21:57:45 +0200497#ifdef HAVE_STDINT_H
498# include <stdint.h>
499#endif
500#ifdef HAVE_INTTYPES_H
501# include <inttypes.h>
502#endif
Bram Moolenaar8fef2ad2005-04-23 20:42:23 +0000503#ifdef HAVE_WCTYPE_H
504# include <wctype.h>
505#endif
Bram Moolenaarba4ef272016-01-30 21:48:49 +0100506#include <stdarg.h>
Bram Moolenaar8fef2ad2005-04-23 20:42:23 +0000507
Bram Moolenaar84026842016-07-17 20:37:43 +0200508/* for offsetof() */
509#include <stddef.h>
510
Bram Moolenaar08ed30e2013-01-17 17:17:26 +0100511#if defined(HAVE_SYS_SELECT_H) && \
Bram Moolenaar581f6dc2010-03-10 16:12:48 +0100512 (!defined(HAVE_SYS_TIME_H) || defined(SYS_SELECT_WITH_SYS_TIME))
Bram Moolenaar08ed30e2013-01-17 17:17:26 +0100513# include <sys/select.h>
514#endif
Bram Moolenaar581f6dc2010-03-10 16:12:48 +0100515
Bram Moolenaar08ed30e2013-01-17 17:17:26 +0100516#ifndef HAVE_SELECT
517# ifdef HAVE_SYS_POLL_H
518# include <sys/poll.h>
Bram Moolenaara8343c12016-02-04 22:09:48 +0100519# elif defined(WIN32)
Bram Moolenaarf12d9832016-01-29 21:11:25 +0100520# define HAVE_SELECT
Bram Moolenaar08ed30e2013-01-17 17:17:26 +0100521# else
522# ifdef HAVE_POLL_H
523# include <poll.h>
Bram Moolenaar581f6dc2010-03-10 16:12:48 +0100524# endif
525# endif
Bram Moolenaar08ed30e2013-01-17 17:17:26 +0100526#endif
Bram Moolenaar581f6dc2010-03-10 16:12:48 +0100527
Bram Moolenaar071d4272004-06-13 20:20:40 +0000528/* ================ end of the header file puzzle =============== */
529
530/*
531 * For dynamically loaded imm library. Currently, only for Win32.
532 */
533#ifdef DYNAMIC_IME
534# ifndef FEAT_MBYTE_IME
535# define FEAT_MBYTE_IME
536# endif
537#endif
538
539/*
540 * Check input method control.
541 */
Bram Moolenaar1b60e502008-03-12 13:40:54 +0000542#if defined(FEAT_XIM) \
543 || (defined(FEAT_GUI) && (defined(FEAT_MBYTE_IME) || defined(GLOBAL_IME))) \
Bram Moolenaar4c4f7102008-03-15 12:12:59 +0000544 || (defined(FEAT_GUI_MAC) && defined(FEAT_MBYTE))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000545# define USE_IM_CONTROL
546#endif
547
548/*
549 * For dynamically loaded gettext library. Currently, only for Win32.
550 */
551#ifdef DYNAMIC_GETTEXT
552# ifndef FEAT_GETTEXT
553# define FEAT_GETTEXT
554# endif
555/* These are in os_win32.c */
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000556extern char *(*dyn_libintl_gettext)(const char *msgid);
557extern char *(*dyn_libintl_bindtextdomain)(const char *domainname, const char *dirname);
558extern char *(*dyn_libintl_bind_textdomain_codeset)(const char *domainname, const char *codeset);
559extern char *(*dyn_libintl_textdomain)(const char *domainname);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000560#endif
561
562
563/*
564 * The _() stuff is for using gettext(). It is a no-op when libintl.h is not
565 * found or the +multilang feature is disabled.
566 */
567#ifdef FEAT_GETTEXT
568# ifdef DYNAMIC_GETTEXT
569# define _(x) (*dyn_libintl_gettext)((char *)(x))
570# define N_(x) x
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000571# define bindtextdomain(domain, dir) (*dyn_libintl_bindtextdomain)((domain), (dir))
572# define bind_textdomain_codeset(domain, codeset) (*dyn_libintl_bind_textdomain_codeset)((domain), (codeset))
573# if !defined(HAVE_BIND_TEXTDOMAIN_CODESET)
574# define HAVE_BIND_TEXTDOMAIN_CODESET 1
575# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576# define textdomain(domain) (*dyn_libintl_textdomain)(domain)
577# else
578# include <libintl.h>
579# define _(x) gettext((char *)(x))
580# ifdef gettext_noop
581# define N_(x) gettext_noop(x)
582# else
583# define N_(x) x
584# endif
585# endif
586#else
587# define _(x) ((char *)(x))
588# define N_(x) x
589# ifdef bindtextdomain
590# undef bindtextdomain
591# endif
592# define bindtextdomain(x, y) /* empty */
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000593# ifdef bind_textdomain_codeset
594# undef bind_textdomain_codeset
595# endif
596# define bind_textdomain_codeset(x, y) /* empty */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000597# ifdef textdomain
598# undef textdomain
599# endif
600# define textdomain(x) /* empty */
601#endif
602
603/*
604 * flags for update_screen()
605 * The higher the value, the higher the priority
606 */
607#define VALID 10 /* buffer not changed, or changes marked
608 with b_mod_* */
609#define INVERTED 20 /* redisplay inverted part that changed */
610#define INVERTED_ALL 25 /* redisplay whole inverted part */
611#define REDRAW_TOP 30 /* display first w_upd_rows screen lines */
Bram Moolenaarf71a3db2006-03-12 21:50:18 +0000612#define SOME_VALID 35 /* like NOT_VALID but may scroll */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000613#define NOT_VALID 40 /* buffer needs complete redraw */
614#define CLEAR 50 /* screen messed up, clear it */
615
616/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000617 * Flags for w_valid.
618 * These are set when something in a window structure becomes invalid, except
619 * when the cursor is moved. Call check_cursor_moved() before testing one of
620 * the flags.
621 * These are reset when that thing has been updated and is valid again.
622 *
623 * Every function that invalidates one of these must call one of the
624 * invalidate_* functions.
625 *
626 * w_valid is supposed to be used only in screen.c. From other files, use the
627 * functions that set or reset the flags.
628 *
629 * VALID_BOTLINE VALID_BOTLINE_AP
630 * on on w_botline valid
631 * off on w_botline approximated
632 * off off w_botline not valid
633 * on off not possible
634 */
635#define VALID_WROW 0x01 /* w_wrow (window row) is valid */
636#define VALID_WCOL 0x02 /* w_wcol (window col) is valid */
637#define VALID_VIRTCOL 0x04 /* w_virtcol (file col) is valid */
638#define VALID_CHEIGHT 0x08 /* w_cline_height and w_cline_folded valid */
639#define VALID_CROW 0x10 /* w_cline_row is valid */
640#define VALID_BOTLINE 0x20 /* w_botine and w_empty_rows are valid */
641#define VALID_BOTLINE_AP 0x40 /* w_botine is approximated */
642#define VALID_TOPLINE 0x80 /* w_topline is valid (for cursor position) */
643
644/*
645 * Terminal highlighting attribute bits.
Bram Moolenaar42b4dda2010-03-02 15:56:05 +0100646 * Attributes above HL_ALL are used for syntax highlighting.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000647 */
648#define HL_NORMAL 0x00
649#define HL_INVERSE 0x01
650#define HL_BOLD 0x02
651#define HL_ITALIC 0x04
652#define HL_UNDERLINE 0x08
Bram Moolenaar3918c952005-03-15 22:34:55 +0000653#define HL_UNDERCURL 0x10
654#define HL_STANDOUT 0x20
655#define HL_ALL 0x3f
Bram Moolenaar071d4272004-06-13 20:20:40 +0000656
657/* special attribute addition: Put message in history */
658#define MSG_HIST 0x1000
659
660/*
661 * values for State
662 *
663 * The lower bits up to 0x20 are used to distinguish normal/visual/op_pending
664 * and cmdline/insert+replace mode. This is used for mapping. If none of
665 * these bits are set, no mapping is done.
666 * The upper bits are used to distinguish between other states.
667 */
668#define NORMAL 0x01 /* Normal mode, command expected */
669#define VISUAL 0x02 /* Visual mode - use get_real_state() */
670#define OP_PENDING 0x04 /* Normal mode, operator is pending - use
671 get_real_state() */
672#define CMDLINE 0x08 /* Editing command line */
673#define INSERT 0x10 /* Insert mode */
674#define LANGMAP 0x20 /* Language mapping, can be combined with
675 INSERT and CMDLINE */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000676
677#define REPLACE_FLAG 0x40 /* Replace mode flag */
678#define REPLACE (REPLACE_FLAG + INSERT)
679#ifdef FEAT_VREPLACE
680# define VREPLACE_FLAG 0x80 /* Virtual-replace mode flag */
681# define VREPLACE (REPLACE_FLAG + VREPLACE_FLAG + INSERT)
682#endif
683#define LREPLACE (REPLACE_FLAG + LANGMAP)
684
685#define NORMAL_BUSY (0x100 + NORMAL) /* Normal mode, busy with a command */
686#define HITRETURN (0x200 + NORMAL) /* waiting for return or command */
687#define ASKMORE 0x300 /* Asking if you want --more-- */
688#define SETWSIZE 0x400 /* window size has changed */
689#define ABBREV 0x500 /* abbreviation instead of mapping */
690#define EXTERNCMD 0x600 /* executing an external command */
691#define SHOWMATCH (0x700 + INSERT) /* show matching paren */
692#define CONFIRM 0x800 /* ":confirm" prompt */
Bram Moolenaar371d5402006-03-20 21:47:49 +0000693#define SELECTMODE 0x1000 /* Select mode, only for mappings */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694
Bram Moolenaar149667a2006-06-23 14:33:23 +0000695#define MAP_ALL_MODES (0x3f | SELECTMODE) /* all mode bits used for
696 * mapping */
697
Bram Moolenaar071d4272004-06-13 20:20:40 +0000698/* directions */
699#define FORWARD 1
700#define BACKWARD (-1)
701#define FORWARD_FILE 3
702#define BACKWARD_FILE (-3)
703
704/* return values for functions */
705#if !(defined(OK) && (OK == 1))
706/* OK already defined to 1 in MacOS X curses, skip this */
707# define OK 1
708#endif
709#define FAIL 0
Bram Moolenaarfd371682005-01-14 21:42:54 +0000710#define NOTDONE 2 /* not OK or FAIL but skipped */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000711
712/* flags for b_flags */
713#define BF_RECOVERED 0x01 /* buffer has been recovered */
714#define BF_CHECK_RO 0x02 /* need to check readonly when loading file
715 into buffer (set by ":e", may be reset by
716 ":buf" */
717#define BF_NEVERLOADED 0x04 /* file has never been loaded into buffer,
718 many variables still need to be set */
719#define BF_NOTEDITED 0x08 /* Set when file name is changed after
720 starting to edit, reset when file is
721 written out. */
722#define BF_NEW 0x10 /* file didn't exist when editing started */
723#define BF_NEW_W 0x20 /* Warned for BF_NEW and file created */
724#define BF_READERR 0x40 /* got errors while reading the file */
Bram Moolenaar81695252004-12-29 20:58:21 +0000725#define BF_DUMMY 0x80 /* dummy buffer, only used internally */
Bram Moolenaar4399ef42005-02-12 14:29:27 +0000726#define BF_PRESERVED 0x100 /* ":preserve" was used */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000727
728/* Mask to check for flags that prevent normal writing */
729#define BF_WRITE_MASK (BF_NOTEDITED + BF_NEW + BF_READERR)
730
731/*
732 * values for xp_context when doing command line completion
733 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000734#define EXPAND_UNSUCCESSFUL (-2)
735#define EXPAND_OK (-1)
736#define EXPAND_NOTHING 0
737#define EXPAND_COMMANDS 1
738#define EXPAND_FILES 2
739#define EXPAND_DIRECTORIES 3
740#define EXPAND_SETTINGS 4
741#define EXPAND_BOOL_SETTINGS 5
742#define EXPAND_TAGS 6
743#define EXPAND_OLD_SETTING 7
744#define EXPAND_HELP 8
745#define EXPAND_BUFFERS 9
746#define EXPAND_EVENTS 10
747#define EXPAND_MENUS 11
748#define EXPAND_SYNTAX 12
749#define EXPAND_HIGHLIGHT 13
750#define EXPAND_AUGROUP 14
751#define EXPAND_USER_VARS 15
752#define EXPAND_MAPPINGS 16
753#define EXPAND_TAGS_LISTFILES 17
754#define EXPAND_FUNCTIONS 18
755#define EXPAND_USER_FUNC 19
756#define EXPAND_EXPRESSION 20
757#define EXPAND_MENUNAMES 21
758#define EXPAND_USER_COMMANDS 22
759#define EXPAND_USER_CMD_FLAGS 23
760#define EXPAND_USER_NARGS 24
761#define EXPAND_USER_COMPLETE 25
762#define EXPAND_ENV_VARS 26
763#define EXPAND_LANGUAGE 27
764#define EXPAND_COLORS 28
765#define EXPAND_COMPILER 29
766#define EXPAND_USER_DEFINED 30
Bram Moolenaara466c992005-07-09 21:03:22 +0000767#define EXPAND_USER_LIST 31
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000768#define EXPAND_SHELLCMD 32
Bram Moolenaarf4580d82009-03-18 11:52:53 +0000769#define EXPAND_CSCOPE 33
Bram Moolenaar3c65e312009-04-29 16:47:23 +0000770#define EXPAND_SIGN 34
Bram Moolenaarf86f26c2010-02-03 15:14:22 +0100771#define EXPAND_PROFILE 35
Bram Moolenaar42b4dda2010-03-02 15:56:05 +0100772#define EXPAND_BEHAVE 36
Bram Moolenaar883f5d02010-06-21 06:24:34 +0200773#define EXPAND_FILETYPE 37
Bram Moolenaar1587a1e2010-07-29 20:59:59 +0200774#define EXPAND_FILES_IN_PATH 38
775#define EXPAND_OWNSYNTAX 39
Bram Moolenaar9b486ca2011-05-19 18:26:40 +0200776#define EXPAND_LOCALES 40
Bram Moolenaar5ae636b2012-04-30 18:48:53 +0200777#define EXPAND_HISTORY 41
Bram Moolenaar24305862012-08-15 14:05:05 +0200778#define EXPAND_USER 42
Bram Moolenaarcd9c4622013-06-08 15:24:48 +0200779#define EXPAND_SYNTIME 43
Bram Moolenaarf1d6ccf2014-12-08 04:16:44 +0100780#define EXPAND_USER_ADDR_TYPE 44
Bram Moolenaar35ca0e72016-03-05 17:41:49 +0100781#define EXPAND_PACKADD 45
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782
783/* Values for exmode_active (0 is no exmode) */
784#define EXMODE_NORMAL 1
785#define EXMODE_VIM 2
786
787/* Values for nextwild() and ExpandOne(). See ExpandOne() for meaning. */
788#define WILD_FREE 1
789#define WILD_EXPAND_FREE 2
790#define WILD_EXPAND_KEEP 3
791#define WILD_NEXT 4
792#define WILD_PREV 5
793#define WILD_ALL 6
794#define WILD_LONGEST 7
Bram Moolenaar146e9c32012-03-07 19:18:23 +0100795#define WILD_ALL_KEEP 8
Bram Moolenaar071d4272004-06-13 20:20:40 +0000796
Bram Moolenaara245bc72015-03-05 19:35:25 +0100797#define WILD_LIST_NOTFOUND 0x01
798#define WILD_HOME_REPLACE 0x02
799#define WILD_USE_NL 0x04
800#define WILD_NO_BEEP 0x08
801#define WILD_ADD_SLASH 0x10
802#define WILD_KEEP_ALL 0x20
803#define WILD_SILENT 0x40
804#define WILD_ESCAPE 0x80
805#define WILD_ICASE 0x100
806#define WILD_ALLLINKS 0x200
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807
808/* Flags for expand_wildcards() */
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000809#define EW_DIR 0x01 /* include directory names */
810#define EW_FILE 0x02 /* include file names */
811#define EW_NOTFOUND 0x04 /* include not found names */
812#define EW_ADDSLASH 0x08 /* append slash to directory name */
813#define EW_KEEPALL 0x10 /* keep all matches */
814#define EW_SILENT 0x20 /* don't print "1 returned" from shell */
815#define EW_EXEC 0x40 /* executable files */
Bram Moolenaarcc448b32010-07-14 16:52:17 +0200816#define EW_PATH 0x80 /* search in 'path' too */
Bram Moolenaar94950a92010-12-02 16:01:29 +0100817#define EW_ICASE 0x100 /* ignore case */
Bram Moolenaarb5609832011-07-20 15:04:58 +0200818#define EW_NOERROR 0x200 /* no error for bad regexp */
Bram Moolenaar0b573a52011-07-27 17:31:47 +0200819#define EW_NOTWILD 0x400 /* add match with literal name if exists */
Bram Moolenaare4df1642014-08-29 12:58:44 +0200820#define EW_KEEPDOLLAR 0x800 /* do not escape $, $var is expanded */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000821/* Note: mostly EW_NOTFOUND and EW_SILENT are mutually exclusive: EW_NOTFOUND
822 * is used when executing commands and EW_SILENT for interactive expanding. */
Bram Moolenaara245bc72015-03-05 19:35:25 +0100823#define EW_ALLLINKS 0x1000 /* also links not pointing to existing file */
Bram Moolenaarb5971142015-03-21 17:32:19 +0100824#define EW_SHELLCMD 0x2000 /* called from expand_shellcmd(), don't check
825 * if executable is in $PATH */
Bram Moolenaarb0967d52016-01-17 16:49:43 +0100826#define EW_DODOT 0x4000 /* also files starting with a dot */
Bram Moolenaar336bd622016-01-17 18:23:58 +0100827#define EW_EMPTYOK 0x8000 /* no matches is not an error */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000828
Bram Moolenaar4d0ec162008-02-20 11:24:52 +0000829/* Flags for find_file_*() functions. */
830#define FINDFILE_FILE 0 /* only files */
831#define FINDFILE_DIR 1 /* only directories */
832#define FINDFILE_BOTH 2 /* files and directories */
833
Bram Moolenaar44a2f922016-03-19 22:11:51 +0100834#ifdef FEAT_WINDOWS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835# define W_WINCOL(wp) (wp->w_wincol)
836# define W_WIDTH(wp) (wp->w_width)
837# define W_ENDCOL(wp) (wp->w_wincol + wp->w_width)
838# define W_VSEP_WIDTH(wp) (wp->w_vsep_width)
839#else
840# define W_WINCOL(wp) 0
841# define W_WIDTH(wp) Columns
842# define W_ENDCOL(wp) Columns
843# define W_VSEP_WIDTH(wp) 0
844#endif
845#ifdef FEAT_WINDOWS
846# define W_STATUS_HEIGHT(wp) (wp->w_status_height)
847# define W_WINROW(wp) (wp->w_winrow)
848#else
849# define W_STATUS_HEIGHT(wp) 0
850# define W_WINROW(wp) 0
851#endif
852
853#ifdef NO_EXPANDPATH
854# define gen_expand_wildcards mch_expand_wildcards
855#endif
856
857/* Values for the find_pattern_in_path() function args 'type' and 'action': */
858#define FIND_ANY 1
859#define FIND_DEFINE 2
860#define CHECK_PATH 3
861
862#define ACTION_SHOW 1
863#define ACTION_GOTO 2
864#define ACTION_SPLIT 3
865#define ACTION_SHOW_ALL 4
866#ifdef FEAT_INS_EXPAND
867# define ACTION_EXPAND 5
868#endif
869
870#ifdef FEAT_SYN_HL
871# define SST_MIN_ENTRIES 150 /* minimal size for state stack array */
Bram Moolenaare89ff042016-02-20 22:17:05 +0100872# define SST_MAX_ENTRIES 1000 /* maximal size for state stack array */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000873# define SST_FIX_STATES 7 /* size of sst_stack[]. */
874# define SST_DIST 16 /* normal distance between entries */
Bram Moolenaar860cae12010-06-05 23:22:07 +0200875# define SST_INVALID (synstate_T *)-1 /* invalid syn_state pointer */
876
877# define HL_CONTAINED 0x01 /* not used on toplevel */
878# define HL_TRANSP 0x02 /* has no highlighting */
879# define HL_ONELINE 0x04 /* match within one line only */
880# define HL_HAS_EOL 0x08 /* end pattern that matches with $ */
881# define HL_SYNC_HERE 0x10 /* sync point after this item (syncing only) */
882# define HL_SYNC_THERE 0x20 /* sync point at current line (syncing only) */
883# define HL_MATCH 0x40 /* use match ID instead of item ID */
884# define HL_SKIPNL 0x80 /* nextgroup can skip newlines */
885# define HL_SKIPWHITE 0x100 /* nextgroup can skip white space */
886# define HL_SKIPEMPTY 0x200 /* nextgroup can skip empty lines */
887# define HL_KEEPEND 0x400 /* end match always kept */
888# define HL_EXCLUDENL 0x800 /* exclude NL from match */
889# define HL_DISPLAY 0x1000 /* only used for displaying, not syncing */
890# define HL_FOLD 0x2000 /* define fold */
891# define HL_EXTEND 0x4000 /* ignore a keepend */
892# define HL_MATCHCONT 0x8000 /* match continued from previous line */
893# define HL_TRANS_CONT 0x10000 /* transparent item without contains arg */
894# define HL_CONCEAL 0x20000 /* can be concealed */
895# define HL_CONCEALENDS 0x40000 /* can be concealed */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000896#endif
897
898/* Values for 'options' argument in do_search() and searchit() */
899#define SEARCH_REV 0x01 /* go in reverse of previous dir. */
900#define SEARCH_ECHO 0x02 /* echo the search command and handle options */
901#define SEARCH_MSG 0x0c /* give messages (yes, it's not 0x04) */
902#define SEARCH_NFMSG 0x08 /* give all messages except not found */
903#define SEARCH_OPT 0x10 /* interpret optional flags */
904#define SEARCH_HIS 0x20 /* put search pattern in history */
905#define SEARCH_END 0x40 /* put cursor at end of match */
906#define SEARCH_NOOF 0x80 /* don't add offset to position */
907#define SEARCH_START 0x100 /* start search without col offset */
908#define SEARCH_MARK 0x200 /* set previous context mark */
909#define SEARCH_KEEP 0x400 /* keep previous search pattern */
910#define SEARCH_PEEK 0x800 /* peek for typed char, cancel search */
Bram Moolenaarad4d8a12015-12-28 19:20:36 +0100911#define SEARCH_COL 0x1000 /* start at specified column instead of zero */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000912
913/* Values for find_ident_under_cursor() */
914#define FIND_IDENT 1 /* find identifier (word) */
915#define FIND_STRING 2 /* find any string (WORD) */
916#define FIND_EVAL 4 /* include "->", "[]" and "." */
917
918/* Values for file_name_in_line() */
919#define FNAME_MESS 1 /* give error message */
920#define FNAME_EXP 2 /* expand to path */
921#define FNAME_HYP 4 /* check for hypertext link */
922#define FNAME_INCL 8 /* apply 'includeexpr' */
923#define FNAME_REL 16 /* ".." and "./" are relative to the (current)
924 file instead of the current directory */
Bram Moolenaard45c07a2015-02-27 17:19:10 +0100925#define FNAME_UNESC 32 /* remove backslashes used for escaping */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926
927/* Values for buflist_getfile() */
928#define GETF_SETMARK 0x01 /* set pcmark before jumping */
929#define GETF_ALT 0x02 /* jumping to alternate file (not buf num) */
930#define GETF_SWITCH 0x04 /* respect 'switchbuf' settings when jumping */
931
932/* Values for buflist_new() flags */
Bram Moolenaarb127cfd2016-05-29 16:24:50 +0200933#define BLN_CURBUF 1 /* may re-use curbuf for new buffer */
934#define BLN_LISTED 2 /* put new buffer in buffer list */
935#define BLN_DUMMY 4 /* allocating dummy buffer */
936#define BLN_NEW 8 /* create a new buffer */
Bram Moolenaar82404332016-07-10 17:00:38 +0200937#define BLN_NOOPT 16 /* don't copy options to existing buffer */
Bram Moolenaarcd524592016-07-17 14:57:05 +0200938#define BLN_DUMMY_OK 32 /* also find an existing dummy buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000939
940/* Values for in_cinkeys() */
941#define KEY_OPEN_FORW 0x101
942#define KEY_OPEN_BACK 0x102
943#define KEY_COMPLETE 0x103 /* end of completion */
944
945/* Values for "noremap" argument of ins_typebuf(). Also used for
946 * map->m_noremap and menu->noremap[]. */
947#define REMAP_YES 0 /* allow remapping */
948#define REMAP_NONE -1 /* no remapping */
949#define REMAP_SCRIPT -2 /* remap script-local mappings only */
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000950#define REMAP_SKIP -3 /* no remapping for first char */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000951
952/* Values for mch_call_shell() second argument */
953#define SHELL_FILTER 1 /* filtering text */
954#define SHELL_EXPAND 2 /* expanding wildcards */
955#define SHELL_COOKED 4 /* set term to cooked mode */
956#define SHELL_DOOUT 8 /* redirecting output */
957#define SHELL_SILENT 16 /* don't print error returned by command */
Bram Moolenaardf177f62005-02-22 08:39:57 +0000958#define SHELL_READ 32 /* read lines and insert into buffer */
959#define SHELL_WRITE 64 /* write lines from buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000960
961/* Values returned by mch_nodetype() */
962#define NODE_NORMAL 0 /* file or directory, check with mch_isdir()*/
963#define NODE_WRITABLE 1 /* something we can write to (character
964 device, fifo, socket, ..) */
965#define NODE_OTHER 2 /* non-writable thing (e.g., block device) */
966
967/* Values for readfile() flags */
968#define READ_NEW 0x01 /* read a file into a new buffer */
969#define READ_FILTER 0x02 /* read filter output */
970#define READ_STDIN 0x04 /* read from stdin */
971#define READ_BUFFER 0x08 /* read from curbuf (converting stdin) */
972#define READ_DUMMY 0x10 /* reading into a dummy buffer */
Bram Moolenaar59f931e2010-07-24 20:27:03 +0200973#define READ_KEEP_UNDO 0x20 /* keep undo info*/
Bram Moolenaar071d4272004-06-13 20:20:40 +0000974
975/* Values for change_indent() */
976#define INDENT_SET 1 /* set indent */
977#define INDENT_INC 2 /* increase indent */
978#define INDENT_DEC 3 /* decrease indent */
979
980/* Values for flags argument for findmatchlimit() */
981#define FM_BACKWARD 0x01 /* search backwards */
982#define FM_FORWARD 0x02 /* search forwards */
983#define FM_BLOCKSTOP 0x04 /* stop at start/end of block */
984#define FM_SKIPCOMM 0x08 /* skip comments */
985
986/* Values for action argument for do_buffer() */
987#define DOBUF_GOTO 0 /* go to specified buffer */
988#define DOBUF_SPLIT 1 /* split window and go to specified buffer */
989#define DOBUF_UNLOAD 2 /* unload specified buffer(s) */
990#define DOBUF_DEL 3 /* delete specified buffer(s) from buflist */
991#define DOBUF_WIPE 4 /* delete specified buffer(s) really */
992
993/* Values for start argument for do_buffer() */
994#define DOBUF_CURRENT 0 /* "count" buffer from current buffer */
995#define DOBUF_FIRST 1 /* "count" buffer from first buffer */
996#define DOBUF_LAST 2 /* "count" buffer from last buffer */
997#define DOBUF_MOD 3 /* "count" mod. buffer from current buffer */
998
999/* Values for sub_cmd and which_pat argument for search_regcomp() */
1000/* Also used for which_pat argument for searchit() */
1001#define RE_SEARCH 0 /* save/use pat in/from search_pattern */
1002#define RE_SUBST 1 /* save/use pat in/from subst_pattern */
1003#define RE_BOTH 2 /* save pat in both patterns */
1004#define RE_LAST 2 /* use last used pattern if "pat" is NULL */
1005
1006/* Second argument for vim_regcomp(). */
1007#define RE_MAGIC 1 /* 'magic' option */
1008#define RE_STRING 2 /* match in string instead of buffer text */
Bram Moolenaarae5bce12005-08-15 21:41:48 +00001009#define RE_STRICT 4 /* don't allow [abc] without ] */
Bram Moolenaare0ad3652015-01-27 12:59:55 +01001010#define RE_AUTO 8 /* automatic engine selection */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001011
1012#ifdef FEAT_SYN_HL
1013/* values for reg_do_extmatch */
1014# define REX_SET 1 /* to allow \z\(...\), */
1015# define REX_USE 2 /* to allow \z\1 et al. */
1016#endif
1017
1018/* Return values for fullpathcmp() */
1019/* Note: can use (fullpathcmp() & FPC_SAME) to check for equal files */
1020#define FPC_SAME 1 /* both exist and are the same file. */
1021#define FPC_DIFF 2 /* both exist and are different files. */
1022#define FPC_NOTX 4 /* both don't exist. */
1023#define FPC_DIFFX 6 /* one of them doesn't exist. */
1024#define FPC_SAMEX 7 /* both don't exist and file names are same. */
1025
1026/* flags for do_ecmd() */
1027#define ECMD_HIDE 0x01 /* don't free the current buffer */
1028#define ECMD_SET_HELP 0x02 /* set b_help flag of (new) buffer before
1029 opening file */
1030#define ECMD_OLDBUF 0x04 /* use existing buffer if it exists */
1031#define ECMD_FORCEIT 0x08 /* ! used in Ex command */
1032#define ECMD_ADDBUF 0x10 /* don't edit, just add to buffer list */
1033
1034/* for lnum argument in do_ecmd() */
1035#define ECMD_LASTL (linenr_T)0 /* use last position in loaded file */
1036#define ECMD_LAST (linenr_T)-1 /* use last position in all files */
1037#define ECMD_ONE (linenr_T)1 /* use first line */
1038
1039/* flags for do_cmdline() */
1040#define DOCMD_VERBOSE 0x01 /* included command in error message */
1041#define DOCMD_NOWAIT 0x02 /* don't call wait_return() and friends */
1042#define DOCMD_REPEAT 0x04 /* repeat exec. until getline() returns NULL */
1043#define DOCMD_KEYTYPED 0x08 /* don't reset KeyTyped */
1044#define DOCMD_EXCRESET 0x10 /* reset exception environment (for debugging)*/
1045#define DOCMD_KEEPLINE 0x20 /* keep typed line for repeating with "." */
1046
1047/* flags for beginline() */
1048#define BL_WHITE 1 /* cursor on first non-white in the line */
1049#define BL_SOL 2 /* use 'sol' option */
1050#define BL_FIX 4 /* don't leave cursor on a NUL */
1051
1052/* flags for mf_sync() */
1053#define MFS_ALL 1 /* also sync blocks with negative numbers */
1054#define MFS_STOP 2 /* stop syncing when a character is available */
1055#define MFS_FLUSH 4 /* flushed file to disk */
1056#define MFS_ZERO 8 /* only write block 0 */
1057
1058/* flags for buf_copy_options() */
1059#define BCO_ENTER 1 /* going to enter the buffer */
1060#define BCO_ALWAYS 2 /* always copy the options */
1061#define BCO_NOHELP 4 /* don't touch the help related options */
1062
1063/* flags for do_put() */
1064#define PUT_FIXINDENT 1 /* make indent look nice */
1065#define PUT_CURSEND 2 /* leave cursor after end of new text */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001066#define PUT_CURSLINE 4 /* leave cursor on last line of new text */
1067#define PUT_LINE 8 /* put register as lines */
1068#define PUT_LINE_SPLIT 16 /* split line for linewise register */
1069#define PUT_LINE_FORWARD 32 /* put linewise register below Visual sel. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001070
1071/* flags for set_indent() */
1072#define SIN_CHANGED 1 /* call changed_bytes() when line changed */
1073#define SIN_INSERT 2 /* insert indent before existing text */
1074#define SIN_UNDO 4 /* save line for undo before changing it */
1075
1076/* flags for insertchar() */
1077#define INSCHAR_FORMAT 1 /* force formatting */
1078#define INSCHAR_DO_COM 2 /* format comments */
1079#define INSCHAR_CTRLV 4 /* char typed just after CTRL-V */
Bram Moolenaar81a82092008-03-12 16:27:00 +00001080#define INSCHAR_NO_FEX 8 /* don't use 'formatexpr' */
Bram Moolenaarbfe3bf82012-06-13 17:28:55 +02001081#define INSCHAR_COM_LIST 16 /* format comments with list/2nd line indent */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001082
1083/* flags for open_line() */
1084#define OPENLINE_DELSPACES 1 /* delete spaces after cursor */
1085#define OPENLINE_DO_COM 2 /* format comments */
1086#define OPENLINE_KEEPTRAIL 4 /* keep trailing spaces */
1087#define OPENLINE_MARKFIX 8 /* fix mark positions */
Bram Moolenaarbfe3bf82012-06-13 17:28:55 +02001088#define OPENLINE_COM_LIST 16 /* format comments with list/2nd line indent */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001089
1090/*
Bram Moolenaarc60954b2016-06-06 21:20:10 +02001091 * There are five history tables:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001092 */
1093#define HIST_CMD 0 /* colon commands */
1094#define HIST_SEARCH 1 /* search commands */
1095#define HIST_EXPR 2 /* expressions (from entering = register) */
1096#define HIST_INPUT 3 /* input() lines */
1097#define HIST_DEBUG 4 /* debug commands */
1098#define HIST_COUNT 5 /* number of history tables */
1099
Bram Moolenaarc60954b2016-06-06 21:20:10 +02001100/* The type numbers are fixed for backwards compatibility. */
1101#define BARTYPE_VERSION 1
1102#define BARTYPE_HISTORY 2
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02001103#define BARTYPE_REGISTER 3
Bram Moolenaar2d358992016-06-12 21:20:54 +02001104#define BARTYPE_MARK 4
Bram Moolenaarc60954b2016-06-06 21:20:10 +02001105
Bram Moolenaar2d358992016-06-12 21:20:54 +02001106#define VIMINFO_VERSION 4
Bram Moolenaar1fd99c12016-06-09 20:24:28 +02001107#define VIMINFO_VERSION_WITH_HISTORY 2
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02001108#define VIMINFO_VERSION_WITH_REGISTERS 3
Bram Moolenaar2d358992016-06-12 21:20:54 +02001109#define VIMINFO_VERSION_WITH_MARKS 4
Bram Moolenaar1fd99c12016-06-09 20:24:28 +02001110
Bram Moolenaarc60954b2016-06-06 21:20:10 +02001111typedef enum {
1112 BVAL_NR,
1113 BVAL_STRING,
1114 BVAL_EMPTY
1115} btype_T;
1116
Bram Moolenaarc60954b2016-06-06 21:20:10 +02001117typedef struct {
1118 btype_T bv_type;
1119 long bv_nr;
1120 char_u *bv_string;
1121 int bv_len; /* length of bv_string */
1122 int bv_allocated; /* bv_string was allocated */
1123} bval_T;
1124
Bram Moolenaar071d4272004-06-13 20:20:40 +00001125/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001126 * Values for do_tag().
1127 */
1128#define DT_TAG 1 /* jump to newer position or same tag again */
1129#define DT_POP 2 /* jump to older position */
1130#define DT_NEXT 3 /* jump to next match of same tag */
1131#define DT_PREV 4 /* jump to previous match of same tag */
1132#define DT_FIRST 5 /* jump to first match of same tag */
1133#define DT_LAST 6 /* jump to first match of same tag */
1134#define DT_SELECT 7 /* jump to selection from list */
1135#define DT_HELP 8 /* like DT_TAG, but no wildcards */
1136#define DT_JUMP 9 /* jump to new tag or selection from list */
1137#define DT_CSCOPE 10 /* cscope find command (like tjump) */
Bram Moolenaarb8a7b562006-02-01 21:47:16 +00001138#define DT_LTAG 11 /* tag using location list */
Bram Moolenaarea408852005-06-25 22:49:46 +00001139#define DT_FREE 99 /* free cached matches */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001140
1141/*
1142 * flags for find_tags().
1143 */
1144#define TAG_HELP 1 /* only search for help tags */
1145#define TAG_NAMES 2 /* only return name of tag */
1146#define TAG_REGEXP 4 /* use tag pattern as regexp */
1147#define TAG_NOIC 8 /* don't always ignore case */
1148#ifdef FEAT_CSCOPE
1149# define TAG_CSCOPE 16 /* cscope tag */
1150#endif
1151#define TAG_VERBOSE 32 /* message verbosity */
1152#define TAG_INS_COMP 64 /* Currently doing insert completion */
1153#define TAG_KEEP_LANG 128 /* keep current language */
1154
Bram Moolenaarc236c162008-07-13 17:41:49 +00001155#define TAG_MANY 300 /* When finding many tags (for completion),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001156 find up to this many tags */
1157
1158/*
1159 * Types of dialogs passed to do_vim_dialog().
1160 */
1161#define VIM_GENERIC 0
1162#define VIM_ERROR 1
1163#define VIM_WARNING 2
1164#define VIM_INFO 3
1165#define VIM_QUESTION 4
1166#define VIM_LAST_TYPE 4 /* sentinel value */
1167
1168/*
1169 * Return values for functions like gui_yesnocancel()
1170 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001171#define VIM_YES 2
1172#define VIM_NO 3
1173#define VIM_CANCEL 4
1174#define VIM_ALL 5
1175#define VIM_DISCARDALL 6
1176
1177/*
1178 * arguments for win_split()
1179 */
1180#define WSP_ROOM 1 /* require enough room */
1181#define WSP_VERT 2 /* split vertically */
1182#define WSP_TOP 4 /* window at top-left of shell */
1183#define WSP_BOT 8 /* window at bottom-right of shell */
1184#define WSP_HELP 16 /* creating the help window */
1185#define WSP_BELOW 32 /* put new window below/right */
1186#define WSP_ABOVE 64 /* put new window above/left */
Bram Moolenaar884ae642009-02-22 01:37:59 +00001187#define WSP_NEWLOC 128 /* don't copy location list */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001188
1189/*
Bram Moolenaar2e2a2812006-03-27 20:55:21 +00001190 * arguments for gui_set_shellsize()
1191 */
1192#define RESIZE_VERT 1 /* resize vertically */
1193#define RESIZE_HOR 2 /* resize horizontally */
1194#define RESIZE_BOTH 15 /* resize in both directions */
1195
1196/*
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001197 * flags for check_changed()
1198 */
1199#define CCGD_AW 1 /* do autowrite if buffer was changed */
1200#define CCGD_MULTWIN 2 /* check also when several wins for the buf */
1201#define CCGD_FORCEIT 4 /* ! used */
1202#define CCGD_ALLBUF 8 /* may write all buffers */
1203#define CCGD_EXCMD 16 /* may suggest using ! */
1204
1205/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001206 * "flags" values for option-setting functions.
1207 * When OPT_GLOBAL and OPT_LOCAL are both missing, set both local and global
1208 * values, get local value.
1209 */
1210#define OPT_FREE 1 /* free old value if it was allocated */
1211#define OPT_GLOBAL 2 /* use global value */
1212#define OPT_LOCAL 4 /* use local value */
1213#define OPT_MODELINE 8 /* option in modeline */
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00001214#define OPT_WINONLY 16 /* only set window-local options */
Bram Moolenaara3227e22006-03-08 21:32:40 +00001215#define OPT_NOWIN 32 /* don't set window-local options */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001216
1217/* Magic chars used in confirm dialog strings */
1218#define DLG_BUTTON_SEP '\n'
1219#define DLG_HOTKEY_CHAR '&'
1220
1221/* Values for "starting" */
1222#define NO_SCREEN 2 /* no screen updating yet */
1223#define NO_BUFFERS 1 /* not all buffers loaded yet */
1224/* 0 not starting anymore */
1225
1226/* Values for swap_exists_action: what to do when swap file already exists */
1227#define SEA_NONE 0 /* don't use dialog */
Bram Moolenaarbe79f902005-12-07 20:56:14 +00001228#define SEA_DIALOG 1 /* use dialog when possible */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001229#define SEA_QUIT 2 /* quit editing the file */
1230#define SEA_RECOVER 3 /* recover the file */
1231
1232/*
1233 * Minimal size for block 0 of a swap file.
1234 * NOTE: This depends on size of struct block0! It's not done with a sizeof(),
1235 * because struct block0 is defined in memline.c (Sorry).
1236 * The maximal block size is arbitrary.
1237 */
1238#define MIN_SWAP_PAGE_SIZE 1048
1239#define MAX_SWAP_PAGE_SIZE 50000
1240
1241/* Special values for current_SID. */
1242#define SID_MODELINE -1 /* when using a modeline */
1243#define SID_CMDARG -2 /* for "--cmd" argument */
1244#define SID_CARG -3 /* for "-c" argument */
1245#define SID_ENV -4 /* for sourcing environment variable */
Bram Moolenaard1f56e62006-02-22 21:25:37 +00001246#define SID_ERROR -5 /* option was reset because of an error */
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00001247#define SID_NONE -6 /* don't set scriptID */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001248
1249/*
1250 * Events for autocommands.
1251 */
1252enum auto_event
1253{
1254 EVENT_BUFADD = 0, /* after adding a buffer to the buffer list */
1255 EVENT_BUFNEW, /* after creating any buffer */
1256 EVENT_BUFDELETE, /* deleting a buffer from the buffer list */
1257 EVENT_BUFWIPEOUT, /* just before really deleting a buffer */
1258 EVENT_BUFENTER, /* after entering a buffer */
1259 EVENT_BUFFILEPOST, /* after renaming a buffer */
1260 EVENT_BUFFILEPRE, /* before renaming a buffer */
1261 EVENT_BUFLEAVE, /* before leaving a buffer */
1262 EVENT_BUFNEWFILE, /* when creating a buffer for a new file */
1263 EVENT_BUFREADPOST, /* after reading a buffer */
1264 EVENT_BUFREADPRE, /* before reading a buffer */
1265 EVENT_BUFREADCMD, /* read buffer using command */
1266 EVENT_BUFUNLOAD, /* just before unloading a buffer */
1267 EVENT_BUFHIDDEN, /* just after buffer becomes hidden */
1268 EVENT_BUFWINENTER, /* after showing a buffer in a window */
1269 EVENT_BUFWINLEAVE, /* just after buffer removed from window */
1270 EVENT_BUFWRITEPOST, /* after writing a buffer */
1271 EVENT_BUFWRITEPRE, /* before writing a buffer */
1272 EVENT_BUFWRITECMD, /* write buffer using command */
1273 EVENT_CMDWINENTER, /* after entering the cmdline window */
1274 EVENT_CMDWINLEAVE, /* before leaving the cmdline window */
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001275 EVENT_COLORSCHEME, /* after loading a colorscheme */
Bram Moolenaarcfa3cae2012-07-10 17:14:56 +02001276 EVENT_COMPLETEDONE, /* after finishing insert complete */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001277 EVENT_FILEAPPENDPOST, /* after appending to a file */
1278 EVENT_FILEAPPENDPRE, /* before appending to a file */
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00001279 EVENT_FILEAPPENDCMD, /* append to a file using command */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001280 EVENT_FILECHANGEDSHELL, /* after shell command that changed file */
Bram Moolenaardb003512006-03-15 22:48:35 +00001281 EVENT_FILECHANGEDSHELLPOST, /* after (not) reloading changed file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001282 EVENT_FILECHANGEDRO, /* before first change to read-only file */
1283 EVENT_FILEREADPOST, /* after reading a file */
1284 EVENT_FILEREADPRE, /* before reading a file */
1285 EVENT_FILEREADCMD, /* read from a file using command */
1286 EVENT_FILETYPE, /* new file type detected (user defined) */
1287 EVENT_FILEWRITEPOST, /* after writing a file */
1288 EVENT_FILEWRITEPRE, /* before writing a file */
1289 EVENT_FILEWRITECMD, /* write to a file using command */
1290 EVENT_FILTERREADPOST, /* after reading from a filter */
1291 EVENT_FILTERREADPRE, /* before reading from a filter */
1292 EVENT_FILTERWRITEPOST, /* after writing to a filter */
1293 EVENT_FILTERWRITEPRE, /* before writing to a filter */
1294 EVENT_FOCUSGAINED, /* got the focus */
1295 EVENT_FOCUSLOST, /* lost the focus to another app */
1296 EVENT_GUIENTER, /* after starting the GUI */
Bram Moolenaar265e5072006-08-29 16:13:22 +00001297 EVENT_GUIFAILED, /* after starting the GUI failed */
Bram Moolenaar843ee412004-06-30 16:16:41 +00001298 EVENT_INSERTCHANGE, /* when changing Insert/Replace mode */
1299 EVENT_INSERTENTER, /* when entering Insert mode */
1300 EVENT_INSERTLEAVE, /* when leaving Insert mode */
Bram Moolenaara3ffd9c2005-07-21 21:03:15 +00001301 EVENT_MENUPOPUP, /* just before popup menu is displayed */
Bram Moolenaar3b53dfb2012-06-06 18:03:07 +02001302 EVENT_QUICKFIXCMDPOST, /* after :make, :grep etc. */
1303 EVENT_QUICKFIXCMDPRE, /* before :make, :grep etc. */
1304 EVENT_QUITPRE, /* before :quit */
Bram Moolenaarcef9dcc2005-12-06 19:50:41 +00001305 EVENT_SESSIONLOADPOST, /* after loading a session file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001306 EVENT_STDINREADPOST, /* after reading from stdin */
1307 EVENT_STDINREADPRE, /* before reading from stdin */
1308 EVENT_SYNTAX, /* syntax selected */
1309 EVENT_TERMCHANGED, /* after changing 'term' */
1310 EVENT_TERMRESPONSE, /* after setting "v:termresponse" */
1311 EVENT_USER, /* user defined autocommand */
1312 EVENT_VIMENTER, /* after starting Vim */
1313 EVENT_VIMLEAVE, /* before exiting Vim */
1314 EVENT_VIMLEAVEPRE, /* before exiting Vim and writing .viminfo */
Bram Moolenaardb003512006-03-15 22:48:35 +00001315 EVENT_VIMRESIZED, /* after Vim window was resized */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001316 EVENT_WINENTER, /* after entering a window */
1317 EVENT_WINLEAVE, /* before leaving a window */
Bram Moolenaarc917da42016-07-19 22:31:36 +02001318 EVENT_WINNEW, /* when entering a new window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001319 EVENT_ENCODINGCHANGED, /* after changing the 'encoding' option */
Bram Moolenaare659c952011-05-19 17:25:41 +02001320 EVENT_INSERTCHARPRE, /* before inserting a char */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001321 EVENT_CURSORHOLD, /* cursor in same position for a while */
Bram Moolenaarcf0c5542006-02-09 23:48:02 +00001322 EVENT_CURSORHOLDI, /* idem, in Insert mode */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001323 EVENT_FUNCUNDEFINED, /* if calling a function which doesn't exist */
1324 EVENT_REMOTEREPLY, /* upon string reception from a remote vim */
Bram Moolenaarbe79f902005-12-07 20:56:14 +00001325 EVENT_SWAPEXISTS, /* found existing swap file */
Bram Moolenaara2031822006-03-07 22:29:51 +00001326 EVENT_SOURCEPRE, /* before sourcing a Vim script */
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00001327 EVENT_SOURCECMD, /* sourcing a Vim script using command */
Bram Moolenaarb8a7b562006-02-01 21:47:16 +00001328 EVENT_SPELLFILEMISSING, /* spell file missing */
Bram Moolenaarcf0c5542006-02-09 23:48:02 +00001329 EVENT_CURSORMOVED, /* cursor was moved */
1330 EVENT_CURSORMOVEDI, /* cursor was moved in Insert mode */
Bram Moolenaar2a0449d2006-02-20 21:27:21 +00001331 EVENT_TABENTER, /* after entering a tab page */
Bram Moolenaarc917da42016-07-19 22:31:36 +02001332 EVENT_TABLEAVE, /* before leaving a tab page */
1333 EVENT_TABNEW, /* when entering a new tab page */
Bram Moolenaar12c11d52016-07-19 23:13:03 +02001334 EVENT_TABCLOSED, /* after closing a tab page */
Bram Moolenaar4e427192006-03-10 21:34:27 +00001335 EVENT_SHELLCMDPOST, /* after ":!cmd" */
1336 EVENT_SHELLFILTERPOST, /* after ":1,2!cmd", ":w !cmd", ":r !cmd". */
Bram Moolenaar186628f2013-03-19 13:33:23 +01001337 EVENT_TEXTCHANGED, /* text was modified */
1338 EVENT_TEXTCHANGEDI, /* text was modified in Insert mode*/
Bram Moolenaar5a31b462014-08-23 14:16:20 +02001339 EVENT_CMDUNDEFINED, /* command undefined */
Bram Moolenaar53744302015-07-17 17:38:22 +02001340 EVENT_OPTIONSET, /* option was set */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001341 NUM_EVENTS /* MUST be the last one */
1342};
1343
Bram Moolenaarcf0c5542006-02-09 23:48:02 +00001344typedef enum auto_event event_T;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001345
1346/*
1347 * Values for index in highlight_attr[].
1348 * When making changes, also update HL_FLAGS below! And update the default
1349 * value of 'highlight' in option.c.
1350 */
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00001351typedef enum
Bram Moolenaar071d4272004-06-13 20:20:40 +00001352{
1353 HLF_8 = 0 /* Meta & special keys listed with ":map", text that is
1354 displayed different from what it is */
1355 , HLF_AT /* @ and ~ characters at end of screen, characters that
1356 don't really exist in the text */
1357 , HLF_D /* directories in CTRL-D listing */
1358 , HLF_E /* error messages */
1359 , HLF_H /* obsolete, ignored */
1360 , HLF_I /* incremental search */
1361 , HLF_L /* last search string */
1362 , HLF_M /* "--More--" message */
1363 , HLF_CM /* Mode (e.g., "-- INSERT --") */
1364 , HLF_N /* line number for ":number" and ":#" commands */
Bram Moolenaar06ca5132012-03-23 16:25:17 +01001365 , HLF_CLN /* current line number */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001366 , HLF_R /* return to continue message and yes/no questions */
1367 , HLF_S /* status lines */
1368 , HLF_SNC /* status lines of not-current windows */
1369 , HLF_C /* column to separate vertically split windows */
1370 , HLF_T /* Titles for output from ":set all", ":autocmd" etc. */
1371 , HLF_V /* Visual mode */
1372 , HLF_VNC /* Visual mode, autoselecting and not clipboard owner */
1373 , HLF_W /* warning messages */
1374 , HLF_WM /* Wildmenu highlight */
1375 , HLF_FL /* Folded line */
1376 , HLF_FC /* Fold column */
1377 , HLF_ADD /* Added diff line */
1378 , HLF_CHD /* Changed diff line */
1379 , HLF_DED /* Deleted diff line */
1380 , HLF_TXD /* Text Changed in diff line */
Bram Moolenaar860cae12010-06-05 23:22:07 +02001381 , HLF_CONCEAL /* Concealed text */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001382 , HLF_SC /* Sign column */
Bram Moolenaar2e4096b2005-03-20 22:25:45 +00001383 , HLF_SPB /* SpellBad */
Bram Moolenaarf9184a12005-07-02 23:10:47 +00001384 , HLF_SPC /* SpellCap */
Bram Moolenaar2e4096b2005-03-20 22:25:45 +00001385 , HLF_SPR /* SpellRare */
1386 , HLF_SPL /* SpellLocal */
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001387 , HLF_PNI /* popup menu normal item */
1388 , HLF_PSI /* popup menu selected item */
1389 , HLF_PSB /* popup menu scrollbar */
1390 , HLF_PST /* popup menu scrollbar thumb */
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001391 , HLF_TP /* tabpage line */
1392 , HLF_TPS /* tabpage line selected */
1393 , HLF_TPF /* tabpage line filler */
Bram Moolenaarf71a3db2006-03-12 21:50:18 +00001394 , HLF_CUC /* 'cursurcolumn' */
1395 , HLF_CUL /* 'cursurline' */
Bram Moolenaar1a384422010-07-14 19:53:30 +02001396 , HLF_MC /* 'colorcolumn' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001397 , HLF_COUNT /* MUST be the last one */
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00001398} hlf_T;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001399
Bram Moolenaarf71a3db2006-03-12 21:50:18 +00001400/* The HL_FLAGS must be in the same order as the HLF_ enums!
Bram Moolenaar42b4dda2010-03-02 15:56:05 +01001401 * When changing this also adjust the default for 'highlight'. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001402#define HL_FLAGS {'8', '@', 'd', 'e', 'h', 'i', 'l', 'm', 'M', \
Bram Moolenaar06ca5132012-03-23 16:25:17 +01001403 'n', 'N', 'r', 's', 'S', 'c', 't', 'v', 'V', 'w', 'W', \
Bram Moolenaar860cae12010-06-05 23:22:07 +02001404 'f', 'F', 'A', 'C', 'D', 'T', '-', '>', \
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001405 'B', 'P', 'R', 'L', \
Bram Moolenaar1a384422010-07-14 19:53:30 +02001406 '+', '=', 'x', 'X', '*', '#', '_', '!', '.', 'o'}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001407
1408/*
1409 * Boolean constants
1410 */
1411#ifndef TRUE
1412# define FALSE 0 /* note: this is an int, not a long! */
1413# define TRUE 1
1414#endif
1415
1416#define MAYBE 2 /* sometimes used for a variant on TRUE */
1417
Bram Moolenaar7db5fc82010-05-24 11:59:29 +02001418#ifndef UINT32_T
1419typedef UINT32_TYPEDEF UINT32_T;
1420#endif
1421
Bram Moolenaar071d4272004-06-13 20:20:40 +00001422/*
1423 * Operator IDs; The order must correspond to opchars[] in ops.c!
1424 */
1425#define OP_NOP 0 /* no pending operation */
1426#define OP_DELETE 1 /* "d" delete operator */
1427#define OP_YANK 2 /* "y" yank operator */
1428#define OP_CHANGE 3 /* "c" change operator */
1429#define OP_LSHIFT 4 /* "<" left shift operator */
1430#define OP_RSHIFT 5 /* ">" right shift operator */
1431#define OP_FILTER 6 /* "!" filter operator */
1432#define OP_TILDE 7 /* "g~" switch case operator */
1433#define OP_INDENT 8 /* "=" indent operator */
1434#define OP_FORMAT 9 /* "gq" format operator */
1435#define OP_COLON 10 /* ":" colon operator */
1436#define OP_UPPER 11 /* "gU" make upper case operator */
1437#define OP_LOWER 12 /* "gu" make lower case operator */
1438#define OP_JOIN 13 /* "J" join operator, only for Visual mode */
1439#define OP_JOIN_NS 14 /* "gJ" join operator, only for Visual mode */
1440#define OP_ROT13 15 /* "g?" rot-13 encoding */
1441#define OP_REPLACE 16 /* "r" replace chars, only for Visual mode */
1442#define OP_INSERT 17 /* "I" Insert column, only for Visual mode */
1443#define OP_APPEND 18 /* "A" Append column, only for Visual mode */
1444#define OP_FOLD 19 /* "zf" define a fold */
1445#define OP_FOLDOPEN 20 /* "zo" open folds */
1446#define OP_FOLDOPENREC 21 /* "zO" open folds recursively */
1447#define OP_FOLDCLOSE 22 /* "zc" close folds */
1448#define OP_FOLDCLOSEREC 23 /* "zC" close folds recursively */
1449#define OP_FOLDDEL 24 /* "zd" delete folds */
1450#define OP_FOLDDELREC 25 /* "zD" delete folds recursively */
1451#define OP_FORMAT2 26 /* "gw" format operator, keeps cursor pos */
Bram Moolenaar12033fb2005-12-16 21:49:31 +00001452#define OP_FUNCTION 27 /* "g@" call 'operatorfunc' */
Bram Moolenaard79e5502016-01-10 22:13:02 +01001453#define OP_NR_ADD 28 /* "<C-A>" Add to the number or alphabetic
1454 character (OP_ADD conflicts with Perl) */
1455#define OP_NR_SUB 29 /* "<C-X>" Subtract from the number or
1456 alphabetic character */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001457
1458/*
1459 * Motion types, used for operators and for yank/delete registers.
1460 */
1461#define MCHAR 0 /* character-wise movement/register */
1462#define MLINE 1 /* line-wise movement/register */
1463#define MBLOCK 2 /* block-wise register */
1464
1465#define MAUTO 0xff /* Decide between MLINE/MCHAR */
1466
1467/*
1468 * Minimum screen size
1469 */
1470#define MIN_COLUMNS 12 /* minimal columns for screen */
1471#define MIN_LINES 2 /* minimal lines for screen */
1472#define STATUS_HEIGHT 1 /* height of a status line under a window */
1473#define QF_WINHEIGHT 10 /* default height for quickfix window */
1474
1475/*
1476 * Buffer sizes
1477 */
1478#ifndef CMDBUFFSIZE
1479# define CMDBUFFSIZE 256 /* size of the command processing buffer */
1480#endif
1481
1482#define LSIZE 512 /* max. size of a line in the tags file */
1483
1484#define IOSIZE (1024+1) /* file i/o and sprintf buffer size */
Bram Moolenaard9d30582005-05-18 22:10:28 +00001485
Bram Moolenaard9462e32011-04-11 21:35:11 +02001486#define DIALOG_MSG_SIZE 1000 /* buffer size for dialog_msg() */
1487
Bram Moolenaard9d30582005-05-18 22:10:28 +00001488#ifdef FEAT_MBYTE
1489# define MSG_BUF_LEN 480 /* length of buffer for small messages */
1490# define MSG_BUF_CLEN (MSG_BUF_LEN / 6) /* cell length (worst case: utf-8
1491 takes 6 bytes for one cell) */
1492#else
1493# define MSG_BUF_LEN 80 /* length of buffer for small messages */
1494# define MSG_BUF_CLEN MSG_BUF_LEN /* cell length */
1495#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001496
Bram Moolenaar0bd40c02009-06-16 09:07:49 +00001497/* Size of the buffer used for tgetent(). Unfortunately this is largely
1498 * undocumented, some systems use 1024. Using a buffer that is too small
1499 * causes a buffer overrun and a crash. Use the maximum known value to stay
1500 * on the safe side. */
1501#define TBUFSZ 2048 /* buffer size for termcap entry */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001502
1503/*
1504 * Maximum length of key sequence to be mapped.
1505 * Must be able to hold an Amiga resize report.
1506 */
1507#define MAXMAPLEN 50
1508
Bram Moolenaar55debbe2010-05-23 23:34:36 +02001509/* Size in bytes of the hash used in the undo file. */
1510#define UNDO_HASH_SIZE 32
1511
Bram Moolenaara7241f52008-06-24 20:39:31 +00001512#ifdef HAVE_FCNTL_H
1513# include <fcntl.h>
1514#endif
1515
Bram Moolenaar071d4272004-06-13 20:20:40 +00001516#ifdef BINARY_FILE_IO
1517# define WRITEBIN "wb" /* no CR-LF translation */
1518# define READBIN "rb"
1519# define APPENDBIN "ab"
1520#else
1521# define WRITEBIN "w"
1522# define READBIN "r"
1523# define APPENDBIN "a"
1524#endif
1525
1526/*
1527 * EMX doesn't have a global way of making open() use binary I/O.
1528 * Use O_BINARY for all open() calls.
1529 */
Bram Moolenaara06ecab2016-07-16 14:47:36 +02001530#if defined(__CYGWIN32__)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001531# define O_EXTRA O_BINARY
1532#else
1533# define O_EXTRA 0
1534#endif
1535
Bram Moolenaara5792f52005-11-23 21:25:05 +00001536#ifndef O_NOFOLLOW
1537# define O_NOFOLLOW 0
1538#endif
1539
Bram Moolenaar071d4272004-06-13 20:20:40 +00001540#ifndef W_OK
1541# define W_OK 2 /* for systems that don't have W_OK in unistd.h */
1542#endif
1543#ifndef R_OK
1544# define R_OK 4 /* for systems that don't have R_OK in unistd.h */
1545#endif
1546
1547/*
1548 * defines to avoid typecasts from (char_u *) to (char *) and back
1549 * (vim_strchr() and vim_strrchr() are now in alloc.c)
1550 */
1551#define STRLEN(s) strlen((char *)(s))
1552#define STRCPY(d, s) strcpy((char *)(d), (char *)(s))
1553#define STRNCPY(d, s, n) strncpy((char *)(d), (char *)(s), (size_t)(n))
1554#define STRCMP(d, s) strcmp((char *)(d), (char *)(s))
1555#define STRNCMP(d, s, n) strncmp((char *)(d), (char *)(s), (size_t)(n))
1556#ifdef HAVE_STRCASECMP
1557# define STRICMP(d, s) strcasecmp((char *)(d), (char *)(s))
1558#else
1559# ifdef HAVE_STRICMP
1560# define STRICMP(d, s) stricmp((char *)(d), (char *)(s))
1561# else
1562# define STRICMP(d, s) vim_stricmp((char *)(d), (char *)(s))
1563# endif
1564#endif
1565
Bram Moolenaara7241f52008-06-24 20:39:31 +00001566/* Like strcpy() but allows overlapped source and destination. */
1567#define STRMOVE(d, s) mch_memmove((d), (s), STRLEN(s) + 1)
1568
Bram Moolenaar071d4272004-06-13 20:20:40 +00001569#ifdef HAVE_STRNCASECMP
1570# define STRNICMP(d, s, n) strncasecmp((char *)(d), (char *)(s), (size_t)(n))
1571#else
1572# ifdef HAVE_STRNICMP
1573# define STRNICMP(d, s, n) strnicmp((char *)(d), (char *)(s), (size_t)(n))
1574# else
1575# define STRNICMP(d, s, n) vim_strnicmp((char *)(d), (char *)(s), (size_t)(n))
1576# endif
1577#endif
1578
1579#ifdef FEAT_MBYTE
Bram Moolenaara245a5b2007-08-11 11:58:23 +00001580/* We need to call mb_stricmp() even when we aren't dealing with a multi-byte
1581 * encoding because mb_stricmp() takes care of all ascii and non-ascii
Bram Moolenaar42b4dda2010-03-02 15:56:05 +01001582 * encodings, including characters with umlauts in latin1, etc., while
Bram Moolenaara245a5b2007-08-11 11:58:23 +00001583 * STRICMP() only handles the system locale version, which often does not
1584 * handle non-ascii properly. */
1585
1586# define MB_STRICMP(d, s) mb_strnicmp((char_u *)(d), (char_u *)(s), (int)MAXCOL)
1587# define MB_STRNICMP(d, s, n) mb_strnicmp((char_u *)(d), (char_u *)(s), (int)(n))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001588#else
1589# define MB_STRICMP(d, s) STRICMP((d), (s))
1590# define MB_STRNICMP(d, s, n) STRNICMP((d), (s), (n))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001591#endif
1592
1593#define STRCAT(d, s) strcat((char *)(d), (char *)(s))
1594#define STRNCAT(d, s, n) strncat((char *)(d), (char *)(s), (size_t)(n))
1595
1596#ifdef HAVE_STRPBRK
1597# define vim_strpbrk(s, cs) (char_u *)strpbrk((char *)(s), (char *)(cs))
1598#endif
1599
1600#define MSG(s) msg((char_u *)(s))
1601#define MSG_ATTR(s, attr) msg_attr((char_u *)(s), (attr))
1602#define EMSG(s) emsg((char_u *)(s))
1603#define EMSG2(s, p) emsg2((char_u *)(s), (char_u *)(p))
1604#define EMSG3(s, p, q) emsg3((char_u *)(s), (char_u *)(p), (char_u *)(q))
1605#define EMSGN(s, n) emsgn((char_u *)(s), (long)(n))
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001606#define EMSGU(s, n) emsgu((char_u *)(s), (long_u)(n))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001607#define OUT_STR(s) out_str((char_u *)(s))
1608#define OUT_STR_NF(s) out_str_nf((char_u *)(s))
1609#define MSG_PUTS(s) msg_puts((char_u *)(s))
1610#define MSG_PUTS_ATTR(s, a) msg_puts_attr((char_u *)(s), (a))
1611#define MSG_PUTS_TITLE(s) msg_puts_title((char_u *)(s))
Bram Moolenaar1d73c882005-06-19 22:48:47 +00001612#define MSG_PUTS_LONG(s) msg_puts_long_attr((char_u *)(s), 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001613#define MSG_PUTS_LONG_ATTR(s, a) msg_puts_long_attr((char_u *)(s), (a))
1614
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001615#ifdef FEAT_GUI
Bram Moolenaar61be73b2016-04-29 22:59:22 +02001616# ifdef FEAT_TERMGUICOLORS
1617# define GUI_FUNCTION(f) (gui.in_use ? gui_##f : termgui_##f)
Bram Moolenaar187147a2016-05-01 13:09:57 +02001618# define GUI_FUNCTION2(f, pixel) (gui.in_use \
1619 ? ((pixel) != INVALCOLOR \
1620 ? gui_##f((pixel)) \
1621 : (long_u)INVALCOLOR) \
1622 : termgui_##f((pixel)))
Bram Moolenaar61be73b2016-04-29 22:59:22 +02001623# define USE_24BIT (gui.in_use || p_tgc)
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001624# else
1625# define GUI_FUNCTION(f) gui_##f
Bram Moolenaar187147a2016-05-01 13:09:57 +02001626# define GUI_FUNCTION2(f,pixel) ((pixel) != INVALCOLOR \
1627 ? gui_##f((pixel)) \
1628 : (long_u)INVALCOLOR)
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001629# define USE_24BIT gui.in_use
1630# endif
1631#else
Bram Moolenaar61be73b2016-04-29 22:59:22 +02001632# ifdef FEAT_TERMGUICOLORS
1633# define GUI_FUNCTION(f) termgui_##f
Bram Moolenaar187147a2016-05-01 13:09:57 +02001634# define GUI_FUNCTION2(f, pixel) termgui_##f((pixel))
Bram Moolenaar61be73b2016-04-29 22:59:22 +02001635# define USE_24BIT p_tgc
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001636# endif
1637#endif
Bram Moolenaar61be73b2016-04-29 22:59:22 +02001638#ifdef FEAT_TERMGUICOLORS
1639# define IS_CTERM (t_colors > 1 || p_tgc)
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001640#else
1641# define IS_CTERM (t_colors > 1)
1642#endif
1643#ifdef GUI_FUNCTION
1644# define GUI_MCH_GET_RGB GUI_FUNCTION(mch_get_rgb)
Bram Moolenaar187147a2016-05-01 13:09:57 +02001645# define GUI_MCH_GET_RGB2(pixel) GUI_FUNCTION2(mch_get_rgb, (pixel))
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001646# define GUI_MCH_GET_COLOR GUI_FUNCTION(mch_get_color)
1647# define GUI_GET_COLOR GUI_FUNCTION(get_color)
1648#endif
1649
Bram Moolenaar071d4272004-06-13 20:20:40 +00001650/* Prefer using emsg3(), because perror() may send the output to the wrong
1651 * destination and mess up the screen. */
1652#ifdef HAVE_STRERROR
1653# define PERROR(msg) (void)emsg3((char_u *)"%s: %s", (char_u *)msg, (char_u *)strerror(errno))
1654#else
1655# define PERROR(msg) perror(msg)
1656#endif
1657
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001658typedef long linenr_T; /* line number type */
1659typedef int colnr_T; /* column number type */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001660typedef unsigned short disptick_T; /* display tick type */
1661
1662#define MAXLNUM (0x7fffffffL) /* maximum (invalid) line number */
1663
1664/*
1665 * Well, you won't believe it, but some S/390 machines ("host", now also known
Bram Moolenaar883f5d02010-06-21 06:24:34 +02001666 * as zServer) use 31 bit pointers. There are also some newer machines, that
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667 * use 64 bit pointers. I don't know how to distinguish between 31 and 64 bit
1668 * machines, so the best way is to assume 31 bits whenever we detect OS/390
1669 * Unix.
1670 * With this we restrict the maximum line length to 1073741823. I guess this is
1671 * not a real problem. BTW: Longer lines are split.
1672 */
Bram Moolenaara2aa31a2014-02-23 22:52:40 +01001673#if VIM_SIZEOF_INT >= 4
Bram Moolenaar071d4272004-06-13 20:20:40 +00001674# ifdef __MVS__
1675# define MAXCOL (0x3fffffffL) /* maximum column number, 30 bits */
1676# else
1677# define MAXCOL (0x7fffffffL) /* maximum column number, 31 bits */
1678# endif
1679#else
1680# define MAXCOL (0x7fff) /* maximum column number, 15 bits */
1681#endif
1682
1683#define SHOWCMD_COLS 10 /* columns needed by shown command */
1684#define STL_MAX_ITEM 80 /* max nr of %<flag> in statusline */
1685
1686typedef void *vim_acl_T; /* dummy to pass an ACL to a function */
1687
1688/*
1689 * Include a prototype for mch_memmove(), it may not be in alloc.pro.
1690 */
1691#ifdef VIM_MEMMOVE
Bram Moolenaard99df422016-01-29 23:20:40 +01001692void mch_memmove(void *, void *, size_t);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001693#else
1694# ifndef mch_memmove
1695# define mch_memmove(to, from, len) memmove(to, from, len)
1696# endif
1697#endif
1698
1699/*
1700 * fnamecmp() is used to compare file names.
1701 * On some systems case in a file name does not matter, on others it does.
1702 * (this does not account for maximum name lengths and things like "../dir",
1703 * thus it is not 100% accurate!)
1704 */
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01001705#define fnamecmp(x, y) vim_fnamecmp((char_u *)(x), (char_u *)(y))
1706#define fnamencmp(x, y, n) vim_fnamencmp((char_u *)(x), (char_u *)(y), (size_t)(n))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001707
1708#ifdef HAVE_MEMSET
1709# define vim_memset(ptr, c, size) memset((ptr), (c), (size))
1710#else
Bram Moolenaard99df422016-01-29 23:20:40 +01001711void *vim_memset(void *, int, size_t);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001712#endif
1713
1714#ifdef HAVE_MEMCMP
1715# define vim_memcmp(p1, p2, len) memcmp((p1), (p2), (len))
1716#else
1717# ifdef HAVE_BCMP
1718# define vim_memcmp(p1, p2, len) bcmp((p1), (p2), (len))
1719# else
Bram Moolenaard99df422016-01-29 23:20:40 +01001720int vim_memcmp(void *, void *, size_t);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001721# define VIM_MEMCMP
1722# endif
1723#endif
1724
Bram Moolenaare7fedb62015-12-31 19:07:19 +01001725#if defined(UNIX) || defined(FEAT_GUI) || defined(VMS) \
Bram Moolenaar071d4272004-06-13 20:20:40 +00001726 || defined(FEAT_CLIENTSERVER)
1727# define USE_INPUT_BUF
1728#endif
1729
Bram Moolenaar540fc6f2010-12-17 16:27:16 +01001730#ifndef EINTR
1731# define read_eintr(fd, buf, count) vim_read((fd), (buf), (count))
1732# define write_eintr(fd, buf, count) vim_write((fd), (buf), (count))
1733#endif
1734
Bram Moolenaar071d4272004-06-13 20:20:40 +00001735#ifdef MSWIN
1736/* On MS-Windows the third argument isn't size_t. This matters for Win64,
1737 * where sizeof(size_t)==8, not 4 */
1738# define vim_read(fd, buf, count) read((fd), (char *)(buf), (unsigned int)(count))
1739# define vim_write(fd, buf, count) write((fd), (char *)(buf), (unsigned int)(count))
1740#else
1741# define vim_read(fd, buf, count) read((fd), (char *)(buf), (size_t) (count))
1742# define vim_write(fd, buf, count) write((fd), (char *)(buf), (size_t) (count))
1743#endif
1744
1745/*
1746 * Enums need a typecast to be used as array index (for Ultrix).
1747 */
1748#define hl_attr(n) highlight_attr[(int)(n)]
1749#define term_str(n) term_strings[(int)(n)]
1750
1751/*
1752 * vim_iswhite() is used for "^" and the like. It differs from isspace()
1753 * because it doesn't include <CR> and <LF> and the like.
1754 */
1755#define vim_iswhite(x) ((x) == ' ' || (x) == '\t')
1756
Bram Moolenaara226a6d2006-02-26 23:59:20 +00001757/*
1758 * EXTERN is only defined in main.c. That's where global variables are
1759 * actually defined and initialized.
1760 */
1761#ifndef EXTERN
1762# define EXTERN extern
1763# define INIT(x)
1764#else
1765# ifndef INIT
1766# define INIT(x) x
1767# define DO_INIT
1768# endif
1769#endif
1770
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001771#ifdef FEAT_MBYTE
1772# define MAX_MCO 6 /* maximum value for 'maxcombine' */
1773
1774/* Maximum number of bytes in a multi-byte character. It can be one 32-bit
1775 * character of up to 6 bytes, or one 16-bit character of up to three bytes
1776 * plus six following composing characters of three bytes each. */
1777# define MB_MAXBYTES 21
Bram Moolenaar9a920d82012-06-01 15:21:02 +02001778#else
1779# define MB_MAXBYTES 1
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001780#endif
1781
Bram Moolenaar91a4e822008-01-19 14:59:58 +00001782#if (defined(FEAT_PROFILE) || defined(FEAT_RELTIME)) && !defined(PROTO)
1783# ifdef WIN3264
1784typedef LARGE_INTEGER proftime_T;
1785# else
1786typedef struct timeval proftime_T;
1787# endif
1788#else
1789typedef int proftime_T; /* dummy for function prototypes */
1790#endif
1791
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +02001792/*
1793 * When compiling with 32 bit Perl time_t is 32 bits in the Perl code but 64
1794 * bits elsewhere. That causes memory corruption. Define time_T and use it
1795 * for global variables to avoid that.
1796 */
1797#ifdef WIN3264
1798typedef __time64_t time_T;
1799#else
1800typedef time_t time_T;
1801#endif
1802
Bram Moolenaard8070362016-02-15 21:56:54 +01001803#ifdef _WIN64
Bram Moolenaard090d7b2016-02-13 17:09:53 +01001804typedef __int64 sock_T;
Bram Moolenaarf8b7d892016-02-13 17:24:26 +01001805#else
Bram Moolenaard090d7b2016-02-13 17:09:53 +01001806typedef int sock_T;
Bram Moolenaard090d7b2016-02-13 17:09:53 +01001807#endif
1808
Bram Moolenaara226a6d2006-02-26 23:59:20 +00001809/* Include option.h before structs.h, because the number of window-local and
1810 * buffer-local options is used there. */
1811#include "option.h" /* options and default values */
1812
Bram Moolenaar071d4272004-06-13 20:20:40 +00001813/* Note that gui.h is included by structs.h */
1814
1815#include "structs.h" /* file that defines many structures */
1816
Bram Moolenaar28fb79d2016-01-09 22:28:33 +01001817#include "alloc.h"
1818
Bram Moolenaar371d5402006-03-20 21:47:49 +00001819/* Values for "do_profiling". */
1820#define PROF_NONE 0 /* profiling not started */
1821#define PROF_YES 1 /* profiling busy */
1822#define PROF_PAUSED 2 /* profiling paused */
1823
Bram Moolenaar071d4272004-06-13 20:20:40 +00001824#ifdef FEAT_MOUSE
1825
1826/* Codes for mouse button events in lower three bits: */
1827# define MOUSE_LEFT 0x00
1828# define MOUSE_MIDDLE 0x01
1829# define MOUSE_RIGHT 0x02
1830# define MOUSE_RELEASE 0x03
1831
1832/* bit masks for modifiers: */
1833# define MOUSE_SHIFT 0x04
1834# define MOUSE_ALT 0x08
1835# define MOUSE_CTRL 0x10
1836
1837/* mouse buttons that are handled like a key press (GUI only) */
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +02001838/* Note that the scroll wheel keys are inverted: MOUSE_5 scrolls lines up but
1839 * the result of this is that the window moves down, similarly MOUSE_6 scrolls
1840 * columns left but the window moves right. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841# define MOUSE_4 0x100 /* scroll wheel down */
1842# define MOUSE_5 0x200 /* scroll wheel up */
1843
1844# define MOUSE_X1 0x300 /* Mouse-button X1 (6th) */
1845# define MOUSE_X2 0x400 /* Mouse-button X2 */
1846
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +02001847# define MOUSE_6 0x500 /* scroll wheel left */
1848# define MOUSE_7 0x600 /* scroll wheel right */
1849
Bram Moolenaar071d4272004-06-13 20:20:40 +00001850/* 0x20 is reserved by xterm */
1851# define MOUSE_DRAG_XTERM 0x40
1852
1853# define MOUSE_DRAG (0x40 | MOUSE_RELEASE)
1854
1855/* Lowest button code for using the mouse wheel (xterm only) */
1856# define MOUSEWHEEL_LOW 0x60
1857
1858# define MOUSE_CLICK_MASK 0x03
1859
1860# define NUM_MOUSE_CLICKS(code) \
1861 (((unsigned)((code) & 0xC0) >> 6) + 1)
1862
1863# define SET_NUM_MOUSE_CLICKS(code, num) \
1864 (code) = ((code) & 0x3f) | ((((num) - 1) & 3) << 6)
1865
Bram Moolenaar6f3058f2005-04-24 21:58:05 +00001866/* Added to mouse column for GUI when 'mousefocus' wants to give focus to a
1867 * window by simulating a click on its status line. We could use up to 128 *
1868 * 128 = 16384 columns, now it's reduced to 10000. */
1869# define MOUSE_COLOFF 10000
1870
Bram Moolenaar071d4272004-06-13 20:20:40 +00001871/*
1872 * jump_to_mouse() returns one of first four these values, possibly with
1873 * some of the other three added.
1874 */
1875# define IN_UNKNOWN 0
1876# define IN_BUFFER 1
1877# define IN_STATUS_LINE 2 /* on status or command line */
1878# define IN_SEP_LINE 4 /* on vertical separator line */
1879# define IN_OTHER_WIN 8 /* in other window but can't go there */
1880# define CURSOR_MOVED 0x100
1881# define MOUSE_FOLD_CLOSE 0x200 /* clicked on '-' in fold column */
1882# define MOUSE_FOLD_OPEN 0x400 /* clicked on '+' in fold column */
1883
1884/* flags for jump_to_mouse() */
1885# define MOUSE_FOCUS 0x01 /* need to stay in this window */
1886# define MOUSE_MAY_VIS 0x02 /* may start Visual mode */
1887# define MOUSE_DID_MOVE 0x04 /* only act when mouse has moved */
1888# define MOUSE_SETPOS 0x08 /* only set current mouse position */
1889# define MOUSE_MAY_STOP_VIS 0x10 /* may stop Visual mode */
1890# define MOUSE_RELEASED 0x20 /* button was released */
1891
1892# if defined(UNIX) && defined(HAVE_GETTIMEOFDAY) && defined(HAVE_SYS_TIME_H)
1893# define CHECK_DOUBLE_CLICK 1 /* Checking for double clicks ourselves. */
1894# endif
1895
1896#endif /* FEAT_MOUSE */
1897
1898/* defines for eval_vars() */
1899#define VALID_PATH 1
1900#define VALID_HEAD 2
1901
1902/* Defines for Vim variables. These must match vimvars[] in eval.c! */
1903#define VV_COUNT 0
1904#define VV_COUNT1 1
1905#define VV_PREVCOUNT 2
1906#define VV_ERRMSG 3
1907#define VV_WARNINGMSG 4
1908#define VV_STATUSMSG 5
1909#define VV_SHELL_ERROR 6
1910#define VV_THIS_SESSION 7
1911#define VV_VERSION 8
1912#define VV_LNUM 9
1913#define VV_TERMRESPONSE 10
1914#define VV_FNAME 11
1915#define VV_LANG 12
1916#define VV_LC_TIME 13
1917#define VV_CTYPE 14
1918#define VV_CC_FROM 15
1919#define VV_CC_TO 16
1920#define VV_FNAME_IN 17
1921#define VV_FNAME_OUT 18
1922#define VV_FNAME_NEW 19
1923#define VV_FNAME_DIFF 20
1924#define VV_CMDARG 21
1925#define VV_FOLDSTART 22
1926#define VV_FOLDEND 23
1927#define VV_FOLDDASHES 24
1928#define VV_FOLDLEVEL 25
1929#define VV_PROGNAME 26
1930#define VV_SEND_SERVER 27
1931#define VV_DYING 28
1932#define VV_EXCEPTION 29
1933#define VV_THROWPOINT 30
1934#define VV_REG 31
1935#define VV_CMDBANG 32
Bram Moolenaar843ee412004-06-30 16:16:41 +00001936#define VV_INSERTMODE 33
Bram Moolenaar6d14ccd2005-01-15 22:08:30 +00001937#define VV_VAL 34
1938#define VV_KEY 35
Bram Moolenaar05159a02005-02-26 23:04:13 +00001939#define VV_PROFILING 36
Bram Moolenaar19a09a12005-03-04 23:39:37 +00001940#define VV_FCS_REASON 37
1941#define VV_FCS_CHOICE 38
Bram Moolenaar52b4b552005-03-07 23:00:57 +00001942#define VV_BEVAL_BUFNR 39
1943#define VV_BEVAL_WINNR 40
Bram Moolenaarc9721bd2016-06-04 17:41:03 +02001944#define VV_BEVAL_WINID 41
1945#define VV_BEVAL_LNUM 42
1946#define VV_BEVAL_COL 43
1947#define VV_BEVAL_TEXT 44
1948#define VV_SCROLLSTART 45
1949#define VV_SWAPNAME 46
1950#define VV_SWAPCHOICE 47
1951#define VV_SWAPCOMMAND 48
1952#define VV_CHAR 49
1953#define VV_MOUSE_WIN 50
Bram Moolenaar511972d2016-06-04 18:09:59 +02001954#define VV_MOUSE_WINID 51
1955#define VV_MOUSE_LNUM 52
1956#define VV_MOUSE_COL 53
1957#define VV_OP 54
1958#define VV_SEARCHFORWARD 55
1959#define VV_HLSEARCH 56
1960#define VV_OLDFILES 57
1961#define VV_WINDOWID 58
1962#define VV_PROGPATH 59
1963#define VV_COMPLETED_ITEM 60
1964#define VV_OPTION_NEW 61
1965#define VV_OPTION_OLD 62
1966#define VV_OPTION_TYPE 63
1967#define VV_ERRORS 64
1968#define VV_FALSE 65
1969#define VV_TRUE 66
1970#define VV_NULL 67
1971#define VV_NONE 68
1972#define VV_VIM_DID_ENTER 69
1973#define VV_TESTING 70
Bram Moolenaarf562e722016-07-19 17:25:25 +02001974#define VV_TYPE_NUMBER 71
1975#define VV_TYPE_STRING 72
1976#define VV_TYPE_FUNC 73
1977#define VV_TYPE_LIST 74
1978#define VV_TYPE_DICT 75
1979#define VV_TYPE_FLOAT 76
1980#define VV_TYPE_BOOL 77
1981#define VV_TYPE_NONE 78
1982#define VV_TYPE_JOB 79
1983#define VV_TYPE_CHANNEL 80
1984#define VV_LEN 81 /* number of v: vars */
Bram Moolenaar520e1e42016-01-23 19:46:28 +01001985
1986/* used for v_number in VAR_SPECIAL */
1987#define VVAL_FALSE 0L
1988#define VVAL_TRUE 1L
1989#define VVAL_NONE 2L
1990#define VVAL_NULL 3L
Bram Moolenaar071d4272004-06-13 20:20:40 +00001991
Bram Moolenaarf562e722016-07-19 17:25:25 +02001992/* Type values for type(). */
1993#define VAR_TYPE_NUMBER 0
1994#define VAR_TYPE_STRING 1
1995#define VAR_TYPE_FUNC 2
1996#define VAR_TYPE_LIST 3
1997#define VAR_TYPE_DICT 4
1998#define VAR_TYPE_FLOAT 5
1999#define VAR_TYPE_BOOL 6
2000#define VAR_TYPE_NONE 7
2001#define VAR_TYPE_JOB 8
2002#define VAR_TYPE_CHANNEL 9
2003
Bram Moolenaar071d4272004-06-13 20:20:40 +00002004#ifdef FEAT_CLIPBOARD
2005
2006/* VIM_ATOM_NAME is the older Vim-specific selection type for X11. Still
2007 * supported for when a mix of Vim versions is used. VIMENC_ATOM_NAME includes
2008 * the encoding to support Vims using different 'encoding' values. */
Bram Moolenaar08ed30e2013-01-17 17:17:26 +01002009# define VIM_ATOM_NAME "_VIM_TEXT"
2010# define VIMENC_ATOM_NAME "_VIMENC_TEXT"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002011
2012/* Selection states for modeless selection */
2013# define SELECT_CLEARED 0
2014# define SELECT_IN_PROGRESS 1
2015# define SELECT_DONE 2
2016
2017# define SELECT_MODE_CHAR 0
2018# define SELECT_MODE_WORD 1
2019# define SELECT_MODE_LINE 2
2020
2021# ifdef FEAT_GUI_W32
2022# ifdef FEAT_OLE
2023# define WM_OLE (WM_APP+0)
2024# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002025# endif
2026
2027/* Info about selected text */
2028typedef struct VimClipboard
2029{
2030 int available; /* Is clipboard available? */
2031 int owned; /* Flag: do we own the selection? */
2032 pos_T start; /* Start of selected area */
2033 pos_T end; /* End of selected area */
2034 int vmode; /* Visual mode character */
2035
2036 /* Fields for selection that doesn't use Visual mode */
2037 short_u origin_row;
2038 short_u origin_start_col;
2039 short_u origin_end_col;
2040 short_u word_start_col;
2041 short_u word_end_col;
2042
2043 pos_T prev; /* Previous position */
2044 short_u state; /* Current selection state */
2045 short_u mode; /* Select by char, word, or line. */
2046
2047# if defined(FEAT_GUI_X11) || defined(FEAT_XCLIPBOARD)
2048 Atom sel_atom; /* PRIMARY/CLIPBOARD selection ID */
2049# endif
2050
2051# ifdef FEAT_GUI_GTK
2052 GdkAtom gtk_sel_atom; /* PRIMARY/CLIPBOARD selection ID */
2053# endif
2054
Bram Moolenaar693e40c2013-02-26 14:56:42 +01002055# if defined(MSWIN) || defined(FEAT_CYGWIN_WIN32_CLIPBOARD)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002056 int_u format; /* Vim's own special clipboard format */
2057 int_u format_raw; /* Vim's raw text clipboard format */
2058# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002059} VimClipboard;
2060#else
2061typedef int VimClipboard; /* This is required for the prototypes. */
2062#endif
2063
2064#ifdef __BORLANDC__
2065/* work around a bug in the Borland 'stat' function: */
2066# include <io.h> /* for access() */
2067
2068# define stat(a,b) (access(a,0) ? -1 : stat(a,b))
2069#endif
2070
Bram Moolenaar8767f522016-07-01 17:17:39 +02002071/* Use 64-bit stat structure if available. */
2072#if (defined(_MSC_VER) && (_MSC_VER >= 1300)) || defined(__MINGW32__)
2073# define HAVE_STAT64
2074typedef struct _stat64 stat_T;
2075#else
2076typedef struct stat stat_T;
2077#endif
2078
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02002079typedef enum
2080{
2081 ASSERT_EQUAL,
2082 ASSERT_NOTEQUAL,
2083 ASSERT_MATCH,
2084 ASSERT_NOTMATCH,
2085 ASSERT_OTHER
2086} assert_type_T;
2087
Bram Moolenaar071d4272004-06-13 20:20:40 +00002088#include "ex_cmds.h" /* Ex command defines */
Bram Moolenaar6cfdb2a2016-07-19 17:01:31 +02002089#include "spell.h" /* spell checking stuff */
2090
Bram Moolenaar071d4272004-06-13 20:20:40 +00002091#include "proto.h" /* function prototypes */
2092
2093/* This has to go after the include of proto.h, as proto/gui.pro declares
2094 * functions of these names. The declarations would break if the defines had
2095 * been seen at that stage. But it must be before globals.h, where error_ga
2096 * is declared. */
2097#if !defined(FEAT_GUI_W32) && !defined(FEAT_GUI_X11) \
Bram Moolenaarcef9dcc2005-12-06 19:50:41 +00002098 && !defined(FEAT_GUI_GTK) && !defined(FEAT_GUI_MAC)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002099# define mch_errmsg(str) fprintf(stderr, "%s", (str))
2100# define display_errors() fflush(stderr)
2101# define mch_msg(str) printf("%s", (str))
2102#else
2103# define USE_MCH_ERRMSG
2104#endif
2105
Bram Moolenaaraab21c32005-01-25 21:46:35 +00002106#ifndef FEAT_MBYTE
2107# define after_pathsep(b, p) vim_ispathsep(*((p) - 1))
2108# define transchar_byte(c) transchar(c)
2109#endif
2110
2111#ifndef FEAT_LINEBREAK
2112/* Without the 'numberwidth' option line numbers are always 7 chars. */
2113# define number_width(x) 7
2114#endif
2115
2116
Bram Moolenaar071d4272004-06-13 20:20:40 +00002117#include "globals.h" /* global variables and messages */
2118
Bram Moolenaar071d4272004-06-13 20:20:40 +00002119#ifndef FEAT_VIRTUALEDIT
2120# define getvvcol(w, p, s, c, e) getvcol(w, p, s, c, e)
Bram Moolenaar76440e22014-11-27 19:14:49 +01002121# define virtual_active() FALSE
Bram Moolenaar071d4272004-06-13 20:20:40 +00002122# define virtual_op FALSE
2123#endif
2124
2125/*
2126 * If console dialog not supported, but GUI dialog is, use the GUI one.
2127 */
2128#if defined(FEAT_GUI_DIALOG) && !defined(FEAT_CON_DIALOG)
2129# define do_dialog gui_mch_dialog
2130#endif
2131
2132/*
2133 * Default filters for gui_mch_browse().
2134 * The filters are almost system independent. Except for the difference
2135 * between "*" and "*.*" for MSDOS-like systems.
2136 * NOTE: Motif only uses the very first pattern. Therefore
2137 * BROWSE_FILTER_DEFAULT should start with a "*" pattern.
2138 */
2139#ifdef FEAT_BROWSE
2140# ifdef BACKSLASH_IN_FILENAME
2141# define BROWSE_FILTER_MACROS \
2142 (char_u *)"Vim macro files (*.vim)\t*.vim\nAll Files (*.*)\t*.*\n"
2143# define BROWSE_FILTER_ALL_FILES (char_u *)"All Files (*.*)\t*.*\n"
2144# define BROWSE_FILTER_DEFAULT \
2145 (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"
2146# else
2147# define BROWSE_FILTER_MACROS \
2148 (char_u *)"Vim macro files (*.vim)\t*.vim\nAll Files (*)\t*\n"
2149# define BROWSE_FILTER_ALL_FILES (char_u *)"All Files (*)\t*\n"
2150# define BROWSE_FILTER_DEFAULT \
2151 (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"
2152# endif
Bram Moolenaar7171abe2004-10-11 10:06:20 +00002153# define BROWSE_SAVE 1 /* flag for do_browse() */
2154# define BROWSE_DIR 2 /* flag for do_browse() */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155#endif
2156
2157/* stop using fastcall for Borland */
2158#if defined(__BORLANDC__) && defined(WIN32) && !defined(DEBUG)
Bram Moolenaaraab21c32005-01-25 21:46:35 +00002159 #pragma option -p.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002160#endif
2161
Bram Moolenaar442b4222010-05-24 21:34:22 +02002162#ifdef _MSC_VER
2163/* Avoid useless warning "conversion from X to Y of greater size". */
2164 #pragma warning(disable : 4312)
Bram Moolenaareb292852015-02-10 18:47:58 +01002165/* Avoid warning for old style function declarators */
2166 #pragma warning(disable : 4131)
2167/* Avoid warning for conversion to type with smaller range */
2168 #pragma warning(disable : 4244)
2169/* Avoid warning for conversion to larger size */
2170 #pragma warning(disable : 4306)
2171/* Avoid warning for unreferenced formal parameter */
2172 #pragma warning(disable : 4100)
2173/* Avoid warning for differs in indirection to slightly different base type */
2174 #pragma warning(disable : 4057)
2175/* Avoid warning for constant conditional expression */
2176 #pragma warning(disable : 4127)
2177/* Avoid warning for assignment within conditional */
2178 #pragma warning(disable : 4706)
Bram Moolenaar442b4222010-05-24 21:34:22 +02002179#endif
2180
Bram Moolenaar9a920d82012-06-01 15:21:02 +02002181/* Note: a NULL argument for vim_realloc() is not portable, don't use it. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002182#if defined(MEM_PROFILE)
2183# define vim_realloc(ptr, size) mem_realloc((ptr), (size))
2184#else
2185# define vim_realloc(ptr, size) realloc((ptr), (size))
2186#endif
2187
2188/*
Bram Moolenaar34162142007-05-12 13:12:19 +00002189 * The following macros stop display/event loop nesting at the wrong time.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002190 */
2191#ifdef ALT_X_INPUT
2192# define ALT_INPUT_LOCK_OFF suppress_alternate_input = FALSE
2193# define ALT_INPUT_LOCK_ON suppress_alternate_input = TRUE
2194#endif
2195
2196#ifdef FEAT_MBYTE
Bram Moolenaar071d4272004-06-13 20:20:40 +00002197/*
2198 * Return byte length of character that starts with byte "b".
2199 * Returns 1 for a single-byte character.
2200 * MB_BYTE2LEN_CHECK() can be used to count a special key as one byte.
2201 * Don't call MB_BYTE2LEN(b) with b < 0 or b > 255!
2202 */
2203# define MB_BYTE2LEN(b) mb_bytelen_tab[b]
2204# define MB_BYTE2LEN_CHECK(b) (((b) < 0 || (b) > 255) ? 1 : mb_bytelen_tab[b])
2205#endif
2206
2207#if defined(FEAT_MBYTE) || defined(FEAT_POSTSCRIPT)
2208/* properties used in enc_canon_table[] (first three mutually exclusive) */
2209# define ENC_8BIT 0x01
2210# define ENC_DBCS 0x02
2211# define ENC_UNICODE 0x04
2212
2213# define ENC_ENDIAN_B 0x10 /* Unicode: Big endian */
2214# define ENC_ENDIAN_L 0x20 /* Unicode: Little endian */
2215
2216# define ENC_2BYTE 0x40 /* Unicode: UCS-2 */
2217# define ENC_4BYTE 0x80 /* Unicode: UCS-4 */
2218# define ENC_2WORD 0x100 /* Unicode: UTF-16 */
2219
2220# define ENC_LATIN1 0x200 /* Latin1 */
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00002221# define ENC_LATIN9 0x400 /* Latin9 */
2222# define ENC_MACROMAN 0x800 /* Mac Roman (not Macro Man! :-) */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002223#endif
2224
2225#ifdef FEAT_MBYTE
2226# ifdef USE_ICONV
2227# ifndef EILSEQ
2228# define EILSEQ 123
2229# endif
2230# ifdef DYNAMIC_ICONV
2231/* On Win32 iconv.dll is dynamically loaded. */
2232# define ICONV_ERRNO (*iconv_errno())
2233# define ICONV_E2BIG 7
2234# define ICONV_EINVAL 22
2235# define ICONV_EILSEQ 42
2236# else
2237# define ICONV_ERRNO errno
2238# define ICONV_E2BIG E2BIG
2239# define ICONV_EINVAL EINVAL
2240# define ICONV_EILSEQ EILSEQ
2241# endif
2242# endif
2243
2244#endif
2245
2246/* ISSYMLINK(mode) tests if a file is a symbolic link. */
2247#if (defined(S_IFMT) && defined(S_IFLNK)) || defined(S_ISLNK)
2248# define HAVE_ISSYMLINK
2249# if defined(S_IFMT) && defined(S_IFLNK)
2250# define ISSYMLINK(mode) (((mode) & S_IFMT) == S_IFLNK)
2251# else
2252# define ISSYMLINK(mode) S_ISLNK(mode)
2253# endif
2254#endif
2255
2256#define SIGN_BYTE 1 /* byte value used where sign is displayed;
2257 attribute value is sign type */
2258
2259#ifdef FEAT_NETBEANS_INTG
2260# define MULTISIGN_BYTE 2 /* byte value used where sign is displayed if
2261 multiple signs exist on the line */
2262#endif
2263
2264#if defined(FEAT_GUI) && defined(FEAT_XCLIPBOARD)
2265# ifdef FEAT_GUI_GTK
2266 /* Avoid using a global variable for the X display. It's ugly
2267 * and is likely to cause trouble in multihead environments. */
2268# define X_DISPLAY ((gui.in_use) ? gui_mch_get_display() : xterm_dpy)
2269# else
2270# define X_DISPLAY (gui.in_use ? gui.dpy : xterm_dpy)
2271# endif
2272#else
2273# ifdef FEAT_GUI
2274# ifdef FEAT_GUI_GTK
2275# define X_DISPLAY ((gui.in_use) ? gui_mch_get_display() : (Display *)NULL)
2276# else
2277# define X_DISPLAY gui.dpy
2278# endif
2279# else
2280# define X_DISPLAY xterm_dpy
2281# endif
2282#endif
2283
Bram Moolenaar77c604d2012-07-10 13:41:14 +02002284#if defined(FEAT_BROWSE) && defined(GTK_CHECK_VERSION)
2285# if GTK_CHECK_VERSION(2,4,0)
2286# define USE_FILE_CHOOSER
2287# endif
2288#endif
2289
Bram Moolenaar03005972008-11-20 13:12:36 +00002290#ifndef FEAT_NETBEANS_INTG
2291# undef NBDEBUG
2292#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002293#ifdef NBDEBUG /* Netbeans debugging. */
2294# include "nbdebug.h"
2295#else
2296# define nbdebug(a)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002297#endif
2298
2299#ifdef IN_PERL_FILE
2300 /*
2301 * Avoid clashes between Perl and Vim namespace.
2302 */
2303# undef NORMAL
2304# undef STRLEN
2305# undef FF
2306# undef OP_DELETE
2307# undef OP_JOIN
2308# ifdef __BORLANDC__
2309# define NOPROTO 1
2310# endif
2311 /* remove MAX and MIN, included by glib.h, redefined by sys/param.h */
2312# ifdef MAX
2313# undef MAX
2314# endif
2315# ifdef MIN
2316# undef MIN
2317# endif
2318 /* We use _() for gettext(), Perl uses it for function prototypes... */
2319# ifdef _
2320# undef _
2321# endif
2322# ifdef DEBUG
2323# undef DEBUG
2324# endif
2325# ifdef _DEBUG
2326# undef _DEBUG
2327# endif
2328# ifdef instr
2329# undef instr
2330# endif
Bram Moolenaared39e1d2008-08-09 17:55:22 +00002331 /* bool may cause trouble on MACOS but is required on a few other systems
2332 * and for Perl */
2333# if defined(bool) && defined(MACOS) && !defined(FEAT_PERL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002334# undef bool
2335# endif
2336
2337# ifdef __BORLANDC__
2338 /* Borland has the structure stati64 but not _stati64 */
2339# define _stati64 stati64
2340# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002341#endif
2342
Bram Moolenaar5eba4c22005-07-12 22:40:29 +00002343/* values for vim_handle_signal() that are not a signal */
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00002344#define SIGNAL_BLOCK -1
2345#define SIGNAL_UNBLOCK -2
Bram Moolenaare7fedb62015-12-31 19:07:19 +01002346#if !defined(UNIX) && !defined(VMS)
Bram Moolenaar5eba4c22005-07-12 22:40:29 +00002347# define vim_handle_signal(x) 0
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002348#endif
2349
Bram Moolenaar05159a02005-02-26 23:04:13 +00002350/* flags for skip_vimgrep_pat() */
2351#define VGR_GLOBAL 1
2352#define VGR_NOJUMP 2
2353
Bram Moolenaarb0bf8582005-12-13 20:02:15 +00002354/* behavior for bad character, "++bad=" argument */
2355#define BAD_REPLACE '?' /* replace it with '?' (default) */
2356#define BAD_KEEP -1 /* leave it */
2357#define BAD_DROP -2 /* erase it */
2358
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002359/* last argument for do_source() */
2360#define DOSO_NONE 0
2361#define DOSO_VIMRC 1 /* loading vimrc file */
2362#define DOSO_GVIMRC 2 /* loading gvimrc file */
Bram Moolenaar371d5402006-03-20 21:47:49 +00002363
Bram Moolenaard812df62008-11-09 12:46:09 +00002364/* flags for read_viminfo() and children */
2365#define VIF_WANT_INFO 1 /* load non-mark info */
2366#define VIF_WANT_MARKS 2 /* load file marks */
2367#define VIF_FORCEIT 4 /* overwrite info already read */
2368#define VIF_GET_OLDFILES 8 /* load v:oldfiles */
2369
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002370/* flags for buf_freeall() */
2371#define BFA_DEL 1 /* buffer is going to be deleted */
2372#define BFA_WIPE 2 /* buffer is going to be wiped out */
2373#define BFA_KEEP_UNDO 4 /* do not free undo information */
2374
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +02002375/* direction for nv_mousescroll() and ins_mousescroll() */
2376#define MSCR_DOWN 0 /* DOWN must be FALSE */
2377#define MSCR_UP 1
2378#define MSCR_LEFT -1
2379#define MSCR_RIGHT -2
2380
Bram Moolenaar946ffd42010-12-30 12:30:31 +01002381#define KEYLEN_PART_KEY -1 /* keylen value for incomplete key-code */
2382#define KEYLEN_PART_MAP -2 /* keylen value for incomplete mapping */
2383#define KEYLEN_REMOVED 9999 /* keylen value for removed sequence */
2384
Bram Moolenaar1c32dff2011-05-05 16:41:24 +02002385/* Return values from win32_fileinfo(). */
2386#define FILEINFO_OK 0
2387#define FILEINFO_ENC_FAIL 1 /* enc_to_utf16() failed */
2388#define FILEINFO_READ_FAIL 2 /* CreateFile() failed */
2389#define FILEINFO_INFO_FAIL 3 /* GetFileInformationByHandle() failed */
2390
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02002391/* Return value from get_option_value_strict */
2392#define SOPT_BOOL 0x01 /* Boolean option */
2393#define SOPT_NUM 0x02 /* Number option */
2394#define SOPT_STRING 0x04 /* String option */
2395#define SOPT_GLOBAL 0x08 /* Option has global value */
2396#define SOPT_WIN 0x10 /* Option has window-local value */
2397#define SOPT_BUF 0x20 /* Option has buffer-local value */
2398#define SOPT_UNSET 0x40 /* Option does not have local value set */
2399
Bram Moolenaar1028f4d2014-01-14 16:55:00 +01002400/* Option types for various functions in option.c */
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02002401#define SREQ_GLOBAL 0 /* Request global option */
2402#define SREQ_WIN 1 /* Request window-local option */
2403#define SREQ_BUF 2 /* Request buffer-local option */
2404
Bram Moolenaarb7cb42b2014-04-02 19:55:10 +02002405/* Flags for get_reg_contents */
2406#define GREG_NO_EXPR 1 /* Do not allow expression register */
2407#define GREG_EXPR_SRC 2 /* Return expression itself for "=" register */
2408#define GREG_LIST 4 /* Return list */
2409
Bram Moolenaar018acca2013-05-30 13:37:28 +02002410/* Character used as separated in autoload function/variable names. */
2411#define AUTOLOAD_CHAR '#'
2412
Bram Moolenaar8050efa2013-11-08 04:30:20 +01002413#ifdef FEAT_EVAL
Bram Moolenaar76440e22014-11-27 19:14:49 +01002414# define SET_NO_HLSEARCH(flag) no_hlsearch = (flag); set_vim_var_nr(VV_HLSEARCH, !no_hlsearch && p_hls)
Bram Moolenaar8050efa2013-11-08 04:30:20 +01002415#else
2416# define SET_NO_HLSEARCH(flag) no_hlsearch = (flag)
2417#endif
2418
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01002419#ifdef FEAT_JOB_CHANNEL
Bram Moolenaare0874f82016-01-24 20:36:41 +01002420# define MAX_OPEN_CHANNELS 10
2421#else
2422# define MAX_OPEN_CHANNELS 0
2423#endif
2424
Bram Moolenaar595e64e2016-02-07 19:19:53 +01002425/* Options for json_encode() and json_decode. */
2426#define JSON_JS 1 /* use JS instead of JSON */
2427#define JSON_NO_NONE 2 /* v:none item not allowed */
2428
Bram Moolenaar4349c572016-01-30 13:28:28 +01002429#ifdef FEAT_MZSCHEME
2430/* this is in main.c, cproto can't handle it. */
2431int vim_main2(int argc, char **argv);
2432#endif
2433
Bram Moolenaar6bef5302016-03-12 21:28:26 +01002434/* Used for flags of do_in_path() */
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01002435#define DIP_ALL 0x01 /* all matches, not just the first one */
2436#define DIP_DIR 0x02 /* find directories instead of files. */
2437#define DIP_ERR 0x04 /* give an error message when none found. */
2438#define DIP_START 0x08 /* also use "start" directory in 'packpath' */
2439#define DIP_OPT 0x10 /* also use "opt" directory in 'packpath' */
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01002440#define DIP_NORTP 0x20 /* do not use 'runtimepath' */
Bram Moolenaar6bef5302016-03-12 21:28:26 +01002441
Bram Moolenaar888ccac2016-06-04 18:49:36 +02002442/* Lowest number used for window ID. Cannot have this many windows. */
2443#define LOWEST_WIN_ID 1000
2444
Bram Moolenaarcd524592016-07-17 14:57:05 +02002445/* Used by the garbage collector. */
2446#define COPYID_INC 2
2447#define COPYID_MASK (~0x1)
2448
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002449/* Values for trans_function_name() argument: */
2450#define TFN_INT 1 /* internal function name OK */
2451#define TFN_QUIET 2 /* no error messages */
2452#define TFN_NO_AUTOLOAD 4 /* do not use script autoloading */
2453
2454/* Values for get_lval() flags argument: */
2455#define GLV_QUIET TFN_QUIET /* no error messages */
2456#define GLV_NO_AUTOLOAD TFN_NO_AUTOLOAD /* do not use script autoloading */
2457
2458#define DO_NOT_FREE_CNT 99999 /* refcount for dict or list that should not
2459 be freed. */
2460
2461/* errors for when calling a function */
2462#define ERROR_UNKNOWN 0
2463#define ERROR_TOOMANY 1
2464#define ERROR_TOOFEW 2
2465#define ERROR_SCRIPT 3
2466#define ERROR_DICT 4
2467#define ERROR_NONE 5
2468#define ERROR_OTHER 6
2469
2470/* flags for find_name_end() */
2471#define FNE_INCL_BR 1 /* include [] in name */
2472#define FNE_CHECK_START 2 /* check name starts with valid character */
2473
Bram Moolenaar071d4272004-06-13 20:20:40 +00002474#endif /* VIM__H */