diff options
Diffstat (limited to 'src/macros.h')
| -rw-r--r-- | src/macros.h | 390 |
1 files changed, 390 insertions, 0 deletions
diff --git a/src/macros.h b/src/macros.h new file mode 100644 index 0000000..3db2456 --- /dev/null +++ b/src/macros.h @@ -0,0 +1,390 @@ +/* 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. + */ + +/* + * macros.h: macro definitions for often used code + * + * Macros should be ALL_CAPS. An exception is for where a function is + * replaced and an argument is not used more than once. + */ + +/* + * PBYTE(lp, c) - put byte 'c' at position 'lp' + */ +#define PBYTE(lp, c) (*(ml_get_buf(curbuf, (lp).lnum, TRUE) + (lp).col) = (c)) + +/* + * Position comparisons + */ +#define LT_POS(a, b) (((a).lnum != (b).lnum) \ + ? (a).lnum < (b).lnum \ + : (a).col != (b).col \ + ? (a).col < (b).col \ + : (a).coladd < (b).coladd) +#define LT_POSP(a, b) (((a)->lnum != (b)->lnum) \ + ? (a)->lnum < (b)->lnum \ + : (a)->col != (b)->col \ + ? (a)->col < (b)->col \ + : (a)->coladd < (b)->coladd) +#define EQUAL_POS(a, b) (((a).lnum == (b).lnum) && ((a).col == (b).col) && ((a).coladd == (b).coladd)) +#define CLEAR_POS(a) do {(a)->lnum = 0; (a)->col = 0; (a)->coladd = 0;} while (0) +#define EMPTY_POS(a) ((a).lnum == 0 && (a).col == 0 && (a).coladd == 0) + +#define LTOREQ_POS(a, b) (LT_POS(a, b) || EQUAL_POS(a, b)) + +/* + * VIM_ISWHITE() differs from isspace() because it doesn't include <CR> and + * <LF> and the like. + */ +#define VIM_ISWHITE(x) ((x) == ' ' || (x) == '\t') +#define IS_WHITE_OR_NUL(x) ((x) == ' ' || (x) == '\t' || (x) == NUL) + +/* + * LINEEMPTY() - return TRUE if the line is empty + */ +#define LINEEMPTY(p) (*ml_get(p) == NUL) + +/* + * BUFEMPTY() - return TRUE if the current buffer is empty + */ +#define BUFEMPTY() (curbuf->b_ml.ml_line_count == 1 && *ml_get((linenr_T)1) == NUL) + +/* + * toupper() and tolower() that use the current locale. + * On some systems toupper()/tolower() only work on lower/uppercase + * characters, first use islower() or isupper() then. + * Careful: Only call TOUPPER_LOC() and TOLOWER_LOC() with a character in the + * range 0 - 255. toupper()/tolower() on some systems can't handle others. + * Note: It is often better to use MB_TOLOWER() and MB_TOUPPER(), because many + * toupper() and tolower() implementations only work for ASCII. + */ +#ifdef MSWIN +# define TOUPPER_LOC(c) toupper_tab[(c) & 255] +# define TOLOWER_LOC(c) tolower_tab[(c) & 255] +#else +# ifdef BROKEN_TOUPPER +# define TOUPPER_LOC(c) (islower(c) ? toupper(c) : (c)) +# define TOLOWER_LOC(c) (isupper(c) ? tolower(c) : (c)) +# else +# define TOUPPER_LOC toupper +# define TOLOWER_LOC tolower +# endif +#endif + +// toupper() and tolower() for ASCII only and ignore the current locale. +#ifdef EBCDIC +# define TOUPPER_ASC(c) (islower(c) ? toupper(c) : (c)) +# define TOLOWER_ASC(c) (isupper(c) ? tolower(c) : (c)) +#else +# define TOUPPER_ASC(c) (((c) < 'a' || (c) > 'z') ? (c) : (c) - ('a' - 'A')) +# define TOLOWER_ASC(c) (((c) < 'A' || (c) > 'Z') ? (c) : (c) + ('a' - 'A')) +#endif + +/* + * MB_ISLOWER() and MB_ISUPPER() are to be used on multi-byte characters. But + * don't use them for negative values! + */ +#define MB_ISLOWER(c) vim_islower(c) +#define MB_ISUPPER(c) vim_isupper(c) +#define MB_TOLOWER(c) vim_tolower(c) +#define MB_TOUPPER(c) vim_toupper(c) +#define MB_CASEFOLD(c) (enc_utf8 ? utf_fold(c) : MB_TOLOWER(c)) + +// Use our own isdigit() replacement, because on MS-Windows isdigit() returns +// non-zero for superscript 1. Also avoids that isdigit() crashes for numbers +// below 0 and above 255. +#define VIM_ISDIGIT(c) ((unsigned)(c) - '0' < 10) + +// Like isalpha() but reject non-ASCII characters. Can't be used with a +// special key (negative value). +#ifdef EBCDIC +# define ASCII_ISALPHA(c) isalpha(c) +# define ASCII_ISALNUM(c) isalnum(c) +# define ASCII_ISLOWER(c) islower(c) +# define ASCII_ISUPPER(c) isupper(c) +#else +# define ASCII_ISLOWER(c) ((unsigned)(c) - 'a' < 26) +# define ASCII_ISUPPER(c) ((unsigned)(c) - 'A' < 26) +# define ASCII_ISALPHA(c) (ASCII_ISUPPER(c) || ASCII_ISLOWER(c)) +# define ASCII_ISALNUM(c) (ASCII_ISALPHA(c) || VIM_ISDIGIT(c)) +#endif + +// Returns empty string if it is NULL. +#define EMPTY_IF_NULL(x) ((x) ? (x) : (char_u *)"") + +#ifdef FEAT_LANGMAP +/* + * Adjust chars in a language according to 'langmap' option. + * NOTE that there is no noticeable overhead if 'langmap' is not set. + * When set the overhead for characters < 256 is small. + * Don't apply 'langmap' if the character comes from the Stuff buffer or from + * a mapping and the langnoremap option was set. + * The do-while is just to ignore a ';' after the macro. + */ +# define LANGMAP_ADJUST(c, condition) \ + do { \ + if (*p_langmap \ + && (condition) \ + && (p_lrm || (!p_lrm && KeyTyped)) \ + && !KeyStuffed \ + && (c) >= 0) \ + { \ + if ((c) < 256) \ + c = langmap_mapchar[c]; \ + else \ + c = langmap_adjust_mb(c); \ + } \ + } while (0) +#else +# define LANGMAP_ADJUST(c, condition) // nop +#endif + +/* + * VIM_ISBREAK() is used very often if 'linebreak' is set, use a macro to make + * it work fast. Only works for single byte characters! + */ +#define VIM_ISBREAK(c) ((c) < 256 && breakat_flags[(char_u)(c)]) + +/* + * On VMS file names are different and require a translation. + * On the Mac open() has only two arguments. + */ +#ifdef VMS +# define mch_access(n, p) access(vms_fixfilename(n), (p)) + // see mch_open() comment +# define mch_fopen(n, p) fopen(vms_fixfilename(n), (p)) +# define mch_fstat(n, p) fstat((n), (p)) +# undef HAVE_LSTAT // VMS does not have lstat() +# define mch_stat(n, p) stat(vms_fixfilename(n), (p)) +#else +# ifndef MSWIN +# define mch_access(n, p) access((n), (p)) +# endif + +// Use 64-bit fstat function if available. +// NOTE: This condition is the same as for the stat_T type. +# if (defined(_MSC_VER) && (_MSC_VER >= 1300)) || defined(__MINGW32__) +# define mch_fstat(n, p) _fstat64((n), (p)) +# else +# define mch_fstat(n, p) fstat((n), (p)) +# endif + +# ifdef MSWIN // has its own mch_stat() function +# define mch_stat(n, p) vim_stat((n), (p)) +# else +# ifdef STAT_IGNORES_SLASH +# define mch_stat(n, p) vim_stat((n), (p)) +# else +# define mch_stat(n, p) stat((n), (p)) +# endif +# endif +#endif + +#ifdef HAVE_LSTAT +# define mch_lstat(n, p) lstat((n), (p)) +#else +# define mch_lstat(n, p) mch_stat((n), (p)) +#endif + +#ifdef VMS +/* + * It is possible to force some record format with: + * # define mch_open(n, m, p) open(vms_fixfilename(n), (m), (p)), "rat=cr", "rfm=stmlf", "mrs=0") + * but it is not recommended, because it can destroy indexes etc. + */ +# define mch_open(n, m, p) open(vms_fixfilename(n), (m), (p)) +#endif + +// mch_open_rw(): invoke mch_open() with third argument for user R/W. +#if defined(UNIX) || defined(VMS) // open in rw------- mode +# define mch_open_rw(n, f) mch_open((n), (f), (mode_t)0600) +#else +# if defined(MSWIN) // open read/write +# define mch_open_rw(n, f) mch_open((n), (f), S_IREAD | S_IWRITE) +# else +# define mch_open_rw(n, f) mch_open((n), (f), 0) +# endif +#endif + +#ifdef STARTUPTIME +# define TIME_MSG(s) do { if (time_fd != NULL) time_msg(s, NULL); } while (0) +#else +# define TIME_MSG(s) do { /**/ } while (0) +#endif + +#define REPLACE_NORMAL(s) (((s) & REPLACE_FLAG) && !((s) & VREPLACE_FLAG)) + +#ifdef FEAT_ARABIC +# define ARABIC_CHAR(ch) (((ch) & 0xFF00) == 0x0600) +# define UTF_COMPOSINGLIKE(p1, p2) utf_composinglike((p1), (p2)) +#else +# define UTF_COMPOSINGLIKE(p1, p2) utf_iscomposing(utf_ptr2char(p2)) +#endif + +#ifdef FEAT_RIGHTLEFT + // Whether to draw the vertical bar on the right side of the cell. +# define CURSOR_BAR_RIGHT (curwin->w_p_rl && (!(State & CMDLINE) || cmdmsg_rl)) +#endif + +/* + * MB_PTR_ADV(): advance a pointer to the next character, taking care of + * multi-byte characters if needed. + * MB_PTR_BACK(): backup a pointer to the previous character, taking care of + * multi-byte characters if needed. + * MB_COPY_CHAR(f, t): copy one char from "f" to "t" and advance the pointers. + * PTR2CHAR(): get character from pointer. + */ +// Advance multi-byte pointer, skip over composing chars. +#define MB_PTR_ADV(p) p += (*mb_ptr2len)(p) +// Advance multi-byte pointer, do not skip over composing chars. +#define MB_CPTR_ADV(p) p += enc_utf8 ? utf_ptr2len(p) : (*mb_ptr2len)(p) +// Backup multi-byte pointer. Only use with "p" > "s" ! +#define MB_PTR_BACK(s, p) p -= has_mbyte ? ((*mb_head_off)(s, p - 1) + 1) : 1 +// get length of multi-byte char, not including composing chars +#define MB_CPTR2LEN(p) (enc_utf8 ? utf_ptr2len(p) : (*mb_ptr2len)(p)) + +#define MB_COPY_CHAR(f, t) do { if (has_mbyte) mb_copy_char(&f, &t); else *t++ = *f++; } while (0) +#define MB_CHARLEN(p) (has_mbyte ? mb_charlen(p) : (int)STRLEN(p)) +#define MB_CHAR2LEN(c) (has_mbyte ? mb_char2len(c) : 1) +#define PTR2CHAR(p) (has_mbyte ? mb_ptr2char(p) : (int)*(p)) + +#ifdef FEAT_AUTOCHDIR +# define DO_AUTOCHDIR do { if (p_acd) do_autochdir(); } while (0) +#else +# define DO_AUTOCHDIR do { /**/ } while (0) +#endif + +#define RESET_BINDING(wp) do { (wp)->w_p_scb = FALSE; (wp)->w_p_crb = FALSE; \ + } while (0) + +#ifdef FEAT_DIFF +# define PLINES_NOFILL(x) plines_nofill(x) +#else +# define PLINES_NOFILL(x) plines(x) +#endif + +#if defined(FEAT_JOB_CHANNEL) || defined(FEAT_CLIENTSERVER) +# define MESSAGE_QUEUE +#endif + +#if defined(FEAT_EVAL) && defined(FEAT_FLOAT) +# include <float.h> +# if defined(HAVE_MATH_H) + // for isnan() and isinf() +# include <math.h> +# endif +# ifdef USING_FLOAT_STUFF +# ifdef MSWIN +# ifndef isnan +# define isnan(x) _isnan(x) + static __inline int isinf(double x) { return !_finite(x) && !_isnan(x); } +# endif +# else +# ifndef HAVE_ISNAN + static inline int isnan(double x) { return x != x; } +# endif +# ifndef HAVE_ISINF + static inline int isinf(double x) { return !isnan(x) && isnan(x - x); } +# endif +# endif +# if !defined(INFINITY) +# if defined(DBL_MAX) +# ifdef VMS +# define INFINITY DBL_MAX +# else +# define INFINITY (DBL_MAX+DBL_MAX) +# endif +# else +# define INFINITY (1.0 / 0.0) +# endif +# endif +# if !defined(NAN) +# define NAN (INFINITY-INFINITY) +# endif +# if !defined(DBL_EPSILON) +# define DBL_EPSILON 2.2204460492503131e-16 +# endif +# endif +#endif + +#ifdef FEAT_EVAL +# define FUNCARG(fp, j) ((char_u **)(fp->uf_args.ga_data))[j] +#endif + +/* + * In a hashtab item "hi_key" points to "di_key" in a dictitem. + * This avoids adding a pointer to the hashtab item. + * DI2HIKEY() converts a dictitem pointer to a hashitem key pointer. + * HIKEY2DI() converts a hashitem key pointer to a dictitem pointer. + * HI2DI() converts a hashitem pointer to a dictitem pointer. + */ +#define DI2HIKEY(di) ((di)->di_key) +#define HIKEY2DI(p) ((dictitem_T *)(p - offsetof(dictitem_T, di_key))) +#define HI2DI(hi) HIKEY2DI((hi)->hi_key) + +/* + * Flush control functions. + */ +#ifdef FEAT_GUI +# define mch_enable_flush() gui_enable_flush() +# define mch_disable_flush() gui_disable_flush() +#else +# define mch_enable_flush() +# define mch_disable_flush() +#endif + +/* + * Like vim_free(), and also set the pointer to NULL. + */ +#define VIM_CLEAR(p) \ + do { \ + if ((p) != NULL) { \ + vim_free(p); \ + (p) = NULL; \ + } \ + } while (0) + +// Whether a command index indicates a user command. +#define IS_USER_CMDIDX(idx) ((int)(idx) < 0) + +// Give an error in curwin is a popup window and evaluate to TRUE. +#ifdef FEAT_PROP_POPUP +# define WIN_IS_POPUP(wp) ((wp)->w_popup_flags != 0) +# define ERROR_IF_POPUP_WINDOW error_if_popup_window(FALSE) +# define ERROR_IF_ANY_POPUP_WINDOW error_if_popup_window(TRUE) +#else +# define WIN_IS_POPUP(wp) 0 +# define ERROR_IF_POPUP_WINDOW 0 +# define ERROR_IF_ANY_POPUP_WINDOW 0 +#endif +#if defined(FEAT_PROP_POPUP) && defined(FEAT_TERMINAL) +# define ERROR_IF_TERM_POPUP_WINDOW error_if_term_popup_window() +#else +# define ERROR_IF_TERM_POPUP_WINDOW 0 +#endif + + +#ifdef ABORT_ON_INTERNAL_ERROR +# define ESTACK_CHECK_DECLARATION int estack_len_before; +# define ESTACK_CHECK_SETUP estack_len_before = exestack.ga_len; +# define ESTACK_CHECK_NOW if (estack_len_before != exestack.ga_len) \ + siemsg("Exestack length expected: %d, actual: %d", estack_len_before, exestack.ga_len); +# define CHECK_CURBUF if (curwin != NULL && curwin->w_buffer != curbuf) \ + iemsg("curbuf != curwin->w_buffer") +#else +# define ESTACK_CHECK_DECLARATION +# define ESTACK_CHECK_SETUP +# define ESTACK_CHECK_NOW +# define CHECK_CURBUF +#endif + +// Inline the condition for performance. +#define CHECK_LIST_MATERIALIZE(l) if ((l)->lv_first == &range_list_item) range_list_materialize(l) + +// Inlined version of ga_grow(). Especially useful if "n" is a constant. +#define GA_GROW(gap, n) (((gap)->ga_maxlen - (gap)->ga_len < n) ? ga_grow_inner((gap), (n)) : OK) |