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