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