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