src/vim.h

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