blob: 34a8650c4900c698ad51d7f1897c8150d3b327a7 [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
101#endif
102#if defined(MACOS_X) || defined(MACOS_CLASSIC)
Bram Moolenaar08ed30e2013-01-17 17:17:26 +0100103# define MACOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000104#endif
105#if defined(MACOS_X) && defined(MACOS_CLASSIC)
106 Error: To compile for both MACOS X and Classic use a Classic Carbon
107#endif
108/* Unless made through the Makefile enforce GUI on Mac */
109#if defined(MACOS) && !defined(HAVE_CONFIG_H)
110# define FEAT_GUI_MAC
111#endif
112
Bram Moolenaar071d4272004-06-13 20:20:40 +0000113#if defined(FEAT_GUI_MOTIF) \
114 || defined(FEAT_GUI_GTK) \
115 || defined(FEAT_GUI_ATHENA) \
116 || defined(FEAT_GUI_MAC) \
117 || defined(FEAT_GUI_W32) \
Bram Moolenaarcef9dcc2005-12-06 19:50:41 +0000118 || defined(FEAT_GUI_PHOTON)
Bram Moolenaar9a4d7fd2011-06-13 02:04:00 +0200119# define FEAT_GUI_ENABLED /* also defined with NO_X11_INCLUDES */
Bram Moolenaarab79bcb2004-07-18 21:34:53 +0000120# if !defined(FEAT_GUI) && !defined(NO_X11_INCLUDES)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000121# define FEAT_GUI
122# endif
123#endif
124
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +0200125/* Check support for rendering options */
126#ifdef FEAT_GUI
127# if defined(FEAT_DIRECTX)
128# define FEAT_RENDER_OPTIONS
129# endif
130#endif
131
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000132/* Visual Studio 2005 has 'deprecated' many of the standard CRT functions */
133#if _MSC_VER >= 1400
134# define _CRT_SECURE_NO_DEPRECATE
135# define _CRT_NONSTDC_NO_DEPRECATE
136#endif
137
Bram Moolenaare89ff042016-02-20 22:17:05 +0100138#if defined(FEAT_GUI_W32)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000139# define FEAT_GUI_MSWIN
140#endif
Bram Moolenaarcf7164a2016-02-20 13:55:06 +0100141#if defined(WIN32) || defined(_WIN64)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000142# define MSWIN
143#endif
144/* Practically everything is common to both Win32 and Win64 */
145#if defined(WIN32) || defined(_WIN64)
146# define WIN3264
147#endif
148
149/*
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100150 * VIM_SIZEOF_INT is used in feature.h, and the system-specific included files
151 * need items from feature.h. Therefore define VIM_SIZEOF_INT here.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152 */
153#ifdef WIN3264
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100154# define VIM_SIZEOF_INT 4
Bram Moolenaar071d4272004-06-13 20:20:40 +0000155#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000156
157#ifdef AMIGA
158 /* Be conservative about sizeof(int). It could be 4 too. */
159# ifndef FEAT_GUI_GTK /* avoid problems when generating prototypes */
160# ifdef __GNUC__
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100161# define VIM_SIZEOF_INT 4
Bram Moolenaar071d4272004-06-13 20:20:40 +0000162# else
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100163# define VIM_SIZEOF_INT 2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000164# endif
165# endif
166#endif
167#ifdef MACOS
Bram Moolenaar2a0449d2006-02-20 21:27:21 +0000168# if defined(__POWERPC__) || defined(MACOS_X) || defined(__fourbyteints__) \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000169 || defined(__MRC__) || defined(__SC__) || defined(__APPLE_CC__)/* MPW Compilers */
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100170# define VIM_SIZEOF_INT 4
Bram Moolenaar071d4272004-06-13 20:20:40 +0000171# else
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100172# define VIM_SIZEOF_INT 2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000173# endif
174#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000175
176
Bram Moolenaarb822cb02016-07-30 14:12:23 +0200177/*
178 * #defines for optionals and features
179 * Also defines FEAT_TINY, FEAT_SMALL, etc. when FEAT_HUGE is defined.
180 */
181#include "feature.h"
182
183#if defined(MACOS_X_UNIX)
184# if defined(FEAT_SMALL) && !defined(FEAT_CLIPBOARD)
185# define FEAT_CLIPBOARD
186# endif
187# if defined(FEAT_SMALL) && !defined(FEAT_MOUSE)
188# define FEAT_MOUSE
189# endif
190#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000191
192/* +x11 is only enabled when it's both available and wanted. */
193#if defined(HAVE_X11) && defined(WANT_X11)
194# define FEAT_X11
195#endif
196
Bram Moolenaarab79bcb2004-07-18 21:34:53 +0000197#ifdef NO_X11_INCLUDES
Bram Moolenaar423f9722010-10-10 17:08:43 +0200198 /* In os_mac_conv.c and os_macosx.m NO_X11_INCLUDES is defined to avoid
199 * X11 headers. Disable all X11 related things to avoid conflicts. */
Bram Moolenaarab79bcb2004-07-18 21:34:53 +0000200# ifdef FEAT_X11
201# undef FEAT_X11
202# endif
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000203# ifdef FEAT_GUI_X11
204# undef FEAT_GUI_X11
205# endif
Bram Moolenaarab79bcb2004-07-18 21:34:53 +0000206# ifdef FEAT_XCLIPBOARD
207# undef FEAT_XCLIPBOARD
208# endif
209# ifdef FEAT_GUI_MOTIF
210# undef FEAT_GUI_MOTIF
211# endif
212# ifdef FEAT_GUI_ATHENA
213# undef FEAT_GUI_ATHENA
214# endif
215# ifdef FEAT_GUI_GTK
216# undef FEAT_GUI_GTK
217# endif
218# ifdef FEAT_BEVAL_TIP
219# undef FEAT_BEVAL_TIP
220# endif
221# ifdef FEAT_XIM
222# undef FEAT_XIM
223# endif
224# ifdef FEAT_CLIENTSERVER
225# undef FEAT_CLIENTSERVER
226# endif
227#endif
228
Bram Moolenaardb003512006-03-15 22:48:35 +0000229/* The Mac conversion stuff doesn't work under X11. */
230#if defined(FEAT_MBYTE) && defined(MACOS_X)
231# define MACOS_CONVERT
232#endif
233
Bram Moolenaar071d4272004-06-13 20:20:40 +0000234/* Can't use "PACKAGE" here, conflicts with a Perl include file. */
235#ifndef VIMPACKAGE
236# define VIMPACKAGE "vim"
237#endif
238
239/*
240 * Find out if function definitions should include argument types
241 */
242#ifdef AZTEC_C
243# include <functions.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +0000244#endif
245
246#ifdef SASC
247# include <clib/exec_protos.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +0000248#endif
249
250#ifdef _DCC
251# include <clib/exec_protos.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +0000252#endif
253
254#ifdef __BEOS__
255# include "os_beos.h"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000256#endif
257
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200258#if (defined(UNIX) || defined(VMS)) \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000259 && (!defined(MACOS_X) || defined(HAVE_CONFIG_H))
260# include "os_unix.h" /* bring lots of system header files */
261#endif
262
Bram Moolenaar0c094b92009-05-14 20:20:33 +0000263/* Mark unused function arguments with UNUSED, so that gcc -Wunused-parameter
264 * can be used to check for mistakes. */
265#ifdef HAVE_ATTRIBUTE_UNUSED
266# define UNUSED __attribute__((unused))
267#else
268# define UNUSED
269#endif
270
Bram Moolenaar843ee412004-06-30 16:16:41 +0000271/* if we're compiling in C++ (currently only KVim), the system
272 * headers must have the correct prototypes or nothing will build.
273 * conversely, our prototypes might clash due to throw() specifiers and
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000274 * cause compilation failures even though the headers are correct. For
Bram Moolenaar843ee412004-06-30 16:16:41 +0000275 * a concrete example, gcc-3.2 enforces exception specifications, and
276 * glibc-2.2.5 has them in their system headers.
277 */
278#if !defined(__cplusplus) && defined(UNIX) \
279 && !defined(MACOS_X) /* MACOS_X doesn't yet support osdef.h */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000280# include "auto/osdef.h" /* bring missing declarations in */
281#endif
282
Bram Moolenaar071d4272004-06-13 20:20:40 +0000283#ifdef AMIGA
284# include "os_amiga.h"
285#endif
286
Bram Moolenaar071d4272004-06-13 20:20:40 +0000287#ifdef WIN3264
288# include "os_win32.h"
289#endif
290
291#ifdef __MINT__
292# include "os_mint.h"
293#endif
294
295#if defined(MACOS)
296# if defined(__MRC__) || defined(__SC__) /* MPW Compilers */
297# define HAVE_SETENV
298# endif
299# include "os_mac.h"
300#endif
301
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302#ifdef __QNX__
303# include "os_qnx.h"
304#endif
305
306#ifdef FEAT_SUN_WORKSHOP
307# include "workshop.h"
308#endif
309
310#ifdef X_LOCALE
311# include <X11/Xlocale.h>
312#else
313# ifdef HAVE_LOCALE_H
314# include <locale.h>
315# endif
316#endif
317
318/*
319 * Maximum length of a path (for non-unix systems) Make it a bit long, to stay
320 * on the safe side. But not too long to put on the stack.
321 */
322#ifndef MAXPATHL
323# ifdef MAXPATHLEN
324# define MAXPATHL MAXPATHLEN
325# else
326# define MAXPATHL 256
327# endif
328#endif
329#ifdef BACKSLASH_IN_FILENAME
Bram Moolenaaraebaf892008-05-28 14:49:58 +0000330# define PATH_ESC_CHARS ((char_u *)" \t\n*?[{`%#'\"|!<")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000331#else
Bram Moolenaar03cd93a2008-11-20 09:27:32 +0000332# ifdef VMS
333 /* VMS allows a lot of characters in the file name */
334# define PATH_ESC_CHARS ((char_u *)" \t\n*?{`\\%#'\"|!")
335# define SHELL_ESC_CHARS ((char_u *)" \t\n*?{`\\%#'|!()&")
336# else
337# define PATH_ESC_CHARS ((char_u *)" \t\n*?[{`$\\%#'\"|!<")
338# define SHELL_ESC_CHARS ((char_u *)" \t\n*?[{`$\\%#'\"|!<>();&")
339# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000340#endif
341
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100342/* length of a buffer to store a number in ASCII (64 bits binary + NUL) */
343#define NUMBUFLEN 65
344
345/* flags for vim_str2nr() */
346#define STR2NR_BIN 1
347#define STR2NR_OCT 2
348#define STR2NR_HEX 4
349#define STR2NR_ALL (STR2NR_BIN + STR2NR_OCT + STR2NR_HEX)
350#define STR2NR_FORCE 8 /* only when ONE of the above is used */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000351
352/*
353 * Shorthand for unsigned variables. Many systems, but not all, have u_char
354 * already defined, so we use char_u to avoid trouble.
355 */
356typedef unsigned char char_u;
357typedef unsigned short short_u;
358typedef unsigned int int_u;
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000359/* Make sure long_u is big enough to hold a pointer.
Bram Moolenaare6a91fd2008-07-24 18:51:11 +0000360 * On Win64, longs are 32 bits and pointers are 64 bits.
361 * For printf() and scanf(), we need to take care of long_u specifically. */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000362#ifdef _WIN64
Bram Moolenaar55d5c032010-07-17 23:52:29 +0200363typedef unsigned __int64 long_u;
364typedef __int64 long_i;
Bram Moolenaarcb4cef22008-03-16 15:04:34 +0000365# define SCANF_HEX_LONG_U "%Ix"
366# define SCANF_DECIMAL_LONG_U "%Iu"
367# define PRINTF_HEX_LONG_U "0x%Ix"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000368#else
Bram Moolenaare6a91fd2008-07-24 18:51:11 +0000369 /* Microsoft-specific. The __w64 keyword should be specified on any typedefs
370 * that change size between 32-bit and 64-bit platforms. For any such type,
371 * __w64 should appear only on the 32-bit definition of the typedef.
372 * Define __w64 as an empty token for everything but MSVC 7.x or later.
373 */
374# if !defined(_MSC_VER) || (_MSC_VER < 1300)
Bram Moolenaar03cd93a2008-11-20 09:27:32 +0000375# define __w64
Bram Moolenaare6a91fd2008-07-24 18:51:11 +0000376# endif
377typedef unsigned long __w64 long_u;
378typedef long __w64 long_i;
Bram Moolenaarcb4cef22008-03-16 15:04:34 +0000379# define SCANF_HEX_LONG_U "%lx"
380# define SCANF_DECIMAL_LONG_U "%lu"
381# define PRINTF_HEX_LONG_U "0x%lx"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000382#endif
Bram Moolenaarcb4cef22008-03-16 15:04:34 +0000383#define PRINTF_DECIMAL_LONG_U SCANF_DECIMAL_LONG_U
Bram Moolenaar071d4272004-06-13 20:20:40 +0000384
385/*
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100386 * Only systems which use configure will have SIZEOF_OFF_T and VIM_SIZEOF_LONG
Bram Moolenaar914703b2010-05-31 21:59:46 +0200387 * defined, which is ok since those are the same systems which can have
388 * varying sizes for off_t. The other systems will continue to use "%ld" to
389 * print off_t since off_t is simply a typedef to long for them.
390 */
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100391#if defined(SIZEOF_OFF_T) && (SIZEOF_OFF_T > VIM_SIZEOF_LONG)
Bram Moolenaar914703b2010-05-31 21:59:46 +0200392# define LONG_LONG_OFF_T
393#endif
394
395/*
Bram Moolenaar8767f522016-07-01 17:17:39 +0200396 * We use 64-bit file functions here, if available. E.g. ftello() returns
397 * off_t instead of long, which helps if long is 32 bit and off_t is 64 bit.
398 * We assume that when fseeko() is available then ftello() is too.
399 * Note that Windows has different function names.
400 */
401#if (defined(_MSC_VER) && (_MSC_VER >= 1300)) || defined(__MINGW32__)
402typedef __int64 off_T;
403# ifdef __MINGW32__
404# define vim_lseek lseek64
405# define vim_fseek fseeko64
406# define vim_ftell ftello64
407# else
408# define vim_lseek _lseeki64
409# define vim_fseek _fseeki64
410# define vim_ftell _ftelli64
411# endif
412#else
413typedef off_t off_T;
414# ifdef HAVE_FSEEKO
415# define vim_lseek lseek
416# define vim_ftell ftello
417# define vim_fseek fseeko
418# else
419# define vim_lseek lseek
420# define vim_ftell ftell
421# define vim_fseek(a, b, c) fseek(a, (long)b, c)
422# endif
423#endif
424
425/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000426 * The characters and attributes cached for the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000427 */
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000428typedef char_u schar_T;
Bram Moolenaar3918c952005-03-15 22:34:55 +0000429#ifdef FEAT_SYN_HL
430typedef unsigned short sattr_T;
431# define MAX_TYPENR 65535
432#else
433typedef unsigned char sattr_T;
434# define MAX_TYPENR 255
435#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000436
437/*
438 * The u8char_T can hold one decoded UTF-8 character.
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000439 * We normally use 32 bits now, since some Asian characters don't fit in 16
440 * bits. u8char_T is only used for displaying, it could be 16 bits to save
441 * memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000442 */
443#ifdef FEAT_MBYTE
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000444# ifdef UNICODE16
445typedef unsigned short u8char_T; /* short should be 16 bits */
446# else
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100447# if VIM_SIZEOF_INT >= 4
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000448typedef unsigned int u8char_T; /* int is 32 bits */
449# else
450typedef unsigned long u8char_T; /* long should be 32 bits or more */
451# endif
452# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000453#endif
454
455#ifndef UNIX /* For Unix this is included in os_unix.h */
456# include <stdio.h>
457# include <ctype.h>
458#endif
459
460#include "ascii.h"
461#include "keymap.h"
462#include "term.h"
463#include "macros.h"
464
465#ifdef LATTICE
466# include <sys/types.h>
467# include <sys/stat.h>
468#endif
469#ifdef _DCC
470# include <sys/stat.h>
471#endif
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100472#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000473# include <sys/stat.h>
474#endif
475
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100476#if defined(HAVE_ERRNO_H) \
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200477 || defined(WIN32) || defined(_WIN64)
Bram Moolenaarb57aa922010-12-17 20:24:01 +0100478# include <errno.h>
479#endif
480
Bram Moolenaar071d4272004-06-13 20:20:40 +0000481/*
482 * Allow other (non-unix) systems to configure themselves now
483 * These are also in os_unix.h, because osdef.sh needs them there.
484 */
485#ifndef UNIX
486/* Note: Some systems need both string.h and strings.h (Savage). If the
487 * system can't handle this, define NO_STRINGS_WITH_STRING_H. */
488# ifdef HAVE_STRING_H
489# include <string.h>
490# endif
491# if defined(HAVE_STRINGS_H) && !defined(NO_STRINGS_WITH_STRING_H)
Bram Moolenaar08ed30e2013-01-17 17:17:26 +0100492# include <strings.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +0000493# endif
494# ifdef HAVE_STAT_H
495# include <stat.h>
496# endif
497# ifdef HAVE_STDLIB_H
498# include <stdlib.h>
499# endif
500#endif /* NON-UNIX */
501
502#include <assert.h>
503
Bram Moolenaarfa7584c2010-05-19 21:57:45 +0200504#ifdef HAVE_STDINT_H
505# include <stdint.h>
506#endif
507#ifdef HAVE_INTTYPES_H
508# include <inttypes.h>
509#endif
Bram Moolenaar8fef2ad2005-04-23 20:42:23 +0000510#ifdef HAVE_WCTYPE_H
511# include <wctype.h>
512#endif
Bram Moolenaarba4ef272016-01-30 21:48:49 +0100513#include <stdarg.h>
Bram Moolenaar8fef2ad2005-04-23 20:42:23 +0000514
Bram Moolenaar84026842016-07-17 20:37:43 +0200515/* for offsetof() */
516#include <stddef.h>
517
Bram Moolenaar08ed30e2013-01-17 17:17:26 +0100518#if defined(HAVE_SYS_SELECT_H) && \
Bram Moolenaar581f6dc2010-03-10 16:12:48 +0100519 (!defined(HAVE_SYS_TIME_H) || defined(SYS_SELECT_WITH_SYS_TIME))
Bram Moolenaar08ed30e2013-01-17 17:17:26 +0100520# include <sys/select.h>
521#endif
Bram Moolenaar581f6dc2010-03-10 16:12:48 +0100522
Bram Moolenaar08ed30e2013-01-17 17:17:26 +0100523#ifndef HAVE_SELECT
524# ifdef HAVE_SYS_POLL_H
525# include <sys/poll.h>
Bram Moolenaara8343c12016-02-04 22:09:48 +0100526# elif defined(WIN32)
Bram Moolenaarf12d9832016-01-29 21:11:25 +0100527# define HAVE_SELECT
Bram Moolenaar08ed30e2013-01-17 17:17:26 +0100528# else
529# ifdef HAVE_POLL_H
530# include <poll.h>
Bram Moolenaar581f6dc2010-03-10 16:12:48 +0100531# endif
532# endif
Bram Moolenaar08ed30e2013-01-17 17:17:26 +0100533#endif
Bram Moolenaar581f6dc2010-03-10 16:12:48 +0100534
Bram Moolenaar071d4272004-06-13 20:20:40 +0000535/* ================ end of the header file puzzle =============== */
536
537/*
538 * For dynamically loaded imm library. Currently, only for Win32.
539 */
540#ifdef DYNAMIC_IME
541# ifndef FEAT_MBYTE_IME
542# define FEAT_MBYTE_IME
543# endif
544#endif
545
546/*
547 * Check input method control.
548 */
Bram Moolenaar1b60e502008-03-12 13:40:54 +0000549#if defined(FEAT_XIM) \
550 || (defined(FEAT_GUI) && (defined(FEAT_MBYTE_IME) || defined(GLOBAL_IME))) \
Bram Moolenaar4c4f7102008-03-15 12:12:59 +0000551 || (defined(FEAT_GUI_MAC) && defined(FEAT_MBYTE))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000552# define USE_IM_CONTROL
553#endif
554
555/*
556 * For dynamically loaded gettext library. Currently, only for Win32.
557 */
558#ifdef DYNAMIC_GETTEXT
559# ifndef FEAT_GETTEXT
560# define FEAT_GETTEXT
561# endif
562/* These are in os_win32.c */
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000563extern char *(*dyn_libintl_gettext)(const char *msgid);
564extern char *(*dyn_libintl_bindtextdomain)(const char *domainname, const char *dirname);
565extern char *(*dyn_libintl_bind_textdomain_codeset)(const char *domainname, const char *codeset);
566extern char *(*dyn_libintl_textdomain)(const char *domainname);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000567#endif
568
569
570/*
571 * The _() stuff is for using gettext(). It is a no-op when libintl.h is not
572 * found or the +multilang feature is disabled.
573 */
574#ifdef FEAT_GETTEXT
575# ifdef DYNAMIC_GETTEXT
576# define _(x) (*dyn_libintl_gettext)((char *)(x))
577# define N_(x) x
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000578# define bindtextdomain(domain, dir) (*dyn_libintl_bindtextdomain)((domain), (dir))
579# define bind_textdomain_codeset(domain, codeset) (*dyn_libintl_bind_textdomain_codeset)((domain), (codeset))
580# if !defined(HAVE_BIND_TEXTDOMAIN_CODESET)
581# define HAVE_BIND_TEXTDOMAIN_CODESET 1
582# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000583# define textdomain(domain) (*dyn_libintl_textdomain)(domain)
584# else
585# include <libintl.h>
586# define _(x) gettext((char *)(x))
587# ifdef gettext_noop
588# define N_(x) gettext_noop(x)
589# else
590# define N_(x) x
591# endif
592# endif
593#else
594# define _(x) ((char *)(x))
595# define N_(x) x
596# ifdef bindtextdomain
597# undef bindtextdomain
598# endif
599# define bindtextdomain(x, y) /* empty */
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000600# ifdef bind_textdomain_codeset
601# undef bind_textdomain_codeset
602# endif
603# define bind_textdomain_codeset(x, y) /* empty */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000604# ifdef textdomain
605# undef textdomain
606# endif
607# define textdomain(x) /* empty */
608#endif
609
610/*
611 * flags for update_screen()
612 * The higher the value, the higher the priority
613 */
614#define VALID 10 /* buffer not changed, or changes marked
615 with b_mod_* */
616#define INVERTED 20 /* redisplay inverted part that changed */
617#define INVERTED_ALL 25 /* redisplay whole inverted part */
618#define REDRAW_TOP 30 /* display first w_upd_rows screen lines */
Bram Moolenaarf71a3db2006-03-12 21:50:18 +0000619#define SOME_VALID 35 /* like NOT_VALID but may scroll */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000620#define NOT_VALID 40 /* buffer needs complete redraw */
621#define CLEAR 50 /* screen messed up, clear it */
622
623/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000624 * Flags for w_valid.
625 * These are set when something in a window structure becomes invalid, except
626 * when the cursor is moved. Call check_cursor_moved() before testing one of
627 * the flags.
628 * These are reset when that thing has been updated and is valid again.
629 *
630 * Every function that invalidates one of these must call one of the
631 * invalidate_* functions.
632 *
633 * w_valid is supposed to be used only in screen.c. From other files, use the
634 * functions that set or reset the flags.
635 *
636 * VALID_BOTLINE VALID_BOTLINE_AP
637 * on on w_botline valid
638 * off on w_botline approximated
639 * off off w_botline not valid
640 * on off not possible
641 */
642#define VALID_WROW 0x01 /* w_wrow (window row) is valid */
643#define VALID_WCOL 0x02 /* w_wcol (window col) is valid */
644#define VALID_VIRTCOL 0x04 /* w_virtcol (file col) is valid */
645#define VALID_CHEIGHT 0x08 /* w_cline_height and w_cline_folded valid */
646#define VALID_CROW 0x10 /* w_cline_row is valid */
647#define VALID_BOTLINE 0x20 /* w_botine and w_empty_rows are valid */
648#define VALID_BOTLINE_AP 0x40 /* w_botine is approximated */
649#define VALID_TOPLINE 0x80 /* w_topline is valid (for cursor position) */
650
651/*
652 * Terminal highlighting attribute bits.
Bram Moolenaar42b4dda2010-03-02 15:56:05 +0100653 * Attributes above HL_ALL are used for syntax highlighting.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000654 */
655#define HL_NORMAL 0x00
656#define HL_INVERSE 0x01
657#define HL_BOLD 0x02
658#define HL_ITALIC 0x04
659#define HL_UNDERLINE 0x08
Bram Moolenaar3918c952005-03-15 22:34:55 +0000660#define HL_UNDERCURL 0x10
661#define HL_STANDOUT 0x20
662#define HL_ALL 0x3f
Bram Moolenaar071d4272004-06-13 20:20:40 +0000663
664/* special attribute addition: Put message in history */
665#define MSG_HIST 0x1000
666
667/*
668 * values for State
669 *
670 * The lower bits up to 0x20 are used to distinguish normal/visual/op_pending
671 * and cmdline/insert+replace mode. This is used for mapping. If none of
672 * these bits are set, no mapping is done.
673 * The upper bits are used to distinguish between other states.
674 */
675#define NORMAL 0x01 /* Normal mode, command expected */
676#define VISUAL 0x02 /* Visual mode - use get_real_state() */
677#define OP_PENDING 0x04 /* Normal mode, operator is pending - use
678 get_real_state() */
679#define CMDLINE 0x08 /* Editing command line */
680#define INSERT 0x10 /* Insert mode */
681#define LANGMAP 0x20 /* Language mapping, can be combined with
682 INSERT and CMDLINE */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000683
684#define REPLACE_FLAG 0x40 /* Replace mode flag */
685#define REPLACE (REPLACE_FLAG + INSERT)
686#ifdef FEAT_VREPLACE
687# define VREPLACE_FLAG 0x80 /* Virtual-replace mode flag */
688# define VREPLACE (REPLACE_FLAG + VREPLACE_FLAG + INSERT)
689#endif
690#define LREPLACE (REPLACE_FLAG + LANGMAP)
691
692#define NORMAL_BUSY (0x100 + NORMAL) /* Normal mode, busy with a command */
693#define HITRETURN (0x200 + NORMAL) /* waiting for return or command */
694#define ASKMORE 0x300 /* Asking if you want --more-- */
695#define SETWSIZE 0x400 /* window size has changed */
696#define ABBREV 0x500 /* abbreviation instead of mapping */
697#define EXTERNCMD 0x600 /* executing an external command */
698#define SHOWMATCH (0x700 + INSERT) /* show matching paren */
699#define CONFIRM 0x800 /* ":confirm" prompt */
Bram Moolenaar371d5402006-03-20 21:47:49 +0000700#define SELECTMODE 0x1000 /* Select mode, only for mappings */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000701
Bram Moolenaar149667a2006-06-23 14:33:23 +0000702#define MAP_ALL_MODES (0x3f | SELECTMODE) /* all mode bits used for
703 * mapping */
704
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705/* directions */
706#define FORWARD 1
707#define BACKWARD (-1)
708#define FORWARD_FILE 3
709#define BACKWARD_FILE (-3)
710
711/* return values for functions */
712#if !(defined(OK) && (OK == 1))
713/* OK already defined to 1 in MacOS X curses, skip this */
714# define OK 1
715#endif
716#define FAIL 0
Bram Moolenaarfd371682005-01-14 21:42:54 +0000717#define NOTDONE 2 /* not OK or FAIL but skipped */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000718
719/* flags for b_flags */
720#define BF_RECOVERED 0x01 /* buffer has been recovered */
721#define BF_CHECK_RO 0x02 /* need to check readonly when loading file
722 into buffer (set by ":e", may be reset by
723 ":buf" */
724#define BF_NEVERLOADED 0x04 /* file has never been loaded into buffer,
725 many variables still need to be set */
726#define BF_NOTEDITED 0x08 /* Set when file name is changed after
727 starting to edit, reset when file is
728 written out. */
729#define BF_NEW 0x10 /* file didn't exist when editing started */
730#define BF_NEW_W 0x20 /* Warned for BF_NEW and file created */
731#define BF_READERR 0x40 /* got errors while reading the file */
Bram Moolenaar81695252004-12-29 20:58:21 +0000732#define BF_DUMMY 0x80 /* dummy buffer, only used internally */
Bram Moolenaar4399ef42005-02-12 14:29:27 +0000733#define BF_PRESERVED 0x100 /* ":preserve" was used */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000734
735/* Mask to check for flags that prevent normal writing */
736#define BF_WRITE_MASK (BF_NOTEDITED + BF_NEW + BF_READERR)
737
738/*
739 * values for xp_context when doing command line completion
740 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000741#define EXPAND_UNSUCCESSFUL (-2)
742#define EXPAND_OK (-1)
743#define EXPAND_NOTHING 0
744#define EXPAND_COMMANDS 1
745#define EXPAND_FILES 2
746#define EXPAND_DIRECTORIES 3
747#define EXPAND_SETTINGS 4
748#define EXPAND_BOOL_SETTINGS 5
749#define EXPAND_TAGS 6
750#define EXPAND_OLD_SETTING 7
751#define EXPAND_HELP 8
752#define EXPAND_BUFFERS 9
753#define EXPAND_EVENTS 10
754#define EXPAND_MENUS 11
755#define EXPAND_SYNTAX 12
756#define EXPAND_HIGHLIGHT 13
757#define EXPAND_AUGROUP 14
758#define EXPAND_USER_VARS 15
759#define EXPAND_MAPPINGS 16
760#define EXPAND_TAGS_LISTFILES 17
761#define EXPAND_FUNCTIONS 18
762#define EXPAND_USER_FUNC 19
763#define EXPAND_EXPRESSION 20
764#define EXPAND_MENUNAMES 21
765#define EXPAND_USER_COMMANDS 22
766#define EXPAND_USER_CMD_FLAGS 23
767#define EXPAND_USER_NARGS 24
768#define EXPAND_USER_COMPLETE 25
769#define EXPAND_ENV_VARS 26
770#define EXPAND_LANGUAGE 27
771#define EXPAND_COLORS 28
772#define EXPAND_COMPILER 29
773#define EXPAND_USER_DEFINED 30
Bram Moolenaara466c992005-07-09 21:03:22 +0000774#define EXPAND_USER_LIST 31
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000775#define EXPAND_SHELLCMD 32
Bram Moolenaarf4580d82009-03-18 11:52:53 +0000776#define EXPAND_CSCOPE 33
Bram Moolenaar3c65e312009-04-29 16:47:23 +0000777#define EXPAND_SIGN 34
Bram Moolenaarf86f26c2010-02-03 15:14:22 +0100778#define EXPAND_PROFILE 35
Bram Moolenaar42b4dda2010-03-02 15:56:05 +0100779#define EXPAND_BEHAVE 36
Bram Moolenaar883f5d02010-06-21 06:24:34 +0200780#define EXPAND_FILETYPE 37
Bram Moolenaar1587a1e2010-07-29 20:59:59 +0200781#define EXPAND_FILES_IN_PATH 38
782#define EXPAND_OWNSYNTAX 39
Bram Moolenaar9b486ca2011-05-19 18:26:40 +0200783#define EXPAND_LOCALES 40
Bram Moolenaar5ae636b2012-04-30 18:48:53 +0200784#define EXPAND_HISTORY 41
Bram Moolenaar24305862012-08-15 14:05:05 +0200785#define EXPAND_USER 42
Bram Moolenaarcd9c4622013-06-08 15:24:48 +0200786#define EXPAND_SYNTIME 43
Bram Moolenaarf1d6ccf2014-12-08 04:16:44 +0100787#define EXPAND_USER_ADDR_TYPE 44
Bram Moolenaar35ca0e72016-03-05 17:41:49 +0100788#define EXPAND_PACKADD 45
Bram Moolenaar071d4272004-06-13 20:20:40 +0000789
790/* Values for exmode_active (0 is no exmode) */
791#define EXMODE_NORMAL 1
792#define EXMODE_VIM 2
793
794/* Values for nextwild() and ExpandOne(). See ExpandOne() for meaning. */
795#define WILD_FREE 1
796#define WILD_EXPAND_FREE 2
797#define WILD_EXPAND_KEEP 3
798#define WILD_NEXT 4
799#define WILD_PREV 5
800#define WILD_ALL 6
801#define WILD_LONGEST 7
Bram Moolenaar146e9c32012-03-07 19:18:23 +0100802#define WILD_ALL_KEEP 8
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803
Bram Moolenaara245bc72015-03-05 19:35:25 +0100804#define WILD_LIST_NOTFOUND 0x01
805#define WILD_HOME_REPLACE 0x02
806#define WILD_USE_NL 0x04
807#define WILD_NO_BEEP 0x08
808#define WILD_ADD_SLASH 0x10
809#define WILD_KEEP_ALL 0x20
810#define WILD_SILENT 0x40
811#define WILD_ESCAPE 0x80
812#define WILD_ICASE 0x100
813#define WILD_ALLLINKS 0x200
Bram Moolenaar071d4272004-06-13 20:20:40 +0000814
815/* Flags for expand_wildcards() */
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000816#define EW_DIR 0x01 /* include directory names */
817#define EW_FILE 0x02 /* include file names */
818#define EW_NOTFOUND 0x04 /* include not found names */
819#define EW_ADDSLASH 0x08 /* append slash to directory name */
820#define EW_KEEPALL 0x10 /* keep all matches */
821#define EW_SILENT 0x20 /* don't print "1 returned" from shell */
822#define EW_EXEC 0x40 /* executable files */
Bram Moolenaarcc448b32010-07-14 16:52:17 +0200823#define EW_PATH 0x80 /* search in 'path' too */
Bram Moolenaar94950a92010-12-02 16:01:29 +0100824#define EW_ICASE 0x100 /* ignore case */
Bram Moolenaarb5609832011-07-20 15:04:58 +0200825#define EW_NOERROR 0x200 /* no error for bad regexp */
Bram Moolenaar0b573a52011-07-27 17:31:47 +0200826#define EW_NOTWILD 0x400 /* add match with literal name if exists */
Bram Moolenaare4df1642014-08-29 12:58:44 +0200827#define EW_KEEPDOLLAR 0x800 /* do not escape $, $var is expanded */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000828/* Note: mostly EW_NOTFOUND and EW_SILENT are mutually exclusive: EW_NOTFOUND
829 * is used when executing commands and EW_SILENT for interactive expanding. */
Bram Moolenaara245bc72015-03-05 19:35:25 +0100830#define EW_ALLLINKS 0x1000 /* also links not pointing to existing file */
Bram Moolenaarb5971142015-03-21 17:32:19 +0100831#define EW_SHELLCMD 0x2000 /* called from expand_shellcmd(), don't check
832 * if executable is in $PATH */
Bram Moolenaarb0967d52016-01-17 16:49:43 +0100833#define EW_DODOT 0x4000 /* also files starting with a dot */
Bram Moolenaar336bd622016-01-17 18:23:58 +0100834#define EW_EMPTYOK 0x8000 /* no matches is not an error */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835
Bram Moolenaar4d0ec162008-02-20 11:24:52 +0000836/* Flags for find_file_*() functions. */
837#define FINDFILE_FILE 0 /* only files */
838#define FINDFILE_DIR 1 /* only directories */
839#define FINDFILE_BOTH 2 /* files and directories */
840
Bram Moolenaar44a2f922016-03-19 22:11:51 +0100841#ifdef FEAT_WINDOWS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842# define W_WINCOL(wp) (wp->w_wincol)
843# define W_WIDTH(wp) (wp->w_width)
844# define W_ENDCOL(wp) (wp->w_wincol + wp->w_width)
845# define W_VSEP_WIDTH(wp) (wp->w_vsep_width)
846#else
847# define W_WINCOL(wp) 0
848# define W_WIDTH(wp) Columns
849# define W_ENDCOL(wp) Columns
850# define W_VSEP_WIDTH(wp) 0
851#endif
852#ifdef FEAT_WINDOWS
853# define W_STATUS_HEIGHT(wp) (wp->w_status_height)
854# define W_WINROW(wp) (wp->w_winrow)
855#else
856# define W_STATUS_HEIGHT(wp) 0
857# define W_WINROW(wp) 0
858#endif
859
860#ifdef NO_EXPANDPATH
861# define gen_expand_wildcards mch_expand_wildcards
862#endif
863
864/* Values for the find_pattern_in_path() function args 'type' and 'action': */
865#define FIND_ANY 1
866#define FIND_DEFINE 2
867#define CHECK_PATH 3
868
869#define ACTION_SHOW 1
870#define ACTION_GOTO 2
871#define ACTION_SPLIT 3
872#define ACTION_SHOW_ALL 4
873#ifdef FEAT_INS_EXPAND
874# define ACTION_EXPAND 5
875#endif
876
877#ifdef FEAT_SYN_HL
878# define SST_MIN_ENTRIES 150 /* minimal size for state stack array */
Bram Moolenaare89ff042016-02-20 22:17:05 +0100879# define SST_MAX_ENTRIES 1000 /* maximal size for state stack array */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000880# define SST_FIX_STATES 7 /* size of sst_stack[]. */
881# define SST_DIST 16 /* normal distance between entries */
Bram Moolenaar860cae12010-06-05 23:22:07 +0200882# define SST_INVALID (synstate_T *)-1 /* invalid syn_state pointer */
883
884# define HL_CONTAINED 0x01 /* not used on toplevel */
885# define HL_TRANSP 0x02 /* has no highlighting */
886# define HL_ONELINE 0x04 /* match within one line only */
887# define HL_HAS_EOL 0x08 /* end pattern that matches with $ */
888# define HL_SYNC_HERE 0x10 /* sync point after this item (syncing only) */
889# define HL_SYNC_THERE 0x20 /* sync point at current line (syncing only) */
890# define HL_MATCH 0x40 /* use match ID instead of item ID */
891# define HL_SKIPNL 0x80 /* nextgroup can skip newlines */
892# define HL_SKIPWHITE 0x100 /* nextgroup can skip white space */
893# define HL_SKIPEMPTY 0x200 /* nextgroup can skip empty lines */
894# define HL_KEEPEND 0x400 /* end match always kept */
895# define HL_EXCLUDENL 0x800 /* exclude NL from match */
896# define HL_DISPLAY 0x1000 /* only used for displaying, not syncing */
897# define HL_FOLD 0x2000 /* define fold */
898# define HL_EXTEND 0x4000 /* ignore a keepend */
899# define HL_MATCHCONT 0x8000 /* match continued from previous line */
900# define HL_TRANS_CONT 0x10000 /* transparent item without contains arg */
901# define HL_CONCEAL 0x20000 /* can be concealed */
902# define HL_CONCEALENDS 0x40000 /* can be concealed */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000903#endif
904
905/* Values for 'options' argument in do_search() and searchit() */
906#define SEARCH_REV 0x01 /* go in reverse of previous dir. */
907#define SEARCH_ECHO 0x02 /* echo the search command and handle options */
908#define SEARCH_MSG 0x0c /* give messages (yes, it's not 0x04) */
909#define SEARCH_NFMSG 0x08 /* give all messages except not found */
910#define SEARCH_OPT 0x10 /* interpret optional flags */
911#define SEARCH_HIS 0x20 /* put search pattern in history */
912#define SEARCH_END 0x40 /* put cursor at end of match */
913#define SEARCH_NOOF 0x80 /* don't add offset to position */
914#define SEARCH_START 0x100 /* start search without col offset */
915#define SEARCH_MARK 0x200 /* set previous context mark */
916#define SEARCH_KEEP 0x400 /* keep previous search pattern */
917#define SEARCH_PEEK 0x800 /* peek for typed char, cancel search */
Bram Moolenaarad4d8a12015-12-28 19:20:36 +0100918#define SEARCH_COL 0x1000 /* start at specified column instead of zero */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000919
920/* Values for find_ident_under_cursor() */
921#define FIND_IDENT 1 /* find identifier (word) */
922#define FIND_STRING 2 /* find any string (WORD) */
923#define FIND_EVAL 4 /* include "->", "[]" and "." */
924
925/* Values for file_name_in_line() */
926#define FNAME_MESS 1 /* give error message */
927#define FNAME_EXP 2 /* expand to path */
928#define FNAME_HYP 4 /* check for hypertext link */
929#define FNAME_INCL 8 /* apply 'includeexpr' */
930#define FNAME_REL 16 /* ".." and "./" are relative to the (current)
931 file instead of the current directory */
Bram Moolenaard45c07a2015-02-27 17:19:10 +0100932#define FNAME_UNESC 32 /* remove backslashes used for escaping */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933
934/* Values for buflist_getfile() */
935#define GETF_SETMARK 0x01 /* set pcmark before jumping */
936#define GETF_ALT 0x02 /* jumping to alternate file (not buf num) */
937#define GETF_SWITCH 0x04 /* respect 'switchbuf' settings when jumping */
938
939/* Values for buflist_new() flags */
Bram Moolenaarb127cfd2016-05-29 16:24:50 +0200940#define BLN_CURBUF 1 /* may re-use curbuf for new buffer */
941#define BLN_LISTED 2 /* put new buffer in buffer list */
942#define BLN_DUMMY 4 /* allocating dummy buffer */
943#define BLN_NEW 8 /* create a new buffer */
Bram Moolenaar82404332016-07-10 17:00:38 +0200944#define BLN_NOOPT 16 /* don't copy options to existing buffer */
Bram Moolenaarcd524592016-07-17 14:57:05 +0200945#define BLN_DUMMY_OK 32 /* also find an existing dummy buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000946
947/* Values for in_cinkeys() */
948#define KEY_OPEN_FORW 0x101
949#define KEY_OPEN_BACK 0x102
950#define KEY_COMPLETE 0x103 /* end of completion */
951
952/* Values for "noremap" argument of ins_typebuf(). Also used for
953 * map->m_noremap and menu->noremap[]. */
954#define REMAP_YES 0 /* allow remapping */
955#define REMAP_NONE -1 /* no remapping */
956#define REMAP_SCRIPT -2 /* remap script-local mappings only */
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000957#define REMAP_SKIP -3 /* no remapping for first char */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000958
959/* Values for mch_call_shell() second argument */
960#define SHELL_FILTER 1 /* filtering text */
961#define SHELL_EXPAND 2 /* expanding wildcards */
962#define SHELL_COOKED 4 /* set term to cooked mode */
963#define SHELL_DOOUT 8 /* redirecting output */
964#define SHELL_SILENT 16 /* don't print error returned by command */
Bram Moolenaardf177f62005-02-22 08:39:57 +0000965#define SHELL_READ 32 /* read lines and insert into buffer */
966#define SHELL_WRITE 64 /* write lines from buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000967
968/* Values returned by mch_nodetype() */
969#define NODE_NORMAL 0 /* file or directory, check with mch_isdir()*/
970#define NODE_WRITABLE 1 /* something we can write to (character
971 device, fifo, socket, ..) */
972#define NODE_OTHER 2 /* non-writable thing (e.g., block device) */
973
974/* Values for readfile() flags */
975#define READ_NEW 0x01 /* read a file into a new buffer */
976#define READ_FILTER 0x02 /* read filter output */
977#define READ_STDIN 0x04 /* read from stdin */
978#define READ_BUFFER 0x08 /* read from curbuf (converting stdin) */
979#define READ_DUMMY 0x10 /* reading into a dummy buffer */
Bram Moolenaar59f931e2010-07-24 20:27:03 +0200980#define READ_KEEP_UNDO 0x20 /* keep undo info*/
Bram Moolenaar071d4272004-06-13 20:20:40 +0000981
982/* Values for change_indent() */
983#define INDENT_SET 1 /* set indent */
984#define INDENT_INC 2 /* increase indent */
985#define INDENT_DEC 3 /* decrease indent */
986
987/* Values for flags argument for findmatchlimit() */
988#define FM_BACKWARD 0x01 /* search backwards */
989#define FM_FORWARD 0x02 /* search forwards */
990#define FM_BLOCKSTOP 0x04 /* stop at start/end of block */
991#define FM_SKIPCOMM 0x08 /* skip comments */
992
993/* Values for action argument for do_buffer() */
994#define DOBUF_GOTO 0 /* go to specified buffer */
995#define DOBUF_SPLIT 1 /* split window and go to specified buffer */
996#define DOBUF_UNLOAD 2 /* unload specified buffer(s) */
997#define DOBUF_DEL 3 /* delete specified buffer(s) from buflist */
998#define DOBUF_WIPE 4 /* delete specified buffer(s) really */
999
1000/* Values for start argument for do_buffer() */
1001#define DOBUF_CURRENT 0 /* "count" buffer from current buffer */
1002#define DOBUF_FIRST 1 /* "count" buffer from first buffer */
1003#define DOBUF_LAST 2 /* "count" buffer from last buffer */
1004#define DOBUF_MOD 3 /* "count" mod. buffer from current buffer */
1005
1006/* Values for sub_cmd and which_pat argument for search_regcomp() */
1007/* Also used for which_pat argument for searchit() */
1008#define RE_SEARCH 0 /* save/use pat in/from search_pattern */
1009#define RE_SUBST 1 /* save/use pat in/from subst_pattern */
1010#define RE_BOTH 2 /* save pat in both patterns */
1011#define RE_LAST 2 /* use last used pattern if "pat" is NULL */
1012
1013/* Second argument for vim_regcomp(). */
1014#define RE_MAGIC 1 /* 'magic' option */
1015#define RE_STRING 2 /* match in string instead of buffer text */
Bram Moolenaarae5bce12005-08-15 21:41:48 +00001016#define RE_STRICT 4 /* don't allow [abc] without ] */
Bram Moolenaare0ad3652015-01-27 12:59:55 +01001017#define RE_AUTO 8 /* automatic engine selection */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001018
1019#ifdef FEAT_SYN_HL
1020/* values for reg_do_extmatch */
1021# define REX_SET 1 /* to allow \z\(...\), */
1022# define REX_USE 2 /* to allow \z\1 et al. */
1023#endif
1024
1025/* Return values for fullpathcmp() */
1026/* Note: can use (fullpathcmp() & FPC_SAME) to check for equal files */
1027#define FPC_SAME 1 /* both exist and are the same file. */
1028#define FPC_DIFF 2 /* both exist and are different files. */
1029#define FPC_NOTX 4 /* both don't exist. */
1030#define FPC_DIFFX 6 /* one of them doesn't exist. */
1031#define FPC_SAMEX 7 /* both don't exist and file names are same. */
1032
1033/* flags for do_ecmd() */
1034#define ECMD_HIDE 0x01 /* don't free the current buffer */
1035#define ECMD_SET_HELP 0x02 /* set b_help flag of (new) buffer before
1036 opening file */
1037#define ECMD_OLDBUF 0x04 /* use existing buffer if it exists */
1038#define ECMD_FORCEIT 0x08 /* ! used in Ex command */
1039#define ECMD_ADDBUF 0x10 /* don't edit, just add to buffer list */
1040
1041/* for lnum argument in do_ecmd() */
1042#define ECMD_LASTL (linenr_T)0 /* use last position in loaded file */
1043#define ECMD_LAST (linenr_T)-1 /* use last position in all files */
1044#define ECMD_ONE (linenr_T)1 /* use first line */
1045
1046/* flags for do_cmdline() */
1047#define DOCMD_VERBOSE 0x01 /* included command in error message */
1048#define DOCMD_NOWAIT 0x02 /* don't call wait_return() and friends */
1049#define DOCMD_REPEAT 0x04 /* repeat exec. until getline() returns NULL */
1050#define DOCMD_KEYTYPED 0x08 /* don't reset KeyTyped */
1051#define DOCMD_EXCRESET 0x10 /* reset exception environment (for debugging)*/
1052#define DOCMD_KEEPLINE 0x20 /* keep typed line for repeating with "." */
1053
1054/* flags for beginline() */
1055#define BL_WHITE 1 /* cursor on first non-white in the line */
1056#define BL_SOL 2 /* use 'sol' option */
1057#define BL_FIX 4 /* don't leave cursor on a NUL */
1058
1059/* flags for mf_sync() */
1060#define MFS_ALL 1 /* also sync blocks with negative numbers */
1061#define MFS_STOP 2 /* stop syncing when a character is available */
1062#define MFS_FLUSH 4 /* flushed file to disk */
1063#define MFS_ZERO 8 /* only write block 0 */
1064
1065/* flags for buf_copy_options() */
1066#define BCO_ENTER 1 /* going to enter the buffer */
1067#define BCO_ALWAYS 2 /* always copy the options */
1068#define BCO_NOHELP 4 /* don't touch the help related options */
1069
1070/* flags for do_put() */
1071#define PUT_FIXINDENT 1 /* make indent look nice */
1072#define PUT_CURSEND 2 /* leave cursor after end of new text */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001073#define PUT_CURSLINE 4 /* leave cursor on last line of new text */
1074#define PUT_LINE 8 /* put register as lines */
1075#define PUT_LINE_SPLIT 16 /* split line for linewise register */
1076#define PUT_LINE_FORWARD 32 /* put linewise register below Visual sel. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001077
1078/* flags for set_indent() */
1079#define SIN_CHANGED 1 /* call changed_bytes() when line changed */
1080#define SIN_INSERT 2 /* insert indent before existing text */
1081#define SIN_UNDO 4 /* save line for undo before changing it */
1082
1083/* flags for insertchar() */
1084#define INSCHAR_FORMAT 1 /* force formatting */
1085#define INSCHAR_DO_COM 2 /* format comments */
1086#define INSCHAR_CTRLV 4 /* char typed just after CTRL-V */
Bram Moolenaar81a82092008-03-12 16:27:00 +00001087#define INSCHAR_NO_FEX 8 /* don't use 'formatexpr' */
Bram Moolenaarbfe3bf82012-06-13 17:28:55 +02001088#define INSCHAR_COM_LIST 16 /* format comments with list/2nd line indent */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001089
1090/* flags for open_line() */
1091#define OPENLINE_DELSPACES 1 /* delete spaces after cursor */
1092#define OPENLINE_DO_COM 2 /* format comments */
1093#define OPENLINE_KEEPTRAIL 4 /* keep trailing spaces */
1094#define OPENLINE_MARKFIX 8 /* fix mark positions */
Bram Moolenaarbfe3bf82012-06-13 17:28:55 +02001095#define OPENLINE_COM_LIST 16 /* format comments with list/2nd line indent */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001096
1097/*
Bram Moolenaarc60954b2016-06-06 21:20:10 +02001098 * There are five history tables:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001099 */
1100#define HIST_CMD 0 /* colon commands */
1101#define HIST_SEARCH 1 /* search commands */
1102#define HIST_EXPR 2 /* expressions (from entering = register) */
1103#define HIST_INPUT 3 /* input() lines */
1104#define HIST_DEBUG 4 /* debug commands */
1105#define HIST_COUNT 5 /* number of history tables */
1106
Bram Moolenaarc60954b2016-06-06 21:20:10 +02001107/* The type numbers are fixed for backwards compatibility. */
1108#define BARTYPE_VERSION 1
1109#define BARTYPE_HISTORY 2
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02001110#define BARTYPE_REGISTER 3
Bram Moolenaar2d358992016-06-12 21:20:54 +02001111#define BARTYPE_MARK 4
Bram Moolenaarc60954b2016-06-06 21:20:10 +02001112
Bram Moolenaar2d358992016-06-12 21:20:54 +02001113#define VIMINFO_VERSION 4
Bram Moolenaar1fd99c12016-06-09 20:24:28 +02001114#define VIMINFO_VERSION_WITH_HISTORY 2
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02001115#define VIMINFO_VERSION_WITH_REGISTERS 3
Bram Moolenaar2d358992016-06-12 21:20:54 +02001116#define VIMINFO_VERSION_WITH_MARKS 4
Bram Moolenaar1fd99c12016-06-09 20:24:28 +02001117
Bram Moolenaarc60954b2016-06-06 21:20:10 +02001118typedef enum {
1119 BVAL_NR,
1120 BVAL_STRING,
1121 BVAL_EMPTY
1122} btype_T;
1123
Bram Moolenaarc60954b2016-06-06 21:20:10 +02001124typedef struct {
1125 btype_T bv_type;
1126 long bv_nr;
1127 char_u *bv_string;
1128 int bv_len; /* length of bv_string */
1129 int bv_allocated; /* bv_string was allocated */
1130} bval_T;
1131
Bram Moolenaar071d4272004-06-13 20:20:40 +00001132/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001133 * Values for do_tag().
1134 */
1135#define DT_TAG 1 /* jump to newer position or same tag again */
1136#define DT_POP 2 /* jump to older position */
1137#define DT_NEXT 3 /* jump to next match of same tag */
1138#define DT_PREV 4 /* jump to previous match of same tag */
1139#define DT_FIRST 5 /* jump to first match of same tag */
1140#define DT_LAST 6 /* jump to first match of same tag */
1141#define DT_SELECT 7 /* jump to selection from list */
1142#define DT_HELP 8 /* like DT_TAG, but no wildcards */
1143#define DT_JUMP 9 /* jump to new tag or selection from list */
1144#define DT_CSCOPE 10 /* cscope find command (like tjump) */
Bram Moolenaarb8a7b562006-02-01 21:47:16 +00001145#define DT_LTAG 11 /* tag using location list */
Bram Moolenaarea408852005-06-25 22:49:46 +00001146#define DT_FREE 99 /* free cached matches */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001147
1148/*
1149 * flags for find_tags().
1150 */
1151#define TAG_HELP 1 /* only search for help tags */
1152#define TAG_NAMES 2 /* only return name of tag */
1153#define TAG_REGEXP 4 /* use tag pattern as regexp */
1154#define TAG_NOIC 8 /* don't always ignore case */
1155#ifdef FEAT_CSCOPE
1156# define TAG_CSCOPE 16 /* cscope tag */
1157#endif
1158#define TAG_VERBOSE 32 /* message verbosity */
1159#define TAG_INS_COMP 64 /* Currently doing insert completion */
1160#define TAG_KEEP_LANG 128 /* keep current language */
1161
Bram Moolenaarc236c162008-07-13 17:41:49 +00001162#define TAG_MANY 300 /* When finding many tags (for completion),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001163 find up to this many tags */
1164
1165/*
1166 * Types of dialogs passed to do_vim_dialog().
1167 */
1168#define VIM_GENERIC 0
1169#define VIM_ERROR 1
1170#define VIM_WARNING 2
1171#define VIM_INFO 3
1172#define VIM_QUESTION 4
1173#define VIM_LAST_TYPE 4 /* sentinel value */
1174
1175/*
1176 * Return values for functions like gui_yesnocancel()
1177 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001178#define VIM_YES 2
1179#define VIM_NO 3
1180#define VIM_CANCEL 4
1181#define VIM_ALL 5
1182#define VIM_DISCARDALL 6
1183
1184/*
1185 * arguments for win_split()
1186 */
1187#define WSP_ROOM 1 /* require enough room */
1188#define WSP_VERT 2 /* split vertically */
1189#define WSP_TOP 4 /* window at top-left of shell */
1190#define WSP_BOT 8 /* window at bottom-right of shell */
1191#define WSP_HELP 16 /* creating the help window */
1192#define WSP_BELOW 32 /* put new window below/right */
1193#define WSP_ABOVE 64 /* put new window above/left */
Bram Moolenaar884ae642009-02-22 01:37:59 +00001194#define WSP_NEWLOC 128 /* don't copy location list */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001195
1196/*
Bram Moolenaar2e2a2812006-03-27 20:55:21 +00001197 * arguments for gui_set_shellsize()
1198 */
1199#define RESIZE_VERT 1 /* resize vertically */
1200#define RESIZE_HOR 2 /* resize horizontally */
1201#define RESIZE_BOTH 15 /* resize in both directions */
1202
1203/*
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001204 * flags for check_changed()
1205 */
1206#define CCGD_AW 1 /* do autowrite if buffer was changed */
1207#define CCGD_MULTWIN 2 /* check also when several wins for the buf */
1208#define CCGD_FORCEIT 4 /* ! used */
1209#define CCGD_ALLBUF 8 /* may write all buffers */
1210#define CCGD_EXCMD 16 /* may suggest using ! */
1211
1212/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001213 * "flags" values for option-setting functions.
1214 * When OPT_GLOBAL and OPT_LOCAL are both missing, set both local and global
1215 * values, get local value.
1216 */
1217#define OPT_FREE 1 /* free old value if it was allocated */
1218#define OPT_GLOBAL 2 /* use global value */
1219#define OPT_LOCAL 4 /* use local value */
1220#define OPT_MODELINE 8 /* option in modeline */
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00001221#define OPT_WINONLY 16 /* only set window-local options */
Bram Moolenaara3227e22006-03-08 21:32:40 +00001222#define OPT_NOWIN 32 /* don't set window-local options */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001223
1224/* Magic chars used in confirm dialog strings */
1225#define DLG_BUTTON_SEP '\n'
1226#define DLG_HOTKEY_CHAR '&'
1227
1228/* Values for "starting" */
1229#define NO_SCREEN 2 /* no screen updating yet */
1230#define NO_BUFFERS 1 /* not all buffers loaded yet */
1231/* 0 not starting anymore */
1232
1233/* Values for swap_exists_action: what to do when swap file already exists */
1234#define SEA_NONE 0 /* don't use dialog */
Bram Moolenaarbe79f902005-12-07 20:56:14 +00001235#define SEA_DIALOG 1 /* use dialog when possible */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001236#define SEA_QUIT 2 /* quit editing the file */
1237#define SEA_RECOVER 3 /* recover the file */
1238
1239/*
1240 * Minimal size for block 0 of a swap file.
1241 * NOTE: This depends on size of struct block0! It's not done with a sizeof(),
1242 * because struct block0 is defined in memline.c (Sorry).
1243 * The maximal block size is arbitrary.
1244 */
1245#define MIN_SWAP_PAGE_SIZE 1048
1246#define MAX_SWAP_PAGE_SIZE 50000
1247
1248/* Special values for current_SID. */
1249#define SID_MODELINE -1 /* when using a modeline */
1250#define SID_CMDARG -2 /* for "--cmd" argument */
1251#define SID_CARG -3 /* for "-c" argument */
1252#define SID_ENV -4 /* for sourcing environment variable */
Bram Moolenaard1f56e62006-02-22 21:25:37 +00001253#define SID_ERROR -5 /* option was reset because of an error */
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00001254#define SID_NONE -6 /* don't set scriptID */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001255
1256/*
1257 * Events for autocommands.
1258 */
1259enum auto_event
1260{
1261 EVENT_BUFADD = 0, /* after adding a buffer to the buffer list */
1262 EVENT_BUFNEW, /* after creating any buffer */
1263 EVENT_BUFDELETE, /* deleting a buffer from the buffer list */
1264 EVENT_BUFWIPEOUT, /* just before really deleting a buffer */
1265 EVENT_BUFENTER, /* after entering a buffer */
1266 EVENT_BUFFILEPOST, /* after renaming a buffer */
1267 EVENT_BUFFILEPRE, /* before renaming a buffer */
1268 EVENT_BUFLEAVE, /* before leaving a buffer */
1269 EVENT_BUFNEWFILE, /* when creating a buffer for a new file */
1270 EVENT_BUFREADPOST, /* after reading a buffer */
1271 EVENT_BUFREADPRE, /* before reading a buffer */
1272 EVENT_BUFREADCMD, /* read buffer using command */
1273 EVENT_BUFUNLOAD, /* just before unloading a buffer */
1274 EVENT_BUFHIDDEN, /* just after buffer becomes hidden */
1275 EVENT_BUFWINENTER, /* after showing a buffer in a window */
1276 EVENT_BUFWINLEAVE, /* just after buffer removed from window */
1277 EVENT_BUFWRITEPOST, /* after writing a buffer */
1278 EVENT_BUFWRITEPRE, /* before writing a buffer */
1279 EVENT_BUFWRITECMD, /* write buffer using command */
1280 EVENT_CMDWINENTER, /* after entering the cmdline window */
1281 EVENT_CMDWINLEAVE, /* before leaving the cmdline window */
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001282 EVENT_COLORSCHEME, /* after loading a colorscheme */
Bram Moolenaarcfa3cae2012-07-10 17:14:56 +02001283 EVENT_COMPLETEDONE, /* after finishing insert complete */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001284 EVENT_FILEAPPENDPOST, /* after appending to a file */
1285 EVENT_FILEAPPENDPRE, /* before appending to a file */
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00001286 EVENT_FILEAPPENDCMD, /* append to a file using command */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287 EVENT_FILECHANGEDSHELL, /* after shell command that changed file */
Bram Moolenaardb003512006-03-15 22:48:35 +00001288 EVENT_FILECHANGEDSHELLPOST, /* after (not) reloading changed file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001289 EVENT_FILECHANGEDRO, /* before first change to read-only file */
1290 EVENT_FILEREADPOST, /* after reading a file */
1291 EVENT_FILEREADPRE, /* before reading a file */
1292 EVENT_FILEREADCMD, /* read from a file using command */
1293 EVENT_FILETYPE, /* new file type detected (user defined) */
1294 EVENT_FILEWRITEPOST, /* after writing a file */
1295 EVENT_FILEWRITEPRE, /* before writing a file */
1296 EVENT_FILEWRITECMD, /* write to a file using command */
1297 EVENT_FILTERREADPOST, /* after reading from a filter */
1298 EVENT_FILTERREADPRE, /* before reading from a filter */
1299 EVENT_FILTERWRITEPOST, /* after writing to a filter */
1300 EVENT_FILTERWRITEPRE, /* before writing to a filter */
1301 EVENT_FOCUSGAINED, /* got the focus */
1302 EVENT_FOCUSLOST, /* lost the focus to another app */
1303 EVENT_GUIENTER, /* after starting the GUI */
Bram Moolenaar265e5072006-08-29 16:13:22 +00001304 EVENT_GUIFAILED, /* after starting the GUI failed */
Bram Moolenaar843ee412004-06-30 16:16:41 +00001305 EVENT_INSERTCHANGE, /* when changing Insert/Replace mode */
1306 EVENT_INSERTENTER, /* when entering Insert mode */
1307 EVENT_INSERTLEAVE, /* when leaving Insert mode */
Bram Moolenaara3ffd9c2005-07-21 21:03:15 +00001308 EVENT_MENUPOPUP, /* just before popup menu is displayed */
Bram Moolenaar3b53dfb2012-06-06 18:03:07 +02001309 EVENT_QUICKFIXCMDPOST, /* after :make, :grep etc. */
1310 EVENT_QUICKFIXCMDPRE, /* before :make, :grep etc. */
1311 EVENT_QUITPRE, /* before :quit */
Bram Moolenaarcef9dcc2005-12-06 19:50:41 +00001312 EVENT_SESSIONLOADPOST, /* after loading a session file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001313 EVENT_STDINREADPOST, /* after reading from stdin */
1314 EVENT_STDINREADPRE, /* before reading from stdin */
1315 EVENT_SYNTAX, /* syntax selected */
1316 EVENT_TERMCHANGED, /* after changing 'term' */
1317 EVENT_TERMRESPONSE, /* after setting "v:termresponse" */
1318 EVENT_USER, /* user defined autocommand */
1319 EVENT_VIMENTER, /* after starting Vim */
1320 EVENT_VIMLEAVE, /* before exiting Vim */
1321 EVENT_VIMLEAVEPRE, /* before exiting Vim and writing .viminfo */
Bram Moolenaardb003512006-03-15 22:48:35 +00001322 EVENT_VIMRESIZED, /* after Vim window was resized */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001323 EVENT_WINENTER, /* after entering a window */
1324 EVENT_WINLEAVE, /* before leaving a window */
Bram Moolenaarc917da42016-07-19 22:31:36 +02001325 EVENT_WINNEW, /* when entering a new window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001326 EVENT_ENCODINGCHANGED, /* after changing the 'encoding' option */
Bram Moolenaare659c952011-05-19 17:25:41 +02001327 EVENT_INSERTCHARPRE, /* before inserting a char */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001328 EVENT_CURSORHOLD, /* cursor in same position for a while */
Bram Moolenaarcf0c5542006-02-09 23:48:02 +00001329 EVENT_CURSORHOLDI, /* idem, in Insert mode */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001330 EVENT_FUNCUNDEFINED, /* if calling a function which doesn't exist */
1331 EVENT_REMOTEREPLY, /* upon string reception from a remote vim */
Bram Moolenaarbe79f902005-12-07 20:56:14 +00001332 EVENT_SWAPEXISTS, /* found existing swap file */
Bram Moolenaara2031822006-03-07 22:29:51 +00001333 EVENT_SOURCEPRE, /* before sourcing a Vim script */
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00001334 EVENT_SOURCECMD, /* sourcing a Vim script using command */
Bram Moolenaarb8a7b562006-02-01 21:47:16 +00001335 EVENT_SPELLFILEMISSING, /* spell file missing */
Bram Moolenaarcf0c5542006-02-09 23:48:02 +00001336 EVENT_CURSORMOVED, /* cursor was moved */
1337 EVENT_CURSORMOVEDI, /* cursor was moved in Insert mode */
Bram Moolenaar2a0449d2006-02-20 21:27:21 +00001338 EVENT_TABENTER, /* after entering a tab page */
Bram Moolenaarc917da42016-07-19 22:31:36 +02001339 EVENT_TABLEAVE, /* before leaving a tab page */
1340 EVENT_TABNEW, /* when entering a new tab page */
Bram Moolenaar12c11d52016-07-19 23:13:03 +02001341 EVENT_TABCLOSED, /* after closing a tab page */
Bram Moolenaar4e427192006-03-10 21:34:27 +00001342 EVENT_SHELLCMDPOST, /* after ":!cmd" */
1343 EVENT_SHELLFILTERPOST, /* after ":1,2!cmd", ":w !cmd", ":r !cmd". */
Bram Moolenaar186628f2013-03-19 13:33:23 +01001344 EVENT_TEXTCHANGED, /* text was modified */
1345 EVENT_TEXTCHANGEDI, /* text was modified in Insert mode*/
Bram Moolenaar5a31b462014-08-23 14:16:20 +02001346 EVENT_CMDUNDEFINED, /* command undefined */
Bram Moolenaar53744302015-07-17 17:38:22 +02001347 EVENT_OPTIONSET, /* option was set */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001348 NUM_EVENTS /* MUST be the last one */
1349};
1350
Bram Moolenaarcf0c5542006-02-09 23:48:02 +00001351typedef enum auto_event event_T;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001352
1353/*
1354 * Values for index in highlight_attr[].
1355 * When making changes, also update HL_FLAGS below! And update the default
1356 * value of 'highlight' in option.c.
1357 */
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00001358typedef enum
Bram Moolenaar071d4272004-06-13 20:20:40 +00001359{
1360 HLF_8 = 0 /* Meta & special keys listed with ":map", text that is
1361 displayed different from what it is */
1362 , HLF_AT /* @ and ~ characters at end of screen, characters that
1363 don't really exist in the text */
1364 , HLF_D /* directories in CTRL-D listing */
1365 , HLF_E /* error messages */
1366 , HLF_H /* obsolete, ignored */
1367 , HLF_I /* incremental search */
1368 , HLF_L /* last search string */
1369 , HLF_M /* "--More--" message */
1370 , HLF_CM /* Mode (e.g., "-- INSERT --") */
1371 , HLF_N /* line number for ":number" and ":#" commands */
Bram Moolenaar06ca5132012-03-23 16:25:17 +01001372 , HLF_CLN /* current line number */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001373 , HLF_R /* return to continue message and yes/no questions */
1374 , HLF_S /* status lines */
1375 , HLF_SNC /* status lines of not-current windows */
1376 , HLF_C /* column to separate vertically split windows */
1377 , HLF_T /* Titles for output from ":set all", ":autocmd" etc. */
1378 , HLF_V /* Visual mode */
1379 , HLF_VNC /* Visual mode, autoselecting and not clipboard owner */
1380 , HLF_W /* warning messages */
1381 , HLF_WM /* Wildmenu highlight */
1382 , HLF_FL /* Folded line */
1383 , HLF_FC /* Fold column */
1384 , HLF_ADD /* Added diff line */
1385 , HLF_CHD /* Changed diff line */
1386 , HLF_DED /* Deleted diff line */
1387 , HLF_TXD /* Text Changed in diff line */
Bram Moolenaar860cae12010-06-05 23:22:07 +02001388 , HLF_CONCEAL /* Concealed text */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001389 , HLF_SC /* Sign column */
Bram Moolenaar2e4096b2005-03-20 22:25:45 +00001390 , HLF_SPB /* SpellBad */
Bram Moolenaarf9184a12005-07-02 23:10:47 +00001391 , HLF_SPC /* SpellCap */
Bram Moolenaar2e4096b2005-03-20 22:25:45 +00001392 , HLF_SPR /* SpellRare */
1393 , HLF_SPL /* SpellLocal */
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001394 , HLF_PNI /* popup menu normal item */
1395 , HLF_PSI /* popup menu selected item */
1396 , HLF_PSB /* popup menu scrollbar */
1397 , HLF_PST /* popup menu scrollbar thumb */
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001398 , HLF_TP /* tabpage line */
1399 , HLF_TPS /* tabpage line selected */
1400 , HLF_TPF /* tabpage line filler */
Bram Moolenaarf71a3db2006-03-12 21:50:18 +00001401 , HLF_CUC /* 'cursurcolumn' */
1402 , HLF_CUL /* 'cursurline' */
Bram Moolenaar1a384422010-07-14 19:53:30 +02001403 , HLF_MC /* 'colorcolumn' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001404 , HLF_COUNT /* MUST be the last one */
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00001405} hlf_T;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001406
Bram Moolenaarf71a3db2006-03-12 21:50:18 +00001407/* The HL_FLAGS must be in the same order as the HLF_ enums!
Bram Moolenaar42b4dda2010-03-02 15:56:05 +01001408 * When changing this also adjust the default for 'highlight'. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001409#define HL_FLAGS {'8', '@', 'd', 'e', 'h', 'i', 'l', 'm', 'M', \
Bram Moolenaar06ca5132012-03-23 16:25:17 +01001410 'n', 'N', 'r', 's', 'S', 'c', 't', 'v', 'V', 'w', 'W', \
Bram Moolenaar860cae12010-06-05 23:22:07 +02001411 'f', 'F', 'A', 'C', 'D', 'T', '-', '>', \
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001412 'B', 'P', 'R', 'L', \
Bram Moolenaar1a384422010-07-14 19:53:30 +02001413 '+', '=', 'x', 'X', '*', '#', '_', '!', '.', 'o'}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001414
1415/*
1416 * Boolean constants
1417 */
1418#ifndef TRUE
1419# define FALSE 0 /* note: this is an int, not a long! */
1420# define TRUE 1
1421#endif
1422
1423#define MAYBE 2 /* sometimes used for a variant on TRUE */
1424
Bram Moolenaar7db5fc82010-05-24 11:59:29 +02001425#ifndef UINT32_T
1426typedef UINT32_TYPEDEF UINT32_T;
1427#endif
1428
Bram Moolenaar071d4272004-06-13 20:20:40 +00001429/*
1430 * Operator IDs; The order must correspond to opchars[] in ops.c!
1431 */
1432#define OP_NOP 0 /* no pending operation */
1433#define OP_DELETE 1 /* "d" delete operator */
1434#define OP_YANK 2 /* "y" yank operator */
1435#define OP_CHANGE 3 /* "c" change operator */
1436#define OP_LSHIFT 4 /* "<" left shift operator */
1437#define OP_RSHIFT 5 /* ">" right shift operator */
1438#define OP_FILTER 6 /* "!" filter operator */
1439#define OP_TILDE 7 /* "g~" switch case operator */
1440#define OP_INDENT 8 /* "=" indent operator */
1441#define OP_FORMAT 9 /* "gq" format operator */
1442#define OP_COLON 10 /* ":" colon operator */
1443#define OP_UPPER 11 /* "gU" make upper case operator */
1444#define OP_LOWER 12 /* "gu" make lower case operator */
1445#define OP_JOIN 13 /* "J" join operator, only for Visual mode */
1446#define OP_JOIN_NS 14 /* "gJ" join operator, only for Visual mode */
1447#define OP_ROT13 15 /* "g?" rot-13 encoding */
1448#define OP_REPLACE 16 /* "r" replace chars, only for Visual mode */
1449#define OP_INSERT 17 /* "I" Insert column, only for Visual mode */
1450#define OP_APPEND 18 /* "A" Append column, only for Visual mode */
1451#define OP_FOLD 19 /* "zf" define a fold */
1452#define OP_FOLDOPEN 20 /* "zo" open folds */
1453#define OP_FOLDOPENREC 21 /* "zO" open folds recursively */
1454#define OP_FOLDCLOSE 22 /* "zc" close folds */
1455#define OP_FOLDCLOSEREC 23 /* "zC" close folds recursively */
1456#define OP_FOLDDEL 24 /* "zd" delete folds */
1457#define OP_FOLDDELREC 25 /* "zD" delete folds recursively */
1458#define OP_FORMAT2 26 /* "gw" format operator, keeps cursor pos */
Bram Moolenaar12033fb2005-12-16 21:49:31 +00001459#define OP_FUNCTION 27 /* "g@" call 'operatorfunc' */
Bram Moolenaard79e5502016-01-10 22:13:02 +01001460#define OP_NR_ADD 28 /* "<C-A>" Add to the number or alphabetic
1461 character (OP_ADD conflicts with Perl) */
1462#define OP_NR_SUB 29 /* "<C-X>" Subtract from the number or
1463 alphabetic character */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001464
1465/*
1466 * Motion types, used for operators and for yank/delete registers.
1467 */
1468#define MCHAR 0 /* character-wise movement/register */
1469#define MLINE 1 /* line-wise movement/register */
1470#define MBLOCK 2 /* block-wise register */
1471
1472#define MAUTO 0xff /* Decide between MLINE/MCHAR */
1473
1474/*
1475 * Minimum screen size
1476 */
1477#define MIN_COLUMNS 12 /* minimal columns for screen */
1478#define MIN_LINES 2 /* minimal lines for screen */
1479#define STATUS_HEIGHT 1 /* height of a status line under a window */
1480#define QF_WINHEIGHT 10 /* default height for quickfix window */
1481
1482/*
1483 * Buffer sizes
1484 */
1485#ifndef CMDBUFFSIZE
1486# define CMDBUFFSIZE 256 /* size of the command processing buffer */
1487#endif
1488
1489#define LSIZE 512 /* max. size of a line in the tags file */
1490
1491#define IOSIZE (1024+1) /* file i/o and sprintf buffer size */
Bram Moolenaard9d30582005-05-18 22:10:28 +00001492
Bram Moolenaard9462e32011-04-11 21:35:11 +02001493#define DIALOG_MSG_SIZE 1000 /* buffer size for dialog_msg() */
1494
Bram Moolenaard9d30582005-05-18 22:10:28 +00001495#ifdef FEAT_MBYTE
1496# define MSG_BUF_LEN 480 /* length of buffer for small messages */
1497# define MSG_BUF_CLEN (MSG_BUF_LEN / 6) /* cell length (worst case: utf-8
1498 takes 6 bytes for one cell) */
1499#else
1500# define MSG_BUF_LEN 80 /* length of buffer for small messages */
1501# define MSG_BUF_CLEN MSG_BUF_LEN /* cell length */
1502#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001503
Bram Moolenaar0bd40c02009-06-16 09:07:49 +00001504/* Size of the buffer used for tgetent(). Unfortunately this is largely
1505 * undocumented, some systems use 1024. Using a buffer that is too small
1506 * causes a buffer overrun and a crash. Use the maximum known value to stay
1507 * on the safe side. */
1508#define TBUFSZ 2048 /* buffer size for termcap entry */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001509
1510/*
1511 * Maximum length of key sequence to be mapped.
1512 * Must be able to hold an Amiga resize report.
1513 */
1514#define MAXMAPLEN 50
1515
Bram Moolenaar55debbe2010-05-23 23:34:36 +02001516/* Size in bytes of the hash used in the undo file. */
1517#define UNDO_HASH_SIZE 32
1518
Bram Moolenaara7241f52008-06-24 20:39:31 +00001519#ifdef HAVE_FCNTL_H
1520# include <fcntl.h>
1521#endif
1522
Bram Moolenaar071d4272004-06-13 20:20:40 +00001523#ifdef BINARY_FILE_IO
1524# define WRITEBIN "wb" /* no CR-LF translation */
1525# define READBIN "rb"
1526# define APPENDBIN "ab"
1527#else
1528# define WRITEBIN "w"
1529# define READBIN "r"
1530# define APPENDBIN "a"
1531#endif
1532
1533/*
1534 * EMX doesn't have a global way of making open() use binary I/O.
1535 * Use O_BINARY for all open() calls.
1536 */
Bram Moolenaara06ecab2016-07-16 14:47:36 +02001537#if defined(__CYGWIN32__)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001538# define O_EXTRA O_BINARY
1539#else
1540# define O_EXTRA 0
1541#endif
1542
Bram Moolenaara5792f52005-11-23 21:25:05 +00001543#ifndef O_NOFOLLOW
1544# define O_NOFOLLOW 0
1545#endif
1546
Bram Moolenaar071d4272004-06-13 20:20:40 +00001547#ifndef W_OK
1548# define W_OK 2 /* for systems that don't have W_OK in unistd.h */
1549#endif
1550#ifndef R_OK
1551# define R_OK 4 /* for systems that don't have R_OK in unistd.h */
1552#endif
1553
1554/*
1555 * defines to avoid typecasts from (char_u *) to (char *) and back
1556 * (vim_strchr() and vim_strrchr() are now in alloc.c)
1557 */
1558#define STRLEN(s) strlen((char *)(s))
1559#define STRCPY(d, s) strcpy((char *)(d), (char *)(s))
1560#define STRNCPY(d, s, n) strncpy((char *)(d), (char *)(s), (size_t)(n))
1561#define STRCMP(d, s) strcmp((char *)(d), (char *)(s))
1562#define STRNCMP(d, s, n) strncmp((char *)(d), (char *)(s), (size_t)(n))
1563#ifdef HAVE_STRCASECMP
1564# define STRICMP(d, s) strcasecmp((char *)(d), (char *)(s))
1565#else
1566# ifdef HAVE_STRICMP
1567# define STRICMP(d, s) stricmp((char *)(d), (char *)(s))
1568# else
1569# define STRICMP(d, s) vim_stricmp((char *)(d), (char *)(s))
1570# endif
1571#endif
1572
Bram Moolenaara7241f52008-06-24 20:39:31 +00001573/* Like strcpy() but allows overlapped source and destination. */
1574#define STRMOVE(d, s) mch_memmove((d), (s), STRLEN(s) + 1)
1575
Bram Moolenaar071d4272004-06-13 20:20:40 +00001576#ifdef HAVE_STRNCASECMP
1577# define STRNICMP(d, s, n) strncasecmp((char *)(d), (char *)(s), (size_t)(n))
1578#else
1579# ifdef HAVE_STRNICMP
1580# define STRNICMP(d, s, n) strnicmp((char *)(d), (char *)(s), (size_t)(n))
1581# else
1582# define STRNICMP(d, s, n) vim_strnicmp((char *)(d), (char *)(s), (size_t)(n))
1583# endif
1584#endif
1585
1586#ifdef FEAT_MBYTE
Bram Moolenaara245a5b2007-08-11 11:58:23 +00001587/* We need to call mb_stricmp() even when we aren't dealing with a multi-byte
1588 * encoding because mb_stricmp() takes care of all ascii and non-ascii
Bram Moolenaar42b4dda2010-03-02 15:56:05 +01001589 * encodings, including characters with umlauts in latin1, etc., while
Bram Moolenaara245a5b2007-08-11 11:58:23 +00001590 * STRICMP() only handles the system locale version, which often does not
1591 * handle non-ascii properly. */
1592
1593# define MB_STRICMP(d, s) mb_strnicmp((char_u *)(d), (char_u *)(s), (int)MAXCOL)
1594# define MB_STRNICMP(d, s, n) mb_strnicmp((char_u *)(d), (char_u *)(s), (int)(n))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001595#else
1596# define MB_STRICMP(d, s) STRICMP((d), (s))
1597# define MB_STRNICMP(d, s, n) STRNICMP((d), (s), (n))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001598#endif
1599
1600#define STRCAT(d, s) strcat((char *)(d), (char *)(s))
1601#define STRNCAT(d, s, n) strncat((char *)(d), (char *)(s), (size_t)(n))
1602
1603#ifdef HAVE_STRPBRK
1604# define vim_strpbrk(s, cs) (char_u *)strpbrk((char *)(s), (char *)(cs))
1605#endif
1606
1607#define MSG(s) msg((char_u *)(s))
1608#define MSG_ATTR(s, attr) msg_attr((char_u *)(s), (attr))
1609#define EMSG(s) emsg((char_u *)(s))
1610#define EMSG2(s, p) emsg2((char_u *)(s), (char_u *)(p))
1611#define EMSG3(s, p, q) emsg3((char_u *)(s), (char_u *)(p), (char_u *)(q))
1612#define EMSGN(s, n) emsgn((char_u *)(s), (long)(n))
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001613#define EMSGU(s, n) emsgu((char_u *)(s), (long_u)(n))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001614#define OUT_STR(s) out_str((char_u *)(s))
1615#define OUT_STR_NF(s) out_str_nf((char_u *)(s))
1616#define MSG_PUTS(s) msg_puts((char_u *)(s))
1617#define MSG_PUTS_ATTR(s, a) msg_puts_attr((char_u *)(s), (a))
1618#define MSG_PUTS_TITLE(s) msg_puts_title((char_u *)(s))
Bram Moolenaar1d73c882005-06-19 22:48:47 +00001619#define MSG_PUTS_LONG(s) msg_puts_long_attr((char_u *)(s), 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001620#define MSG_PUTS_LONG_ATTR(s, a) msg_puts_long_attr((char_u *)(s), (a))
1621
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001622#ifdef FEAT_GUI
Bram Moolenaar61be73b2016-04-29 22:59:22 +02001623# ifdef FEAT_TERMGUICOLORS
1624# define GUI_FUNCTION(f) (gui.in_use ? gui_##f : termgui_##f)
Bram Moolenaar187147a2016-05-01 13:09:57 +02001625# define GUI_FUNCTION2(f, pixel) (gui.in_use \
1626 ? ((pixel) != INVALCOLOR \
1627 ? gui_##f((pixel)) \
1628 : (long_u)INVALCOLOR) \
1629 : termgui_##f((pixel)))
Bram Moolenaar61be73b2016-04-29 22:59:22 +02001630# define USE_24BIT (gui.in_use || p_tgc)
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001631# else
1632# define GUI_FUNCTION(f) gui_##f
Bram Moolenaar187147a2016-05-01 13:09:57 +02001633# define GUI_FUNCTION2(f,pixel) ((pixel) != INVALCOLOR \
1634 ? gui_##f((pixel)) \
1635 : (long_u)INVALCOLOR)
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001636# define USE_24BIT gui.in_use
1637# endif
1638#else
Bram Moolenaar61be73b2016-04-29 22:59:22 +02001639# ifdef FEAT_TERMGUICOLORS
1640# define GUI_FUNCTION(f) termgui_##f
Bram Moolenaar187147a2016-05-01 13:09:57 +02001641# define GUI_FUNCTION2(f, pixel) termgui_##f((pixel))
Bram Moolenaar61be73b2016-04-29 22:59:22 +02001642# define USE_24BIT p_tgc
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001643# endif
1644#endif
Bram Moolenaar61be73b2016-04-29 22:59:22 +02001645#ifdef FEAT_TERMGUICOLORS
1646# define IS_CTERM (t_colors > 1 || p_tgc)
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001647#else
1648# define IS_CTERM (t_colors > 1)
1649#endif
1650#ifdef GUI_FUNCTION
1651# define GUI_MCH_GET_RGB GUI_FUNCTION(mch_get_rgb)
Bram Moolenaar187147a2016-05-01 13:09:57 +02001652# define GUI_MCH_GET_RGB2(pixel) GUI_FUNCTION2(mch_get_rgb, (pixel))
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001653# define GUI_MCH_GET_COLOR GUI_FUNCTION(mch_get_color)
1654# define GUI_GET_COLOR GUI_FUNCTION(get_color)
1655#endif
1656
Bram Moolenaar071d4272004-06-13 20:20:40 +00001657/* Prefer using emsg3(), because perror() may send the output to the wrong
1658 * destination and mess up the screen. */
1659#ifdef HAVE_STRERROR
1660# define PERROR(msg) (void)emsg3((char_u *)"%s: %s", (char_u *)msg, (char_u *)strerror(errno))
1661#else
Bram Moolenaarb869c0d2016-07-20 00:10:51 +02001662# define PERROR(msg) do_perror(msg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001663#endif
1664
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001665typedef long linenr_T; /* line number type */
1666typedef int colnr_T; /* column number type */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667typedef unsigned short disptick_T; /* display tick type */
1668
1669#define MAXLNUM (0x7fffffffL) /* maximum (invalid) line number */
1670
1671/*
1672 * Well, you won't believe it, but some S/390 machines ("host", now also known
Bram Moolenaar883f5d02010-06-21 06:24:34 +02001673 * as zServer) use 31 bit pointers. There are also some newer machines, that
Bram Moolenaar071d4272004-06-13 20:20:40 +00001674 * use 64 bit pointers. I don't know how to distinguish between 31 and 64 bit
1675 * machines, so the best way is to assume 31 bits whenever we detect OS/390
1676 * Unix.
1677 * With this we restrict the maximum line length to 1073741823. I guess this is
1678 * not a real problem. BTW: Longer lines are split.
1679 */
Bram Moolenaara2aa31a2014-02-23 22:52:40 +01001680#if VIM_SIZEOF_INT >= 4
Bram Moolenaar071d4272004-06-13 20:20:40 +00001681# ifdef __MVS__
1682# define MAXCOL (0x3fffffffL) /* maximum column number, 30 bits */
1683# else
1684# define MAXCOL (0x7fffffffL) /* maximum column number, 31 bits */
1685# endif
1686#else
1687# define MAXCOL (0x7fff) /* maximum column number, 15 bits */
1688#endif
1689
1690#define SHOWCMD_COLS 10 /* columns needed by shown command */
1691#define STL_MAX_ITEM 80 /* max nr of %<flag> in statusline */
1692
1693typedef void *vim_acl_T; /* dummy to pass an ACL to a function */
1694
1695/*
1696 * Include a prototype for mch_memmove(), it may not be in alloc.pro.
1697 */
1698#ifdef VIM_MEMMOVE
Bram Moolenaard99df422016-01-29 23:20:40 +01001699void mch_memmove(void *, void *, size_t);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001700#else
1701# ifndef mch_memmove
1702# define mch_memmove(to, from, len) memmove(to, from, len)
1703# endif
1704#endif
1705
1706/*
1707 * fnamecmp() is used to compare file names.
1708 * On some systems case in a file name does not matter, on others it does.
1709 * (this does not account for maximum name lengths and things like "../dir",
1710 * thus it is not 100% accurate!)
1711 */
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01001712#define fnamecmp(x, y) vim_fnamecmp((char_u *)(x), (char_u *)(y))
1713#define fnamencmp(x, y, n) vim_fnamencmp((char_u *)(x), (char_u *)(y), (size_t)(n))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001714
1715#ifdef HAVE_MEMSET
1716# define vim_memset(ptr, c, size) memset((ptr), (c), (size))
1717#else
Bram Moolenaard99df422016-01-29 23:20:40 +01001718void *vim_memset(void *, int, size_t);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001719#endif
1720
1721#ifdef HAVE_MEMCMP
1722# define vim_memcmp(p1, p2, len) memcmp((p1), (p2), (len))
1723#else
1724# ifdef HAVE_BCMP
1725# define vim_memcmp(p1, p2, len) bcmp((p1), (p2), (len))
1726# else
Bram Moolenaard99df422016-01-29 23:20:40 +01001727int vim_memcmp(void *, void *, size_t);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001728# define VIM_MEMCMP
1729# endif
1730#endif
1731
Bram Moolenaare7fedb62015-12-31 19:07:19 +01001732#if defined(UNIX) || defined(FEAT_GUI) || defined(VMS) \
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733 || defined(FEAT_CLIENTSERVER)
1734# define USE_INPUT_BUF
1735#endif
1736
Bram Moolenaar540fc6f2010-12-17 16:27:16 +01001737#ifndef EINTR
1738# define read_eintr(fd, buf, count) vim_read((fd), (buf), (count))
1739# define write_eintr(fd, buf, count) vim_write((fd), (buf), (count))
1740#endif
1741
Bram Moolenaar071d4272004-06-13 20:20:40 +00001742#ifdef MSWIN
1743/* On MS-Windows the third argument isn't size_t. This matters for Win64,
1744 * where sizeof(size_t)==8, not 4 */
1745# define vim_read(fd, buf, count) read((fd), (char *)(buf), (unsigned int)(count))
1746# define vim_write(fd, buf, count) write((fd), (char *)(buf), (unsigned int)(count))
1747#else
1748# define vim_read(fd, buf, count) read((fd), (char *)(buf), (size_t) (count))
1749# define vim_write(fd, buf, count) write((fd), (char *)(buf), (size_t) (count))
1750#endif
1751
1752/*
1753 * Enums need a typecast to be used as array index (for Ultrix).
1754 */
1755#define hl_attr(n) highlight_attr[(int)(n)]
1756#define term_str(n) term_strings[(int)(n)]
1757
1758/*
1759 * vim_iswhite() is used for "^" and the like. It differs from isspace()
1760 * because it doesn't include <CR> and <LF> and the like.
1761 */
1762#define vim_iswhite(x) ((x) == ' ' || (x) == '\t')
1763
Bram Moolenaara226a6d2006-02-26 23:59:20 +00001764/*
1765 * EXTERN is only defined in main.c. That's where global variables are
1766 * actually defined and initialized.
1767 */
1768#ifndef EXTERN
1769# define EXTERN extern
1770# define INIT(x)
1771#else
1772# ifndef INIT
1773# define INIT(x) x
1774# define DO_INIT
Bram Moolenaarac77aec2016-07-26 22:02:54 +02001775# define COMMA ,
Bram Moolenaara226a6d2006-02-26 23:59:20 +00001776# endif
1777#endif
1778
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001779#ifdef FEAT_MBYTE
1780# define MAX_MCO 6 /* maximum value for 'maxcombine' */
1781
1782/* Maximum number of bytes in a multi-byte character. It can be one 32-bit
1783 * character of up to 6 bytes, or one 16-bit character of up to three bytes
1784 * plus six following composing characters of three bytes each. */
1785# define MB_MAXBYTES 21
Bram Moolenaar9a920d82012-06-01 15:21:02 +02001786#else
1787# define MB_MAXBYTES 1
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001788#endif
1789
Bram Moolenaar91a4e822008-01-19 14:59:58 +00001790#if (defined(FEAT_PROFILE) || defined(FEAT_RELTIME)) && !defined(PROTO)
1791# ifdef WIN3264
1792typedef LARGE_INTEGER proftime_T;
1793# else
1794typedef struct timeval proftime_T;
1795# endif
1796#else
1797typedef int proftime_T; /* dummy for function prototypes */
1798#endif
1799
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +02001800/*
1801 * When compiling with 32 bit Perl time_t is 32 bits in the Perl code but 64
1802 * bits elsewhere. That causes memory corruption. Define time_T and use it
1803 * for global variables to avoid that.
1804 */
1805#ifdef WIN3264
1806typedef __time64_t time_T;
1807#else
1808typedef time_t time_T;
1809#endif
1810
Bram Moolenaard8070362016-02-15 21:56:54 +01001811#ifdef _WIN64
Bram Moolenaard090d7b2016-02-13 17:09:53 +01001812typedef __int64 sock_T;
Bram Moolenaarf8b7d892016-02-13 17:24:26 +01001813#else
Bram Moolenaard090d7b2016-02-13 17:09:53 +01001814typedef int sock_T;
Bram Moolenaard090d7b2016-02-13 17:09:53 +01001815#endif
1816
Bram Moolenaara226a6d2006-02-26 23:59:20 +00001817/* Include option.h before structs.h, because the number of window-local and
1818 * buffer-local options is used there. */
1819#include "option.h" /* options and default values */
1820
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821/* Note that gui.h is included by structs.h */
1822
1823#include "structs.h" /* file that defines many structures */
1824
Bram Moolenaar28fb79d2016-01-09 22:28:33 +01001825#include "alloc.h"
1826
Bram Moolenaar371d5402006-03-20 21:47:49 +00001827/* Values for "do_profiling". */
1828#define PROF_NONE 0 /* profiling not started */
1829#define PROF_YES 1 /* profiling busy */
1830#define PROF_PAUSED 2 /* profiling paused */
1831
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832#ifdef FEAT_MOUSE
1833
1834/* Codes for mouse button events in lower three bits: */
1835# define MOUSE_LEFT 0x00
1836# define MOUSE_MIDDLE 0x01
1837# define MOUSE_RIGHT 0x02
1838# define MOUSE_RELEASE 0x03
1839
1840/* bit masks for modifiers: */
1841# define MOUSE_SHIFT 0x04
1842# define MOUSE_ALT 0x08
1843# define MOUSE_CTRL 0x10
1844
1845/* mouse buttons that are handled like a key press (GUI only) */
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +02001846/* Note that the scroll wheel keys are inverted: MOUSE_5 scrolls lines up but
1847 * the result of this is that the window moves down, similarly MOUSE_6 scrolls
1848 * columns left but the window moves right. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001849# define MOUSE_4 0x100 /* scroll wheel down */
1850# define MOUSE_5 0x200 /* scroll wheel up */
1851
1852# define MOUSE_X1 0x300 /* Mouse-button X1 (6th) */
1853# define MOUSE_X2 0x400 /* Mouse-button X2 */
1854
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +02001855# define MOUSE_6 0x500 /* scroll wheel left */
1856# define MOUSE_7 0x600 /* scroll wheel right */
1857
Bram Moolenaar071d4272004-06-13 20:20:40 +00001858/* 0x20 is reserved by xterm */
1859# define MOUSE_DRAG_XTERM 0x40
1860
1861# define MOUSE_DRAG (0x40 | MOUSE_RELEASE)
1862
1863/* Lowest button code for using the mouse wheel (xterm only) */
1864# define MOUSEWHEEL_LOW 0x60
1865
1866# define MOUSE_CLICK_MASK 0x03
1867
1868# define NUM_MOUSE_CLICKS(code) \
1869 (((unsigned)((code) & 0xC0) >> 6) + 1)
1870
1871# define SET_NUM_MOUSE_CLICKS(code, num) \
1872 (code) = ((code) & 0x3f) | ((((num) - 1) & 3) << 6)
1873
Bram Moolenaar6f3058f2005-04-24 21:58:05 +00001874/* Added to mouse column for GUI when 'mousefocus' wants to give focus to a
1875 * window by simulating a click on its status line. We could use up to 128 *
1876 * 128 = 16384 columns, now it's reduced to 10000. */
1877# define MOUSE_COLOFF 10000
1878
Bram Moolenaar071d4272004-06-13 20:20:40 +00001879/*
1880 * jump_to_mouse() returns one of first four these values, possibly with
1881 * some of the other three added.
1882 */
1883# define IN_UNKNOWN 0
1884# define IN_BUFFER 1
1885# define IN_STATUS_LINE 2 /* on status or command line */
1886# define IN_SEP_LINE 4 /* on vertical separator line */
1887# define IN_OTHER_WIN 8 /* in other window but can't go there */
1888# define CURSOR_MOVED 0x100
1889# define MOUSE_FOLD_CLOSE 0x200 /* clicked on '-' in fold column */
1890# define MOUSE_FOLD_OPEN 0x400 /* clicked on '+' in fold column */
1891
1892/* flags for jump_to_mouse() */
1893# define MOUSE_FOCUS 0x01 /* need to stay in this window */
1894# define MOUSE_MAY_VIS 0x02 /* may start Visual mode */
1895# define MOUSE_DID_MOVE 0x04 /* only act when mouse has moved */
1896# define MOUSE_SETPOS 0x08 /* only set current mouse position */
1897# define MOUSE_MAY_STOP_VIS 0x10 /* may stop Visual mode */
1898# define MOUSE_RELEASED 0x20 /* button was released */
1899
1900# if defined(UNIX) && defined(HAVE_GETTIMEOFDAY) && defined(HAVE_SYS_TIME_H)
1901# define CHECK_DOUBLE_CLICK 1 /* Checking for double clicks ourselves. */
1902# endif
1903
1904#endif /* FEAT_MOUSE */
1905
1906/* defines for eval_vars() */
1907#define VALID_PATH 1
1908#define VALID_HEAD 2
1909
1910/* Defines for Vim variables. These must match vimvars[] in eval.c! */
1911#define VV_COUNT 0
1912#define VV_COUNT1 1
1913#define VV_PREVCOUNT 2
1914#define VV_ERRMSG 3
1915#define VV_WARNINGMSG 4
1916#define VV_STATUSMSG 5
1917#define VV_SHELL_ERROR 6
1918#define VV_THIS_SESSION 7
1919#define VV_VERSION 8
1920#define VV_LNUM 9
1921#define VV_TERMRESPONSE 10
1922#define VV_FNAME 11
1923#define VV_LANG 12
1924#define VV_LC_TIME 13
1925#define VV_CTYPE 14
1926#define VV_CC_FROM 15
1927#define VV_CC_TO 16
1928#define VV_FNAME_IN 17
1929#define VV_FNAME_OUT 18
1930#define VV_FNAME_NEW 19
1931#define VV_FNAME_DIFF 20
1932#define VV_CMDARG 21
1933#define VV_FOLDSTART 22
1934#define VV_FOLDEND 23
1935#define VV_FOLDDASHES 24
1936#define VV_FOLDLEVEL 25
1937#define VV_PROGNAME 26
1938#define VV_SEND_SERVER 27
1939#define VV_DYING 28
1940#define VV_EXCEPTION 29
1941#define VV_THROWPOINT 30
1942#define VV_REG 31
1943#define VV_CMDBANG 32
Bram Moolenaar843ee412004-06-30 16:16:41 +00001944#define VV_INSERTMODE 33
Bram Moolenaar6d14ccd2005-01-15 22:08:30 +00001945#define VV_VAL 34
1946#define VV_KEY 35
Bram Moolenaar05159a02005-02-26 23:04:13 +00001947#define VV_PROFILING 36
Bram Moolenaar19a09a12005-03-04 23:39:37 +00001948#define VV_FCS_REASON 37
1949#define VV_FCS_CHOICE 38
Bram Moolenaar52b4b552005-03-07 23:00:57 +00001950#define VV_BEVAL_BUFNR 39
1951#define VV_BEVAL_WINNR 40
Bram Moolenaarc9721bd2016-06-04 17:41:03 +02001952#define VV_BEVAL_WINID 41
1953#define VV_BEVAL_LNUM 42
1954#define VV_BEVAL_COL 43
1955#define VV_BEVAL_TEXT 44
1956#define VV_SCROLLSTART 45
1957#define VV_SWAPNAME 46
1958#define VV_SWAPCHOICE 47
1959#define VV_SWAPCOMMAND 48
1960#define VV_CHAR 49
1961#define VV_MOUSE_WIN 50
Bram Moolenaar511972d2016-06-04 18:09:59 +02001962#define VV_MOUSE_WINID 51
1963#define VV_MOUSE_LNUM 52
1964#define VV_MOUSE_COL 53
1965#define VV_OP 54
1966#define VV_SEARCHFORWARD 55
1967#define VV_HLSEARCH 56
1968#define VV_OLDFILES 57
1969#define VV_WINDOWID 58
1970#define VV_PROGPATH 59
1971#define VV_COMPLETED_ITEM 60
1972#define VV_OPTION_NEW 61
1973#define VV_OPTION_OLD 62
1974#define VV_OPTION_TYPE 63
1975#define VV_ERRORS 64
1976#define VV_FALSE 65
1977#define VV_TRUE 66
1978#define VV_NULL 67
1979#define VV_NONE 68
1980#define VV_VIM_DID_ENTER 69
1981#define VV_TESTING 70
Bram Moolenaarf562e722016-07-19 17:25:25 +02001982#define VV_TYPE_NUMBER 71
1983#define VV_TYPE_STRING 72
1984#define VV_TYPE_FUNC 73
1985#define VV_TYPE_LIST 74
1986#define VV_TYPE_DICT 75
1987#define VV_TYPE_FLOAT 76
1988#define VV_TYPE_BOOL 77
1989#define VV_TYPE_NONE 78
1990#define VV_TYPE_JOB 79
1991#define VV_TYPE_CHANNEL 80
1992#define VV_LEN 81 /* number of v: vars */
Bram Moolenaar520e1e42016-01-23 19:46:28 +01001993
1994/* used for v_number in VAR_SPECIAL */
1995#define VVAL_FALSE 0L
1996#define VVAL_TRUE 1L
1997#define VVAL_NONE 2L
1998#define VVAL_NULL 3L
Bram Moolenaar071d4272004-06-13 20:20:40 +00001999
Bram Moolenaarf562e722016-07-19 17:25:25 +02002000/* Type values for type(). */
2001#define VAR_TYPE_NUMBER 0
2002#define VAR_TYPE_STRING 1
2003#define VAR_TYPE_FUNC 2
2004#define VAR_TYPE_LIST 3
2005#define VAR_TYPE_DICT 4
2006#define VAR_TYPE_FLOAT 5
2007#define VAR_TYPE_BOOL 6
2008#define VAR_TYPE_NONE 7
2009#define VAR_TYPE_JOB 8
2010#define VAR_TYPE_CHANNEL 9
2011
Bram Moolenaar071d4272004-06-13 20:20:40 +00002012#ifdef FEAT_CLIPBOARD
2013
2014/* VIM_ATOM_NAME is the older Vim-specific selection type for X11. Still
2015 * supported for when a mix of Vim versions is used. VIMENC_ATOM_NAME includes
2016 * the encoding to support Vims using different 'encoding' values. */
Bram Moolenaar08ed30e2013-01-17 17:17:26 +01002017# define VIM_ATOM_NAME "_VIM_TEXT"
2018# define VIMENC_ATOM_NAME "_VIMENC_TEXT"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002019
2020/* Selection states for modeless selection */
2021# define SELECT_CLEARED 0
2022# define SELECT_IN_PROGRESS 1
2023# define SELECT_DONE 2
2024
2025# define SELECT_MODE_CHAR 0
2026# define SELECT_MODE_WORD 1
2027# define SELECT_MODE_LINE 2
2028
2029# ifdef FEAT_GUI_W32
2030# ifdef FEAT_OLE
2031# define WM_OLE (WM_APP+0)
2032# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033# endif
2034
2035/* Info about selected text */
2036typedef struct VimClipboard
2037{
2038 int available; /* Is clipboard available? */
2039 int owned; /* Flag: do we own the selection? */
2040 pos_T start; /* Start of selected area */
2041 pos_T end; /* End of selected area */
2042 int vmode; /* Visual mode character */
2043
2044 /* Fields for selection that doesn't use Visual mode */
2045 short_u origin_row;
2046 short_u origin_start_col;
2047 short_u origin_end_col;
2048 short_u word_start_col;
2049 short_u word_end_col;
2050
2051 pos_T prev; /* Previous position */
2052 short_u state; /* Current selection state */
2053 short_u mode; /* Select by char, word, or line. */
2054
2055# if defined(FEAT_GUI_X11) || defined(FEAT_XCLIPBOARD)
2056 Atom sel_atom; /* PRIMARY/CLIPBOARD selection ID */
2057# endif
2058
2059# ifdef FEAT_GUI_GTK
2060 GdkAtom gtk_sel_atom; /* PRIMARY/CLIPBOARD selection ID */
2061# endif
2062
Bram Moolenaar693e40c2013-02-26 14:56:42 +01002063# if defined(MSWIN) || defined(FEAT_CYGWIN_WIN32_CLIPBOARD)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002064 int_u format; /* Vim's own special clipboard format */
2065 int_u format_raw; /* Vim's raw text clipboard format */
2066# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002067} VimClipboard;
2068#else
2069typedef int VimClipboard; /* This is required for the prototypes. */
2070#endif
2071
2072#ifdef __BORLANDC__
2073/* work around a bug in the Borland 'stat' function: */
2074# include <io.h> /* for access() */
2075
2076# define stat(a,b) (access(a,0) ? -1 : stat(a,b))
2077#endif
2078
Bram Moolenaar8767f522016-07-01 17:17:39 +02002079/* Use 64-bit stat structure if available. */
2080#if (defined(_MSC_VER) && (_MSC_VER >= 1300)) || defined(__MINGW32__)
2081# define HAVE_STAT64
2082typedef struct _stat64 stat_T;
2083#else
2084typedef struct stat stat_T;
2085#endif
2086
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02002087typedef enum
2088{
2089 ASSERT_EQUAL,
2090 ASSERT_NOTEQUAL,
2091 ASSERT_MATCH,
2092 ASSERT_NOTMATCH,
2093 ASSERT_OTHER
2094} assert_type_T;
2095
Bram Moolenaar071d4272004-06-13 20:20:40 +00002096#include "ex_cmds.h" /* Ex command defines */
Bram Moolenaar6cfdb2a2016-07-19 17:01:31 +02002097#include "spell.h" /* spell checking stuff */
2098
Bram Moolenaar071d4272004-06-13 20:20:40 +00002099#include "proto.h" /* function prototypes */
2100
2101/* This has to go after the include of proto.h, as proto/gui.pro declares
2102 * functions of these names. The declarations would break if the defines had
2103 * been seen at that stage. But it must be before globals.h, where error_ga
2104 * is declared. */
2105#if !defined(FEAT_GUI_W32) && !defined(FEAT_GUI_X11) \
Bram Moolenaarcef9dcc2005-12-06 19:50:41 +00002106 && !defined(FEAT_GUI_GTK) && !defined(FEAT_GUI_MAC)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002107# define mch_errmsg(str) fprintf(stderr, "%s", (str))
2108# define display_errors() fflush(stderr)
2109# define mch_msg(str) printf("%s", (str))
2110#else
2111# define USE_MCH_ERRMSG
2112#endif
2113
Bram Moolenaaraab21c32005-01-25 21:46:35 +00002114#ifndef FEAT_MBYTE
2115# define after_pathsep(b, p) vim_ispathsep(*((p) - 1))
2116# define transchar_byte(c) transchar(c)
2117#endif
2118
2119#ifndef FEAT_LINEBREAK
2120/* Without the 'numberwidth' option line numbers are always 7 chars. */
2121# define number_width(x) 7
2122#endif
2123
2124
Bram Moolenaar071d4272004-06-13 20:20:40 +00002125#include "globals.h" /* global variables and messages */
2126
Bram Moolenaar071d4272004-06-13 20:20:40 +00002127#ifndef FEAT_VIRTUALEDIT
2128# define getvvcol(w, p, s, c, e) getvcol(w, p, s, c, e)
Bram Moolenaar76440e22014-11-27 19:14:49 +01002129# define virtual_active() FALSE
Bram Moolenaar071d4272004-06-13 20:20:40 +00002130# define virtual_op FALSE
2131#endif
2132
2133/*
2134 * If console dialog not supported, but GUI dialog is, use the GUI one.
2135 */
2136#if defined(FEAT_GUI_DIALOG) && !defined(FEAT_CON_DIALOG)
2137# define do_dialog gui_mch_dialog
2138#endif
2139
2140/*
2141 * Default filters for gui_mch_browse().
2142 * The filters are almost system independent. Except for the difference
2143 * between "*" and "*.*" for MSDOS-like systems.
2144 * NOTE: Motif only uses the very first pattern. Therefore
2145 * BROWSE_FILTER_DEFAULT should start with a "*" pattern.
2146 */
2147#ifdef FEAT_BROWSE
2148# ifdef BACKSLASH_IN_FILENAME
2149# define BROWSE_FILTER_MACROS \
2150 (char_u *)"Vim macro files (*.vim)\t*.vim\nAll Files (*.*)\t*.*\n"
2151# define BROWSE_FILTER_ALL_FILES (char_u *)"All Files (*.*)\t*.*\n"
2152# define BROWSE_FILTER_DEFAULT \
2153 (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"
2154# else
2155# define BROWSE_FILTER_MACROS \
2156 (char_u *)"Vim macro files (*.vim)\t*.vim\nAll Files (*)\t*\n"
2157# define BROWSE_FILTER_ALL_FILES (char_u *)"All Files (*)\t*\n"
2158# define BROWSE_FILTER_DEFAULT \
2159 (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"
2160# endif
Bram Moolenaar7171abe2004-10-11 10:06:20 +00002161# define BROWSE_SAVE 1 /* flag for do_browse() */
2162# define BROWSE_DIR 2 /* flag for do_browse() */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002163#endif
2164
2165/* stop using fastcall for Borland */
2166#if defined(__BORLANDC__) && defined(WIN32) && !defined(DEBUG)
Bram Moolenaaraab21c32005-01-25 21:46:35 +00002167 #pragma option -p.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002168#endif
2169
Bram Moolenaar442b4222010-05-24 21:34:22 +02002170#ifdef _MSC_VER
2171/* Avoid useless warning "conversion from X to Y of greater size". */
2172 #pragma warning(disable : 4312)
Bram Moolenaareb292852015-02-10 18:47:58 +01002173/* Avoid warning for old style function declarators */
2174 #pragma warning(disable : 4131)
2175/* Avoid warning for conversion to type with smaller range */
2176 #pragma warning(disable : 4244)
2177/* Avoid warning for conversion to larger size */
2178 #pragma warning(disable : 4306)
2179/* Avoid warning for unreferenced formal parameter */
2180 #pragma warning(disable : 4100)
2181/* Avoid warning for differs in indirection to slightly different base type */
2182 #pragma warning(disable : 4057)
2183/* Avoid warning for constant conditional expression */
2184 #pragma warning(disable : 4127)
2185/* Avoid warning for assignment within conditional */
2186 #pragma warning(disable : 4706)
Bram Moolenaar442b4222010-05-24 21:34:22 +02002187#endif
2188
Bram Moolenaar9a920d82012-06-01 15:21:02 +02002189/* Note: a NULL argument for vim_realloc() is not portable, don't use it. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002190#if defined(MEM_PROFILE)
2191# define vim_realloc(ptr, size) mem_realloc((ptr), (size))
2192#else
2193# define vim_realloc(ptr, size) realloc((ptr), (size))
2194#endif
2195
2196/*
Bram Moolenaar34162142007-05-12 13:12:19 +00002197 * The following macros stop display/event loop nesting at the wrong time.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002198 */
2199#ifdef ALT_X_INPUT
2200# define ALT_INPUT_LOCK_OFF suppress_alternate_input = FALSE
2201# define ALT_INPUT_LOCK_ON suppress_alternate_input = TRUE
2202#endif
2203
2204#ifdef FEAT_MBYTE
Bram Moolenaar071d4272004-06-13 20:20:40 +00002205/*
2206 * Return byte length of character that starts with byte "b".
2207 * Returns 1 for a single-byte character.
2208 * MB_BYTE2LEN_CHECK() can be used to count a special key as one byte.
2209 * Don't call MB_BYTE2LEN(b) with b < 0 or b > 255!
2210 */
2211# define MB_BYTE2LEN(b) mb_bytelen_tab[b]
2212# define MB_BYTE2LEN_CHECK(b) (((b) < 0 || (b) > 255) ? 1 : mb_bytelen_tab[b])
2213#endif
2214
2215#if defined(FEAT_MBYTE) || defined(FEAT_POSTSCRIPT)
2216/* properties used in enc_canon_table[] (first three mutually exclusive) */
2217# define ENC_8BIT 0x01
2218# define ENC_DBCS 0x02
2219# define ENC_UNICODE 0x04
2220
2221# define ENC_ENDIAN_B 0x10 /* Unicode: Big endian */
2222# define ENC_ENDIAN_L 0x20 /* Unicode: Little endian */
2223
2224# define ENC_2BYTE 0x40 /* Unicode: UCS-2 */
2225# define ENC_4BYTE 0x80 /* Unicode: UCS-4 */
2226# define ENC_2WORD 0x100 /* Unicode: UTF-16 */
2227
2228# define ENC_LATIN1 0x200 /* Latin1 */
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00002229# define ENC_LATIN9 0x400 /* Latin9 */
2230# define ENC_MACROMAN 0x800 /* Mac Roman (not Macro Man! :-) */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002231#endif
2232
2233#ifdef FEAT_MBYTE
2234# ifdef USE_ICONV
2235# ifndef EILSEQ
2236# define EILSEQ 123
2237# endif
2238# ifdef DYNAMIC_ICONV
2239/* On Win32 iconv.dll is dynamically loaded. */
2240# define ICONV_ERRNO (*iconv_errno())
2241# define ICONV_E2BIG 7
2242# define ICONV_EINVAL 22
2243# define ICONV_EILSEQ 42
2244# else
2245# define ICONV_ERRNO errno
2246# define ICONV_E2BIG E2BIG
2247# define ICONV_EINVAL EINVAL
2248# define ICONV_EILSEQ EILSEQ
2249# endif
2250# endif
2251
2252#endif
2253
2254/* ISSYMLINK(mode) tests if a file is a symbolic link. */
2255#if (defined(S_IFMT) && defined(S_IFLNK)) || defined(S_ISLNK)
2256# define HAVE_ISSYMLINK
2257# if defined(S_IFMT) && defined(S_IFLNK)
2258# define ISSYMLINK(mode) (((mode) & S_IFMT) == S_IFLNK)
2259# else
2260# define ISSYMLINK(mode) S_ISLNK(mode)
2261# endif
2262#endif
2263
2264#define SIGN_BYTE 1 /* byte value used where sign is displayed;
2265 attribute value is sign type */
2266
2267#ifdef FEAT_NETBEANS_INTG
2268# define MULTISIGN_BYTE 2 /* byte value used where sign is displayed if
2269 multiple signs exist on the line */
2270#endif
2271
2272#if defined(FEAT_GUI) && defined(FEAT_XCLIPBOARD)
2273# ifdef FEAT_GUI_GTK
2274 /* Avoid using a global variable for the X display. It's ugly
2275 * and is likely to cause trouble in multihead environments. */
2276# define X_DISPLAY ((gui.in_use) ? gui_mch_get_display() : xterm_dpy)
2277# else
2278# define X_DISPLAY (gui.in_use ? gui.dpy : xterm_dpy)
2279# endif
2280#else
2281# ifdef FEAT_GUI
2282# ifdef FEAT_GUI_GTK
2283# define X_DISPLAY ((gui.in_use) ? gui_mch_get_display() : (Display *)NULL)
2284# else
2285# define X_DISPLAY gui.dpy
2286# endif
2287# else
2288# define X_DISPLAY xterm_dpy
2289# endif
2290#endif
2291
Bram Moolenaar77c604d2012-07-10 13:41:14 +02002292#if defined(FEAT_BROWSE) && defined(GTK_CHECK_VERSION)
2293# if GTK_CHECK_VERSION(2,4,0)
2294# define USE_FILE_CHOOSER
2295# endif
2296#endif
2297
Bram Moolenaar03005972008-11-20 13:12:36 +00002298#ifndef FEAT_NETBEANS_INTG
2299# undef NBDEBUG
2300#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002301#ifdef NBDEBUG /* Netbeans debugging. */
2302# include "nbdebug.h"
2303#else
2304# define nbdebug(a)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002305#endif
2306
2307#ifdef IN_PERL_FILE
2308 /*
2309 * Avoid clashes between Perl and Vim namespace.
2310 */
2311# undef NORMAL
2312# undef STRLEN
2313# undef FF
2314# undef OP_DELETE
2315# undef OP_JOIN
2316# ifdef __BORLANDC__
2317# define NOPROTO 1
2318# endif
2319 /* remove MAX and MIN, included by glib.h, redefined by sys/param.h */
2320# ifdef MAX
2321# undef MAX
2322# endif
2323# ifdef MIN
2324# undef MIN
2325# endif
2326 /* We use _() for gettext(), Perl uses it for function prototypes... */
2327# ifdef _
2328# undef _
2329# endif
2330# ifdef DEBUG
2331# undef DEBUG
2332# endif
2333# ifdef _DEBUG
2334# undef _DEBUG
2335# endif
2336# ifdef instr
2337# undef instr
2338# endif
Bram Moolenaared39e1d2008-08-09 17:55:22 +00002339 /* bool may cause trouble on MACOS but is required on a few other systems
2340 * and for Perl */
2341# if defined(bool) && defined(MACOS) && !defined(FEAT_PERL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002342# undef bool
2343# endif
2344
2345# ifdef __BORLANDC__
2346 /* Borland has the structure stati64 but not _stati64 */
2347# define _stati64 stati64
2348# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002349#endif
2350
Bram Moolenaar5eba4c22005-07-12 22:40:29 +00002351/* values for vim_handle_signal() that are not a signal */
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00002352#define SIGNAL_BLOCK -1
2353#define SIGNAL_UNBLOCK -2
Bram Moolenaare7fedb62015-12-31 19:07:19 +01002354#if !defined(UNIX) && !defined(VMS)
Bram Moolenaar5eba4c22005-07-12 22:40:29 +00002355# define vim_handle_signal(x) 0
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002356#endif
2357
Bram Moolenaar05159a02005-02-26 23:04:13 +00002358/* flags for skip_vimgrep_pat() */
2359#define VGR_GLOBAL 1
2360#define VGR_NOJUMP 2
2361
Bram Moolenaarb0bf8582005-12-13 20:02:15 +00002362/* behavior for bad character, "++bad=" argument */
2363#define BAD_REPLACE '?' /* replace it with '?' (default) */
2364#define BAD_KEEP -1 /* leave it */
2365#define BAD_DROP -2 /* erase it */
2366
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002367/* last argument for do_source() */
2368#define DOSO_NONE 0
2369#define DOSO_VIMRC 1 /* loading vimrc file */
2370#define DOSO_GVIMRC 2 /* loading gvimrc file */
Bram Moolenaar371d5402006-03-20 21:47:49 +00002371
Bram Moolenaard812df62008-11-09 12:46:09 +00002372/* flags for read_viminfo() and children */
2373#define VIF_WANT_INFO 1 /* load non-mark info */
2374#define VIF_WANT_MARKS 2 /* load file marks */
2375#define VIF_FORCEIT 4 /* overwrite info already read */
2376#define VIF_GET_OLDFILES 8 /* load v:oldfiles */
2377
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002378/* flags for buf_freeall() */
2379#define BFA_DEL 1 /* buffer is going to be deleted */
2380#define BFA_WIPE 2 /* buffer is going to be wiped out */
2381#define BFA_KEEP_UNDO 4 /* do not free undo information */
2382
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +02002383/* direction for nv_mousescroll() and ins_mousescroll() */
2384#define MSCR_DOWN 0 /* DOWN must be FALSE */
2385#define MSCR_UP 1
2386#define MSCR_LEFT -1
2387#define MSCR_RIGHT -2
2388
Bram Moolenaar946ffd42010-12-30 12:30:31 +01002389#define KEYLEN_PART_KEY -1 /* keylen value for incomplete key-code */
2390#define KEYLEN_PART_MAP -2 /* keylen value for incomplete mapping */
2391#define KEYLEN_REMOVED 9999 /* keylen value for removed sequence */
2392
Bram Moolenaar1c32dff2011-05-05 16:41:24 +02002393/* Return values from win32_fileinfo(). */
2394#define FILEINFO_OK 0
2395#define FILEINFO_ENC_FAIL 1 /* enc_to_utf16() failed */
2396#define FILEINFO_READ_FAIL 2 /* CreateFile() failed */
2397#define FILEINFO_INFO_FAIL 3 /* GetFileInformationByHandle() failed */
2398
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02002399/* Return value from get_option_value_strict */
2400#define SOPT_BOOL 0x01 /* Boolean option */
2401#define SOPT_NUM 0x02 /* Number option */
2402#define SOPT_STRING 0x04 /* String option */
2403#define SOPT_GLOBAL 0x08 /* Option has global value */
2404#define SOPT_WIN 0x10 /* Option has window-local value */
2405#define SOPT_BUF 0x20 /* Option has buffer-local value */
2406#define SOPT_UNSET 0x40 /* Option does not have local value set */
2407
Bram Moolenaar1028f4d2014-01-14 16:55:00 +01002408/* Option types for various functions in option.c */
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02002409#define SREQ_GLOBAL 0 /* Request global option */
2410#define SREQ_WIN 1 /* Request window-local option */
2411#define SREQ_BUF 2 /* Request buffer-local option */
2412
Bram Moolenaarb7cb42b2014-04-02 19:55:10 +02002413/* Flags for get_reg_contents */
2414#define GREG_NO_EXPR 1 /* Do not allow expression register */
2415#define GREG_EXPR_SRC 2 /* Return expression itself for "=" register */
2416#define GREG_LIST 4 /* Return list */
2417
Bram Moolenaar018acca2013-05-30 13:37:28 +02002418/* Character used as separated in autoload function/variable names. */
2419#define AUTOLOAD_CHAR '#'
2420
Bram Moolenaar8050efa2013-11-08 04:30:20 +01002421#ifdef FEAT_EVAL
Bram Moolenaar76440e22014-11-27 19:14:49 +01002422# 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 +01002423#else
2424# define SET_NO_HLSEARCH(flag) no_hlsearch = (flag)
2425#endif
2426
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01002427#ifdef FEAT_JOB_CHANNEL
Bram Moolenaare0874f82016-01-24 20:36:41 +01002428# define MAX_OPEN_CHANNELS 10
2429#else
2430# define MAX_OPEN_CHANNELS 0
2431#endif
2432
Bram Moolenaar595e64e2016-02-07 19:19:53 +01002433/* Options for json_encode() and json_decode. */
2434#define JSON_JS 1 /* use JS instead of JSON */
2435#define JSON_NO_NONE 2 /* v:none item not allowed */
2436
Bram Moolenaar4349c572016-01-30 13:28:28 +01002437#ifdef FEAT_MZSCHEME
2438/* this is in main.c, cproto can't handle it. */
2439int vim_main2(int argc, char **argv);
2440#endif
2441
Bram Moolenaar6bef5302016-03-12 21:28:26 +01002442/* Used for flags of do_in_path() */
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01002443#define DIP_ALL 0x01 /* all matches, not just the first one */
2444#define DIP_DIR 0x02 /* find directories instead of files. */
2445#define DIP_ERR 0x04 /* give an error message when none found. */
2446#define DIP_START 0x08 /* also use "start" directory in 'packpath' */
2447#define DIP_OPT 0x10 /* also use "opt" directory in 'packpath' */
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01002448#define DIP_NORTP 0x20 /* do not use 'runtimepath' */
Bram Moolenaar6bef5302016-03-12 21:28:26 +01002449
Bram Moolenaar888ccac2016-06-04 18:49:36 +02002450/* Lowest number used for window ID. Cannot have this many windows. */
2451#define LOWEST_WIN_ID 1000
2452
Bram Moolenaarcd524592016-07-17 14:57:05 +02002453/* Used by the garbage collector. */
2454#define COPYID_INC 2
2455#define COPYID_MASK (~0x1)
2456
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002457/* Values for trans_function_name() argument: */
2458#define TFN_INT 1 /* internal function name OK */
2459#define TFN_QUIET 2 /* no error messages */
2460#define TFN_NO_AUTOLOAD 4 /* do not use script autoloading */
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002461#define TFN_NO_DEREF 8 /* do not dereference a Funcref */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002462
2463/* Values for get_lval() flags argument: */
2464#define GLV_QUIET TFN_QUIET /* no error messages */
2465#define GLV_NO_AUTOLOAD TFN_NO_AUTOLOAD /* do not use script autoloading */
2466
2467#define DO_NOT_FREE_CNT 99999 /* refcount for dict or list that should not
2468 be freed. */
2469
2470/* errors for when calling a function */
2471#define ERROR_UNKNOWN 0
2472#define ERROR_TOOMANY 1
2473#define ERROR_TOOFEW 2
2474#define ERROR_SCRIPT 3
2475#define ERROR_DICT 4
2476#define ERROR_NONE 5
2477#define ERROR_OTHER 6
2478
2479/* flags for find_name_end() */
2480#define FNE_INCL_BR 1 /* include [] in name */
2481#define FNE_CHECK_START 2 /* check name starts with valid character */
2482
Bram Moolenaar071d4272004-06-13 20:20:40 +00002483#endif /* VIM__H */