blob: 7f29b613a4078a0f550865460db4515be4eb991b [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 *
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 Moolenaar32d19c12018-09-13 17:26:54 +020012#include "protodef.h"
Bram Moolenaar0f1e6432017-11-18 20:22:24 +010013
Bram Moolenaara06ecab2016-07-16 14:47:36 +020014/* use fastcall for Borland, when compiling for Win32 */
Bram Moolenaar071d4272004-06-13 20:20:40 +000015#if defined(__BORLANDC__) && defined(WIN32) && !defined(DEBUG)
16#if defined(FEAT_PERL) || \
17 defined(FEAT_PYTHON) || \
Bram Moolenaarbd5e15f2010-07-17 21:19:38 +020018 defined(FEAT_PYTHON3) || \
Bram Moolenaar071d4272004-06-13 20:20:40 +000019 defined(FEAT_RUBY) || \
20 defined(FEAT_TCL) || \
Bram Moolenaar325b7a22004-07-05 15:58:32 +000021 defined(FEAT_MZSCHEME) || \
Bram Moolenaar071d4272004-06-13 20:20:40 +000022 defined(DYNAMIC_GETTEXT) || \
23 defined(DYNAMIC_ICONV) || \
24 defined(DYNAMIC_IME) || \
25 defined(XPM)
Bram Moolenaaraab21c32005-01-25 21:46:35 +000026 #pragma option -pc
Bram Moolenaar071d4272004-06-13 20:20:40 +000027# else
Bram Moolenaaraab21c32005-01-25 21:46:35 +000028 #pragma option -pr
Bram Moolenaar071d4272004-06-13 20:20:40 +000029# endif
30#endif
31
Bram Moolenaara06ecab2016-07-16 14:47:36 +020032#if defined(WIN32) || defined(_WIN64)
Bram Moolenaar9c263032010-12-17 18:06:06 +010033# include "vimio.h"
34#endif
35
Bram Moolenaar071d4272004-06-13 20:20:40 +000036/* ============ the header file puzzle (ca. 50-100 pieces) ========= */
37
38#ifdef HAVE_CONFIG_H /* GNU autoconf (or something else) was here */
39# include "auto/config.h"
40# define HAVE_PATHDEF
41
42/*
Bram Moolenaarc1762cc2007-05-10 16:56:30 +000043 * Check if configure correctly managed to find sizeof(int). If this failed,
Bram Moolenaar071d4272004-06-13 20:20:40 +000044 * it becomes zero. This is likely a problem of not being able to run the
45 * test program. Other items from configure may also be wrong then!
46 */
Bram Moolenaara2aa31a2014-02-23 22:52:40 +010047# if (VIM_SIZEOF_INT == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +000048 Error: configure did not run properly. Check auto/config.log.
49# endif
50
51/*
Bram Moolenaarc1762cc2007-05-10 16:56:30 +000052 * Cygwin may have fchdir() in a newer release, but in most versions it
Bram Moolenaar071d4272004-06-13 20:20:40 +000053 * doesn't work well and avoiding it keeps the binary backward compatible.
54 */
55# if defined(__CYGWIN32__) && defined(HAVE_FCHDIR)
56# undef HAVE_FCHDIR
57# endif
Bram Moolenaarfa7584c2010-05-19 21:57:45 +020058
59/* We may need to define the uint32_t on non-Unix system, but using the same
60 * identifier causes conflicts. Therefore use UINT32_T. */
Bram Moolenaar7db5fc82010-05-24 11:59:29 +020061# define UINT32_TYPEDEF uint32_t
Bram Moolenaarfa7584c2010-05-19 21:57:45 +020062#endif
63
Bram Moolenaar7db5fc82010-05-24 11:59:29 +020064#if !defined(UINT32_TYPEDEF)
Bram Moolenaarfa7584c2010-05-19 21:57:45 +020065# if defined(uint32_t) /* this doesn't catch typedefs, unfortunately */
Bram Moolenaar7db5fc82010-05-24 11:59:29 +020066# define UINT32_TYPEDEF uint32_t
Bram Moolenaarfa7584c2010-05-19 21:57:45 +020067# else
68 /* Fall back to assuming unsigned int is 32 bit. If this is wrong then the
69 * test in blowfish.c will fail. */
Bram Moolenaar7db5fc82010-05-24 11:59:29 +020070# define UINT32_TYPEDEF unsigned int
Bram Moolenaarfa7584c2010-05-19 21:57:45 +020071# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +000072#endif
73
Bram Moolenaar311d9822007-02-27 15:48:28 +000074/* user ID of root is usually zero, but not for everybody */
75#ifdef __TANDEM
Bram Moolenaar25153e12010-02-24 14:47:08 +010076# ifndef _TANDEM_SOURCE
77# define _TANDEM_SOURCE
78# endif
Bram Moolenaar311d9822007-02-27 15:48:28 +000079# include <floss.h>
80# define ROOT_UID 65535
Bram Moolenaar03305f32014-03-24 19:44:09 +010081# define OLDXAW
82# if (_TANDEM_ARCH_ == 2 && __H_Series_RVU >= 621)
83# define SA_ONSTACK_COMPATIBILITY
84# endif
Bram Moolenaar311d9822007-02-27 15:48:28 +000085#else
86# define ROOT_UID 0
87#endif
88
Bram Moolenaar071d4272004-06-13 20:20:40 +000089/*
Bram Moolenaard0573012017-10-28 21:11:06 +020090 * MACOS_X compiling for Mac OS X
91 * MACOS_X_DARWIN integrating the darwin feature into MACOS_X
Bram Moolenaar071d4272004-06-13 20:20:40 +000092 */
Bram Moolenaard0573012017-10-28 21:11:06 +020093#if defined(MACOS_X_DARWIN) && !defined(MACOS_X)
Bram Moolenaar071d4272004-06-13 20:20:40 +000094# define MACOS_X
Bram Moolenaar071d4272004-06-13 20:20:40 +000095#endif
96/* Unless made through the Makefile enforce GUI on Mac */
Bram Moolenaard0573012017-10-28 21:11:06 +020097#if defined(MACOS_X) && !defined(HAVE_CONFIG_H)
98# define UNIX
Bram Moolenaar071d4272004-06-13 20:20:40 +000099# define FEAT_GUI_MAC
100#endif
101
Bram Moolenaar071d4272004-06-13 20:20:40 +0000102#if defined(FEAT_GUI_MOTIF) \
103 || defined(FEAT_GUI_GTK) \
104 || defined(FEAT_GUI_ATHENA) \
105 || defined(FEAT_GUI_MAC) \
106 || defined(FEAT_GUI_W32) \
Bram Moolenaarcef9dcc2005-12-06 19:50:41 +0000107 || defined(FEAT_GUI_PHOTON)
Bram Moolenaar9a4d7fd2011-06-13 02:04:00 +0200108# define FEAT_GUI_ENABLED /* also defined with NO_X11_INCLUDES */
Bram Moolenaarab79bcb2004-07-18 21:34:53 +0000109# if !defined(FEAT_GUI) && !defined(NO_X11_INCLUDES)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000110# define FEAT_GUI
111# endif
112#endif
113
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +0200114/* Check support for rendering options */
115#ifdef FEAT_GUI
116# if defined(FEAT_DIRECTX)
117# define FEAT_RENDER_OPTIONS
118# endif
119#endif
120
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000121/* Visual Studio 2005 has 'deprecated' many of the standard CRT functions */
122#if _MSC_VER >= 1400
123# define _CRT_SECURE_NO_DEPRECATE
124# define _CRT_NONSTDC_NO_DEPRECATE
125#endif
126
Bram Moolenaare89ff042016-02-20 22:17:05 +0100127#if defined(FEAT_GUI_W32)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000128# define FEAT_GUI_MSWIN
129#endif
Bram Moolenaarcf7164a2016-02-20 13:55:06 +0100130#if defined(WIN32) || defined(_WIN64)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000131# define MSWIN
132#endif
133/* Practically everything is common to both Win32 and Win64 */
134#if defined(WIN32) || defined(_WIN64)
135# define WIN3264
136#endif
137
138/*
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100139 * VIM_SIZEOF_INT is used in feature.h, and the system-specific included files
140 * need items from feature.h. Therefore define VIM_SIZEOF_INT here.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000141 */
142#ifdef WIN3264
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100143# define VIM_SIZEOF_INT 4
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145
146#ifdef AMIGA
147 /* Be conservative about sizeof(int). It could be 4 too. */
148# ifndef FEAT_GUI_GTK /* avoid problems when generating prototypes */
149# ifdef __GNUC__
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100150# define VIM_SIZEOF_INT 4
Bram Moolenaar071d4272004-06-13 20:20:40 +0000151# else
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100152# define VIM_SIZEOF_INT 2
Bram Moolenaar071d4272004-06-13 20:20:40 +0000153# endif
154# endif
155#endif
Bram Moolenaard0573012017-10-28 21:11:06 +0200156#if defined(MACOS_X) && !defined(HAVE_CONFIG_H)
157# define VIM_SIZEOF_INT __SIZEOF_INT__
Bram Moolenaar071d4272004-06-13 20:20:40 +0000158#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000159
Bram Moolenaarb822cb02016-07-30 14:12:23 +0200160/*
161 * #defines for optionals and features
162 * Also defines FEAT_TINY, FEAT_SMALL, etc. when FEAT_HUGE is defined.
163 */
164#include "feature.h"
165
Bram Moolenaard0573012017-10-28 21:11:06 +0200166#if defined(MACOS_X_DARWIN)
Bram Moolenaarb822cb02016-07-30 14:12:23 +0200167# if defined(FEAT_SMALL) && !defined(FEAT_CLIPBOARD)
168# define FEAT_CLIPBOARD
169# endif
170# if defined(FEAT_SMALL) && !defined(FEAT_MOUSE)
171# define FEAT_MOUSE
172# endif
173#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000174
175/* +x11 is only enabled when it's both available and wanted. */
176#if defined(HAVE_X11) && defined(WANT_X11)
177# define FEAT_X11
178#endif
179
Bram Moolenaarab79bcb2004-07-18 21:34:53 +0000180#ifdef NO_X11_INCLUDES
Bram Moolenaar423f9722010-10-10 17:08:43 +0200181 /* In os_mac_conv.c and os_macosx.m NO_X11_INCLUDES is defined to avoid
182 * X11 headers. Disable all X11 related things to avoid conflicts. */
Bram Moolenaarab79bcb2004-07-18 21:34:53 +0000183# ifdef FEAT_X11
184# undef FEAT_X11
185# endif
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000186# ifdef FEAT_GUI_X11
187# undef FEAT_GUI_X11
188# endif
Bram Moolenaarab79bcb2004-07-18 21:34:53 +0000189# ifdef FEAT_XCLIPBOARD
190# undef FEAT_XCLIPBOARD
191# endif
192# ifdef FEAT_GUI_MOTIF
193# undef FEAT_GUI_MOTIF
194# endif
195# ifdef FEAT_GUI_ATHENA
196# undef FEAT_GUI_ATHENA
197# endif
198# ifdef FEAT_GUI_GTK
199# undef FEAT_GUI_GTK
200# endif
201# ifdef FEAT_BEVAL_TIP
202# undef FEAT_BEVAL_TIP
203# endif
204# ifdef FEAT_XIM
205# undef FEAT_XIM
206# endif
207# ifdef FEAT_CLIENTSERVER
208# undef FEAT_CLIENTSERVER
209# endif
210#endif
211
Bram Moolenaardb003512006-03-15 22:48:35 +0000212/* The Mac conversion stuff doesn't work under X11. */
Bram Moolenaard0573012017-10-28 21:11:06 +0200213#if defined(FEAT_MBYTE) && defined(MACOS_X_DARWIN)
Bram Moolenaardb003512006-03-15 22:48:35 +0000214# define MACOS_CONVERT
215#endif
216
Bram Moolenaar071d4272004-06-13 20:20:40 +0000217/* Can't use "PACKAGE" here, conflicts with a Perl include file. */
218#ifndef VIMPACKAGE
219# define VIMPACKAGE "vim"
220#endif
221
222/*
223 * Find out if function definitions should include argument types
224 */
225#ifdef AZTEC_C
226# include <functions.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +0000227#endif
228
229#ifdef SASC
230# include <clib/exec_protos.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231#endif
232
233#ifdef _DCC
234# include <clib/exec_protos.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +0000235#endif
236
237#ifdef __BEOS__
238# include "os_beos.h"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000239#endif
240
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200241#if (defined(UNIX) || defined(VMS)) \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000242 && (!defined(MACOS_X) || defined(HAVE_CONFIG_H))
243# include "os_unix.h" /* bring lots of system header files */
244#endif
245
Bram Moolenaar0c094b92009-05-14 20:20:33 +0000246/* Mark unused function arguments with UNUSED, so that gcc -Wunused-parameter
247 * can be used to check for mistakes. */
248#ifdef HAVE_ATTRIBUTE_UNUSED
249# define UNUSED __attribute__((unused))
250#else
251# define UNUSED
252#endif
253
Bram Moolenaara899e6e2016-12-03 16:40:51 +0100254/* Used to check for "sun", "__sun" is used by newer compilers. */
255#if defined(__sun)
256# define SUN_SYSTEM
257#endif
258
Bram Moolenaar843ee412004-06-30 16:16:41 +0000259/* if we're compiling in C++ (currently only KVim), the system
260 * headers must have the correct prototypes or nothing will build.
261 * conversely, our prototypes might clash due to throw() specifiers and
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000262 * cause compilation failures even though the headers are correct. For
Bram Moolenaar843ee412004-06-30 16:16:41 +0000263 * a concrete example, gcc-3.2 enforces exception specifications, and
264 * glibc-2.2.5 has them in their system headers.
265 */
266#if !defined(__cplusplus) && defined(UNIX) \
267 && !defined(MACOS_X) /* MACOS_X doesn't yet support osdef.h */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268# include "auto/osdef.h" /* bring missing declarations in */
269#endif
270
Bram Moolenaar071d4272004-06-13 20:20:40 +0000271#ifdef AMIGA
272# include "os_amiga.h"
273#endif
274
Bram Moolenaar071d4272004-06-13 20:20:40 +0000275#ifdef WIN3264
276# include "os_win32.h"
277#endif
278
279#ifdef __MINT__
280# include "os_mint.h"
281#endif
282
Bram Moolenaard0573012017-10-28 21:11:06 +0200283#if defined(MACOS_X)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000284# include "os_mac.h"
285#endif
286
Bram Moolenaar071d4272004-06-13 20:20:40 +0000287#ifdef __QNX__
288# include "os_qnx.h"
289#endif
290
291#ifdef FEAT_SUN_WORKSHOP
292# include "workshop.h"
293#endif
294
295#ifdef X_LOCALE
296# include <X11/Xlocale.h>
297#else
298# ifdef HAVE_LOCALE_H
299# include <locale.h>
300# endif
301#endif
302
303/*
304 * Maximum length of a path (for non-unix systems) Make it a bit long, to stay
305 * on the safe side. But not too long to put on the stack.
306 */
307#ifndef MAXPATHL
308# ifdef MAXPATHLEN
309# define MAXPATHL MAXPATHLEN
310# else
311# define MAXPATHL 256
312# endif
313#endif
314#ifdef BACKSLASH_IN_FILENAME
Bram Moolenaaraebaf892008-05-28 14:49:58 +0000315# define PATH_ESC_CHARS ((char_u *)" \t\n*?[{`%#'\"|!<")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316#else
Bram Moolenaar03cd93a2008-11-20 09:27:32 +0000317# ifdef VMS
318 /* VMS allows a lot of characters in the file name */
319# define PATH_ESC_CHARS ((char_u *)" \t\n*?{`\\%#'\"|!")
320# define SHELL_ESC_CHARS ((char_u *)" \t\n*?{`\\%#'|!()&")
321# else
322# define PATH_ESC_CHARS ((char_u *)" \t\n*?[{`$\\%#'\"|!<")
323# define SHELL_ESC_CHARS ((char_u *)" \t\n*?[{`$\\%#'\"|!<>();&")
324# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000325#endif
326
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100327/* length of a buffer to store a number in ASCII (64 bits binary + NUL) */
328#define NUMBUFLEN 65
329
330/* flags for vim_str2nr() */
331#define STR2NR_BIN 1
332#define STR2NR_OCT 2
333#define STR2NR_HEX 4
334#define STR2NR_ALL (STR2NR_BIN + STR2NR_OCT + STR2NR_HEX)
335#define STR2NR_FORCE 8 /* only when ONE of the above is used */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000336
337/*
338 * Shorthand for unsigned variables. Many systems, but not all, have u_char
339 * already defined, so we use char_u to avoid trouble.
340 */
341typedef unsigned char char_u;
342typedef unsigned short short_u;
343typedef unsigned int int_u;
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000344/* Make sure long_u is big enough to hold a pointer.
Bram Moolenaare6a91fd2008-07-24 18:51:11 +0000345 * On Win64, longs are 32 bits and pointers are 64 bits.
346 * For printf() and scanf(), we need to take care of long_u specifically. */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000347#ifdef _WIN64
Bram Moolenaar55d5c032010-07-17 23:52:29 +0200348typedef unsigned __int64 long_u;
349typedef __int64 long_i;
Bram Moolenaarcb4cef22008-03-16 15:04:34 +0000350# define SCANF_HEX_LONG_U "%Ix"
351# define SCANF_DECIMAL_LONG_U "%Iu"
352# define PRINTF_HEX_LONG_U "0x%Ix"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000353#else
Bram Moolenaare6a91fd2008-07-24 18:51:11 +0000354 /* Microsoft-specific. The __w64 keyword should be specified on any typedefs
355 * that change size between 32-bit and 64-bit platforms. For any such type,
356 * __w64 should appear only on the 32-bit definition of the typedef.
357 * Define __w64 as an empty token for everything but MSVC 7.x or later.
358 */
359# if !defined(_MSC_VER) || (_MSC_VER < 1300)
Bram Moolenaar03cd93a2008-11-20 09:27:32 +0000360# define __w64
Bram Moolenaare6a91fd2008-07-24 18:51:11 +0000361# endif
362typedef unsigned long __w64 long_u;
363typedef long __w64 long_i;
Bram Moolenaarcb4cef22008-03-16 15:04:34 +0000364# define SCANF_HEX_LONG_U "%lx"
365# define SCANF_DECIMAL_LONG_U "%lu"
366# define PRINTF_HEX_LONG_U "0x%lx"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000367#endif
Bram Moolenaarcb4cef22008-03-16 15:04:34 +0000368#define PRINTF_DECIMAL_LONG_U SCANF_DECIMAL_LONG_U
Bram Moolenaar071d4272004-06-13 20:20:40 +0000369
370/*
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100371 * Only systems which use configure will have SIZEOF_OFF_T and VIM_SIZEOF_LONG
Bram Moolenaar914703b2010-05-31 21:59:46 +0200372 * defined, which is ok since those are the same systems which can have
373 * varying sizes for off_t. The other systems will continue to use "%ld" to
374 * print off_t since off_t is simply a typedef to long for them.
375 */
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100376#if defined(SIZEOF_OFF_T) && (SIZEOF_OFF_T > VIM_SIZEOF_LONG)
Bram Moolenaar914703b2010-05-31 21:59:46 +0200377# define LONG_LONG_OFF_T
378#endif
379
380/*
Bram Moolenaar8767f522016-07-01 17:17:39 +0200381 * We use 64-bit file functions here, if available. E.g. ftello() returns
382 * off_t instead of long, which helps if long is 32 bit and off_t is 64 bit.
383 * We assume that when fseeko() is available then ftello() is too.
384 * Note that Windows has different function names.
385 */
386#if (defined(_MSC_VER) && (_MSC_VER >= 1300)) || defined(__MINGW32__)
387typedef __int64 off_T;
388# ifdef __MINGW32__
389# define vim_lseek lseek64
390# define vim_fseek fseeko64
391# define vim_ftell ftello64
392# else
393# define vim_lseek _lseeki64
394# define vim_fseek _fseeki64
395# define vim_ftell _ftelli64
396# endif
397#else
Bram Moolenaard90b6c02016-08-28 18:10:45 +0200398# ifdef PROTO
399typedef long off_T;
400# else
Bram Moolenaar8767f522016-07-01 17:17:39 +0200401typedef off_t off_T;
Bram Moolenaard90b6c02016-08-28 18:10:45 +0200402# endif
Bram Moolenaar8767f522016-07-01 17:17:39 +0200403# ifdef HAVE_FSEEKO
404# define vim_lseek lseek
405# define vim_ftell ftello
406# define vim_fseek fseeko
407# else
408# define vim_lseek lseek
409# define vim_ftell ftell
410# define vim_fseek(a, b, c) fseek(a, (long)b, c)
411# endif
412#endif
413
414/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000415 * The characters and attributes cached for the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000416 */
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000417typedef char_u schar_T;
Bram Moolenaar3918c952005-03-15 22:34:55 +0000418typedef unsigned short sattr_T;
Bram Moolenaar9f45ccd2017-09-02 20:40:35 +0200419#define MAX_TYPENR 65535
Bram Moolenaar071d4272004-06-13 20:20:40 +0000420
421/*
422 * The u8char_T can hold one decoded UTF-8 character.
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000423 * We normally use 32 bits now, since some Asian characters don't fit in 16
424 * bits. u8char_T is only used for displaying, it could be 16 bits to save
425 * memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000426 */
427#ifdef FEAT_MBYTE
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000428# ifdef UNICODE16
429typedef unsigned short u8char_T; /* short should be 16 bits */
430# else
Bram Moolenaara2aa31a2014-02-23 22:52:40 +0100431# if VIM_SIZEOF_INT >= 4
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000432typedef unsigned int u8char_T; /* int is 32 bits */
433# else
434typedef unsigned long u8char_T; /* long should be 32 bits or more */
435# endif
436# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000437#endif
438
439#ifndef UNIX /* For Unix this is included in os_unix.h */
440# include <stdio.h>
441# include <ctype.h>
442#endif
443
444#include "ascii.h"
445#include "keymap.h"
446#include "term.h"
447#include "macros.h"
448
449#ifdef LATTICE
450# include <sys/types.h>
451# include <sys/stat.h>
452#endif
453#ifdef _DCC
454# include <sys/stat.h>
455#endif
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100456#if defined(MSWIN)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000457# include <sys/stat.h>
458#endif
459
Bram Moolenaar48e330a2016-02-23 14:53:34 +0100460#if defined(HAVE_ERRNO_H) \
Bram Moolenaara06ecab2016-07-16 14:47:36 +0200461 || defined(WIN32) || defined(_WIN64)
Bram Moolenaarb57aa922010-12-17 20:24:01 +0100462# include <errno.h>
463#endif
464
Bram Moolenaarbfd30592017-02-21 21:57:06 +0100465/* for INT_MAX et al. */
466#include <limits.h>
467
Bram Moolenaar071d4272004-06-13 20:20:40 +0000468/*
469 * Allow other (non-unix) systems to configure themselves now
470 * These are also in os_unix.h, because osdef.sh needs them there.
471 */
472#ifndef UNIX
473/* Note: Some systems need both string.h and strings.h (Savage). If the
474 * system can't handle this, define NO_STRINGS_WITH_STRING_H. */
475# ifdef HAVE_STRING_H
476# include <string.h>
477# endif
478# if defined(HAVE_STRINGS_H) && !defined(NO_STRINGS_WITH_STRING_H)
Bram Moolenaar08ed30e2013-01-17 17:17:26 +0100479# include <strings.h>
Bram Moolenaar071d4272004-06-13 20:20:40 +0000480# endif
481# ifdef HAVE_STAT_H
482# include <stat.h>
483# endif
484# ifdef HAVE_STDLIB_H
485# include <stdlib.h>
486# endif
487#endif /* NON-UNIX */
488
489#include <assert.h>
490
Bram Moolenaarfa7584c2010-05-19 21:57:45 +0200491#ifdef HAVE_STDINT_H
492# include <stdint.h>
493#endif
494#ifdef HAVE_INTTYPES_H
495# include <inttypes.h>
496#endif
Bram Moolenaar8fef2ad2005-04-23 20:42:23 +0000497#ifdef HAVE_WCTYPE_H
498# include <wctype.h>
499#endif
Bram Moolenaarba4ef272016-01-30 21:48:49 +0100500#include <stdarg.h>
Bram Moolenaar8fef2ad2005-04-23 20:42:23 +0000501
Bram Moolenaar84026842016-07-17 20:37:43 +0200502/* for offsetof() */
503#include <stddef.h>
504
Bram Moolenaar08ed30e2013-01-17 17:17:26 +0100505#if defined(HAVE_SYS_SELECT_H) && \
Bram Moolenaar581f6dc2010-03-10 16:12:48 +0100506 (!defined(HAVE_SYS_TIME_H) || defined(SYS_SELECT_WITH_SYS_TIME))
Bram Moolenaar08ed30e2013-01-17 17:17:26 +0100507# include <sys/select.h>
508#endif
Bram Moolenaar581f6dc2010-03-10 16:12:48 +0100509
Bram Moolenaar08ed30e2013-01-17 17:17:26 +0100510#ifndef HAVE_SELECT
511# ifdef HAVE_SYS_POLL_H
512# include <sys/poll.h>
Bram Moolenaara8343c12016-02-04 22:09:48 +0100513# elif defined(WIN32)
Bram Moolenaarf12d9832016-01-29 21:11:25 +0100514# define HAVE_SELECT
Bram Moolenaar08ed30e2013-01-17 17:17:26 +0100515# else
516# ifdef HAVE_POLL_H
517# include <poll.h>
Bram Moolenaar581f6dc2010-03-10 16:12:48 +0100518# endif
519# endif
Bram Moolenaar08ed30e2013-01-17 17:17:26 +0100520#endif
Bram Moolenaar581f6dc2010-03-10 16:12:48 +0100521
Bram Moolenaar071d4272004-06-13 20:20:40 +0000522/* ================ end of the header file puzzle =============== */
523
524/*
525 * For dynamically loaded imm library. Currently, only for Win32.
526 */
527#ifdef DYNAMIC_IME
528# ifndef FEAT_MBYTE_IME
529# define FEAT_MBYTE_IME
530# endif
531#endif
532
533/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000534 * For dynamically loaded gettext library. Currently, only for Win32.
535 */
536#ifdef DYNAMIC_GETTEXT
537# ifndef FEAT_GETTEXT
538# define FEAT_GETTEXT
539# endif
540/* These are in os_win32.c */
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000541extern char *(*dyn_libintl_gettext)(const char *msgid);
Bram Moolenaaree695f72016-08-03 22:08:45 +0200542extern char *(*dyn_libintl_ngettext)(const char *msgid, const char *msgid_plural, unsigned long n);
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000543extern char *(*dyn_libintl_bindtextdomain)(const char *domainname, const char *dirname);
544extern char *(*dyn_libintl_bind_textdomain_codeset)(const char *domainname, const char *codeset);
545extern char *(*dyn_libintl_textdomain)(const char *domainname);
Bram Moolenaar972c3b82017-01-12 21:44:49 +0100546extern int (*dyn_libintl_putenv)(const char *envstring);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000547#endif
548
549
550/*
551 * The _() stuff is for using gettext(). It is a no-op when libintl.h is not
552 * found or the +multilang feature is disabled.
Bram Moolenaarda6e8912018-08-21 15:12:14 +0200553 * Use NGETTEXT(single, multi, number) to get plural behavior:
554 * - single - message for singular form
555 * - multi - message for plural form
556 * - number - the count
Bram Moolenaar071d4272004-06-13 20:20:40 +0000557 */
558#ifdef FEAT_GETTEXT
559# ifdef DYNAMIC_GETTEXT
560# define _(x) (*dyn_libintl_gettext)((char *)(x))
Bram Moolenaar1c465442017-03-12 20:10:05 +0100561# define NGETTEXT(x, xs, n) (*dyn_libintl_ngettext)((char *)(x), (char *)(xs), (n))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000562# define N_(x) x
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000563# define bindtextdomain(domain, dir) (*dyn_libintl_bindtextdomain)((domain), (dir))
564# define bind_textdomain_codeset(domain, codeset) (*dyn_libintl_bind_textdomain_codeset)((domain), (codeset))
565# if !defined(HAVE_BIND_TEXTDOMAIN_CODESET)
566# define HAVE_BIND_TEXTDOMAIN_CODESET 1
567# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000568# define textdomain(domain) (*dyn_libintl_textdomain)(domain)
Bram Moolenaar972c3b82017-01-12 21:44:49 +0100569# define libintl_putenv(envstring) (*dyn_libintl_putenv)(envstring)
Bram Moolenaar7c23d1d2017-02-01 13:14:16 +0100570# define libintl_wputenv(envstring) (*dyn_libintl_wputenv)(envstring)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000571# else
572# include <libintl.h>
573# define _(x) gettext((char *)(x))
Bram Moolenaar1c465442017-03-12 20:10:05 +0100574# define NGETTEXT(x, xs, n) ngettext((x), (xs), (n))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000575# ifdef gettext_noop
576# define N_(x) gettext_noop(x)
577# else
578# define N_(x) x
579# endif
580# endif
581#else
582# define _(x) ((char *)(x))
Bram Moolenaar1c465442017-03-12 20:10:05 +0100583# define NGETTEXT(x, xs, n) (((n) == 1) ? (char *)(x) : (char *)(xs))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000584# define N_(x) x
585# ifdef bindtextdomain
586# undef bindtextdomain
587# endif
588# define bindtextdomain(x, y) /* empty */
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000589# ifdef bind_textdomain_codeset
590# undef bind_textdomain_codeset
591# endif
592# define bind_textdomain_codeset(x, y) /* empty */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000593# ifdef textdomain
594# undef textdomain
595# endif
596# define textdomain(x) /* empty */
597#endif
598
599/*
600 * flags for update_screen()
601 * The higher the value, the higher the priority
602 */
Bram Moolenaar29ae3772017-04-30 19:39:39 +0200603#define VALID_NO_UPDATE 5 /* no new changes, keep the command line if
604 possible */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000605#define VALID 10 /* buffer not changed, or changes marked
606 with b_mod_* */
607#define INVERTED 20 /* redisplay inverted part that changed */
608#define INVERTED_ALL 25 /* redisplay whole inverted part */
609#define REDRAW_TOP 30 /* display first w_upd_rows screen lines */
Bram Moolenaarf71a3db2006-03-12 21:50:18 +0000610#define SOME_VALID 35 /* like NOT_VALID but may scroll */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611#define NOT_VALID 40 /* buffer needs complete redraw */
612#define CLEAR 50 /* screen messed up, clear it */
613
614/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615 * Flags for w_valid.
616 * These are set when something in a window structure becomes invalid, except
617 * when the cursor is moved. Call check_cursor_moved() before testing one of
618 * the flags.
619 * These are reset when that thing has been updated and is valid again.
620 *
621 * Every function that invalidates one of these must call one of the
622 * invalidate_* functions.
623 *
624 * w_valid is supposed to be used only in screen.c. From other files, use the
625 * functions that set or reset the flags.
626 *
627 * VALID_BOTLINE VALID_BOTLINE_AP
628 * on on w_botline valid
629 * off on w_botline approximated
630 * off off w_botline not valid
631 * on off not possible
632 */
633#define VALID_WROW 0x01 /* w_wrow (window row) is valid */
634#define VALID_WCOL 0x02 /* w_wcol (window col) is valid */
635#define VALID_VIRTCOL 0x04 /* w_virtcol (file col) is valid */
636#define VALID_CHEIGHT 0x08 /* w_cline_height and w_cline_folded valid */
637#define VALID_CROW 0x10 /* w_cline_row is valid */
638#define VALID_BOTLINE 0x20 /* w_botine and w_empty_rows are valid */
639#define VALID_BOTLINE_AP 0x40 /* w_botine is approximated */
640#define VALID_TOPLINE 0x80 /* w_topline is valid (for cursor position) */
641
642/*
643 * Terminal highlighting attribute bits.
Bram Moolenaar42b4dda2010-03-02 15:56:05 +0100644 * Attributes above HL_ALL are used for syntax highlighting.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000645 */
646#define HL_NORMAL 0x00
647#define HL_INVERSE 0x01
648#define HL_BOLD 0x02
649#define HL_ITALIC 0x04
650#define HL_UNDERLINE 0x08
Bram Moolenaar3918c952005-03-15 22:34:55 +0000651#define HL_UNDERCURL 0x10
652#define HL_STANDOUT 0x20
Bram Moolenaar0cd2a942017-08-12 15:12:30 +0200653#define HL_NOCOMBINE 0x40
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +0200654#define HL_STRIKETHROUGH 0x80
655#define HL_ALL 0xff
Bram Moolenaar071d4272004-06-13 20:20:40 +0000656
657/* special attribute addition: Put message in history */
658#define MSG_HIST 0x1000
659
660/*
661 * values for State
662 *
663 * The lower bits up to 0x20 are used to distinguish normal/visual/op_pending
664 * and cmdline/insert+replace mode. This is used for mapping. If none of
665 * these bits are set, no mapping is done.
666 * The upper bits are used to distinguish between other states.
667 */
668#define NORMAL 0x01 /* Normal mode, command expected */
669#define VISUAL 0x02 /* Visual mode - use get_real_state() */
670#define OP_PENDING 0x04 /* Normal mode, operator is pending - use
671 get_real_state() */
672#define CMDLINE 0x08 /* Editing command line */
673#define INSERT 0x10 /* Insert mode */
674#define LANGMAP 0x20 /* Language mapping, can be combined with
675 INSERT and CMDLINE */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000676
677#define REPLACE_FLAG 0x40 /* Replace mode flag */
678#define REPLACE (REPLACE_FLAG + INSERT)
Bram Moolenaar1f0bfe52018-07-29 16:09:22 +0200679#define VREPLACE_FLAG 0x80 /* Virtual-replace mode flag */
680#define VREPLACE (REPLACE_FLAG + VREPLACE_FLAG + INSERT)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000681#define LREPLACE (REPLACE_FLAG + LANGMAP)
682
683#define NORMAL_BUSY (0x100 + NORMAL) /* Normal mode, busy with a command */
684#define HITRETURN (0x200 + NORMAL) /* waiting for return or command */
685#define ASKMORE 0x300 /* Asking if you want --more-- */
686#define SETWSIZE 0x400 /* window size has changed */
687#define ABBREV 0x500 /* abbreviation instead of mapping */
688#define EXTERNCMD 0x600 /* executing an external command */
689#define SHOWMATCH (0x700 + INSERT) /* show matching paren */
690#define CONFIRM 0x800 /* ":confirm" prompt */
Bram Moolenaar371d5402006-03-20 21:47:49 +0000691#define SELECTMODE 0x1000 /* Select mode, only for mappings */
Bram Moolenaar69fbc9e2017-09-14 20:37:57 +0200692#define TERMINAL 0x2000 /* Terminal mode */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000693
Bram Moolenaar69fbc9e2017-09-14 20:37:57 +0200694/* all mode bits used for mapping */
695#define MAP_ALL_MODES (0x3f | SELECTMODE | TERMINAL)
Bram Moolenaar149667a2006-06-23 14:33:23 +0000696
Bram Moolenaar071d4272004-06-13 20:20:40 +0000697/* directions */
698#define FORWARD 1
699#define BACKWARD (-1)
700#define FORWARD_FILE 3
701#define BACKWARD_FILE (-3)
702
703/* return values for functions */
704#if !(defined(OK) && (OK == 1))
705/* OK already defined to 1 in MacOS X curses, skip this */
706# define OK 1
707#endif
708#define FAIL 0
Bram Moolenaarfd371682005-01-14 21:42:54 +0000709#define NOTDONE 2 /* not OK or FAIL but skipped */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000710
711/* flags for b_flags */
712#define BF_RECOVERED 0x01 /* buffer has been recovered */
713#define BF_CHECK_RO 0x02 /* need to check readonly when loading file
714 into buffer (set by ":e", may be reset by
715 ":buf" */
716#define BF_NEVERLOADED 0x04 /* file has never been loaded into buffer,
717 many variables still need to be set */
718#define BF_NOTEDITED 0x08 /* Set when file name is changed after
719 starting to edit, reset when file is
720 written out. */
721#define BF_NEW 0x10 /* file didn't exist when editing started */
722#define BF_NEW_W 0x20 /* Warned for BF_NEW and file created */
723#define BF_READERR 0x40 /* got errors while reading the file */
Bram Moolenaar81695252004-12-29 20:58:21 +0000724#define BF_DUMMY 0x80 /* dummy buffer, only used internally */
Bram Moolenaar4399ef42005-02-12 14:29:27 +0000725#define BF_PRESERVED 0x100 /* ":preserve" was used */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000726
727/* Mask to check for flags that prevent normal writing */
728#define BF_WRITE_MASK (BF_NOTEDITED + BF_NEW + BF_READERR)
729
730/*
731 * values for xp_context when doing command line completion
732 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000733#define EXPAND_UNSUCCESSFUL (-2)
734#define EXPAND_OK (-1)
735#define EXPAND_NOTHING 0
736#define EXPAND_COMMANDS 1
737#define EXPAND_FILES 2
738#define EXPAND_DIRECTORIES 3
739#define EXPAND_SETTINGS 4
740#define EXPAND_BOOL_SETTINGS 5
741#define EXPAND_TAGS 6
742#define EXPAND_OLD_SETTING 7
743#define EXPAND_HELP 8
744#define EXPAND_BUFFERS 9
745#define EXPAND_EVENTS 10
746#define EXPAND_MENUS 11
747#define EXPAND_SYNTAX 12
748#define EXPAND_HIGHLIGHT 13
749#define EXPAND_AUGROUP 14
750#define EXPAND_USER_VARS 15
751#define EXPAND_MAPPINGS 16
752#define EXPAND_TAGS_LISTFILES 17
753#define EXPAND_FUNCTIONS 18
754#define EXPAND_USER_FUNC 19
755#define EXPAND_EXPRESSION 20
756#define EXPAND_MENUNAMES 21
757#define EXPAND_USER_COMMANDS 22
758#define EXPAND_USER_CMD_FLAGS 23
759#define EXPAND_USER_NARGS 24
760#define EXPAND_USER_COMPLETE 25
761#define EXPAND_ENV_VARS 26
762#define EXPAND_LANGUAGE 27
763#define EXPAND_COLORS 28
764#define EXPAND_COMPILER 29
765#define EXPAND_USER_DEFINED 30
Bram Moolenaara466c992005-07-09 21:03:22 +0000766#define EXPAND_USER_LIST 31
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000767#define EXPAND_SHELLCMD 32
Bram Moolenaarf4580d82009-03-18 11:52:53 +0000768#define EXPAND_CSCOPE 33
Bram Moolenaar3c65e312009-04-29 16:47:23 +0000769#define EXPAND_SIGN 34
Bram Moolenaarf86f26c2010-02-03 15:14:22 +0100770#define EXPAND_PROFILE 35
Bram Moolenaar42b4dda2010-03-02 15:56:05 +0100771#define EXPAND_BEHAVE 36
Bram Moolenaar883f5d02010-06-21 06:24:34 +0200772#define EXPAND_FILETYPE 37
Bram Moolenaar1587a1e2010-07-29 20:59:59 +0200773#define EXPAND_FILES_IN_PATH 38
774#define EXPAND_OWNSYNTAX 39
Bram Moolenaar9b486ca2011-05-19 18:26:40 +0200775#define EXPAND_LOCALES 40
Bram Moolenaar5ae636b2012-04-30 18:48:53 +0200776#define EXPAND_HISTORY 41
Bram Moolenaar24305862012-08-15 14:05:05 +0200777#define EXPAND_USER 42
Bram Moolenaarcd9c4622013-06-08 15:24:48 +0200778#define EXPAND_SYNTIME 43
Bram Moolenaarf1d6ccf2014-12-08 04:16:44 +0100779#define EXPAND_USER_ADDR_TYPE 44
Bram Moolenaar35ca0e72016-03-05 17:41:49 +0100780#define EXPAND_PACKADD 45
Bram Moolenaar9e507ca2016-10-15 15:39:39 +0200781#define EXPAND_MESSAGES 46
Bram Moolenaarcae92dc2017-08-06 15:22:15 +0200782#define EXPAND_MAPCLEAR 47
Bram Moolenaarcd43eff2018-03-29 15:55:38 +0200783#define EXPAND_ARGLIST 48
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784
785/* Values for exmode_active (0 is no exmode) */
786#define EXMODE_NORMAL 1
787#define EXMODE_VIM 2
788
789/* Values for nextwild() and ExpandOne(). See ExpandOne() for meaning. */
790#define WILD_FREE 1
791#define WILD_EXPAND_FREE 2
792#define WILD_EXPAND_KEEP 3
793#define WILD_NEXT 4
794#define WILD_PREV 5
795#define WILD_ALL 6
796#define WILD_LONGEST 7
Bram Moolenaar146e9c32012-03-07 19:18:23 +0100797#define WILD_ALL_KEEP 8
Bram Moolenaar071d4272004-06-13 20:20:40 +0000798
Bram Moolenaara245bc72015-03-05 19:35:25 +0100799#define WILD_LIST_NOTFOUND 0x01
800#define WILD_HOME_REPLACE 0x02
801#define WILD_USE_NL 0x04
802#define WILD_NO_BEEP 0x08
803#define WILD_ADD_SLASH 0x10
804#define WILD_KEEP_ALL 0x20
805#define WILD_SILENT 0x40
806#define WILD_ESCAPE 0x80
807#define WILD_ICASE 0x100
808#define WILD_ALLLINKS 0x200
Bram Moolenaar071d4272004-06-13 20:20:40 +0000809
810/* Flags for expand_wildcards() */
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000811#define EW_DIR 0x01 /* include directory names */
812#define EW_FILE 0x02 /* include file names */
813#define EW_NOTFOUND 0x04 /* include not found names */
814#define EW_ADDSLASH 0x08 /* append slash to directory name */
815#define EW_KEEPALL 0x10 /* keep all matches */
816#define EW_SILENT 0x20 /* don't print "1 returned" from shell */
817#define EW_EXEC 0x40 /* executable files */
Bram Moolenaarcc448b32010-07-14 16:52:17 +0200818#define EW_PATH 0x80 /* search in 'path' too */
Bram Moolenaar94950a92010-12-02 16:01:29 +0100819#define EW_ICASE 0x100 /* ignore case */
Bram Moolenaarb5609832011-07-20 15:04:58 +0200820#define EW_NOERROR 0x200 /* no error for bad regexp */
Bram Moolenaar0b573a52011-07-27 17:31:47 +0200821#define EW_NOTWILD 0x400 /* add match with literal name if exists */
Bram Moolenaare4df1642014-08-29 12:58:44 +0200822#define EW_KEEPDOLLAR 0x800 /* do not escape $, $var is expanded */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000823/* Note: mostly EW_NOTFOUND and EW_SILENT are mutually exclusive: EW_NOTFOUND
824 * is used when executing commands and EW_SILENT for interactive expanding. */
Bram Moolenaara245bc72015-03-05 19:35:25 +0100825#define EW_ALLLINKS 0x1000 /* also links not pointing to existing file */
Bram Moolenaarb5971142015-03-21 17:32:19 +0100826#define EW_SHELLCMD 0x2000 /* called from expand_shellcmd(), don't check
827 * if executable is in $PATH */
Bram Moolenaarb0967d52016-01-17 16:49:43 +0100828#define EW_DODOT 0x4000 /* also files starting with a dot */
Bram Moolenaar336bd622016-01-17 18:23:58 +0100829#define EW_EMPTYOK 0x8000 /* no matches is not an error */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000830
Bram Moolenaar4d0ec162008-02-20 11:24:52 +0000831/* Flags for find_file_*() functions. */
832#define FINDFILE_FILE 0 /* only files */
833#define FINDFILE_DIR 1 /* only directories */
834#define FINDFILE_BOTH 2 /* files and directories */
835
Bram Moolenaar4033c552017-09-16 20:54:51 +0200836#define W_ENDCOL(wp) (wp->w_wincol + wp->w_width)
Bram Moolenaara5a2be22017-09-19 22:08:04 +0200837#ifdef FEAT_MENU
838# define W_WINROW(wp) (wp->w_winrow + wp->w_winbar_height)
839#else
840# define W_WINROW(wp) (wp->w_winrow)
841#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842
843#ifdef NO_EXPANDPATH
844# define gen_expand_wildcards mch_expand_wildcards
845#endif
846
847/* Values for the find_pattern_in_path() function args 'type' and 'action': */
848#define FIND_ANY 1
849#define FIND_DEFINE 2
850#define CHECK_PATH 3
851
852#define ACTION_SHOW 1
853#define ACTION_GOTO 2
854#define ACTION_SPLIT 3
855#define ACTION_SHOW_ALL 4
856#ifdef FEAT_INS_EXPAND
857# define ACTION_EXPAND 5
858#endif
859
860#ifdef FEAT_SYN_HL
861# define SST_MIN_ENTRIES 150 /* minimal size for state stack array */
Bram Moolenaare89ff042016-02-20 22:17:05 +0100862# define SST_MAX_ENTRIES 1000 /* maximal size for state stack array */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863# define SST_FIX_STATES 7 /* size of sst_stack[]. */
864# define SST_DIST 16 /* normal distance between entries */
Bram Moolenaar860cae12010-06-05 23:22:07 +0200865# define SST_INVALID (synstate_T *)-1 /* invalid syn_state pointer */
866
867# define HL_CONTAINED 0x01 /* not used on toplevel */
868# define HL_TRANSP 0x02 /* has no highlighting */
869# define HL_ONELINE 0x04 /* match within one line only */
870# define HL_HAS_EOL 0x08 /* end pattern that matches with $ */
871# define HL_SYNC_HERE 0x10 /* sync point after this item (syncing only) */
872# define HL_SYNC_THERE 0x20 /* sync point at current line (syncing only) */
873# define HL_MATCH 0x40 /* use match ID instead of item ID */
874# define HL_SKIPNL 0x80 /* nextgroup can skip newlines */
875# define HL_SKIPWHITE 0x100 /* nextgroup can skip white space */
876# define HL_SKIPEMPTY 0x200 /* nextgroup can skip empty lines */
877# define HL_KEEPEND 0x400 /* end match always kept */
878# define HL_EXCLUDENL 0x800 /* exclude NL from match */
879# define HL_DISPLAY 0x1000 /* only used for displaying, not syncing */
880# define HL_FOLD 0x2000 /* define fold */
881# define HL_EXTEND 0x4000 /* ignore a keepend */
882# define HL_MATCHCONT 0x8000 /* match continued from previous line */
883# define HL_TRANS_CONT 0x10000 /* transparent item without contains arg */
884# define HL_CONCEAL 0x20000 /* can be concealed */
885# define HL_CONCEALENDS 0x40000 /* can be concealed */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000886#endif
887
888/* Values for 'options' argument in do_search() and searchit() */
889#define SEARCH_REV 0x01 /* go in reverse of previous dir. */
890#define SEARCH_ECHO 0x02 /* echo the search command and handle options */
891#define SEARCH_MSG 0x0c /* give messages (yes, it's not 0x04) */
892#define SEARCH_NFMSG 0x08 /* give all messages except not found */
893#define SEARCH_OPT 0x10 /* interpret optional flags */
894#define SEARCH_HIS 0x20 /* put search pattern in history */
895#define SEARCH_END 0x40 /* put cursor at end of match */
896#define SEARCH_NOOF 0x80 /* don't add offset to position */
897#define SEARCH_START 0x100 /* start search without col offset */
898#define SEARCH_MARK 0x200 /* set previous context mark */
899#define SEARCH_KEEP 0x400 /* keep previous search pattern */
900#define SEARCH_PEEK 0x800 /* peek for typed char, cancel search */
Bram Moolenaarad4d8a12015-12-28 19:20:36 +0100901#define SEARCH_COL 0x1000 /* start at specified column instead of zero */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000902
903/* Values for find_ident_under_cursor() */
904#define FIND_IDENT 1 /* find identifier (word) */
905#define FIND_STRING 2 /* find any string (WORD) */
906#define FIND_EVAL 4 /* include "->", "[]" and "." */
907
908/* Values for file_name_in_line() */
909#define FNAME_MESS 1 /* give error message */
910#define FNAME_EXP 2 /* expand to path */
911#define FNAME_HYP 4 /* check for hypertext link */
912#define FNAME_INCL 8 /* apply 'includeexpr' */
913#define FNAME_REL 16 /* ".." and "./" are relative to the (current)
914 file instead of the current directory */
Bram Moolenaard45c07a2015-02-27 17:19:10 +0100915#define FNAME_UNESC 32 /* remove backslashes used for escaping */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000916
917/* Values for buflist_getfile() */
918#define GETF_SETMARK 0x01 /* set pcmark before jumping */
919#define GETF_ALT 0x02 /* jumping to alternate file (not buf num) */
920#define GETF_SWITCH 0x04 /* respect 'switchbuf' settings when jumping */
921
Bram Moolenaar8ad80de2017-06-05 16:01:59 +0200922/* Return values of getfile() */
923#define GETFILE_ERROR 1 /* normal error */
924#define GETFILE_NOT_WRITTEN 2 /* "not written" error */
925#define GETFILE_SAME_FILE 0 /* success, same file */
926#define GETFILE_OPEN_OTHER -1 /* success, opened another file */
927#define GETFILE_UNUSED 8
928#define GETFILE_SUCCESS(x) ((x) <= 0)
929
Bram Moolenaar071d4272004-06-13 20:20:40 +0000930/* Values for buflist_new() flags */
Bram Moolenaarb127cfd2016-05-29 16:24:50 +0200931#define BLN_CURBUF 1 /* may re-use curbuf for new buffer */
932#define BLN_LISTED 2 /* put new buffer in buffer list */
933#define BLN_DUMMY 4 /* allocating dummy buffer */
934#define BLN_NEW 8 /* create a new buffer */
Bram Moolenaar82404332016-07-10 17:00:38 +0200935#define BLN_NOOPT 16 /* don't copy options to existing buffer */
Bram Moolenaarcd524592016-07-17 14:57:05 +0200936#define BLN_DUMMY_OK 32 /* also find an existing dummy buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000937
938/* Values for in_cinkeys() */
939#define KEY_OPEN_FORW 0x101
940#define KEY_OPEN_BACK 0x102
941#define KEY_COMPLETE 0x103 /* end of completion */
942
943/* Values for "noremap" argument of ins_typebuf(). Also used for
944 * map->m_noremap and menu->noremap[]. */
945#define REMAP_YES 0 /* allow remapping */
946#define REMAP_NONE -1 /* no remapping */
947#define REMAP_SCRIPT -2 /* remap script-local mappings only */
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000948#define REMAP_SKIP -3 /* no remapping for first char */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000949
950/* Values for mch_call_shell() second argument */
951#define SHELL_FILTER 1 /* filtering text */
952#define SHELL_EXPAND 2 /* expanding wildcards */
953#define SHELL_COOKED 4 /* set term to cooked mode */
954#define SHELL_DOOUT 8 /* redirecting output */
955#define SHELL_SILENT 16 /* don't print error returned by command */
Bram Moolenaardf177f62005-02-22 08:39:57 +0000956#define SHELL_READ 32 /* read lines and insert into buffer */
957#define SHELL_WRITE 64 /* write lines from buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000958
959/* Values returned by mch_nodetype() */
960#define NODE_NORMAL 0 /* file or directory, check with mch_isdir()*/
961#define NODE_WRITABLE 1 /* something we can write to (character
962 device, fifo, socket, ..) */
963#define NODE_OTHER 2 /* non-writable thing (e.g., block device) */
964
965/* Values for readfile() flags */
966#define READ_NEW 0x01 /* read a file into a new buffer */
967#define READ_FILTER 0x02 /* read filter output */
968#define READ_STDIN 0x04 /* read from stdin */
969#define READ_BUFFER 0x08 /* read from curbuf (converting stdin) */
970#define READ_DUMMY 0x10 /* reading into a dummy buffer */
Bram Moolenaarf71d7b92016-08-09 22:14:05 +0200971#define READ_KEEP_UNDO 0x20 /* keep undo info */
972#define READ_FIFO 0x40 /* read from fifo or socket */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000973
974/* Values for change_indent() */
975#define INDENT_SET 1 /* set indent */
976#define INDENT_INC 2 /* increase indent */
977#define INDENT_DEC 3 /* decrease indent */
978
979/* Values for flags argument for findmatchlimit() */
980#define FM_BACKWARD 0x01 /* search backwards */
981#define FM_FORWARD 0x02 /* search forwards */
982#define FM_BLOCKSTOP 0x04 /* stop at start/end of block */
983#define FM_SKIPCOMM 0x08 /* skip comments */
984
985/* Values for action argument for do_buffer() */
986#define DOBUF_GOTO 0 /* go to specified buffer */
987#define DOBUF_SPLIT 1 /* split window and go to specified buffer */
988#define DOBUF_UNLOAD 2 /* unload specified buffer(s) */
989#define DOBUF_DEL 3 /* delete specified buffer(s) from buflist */
990#define DOBUF_WIPE 4 /* delete specified buffer(s) really */
991
992/* Values for start argument for do_buffer() */
993#define DOBUF_CURRENT 0 /* "count" buffer from current buffer */
994#define DOBUF_FIRST 1 /* "count" buffer from first buffer */
995#define DOBUF_LAST 2 /* "count" buffer from last buffer */
996#define DOBUF_MOD 3 /* "count" mod. buffer from current buffer */
997
998/* Values for sub_cmd and which_pat argument for search_regcomp() */
999/* Also used for which_pat argument for searchit() */
1000#define RE_SEARCH 0 /* save/use pat in/from search_pattern */
1001#define RE_SUBST 1 /* save/use pat in/from subst_pattern */
1002#define RE_BOTH 2 /* save pat in both patterns */
1003#define RE_LAST 2 /* use last used pattern if "pat" is NULL */
1004
1005/* Second argument for vim_regcomp(). */
1006#define RE_MAGIC 1 /* 'magic' option */
1007#define RE_STRING 2 /* match in string instead of buffer text */
Bram Moolenaarae5bce12005-08-15 21:41:48 +00001008#define RE_STRICT 4 /* don't allow [abc] without ] */
Bram Moolenaare0ad3652015-01-27 12:59:55 +01001009#define RE_AUTO 8 /* automatic engine selection */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001010
1011#ifdef FEAT_SYN_HL
1012/* values for reg_do_extmatch */
1013# define REX_SET 1 /* to allow \z\(...\), */
1014# define REX_USE 2 /* to allow \z\1 et al. */
Bram Moolenaarbcf94422018-06-23 14:21:42 +02001015# define REX_ALL (REX_SET | REX_USE)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001016#endif
1017
1018/* Return values for fullpathcmp() */
1019/* Note: can use (fullpathcmp() & FPC_SAME) to check for equal files */
1020#define FPC_SAME 1 /* both exist and are the same file. */
1021#define FPC_DIFF 2 /* both exist and are different files. */
1022#define FPC_NOTX 4 /* both don't exist. */
1023#define FPC_DIFFX 6 /* one of them doesn't exist. */
1024#define FPC_SAMEX 7 /* both don't exist and file names are same. */
1025
1026/* flags for do_ecmd() */
1027#define ECMD_HIDE 0x01 /* don't free the current buffer */
1028#define ECMD_SET_HELP 0x02 /* set b_help flag of (new) buffer before
1029 opening file */
1030#define ECMD_OLDBUF 0x04 /* use existing buffer if it exists */
1031#define ECMD_FORCEIT 0x08 /* ! used in Ex command */
1032#define ECMD_ADDBUF 0x10 /* don't edit, just add to buffer list */
1033
1034/* for lnum argument in do_ecmd() */
1035#define ECMD_LASTL (linenr_T)0 /* use last position in loaded file */
1036#define ECMD_LAST (linenr_T)-1 /* use last position in all files */
1037#define ECMD_ONE (linenr_T)1 /* use first line */
1038
1039/* flags for do_cmdline() */
1040#define DOCMD_VERBOSE 0x01 /* included command in error message */
1041#define DOCMD_NOWAIT 0x02 /* don't call wait_return() and friends */
1042#define DOCMD_REPEAT 0x04 /* repeat exec. until getline() returns NULL */
1043#define DOCMD_KEYTYPED 0x08 /* don't reset KeyTyped */
1044#define DOCMD_EXCRESET 0x10 /* reset exception environment (for debugging)*/
1045#define DOCMD_KEEPLINE 0x20 /* keep typed line for repeating with "." */
1046
1047/* flags for beginline() */
1048#define BL_WHITE 1 /* cursor on first non-white in the line */
1049#define BL_SOL 2 /* use 'sol' option */
1050#define BL_FIX 4 /* don't leave cursor on a NUL */
1051
1052/* flags for mf_sync() */
1053#define MFS_ALL 1 /* also sync blocks with negative numbers */
1054#define MFS_STOP 2 /* stop syncing when a character is available */
1055#define MFS_FLUSH 4 /* flushed file to disk */
1056#define MFS_ZERO 8 /* only write block 0 */
1057
1058/* flags for buf_copy_options() */
1059#define BCO_ENTER 1 /* going to enter the buffer */
1060#define BCO_ALWAYS 2 /* always copy the options */
1061#define BCO_NOHELP 4 /* don't touch the help related options */
1062
1063/* flags for do_put() */
1064#define PUT_FIXINDENT 1 /* make indent look nice */
1065#define PUT_CURSEND 2 /* leave cursor after end of new text */
Bram Moolenaardf177f62005-02-22 08:39:57 +00001066#define PUT_CURSLINE 4 /* leave cursor on last line of new text */
1067#define PUT_LINE 8 /* put register as lines */
1068#define PUT_LINE_SPLIT 16 /* split line for linewise register */
1069#define PUT_LINE_FORWARD 32 /* put linewise register below Visual sel. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001070
1071/* flags for set_indent() */
1072#define SIN_CHANGED 1 /* call changed_bytes() when line changed */
1073#define SIN_INSERT 2 /* insert indent before existing text */
1074#define SIN_UNDO 4 /* save line for undo before changing it */
1075
1076/* flags for insertchar() */
1077#define INSCHAR_FORMAT 1 /* force formatting */
1078#define INSCHAR_DO_COM 2 /* format comments */
1079#define INSCHAR_CTRLV 4 /* char typed just after CTRL-V */
Bram Moolenaar81a82092008-03-12 16:27:00 +00001080#define INSCHAR_NO_FEX 8 /* don't use 'formatexpr' */
Bram Moolenaarbfe3bf82012-06-13 17:28:55 +02001081#define INSCHAR_COM_LIST 16 /* format comments with list/2nd line indent */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001082
1083/* flags for open_line() */
1084#define OPENLINE_DELSPACES 1 /* delete spaces after cursor */
1085#define OPENLINE_DO_COM 2 /* format comments */
1086#define OPENLINE_KEEPTRAIL 4 /* keep trailing spaces */
1087#define OPENLINE_MARKFIX 8 /* fix mark positions */
Bram Moolenaarbfe3bf82012-06-13 17:28:55 +02001088#define OPENLINE_COM_LIST 16 /* format comments with list/2nd line indent */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001089
1090/*
Bram Moolenaarc60954b2016-06-06 21:20:10 +02001091 * There are five history tables:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001092 */
1093#define HIST_CMD 0 /* colon commands */
1094#define HIST_SEARCH 1 /* search commands */
1095#define HIST_EXPR 2 /* expressions (from entering = register) */
1096#define HIST_INPUT 3 /* input() lines */
1097#define HIST_DEBUG 4 /* debug commands */
1098#define HIST_COUNT 5 /* number of history tables */
1099
Bram Moolenaarc60954b2016-06-06 21:20:10 +02001100/* The type numbers are fixed for backwards compatibility. */
1101#define BARTYPE_VERSION 1
1102#define BARTYPE_HISTORY 2
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02001103#define BARTYPE_REGISTER 3
Bram Moolenaar2d358992016-06-12 21:20:54 +02001104#define BARTYPE_MARK 4
Bram Moolenaarc60954b2016-06-06 21:20:10 +02001105
Bram Moolenaar2d358992016-06-12 21:20:54 +02001106#define VIMINFO_VERSION 4
Bram Moolenaar1fd99c12016-06-09 20:24:28 +02001107#define VIMINFO_VERSION_WITH_HISTORY 2
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02001108#define VIMINFO_VERSION_WITH_REGISTERS 3
Bram Moolenaar2d358992016-06-12 21:20:54 +02001109#define VIMINFO_VERSION_WITH_MARKS 4
Bram Moolenaar1fd99c12016-06-09 20:24:28 +02001110
Bram Moolenaarc60954b2016-06-06 21:20:10 +02001111typedef enum {
1112 BVAL_NR,
1113 BVAL_STRING,
1114 BVAL_EMPTY
1115} btype_T;
1116
Bram Moolenaarc60954b2016-06-06 21:20:10 +02001117typedef struct {
1118 btype_T bv_type;
1119 long bv_nr;
1120 char_u *bv_string;
1121 int bv_len; /* length of bv_string */
1122 int bv_allocated; /* bv_string was allocated */
1123} bval_T;
1124
Bram Moolenaar071d4272004-06-13 20:20:40 +00001125/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001126 * Values for do_tag().
1127 */
1128#define DT_TAG 1 /* jump to newer position or same tag again */
1129#define DT_POP 2 /* jump to older position */
1130#define DT_NEXT 3 /* jump to next match of same tag */
1131#define DT_PREV 4 /* jump to previous match of same tag */
1132#define DT_FIRST 5 /* jump to first match of same tag */
1133#define DT_LAST 6 /* jump to first match of same tag */
1134#define DT_SELECT 7 /* jump to selection from list */
1135#define DT_HELP 8 /* like DT_TAG, but no wildcards */
1136#define DT_JUMP 9 /* jump to new tag or selection from list */
1137#define DT_CSCOPE 10 /* cscope find command (like tjump) */
Bram Moolenaarb8a7b562006-02-01 21:47:16 +00001138#define DT_LTAG 11 /* tag using location list */
Bram Moolenaarea408852005-06-25 22:49:46 +00001139#define DT_FREE 99 /* free cached matches */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001140
1141/*
1142 * flags for find_tags().
1143 */
1144#define TAG_HELP 1 /* only search for help tags */
1145#define TAG_NAMES 2 /* only return name of tag */
1146#define TAG_REGEXP 4 /* use tag pattern as regexp */
1147#define TAG_NOIC 8 /* don't always ignore case */
1148#ifdef FEAT_CSCOPE
1149# define TAG_CSCOPE 16 /* cscope tag */
1150#endif
1151#define TAG_VERBOSE 32 /* message verbosity */
1152#define TAG_INS_COMP 64 /* Currently doing insert completion */
1153#define TAG_KEEP_LANG 128 /* keep current language */
1154
Bram Moolenaarc236c162008-07-13 17:41:49 +00001155#define TAG_MANY 300 /* When finding many tags (for completion),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001156 find up to this many tags */
1157
1158/*
1159 * Types of dialogs passed to do_vim_dialog().
1160 */
1161#define VIM_GENERIC 0
1162#define VIM_ERROR 1
1163#define VIM_WARNING 2
1164#define VIM_INFO 3
1165#define VIM_QUESTION 4
1166#define VIM_LAST_TYPE 4 /* sentinel value */
1167
1168/*
1169 * Return values for functions like gui_yesnocancel()
1170 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001171#define VIM_YES 2
1172#define VIM_NO 3
1173#define VIM_CANCEL 4
1174#define VIM_ALL 5
1175#define VIM_DISCARDALL 6
1176
1177/*
1178 * arguments for win_split()
1179 */
1180#define WSP_ROOM 1 /* require enough room */
1181#define WSP_VERT 2 /* split vertically */
1182#define WSP_TOP 4 /* window at top-left of shell */
1183#define WSP_BOT 8 /* window at bottom-right of shell */
1184#define WSP_HELP 16 /* creating the help window */
1185#define WSP_BELOW 32 /* put new window below/right */
1186#define WSP_ABOVE 64 /* put new window above/left */
Bram Moolenaar884ae642009-02-22 01:37:59 +00001187#define WSP_NEWLOC 128 /* don't copy location list */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001188
1189/*
Bram Moolenaar2e2a2812006-03-27 20:55:21 +00001190 * arguments for gui_set_shellsize()
1191 */
1192#define RESIZE_VERT 1 /* resize vertically */
1193#define RESIZE_HOR 2 /* resize horizontally */
1194#define RESIZE_BOTH 15 /* resize in both directions */
1195
1196/*
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001197 * flags for check_changed()
1198 */
1199#define CCGD_AW 1 /* do autowrite if buffer was changed */
1200#define CCGD_MULTWIN 2 /* check also when several wins for the buf */
1201#define CCGD_FORCEIT 4 /* ! used */
1202#define CCGD_ALLBUF 8 /* may write all buffers */
1203#define CCGD_EXCMD 16 /* may suggest using ! */
1204
1205/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001206 * "flags" values for option-setting functions.
1207 * When OPT_GLOBAL and OPT_LOCAL are both missing, set both local and global
1208 * values, get local value.
1209 */
1210#define OPT_FREE 1 /* free old value if it was allocated */
1211#define OPT_GLOBAL 2 /* use global value */
1212#define OPT_LOCAL 4 /* use local value */
1213#define OPT_MODELINE 8 /* option in modeline */
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00001214#define OPT_WINONLY 16 /* only set window-local options */
Bram Moolenaara3227e22006-03-08 21:32:40 +00001215#define OPT_NOWIN 32 /* don't set window-local options */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001216
1217/* Magic chars used in confirm dialog strings */
1218#define DLG_BUTTON_SEP '\n'
1219#define DLG_HOTKEY_CHAR '&'
1220
1221/* Values for "starting" */
1222#define NO_SCREEN 2 /* no screen updating yet */
1223#define NO_BUFFERS 1 /* not all buffers loaded yet */
1224/* 0 not starting anymore */
1225
1226/* Values for swap_exists_action: what to do when swap file already exists */
1227#define SEA_NONE 0 /* don't use dialog */
Bram Moolenaarbe79f902005-12-07 20:56:14 +00001228#define SEA_DIALOG 1 /* use dialog when possible */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001229#define SEA_QUIT 2 /* quit editing the file */
1230#define SEA_RECOVER 3 /* recover the file */
1231
1232/*
1233 * Minimal size for block 0 of a swap file.
1234 * NOTE: This depends on size of struct block0! It's not done with a sizeof(),
1235 * because struct block0 is defined in memline.c (Sorry).
1236 * The maximal block size is arbitrary.
1237 */
1238#define MIN_SWAP_PAGE_SIZE 1048
1239#define MAX_SWAP_PAGE_SIZE 50000
1240
Bram Moolenaar25328e32018-09-11 21:30:09 +02001241/* Special values for current_sctx.sc_sid. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001242#define SID_MODELINE -1 /* when using a modeline */
1243#define SID_CMDARG -2 /* for "--cmd" argument */
1244#define SID_CARG -3 /* for "-c" argument */
1245#define SID_ENV -4 /* for sourcing environment variable */
Bram Moolenaard1f56e62006-02-22 21:25:37 +00001246#define SID_ERROR -5 /* option was reset because of an error */
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00001247#define SID_NONE -6 /* don't set scriptID */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001248
1249/*
1250 * Events for autocommands.
1251 */
1252enum auto_event
1253{
Bram Moolenaare8fa05b2018-09-16 15:48:06 +02001254 EVENT_BUFADD = 0, // after adding a buffer to the buffer list
1255 EVENT_BUFDELETE, // deleting a buffer from the buffer list
1256 EVENT_BUFENTER, // after entering a buffer
1257 EVENT_BUFFILEPOST, // after renaming a buffer
1258 EVENT_BUFFILEPRE, // before renaming a buffer
1259 EVENT_BUFHIDDEN, // just after buffer becomes hidden
1260 EVENT_BUFLEAVE, // before leaving a buffer
1261 EVENT_BUFNEW, // after creating any buffer
1262 EVENT_BUFNEWFILE, // when creating a buffer for a new file
1263 EVENT_BUFREADCMD, // read buffer using command
1264 EVENT_BUFREADPOST, // after reading a buffer
1265 EVENT_BUFREADPRE, // before reading a buffer
1266 EVENT_BUFUNLOAD, // just before unloading a buffer
1267 EVENT_BUFWINENTER, // after showing a buffer in a window
1268 EVENT_BUFWINLEAVE, // just after buffer removed from window
1269 EVENT_BUFWIPEOUT, // just before really deleting a buffer
1270 EVENT_BUFWRITECMD, // write buffer using command
1271 EVENT_BUFWRITEPOST, // after writing a buffer
1272 EVENT_BUFWRITEPRE, // before writing a buffer
Bram Moolenaarc4568ab2018-11-16 16:21:05 +01001273 EVENT_CMDLINECHANGED, // command line was modified
Bram Moolenaare8fa05b2018-09-16 15:48:06 +02001274 EVENT_CMDLINEENTER, // after entering the command line
1275 EVENT_CMDLINELEAVE, // before leaving the command line
1276 EVENT_CMDUNDEFINED, // command undefined
1277 EVENT_CMDWINENTER, // after entering the cmdline window
1278 EVENT_CMDWINLEAVE, // before leaving the cmdline window
1279 EVENT_COLORSCHEME, // after loading a colorscheme
1280 EVENT_COLORSCHEMEPRE, // before loading a colorscheme
1281 EVENT_COMPLETEDONE, // after finishing insert complete
1282 EVENT_CURSORHOLD, // cursor in same position for a while
1283 EVENT_CURSORHOLDI, // idem, in Insert mode
1284 EVENT_CURSORMOVED, // cursor was moved
1285 EVENT_CURSORMOVEDI, // cursor was moved in Insert mode
1286 EVENT_DIFFUPDATED, // after diffs were updated
1287 EVENT_DIRCHANGED, // after user changed directory
1288 EVENT_ENCODINGCHANGED, // after changing the 'encoding' option
1289 EVENT_EXITPRE, // before exiting
1290 EVENT_FILEAPPENDCMD, // append to a file using command
1291 EVENT_FILEAPPENDPOST, // after appending to a file
1292 EVENT_FILEAPPENDPRE, // before appending to a file
1293 EVENT_FILECHANGEDRO, // before first change to read-only file
1294 EVENT_FILECHANGEDSHELL, // after shell command that changed file
1295 EVENT_FILECHANGEDSHELLPOST, // after (not) reloading changed file
1296 EVENT_FILEREADCMD, // read from a file using command
1297 EVENT_FILEREADPOST, // after reading a file
1298 EVENT_FILEREADPRE, // before reading a file
1299 EVENT_FILETYPE, // new file type detected (user defined)
1300 EVENT_FILEWRITECMD, // write to a file using command
1301 EVENT_FILEWRITEPOST, // after writing a file
1302 EVENT_FILEWRITEPRE, // before writing a file
1303 EVENT_FILTERREADPOST, // after reading from a filter
1304 EVENT_FILTERREADPRE, // before reading from a filter
1305 EVENT_FILTERWRITEPOST, // after writing to a filter
1306 EVENT_FILTERWRITEPRE, // before writing to a filter
1307 EVENT_FOCUSGAINED, // got the focus
1308 EVENT_FOCUSLOST, // lost the focus to another app
1309 EVENT_FUNCUNDEFINED, // if calling a function which doesn't exist
1310 EVENT_GUIENTER, // after starting the GUI
1311 EVENT_GUIFAILED, // after starting the GUI failed
1312 EVENT_INSERTCHANGE, // when changing Insert/Replace mode
1313 EVENT_INSERTCHARPRE, // before inserting a char
1314 EVENT_INSERTENTER, // when entering Insert mode
1315 EVENT_INSERTLEAVE, // when leaving Insert mode
1316 EVENT_MENUPOPUP, // just before popup menu is displayed
1317 EVENT_OPTIONSET, // option was set
1318 EVENT_QUICKFIXCMDPOST, // after :make, :grep etc.
1319 EVENT_QUICKFIXCMDPRE, // before :make, :grep etc.
1320 EVENT_QUITPRE, // before :quit
1321 EVENT_REMOTEREPLY, // upon string reception from a remote vim
1322 EVENT_SESSIONLOADPOST, // after loading a session file
1323 EVENT_SHELLCMDPOST, // after ":!cmd"
1324 EVENT_SHELLFILTERPOST, // after ":1,2!cmd", ":w !cmd", ":r !cmd".
1325 EVENT_SOURCECMD, // sourcing a Vim script using command
1326 EVENT_SOURCEPRE, // before sourcing a Vim script
Bram Moolenaar2b618522019-01-12 13:26:03 +01001327 EVENT_SOURCEPOST, // after sourcing a Vim script
Bram Moolenaare8fa05b2018-09-16 15:48:06 +02001328 EVENT_SPELLFILEMISSING, // spell file missing
1329 EVENT_STDINREADPOST, // after reading from stdin
1330 EVENT_STDINREADPRE, // before reading from stdin
1331 EVENT_SWAPEXISTS, // found existing swap file
1332 EVENT_SYNTAX, // syntax selected
1333 EVENT_TABCLOSED, // after closing a tab page
1334 EVENT_TABENTER, // after entering a tab page
1335 EVENT_TABLEAVE, // before leaving a tab page
1336 EVENT_TABNEW, // when entering a new tab page
1337 EVENT_TERMCHANGED, // after changing 'term'
1338 EVENT_TERMINALOPEN, // after a terminal buffer was created
1339 EVENT_TERMRESPONSE, // after setting "v:termresponse"
1340 EVENT_TEXTCHANGED, // text was modified not in Insert mode
1341 EVENT_TEXTCHANGEDI, // text was modified in Insert mode
1342 EVENT_TEXTCHANGEDP, // TextChangedI with popup menu visible
1343 EVENT_TEXTYANKPOST, // after some text was yanked
1344 EVENT_USER, // user defined autocommand
1345 EVENT_VIMENTER, // after starting Vim
1346 EVENT_VIMLEAVE, // before exiting Vim
1347 EVENT_VIMLEAVEPRE, // before exiting Vim and writing .viminfo
1348 EVENT_VIMRESIZED, // after Vim window was resized
1349 EVENT_WINENTER, // after entering a window
1350 EVENT_WINLEAVE, // before leaving a window
1351 EVENT_WINNEW, // when entering a new window
Bram Moolenaare87303a2018-03-11 17:02:12 +01001352
Bram Moolenaare8fa05b2018-09-16 15:48:06 +02001353 NUM_EVENTS // MUST be the last one
Bram Moolenaar071d4272004-06-13 20:20:40 +00001354};
1355
Bram Moolenaarcf0c5542006-02-09 23:48:02 +00001356typedef enum auto_event event_T;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001357
1358/*
1359 * Values for index in highlight_attr[].
1360 * When making changes, also update HL_FLAGS below! And update the default
1361 * value of 'highlight' in option.c.
1362 */
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00001363typedef enum
Bram Moolenaar071d4272004-06-13 20:20:40 +00001364{
1365 HLF_8 = 0 /* Meta & special keys listed with ":map", text that is
1366 displayed different from what it is */
Bram Moolenaar58b85342016-08-14 19:54:54 +02001367 , HLF_EOB /* after the last line in the buffer */
1368 , HLF_AT /* @ characters at end of screen, characters that
Bram Moolenaar071d4272004-06-13 20:20:40 +00001369 don't really exist in the text */
1370 , HLF_D /* directories in CTRL-D listing */
1371 , HLF_E /* error messages */
1372 , HLF_H /* obsolete, ignored */
1373 , HLF_I /* incremental search */
1374 , HLF_L /* last search string */
1375 , HLF_M /* "--More--" message */
1376 , HLF_CM /* Mode (e.g., "-- INSERT --") */
1377 , HLF_N /* line number for ":number" and ":#" commands */
Bram Moolenaar06ca5132012-03-23 16:25:17 +01001378 , HLF_CLN /* current line number */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001379 , HLF_R /* return to continue message and yes/no questions */
1380 , HLF_S /* status lines */
1381 , HLF_SNC /* status lines of not-current windows */
1382 , HLF_C /* column to separate vertically split windows */
1383 , HLF_T /* Titles for output from ":set all", ":autocmd" etc. */
1384 , HLF_V /* Visual mode */
1385 , HLF_VNC /* Visual mode, autoselecting and not clipboard owner */
1386 , HLF_W /* warning messages */
1387 , HLF_WM /* Wildmenu highlight */
1388 , HLF_FL /* Folded line */
1389 , HLF_FC /* Fold column */
1390 , HLF_ADD /* Added diff line */
1391 , HLF_CHD /* Changed diff line */
1392 , HLF_DED /* Deleted diff line */
1393 , HLF_TXD /* Text Changed in diff line */
Bram Moolenaar860cae12010-06-05 23:22:07 +02001394 , HLF_CONCEAL /* Concealed text */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001395 , HLF_SC /* Sign column */
Bram Moolenaar2e4096b2005-03-20 22:25:45 +00001396 , HLF_SPB /* SpellBad */
Bram Moolenaarf9184a12005-07-02 23:10:47 +00001397 , HLF_SPC /* SpellCap */
Bram Moolenaar2e4096b2005-03-20 22:25:45 +00001398 , HLF_SPR /* SpellRare */
1399 , HLF_SPL /* SpellLocal */
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001400 , HLF_PNI /* popup menu normal item */
1401 , HLF_PSI /* popup menu selected item */
1402 , HLF_PSB /* popup menu scrollbar */
1403 , HLF_PST /* popup menu scrollbar thumb */
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001404 , HLF_TP /* tabpage line */
1405 , HLF_TPS /* tabpage line selected */
1406 , HLF_TPF /* tabpage line filler */
Bram Moolenaar3633cf52017-07-31 22:29:35 +02001407 , HLF_CUC /* 'cursorcolumn' */
1408 , HLF_CUL /* 'cursorline' */
Bram Moolenaar1a384422010-07-14 19:53:30 +02001409 , HLF_MC /* 'colorcolumn' */
Bram Moolenaar21020352017-06-13 17:21:04 +02001410 , HLF_QFL /* quickfix window line currently selected */
Bram Moolenaar3633cf52017-07-31 22:29:35 +02001411 , HLF_ST /* status lines of terminal windows */
Bram Moolenaar05fbfdc2017-08-14 22:35:08 +02001412 , HLF_STNC /* status lines of not-current terminal windows */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001413 , HLF_COUNT /* MUST be the last one */
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00001414} hlf_T;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001415
Bram Moolenaarf71a3db2006-03-12 21:50:18 +00001416/* The HL_FLAGS must be in the same order as the HLF_ enums!
Bram Moolenaar42b4dda2010-03-02 15:56:05 +01001417 * When changing this also adjust the default for 'highlight'. */
Bram Moolenaar58b85342016-08-14 19:54:54 +02001418#define HL_FLAGS {'8', '~', '@', 'd', 'e', 'h', 'i', 'l', 'm', 'M', \
Bram Moolenaar06ca5132012-03-23 16:25:17 +01001419 'n', 'N', 'r', 's', 'S', 'c', 't', 'v', 'V', 'w', 'W', \
Bram Moolenaar860cae12010-06-05 23:22:07 +02001420 'f', 'F', 'A', 'C', 'D', 'T', '-', '>', \
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001421 'B', 'P', 'R', 'L', \
Bram Moolenaar05fbfdc2017-08-14 22:35:08 +02001422 '+', '=', 'x', 'X', '*', '#', '_', '!', '.', 'o', 'q', \
1423 'z', 'Z'}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001424
1425/*
1426 * Boolean constants
1427 */
1428#ifndef TRUE
1429# define FALSE 0 /* note: this is an int, not a long! */
1430# define TRUE 1
1431#endif
1432
1433#define MAYBE 2 /* sometimes used for a variant on TRUE */
1434
Bram Moolenaar7db5fc82010-05-24 11:59:29 +02001435#ifndef UINT32_T
1436typedef UINT32_TYPEDEF UINT32_T;
1437#endif
1438
Bram Moolenaar071d4272004-06-13 20:20:40 +00001439/*
1440 * Operator IDs; The order must correspond to opchars[] in ops.c!
1441 */
1442#define OP_NOP 0 /* no pending operation */
1443#define OP_DELETE 1 /* "d" delete operator */
1444#define OP_YANK 2 /* "y" yank operator */
1445#define OP_CHANGE 3 /* "c" change operator */
1446#define OP_LSHIFT 4 /* "<" left shift operator */
1447#define OP_RSHIFT 5 /* ">" right shift operator */
1448#define OP_FILTER 6 /* "!" filter operator */
1449#define OP_TILDE 7 /* "g~" switch case operator */
1450#define OP_INDENT 8 /* "=" indent operator */
1451#define OP_FORMAT 9 /* "gq" format operator */
1452#define OP_COLON 10 /* ":" colon operator */
1453#define OP_UPPER 11 /* "gU" make upper case operator */
1454#define OP_LOWER 12 /* "gu" make lower case operator */
1455#define OP_JOIN 13 /* "J" join operator, only for Visual mode */
1456#define OP_JOIN_NS 14 /* "gJ" join operator, only for Visual mode */
1457#define OP_ROT13 15 /* "g?" rot-13 encoding */
1458#define OP_REPLACE 16 /* "r" replace chars, only for Visual mode */
1459#define OP_INSERT 17 /* "I" Insert column, only for Visual mode */
1460#define OP_APPEND 18 /* "A" Append column, only for Visual mode */
1461#define OP_FOLD 19 /* "zf" define a fold */
1462#define OP_FOLDOPEN 20 /* "zo" open folds */
1463#define OP_FOLDOPENREC 21 /* "zO" open folds recursively */
1464#define OP_FOLDCLOSE 22 /* "zc" close folds */
1465#define OP_FOLDCLOSEREC 23 /* "zC" close folds recursively */
1466#define OP_FOLDDEL 24 /* "zd" delete folds */
1467#define OP_FOLDDELREC 25 /* "zD" delete folds recursively */
1468#define OP_FORMAT2 26 /* "gw" format operator, keeps cursor pos */
Bram Moolenaar12033fb2005-12-16 21:49:31 +00001469#define OP_FUNCTION 27 /* "g@" call 'operatorfunc' */
Bram Moolenaard79e5502016-01-10 22:13:02 +01001470#define OP_NR_ADD 28 /* "<C-A>" Add to the number or alphabetic
1471 character (OP_ADD conflicts with Perl) */
1472#define OP_NR_SUB 29 /* "<C-X>" Subtract from the number or
1473 alphabetic character */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001474
1475/*
1476 * Motion types, used for operators and for yank/delete registers.
1477 */
1478#define MCHAR 0 /* character-wise movement/register */
1479#define MLINE 1 /* line-wise movement/register */
1480#define MBLOCK 2 /* block-wise register */
1481
1482#define MAUTO 0xff /* Decide between MLINE/MCHAR */
1483
1484/*
1485 * Minimum screen size
1486 */
1487#define MIN_COLUMNS 12 /* minimal columns for screen */
1488#define MIN_LINES 2 /* minimal lines for screen */
1489#define STATUS_HEIGHT 1 /* height of a status line under a window */
Bram Moolenaar3167c3e2017-11-25 14:19:43 +01001490#ifdef FEAT_MENU /* height of a status line under a window */
1491# define WINBAR_HEIGHT(wp) (wp)->w_winbar_height
Bram Moolenaar415a6932017-12-05 20:31:07 +01001492# define VISIBLE_HEIGHT(wp) ((wp)->w_height + (wp)->w_winbar_height)
Bram Moolenaar3167c3e2017-11-25 14:19:43 +01001493#else
1494# define WINBAR_HEIGHT(wp) 0
Bram Moolenaar415a6932017-12-05 20:31:07 +01001495# define VISIBLE_HEIGHT(wp) (wp)->w_height
Bram Moolenaar3167c3e2017-11-25 14:19:43 +01001496#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001497#define QF_WINHEIGHT 10 /* default height for quickfix window */
1498
1499/*
1500 * Buffer sizes
1501 */
1502#ifndef CMDBUFFSIZE
1503# define CMDBUFFSIZE 256 /* size of the command processing buffer */
1504#endif
1505
1506#define LSIZE 512 /* max. size of a line in the tags file */
1507
1508#define IOSIZE (1024+1) /* file i/o and sprintf buffer size */
Bram Moolenaard9d30582005-05-18 22:10:28 +00001509
Bram Moolenaard9462e32011-04-11 21:35:11 +02001510#define DIALOG_MSG_SIZE 1000 /* buffer size for dialog_msg() */
1511
Bram Moolenaard9d30582005-05-18 22:10:28 +00001512#ifdef FEAT_MBYTE
1513# define MSG_BUF_LEN 480 /* length of buffer for small messages */
1514# define MSG_BUF_CLEN (MSG_BUF_LEN / 6) /* cell length (worst case: utf-8
1515 takes 6 bytes for one cell) */
1516#else
1517# define MSG_BUF_LEN 80 /* length of buffer for small messages */
1518# define MSG_BUF_CLEN MSG_BUF_LEN /* cell length */
1519#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001520
Bram Moolenaaree695f72016-08-03 22:08:45 +02001521#define FOLD_TEXT_LEN 51 /* buffer size for get_foldtext() */
1522
Bram Moolenaar0bd40c02009-06-16 09:07:49 +00001523/* Size of the buffer used for tgetent(). Unfortunately this is largely
1524 * undocumented, some systems use 1024. Using a buffer that is too small
1525 * causes a buffer overrun and a crash. Use the maximum known value to stay
1526 * on the safe side. */
1527#define TBUFSZ 2048 /* buffer size for termcap entry */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001528
1529/*
1530 * Maximum length of key sequence to be mapped.
1531 * Must be able to hold an Amiga resize report.
1532 */
1533#define MAXMAPLEN 50
1534
Bram Moolenaar55debbe2010-05-23 23:34:36 +02001535/* Size in bytes of the hash used in the undo file. */
1536#define UNDO_HASH_SIZE 32
1537
Bram Moolenaara7241f52008-06-24 20:39:31 +00001538#ifdef HAVE_FCNTL_H
1539# include <fcntl.h>
1540#endif
1541
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542#ifdef BINARY_FILE_IO
1543# define WRITEBIN "wb" /* no CR-LF translation */
1544# define READBIN "rb"
1545# define APPENDBIN "ab"
1546#else
1547# define WRITEBIN "w"
1548# define READBIN "r"
1549# define APPENDBIN "a"
1550#endif
1551
1552/*
1553 * EMX doesn't have a global way of making open() use binary I/O.
1554 * Use O_BINARY for all open() calls.
1555 */
Bram Moolenaara06ecab2016-07-16 14:47:36 +02001556#if defined(__CYGWIN32__)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001557# define O_EXTRA O_BINARY
1558#else
1559# define O_EXTRA 0
1560#endif
1561
Bram Moolenaara5792f52005-11-23 21:25:05 +00001562#ifndef O_NOFOLLOW
1563# define O_NOFOLLOW 0
1564#endif
1565
Bram Moolenaar071d4272004-06-13 20:20:40 +00001566#ifndef W_OK
1567# define W_OK 2 /* for systems that don't have W_OK in unistd.h */
1568#endif
1569#ifndef R_OK
1570# define R_OK 4 /* for systems that don't have R_OK in unistd.h */
1571#endif
1572
1573/*
1574 * defines to avoid typecasts from (char_u *) to (char *) and back
1575 * (vim_strchr() and vim_strrchr() are now in alloc.c)
1576 */
1577#define STRLEN(s) strlen((char *)(s))
1578#define STRCPY(d, s) strcpy((char *)(d), (char *)(s))
1579#define STRNCPY(d, s, n) strncpy((char *)(d), (char *)(s), (size_t)(n))
1580#define STRCMP(d, s) strcmp((char *)(d), (char *)(s))
1581#define STRNCMP(d, s, n) strncmp((char *)(d), (char *)(s), (size_t)(n))
1582#ifdef HAVE_STRCASECMP
1583# define STRICMP(d, s) strcasecmp((char *)(d), (char *)(s))
1584#else
1585# ifdef HAVE_STRICMP
1586# define STRICMP(d, s) stricmp((char *)(d), (char *)(s))
1587# else
1588# define STRICMP(d, s) vim_stricmp((char *)(d), (char *)(s))
1589# endif
1590#endif
1591
Bram Moolenaara7241f52008-06-24 20:39:31 +00001592/* Like strcpy() but allows overlapped source and destination. */
1593#define STRMOVE(d, s) mch_memmove((d), (s), STRLEN(s) + 1)
1594
Bram Moolenaar071d4272004-06-13 20:20:40 +00001595#ifdef HAVE_STRNCASECMP
1596# define STRNICMP(d, s, n) strncasecmp((char *)(d), (char *)(s), (size_t)(n))
1597#else
1598# ifdef HAVE_STRNICMP
1599# define STRNICMP(d, s, n) strnicmp((char *)(d), (char *)(s), (size_t)(n))
1600# else
1601# define STRNICMP(d, s, n) vim_strnicmp((char *)(d), (char *)(s), (size_t)(n))
1602# endif
1603#endif
1604
1605#ifdef FEAT_MBYTE
Bram Moolenaara245a5b2007-08-11 11:58:23 +00001606/* We need to call mb_stricmp() even when we aren't dealing with a multi-byte
1607 * encoding because mb_stricmp() takes care of all ascii and non-ascii
Bram Moolenaar42b4dda2010-03-02 15:56:05 +01001608 * encodings, including characters with umlauts in latin1, etc., while
Bram Moolenaara245a5b2007-08-11 11:58:23 +00001609 * STRICMP() only handles the system locale version, which often does not
1610 * handle non-ascii properly. */
1611
1612# define MB_STRICMP(d, s) mb_strnicmp((char_u *)(d), (char_u *)(s), (int)MAXCOL)
1613# define MB_STRNICMP(d, s, n) mb_strnicmp((char_u *)(d), (char_u *)(s), (int)(n))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001614#else
1615# define MB_STRICMP(d, s) STRICMP((d), (s))
1616# define MB_STRNICMP(d, s, n) STRNICMP((d), (s), (n))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001617#endif
1618
1619#define STRCAT(d, s) strcat((char *)(d), (char *)(s))
1620#define STRNCAT(d, s, n) strncat((char *)(d), (char *)(s), (size_t)(n))
1621
1622#ifdef HAVE_STRPBRK
1623# define vim_strpbrk(s, cs) (char_u *)strpbrk((char *)(s), (char *)(cs))
1624#endif
1625
1626#define MSG(s) msg((char_u *)(s))
1627#define MSG_ATTR(s, attr) msg_attr((char_u *)(s), (attr))
1628#define EMSG(s) emsg((char_u *)(s))
1629#define EMSG2(s, p) emsg2((char_u *)(s), (char_u *)(p))
1630#define EMSG3(s, p, q) emsg3((char_u *)(s), (char_u *)(p), (char_u *)(q))
1631#define EMSGN(s, n) emsgn((char_u *)(s), (long)(n))
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001632#define EMSGU(s, n) emsgu((char_u *)(s), (long_u)(n))
Bram Moolenaar95f09602016-11-10 20:01:45 +01001633#define IEMSG(s) iemsg((char_u *)(s))
1634#define IEMSG2(s, p) iemsg2((char_u *)(s), (char_u *)(p))
1635#define IEMSGN(s, n) iemsgn((char_u *)(s), (long)(n))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001636#define OUT_STR(s) out_str((char_u *)(s))
1637#define OUT_STR_NF(s) out_str_nf((char_u *)(s))
1638#define MSG_PUTS(s) msg_puts((char_u *)(s))
1639#define MSG_PUTS_ATTR(s, a) msg_puts_attr((char_u *)(s), (a))
1640#define MSG_PUTS_TITLE(s) msg_puts_title((char_u *)(s))
Bram Moolenaar1d73c882005-06-19 22:48:47 +00001641#define MSG_PUTS_LONG(s) msg_puts_long_attr((char_u *)(s), 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001642#define MSG_PUTS_LONG_ATTR(s, a) msg_puts_long_attr((char_u *)(s), (a))
1643
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001644#ifdef FEAT_GUI
Bram Moolenaar61be73b2016-04-29 22:59:22 +02001645# ifdef FEAT_TERMGUICOLORS
1646# define GUI_FUNCTION(f) (gui.in_use ? gui_##f : termgui_##f)
Bram Moolenaar187147a2016-05-01 13:09:57 +02001647# define GUI_FUNCTION2(f, pixel) (gui.in_use \
1648 ? ((pixel) != INVALCOLOR \
1649 ? gui_##f((pixel)) \
Bram Moolenaar424d74b2016-08-25 23:02:11 +02001650 : INVALCOLOR) \
Bram Moolenaar187147a2016-05-01 13:09:57 +02001651 : termgui_##f((pixel)))
Bram Moolenaar61be73b2016-04-29 22:59:22 +02001652# define USE_24BIT (gui.in_use || p_tgc)
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001653# else
1654# define GUI_FUNCTION(f) gui_##f
Bram Moolenaar187147a2016-05-01 13:09:57 +02001655# define GUI_FUNCTION2(f,pixel) ((pixel) != INVALCOLOR \
1656 ? gui_##f((pixel)) \
Bram Moolenaar424d74b2016-08-25 23:02:11 +02001657 : INVALCOLOR)
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001658# define USE_24BIT gui.in_use
1659# endif
1660#else
Bram Moolenaar61be73b2016-04-29 22:59:22 +02001661# ifdef FEAT_TERMGUICOLORS
1662# define GUI_FUNCTION(f) termgui_##f
Bram Moolenaar187147a2016-05-01 13:09:57 +02001663# define GUI_FUNCTION2(f, pixel) termgui_##f((pixel))
Bram Moolenaar61be73b2016-04-29 22:59:22 +02001664# define USE_24BIT p_tgc
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001665# endif
1666#endif
Bram Moolenaar61be73b2016-04-29 22:59:22 +02001667#ifdef FEAT_TERMGUICOLORS
1668# define IS_CTERM (t_colors > 1 || p_tgc)
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001669#else
1670# define IS_CTERM (t_colors > 1)
1671#endif
1672#ifdef GUI_FUNCTION
1673# define GUI_MCH_GET_RGB GUI_FUNCTION(mch_get_rgb)
Bram Moolenaar187147a2016-05-01 13:09:57 +02001674# define GUI_MCH_GET_RGB2(pixel) GUI_FUNCTION2(mch_get_rgb, (pixel))
Bram Moolenaar8a633e32016-04-21 21:10:14 +02001675# define GUI_MCH_GET_COLOR GUI_FUNCTION(mch_get_color)
1676# define GUI_GET_COLOR GUI_FUNCTION(get_color)
1677#endif
1678
Bram Moolenaar071d4272004-06-13 20:20:40 +00001679/* Prefer using emsg3(), because perror() may send the output to the wrong
1680 * destination and mess up the screen. */
1681#ifdef HAVE_STRERROR
1682# define PERROR(msg) (void)emsg3((char_u *)"%s: %s", (char_u *)msg, (char_u *)strerror(errno))
1683#else
Bram Moolenaarb869c0d2016-07-20 00:10:51 +02001684# define PERROR(msg) do_perror(msg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001685#endif
1686
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001687typedef long linenr_T; /* line number type */
1688typedef int colnr_T; /* column number type */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001689typedef unsigned short disptick_T; /* display tick type */
1690
1691#define MAXLNUM (0x7fffffffL) /* maximum (invalid) line number */
1692
1693/*
1694 * Well, you won't believe it, but some S/390 machines ("host", now also known
Bram Moolenaar883f5d02010-06-21 06:24:34 +02001695 * as zServer) use 31 bit pointers. There are also some newer machines, that
Bram Moolenaar071d4272004-06-13 20:20:40 +00001696 * use 64 bit pointers. I don't know how to distinguish between 31 and 64 bit
1697 * machines, so the best way is to assume 31 bits whenever we detect OS/390
1698 * Unix.
1699 * With this we restrict the maximum line length to 1073741823. I guess this is
1700 * not a real problem. BTW: Longer lines are split.
1701 */
Bram Moolenaara2aa31a2014-02-23 22:52:40 +01001702#if VIM_SIZEOF_INT >= 4
Bram Moolenaar071d4272004-06-13 20:20:40 +00001703# ifdef __MVS__
1704# define MAXCOL (0x3fffffffL) /* maximum column number, 30 bits */
1705# else
1706# define MAXCOL (0x7fffffffL) /* maximum column number, 31 bits */
1707# endif
1708#else
1709# define MAXCOL (0x7fff) /* maximum column number, 15 bits */
1710#endif
1711
1712#define SHOWCMD_COLS 10 /* columns needed by shown command */
1713#define STL_MAX_ITEM 80 /* max nr of %<flag> in statusline */
1714
1715typedef void *vim_acl_T; /* dummy to pass an ACL to a function */
1716
Bram Moolenaar52c0de12017-01-26 21:36:34 +01001717#ifndef mch_memmove
Bram Moolenaar3a118be2017-01-27 21:22:19 +01001718# define mch_memmove(to, from, len) memmove((char*)(to), (char*)(from), (size_t)(len))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001719#endif
1720
1721/*
1722 * fnamecmp() is used to compare file names.
1723 * On some systems case in a file name does not matter, on others it does.
1724 * (this does not account for maximum name lengths and things like "../dir",
1725 * thus it is not 100% accurate!)
1726 */
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01001727#define fnamecmp(x, y) vim_fnamecmp((char_u *)(x), (char_u *)(y))
1728#define fnamencmp(x, y, n) vim_fnamencmp((char_u *)(x), (char_u *)(y), (size_t)(n))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001729
1730#ifdef HAVE_MEMSET
1731# define vim_memset(ptr, c, size) memset((ptr), (c), (size))
1732#else
Bram Moolenaard99df422016-01-29 23:20:40 +01001733void *vim_memset(void *, int, size_t);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001734#endif
1735
Bram Moolenaare7fedb62015-12-31 19:07:19 +01001736#if defined(UNIX) || defined(FEAT_GUI) || defined(VMS) \
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737 || defined(FEAT_CLIENTSERVER)
1738# define USE_INPUT_BUF
1739#endif
1740
Bram Moolenaar540fc6f2010-12-17 16:27:16 +01001741#ifndef EINTR
1742# define read_eintr(fd, buf, count) vim_read((fd), (buf), (count))
1743# define write_eintr(fd, buf, count) vim_write((fd), (buf), (count))
1744#endif
1745
Bram Moolenaar071d4272004-06-13 20:20:40 +00001746#ifdef MSWIN
1747/* On MS-Windows the third argument isn't size_t. This matters for Win64,
1748 * where sizeof(size_t)==8, not 4 */
1749# define vim_read(fd, buf, count) read((fd), (char *)(buf), (unsigned int)(count))
1750# define vim_write(fd, buf, count) write((fd), (char *)(buf), (unsigned int)(count))
1751#else
1752# define vim_read(fd, buf, count) read((fd), (char *)(buf), (size_t) (count))
1753# define vim_write(fd, buf, count) write((fd), (char *)(buf), (size_t) (count))
1754#endif
1755
1756/*
1757 * Enums need a typecast to be used as array index (for Ultrix).
1758 */
Bram Moolenaar8820b482017-03-16 17:23:31 +01001759#define HL_ATTR(n) highlight_attr[(int)(n)]
1760#define TERM_STR(n) term_strings[(int)(n)]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001761
1762/*
Bram Moolenaara226a6d2006-02-26 23:59:20 +00001763 * EXTERN is only defined in main.c. That's where global variables are
1764 * actually defined and initialized.
1765 */
1766#ifndef EXTERN
1767# define EXTERN extern
1768# define INIT(x)
1769#else
1770# ifndef INIT
1771# define INIT(x) x
1772# define DO_INIT
Bram Moolenaarac77aec2016-07-26 22:02:54 +02001773# define COMMA ,
Bram Moolenaara226a6d2006-02-26 23:59:20 +00001774# endif
1775#endif
1776
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001777#ifdef FEAT_MBYTE
1778# define MAX_MCO 6 /* maximum value for 'maxcombine' */
1779
1780/* Maximum number of bytes in a multi-byte character. It can be one 32-bit
1781 * character of up to 6 bytes, or one 16-bit character of up to three bytes
1782 * plus six following composing characters of three bytes each. */
1783# define MB_MAXBYTES 21
Bram Moolenaar9a920d82012-06-01 15:21:02 +02001784#else
1785# define MB_MAXBYTES 1
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001786#endif
1787
Bram Moolenaar91a4e822008-01-19 14:59:58 +00001788#if (defined(FEAT_PROFILE) || defined(FEAT_RELTIME)) && !defined(PROTO)
1789# ifdef WIN3264
1790typedef LARGE_INTEGER proftime_T;
1791# else
1792typedef struct timeval proftime_T;
1793# endif
1794#else
1795typedef int proftime_T; /* dummy for function prototypes */
1796#endif
1797
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +02001798/*
1799 * When compiling with 32 bit Perl time_t is 32 bits in the Perl code but 64
1800 * bits elsewhere. That causes memory corruption. Define time_T and use it
1801 * for global variables to avoid that.
1802 */
Bram Moolenaard90b6c02016-08-28 18:10:45 +02001803#ifdef PROTO
1804typedef long time_T;
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +02001805#else
Bram Moolenaard90b6c02016-08-28 18:10:45 +02001806# ifdef WIN3264
1807typedef __time64_t time_T;
1808# else
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +02001809typedef time_t time_T;
Bram Moolenaard90b6c02016-08-28 18:10:45 +02001810# endif
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +02001811#endif
1812
Bram Moolenaard8070362016-02-15 21:56:54 +01001813#ifdef _WIN64
Bram Moolenaard090d7b2016-02-13 17:09:53 +01001814typedef __int64 sock_T;
Bram Moolenaarf8b7d892016-02-13 17:24:26 +01001815#else
Bram Moolenaard090d7b2016-02-13 17:09:53 +01001816typedef int sock_T;
Bram Moolenaard090d7b2016-02-13 17:09:53 +01001817#endif
1818
Bram Moolenaara226a6d2006-02-26 23:59:20 +00001819/* Include option.h before structs.h, because the number of window-local and
1820 * buffer-local options is used there. */
Bram Moolenaar40e280d2017-11-19 20:34:59 +01001821#include "option.h" /* options and default values */
1822
1823#include "beval.h" /* BalloonEval */
Bram Moolenaara226a6d2006-02-26 23:59:20 +00001824
Bram Moolenaar071d4272004-06-13 20:20:40 +00001825/* Note that gui.h is included by structs.h */
1826
Bram Moolenaar40e280d2017-11-19 20:34:59 +01001827#include "structs.h" /* defines many structures */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001828
Bram Moolenaar28fb79d2016-01-09 22:28:33 +01001829#include "alloc.h"
1830
Bram Moolenaar371d5402006-03-20 21:47:49 +00001831/* Values for "do_profiling". */
1832#define PROF_NONE 0 /* profiling not started */
1833#define PROF_YES 1 /* profiling busy */
1834#define PROF_PAUSED 2 /* profiling paused */
1835
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836#ifdef FEAT_MOUSE
1837
1838/* Codes for mouse button events in lower three bits: */
1839# define MOUSE_LEFT 0x00
1840# define MOUSE_MIDDLE 0x01
1841# define MOUSE_RIGHT 0x02
1842# define MOUSE_RELEASE 0x03
1843
1844/* bit masks for modifiers: */
1845# define MOUSE_SHIFT 0x04
1846# define MOUSE_ALT 0x08
1847# define MOUSE_CTRL 0x10
1848
1849/* mouse buttons that are handled like a key press (GUI only) */
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +02001850/* Note that the scroll wheel keys are inverted: MOUSE_5 scrolls lines up but
1851 * the result of this is that the window moves down, similarly MOUSE_6 scrolls
1852 * columns left but the window moves right. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001853# define MOUSE_4 0x100 /* scroll wheel down */
1854# define MOUSE_5 0x200 /* scroll wheel up */
1855
1856# define MOUSE_X1 0x300 /* Mouse-button X1 (6th) */
1857# define MOUSE_X2 0x400 /* Mouse-button X2 */
1858
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +02001859# define MOUSE_6 0x500 /* scroll wheel left */
1860# define MOUSE_7 0x600 /* scroll wheel right */
1861
Bram Moolenaar071d4272004-06-13 20:20:40 +00001862/* 0x20 is reserved by xterm */
1863# define MOUSE_DRAG_XTERM 0x40
1864
1865# define MOUSE_DRAG (0x40 | MOUSE_RELEASE)
1866
1867/* Lowest button code for using the mouse wheel (xterm only) */
1868# define MOUSEWHEEL_LOW 0x60
1869
1870# define MOUSE_CLICK_MASK 0x03
1871
1872# define NUM_MOUSE_CLICKS(code) \
1873 (((unsigned)((code) & 0xC0) >> 6) + 1)
1874
1875# define SET_NUM_MOUSE_CLICKS(code, num) \
1876 (code) = ((code) & 0x3f) | ((((num) - 1) & 3) << 6)
1877
Bram Moolenaar6f3058f2005-04-24 21:58:05 +00001878/* Added to mouse column for GUI when 'mousefocus' wants to give focus to a
1879 * window by simulating a click on its status line. We could use up to 128 *
1880 * 128 = 16384 columns, now it's reduced to 10000. */
1881# define MOUSE_COLOFF 10000
1882
Bram Moolenaar071d4272004-06-13 20:20:40 +00001883/*
1884 * jump_to_mouse() returns one of first four these values, possibly with
1885 * some of the other three added.
1886 */
1887# define IN_UNKNOWN 0
1888# define IN_BUFFER 1
1889# define IN_STATUS_LINE 2 /* on status or command line */
1890# define IN_SEP_LINE 4 /* on vertical separator line */
1891# define IN_OTHER_WIN 8 /* in other window but can't go there */
1892# define CURSOR_MOVED 0x100
1893# define MOUSE_FOLD_CLOSE 0x200 /* clicked on '-' in fold column */
1894# define MOUSE_FOLD_OPEN 0x400 /* clicked on '+' in fold column */
Bram Moolenaareb163d72017-09-23 15:08:17 +02001895# define MOUSE_WINBAR 0x800 /* in window toolbar */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001896
1897/* flags for jump_to_mouse() */
1898# define MOUSE_FOCUS 0x01 /* need to stay in this window */
1899# define MOUSE_MAY_VIS 0x02 /* may start Visual mode */
1900# define MOUSE_DID_MOVE 0x04 /* only act when mouse has moved */
1901# define MOUSE_SETPOS 0x08 /* only set current mouse position */
1902# define MOUSE_MAY_STOP_VIS 0x10 /* may stop Visual mode */
1903# define MOUSE_RELEASED 0x20 /* button was released */
1904
1905# if defined(UNIX) && defined(HAVE_GETTIMEOFDAY) && defined(HAVE_SYS_TIME_H)
1906# define CHECK_DOUBLE_CLICK 1 /* Checking for double clicks ourselves. */
1907# endif
1908
1909#endif /* FEAT_MOUSE */
1910
1911/* defines for eval_vars() */
1912#define VALID_PATH 1
1913#define VALID_HEAD 2
1914
1915/* Defines for Vim variables. These must match vimvars[] in eval.c! */
1916#define VV_COUNT 0
1917#define VV_COUNT1 1
1918#define VV_PREVCOUNT 2
1919#define VV_ERRMSG 3
1920#define VV_WARNINGMSG 4
1921#define VV_STATUSMSG 5
1922#define VV_SHELL_ERROR 6
1923#define VV_THIS_SESSION 7
1924#define VV_VERSION 8
1925#define VV_LNUM 9
1926#define VV_TERMRESPONSE 10
1927#define VV_FNAME 11
1928#define VV_LANG 12
1929#define VV_LC_TIME 13
1930#define VV_CTYPE 14
1931#define VV_CC_FROM 15
1932#define VV_CC_TO 16
1933#define VV_FNAME_IN 17
1934#define VV_FNAME_OUT 18
1935#define VV_FNAME_NEW 19
1936#define VV_FNAME_DIFF 20
1937#define VV_CMDARG 21
1938#define VV_FOLDSTART 22
1939#define VV_FOLDEND 23
1940#define VV_FOLDDASHES 24
1941#define VV_FOLDLEVEL 25
1942#define VV_PROGNAME 26
1943#define VV_SEND_SERVER 27
1944#define VV_DYING 28
1945#define VV_EXCEPTION 29
1946#define VV_THROWPOINT 30
1947#define VV_REG 31
1948#define VV_CMDBANG 32
Bram Moolenaar843ee412004-06-30 16:16:41 +00001949#define VV_INSERTMODE 33
Bram Moolenaar6d14ccd2005-01-15 22:08:30 +00001950#define VV_VAL 34
1951#define VV_KEY 35
Bram Moolenaar05159a02005-02-26 23:04:13 +00001952#define VV_PROFILING 36
Bram Moolenaar19a09a12005-03-04 23:39:37 +00001953#define VV_FCS_REASON 37
1954#define VV_FCS_CHOICE 38
Bram Moolenaar52b4b552005-03-07 23:00:57 +00001955#define VV_BEVAL_BUFNR 39
1956#define VV_BEVAL_WINNR 40
Bram Moolenaarc9721bd2016-06-04 17:41:03 +02001957#define VV_BEVAL_WINID 41
1958#define VV_BEVAL_LNUM 42
1959#define VV_BEVAL_COL 43
1960#define VV_BEVAL_TEXT 44
1961#define VV_SCROLLSTART 45
1962#define VV_SWAPNAME 46
1963#define VV_SWAPCHOICE 47
1964#define VV_SWAPCOMMAND 48
1965#define VV_CHAR 49
1966#define VV_MOUSE_WIN 50
Bram Moolenaar511972d2016-06-04 18:09:59 +02001967#define VV_MOUSE_WINID 51
1968#define VV_MOUSE_LNUM 52
1969#define VV_MOUSE_COL 53
1970#define VV_OP 54
1971#define VV_SEARCHFORWARD 55
1972#define VV_HLSEARCH 56
1973#define VV_OLDFILES 57
1974#define VV_WINDOWID 58
1975#define VV_PROGPATH 59
1976#define VV_COMPLETED_ITEM 60
1977#define VV_OPTION_NEW 61
1978#define VV_OPTION_OLD 62
1979#define VV_OPTION_TYPE 63
1980#define VV_ERRORS 64
1981#define VV_FALSE 65
1982#define VV_TRUE 66
1983#define VV_NULL 67
1984#define VV_NONE 68
1985#define VV_VIM_DID_ENTER 69
1986#define VV_TESTING 70
Bram Moolenaarf562e722016-07-19 17:25:25 +02001987#define VV_TYPE_NUMBER 71
1988#define VV_TYPE_STRING 72
1989#define VV_TYPE_FUNC 73
1990#define VV_TYPE_LIST 74
1991#define VV_TYPE_DICT 75
1992#define VV_TYPE_FLOAT 76
1993#define VV_TYPE_BOOL 77
1994#define VV_TYPE_NONE 78
1995#define VV_TYPE_JOB 79
1996#define VV_TYPE_CHANNEL 80
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01001997#define VV_TYPE_BLOB 81
1998#define VV_TERMRFGRESP 82
1999#define VV_TERMRBGRESP 83
2000#define VV_TERMU7RESP 84
2001#define VV_TERMSTYLERESP 85
2002#define VV_TERMBLINKRESP 86
2003#define VV_EVENT 87
2004#define VV_LEN 88 /* number of v: vars */
Bram Moolenaar520e1e42016-01-23 19:46:28 +01002005
2006/* used for v_number in VAR_SPECIAL */
2007#define VVAL_FALSE 0L
2008#define VVAL_TRUE 1L
2009#define VVAL_NONE 2L
2010#define VVAL_NULL 3L
Bram Moolenaar071d4272004-06-13 20:20:40 +00002011
Bram Moolenaarf562e722016-07-19 17:25:25 +02002012/* Type values for type(). */
2013#define VAR_TYPE_NUMBER 0
2014#define VAR_TYPE_STRING 1
2015#define VAR_TYPE_FUNC 2
2016#define VAR_TYPE_LIST 3
2017#define VAR_TYPE_DICT 4
2018#define VAR_TYPE_FLOAT 5
2019#define VAR_TYPE_BOOL 6
2020#define VAR_TYPE_NONE 7
2021#define VAR_TYPE_JOB 8
2022#define VAR_TYPE_CHANNEL 9
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002023#define VAR_TYPE_BLOB 10
Bram Moolenaarf562e722016-07-19 17:25:25 +02002024
Bram Moolenaar071d4272004-06-13 20:20:40 +00002025#ifdef FEAT_CLIPBOARD
2026
2027/* VIM_ATOM_NAME is the older Vim-specific selection type for X11. Still
2028 * supported for when a mix of Vim versions is used. VIMENC_ATOM_NAME includes
2029 * the encoding to support Vims using different 'encoding' values. */
Bram Moolenaar08ed30e2013-01-17 17:17:26 +01002030# define VIM_ATOM_NAME "_VIM_TEXT"
2031# define VIMENC_ATOM_NAME "_VIMENC_TEXT"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002032
2033/* Selection states for modeless selection */
2034# define SELECT_CLEARED 0
2035# define SELECT_IN_PROGRESS 1
2036# define SELECT_DONE 2
2037
2038# define SELECT_MODE_CHAR 0
2039# define SELECT_MODE_WORD 1
2040# define SELECT_MODE_LINE 2
2041
2042# ifdef FEAT_GUI_W32
2043# ifdef FEAT_OLE
2044# define WM_OLE (WM_APP+0)
2045# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046# endif
2047
2048/* Info about selected text */
2049typedef struct VimClipboard
2050{
2051 int available; /* Is clipboard available? */
2052 int owned; /* Flag: do we own the selection? */
2053 pos_T start; /* Start of selected area */
2054 pos_T end; /* End of selected area */
2055 int vmode; /* Visual mode character */
2056
2057 /* Fields for selection that doesn't use Visual mode */
2058 short_u origin_row;
2059 short_u origin_start_col;
2060 short_u origin_end_col;
2061 short_u word_start_col;
2062 short_u word_end_col;
2063
2064 pos_T prev; /* Previous position */
2065 short_u state; /* Current selection state */
2066 short_u mode; /* Select by char, word, or line. */
2067
2068# if defined(FEAT_GUI_X11) || defined(FEAT_XCLIPBOARD)
2069 Atom sel_atom; /* PRIMARY/CLIPBOARD selection ID */
2070# endif
2071
2072# ifdef FEAT_GUI_GTK
2073 GdkAtom gtk_sel_atom; /* PRIMARY/CLIPBOARD selection ID */
2074# endif
2075
Bram Moolenaar693e40c2013-02-26 14:56:42 +01002076# if defined(MSWIN) || defined(FEAT_CYGWIN_WIN32_CLIPBOARD)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002077 int_u format; /* Vim's own special clipboard format */
2078 int_u format_raw; /* Vim's raw text clipboard format */
2079# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002080} VimClipboard;
2081#else
2082typedef int VimClipboard; /* This is required for the prototypes. */
2083#endif
2084
Bram Moolenaar8767f522016-07-01 17:17:39 +02002085/* Use 64-bit stat structure if available. */
2086#if (defined(_MSC_VER) && (_MSC_VER >= 1300)) || defined(__MINGW32__)
2087# define HAVE_STAT64
2088typedef struct _stat64 stat_T;
2089#else
2090typedef struct stat stat_T;
2091#endif
2092
Bram Moolenaare80757c2018-04-10 12:42:44 +02002093#if defined(__GNUC__) && !defined(__MINGW32__)
2094# define USE_PRINTF_FORMAT_ATTRIBUTE
2095#endif
2096
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02002097typedef enum
2098{
2099 ASSERT_EQUAL,
2100 ASSERT_NOTEQUAL,
2101 ASSERT_MATCH,
2102 ASSERT_NOTMATCH,
2103 ASSERT_OTHER
2104} assert_type_T;
2105
Bram Moolenaarec2da362017-01-21 20:04:22 +01002106/* Mode for bracketed_paste(). */
2107typedef enum {
2108 PASTE_INSERT, /* insert mode */
2109 PASTE_CMDLINE, /* command line */
2110 PASTE_EX, /* ex mode line */
2111 PASTE_ONE_CHAR /* return first character */
2112} paste_mode_T;
2113
Bram Moolenaar6a2633b2018-10-07 23:16:36 +02002114// Argument for flush_buffers().
2115typedef enum {
2116 FLUSH_MINIMAL,
2117 FLUSH_TYPEAHEAD, // flush current typebuf contents
2118 FLUSH_INPUT // flush typebuf and inchar() input
2119} flush_buffers_T;
2120
Bram Moolenaar071d4272004-06-13 20:20:40 +00002121#include "ex_cmds.h" /* Ex command defines */
Bram Moolenaar6cfdb2a2016-07-19 17:01:31 +02002122#include "spell.h" /* spell checking stuff */
2123
Bram Moolenaar071d4272004-06-13 20:20:40 +00002124#include "proto.h" /* function prototypes */
2125
2126/* This has to go after the include of proto.h, as proto/gui.pro declares
2127 * functions of these names. The declarations would break if the defines had
2128 * been seen at that stage. But it must be before globals.h, where error_ga
2129 * is declared. */
2130#if !defined(FEAT_GUI_W32) && !defined(FEAT_GUI_X11) \
Bram Moolenaara6b7a082016-08-10 20:53:05 +02002131 && !defined(FEAT_GUI_GTK) && !defined(FEAT_GUI_MAC) && !defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002132# define mch_errmsg(str) fprintf(stderr, "%s", (str))
2133# define display_errors() fflush(stderr)
2134# define mch_msg(str) printf("%s", (str))
2135#else
2136# define USE_MCH_ERRMSG
2137#endif
2138
Bram Moolenaar6e35a112018-03-04 21:36:05 +01002139# if defined(FEAT_MBYTE) && defined(FEAT_EVAL) \
Bram Moolenaar3b3a9a52018-03-06 16:11:47 +01002140 && (!defined(FEAT_GUI_W32) \
Bram Moolenaar6e35a112018-03-04 21:36:05 +01002141 || !(defined(FEAT_MBYTE_IME) || defined(GLOBAL_IME))) \
Bram Moolenaar201dc672018-03-06 18:59:57 +01002142 && !(defined(FEAT_GUI_MAC) && defined(MACOS_CONVERT))
Bram Moolenaar3b3a9a52018-03-06 16:11:47 +01002143/* Whether IME is supported by im_get_status() defined in mbyte.c.
2144 * For Win32 GUI it's in gui_w32.c when FEAT_MBYTE_IME or GLOBAL_IME is defined.
2145 * for Mac it is in gui_mac.c for the GUI or in os_mac_conv.c when
2146 * MACOS_CONVERT is defined. */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002147# define IME_WITHOUT_XIM
2148#endif
2149
2150#if defined(FEAT_MBYTE) && (defined(FEAT_XIM) \
2151 || defined(IME_WITHOUT_XIM) \
Bram Moolenaar3b3a9a52018-03-06 16:11:47 +01002152 || (defined(FEAT_GUI_W32) \
2153 && (defined(FEAT_MBYTE_IME) || defined(GLOBAL_IME))) \
Bram Moolenaar107279c2018-03-04 18:57:19 +01002154 || defined(FEAT_GUI_MAC))
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002155/* im_set_active() is available */
2156# define HAVE_INPUT_METHOD
2157#endif
2158
Bram Moolenaaraab21c32005-01-25 21:46:35 +00002159#ifndef FEAT_MBYTE
2160# define after_pathsep(b, p) vim_ispathsep(*((p) - 1))
2161# define transchar_byte(c) transchar(c)
2162#endif
2163
2164#ifndef FEAT_LINEBREAK
2165/* Without the 'numberwidth' option line numbers are always 7 chars. */
2166# define number_width(x) 7
2167#endif
2168
Bram Moolenaar6537c422018-04-23 20:46:16 +02002169/* This must come after including proto.h.
2170 * For VMS this is defined in macros.h. */
2171#if !(defined(FEAT_MBYTE) && defined(WIN3264)) && !defined(VMS)
Bram Moolenaarb6843a02017-08-02 22:07:12 +02002172# define mch_open(n, m, p) open((n), (m), (p))
2173# define mch_fopen(n, p) fopen((n), (p))
2174#endif
Bram Moolenaaraab21c32005-01-25 21:46:35 +00002175
Bram Moolenaar071d4272004-06-13 20:20:40 +00002176#include "globals.h" /* global variables and messages */
2177
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178#ifndef FEAT_VIRTUALEDIT
Bram Moolenaar8820b482017-03-16 17:23:31 +01002179# define getvvcol(w, p, s, c, e) getvcol((w), (p), (s), (c), (e))
Bram Moolenaar76440e22014-11-27 19:14:49 +01002180# define virtual_active() FALSE
Bram Moolenaar071d4272004-06-13 20:20:40 +00002181# define virtual_op FALSE
2182#endif
2183
2184/*
2185 * If console dialog not supported, but GUI dialog is, use the GUI one.
2186 */
2187#if defined(FEAT_GUI_DIALOG) && !defined(FEAT_CON_DIALOG)
2188# define do_dialog gui_mch_dialog
2189#endif
2190
2191/*
2192 * Default filters for gui_mch_browse().
2193 * The filters are almost system independent. Except for the difference
2194 * between "*" and "*.*" for MSDOS-like systems.
2195 * NOTE: Motif only uses the very first pattern. Therefore
2196 * BROWSE_FILTER_DEFAULT should start with a "*" pattern.
2197 */
2198#ifdef FEAT_BROWSE
2199# ifdef BACKSLASH_IN_FILENAME
2200# define BROWSE_FILTER_MACROS \
Bram Moolenaarc36651b2018-04-29 12:22:56 +02002201 (char_u *)N_("Vim macro files (*.vim)\t*.vim\nAll Files (*.*)\t*.*\n")
2202# define BROWSE_FILTER_ALL_FILES (char_u *)N_("All Files (*.*)\t*.*\n")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002203# define BROWSE_FILTER_DEFAULT \
Bram Moolenaarc36651b2018-04-29 12:22:56 +02002204 (char_u *)N_("All Files (*.*)\t*.*\nC source (*.c, *.h)\t*.c;*.h\nC++ source (*.cpp, *.hpp)\t*.cpp;*.hpp\nVB code (*.bas, *.frm)\t*.bas;*.frm\nVim files (*.vim, _vimrc, _gvimrc)\t*.vim;_vimrc;_gvimrc\n")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002205# else
2206# define BROWSE_FILTER_MACROS \
Bram Moolenaarc36651b2018-04-29 12:22:56 +02002207 (char_u *)N_("Vim macro files (*.vim)\t*.vim\nAll Files (*)\t*\n")
2208# define BROWSE_FILTER_ALL_FILES (char_u *)N_("All Files (*)\t*\n")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002209# define BROWSE_FILTER_DEFAULT \
Bram Moolenaarc36651b2018-04-29 12:22:56 +02002210 (char_u *)N_("All Files (*)\t*\nC source (*.c, *.h)\t*.c;*.h\nC++ source (*.cpp, *.hpp)\t*.cpp;*.hpp\nVim files (*.vim, _vimrc, _gvimrc)\t*.vim;_vimrc;_gvimrc\n")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002211# endif
Bram Moolenaar7171abe2004-10-11 10:06:20 +00002212# define BROWSE_SAVE 1 /* flag for do_browse() */
2213# define BROWSE_DIR 2 /* flag for do_browse() */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002214#endif
2215
2216/* stop using fastcall for Borland */
2217#if defined(__BORLANDC__) && defined(WIN32) && !defined(DEBUG)
Bram Moolenaaraab21c32005-01-25 21:46:35 +00002218 #pragma option -p.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002219#endif
2220
Bram Moolenaar442b4222010-05-24 21:34:22 +02002221#ifdef _MSC_VER
2222/* Avoid useless warning "conversion from X to Y of greater size". */
2223 #pragma warning(disable : 4312)
Bram Moolenaareb292852015-02-10 18:47:58 +01002224/* Avoid warning for old style function declarators */
2225 #pragma warning(disable : 4131)
2226/* Avoid warning for conversion to type with smaller range */
2227 #pragma warning(disable : 4244)
2228/* Avoid warning for conversion to larger size */
2229 #pragma warning(disable : 4306)
2230/* Avoid warning for unreferenced formal parameter */
2231 #pragma warning(disable : 4100)
2232/* Avoid warning for differs in indirection to slightly different base type */
2233 #pragma warning(disable : 4057)
2234/* Avoid warning for constant conditional expression */
2235 #pragma warning(disable : 4127)
2236/* Avoid warning for assignment within conditional */
2237 #pragma warning(disable : 4706)
Bram Moolenaar442b4222010-05-24 21:34:22 +02002238#endif
2239
Bram Moolenaar9a920d82012-06-01 15:21:02 +02002240/* Note: a NULL argument for vim_realloc() is not portable, don't use it. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002241#if defined(MEM_PROFILE)
2242# define vim_realloc(ptr, size) mem_realloc((ptr), (size))
2243#else
2244# define vim_realloc(ptr, size) realloc((ptr), (size))
2245#endif
2246
2247/*
Bram Moolenaar34162142007-05-12 13:12:19 +00002248 * The following macros stop display/event loop nesting at the wrong time.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002249 */
2250#ifdef ALT_X_INPUT
2251# define ALT_INPUT_LOCK_OFF suppress_alternate_input = FALSE
2252# define ALT_INPUT_LOCK_ON suppress_alternate_input = TRUE
2253#endif
2254
2255#ifdef FEAT_MBYTE
Bram Moolenaar071d4272004-06-13 20:20:40 +00002256/*
2257 * Return byte length of character that starts with byte "b".
2258 * Returns 1 for a single-byte character.
2259 * MB_BYTE2LEN_CHECK() can be used to count a special key as one byte.
2260 * Don't call MB_BYTE2LEN(b) with b < 0 or b > 255!
2261 */
2262# define MB_BYTE2LEN(b) mb_bytelen_tab[b]
2263# define MB_BYTE2LEN_CHECK(b) (((b) < 0 || (b) > 255) ? 1 : mb_bytelen_tab[b])
2264#endif
2265
2266#if defined(FEAT_MBYTE) || defined(FEAT_POSTSCRIPT)
2267/* properties used in enc_canon_table[] (first three mutually exclusive) */
2268# define ENC_8BIT 0x01
2269# define ENC_DBCS 0x02
2270# define ENC_UNICODE 0x04
2271
2272# define ENC_ENDIAN_B 0x10 /* Unicode: Big endian */
2273# define ENC_ENDIAN_L 0x20 /* Unicode: Little endian */
2274
2275# define ENC_2BYTE 0x40 /* Unicode: UCS-2 */
2276# define ENC_4BYTE 0x80 /* Unicode: UCS-4 */
2277# define ENC_2WORD 0x100 /* Unicode: UTF-16 */
2278
2279# define ENC_LATIN1 0x200 /* Latin1 */
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00002280# define ENC_LATIN9 0x400 /* Latin9 */
2281# define ENC_MACROMAN 0x800 /* Mac Roman (not Macro Man! :-) */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002282#endif
2283
2284#ifdef FEAT_MBYTE
2285# ifdef USE_ICONV
2286# ifndef EILSEQ
2287# define EILSEQ 123
2288# endif
2289# ifdef DYNAMIC_ICONV
2290/* On Win32 iconv.dll is dynamically loaded. */
2291# define ICONV_ERRNO (*iconv_errno())
2292# define ICONV_E2BIG 7
2293# define ICONV_EINVAL 22
2294# define ICONV_EILSEQ 42
2295# else
2296# define ICONV_ERRNO errno
2297# define ICONV_E2BIG E2BIG
2298# define ICONV_EINVAL EINVAL
2299# define ICONV_EILSEQ EILSEQ
2300# endif
2301# endif
2302
2303#endif
2304
Bram Moolenaar071d4272004-06-13 20:20:40 +00002305
2306#define SIGN_BYTE 1 /* byte value used where sign is displayed;
2307 attribute value is sign type */
2308
2309#ifdef FEAT_NETBEANS_INTG
2310# define MULTISIGN_BYTE 2 /* byte value used where sign is displayed if
2311 multiple signs exist on the line */
2312#endif
2313
2314#if defined(FEAT_GUI) && defined(FEAT_XCLIPBOARD)
2315# ifdef FEAT_GUI_GTK
2316 /* Avoid using a global variable for the X display. It's ugly
2317 * and is likely to cause trouble in multihead environments. */
2318# define X_DISPLAY ((gui.in_use) ? gui_mch_get_display() : xterm_dpy)
2319# else
2320# define X_DISPLAY (gui.in_use ? gui.dpy : xterm_dpy)
2321# endif
2322#else
2323# ifdef FEAT_GUI
2324# ifdef FEAT_GUI_GTK
2325# define X_DISPLAY ((gui.in_use) ? gui_mch_get_display() : (Display *)NULL)
2326# else
2327# define X_DISPLAY gui.dpy
2328# endif
2329# else
2330# define X_DISPLAY xterm_dpy
2331# endif
2332#endif
2333
Bram Moolenaar77c604d2012-07-10 13:41:14 +02002334#if defined(FEAT_BROWSE) && defined(GTK_CHECK_VERSION)
2335# if GTK_CHECK_VERSION(2,4,0)
2336# define USE_FILE_CHOOSER
2337# endif
2338#endif
2339
Bram Moolenaar25328e32018-09-11 21:30:09 +02002340#ifdef FEAT_GUI_GTK
2341# if !GTK_CHECK_VERSION(2,14,0)
2342# define gtk_widget_get_window(wid) ((wid)->window)
Bram Moolenaar664323e2018-09-18 22:30:07 +02002343# define gtk_plug_get_socket_window(wid) ((wid)->socket_window)
2344# define gtk_selection_data_get_data(sel) ((sel)->data)
2345# define gtk_selection_data_get_data_type(sel) ((sel)->type)
2346# define gtk_selection_data_get_format(sel) ((sel)->format)
2347# define gtk_selection_data_get_length(sel) ((sel)->length)
2348# define gtk_adjustment_set_lower(adj, low) \
2349 do { (adj)->lower = low; } while (0)
2350# define gtk_adjustment_set_upper(adj, up) \
2351 do { (adj)->upper = up; } while (0)
2352# define gtk_adjustment_set_page_size(adj, size) \
2353 do { (adj)->page_size = size; } while (0)
2354# define gtk_adjustment_set_page_increment(adj, inc) \
2355 do { (adj)->page_increment = inc; } while (0)
2356# define gtk_adjustment_set_step_increment(adj, inc) \
2357 do { (adj)->step_increment = inc; } while (0)
2358# endif
2359# if !GTK_CHECK_VERSION(2,16,0)
2360# define gtk_selection_data_get_selection(sel) ((sel)->selection)
2361# endif
2362# if !GTK_CHECK_VERSION(2,18,0)
2363# define gtk_widget_get_allocation(wid, alloc) \
2364 do { *(alloc) = (wid)->allocation; } while (0)
2365# define gtk_widget_set_allocation(wid, alloc) \
2366 do { (wid)->allocation = *(alloc); } while (0)
2367# define gtk_widget_get_has_window(wid) !GTK_WIDGET_NO_WINDOW(wid)
2368# define gtk_widget_get_sensitive(wid) GTK_WIDGET_SENSITIVE(wid)
2369# define gtk_widget_get_visible(wid) GTK_WIDGET_VISIBLE(wid)
2370# define gtk_widget_has_focus(wid) GTK_WIDGET_HAS_FOCUS(wid)
2371# define gtk_widget_set_window(wid, win) \
2372 do { (wid)->window = (win); } while (0)
2373# define gtk_widget_set_can_default(wid, can) \
2374 do { if (can) { GTK_WIDGET_SET_FLAGS(wid, GTK_CAN_DEFAULT); } \
2375 else { GTK_WIDGET_UNSET_FLAGS(wid, GTK_CAN_DEFAULT); } } while (0)
2376# define gtk_widget_set_can_focus(wid, can) \
2377 do { if (can) { GTK_WIDGET_SET_FLAGS(wid, GTK_CAN_FOCUS); } \
2378 else { GTK_WIDGET_UNSET_FLAGS(wid, GTK_CAN_FOCUS); } } while (0)
2379# define gtk_widget_set_visible(wid, vis) \
2380 do { if (vis) { gtk_widget_show(wid); } \
2381 else { gtk_widget_hide(wid); } } while (0)
2382# endif
2383# if !GTK_CHECK_VERSION(2,20,0)
2384# define gtk_widget_get_mapped(wid) GTK_WIDGET_MAPPED(wid)
2385# define gtk_widget_get_realized(wid) GTK_WIDGET_REALIZED(wid)
2386# define gtk_widget_set_mapped(wid, map) \
2387 do { if (map) { GTK_WIDGET_SET_FLAGS(wid, GTK_MAPPED); } \
2388 else { GTK_WIDGET_UNSET_FLAGS(wid, GTK_MAPPED); } } while (0)
2389# define gtk_widget_set_realized(wid, rea) \
2390 do { if (rea) { GTK_WIDGET_SET_FLAGS(wid, GTK_REALIZED); } \
2391 else { GTK_WIDGET_UNSET_FLAGS(wid, GTK_REALIZED); } } while (0)
Bram Moolenaar25328e32018-09-11 21:30:09 +02002392# endif
2393#endif
2394
Bram Moolenaar03005972008-11-20 13:12:36 +00002395#ifndef FEAT_NETBEANS_INTG
2396# undef NBDEBUG
2397#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002398#ifdef NBDEBUG /* Netbeans debugging. */
2399# include "nbdebug.h"
2400#else
2401# define nbdebug(a)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002402#endif
2403
2404#ifdef IN_PERL_FILE
2405 /*
2406 * Avoid clashes between Perl and Vim namespace.
2407 */
2408# undef NORMAL
2409# undef STRLEN
2410# undef FF
2411# undef OP_DELETE
2412# undef OP_JOIN
2413# ifdef __BORLANDC__
2414# define NOPROTO 1
2415# endif
2416 /* remove MAX and MIN, included by glib.h, redefined by sys/param.h */
2417# ifdef MAX
2418# undef MAX
2419# endif
2420# ifdef MIN
2421# undef MIN
2422# endif
2423 /* We use _() for gettext(), Perl uses it for function prototypes... */
2424# ifdef _
2425# undef _
2426# endif
2427# ifdef DEBUG
2428# undef DEBUG
2429# endif
2430# ifdef _DEBUG
2431# undef _DEBUG
2432# endif
2433# ifdef instr
2434# undef instr
2435# endif
Bram Moolenaard0573012017-10-28 21:11:06 +02002436 /* bool may cause trouble on some old versions of Mac OS X but is required
2437 * on a few other systems and for Perl */
2438# if (defined(MACOS_X) && !defined(MAC_OS_X_VERSION_10_6)) \
2439 && defined(bool) && !defined(FEAT_PERL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002440# undef bool
2441# endif
2442
2443# ifdef __BORLANDC__
2444 /* Borland has the structure stati64 but not _stati64 */
2445# define _stati64 stati64
2446# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002447#endif
2448
Bram Moolenaar5eba4c22005-07-12 22:40:29 +00002449/* values for vim_handle_signal() that are not a signal */
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00002450#define SIGNAL_BLOCK -1
2451#define SIGNAL_UNBLOCK -2
Bram Moolenaare7fedb62015-12-31 19:07:19 +01002452#if !defined(UNIX) && !defined(VMS)
Bram Moolenaar5eba4c22005-07-12 22:40:29 +00002453# define vim_handle_signal(x) 0
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002454#endif
2455
Bram Moolenaar05159a02005-02-26 23:04:13 +00002456/* flags for skip_vimgrep_pat() */
2457#define VGR_GLOBAL 1
2458#define VGR_NOJUMP 2
2459
Bram Moolenaarb0bf8582005-12-13 20:02:15 +00002460/* behavior for bad character, "++bad=" argument */
2461#define BAD_REPLACE '?' /* replace it with '?' (default) */
2462#define BAD_KEEP -1 /* leave it */
2463#define BAD_DROP -2 /* erase it */
2464
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002465/* last argument for do_source() */
2466#define DOSO_NONE 0
2467#define DOSO_VIMRC 1 /* loading vimrc file */
2468#define DOSO_GVIMRC 2 /* loading gvimrc file */
Bram Moolenaar371d5402006-03-20 21:47:49 +00002469
Bram Moolenaard812df62008-11-09 12:46:09 +00002470/* flags for read_viminfo() and children */
2471#define VIF_WANT_INFO 1 /* load non-mark info */
2472#define VIF_WANT_MARKS 2 /* load file marks */
2473#define VIF_FORCEIT 4 /* overwrite info already read */
2474#define VIF_GET_OLDFILES 8 /* load v:oldfiles */
2475
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002476/* flags for buf_freeall() */
2477#define BFA_DEL 1 /* buffer is going to be deleted */
2478#define BFA_WIPE 2 /* buffer is going to be wiped out */
2479#define BFA_KEEP_UNDO 4 /* do not free undo information */
2480
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +02002481/* direction for nv_mousescroll() and ins_mousescroll() */
2482#define MSCR_DOWN 0 /* DOWN must be FALSE */
2483#define MSCR_UP 1
2484#define MSCR_LEFT -1
2485#define MSCR_RIGHT -2
2486
Bram Moolenaar946ffd42010-12-30 12:30:31 +01002487#define KEYLEN_PART_KEY -1 /* keylen value for incomplete key-code */
2488#define KEYLEN_PART_MAP -2 /* keylen value for incomplete mapping */
2489#define KEYLEN_REMOVED 9999 /* keylen value for removed sequence */
2490
Bram Moolenaar1c32dff2011-05-05 16:41:24 +02002491/* Return values from win32_fileinfo(). */
2492#define FILEINFO_OK 0
2493#define FILEINFO_ENC_FAIL 1 /* enc_to_utf16() failed */
2494#define FILEINFO_READ_FAIL 2 /* CreateFile() failed */
2495#define FILEINFO_INFO_FAIL 3 /* GetFileInformationByHandle() failed */
2496
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02002497/* Return value from get_option_value_strict */
2498#define SOPT_BOOL 0x01 /* Boolean option */
2499#define SOPT_NUM 0x02 /* Number option */
2500#define SOPT_STRING 0x04 /* String option */
2501#define SOPT_GLOBAL 0x08 /* Option has global value */
2502#define SOPT_WIN 0x10 /* Option has window-local value */
2503#define SOPT_BUF 0x20 /* Option has buffer-local value */
2504#define SOPT_UNSET 0x40 /* Option does not have local value set */
2505
Bram Moolenaar1028f4d2014-01-14 16:55:00 +01002506/* Option types for various functions in option.c */
Bram Moolenaar84e0f6c2013-05-06 03:52:55 +02002507#define SREQ_GLOBAL 0 /* Request global option */
2508#define SREQ_WIN 1 /* Request window-local option */
2509#define SREQ_BUF 2 /* Request buffer-local option */
2510
Bram Moolenaarb7cb42b2014-04-02 19:55:10 +02002511/* Flags for get_reg_contents */
2512#define GREG_NO_EXPR 1 /* Do not allow expression register */
2513#define GREG_EXPR_SRC 2 /* Return expression itself for "=" register */
2514#define GREG_LIST 4 /* Return list */
2515
Bram Moolenaar018acca2013-05-30 13:37:28 +02002516/* Character used as separated in autoload function/variable names. */
2517#define AUTOLOAD_CHAR '#'
2518
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01002519#ifdef FEAT_JOB_CHANNEL
Bram Moolenaare0874f82016-01-24 20:36:41 +01002520# define MAX_OPEN_CHANNELS 10
2521#else
2522# define MAX_OPEN_CHANNELS 0
2523#endif
2524
Bram Moolenaar595e64e2016-02-07 19:19:53 +01002525/* Options for json_encode() and json_decode. */
2526#define JSON_JS 1 /* use JS instead of JSON */
2527#define JSON_NO_NONE 2 /* v:none item not allowed */
Bram Moolenaarf1f07922016-08-26 17:58:53 +02002528#define JSON_NL 4 /* append a NL */
Bram Moolenaar595e64e2016-02-07 19:19:53 +01002529
Bram Moolenaar6bef5302016-03-12 21:28:26 +01002530/* Used for flags of do_in_path() */
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01002531#define DIP_ALL 0x01 /* all matches, not just the first one */
2532#define DIP_DIR 0x02 /* find directories instead of files. */
2533#define DIP_ERR 0x04 /* give an error message when none found. */
2534#define DIP_START 0x08 /* also use "start" directory in 'packpath' */
2535#define DIP_OPT 0x10 /* also use "opt" directory in 'packpath' */
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01002536#define DIP_NORTP 0x20 /* do not use 'runtimepath' */
Bram Moolenaar66459b72016-08-06 19:01:55 +02002537#define DIP_NOAFTER 0x40 /* skip "after" directories */
2538#define DIP_AFTER 0x80 /* only use "after" directories */
Bram Moolenaar6bef5302016-03-12 21:28:26 +01002539
Bram Moolenaar888ccac2016-06-04 18:49:36 +02002540/* Lowest number used for window ID. Cannot have this many windows. */
2541#define LOWEST_WIN_ID 1000
2542
Bram Moolenaarcd524592016-07-17 14:57:05 +02002543/* Used by the garbage collector. */
2544#define COPYID_INC 2
2545#define COPYID_MASK (~0x1)
2546
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002547/* Values for trans_function_name() argument: */
2548#define TFN_INT 1 /* internal function name OK */
2549#define TFN_QUIET 2 /* no error messages */
2550#define TFN_NO_AUTOLOAD 4 /* do not use script autoloading */
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002551#define TFN_NO_DEREF 8 /* do not dereference a Funcref */
Bram Moolenaar3a257732017-02-21 20:47:13 +01002552#define TFN_READ_ONLY 16 /* will not change the var */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002553
2554/* Values for get_lval() flags argument: */
2555#define GLV_QUIET TFN_QUIET /* no error messages */
2556#define GLV_NO_AUTOLOAD TFN_NO_AUTOLOAD /* do not use script autoloading */
Bram Moolenaar3a257732017-02-21 20:47:13 +01002557#define GLV_READ_ONLY TFN_READ_ONLY /* will not change the var */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002558
2559#define DO_NOT_FREE_CNT 99999 /* refcount for dict or list that should not
2560 be freed. */
2561
2562/* errors for when calling a function */
2563#define ERROR_UNKNOWN 0
2564#define ERROR_TOOMANY 1
2565#define ERROR_TOOFEW 2
2566#define ERROR_SCRIPT 3
2567#define ERROR_DICT 4
2568#define ERROR_NONE 5
2569#define ERROR_OTHER 6
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002570#define ERROR_DELETED 7
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002571
2572/* flags for find_name_end() */
2573#define FNE_INCL_BR 1 /* include [] in name */
2574#define FNE_CHECK_START 2 /* check name starts with valid character */
2575
Bram Moolenaar1a2ab992017-11-28 21:06:18 +01002576/* BSD is supposed to cover FreeBSD and similar systems. */
2577#if (defined(SUN_SYSTEM) || defined(BSD) || defined(__FreeBSD_kernel__)) \
Bram Moolenaard569bb02018-08-11 13:57:20 +02002578 && (defined(S_ISCHR) || defined(S_IFCHR))
Bram Moolenaarf04507d2016-08-20 15:05:39 +02002579# define OPEN_CHR_FILES
2580#endif
2581
Bram Moolenaard569bb02018-08-11 13:57:20 +02002582/* stat macros */
2583#ifndef S_ISDIR
2584# ifdef S_IFDIR
2585# define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
2586# else
2587# define S_ISDIR(m) 0
2588# endif
2589#endif
2590#ifndef S_ISREG
2591# ifdef S_IFREG
2592# define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
2593# else
2594# define S_ISREG(m) 0
2595# endif
2596#endif
2597#ifndef S_ISBLK
2598# ifdef S_IFBLK
2599# define S_ISBLK(m) (((m) & S_IFMT) == S_IFBLK)
2600# else
2601# define S_ISBLK(m) 0
2602# endif
2603#endif
2604#ifndef S_ISSOCK
2605# ifdef S_IFSOCK
2606# define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK)
2607# else
2608# define S_ISSOCK(m) 0
2609# endif
2610#endif
2611#ifndef S_ISFIFO
2612# ifdef S_IFIFO
2613# define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
2614# else
2615# define S_ISFIFO(m) 0
2616# endif
2617#endif
2618#ifndef S_ISCHR
2619# ifdef S_IFCHR
2620# define S_ISCHR(m) (((m) & S_IFMT) == S_IFCHR)
2621# else
2622# define S_ISCHR(m) 0
2623# endif
2624#endif
2625#ifndef S_ISLNK
2626# ifdef S_IFLNK
2627# define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
2628# else
2629# define S_ISLNK(m) 0
2630# endif
2631#endif
2632
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01002633#if defined(HAVE_GETTIMEOFDAY) && defined(HAVE_SYS_TIME_H)
2634# define ELAPSED_TIMEVAL
2635# define ELAPSED_INIT(v) gettimeofday(&v, NULL)
2636# define ELAPSED_FUNC(v) elapsed(&v)
2637# define ELAPSED_TYPE struct timeval
2638 long elapsed(struct timeval *start_tv);
2639#else
2640# if defined(WIN32)
2641# define ELAPSED_TICKCOUNT
Bram Moolenaar58c35872016-11-24 17:33:17 +01002642# define ELAPSED_INIT(v) v = GetTickCount()
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01002643# define ELAPSED_FUNC(v) elapsed(v)
2644# define ELAPSED_TYPE DWORD
Bram Moolenaar81b9d0b2017-03-19 21:20:53 +01002645# ifndef PROTO
2646 long elapsed(DWORD start_tick);
2647# endif
Bram Moolenaar833eb1d2016-11-24 17:22:50 +01002648# endif
2649#endif
2650
Bram Moolenaarf12519d2018-02-06 22:52:49 +01002651/* Replacement for nchar used by nv_replace(). */
2652#define REPLACE_CR_NCHAR -1
2653#define REPLACE_NL_NCHAR -2
2654
Bram Moolenaar13568252018-03-16 20:46:58 +01002655/* flags for term_start() */
2656#define TERM_START_NOJOB 1
2657#define TERM_START_FORCEIT 2
2658#define TERM_START_SYSTEM 4
2659
Bram Moolenaar40385db2018-08-07 22:31:44 +02002660// Used for icon/title save and restore.
2661#define SAVE_RESTORE_TITLE 1
2662#define SAVE_RESTORE_ICON 2
2663#define SAVE_RESTORE_BOTH (SAVE_RESTORE_TITLE | SAVE_RESTORE_ICON)
2664
Bram Moolenaar071d4272004-06-13 20:20:40 +00002665#endif /* VIM__H */