1 /* vi:set ts=8 sts=4 sw=4 noet: 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 /* 10 * macros.h: macro definitions for often used code 11 * 12 * Macros should be ALL_CAPS. An exception is for where a function is 13 * replaced and an argument is not used more than once. 14 */ 15 16 /* 17 * PBYTE(lp, c) - put byte 'c' at position 'lp' 18 */ 19 #define PBYTE(lp, c) (*(ml_get_buf(curbuf, (lp).lnum, TRUE) + (lp).col) = (c)) 20 21 /* 22 * Position comparisons 23 */ 24 #define LT_POS(a, b) (((a).lnum != (b).lnum) \ 25 ? (a).lnum < (b).lnum \ 26 : (a).col != (b).col \ 27 ? (a).col < (b).col \ 28 : (a).coladd < (b).coladd) 29 #define LT_POSP(a, b) (((a)->lnum != (b)->lnum) \ 30 ? (a)->lnum < (b)->lnum \ 31 : (a)->col != (b)->col \ 32 ? (a)->col < (b)->col \ 33 : (a)->coladd < (b)->coladd) 34 #define EQUAL_POS(a, b) (((a).lnum == (b).lnum) && ((a).col == (b).col) && ((a).coladd == (b).coladd)) 35 #define CLEAR_POS(a) {(a)->lnum = 0; (a)->col = 0; (a)->coladd = 0;} 36 37 #define LTOREQ_POS(a, b) (LT_POS(a, b) || EQUAL_POS(a, b)) 38 39 /* 40 * VIM_ISWHITE() is used for "^" and the like. It differs from isspace() 41 * because it doesn't include <CR> and <LF> and the like. 42 */ 43 #define VIM_ISWHITE(x) ((x) == ' ' || (x) == '\t') 44 45 /* 46 * LINEEMPTY() - return TRUE if the line is empty 47 */ 48 #define LINEEMPTY(p) (*ml_get(p) == NUL) 49 50 /* 51 * BUFEMPTY() - return TRUE if the current buffer is empty 52 */ 53 #define BUFEMPTY() (curbuf->b_ml.ml_line_count == 1 && *ml_get((linenr_T)1) == NUL) 54 55 /* 56 * toupper() and tolower() that use the current locale. 57 * On some systems toupper()/tolower() only work on lower/uppercase 58 * characters, first use islower() or isupper() then. 59 * Careful: Only call TOUPPER_LOC() and TOLOWER_LOC() with a character in the 60 * range 0 - 255. toupper()/tolower() on some systems can't handle others. 61 * Note: It is often better to use MB_TOLOWER() and MB_TOUPPER(), because many 62 * toupper() and tolower() implementations only work for ASCII. 63 */ 64 #ifdef MSWIN 65 # define TOUPPER_LOC(c) toupper_tab[(c) & 255] 66 # define TOLOWER_LOC(c) tolower_tab[(c) & 255] 67 #else 68 # ifdef BROKEN_TOUPPER 69 # define TOUPPER_LOC(c) (islower(c) ? toupper(c) : (c)) 70 # define TOLOWER_LOC(c) (isupper(c) ? tolower(c) : (c)) 71 # else 72 # define TOUPPER_LOC toupper 73 # define TOLOWER_LOC tolower 74 # endif 75 #endif 76 77 /* toupper() and tolower() for ASCII only and ignore the current locale. */ 78 #ifdef EBCDIC 79 # define TOUPPER_ASC(c) (islower(c) ? toupper(c) : (c)) 80 # define TOLOWER_ASC(c) (isupper(c) ? tolower(c) : (c)) 81 #else 82 # define TOUPPER_ASC(c) (((c) < 'a' || (c) > 'z') ? (c) : (c) - ('a' - 'A')) 83 # define TOLOWER_ASC(c) (((c) < 'A' || (c) > 'Z') ? (c) : (c) + ('a' - 'A')) 84 #endif 85 86 /* 87 * MB_ISLOWER() and MB_ISUPPER() are to be used on multi-byte characters. But 88 * don't use them for negative values! 89 */ 90 #define MB_ISLOWER(c) vim_islower(c) 91 #define MB_ISUPPER(c) vim_isupper(c) 92 #define MB_TOLOWER(c) vim_tolower(c) 93 #define MB_TOUPPER(c) vim_toupper(c) 94 95 /* Use our own isdigit() replacement, because on MS-Windows isdigit() returns 96 * non-zero for superscript 1. Also avoids that isdigit() crashes for numbers 97 * below 0 and above 255. */ 98 #define VIM_ISDIGIT(c) ((unsigned)(c) - '0' < 10) 99 100 /* Like isalpha() but reject non-ASCII characters. Can't be used with a 101 * special key (negative value). */ 102 #ifdef EBCDIC 103 # define ASCII_ISALPHA(c) isalpha(c) 104 # define ASCII_ISALNUM(c) isalnum(c) 105 # define ASCII_ISLOWER(c) islower(c) 106 # define ASCII_ISUPPER(c) isupper(c) 107 #else 108 # define ASCII_ISLOWER(c) ((unsigned)(c) - 'a' < 26) 109 # define ASCII_ISUPPER(c) ((unsigned)(c) - 'A' < 26) 110 # define ASCII_ISALPHA(c) (ASCII_ISUPPER(c) || ASCII_ISLOWER(c)) 111 # define ASCII_ISALNUM(c) (ASCII_ISALPHA(c) || VIM_ISDIGIT(c)) 112 #endif 113 114 /* Returns empty string if it is NULL. */ 115 #define EMPTY_IF_NULL(x) ((x) ? (x) : (char_u *)"") 116 117 #ifdef FEAT_LANGMAP 118 /* 119 * Adjust chars in a language according to 'langmap' option. 120 * NOTE that there is no noticeable overhead if 'langmap' is not set. 121 * When set the overhead for characters < 256 is small. 122 * Don't apply 'langmap' if the character comes from the Stuff buffer or from 123 * a mapping and the langnoremap option was set. 124 * The do-while is just to ignore a ';' after the macro. 125 */ 126 # define LANGMAP_ADJUST(c, condition) \ 127 do { \ 128 if (*p_langmap \ 129 && (condition) \ 130 && (p_lrm || (!p_lrm && KeyTyped)) \ 131 && !KeyStuffed \ 132 && (c) >= 0) \ 133 { \ 134 if ((c) < 256) \ 135 c = langmap_mapchar[c]; \ 136 else \ 137 c = langmap_adjust_mb(c); \ 138 } \ 139 } while (0) 140 #else 141 # define LANGMAP_ADJUST(c, condition) /* nop */ 142 #endif 143 144 /* 145 * VIM_ISBREAK() is used very often if 'linebreak' is set, use a macro to make 146 * it work fast. Only works for single byte characters! 147 */ 148 #define VIM_ISBREAK(c) ((c) < 256 && breakat_flags[(char_u)(c)]) 149 150 /* 151 * On VMS file names are different and require a translation. 152 * On the Mac open() has only two arguments. 153 */ 154 #ifdef VMS 155 # define mch_access(n, p) access(vms_fixfilename(n), (p)) 156 /* see mch_open() comment */ 157 # define mch_fopen(n, p) fopen(vms_fixfilename(n), (p)) 158 # define mch_fstat(n, p) fstat(vms_fixfilename(n), (p)) 159 /* VMS does not have lstat() */ 160 # define mch_stat(n, p) stat(vms_fixfilename(n), (p)) 161 # define mch_rmdir(n) rmdir(vms_fixfilename(n)) 162 #else 163 # ifndef WIN32 164 # define mch_access(n, p) access((n), (p)) 165 # endif 166 # define mch_fstat(n, p) fstat((n), (p)) 167 # ifdef MSWIN /* has its own mch_stat() function */ 168 # define mch_stat(n, p) vim_stat((n), (p)) 169 # else 170 # ifdef STAT_IGNORES_SLASH 171 # define mch_stat(n, p) vim_stat((n), (p)) 172 # else 173 # define mch_stat(n, p) stat((n), (p)) 174 # endif 175 # endif 176 #endif 177 178 #ifdef HAVE_LSTAT 179 # define mch_lstat(n, p) lstat((n), (p)) 180 #else 181 # define mch_lstat(n, p) mch_stat((n), (p)) 182 #endif 183 184 #ifdef VMS 185 /* 186 * It is possible to force some record format with: 187 * # define mch_open(n, m, p) open(vms_fixfilename(n), (m), (p)), "rat=cr", "rfm=stmlf", "mrs=0") 188 * but it is not recommended, because it can destroy indexes etc. 189 */ 190 # define mch_open(n, m, p) open(vms_fixfilename(n), (m), (p)) 191 #endif 192 193 /* mch_open_rw(): invoke mch_open() with third argument for user R/W. */ 194 #if defined(UNIX) || defined(VMS) /* open in rw------- mode */ 195 # define mch_open_rw(n, f) mch_open((n), (f), (mode_t)0600) 196 #else 197 # if defined(MSWIN) /* open read/write */ 198 # define mch_open_rw(n, f) mch_open((n), (f), S_IREAD | S_IWRITE) 199 # else 200 # define mch_open_rw(n, f) mch_open((n), (f), 0) 201 # endif 202 #endif 203 204 #ifdef STARTUPTIME 205 # define TIME_MSG(s) do { if (time_fd != NULL) time_msg(s, NULL); } while (0) 206 #else 207 # define TIME_MSG(s) do { /**/ } while (0) 208 #endif 209 210 #define REPLACE_NORMAL(s) (((s) & REPLACE_FLAG) && !((s) & VREPLACE_FLAG)) 211 212 #ifdef FEAT_ARABIC 213 # define UTF_COMPOSINGLIKE(p1, p2) utf_composinglike((p1), (p2)) 214 #else 215 # define UTF_COMPOSINGLIKE(p1, p2) utf_iscomposing(utf_ptr2char(p2)) 216 #endif 217 218 #ifdef FEAT_RIGHTLEFT 219 /* Whether to draw the vertical bar on the right side of the cell. */ 220 # define CURSOR_BAR_RIGHT (curwin->w_p_rl && (!(State & CMDLINE) || cmdmsg_rl)) 221 #endif 222 223 /* 224 * MB_PTR_ADV(): advance a pointer to the next character, taking care of 225 * multi-byte characters if needed. 226 * MB_PTR_BACK(): backup a pointer to the previous character, taking care of 227 * multi-byte characters if needed. 228 * MB_COPY_CHAR(f, t): copy one char from "f" to "t" and advance the pointers. 229 * PTR2CHAR(): get character from pointer. 230 */ 231 /* Get the length of the character p points to, including composing chars */ 232 #define MB_PTR2LEN(p) (has_mbyte ? (*mb_ptr2len)(p) : 1) 233 /* Advance multi-byte pointer, skip over composing chars. */ 234 #define MB_PTR_ADV(p) p += has_mbyte ? (*mb_ptr2len)(p) : 1 235 /* Advance multi-byte pointer, do not skip over composing chars. */ 236 #define MB_CPTR_ADV(p) p += enc_utf8 ? utf_ptr2len(p) : has_mbyte ? (*mb_ptr2len)(p) : 1 237 /* Backup multi-byte pointer. Only use with "p" > "s" ! */ 238 #define MB_PTR_BACK(s, p) p -= has_mbyte ? ((*mb_head_off)(s, p - 1) + 1) : 1 239 /* get length of multi-byte char, not including composing chars */ 240 #define MB_CPTR2LEN(p) (enc_utf8 ? utf_ptr2len(p) : (*mb_ptr2len)(p)) 241 242 #define MB_COPY_CHAR(f, t) if (has_mbyte) mb_copy_char(&f, &t); else *t++ = *f++ 243 #define MB_CHARLEN(p) (has_mbyte ? mb_charlen(p) : (int)STRLEN(p)) 244 #define MB_CHAR2LEN(c) (has_mbyte ? mb_char2len(c) : 1) 245 #define PTR2CHAR(p) (has_mbyte ? mb_ptr2char(p) : (int)*(p)) 246 247 #ifdef FEAT_AUTOCHDIR 248 # define DO_AUTOCHDIR do { if (p_acd) do_autochdir(); } while (0) 249 #else 250 # define DO_AUTOCHDIR do { /**/ } while (0) 251 #endif 252 253 #define RESET_BINDING(wp) (wp)->w_p_scb = FALSE; (wp)->w_p_crb = FALSE 254 255 #ifdef FEAT_DIFF 256 # define PLINES_NOFILL(x) plines_nofill(x) 257 #else 258 # define PLINES_NOFILL(x) plines(x) 259 #endif 260 261 #if defined(FEAT_JOB_CHANNEL) || defined(FEAT_CLIENTSERVER) 262 # define MESSAGE_QUEUE 263 #endif 264 265 #if defined(FEAT_EVAL) && defined(FEAT_FLOAT) 266 # include <float.h> 267 # if defined(HAVE_MATH_H) 268 /* for isnan() and isinf() */ 269 # include <math.h> 270 # endif 271 # ifdef USING_FLOAT_STUFF 272 # if defined(WIN32) 273 # ifndef isnan 274 # define isnan(x) _isnan(x) 275 static __inline int isinf(double x) { return !_finite(x) && !_isnan(x); } 276 # endif 277 # else 278 # ifndef HAVE_ISNAN 279 static inline int isnan(double x) { return x != x; } 280 # endif 281 # ifndef HAVE_ISINF 282 static inline int isinf(double x) { return !isnan(x) && isnan(x - x); } 283 # endif 284 # endif 285 # if !defined(INFINITY) 286 # if defined(DBL_MAX) 287 # ifdef VMS 288 # define INFINITY DBL_MAX 289 # else 290 # define INFINITY (DBL_MAX+DBL_MAX) 291 # endif 292 # else 293 # define INFINITY (1.0 / 0.0) 294 # endif 295 # endif 296 # if !defined(NAN) 297 # define NAN (INFINITY-INFINITY) 298 # endif 299 # if !defined(DBL_EPSILON) 300 # define DBL_EPSILON 2.2204460492503131e-16 301 # endif 302 # endif 303 #endif 304 305 /* 306 * In a hashtab item "hi_key" points to "di_key" in a dictitem. 307 * This avoids adding a pointer to the hashtab item. 308 * DI2HIKEY() converts a dictitem pointer to a hashitem key pointer. 309 * HIKEY2DI() converts a hashitem key pointer to a dictitem pointer. 310 * HI2DI() converts a hashitem pointer to a dictitem pointer. 311 */ 312 #define DI2HIKEY(di) ((di)->di_key) 313 #define HIKEY2DI(p) ((dictitem_T *)(p - offsetof(dictitem_T, di_key))) 314 #define HI2DI(hi) HIKEY2DI((hi)->hi_key) 315 316 /* 317 * Flush control functions. 318 */ 319 #ifdef FEAT_GUI 320 # define mch_enable_flush() gui_enable_flush() 321 # define mch_disable_flush() gui_disable_flush() 322 #else 323 # define mch_enable_flush() 324 # define mch_disable_flush() 325 #endif 326 327 /* 328 * Like vim_free(), and also set the pointer to NULL. 329 */ 330 #define VIM_CLEAR(p) \ 331 do { \ 332 if ((p) != NULL) { \ 333 vim_free(p); \ 334 (p) = NULL; \ 335 } \ 336 } while (0) 337