/
vim.h
2640 lines (2342 loc) · 84.5 KB
/
vim.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* vi:set ts=8 sts=4 sw=4 noet:
*
* VIM - Vi IMproved by Bram Moolenaar
*
* Do ":help uganda" in Vim to read copying and usage conditions.
* Do ":help credits" in Vim to see a list of people who contributed.
*/
#ifndef VIM__H
# define VIM__H
#include "protodef.h"
// _WIN32 is defined as 1 when the compilation target is 32-bit or 64-bit.
// Note: If you want to check for 64-bit use the _WIN64 macro.
#if defined(WIN32) || defined(_WIN32)
# define MSWIN
#endif
#ifdef MSWIN
# include "vimio.h"
#endif
// ============ the header file puzzle: order matters =========
#ifdef HAVE_CONFIG_H // GNU autoconf (or something else) was here
# include "auto/config.h"
# define HAVE_PATHDEF
/*
* Check if configure correctly managed to find sizeof(int). If this failed,
* it becomes zero. This is likely a problem of not being able to run the
* test program. Other items from configure may also be wrong then!
*/
# if (VIM_SIZEOF_INT == 0)
Error: configure did not run properly. Check auto/config.log.
# endif
// for INT_MAX, LONG_MAX et al.
#include <limits.h>
/*
* Cygwin may have fchdir() in a newer release, but in most versions it
* doesn't work well and avoiding it keeps the binary backward compatible.
*/
# if defined(__CYGWIN32__) && defined(HAVE_FCHDIR)
# undef HAVE_FCHDIR
# endif
// We may need to define the uint32_t on non-Unix system, but using the same
// identifier causes conflicts. Therefore use UINT32_T.
# define UINT32_TYPEDEF uint32_t
#endif
#if !defined(UINT32_TYPEDEF)
# if defined(uint32_t) // this doesn't catch typedefs, unfortunately
# define UINT32_TYPEDEF uint32_t
# else
// Fall back to assuming unsigned int is 32 bit. If this is wrong then the
// test in blowfish.c will fail.
# define UINT32_TYPEDEF unsigned int
# endif
#endif
// user ID of root is usually zero, but not for everybody
#ifdef __TANDEM
# ifndef _TANDEM_SOURCE
# define _TANDEM_SOURCE
# endif
# include <floss.h>
# define ROOT_UID 65535
# define OLDXAW
# if (_TANDEM_ARCH_ == 2 && __H_Series_RVU >= 621)
# define SA_ONSTACK_COMPATIBILITY
# endif
#else
# define ROOT_UID 0
#endif
/*
* MACOS_X compiling for Mac OS X
* MACOS_X_DARWIN integrating the darwin feature into MACOS_X
*/
#if defined(MACOS_X_DARWIN) && !defined(MACOS_X)
# define MACOS_X
#endif
// Unless made through the Makefile enforce GUI on Mac
#if defined(MACOS_X) && !defined(HAVE_CONFIG_H)
# define UNIX
# define FEAT_GUI_MAC
#endif
#if defined(FEAT_GUI_MOTIF) \
|| defined(FEAT_GUI_GTK) \
|| defined(FEAT_GUI_ATHENA) \
|| defined(FEAT_GUI_MAC) \
|| defined(FEAT_GUI_MACVIM) \
|| defined(FEAT_GUI_MSWIN) \
|| defined(FEAT_GUI_PHOTON)
# define FEAT_GUI_ENABLED // also defined with NO_X11_INCLUDES
# if !defined(FEAT_GUI) && !defined(NO_X11_INCLUDES)
# define FEAT_GUI
# endif
#endif
// Check support for rendering options
#ifdef FEAT_GUI
# if defined(FEAT_DIRECTX)
# define FEAT_RENDER_OPTIONS
# endif
#endif
// Visual Studio 2005 has 'deprecated' many of the standard CRT functions
#if _MSC_VER >= 1400
# define _CRT_SECURE_NO_DEPRECATE
# define _CRT_NONSTDC_NO_DEPRECATE
#endif
/*
* VIM_SIZEOF_INT is used in feature.h, and the system-specific included files
* need items from feature.h. Therefore define VIM_SIZEOF_INT here.
*/
#ifdef MSWIN
# define VIM_SIZEOF_INT 4
#endif
#ifdef AMIGA
// Be conservative about sizeof(int). It could be 4 too.
# ifndef FEAT_GUI_GTK // avoid problems when generating prototypes
# ifdef __GNUC__
# define VIM_SIZEOF_INT 4
# else
# define VIM_SIZEOF_INT 2
# endif
# endif
#endif
#if defined(MACOS_X) && !defined(HAVE_CONFIG_H)
# define VIM_SIZEOF_INT __SIZEOF_INT__
#endif
#if VIM_SIZEOF_INT < 4 && !defined(PROTO)
Error: Vim only works with 32 bit int or larger
#endif
/*
* #defines for optionals and features
* Also defines FEAT_TINY, FEAT_SMALL, etc. when FEAT_HUGE is defined.
*/
#include "feature.h"
#if defined(MACOS_X_DARWIN)
# if defined(FEAT_SMALL) && !defined(FEAT_CLIPBOARD)
# define FEAT_CLIPBOARD
# endif
# if defined(FEAT_SMALL) && !defined(FEAT_MOUSE)
# define FEAT_MOUSE
# endif
#endif
// +x11 is only enabled when it's both available and wanted.
#if defined(HAVE_X11) && defined(WANT_X11)
# define FEAT_X11
#endif
#ifdef NO_X11_INCLUDES
// In os_mac_conv.c and os_macosx.m NO_X11_INCLUDES is defined to avoid
// X11 headers. Disable all X11 related things to avoid conflicts.
# ifdef FEAT_X11
# undef FEAT_X11
# endif
# ifdef FEAT_GUI_X11
# undef FEAT_GUI_X11
# endif
# ifdef FEAT_XCLIPBOARD
# undef FEAT_XCLIPBOARD
# endif
# ifdef FEAT_GUI_MOTIF
# undef FEAT_GUI_MOTIF
# endif
# ifdef FEAT_GUI_ATHENA
# undef FEAT_GUI_ATHENA
# endif
# ifdef FEAT_GUI_GTK
# undef FEAT_GUI_GTK
# endif
# ifdef FEAT_BEVAL_TIP
# undef FEAT_BEVAL_TIP
# endif
# ifdef FEAT_XIM
# undef FEAT_XIM
# endif
# ifdef FEAT_CLIENTSERVER
# undef FEAT_CLIENTSERVER
# endif
#endif
// The Mac conversion stuff doesn't work under X11.
#if defined(MACOS_X_DARWIN)
# define MACOS_CONVERT
#endif
// Can't use "PACKAGE" here, conflicts with a Perl include file.
#ifndef VIMPACKAGE
# define VIMPACKAGE "vim"
#endif
/*
* Find out if function definitions should include argument types
*/
#ifdef AZTEC_C
# include <functions.h>
#endif
#ifdef SASC
# include <clib/exec_protos.h>
#endif
#ifdef _DCC
# include <clib/exec_protos.h>
#endif
#ifdef __BEOS__
# include "os_beos.h"
#endif
#if (defined(UNIX) || defined(VMS)) \
&& (!defined(MACOS_X) || defined(HAVE_CONFIG_H))
# include "os_unix.h" // bring lots of system header files
#endif
// Mark unused function arguments with UNUSED, so that gcc -Wunused-parameter
// can be used to check for mistakes.
#if defined(HAVE_ATTRIBUTE_UNUSED) || defined(__MINGW32__)
# if !defined(UNUSED)
# define UNUSED __attribute__((unused))
# endif
#else
# define UNUSED
#endif
// Used to check for "sun", "__sun" is used by newer compilers.
#if defined(__sun)
# define SUN_SYSTEM
#endif
// If we're compiling in C++ (currently only KVim), the system
// headers must have the correct prototypes or nothing will build.
// Conversely, our prototypes might clash due to throw() specifiers and
// cause compilation failures even though the headers are correct. For
// a concrete example, gcc-3.2 enforces exception specifications, and
// glibc-2.2.5 has them in their system headers.
#if !defined(__cplusplus) && defined(UNIX) \
&& !defined(MACOS_X) // MACOS_X doesn't yet support osdef.h
# include "auto/osdef.h" // bring missing declarations in
#endif
#ifdef AMIGA
# include "os_amiga.h"
#endif
#ifdef MSWIN
# include "os_win32.h"
#endif
#ifdef __MINT__
# include "os_mint.h"
#endif
#if defined(MACOS_X)
# include "os_mac.h"
#endif
#ifdef __QNX__
# include "os_qnx.h"
#endif
#ifdef X_LOCALE
# include <X11/Xlocale.h>
#else
# ifdef HAVE_LOCALE_H
# include <locale.h>
# endif
#endif
/*
* Maximum length of a path (for non-unix systems) Make it a bit long, to stay
* on the safe side. But not too long to put on the stack.
*/
#ifndef MAXPATHL
# ifdef MAXPATHLEN
# define MAXPATHL MAXPATHLEN
# else
# define MAXPATHL 256
# endif
#endif
#ifdef BACKSLASH_IN_FILENAME
# define PATH_ESC_CHARS ((char_u *)" \t\n*?[{`%#'\"|!<")
#else
# ifdef VMS
// VMS allows a lot of characters in the file name
# define PATH_ESC_CHARS ((char_u *)" \t\n*?{`\\%#'\"|!")
# define SHELL_ESC_CHARS ((char_u *)" \t\n*?{`\\%#'|!()&")
# else
# define PATH_ESC_CHARS ((char_u *)" \t\n*?[{`$\\%#'\"|!<")
# define SHELL_ESC_CHARS ((char_u *)" \t\n*?[{`$\\%#'\"|!<>();&")
# endif
#endif
// length of a buffer to store a number in ASCII (64 bits binary + NUL)
#define NUMBUFLEN 65
// flags for vim_str2nr()
#define STR2NR_BIN 0x01
#define STR2NR_OCT 0x02
#define STR2NR_HEX 0x04
#define STR2NR_ALL (STR2NR_BIN + STR2NR_OCT + STR2NR_HEX)
#define STR2NR_NO_OCT (STR2NR_BIN + STR2NR_HEX)
#define STR2NR_FORCE 0x80 // only when ONE of the above is used
#define STR2NR_QUOTE 0x10 // ignore embedded single quotes
/*
* Shorthand for unsigned variables. Many systems, but not all, have u_char
* already defined, so we use char_u to avoid trouble.
*/
typedef unsigned char char_u;
typedef unsigned short short_u;
typedef unsigned int int_u;
// Older systems do not have support for long long
// use a typedef instead of hadcoded long long
#ifdef HAVE_NO_LONG_LONG
typedef long long_long_T;
typedef long unsigned long_long_u_T;
#else
typedef long long long_long_T;
typedef long long unsigned long_long_u_T;
#endif
// Make sure long_u is big enough to hold a pointer.
// On Win64, longs are 32 bits and pointers are 64 bits.
// For printf() and scanf(), we need to take care of long_u specifically.
#ifdef _WIN64
typedef unsigned __int64 long_u;
typedef __int64 long_i;
# define SCANF_HEX_LONG_U "%Ix"
# define SCANF_DECIMAL_LONG_U "%Iu"
# define PRINTF_HEX_LONG_U "0x%Ix"
#else
// Microsoft-specific. The __w64 keyword should be specified on any typedefs
// that change size between 32-bit and 64-bit platforms. For any such type,
// __w64 should appear only on the 32-bit definition of the typedef.
// Define __w64 as an empty token for everything but MSVC 7.x or later.
# if !defined(_MSC_VER) || (_MSC_VER < 1300)
# define __w64
# endif
typedef unsigned long __w64 long_u;
typedef long __w64 long_i;
# define SCANF_HEX_LONG_U "%lx"
# define SCANF_DECIMAL_LONG_U "%lu"
# define PRINTF_HEX_LONG_U "0x%lx"
#endif
#define PRINTF_DECIMAL_LONG_U SCANF_DECIMAL_LONG_U
/*
* Only systems which use configure will have SIZEOF_OFF_T and VIM_SIZEOF_LONG
* defined, which is ok since those are the same systems which can have
* varying sizes for off_t. The other systems will continue to use "%ld" to
* print off_t since off_t is simply a typedef to long for them.
*/
#if defined(SIZEOF_OFF_T) && (SIZEOF_OFF_T > VIM_SIZEOF_LONG)
# define LONG_LONG_OFF_T
#endif
/*
* We use 64-bit file functions here, if available. E.g. ftello() returns
* off_t instead of long, which helps if long is 32 bit and off_t is 64 bit.
* We assume that when fseeko() is available then ftello() is too.
* Note that Windows has different function names.
*/
#if (defined(_MSC_VER) && (_MSC_VER >= 1300)) || defined(__MINGW32__)
typedef __int64 off_T;
# ifdef __MINGW32__
# define vim_lseek lseek64
# define vim_fseek fseeko64
# define vim_ftell ftello64
# else
# define vim_lseek _lseeki64
# define vim_fseek _fseeki64
# define vim_ftell _ftelli64
# endif
#else
# ifdef PROTO
typedef long off_T;
# else
typedef off_t off_T;
# endif
# ifdef HAVE_FSEEKO
# define vim_lseek lseek
# define vim_ftell ftello
# define vim_fseek fseeko
# else
# define vim_lseek lseek
# define vim_ftell ftell
# define vim_fseek(a, b, c) fseek(a, (long)b, c)
# endif
#endif
/*
* The characters and attributes cached for the screen.
*/
typedef char_u schar_T;
typedef unsigned short sattr_T;
#define MAX_TYPENR 65535
/*
* The u8char_T can hold one decoded UTF-8 character.
* We use 32 bits, since some Asian characters don't fit in 16 bits.
*/
typedef unsigned int u8char_T; // int is 32 bits or more
#ifndef UNIX // For Unix this is included in os_unix.h
# include <stdio.h>
# include <ctype.h>
#endif
#include "ascii.h"
#include "keymap.h"
#include "term.h"
#include "macros.h"
#ifdef LATTICE
# include <sys/types.h>
# include <sys/stat.h>
#endif
#ifdef _DCC
# include <sys/stat.h>
#endif
#if defined(MSWIN)
# include <sys/stat.h>
#endif
#if defined(HAVE_ERRNO_H) || defined(MSWIN)
# include <errno.h>
#endif
/*
* Allow other (non-unix) systems to configure themselves now
* These are also in os_unix.h, because osdef.sh needs them there.
*/
#ifndef UNIX
// Note: Some systems need both string.h and strings.h (Savage). If the
// system can't handle this, define NO_STRINGS_WITH_STRING_H.
# ifdef HAVE_STRING_H
# include <string.h>
# endif
# if defined(HAVE_STRINGS_H) && !defined(NO_STRINGS_WITH_STRING_H)
# include <strings.h>
# endif
# ifdef HAVE_STAT_H
# include <stat.h>
# endif
# ifdef HAVE_STDLIB_H
# include <stdlib.h>
# endif
#endif // NON-UNIX
#include <assert.h>
#ifdef HAVE_STDINT_H
# include <stdint.h>
#endif
#ifdef HAVE_INTTYPES_H
# include <inttypes.h>
#endif
#ifdef HAVE_WCTYPE_H
# include <wctype.h>
#endif
#include <stdarg.h>
// for offsetof()
#include <stddef.h>
#if defined(HAVE_SYS_SELECT_H) && \
(!defined(HAVE_SYS_TIME_H) || defined(SYS_SELECT_WITH_SYS_TIME))
# include <sys/select.h>
#endif
#ifndef HAVE_SELECT
# ifdef HAVE_SYS_POLL_H
# include <sys/poll.h>
# elif defined(MSWIN)
# define HAVE_SELECT
# else
# ifdef HAVE_POLL_H
# include <poll.h>
# endif
# endif
#endif
// ================ end of the header file puzzle ===============
/*
* For dynamically loaded imm library. Currently, only for Win32.
*/
#ifdef DYNAMIC_IME
# ifndef FEAT_MBYTE_IME
# define FEAT_MBYTE_IME
# endif
#endif
/*
* For dynamically loaded gettext library. Currently, only for Win32.
*/
#ifdef DYNAMIC_GETTEXT
# ifndef FEAT_GETTEXT
# define FEAT_GETTEXT
# endif
// These are in os_win32.c
extern char *(*dyn_libintl_gettext)(const char *msgid);
extern char *(*dyn_libintl_ngettext)(const char *msgid, const char *msgid_plural, unsigned long n);
extern char *(*dyn_libintl_bindtextdomain)(const char *domainname, const char *dirname);
extern char *(*dyn_libintl_bind_textdomain_codeset)(const char *domainname, const char *codeset);
extern char *(*dyn_libintl_textdomain)(const char *domainname);
extern int (*dyn_libintl_wputenv)(const wchar_t *envstring);
#endif
/*
* The _() stuff is for using gettext(). It is a no-op when libintl.h is not
* found or the +multilang feature is disabled.
* Use NGETTEXT(single, multi, number) to get plural behavior:
* - single - message for singular form
* - multi - message for plural form
* - number - the count
*/
#ifdef FEAT_GETTEXT
# ifdef DYNAMIC_GETTEXT
# define _(x) (*dyn_libintl_gettext)((char *)(x))
# define NGETTEXT(x, xs, n) (*dyn_libintl_ngettext)((char *)(x), (char *)(xs), (n))
# define N_(x) x
# define bindtextdomain(domain, dir) (*dyn_libintl_bindtextdomain)((domain), (dir))
# define bind_textdomain_codeset(domain, codeset) (*dyn_libintl_bind_textdomain_codeset)((domain), (codeset))
# if !defined(HAVE_BIND_TEXTDOMAIN_CODESET)
# define HAVE_BIND_TEXTDOMAIN_CODESET 1
# endif
# define textdomain(domain) (*dyn_libintl_textdomain)(domain)
# define libintl_wputenv(envstring) (*dyn_libintl_wputenv)(envstring)
# else
# include <libintl.h>
# define _(x) gettext((char *)(x))
# define NGETTEXT(x, xs, n) ngettext((x), (xs), (n))
# ifdef gettext_noop
# define N_(x) gettext_noop(x)
# else
# define N_(x) x
# endif
# endif
#else
# define _(x) ((char *)(x))
# define NGETTEXT(x, xs, n) (((n) == 1) ? (char *)(x) : (char *)(xs))
# define N_(x) x
# ifdef bindtextdomain
# undef bindtextdomain
# endif
# define bindtextdomain(x, y) // empty
# ifdef bind_textdomain_codeset
# undef bind_textdomain_codeset
# endif
# define bind_textdomain_codeset(x, y) // empty
# ifdef textdomain
# undef textdomain
# endif
# define textdomain(x) // empty
#endif
/*
* flags for update_screen()
* The higher the value, the higher the priority
*/
#define VALID_NO_UPDATE 5 // no new changes, keep the command line if
// possible
#define VALID 10 // buffer not changed, or changes marked
// with b_mod_*
#define INVERTED 20 // redisplay inverted part that changed
#define INVERTED_ALL 25 // redisplay whole inverted part
#define REDRAW_TOP 30 // display first w_upd_rows screen lines
#define SOME_VALID 35 // like NOT_VALID but may scroll
#define NOT_VALID 40 // buffer needs complete redraw
#define CLEAR 50 // screen messed up, clear it
// flags for screen_line()
#define SLF_RIGHTLEFT 1
#define SLF_POPUP 2
#define MB_FILLER_CHAR '<' // character used when a double-width character
// doesn't fit.
/*
* Flags for w_valid.
* These are set when something in a window structure becomes invalid, except
* when the cursor is moved. Call check_cursor_moved() before testing one of
* the flags.
* These are reset when that thing has been updated and is valid again.
*
* Every function that invalidates one of these must call one of the
* invalidate_* functions.
*
* w_valid is supposed to be used only in screen.c. From other files, use the
* functions that set or reset the flags.
*
* VALID_BOTLINE VALID_BOTLINE_AP
* on on w_botline valid
* off on w_botline approximated
* off off w_botline not valid
* on off not possible
*/
#define VALID_WROW 0x01 // w_wrow (window row) is valid
#define VALID_WCOL 0x02 // w_wcol (window col) is valid
#define VALID_VIRTCOL 0x04 // w_virtcol (file col) is valid
#define VALID_CHEIGHT 0x08 // w_cline_height and w_cline_folded valid
#define VALID_CROW 0x10 // w_cline_row is valid
#define VALID_BOTLINE 0x20 // w_botine and w_empty_rows are valid
#define VALID_BOTLINE_AP 0x40 // w_botine is approximated
#define VALID_TOPLINE 0x80 // w_topline is valid (for cursor position)
// Values for w_popup_flags.
#define POPF_IS_POPUP 0x01 // this is a popup window
#define POPF_HIDDEN 0x02 // popup is not displayed
#define POPF_HANDLED 0x04 // popup was just redrawn or filtered
#define POPF_CURSORLINE 0x08 // popup is highlighting at the cursorline
#define POPF_ON_CMDLINE 0x10 // popup overlaps command line
#define POPF_DRAG 0x20 // popup can be moved by dragging
#define POPF_RESIZE 0x40 // popup can be resized by dragging
#define POPF_MAPPING 0x80 // mapping keys
#define POPF_INFO 0x100 // used for info of popup menu
#define POPF_INFO_MENU 0x200 // align info popup with popup menu
#ifdef FEAT_TEXT_PROP
# define WIN_IS_POPUP(wp) ((wp)->w_popup_flags != 0)
#else
# define WIN_IS_POPUP(wp) 0
#endif
/*
* Terminal highlighting attribute bits.
* Attributes above HL_ALL are used for syntax highlighting.
*/
#define HL_NORMAL 0x00
#define HL_INVERSE 0x01
#define HL_BOLD 0x02
#define HL_ITALIC 0x04
#define HL_UNDERLINE 0x08
#define HL_UNDERCURL 0x10
#define HL_STANDOUT 0x20
#define HL_NOCOMBINE 0x40
#define HL_STRIKETHROUGH 0x80
#define HL_ALL 0xff
// special attribute addition: Put message in history
#define MSG_HIST 0x1000
/*
* values for State
*
* The lower bits up to 0x20 are used to distinguish normal/visual/op_pending
* and cmdline/insert+replace mode. This is used for mapping. If none of
* these bits are set, no mapping is done.
* The upper bits are used to distinguish between other states.
*/
#define NORMAL 0x01 // Normal mode, command expected
#define VISUAL 0x02 // Visual mode - use get_real_state()
#define OP_PENDING 0x04 // Normal mode, operator is pending - use
// get_real_state()
#define CMDLINE 0x08 // Editing command line
#define INSERT 0x10 // Insert mode
#define LANGMAP 0x20 // Language mapping, can be combined with
// INSERT and CMDLINE
#define REPLACE_FLAG 0x40 // Replace mode flag
#define REPLACE (REPLACE_FLAG + INSERT)
#define VREPLACE_FLAG 0x80 // Virtual-replace mode flag
#define VREPLACE (REPLACE_FLAG + VREPLACE_FLAG + INSERT)
#define LREPLACE (REPLACE_FLAG + LANGMAP)
#define NORMAL_BUSY (0x100 + NORMAL) // Normal mode, busy with a command
#define HITRETURN (0x200 + NORMAL) // waiting for return or command
#define ASKMORE 0x300 // Asking if you want --more--
#define SETWSIZE 0x400 // window size has changed
#define ABBREV 0x500 // abbreviation instead of mapping
#define EXTERNCMD 0x600 // executing an external command
#define SHOWMATCH (0x700 + INSERT) // show matching paren
#define CONFIRM 0x800 // ":confirm" prompt
#define SELECTMODE 0x1000 // Select mode, only for mappings
#define TERMINAL 0x2000 // Terminal mode
#define MODE_ALL 0xffff
// all mode bits used for mapping
#define MAP_ALL_MODES (0x3f | SELECTMODE | TERMINAL)
// directions
#define FORWARD 1
#define BACKWARD (-1)
#define FORWARD_FILE 3
#define BACKWARD_FILE (-3)
// return values for functions
#if !(defined(OK) && (OK == 1))
// OK already defined to 1 in MacOS X curses, skip this
# define OK 1
#endif
#define FAIL 0
#define NOTDONE 2 // not OK or FAIL but skipped
// flags for b_flags
#define BF_RECOVERED 0x01 // buffer has been recovered
#define BF_CHECK_RO 0x02 // need to check readonly when loading file
// into buffer (set by ":e", may be reset by
// ":buf"
#define BF_NEVERLOADED 0x04 // file has never been loaded into buffer,
// many variables still need to be set
#define BF_NOTEDITED 0x08 // Set when file name is changed after
// starting to edit, reset when file is
// written out.
#define BF_NEW 0x10 // file didn't exist when editing started
#define BF_NEW_W 0x20 // Warned for BF_NEW and file created
#define BF_READERR 0x40 // got errors while reading the file
#define BF_DUMMY 0x80 // dummy buffer, only used internally
#define BF_PRESERVED 0x100 // ":preserve" was used
#define BF_SYN_SET 0x200 // 'syntax' option was set
#define BF_NO_SEA 0x400 // no swap_exists_action (ATTENTION prompt)
// Mask to check for flags that prevent normal writing
#define BF_WRITE_MASK (BF_NOTEDITED + BF_NEW + BF_READERR)
/*
* values for xp_context when doing command line completion
*/
#define EXPAND_UNSUCCESSFUL (-2)
#define EXPAND_OK (-1)
#define EXPAND_NOTHING 0
#define EXPAND_COMMANDS 1
#define EXPAND_FILES 2
#define EXPAND_DIRECTORIES 3
#define EXPAND_SETTINGS 4
#define EXPAND_BOOL_SETTINGS 5
#define EXPAND_TAGS 6
#define EXPAND_OLD_SETTING 7
#define EXPAND_HELP 8
#define EXPAND_BUFFERS 9
#define EXPAND_EVENTS 10
#define EXPAND_MENUS 11
#define EXPAND_SYNTAX 12
#define EXPAND_HIGHLIGHT 13
#define EXPAND_AUGROUP 14
#define EXPAND_USER_VARS 15
#define EXPAND_MAPPINGS 16
#define EXPAND_TAGS_LISTFILES 17
#define EXPAND_FUNCTIONS 18
#define EXPAND_USER_FUNC 19
#define EXPAND_EXPRESSION 20
#define EXPAND_MENUNAMES 21
#define EXPAND_USER_COMMANDS 22
#define EXPAND_USER_CMD_FLAGS 23
#define EXPAND_USER_NARGS 24
#define EXPAND_USER_COMPLETE 25
#define EXPAND_ENV_VARS 26
#define EXPAND_LANGUAGE 27
#define EXPAND_COLORS 28
#define EXPAND_COMPILER 29
#define EXPAND_USER_DEFINED 30
#define EXPAND_USER_LIST 31
#define EXPAND_SHELLCMD 32
#define EXPAND_CSCOPE 33
#define EXPAND_SIGN 34
#define EXPAND_PROFILE 35
#define EXPAND_BEHAVE 36
#define EXPAND_FILETYPE 37
#define EXPAND_FILES_IN_PATH 38
#define EXPAND_OWNSYNTAX 39
#define EXPAND_LOCALES 40
#define EXPAND_HISTORY 41
#define EXPAND_USER 42
#define EXPAND_SYNTIME 43
#define EXPAND_USER_ADDR_TYPE 44
#define EXPAND_PACKADD 45
#define EXPAND_MESSAGES 46
#define EXPAND_MAPCLEAR 47
#define EXPAND_ARGLIST 48
#define EXPAND_MACACTION 49
// Values for exmode_active (0 is no exmode)
#define EXMODE_NORMAL 1
#define EXMODE_VIM 2
// Values for nextwild() and ExpandOne(). See ExpandOne() for meaning.
#define WILD_FREE 1
#define WILD_EXPAND_FREE 2
#define WILD_EXPAND_KEEP 3
#define WILD_NEXT 4
#define WILD_PREV 5
#define WILD_ALL 6
#define WILD_LONGEST 7
#define WILD_ALL_KEEP 8
#define WILD_LIST_NOTFOUND 0x01
#define WILD_HOME_REPLACE 0x02
#define WILD_USE_NL 0x04
#define WILD_NO_BEEP 0x08
#define WILD_ADD_SLASH 0x10
#define WILD_KEEP_ALL 0x20
#define WILD_SILENT 0x40
#define WILD_ESCAPE 0x80
#define WILD_ICASE 0x100
#define WILD_ALLLINKS 0x200
#define WILD_IGNORE_COMPLETESLASH 0x400
// Flags for expand_wildcards()
#define EW_DIR 0x01 // include directory names
#define EW_FILE 0x02 // include file names
#define EW_NOTFOUND 0x04 // include not found names
#define EW_ADDSLASH 0x08 // append slash to directory name
#define EW_KEEPALL 0x10 // keep all matches
#define EW_SILENT 0x20 // don't print "1 returned" from shell
#define EW_EXEC 0x40 // executable files
#define EW_PATH 0x80 // search in 'path' too
#define EW_ICASE 0x100 // ignore case
#define EW_NOERROR 0x200 // no error for bad regexp
#define EW_NOTWILD 0x400 // add match with literal name if exists
#define EW_KEEPDOLLAR 0x800 // do not escape $, $var is expanded
// Note: mostly EW_NOTFOUND and EW_SILENT are mutually exclusive: EW_NOTFOUND
// is used when executing commands and EW_SILENT for interactive expanding.
#define EW_ALLLINKS 0x1000 // also links not pointing to existing file
#define EW_SHELLCMD 0x2000 // called from expand_shellcmd(), don't check
// if executable is in $PATH
#define EW_DODOT 0x4000 // also files starting with a dot
#define EW_EMPTYOK 0x8000 // no matches is not an error
#define EW_NOTENV 0x10000 // do not expand environment variables
// Flags for find_file_*() functions.
#define FINDFILE_FILE 0 // only files
#define FINDFILE_DIR 1 // only directories
#define FINDFILE_BOTH 2 // files and directories
#define W_ENDCOL(wp) (wp->w_wincol + wp->w_width)
#ifdef FEAT_MENU
# define W_WINROW(wp) (wp->w_winrow + wp->w_winbar_height)
#else
# define W_WINROW(wp) (wp->w_winrow)
#endif
// Values for the find_pattern_in_path() function args 'type' and 'action':
#define FIND_ANY 1
#define FIND_DEFINE 2
#define CHECK_PATH 3
#define ACTION_SHOW 1
#define ACTION_GOTO 2
#define ACTION_SPLIT 3
#define ACTION_SHOW_ALL 4
#define ACTION_EXPAND 5
#ifdef FEAT_SYN_HL
# define SST_MIN_ENTRIES 150 // minimal size for state stack array
# define SST_MAX_ENTRIES 1000 // maximal size for state stack array
# define SST_FIX_STATES 7 // size of sst_stack[].
# define SST_DIST 16 // normal distance between entries
# define SST_INVALID (synstate_T *)-1 // invalid syn_state pointer
# define HL_CONTAINED 0x01 // not used on toplevel
# define HL_TRANSP 0x02 // has no highlighting
# define HL_ONELINE 0x04 // match within one line only
# define HL_HAS_EOL 0x08 // end pattern that matches with $
# define HL_SYNC_HERE 0x10 // sync point after this item (syncing only)
# define HL_SYNC_THERE 0x20 // sync point at current line (syncing only)
# define HL_MATCH 0x40 // use match ID instead of item ID
# define HL_SKIPNL 0x80 // nextgroup can skip newlines
# define HL_SKIPWHITE 0x100 // nextgroup can skip white space
# define HL_SKIPEMPTY 0x200 // nextgroup can skip empty lines
# define HL_KEEPEND 0x400 // end match always kept
# define HL_EXCLUDENL 0x800 // exclude NL from match
# define HL_DISPLAY 0x1000 // only used for displaying, not syncing
# define HL_FOLD 0x2000 // define fold
# define HL_EXTEND 0x4000 // ignore a keepend
# define HL_MATCHCONT 0x8000 // match continued from previous line
# define HL_TRANS_CONT 0x10000 // transparent item without contains arg
# define HL_CONCEAL 0x20000 // can be concealed
# define HL_CONCEALENDS 0x40000 // can be concealed
#endif
// Values for 'options' argument in do_search() and searchit()
#define SEARCH_REV 0x01 // go in reverse of previous dir.
#define SEARCH_ECHO 0x02 // echo the search command and handle options
#define SEARCH_MSG 0x0c // give messages (yes, it's not 0x04)
#define SEARCH_NFMSG 0x08 // give all messages except not found
#define SEARCH_OPT 0x10 // interpret optional flags
#define SEARCH_HIS 0x20 // put search pattern in history
#define SEARCH_END 0x40 // put cursor at end of match
#define SEARCH_NOOF 0x80 // don't add offset to position
#define SEARCH_START 0x100 // start search without col offset
#define SEARCH_MARK 0x200 // set previous context mark
#define SEARCH_KEEP 0x400 // keep previous search pattern
#define SEARCH_PEEK 0x800 // peek for typed char, cancel search
#define SEARCH_COL 0x1000 // start at specified column instead of zero
// Values for find_ident_under_cursor()
#define FIND_IDENT 1 // find identifier (word)
#define FIND_STRING 2 // find any string (WORD)
#define FIND_EVAL 4 // include "->", "[]" and "."
#define FIND_NOERROR 8 // no error when no word found
// Values for file_name_in_line()
#define FNAME_MESS 1 // give error message
#define FNAME_EXP 2 // expand to path
#define FNAME_HYP 4 // check for hypertext link
#define FNAME_INCL 8 // apply 'includeexpr'
#define FNAME_REL 16 // ".." and "./" are relative to the (current)
// file instead of the current directory
#define FNAME_UNESC 32 // remove backslashes used for escaping
// Values for buflist_getfile()
#define GETF_SETMARK 0x01 // set pcmark before jumping
#define GETF_ALT 0x02 // jumping to alternate file (not buf num)
#define GETF_SWITCH 0x04 // respect 'switchbuf' settings when jumping
// Return values of getfile()
#define GETFILE_ERROR 1 // normal error
#define GETFILE_NOT_WRITTEN 2 // "not written" error
#define GETFILE_SAME_FILE 0 // success, same file
#define GETFILE_OPEN_OTHER -1 // success, opened another file
#define GETFILE_UNUSED 8
#define GETFILE_SUCCESS(x) ((x) <= 0)
// Values for buflist_new() flags
#define BLN_CURBUF 1 // may re-use curbuf for new buffer
#define BLN_LISTED 2 // put new buffer in buffer list
#define BLN_DUMMY 4 // allocating dummy buffer
#define BLN_NEW 8 // create a new buffer
#define BLN_NOOPT 16 // don't copy options to existing buffer
#define BLN_DUMMY_OK 32 // also find an existing dummy buffer
#define BLN_REUSE 64 // may re-use number from buf_reuse
// Values for in_cinkeys()
#define KEY_OPEN_FORW 0x101
#define KEY_OPEN_BACK 0x102
#define KEY_COMPLETE 0x103 // end of completion
// Values for "noremap" argument of ins_typebuf(). Also used for
// map->m_noremap and menu->noremap[].
#define REMAP_YES 0 // allow remapping
#define REMAP_NONE -1 // no remapping
#define REMAP_SCRIPT -2 // remap script-local mappings only
#define REMAP_SKIP -3 // no remapping for first char
// Values for mch_call_shell() second argument
#define SHELL_FILTER 1 // filtering text
#define SHELL_EXPAND 2 // expanding wildcards
#define SHELL_COOKED 4 // set term to cooked mode
#define SHELL_DOOUT 8 // redirecting output
#define SHELL_SILENT 16 // don't print error returned by command
#define SHELL_READ 32 // read lines and insert into buffer
#define SHELL_WRITE 64 // write lines from buffer
// Values returned by mch_nodetype()
#define NODE_NORMAL 0 // file or directory, check with mch_isdir()
#define NODE_WRITABLE 1 // something we can write to (character
// device, fifo, socket, ..)
#define NODE_OTHER 2 // non-writable thing (e.g., block device)
// Values for readfile() flags
#define READ_NEW 0x01 // read a file into a new buffer
#define READ_FILTER 0x02 // read filter output
#define READ_STDIN 0x04 // read from stdin
#define READ_BUFFER 0x08 // read from curbuf (converting stdin)
#define READ_DUMMY 0x10 // reading into a dummy buffer
#define READ_KEEP_UNDO 0x20 // keep undo info
#define READ_FIFO 0x40 // read from fifo or socket
// Values for change_indent()
#define INDENT_SET 1 // set indent
#define INDENT_INC 2 // increase indent
#define INDENT_DEC 3 // decrease indent
// Values for flags argument for findmatchlimit()
#define FM_BACKWARD 0x01 // search backwards
#define FM_FORWARD 0x02 // search forwards
#define FM_BLOCKSTOP 0x04 // stop at start/end of block
#define FM_SKIPCOMM 0x08 // skip comments
// Values for action argument for do_buffer() and close_buffer()
#define DOBUF_GOTO 0 // go to specified buffer
#define DOBUF_SPLIT 1 // split window and go to specified buffer
#define DOBUF_UNLOAD 2 // unload specified buffer(s)
#define DOBUF_DEL 3 // delete specified buffer(s) from buflist
#define DOBUF_WIPE 4 // delete specified buffer(s) really
#define DOBUF_WIPE_REUSE 5 // like DOBUF_WIPE an keep number for reuse
// Values for start argument for do_buffer()
#define DOBUF_CURRENT 0 // "count" buffer from current buffer