| 1 | /* Interface definitions for display code. |
| 2 | |
| 3 | Copyright (C) 1985, 1993-1994, 1997-2013 Free Software Foundation, Inc. |
| 4 | |
| 5 | This file is part of GNU Emacs. |
| 6 | |
| 7 | GNU Emacs is free software: you can redistribute it and/or modify |
| 8 | it under the terms of the GNU General Public License as published by |
| 9 | the Free Software Foundation, either version 3 of the License, or |
| 10 | (at your option) any later version. |
| 11 | |
| 12 | GNU Emacs is distributed in the hope that it will be useful, |
| 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 15 | GNU General Public License for more details. |
| 16 | |
| 17 | You should have received a copy of the GNU General Public License |
| 18 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
| 19 | |
| 20 | /* New redisplay written by Gerd Moellmann <gerd@gnu.org>. */ |
| 21 | |
| 22 | #ifndef DISPEXTERN_H_INCLUDED |
| 23 | #define DISPEXTERN_H_INCLUDED |
| 24 | |
| 25 | #include "character.h" |
| 26 | |
| 27 | #ifdef HAVE_X_WINDOWS |
| 28 | |
| 29 | #include <X11/Xlib.h> |
| 30 | #ifdef USE_X_TOOLKIT |
| 31 | #include <X11/Intrinsic.h> |
| 32 | #endif /* USE_X_TOOLKIT */ |
| 33 | |
| 34 | #else /* !HAVE_X_WINDOWS */ |
| 35 | |
| 36 | /* X-related stuff used by non-X gui code. */ |
| 37 | |
| 38 | typedef struct { |
| 39 | unsigned long pixel; |
| 40 | unsigned short red, green, blue; |
| 41 | char flags; |
| 42 | char pad; |
| 43 | } XColor; |
| 44 | |
| 45 | #endif /* HAVE_X_WINDOWS */ |
| 46 | |
| 47 | #ifdef MSDOS |
| 48 | #include "msdos.h" |
| 49 | #endif |
| 50 | |
| 51 | INLINE_HEADER_BEGIN |
| 52 | |
| 53 | #include <c-strcase.h> |
| 54 | INLINE int |
| 55 | xstrcasecmp (char const *a, char const *b) |
| 56 | { |
| 57 | return c_strcasecmp (a, b); |
| 58 | } |
| 59 | |
| 60 | #ifdef HAVE_X_WINDOWS |
| 61 | #include <X11/Xresource.h> /* for XrmDatabase */ |
| 62 | typedef struct x_display_info Display_Info; |
| 63 | typedef XImage * XImagePtr; |
| 64 | typedef XImagePtr XImagePtr_or_DC; |
| 65 | #define NativeRectangle XRectangle |
| 66 | #endif |
| 67 | |
| 68 | #ifdef HAVE_NTGUI |
| 69 | #include "w32gui.h" |
| 70 | typedef struct w32_display_info Display_Info; |
| 71 | typedef XImage *XImagePtr; |
| 72 | typedef HDC XImagePtr_or_DC; |
| 73 | #endif |
| 74 | |
| 75 | #ifdef HAVE_NS |
| 76 | #include "nsgui.h" |
| 77 | /* Following typedef needed to accommodate the MSDOS port, believe it or not. */ |
| 78 | typedef struct ns_display_info Display_Info; |
| 79 | typedef Pixmap XImagePtr; |
| 80 | typedef XImagePtr XImagePtr_or_DC; |
| 81 | #endif |
| 82 | |
| 83 | #ifdef HAVE_WINDOW_SYSTEM |
| 84 | # include <time.h> |
| 85 | #endif |
| 86 | |
| 87 | #ifndef HAVE_WINDOW_SYSTEM |
| 88 | typedef int Cursor; |
| 89 | #define No_Cursor (0) |
| 90 | #endif |
| 91 | |
| 92 | #ifndef NativeRectangle |
| 93 | #define NativeRectangle int |
| 94 | #endif |
| 95 | |
| 96 | /* Text cursor types. */ |
| 97 | |
| 98 | enum text_cursor_kinds |
| 99 | { |
| 100 | DEFAULT_CURSOR = -2, |
| 101 | NO_CURSOR = -1, |
| 102 | FILLED_BOX_CURSOR, |
| 103 | HOLLOW_BOX_CURSOR, |
| 104 | BAR_CURSOR, |
| 105 | HBAR_CURSOR |
| 106 | }; |
| 107 | |
| 108 | /* Values returned from coordinates_in_window. */ |
| 109 | |
| 110 | enum window_part |
| 111 | { |
| 112 | ON_NOTHING, |
| 113 | ON_TEXT, |
| 114 | ON_MODE_LINE, |
| 115 | ON_VERTICAL_BORDER, |
| 116 | ON_HEADER_LINE, |
| 117 | ON_LEFT_FRINGE, |
| 118 | ON_RIGHT_FRINGE, |
| 119 | ON_LEFT_MARGIN, |
| 120 | ON_RIGHT_MARGIN, |
| 121 | ON_SCROLL_BAR |
| 122 | }; |
| 123 | |
| 124 | /* Number of bits allocated to store fringe bitmap numbers. */ |
| 125 | #define FRINGE_ID_BITS 16 |
| 126 | |
| 127 | /* Number of bits allocated to store fringe bitmap height. */ |
| 128 | #define FRINGE_HEIGHT_BITS 8 |
| 129 | |
| 130 | \f |
| 131 | /*********************************************************************** |
| 132 | Debugging |
| 133 | ***********************************************************************/ |
| 134 | |
| 135 | /* If GLYPH_DEBUG is defined, additional checks are activated. */ |
| 136 | |
| 137 | /* Macros to include code only if GLYPH_DEBUG is defined. */ |
| 138 | |
| 139 | #ifdef GLYPH_DEBUG |
| 140 | #define IF_DEBUG(X) X |
| 141 | #else |
| 142 | #define IF_DEBUG(X) (void) 0 |
| 143 | #endif |
| 144 | |
| 145 | /* Macro for displaying traces of redisplay. If Emacs was compiled |
| 146 | with GLYPH_DEBUG defined, the variable trace_redisplay_p can be set to |
| 147 | a non-zero value in debugging sessions to activate traces. */ |
| 148 | |
| 149 | #ifdef GLYPH_DEBUG |
| 150 | |
| 151 | extern int trace_redisplay_p EXTERNALLY_VISIBLE; |
| 152 | #include <stdio.h> |
| 153 | |
| 154 | #define TRACE(X) \ |
| 155 | if (trace_redisplay_p) \ |
| 156 | fprintf X; \ |
| 157 | else \ |
| 158 | (void) 0 |
| 159 | |
| 160 | #else /* not GLYPH_DEBUG */ |
| 161 | |
| 162 | #define TRACE(X) (void) 0 |
| 163 | |
| 164 | #endif /* GLYPH_DEBUG */ |
| 165 | |
| 166 | |
| 167 | \f |
| 168 | /*********************************************************************** |
| 169 | Text positions |
| 170 | ***********************************************************************/ |
| 171 | |
| 172 | /* Starting with Emacs 20.3, characters from strings and buffers have |
| 173 | both a character and a byte position associated with them. The |
| 174 | following structure holds such a pair of positions. */ |
| 175 | |
| 176 | struct text_pos |
| 177 | { |
| 178 | /* Character position. */ |
| 179 | ptrdiff_t charpos; |
| 180 | |
| 181 | /* Corresponding byte position. */ |
| 182 | ptrdiff_t bytepos; |
| 183 | }; |
| 184 | |
| 185 | /* Access character and byte position of POS in a functional form. */ |
| 186 | |
| 187 | #define BYTEPOS(POS) (POS).bytepos |
| 188 | #define CHARPOS(POS) (POS).charpos |
| 189 | |
| 190 | /* Set character position of POS to CHARPOS, byte position to BYTEPOS. */ |
| 191 | |
| 192 | #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \ |
| 193 | ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS) |
| 194 | |
| 195 | /* Increment text position POS. */ |
| 196 | |
| 197 | #define INC_TEXT_POS(POS, MULTIBYTE_P) \ |
| 198 | do \ |
| 199 | { \ |
| 200 | ++(POS).charpos; \ |
| 201 | if (MULTIBYTE_P) \ |
| 202 | INC_POS ((POS).bytepos); \ |
| 203 | else \ |
| 204 | ++(POS).bytepos; \ |
| 205 | } \ |
| 206 | while (0) |
| 207 | |
| 208 | /* Decrement text position POS. */ |
| 209 | |
| 210 | #define DEC_TEXT_POS(POS, MULTIBYTE_P) \ |
| 211 | do \ |
| 212 | { \ |
| 213 | --(POS).charpos; \ |
| 214 | if (MULTIBYTE_P) \ |
| 215 | DEC_POS ((POS).bytepos); \ |
| 216 | else \ |
| 217 | --(POS).bytepos; \ |
| 218 | } \ |
| 219 | while (0) |
| 220 | |
| 221 | /* Set text position POS from marker MARKER. */ |
| 222 | |
| 223 | #define SET_TEXT_POS_FROM_MARKER(POS, MARKER) \ |
| 224 | (CHARPOS (POS) = marker_position (MARKER), \ |
| 225 | BYTEPOS (POS) = marker_byte_position (MARKER)) |
| 226 | |
| 227 | /* Like above, but clip POS within accessible range. */ |
| 228 | |
| 229 | #define CLIP_TEXT_POS_FROM_MARKER(POS, MARKER) \ |
| 230 | (CHARPOS (POS) = clip_to_bounds \ |
| 231 | (BEGV, marker_position (MARKER), ZV), \ |
| 232 | BYTEPOS (POS) = clip_to_bounds \ |
| 233 | (BEGV_BYTE, marker_byte_position (MARKER), ZV_BYTE)) |
| 234 | |
| 235 | /* Set marker MARKER from text position POS. */ |
| 236 | |
| 237 | #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \ |
| 238 | set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS))) |
| 239 | |
| 240 | /* Value is non-zero if character and byte positions of POS1 and POS2 |
| 241 | are equal. */ |
| 242 | |
| 243 | #define TEXT_POS_EQUAL_P(POS1, POS2) \ |
| 244 | ((POS1).charpos == (POS2).charpos \ |
| 245 | && (POS1).bytepos == (POS2).bytepos) |
| 246 | |
| 247 | /* When rendering glyphs, redisplay scans string or buffer text, |
| 248 | overlay strings in that text, and does display table or control |
| 249 | character translations. The following structure captures a |
| 250 | position taking all this into account. */ |
| 251 | |
| 252 | struct display_pos |
| 253 | { |
| 254 | /* Buffer or string position. */ |
| 255 | struct text_pos pos; |
| 256 | |
| 257 | /* If this is a position in an overlay string, overlay_string_index |
| 258 | is the index of that overlay string in the sequence of overlay |
| 259 | strings at `pos' in the order redisplay processes them. A value |
| 260 | < 0 means that this is not a position in an overlay string. */ |
| 261 | ptrdiff_t overlay_string_index; |
| 262 | |
| 263 | /* If this is a position in an overlay string, string_pos is the |
| 264 | position within that string. */ |
| 265 | struct text_pos string_pos; |
| 266 | |
| 267 | /* If the character at the position above is a control character or |
| 268 | has a display table entry, dpvec_index is an index in the display |
| 269 | table or control character translation of that character. A |
| 270 | value < 0 means this is not a position in such a translation. */ |
| 271 | int dpvec_index; |
| 272 | }; |
| 273 | |
| 274 | |
| 275 | \f |
| 276 | /*********************************************************************** |
| 277 | Glyphs |
| 278 | ***********************************************************************/ |
| 279 | |
| 280 | /* The glyph datatype, used to represent characters on the display. |
| 281 | It consists of a char code and a face id. */ |
| 282 | |
| 283 | typedef struct { |
| 284 | int ch; |
| 285 | int face_id; |
| 286 | } GLYPH; |
| 287 | |
| 288 | /* Return a glyph's character code. */ |
| 289 | INLINE int GLYPH_CHAR (GLYPH glyph) { return glyph.ch; } |
| 290 | |
| 291 | /* Return a glyph's face ID. */ |
| 292 | INLINE int GLYPH_FACE (GLYPH glyph) { return glyph.face_id; } |
| 293 | |
| 294 | #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char)) |
| 295 | #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face)) |
| 296 | #define SET_GLYPH(glyph, char, face) \ |
| 297 | ((glyph).ch = (char), (glyph).face_id = (face)) |
| 298 | |
| 299 | /* The following are valid only if GLYPH_CODE_P (gc). */ |
| 300 | |
| 301 | INLINE int |
| 302 | GLYPH_CODE_CHAR (Lisp_Object gc) |
| 303 | { |
| 304 | return (CONSP (gc) |
| 305 | ? XINT (XCAR (gc)) |
| 306 | : XINT (gc) & MAX_CHAR); |
| 307 | } |
| 308 | |
| 309 | INLINE int |
| 310 | GLYPH_CODE_FACE (Lisp_Object gc) |
| 311 | { |
| 312 | return CONSP (gc) ? XINT (XCDR (gc)) : XINT (gc) >> CHARACTERBITS; |
| 313 | } |
| 314 | |
| 315 | #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \ |
| 316 | do \ |
| 317 | { \ |
| 318 | if (CONSP (gc)) \ |
| 319 | SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \ |
| 320 | else \ |
| 321 | SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \ |
| 322 | (XINT (gc) >> CHARACTERBITS)); \ |
| 323 | } \ |
| 324 | while (0) |
| 325 | |
| 326 | /* The ID of the mode line highlighting face. */ |
| 327 | enum { GLYPH_MODE_LINE_FACE = 1 }; |
| 328 | |
| 329 | /* Enumeration of glyph types. Glyph structures contain a type field |
| 330 | containing one of the enumerators defined here. */ |
| 331 | |
| 332 | enum glyph_type |
| 333 | { |
| 334 | /* Glyph describes a character. */ |
| 335 | CHAR_GLYPH, |
| 336 | |
| 337 | /* Glyph describes a static composition. */ |
| 338 | COMPOSITE_GLYPH, |
| 339 | |
| 340 | /* Glyph describes a glyphless character. */ |
| 341 | GLYPHLESS_GLYPH, |
| 342 | |
| 343 | /* Glyph describes an image. */ |
| 344 | IMAGE_GLYPH, |
| 345 | |
| 346 | /* Glyph is a space of fractional width and/or height. */ |
| 347 | STRETCH_GLYPH |
| 348 | }; |
| 349 | |
| 350 | |
| 351 | /* Structure describing how to use partial glyphs (images slicing) */ |
| 352 | |
| 353 | struct glyph_slice |
| 354 | { |
| 355 | unsigned x : 16; |
| 356 | unsigned y : 16; |
| 357 | unsigned width : 16; |
| 358 | unsigned height : 16; |
| 359 | }; |
| 360 | |
| 361 | |
| 362 | /* Glyphs. |
| 363 | |
| 364 | Be extra careful when changing this structure! Esp. make sure that |
| 365 | functions producing glyphs, like append_glyph, fill ALL of the |
| 366 | glyph structure, and that GLYPH_EQUAL_P compares all |
| 367 | display-relevant members of glyphs (not to imply that these are the |
| 368 | only things to check when you add a member). */ |
| 369 | |
| 370 | struct glyph |
| 371 | { |
| 372 | /* Position from which this glyph was drawn. If `object' below is a |
| 373 | Lisp string, this is an index into that string. If it is a |
| 374 | buffer, this is a position in that buffer. In addition, some |
| 375 | special glyphs have special values for this: |
| 376 | |
| 377 | glyph standing for newline at end of line 0 |
| 378 | empty space after the end of the line -1 |
| 379 | overlay arrow on a TTY -1 |
| 380 | glyph at EOB that ends in a newline -1 |
| 381 | left truncation glyphs: -1 |
| 382 | right truncation/continuation glyphs next buffer position |
| 383 | glyph standing for newline of an empty line buffer position of newline |
| 384 | stretch glyph at left edge of R2L lines buffer position of newline */ |
| 385 | ptrdiff_t charpos; |
| 386 | |
| 387 | /* Lisp object source of this glyph. Currently either a buffer or a |
| 388 | string, if the glyph was produced from characters which came from |
| 389 | a buffer or a string; or Lisp integer zero (a.k.a. "null object") |
| 390 | if the glyph was inserted by redisplay for its own purposes, such |
| 391 | as padding or truncation/continuation glyphs, or the |
| 392 | overlay-arrow glyphs on TTYs. */ |
| 393 | Lisp_Object object; |
| 394 | |
| 395 | /* Width in pixels. */ |
| 396 | short pixel_width; |
| 397 | |
| 398 | /* Ascent and descent in pixels. */ |
| 399 | short ascent, descent; |
| 400 | |
| 401 | /* Vertical offset. If < 0, the glyph is displayed raised, if > 0 |
| 402 | the glyph is displayed lowered. */ |
| 403 | short voffset; |
| 404 | |
| 405 | /* Which kind of glyph this is---character, image etc. Value |
| 406 | should be an enumerator of type enum glyph_type. */ |
| 407 | unsigned type : 3; |
| 408 | |
| 409 | /* 1 means this glyph was produced from multibyte text. Zero |
| 410 | means it was produced from unibyte text, i.e. charsets aren't |
| 411 | applicable, and encoding is not performed. */ |
| 412 | unsigned multibyte_p : 1; |
| 413 | |
| 414 | /* Non-zero means draw a box line at the left or right side of this |
| 415 | glyph. This is part of the implementation of the face attribute |
| 416 | `:box'. */ |
| 417 | unsigned left_box_line_p : 1; |
| 418 | unsigned right_box_line_p : 1; |
| 419 | |
| 420 | /* Non-zero means this glyph's physical ascent or descent is greater |
| 421 | than its logical ascent/descent, i.e. it may potentially overlap |
| 422 | glyphs above or below it. */ |
| 423 | unsigned overlaps_vertically_p : 1; |
| 424 | |
| 425 | /* For terminal frames, 1 means glyph is a padding glyph. Padding |
| 426 | glyphs are used for characters whose visual shape consists of |
| 427 | more than one glyph (e.g. Asian characters). All but the first |
| 428 | glyph of such a glyph sequence have the padding_p flag set. This |
| 429 | flag is used only to minimize code changes. A better way would |
| 430 | probably be to use the width field of glyphs to express padding. |
| 431 | |
| 432 | For graphic frames, 1 means the pixel width of the glyph in a |
| 433 | font is 0, but 1-pixel is padded on displaying for correct cursor |
| 434 | displaying. The member `pixel_width' above is set to 1. */ |
| 435 | unsigned padding_p : 1; |
| 436 | |
| 437 | /* 1 means the actual glyph is not available, draw using `struct |
| 438 | glyphless' below instead. This can happen when a font couldn't |
| 439 | be loaded, or a character doesn't have a glyph in a font. */ |
| 440 | unsigned glyph_not_available_p : 1; |
| 441 | |
| 442 | /* Non-zero means don't display cursor here. */ |
| 443 | unsigned avoid_cursor_p : 1; |
| 444 | |
| 445 | /* Resolved bidirectional level of this character [0..63]. */ |
| 446 | unsigned resolved_level : 5; |
| 447 | |
| 448 | /* Resolved bidirectional type of this character, see enum |
| 449 | bidi_type_t below. Note that according to UAX#9, only some |
| 450 | values (STRONG_L, STRONG_R, WEAK_AN, WEAK_EN, WEAK_BN, and |
| 451 | NEUTRAL_B) can appear in the resolved type, so we only reserve |
| 452 | space for those that can. */ |
| 453 | unsigned bidi_type : 3; |
| 454 | |
| 455 | #define FACE_ID_BITS 20 |
| 456 | |
| 457 | /* Face of the glyph. This is a realized face ID, |
| 458 | an index in the face cache of the frame. */ |
| 459 | unsigned face_id : FACE_ID_BITS; |
| 460 | |
| 461 | /* Type of font used to display the character glyph. May be used to |
| 462 | determine which set of functions to use to obtain font metrics |
| 463 | for the glyph. On W32, value should be an enumerator of the type |
| 464 | w32_char_font_type. Otherwise it equals FONT_TYPE_UNKNOWN. */ |
| 465 | unsigned font_type : 3; |
| 466 | |
| 467 | /* A union of sub-structures for different glyph types. */ |
| 468 | union |
| 469 | { |
| 470 | /* Metrics of a partial glyph of an image (type == IMAGE_GLYPH). */ |
| 471 | struct glyph_slice img; |
| 472 | /* Start and end indices of glyphs of a grapheme cluster of a |
| 473 | composition (type == COMPOSITE_GLYPH). */ |
| 474 | struct { int from, to; } cmp; |
| 475 | /* Pixel offsets for upper and lower part of the acronym. */ |
| 476 | struct { |
| 477 | short upper_xoff, upper_yoff; |
| 478 | short lower_xoff, lower_yoff; |
| 479 | } glyphless; |
| 480 | } slice; |
| 481 | |
| 482 | /* A union of sub-structures for different glyph types. */ |
| 483 | union |
| 484 | { |
| 485 | /* Character code for character glyphs (type == CHAR_GLYPH). */ |
| 486 | unsigned ch; |
| 487 | |
| 488 | /* Sub-structures for type == COMPOSITE_GLYPH. */ |
| 489 | struct |
| 490 | { |
| 491 | /* Flag to tell if the composition is automatic or not. */ |
| 492 | unsigned automatic : 1; |
| 493 | /* ID of the composition. */ |
| 494 | unsigned id : 31; |
| 495 | } cmp; |
| 496 | |
| 497 | /* Image ID for image glyphs (type == IMAGE_GLYPH). */ |
| 498 | int img_id; |
| 499 | |
| 500 | /* Sub-structure for type == STRETCH_GLYPH. */ |
| 501 | struct |
| 502 | { |
| 503 | /* The height of the glyph. */ |
| 504 | unsigned height : 16; |
| 505 | |
| 506 | /* The ascent of the glyph. */ |
| 507 | unsigned ascent : 16; |
| 508 | } |
| 509 | stretch; |
| 510 | |
| 511 | /* Sub-stretch for type == GLYPHLESS_GLYPH. */ |
| 512 | struct |
| 513 | { |
| 514 | /* Value is an enum of the type glyphless_display_method. */ |
| 515 | unsigned method : 2; |
| 516 | /* 1 iff this glyph is for a character of no font. */ |
| 517 | unsigned for_no_font : 1; |
| 518 | /* Length of acronym or hexadecimal code string (at most 8). */ |
| 519 | unsigned len : 4; |
| 520 | /* Character to display. Actually we need only 22 bits. */ |
| 521 | unsigned ch : 25; |
| 522 | } glyphless; |
| 523 | |
| 524 | /* Used to compare all bit-fields above in one step. */ |
| 525 | unsigned val; |
| 526 | } u; |
| 527 | }; |
| 528 | |
| 529 | |
| 530 | /* Default value of the glyph font_type field. */ |
| 531 | |
| 532 | #define FONT_TYPE_UNKNOWN 0 |
| 533 | |
| 534 | /* Is GLYPH a space? */ |
| 535 | |
| 536 | #define CHAR_GLYPH_SPACE_P(GLYPH) \ |
| 537 | ((GLYPH).u.ch == SPACEGLYPH && (GLYPH).face_id == DEFAULT_FACE_ID) |
| 538 | |
| 539 | /* Are glyph slices of glyphs *X and *Y equal? It assumes that both |
| 540 | glyphs have the same type. |
| 541 | |
| 542 | Note: for composition glyphs, we don't have to compare slice.cmp.to |
| 543 | because they should be the same if and only if slice.cmp.from are |
| 544 | the same. */ |
| 545 | |
| 546 | #define GLYPH_SLICE_EQUAL_P(X, Y) \ |
| 547 | ((X)->type == IMAGE_GLYPH \ |
| 548 | ? ((X)->slice.img.x == (Y)->slice.img.x \ |
| 549 | && (X)->slice.img.y == (Y)->slice.img.y \ |
| 550 | && (X)->slice.img.width == (Y)->slice.img.width \ |
| 551 | && (X)->slice.img.height == (Y)->slice.img.height) \ |
| 552 | : ((X)->type != COMPOSITE_GLYPH \ |
| 553 | || (X)->slice.cmp.from == (Y)->slice.cmp.from)) |
| 554 | |
| 555 | /* Are glyphs *X and *Y displayed equal? */ |
| 556 | |
| 557 | #define GLYPH_EQUAL_P(X, Y) \ |
| 558 | ((X)->type == (Y)->type \ |
| 559 | && (X)->u.val == (Y)->u.val \ |
| 560 | && GLYPH_SLICE_EQUAL_P (X, Y) \ |
| 561 | && (X)->face_id == (Y)->face_id \ |
| 562 | && (X)->padding_p == (Y)->padding_p \ |
| 563 | && (X)->left_box_line_p == (Y)->left_box_line_p \ |
| 564 | && (X)->right_box_line_p == (Y)->right_box_line_p \ |
| 565 | && (X)->voffset == (Y)->voffset \ |
| 566 | && (X)->pixel_width == (Y)->pixel_width) |
| 567 | |
| 568 | /* Are character codes, faces, padding_ps of glyphs *X and *Y equal? */ |
| 569 | |
| 570 | #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y) \ |
| 571 | ((X)->u.ch == (Y)->u.ch \ |
| 572 | && (X)->face_id == (Y)->face_id \ |
| 573 | && (X)->padding_p == (Y)->padding_p) |
| 574 | |
| 575 | /* Fill a character glyph GLYPH. CODE, FACE_ID, PADDING_P correspond |
| 576 | to the bits defined for the typedef `GLYPH' in lisp.h. */ |
| 577 | |
| 578 | #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \ |
| 579 | do \ |
| 580 | { \ |
| 581 | (GLYPH).u.ch = (CODE); \ |
| 582 | (GLYPH).face_id = (FACE_ID); \ |
| 583 | (GLYPH).padding_p = (PADDING_P); \ |
| 584 | } \ |
| 585 | while (0) |
| 586 | |
| 587 | /* Fill a character type glyph GLYPH from a glyph typedef FROM as |
| 588 | defined in lisp.h. */ |
| 589 | |
| 590 | #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM) \ |
| 591 | SET_CHAR_GLYPH ((GLYPH), \ |
| 592 | GLYPH_CHAR ((FROM)), \ |
| 593 | GLYPH_FACE ((FROM)), \ |
| 594 | 0) |
| 595 | |
| 596 | /* Construct a glyph code from a character glyph GLYPH. If the |
| 597 | character is multibyte, return -1 as we can't use glyph table for a |
| 598 | multibyte character. */ |
| 599 | |
| 600 | #define SET_GLYPH_FROM_CHAR_GLYPH(G, GLYPH) \ |
| 601 | do \ |
| 602 | { \ |
| 603 | if ((GLYPH).u.ch < 256) \ |
| 604 | SET_GLYPH ((G), (GLYPH).u.ch, ((GLYPH).face_id)); \ |
| 605 | else \ |
| 606 | SET_GLYPH ((G), -1, 0); \ |
| 607 | } \ |
| 608 | while (0) |
| 609 | |
| 610 | #define GLYPH_INVALID_P(GLYPH) (GLYPH_CHAR (GLYPH) < 0) |
| 611 | |
| 612 | /* Is GLYPH a padding glyph? */ |
| 613 | |
| 614 | #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p |
| 615 | |
| 616 | |
| 617 | |
| 618 | \f |
| 619 | /*********************************************************************** |
| 620 | Glyph Pools |
| 621 | ***********************************************************************/ |
| 622 | |
| 623 | /* Glyph Pool. |
| 624 | |
| 625 | Glyph memory for frame-based redisplay is allocated from the heap |
| 626 | in one vector kept in a glyph pool structure which is stored with |
| 627 | the frame. The size of the vector is made large enough to cover |
| 628 | all windows on the frame. |
| 629 | |
| 630 | Both frame and window glyph matrices reference memory from a glyph |
| 631 | pool in frame-based redisplay. |
| 632 | |
| 633 | In window-based redisplay, no glyphs pools exist; windows allocate |
| 634 | and free their glyph memory themselves. */ |
| 635 | |
| 636 | struct glyph_pool |
| 637 | { |
| 638 | /* Vector of glyphs allocated from the heap. */ |
| 639 | struct glyph *glyphs; |
| 640 | |
| 641 | /* Allocated size of `glyphs'. */ |
| 642 | ptrdiff_t nglyphs; |
| 643 | |
| 644 | /* Number of rows and columns in a matrix. */ |
| 645 | int nrows, ncolumns; |
| 646 | }; |
| 647 | |
| 648 | |
| 649 | \f |
| 650 | /*********************************************************************** |
| 651 | Glyph Matrix |
| 652 | ***********************************************************************/ |
| 653 | |
| 654 | /* Glyph Matrix. |
| 655 | |
| 656 | Three kinds of glyph matrices exist: |
| 657 | |
| 658 | 1. Frame glyph matrices. These are used for terminal frames whose |
| 659 | redisplay needs a view of the whole screen due to limited terminal |
| 660 | capabilities. Frame matrices are used only in the update phase |
| 661 | of redisplay. They are built in update_frame and not used after |
| 662 | the update has been performed. |
| 663 | |
| 664 | 2. Window glyph matrices on frames having frame glyph matrices. |
| 665 | Such matrices are sub-matrices of their corresponding frame matrix, |
| 666 | i.e., frame glyph matrices and window glyph matrices share the same |
| 667 | glyph memory, which is allocated in the form of a glyph_pool structure. |
| 668 | Glyph rows in such a window matrix are slices of frame matrix rows. |
| 669 | |
| 670 | 2. Free-standing window glyph matrices managing their own glyph |
| 671 | storage. This form is used in window-based redisplay which |
| 672 | includes variable width and height fonts etc. |
| 673 | |
| 674 | The size of a window's row vector depends on the height of fonts |
| 675 | defined on its frame. It is chosen so that the vector is large |
| 676 | enough to describe all lines in a window when it is displayed in |
| 677 | the smallest possible character size. When new fonts are loaded, |
| 678 | or window sizes change, the row vector is adjusted accordingly. */ |
| 679 | |
| 680 | struct glyph_matrix |
| 681 | { |
| 682 | /* The pool from which glyph memory is allocated, if any. This is |
| 683 | null for frame matrices and for window matrices managing their |
| 684 | own storage. */ |
| 685 | struct glyph_pool *pool; |
| 686 | |
| 687 | /* Vector of glyph row structures. The row at nrows - 1 is reserved |
| 688 | for the mode line. */ |
| 689 | struct glyph_row *rows; |
| 690 | |
| 691 | /* Number of elements allocated for the vector rows above. */ |
| 692 | ptrdiff_t rows_allocated; |
| 693 | |
| 694 | /* The number of rows used by the window if all lines were displayed |
| 695 | with the smallest possible character height. */ |
| 696 | int nrows; |
| 697 | |
| 698 | /* Origin within the frame matrix if this is a window matrix on a |
| 699 | frame having a frame matrix. Both values are zero for |
| 700 | window-based redisplay. */ |
| 701 | int matrix_x, matrix_y; |
| 702 | |
| 703 | /* Width and height of the matrix in columns and rows. */ |
| 704 | int matrix_w, matrix_h; |
| 705 | |
| 706 | /* If this structure describes a window matrix of window W, |
| 707 | window_left_col is the value of W->left_col, window_top_line the |
| 708 | value of W->top_line, window_height and window_width are width and |
| 709 | height of W, as returned by window_box, and window_vscroll is the |
| 710 | value of W->vscroll at the time the matrix was last adjusted. |
| 711 | Only set for window-based redisplay. */ |
| 712 | int window_left_col, window_top_line; |
| 713 | int window_height, window_width; |
| 714 | int window_vscroll; |
| 715 | |
| 716 | /* Number of glyphs reserved for left and right marginal areas when |
| 717 | the matrix was last adjusted. */ |
| 718 | int left_margin_glyphs, right_margin_glyphs; |
| 719 | |
| 720 | /* Flag indicating that scrolling should not be tried in |
| 721 | update_window. This flag is set by functions like try_window_id |
| 722 | which do their own scrolling. */ |
| 723 | unsigned no_scrolling_p : 1; |
| 724 | |
| 725 | /* Non-zero means window displayed in this matrix has a top mode |
| 726 | line. */ |
| 727 | unsigned header_line_p : 1; |
| 728 | |
| 729 | #ifdef GLYPH_DEBUG |
| 730 | /* A string identifying the method used to display the matrix. */ |
| 731 | char method[512]; |
| 732 | #endif |
| 733 | |
| 734 | /* The buffer this matrix displays. Set in |
| 735 | mark_window_display_accurate_1. */ |
| 736 | struct buffer *buffer; |
| 737 | |
| 738 | /* Values of BEGV and ZV as of last redisplay. Set in |
| 739 | mark_window_display_accurate_1. */ |
| 740 | ptrdiff_t begv, zv; |
| 741 | }; |
| 742 | |
| 743 | |
| 744 | /* Check that glyph pointers stored in glyph rows of MATRIX are okay. |
| 745 | This aborts if any pointer is found twice. */ |
| 746 | |
| 747 | #ifdef GLYPH_DEBUG |
| 748 | void check_matrix_pointer_lossage (struct glyph_matrix *); |
| 749 | #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX)) |
| 750 | #else |
| 751 | #define CHECK_MATRIX(MATRIX) (void) 0 |
| 752 | #endif |
| 753 | |
| 754 | |
| 755 | \f |
| 756 | /*********************************************************************** |
| 757 | Glyph Rows |
| 758 | ***********************************************************************/ |
| 759 | |
| 760 | /* Area in window glyph matrix. If values are added or removed, |
| 761 | the function mark_glyph_matrix in alloc.c may need to be changed. */ |
| 762 | |
| 763 | enum glyph_row_area |
| 764 | { |
| 765 | ANY_AREA = -1, |
| 766 | LEFT_MARGIN_AREA, |
| 767 | TEXT_AREA, |
| 768 | RIGHT_MARGIN_AREA, |
| 769 | LAST_AREA |
| 770 | }; |
| 771 | |
| 772 | |
| 773 | /* Rows of glyphs in a windows or frame glyph matrix. |
| 774 | |
| 775 | Each row is partitioned into three areas. The start and end of |
| 776 | each area is recorded in a pointer as shown below. |
| 777 | |
| 778 | +--------------------+-------------+---------------------+ |
| 779 | | left margin area | text area | right margin area | |
| 780 | +--------------------+-------------+---------------------+ |
| 781 | | | | | |
| 782 | glyphs[LEFT_MARGIN_AREA] glyphs[RIGHT_MARGIN_AREA] |
| 783 | | | |
| 784 | glyphs[TEXT_AREA] | |
| 785 | glyphs[LAST_AREA] |
| 786 | |
| 787 | Rows in frame matrices reference glyph memory allocated in a frame |
| 788 | glyph pool (see the description of struct glyph_pool). Rows in |
| 789 | window matrices on frames having frame matrices reference slices of |
| 790 | the glyphs of corresponding rows in the frame matrix. |
| 791 | |
| 792 | Rows in window matrices on frames having no frame matrices point to |
| 793 | glyphs allocated from the heap via xmalloc; |
| 794 | glyphs[LEFT_MARGIN_AREA] is the start address of the allocated |
| 795 | glyph structure array. |
| 796 | |
| 797 | NOTE: layout of first four members of this structure is important, |
| 798 | see clear_glyph_row and copy_row_except_pointers to check why. */ |
| 799 | |
| 800 | struct glyph_row |
| 801 | { |
| 802 | /* Pointers to beginnings of areas. The end of an area A is found at |
| 803 | A + 1 in the vector. The last element of the vector is the end |
| 804 | of the whole row. |
| 805 | |
| 806 | Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s |
| 807 | position field is used. It is -1 if this row does not correspond |
| 808 | to any text; it is some buffer position if the row corresponds to |
| 809 | an empty display line that displays a line end. This is what old |
| 810 | redisplay used to do. (Except in code for terminal frames, this |
| 811 | kludge is no longer used, I believe. --gerd). |
| 812 | |
| 813 | See also start, end, displays_text_p and ends_at_zv_p for cleaner |
| 814 | ways to do it. The special meaning of positions 0 and -1 will be |
| 815 | removed some day, so don't use it in new code. */ |
| 816 | struct glyph *glyphs[1 + LAST_AREA]; |
| 817 | |
| 818 | /* Number of glyphs actually filled in areas. This could have size |
| 819 | LAST_AREA, but it's 1 + LAST_AREA to simplify offset calculations. */ |
| 820 | short used[1 + LAST_AREA]; |
| 821 | |
| 822 | /* Hash code. This hash code is available as soon as the row |
| 823 | is constructed, i.e. after a call to display_line. */ |
| 824 | unsigned hash; |
| 825 | |
| 826 | /* Window-relative x and y-position of the top-left corner of this |
| 827 | row. If y < 0, this means that eabs (y) pixels of the row are |
| 828 | invisible because it is partially visible at the top of a window. |
| 829 | If x < 0, this means that eabs (x) pixels of the first glyph of |
| 830 | the text area of the row are invisible because the glyph is |
| 831 | partially visible. */ |
| 832 | int x, y; |
| 833 | |
| 834 | /* Width of the row in pixels without taking face extension at the |
| 835 | end of the row into account, and without counting truncation |
| 836 | and continuation glyphs at the end of a row on ttys. */ |
| 837 | int pixel_width; |
| 838 | |
| 839 | /* Logical ascent/height of this line. The value of ascent is zero |
| 840 | and height is 1 on terminal frames. */ |
| 841 | int ascent, height; |
| 842 | |
| 843 | /* Physical ascent/height of this line. If max_ascent > ascent, |
| 844 | this line overlaps the line above it on the display. Otherwise, |
| 845 | if max_height > height, this line overlaps the line beneath it. */ |
| 846 | int phys_ascent, phys_height; |
| 847 | |
| 848 | /* Portion of row that is visible. Partially visible rows may be |
| 849 | found at the top and bottom of a window. This is 1 for tty |
| 850 | frames. It may be < 0 in case of completely invisible rows. */ |
| 851 | int visible_height; |
| 852 | |
| 853 | /* Extra line spacing added after this row. Do not consider this |
| 854 | in last row when checking if row is fully visible. */ |
| 855 | int extra_line_spacing; |
| 856 | |
| 857 | /* First position in this row. This is the text position, including |
| 858 | overlay position information etc, where the display of this row |
| 859 | started, and can thus be less than the position of the first |
| 860 | glyph (e.g. due to invisible text or horizontal scrolling). |
| 861 | BIDI Note: In R2L rows, that have its reversed_p flag set, this |
| 862 | position is at or beyond the right edge of the row. */ |
| 863 | struct display_pos start; |
| 864 | |
| 865 | /* Text position at the end of this row. This is the position after |
| 866 | the last glyph on this row. It can be greater than the last |
| 867 | glyph position + 1, due to a newline that ends the line, |
| 868 | truncation, invisible text etc. In an up-to-date display, this |
| 869 | should always be equal to the start position of the next row. |
| 870 | BIDI Note: In R2L rows, this position is at or beyond the left |
| 871 | edge of the row. */ |
| 872 | struct display_pos end; |
| 873 | |
| 874 | /* The smallest and the largest buffer positions that contributed to |
| 875 | glyphs in this row. Note that due to bidi reordering, these are |
| 876 | in general different from the text positions stored in `start' |
| 877 | and `end' members above, and also different from the buffer |
| 878 | positions recorded in the glyphs displayed the leftmost and |
| 879 | rightmost on the screen. */ |
| 880 | struct text_pos minpos, maxpos; |
| 881 | |
| 882 | /* Non-zero means the overlay arrow bitmap is on this line. |
| 883 | -1 means use default overlay arrow bitmap, else |
| 884 | it specifies actual fringe bitmap number. */ |
| 885 | int overlay_arrow_bitmap; |
| 886 | |
| 887 | /* Left fringe bitmap number (enum fringe_bitmap_type). */ |
| 888 | unsigned left_user_fringe_bitmap : FRINGE_ID_BITS; |
| 889 | |
| 890 | /* Right fringe bitmap number (enum fringe_bitmap_type). */ |
| 891 | unsigned right_user_fringe_bitmap : FRINGE_ID_BITS; |
| 892 | |
| 893 | /* Left fringe bitmap number (enum fringe_bitmap_type). */ |
| 894 | unsigned left_fringe_bitmap : FRINGE_ID_BITS; |
| 895 | |
| 896 | /* Right fringe bitmap number (enum fringe_bitmap_type). */ |
| 897 | unsigned right_fringe_bitmap : FRINGE_ID_BITS; |
| 898 | |
| 899 | /* Face of the left fringe glyph. */ |
| 900 | unsigned left_user_fringe_face_id : FACE_ID_BITS; |
| 901 | |
| 902 | /* Face of the right fringe glyph. */ |
| 903 | unsigned right_user_fringe_face_id : FACE_ID_BITS; |
| 904 | |
| 905 | /* Face of the left fringe glyph. */ |
| 906 | unsigned left_fringe_face_id : FACE_ID_BITS; |
| 907 | |
| 908 | /* Face of the right fringe glyph. */ |
| 909 | unsigned right_fringe_face_id : FACE_ID_BITS; |
| 910 | |
| 911 | /* Vertical offset of the left fringe bitmap. */ |
| 912 | signed left_fringe_offset : FRINGE_HEIGHT_BITS; |
| 913 | |
| 914 | /* Vertical offset of the right fringe bitmap. */ |
| 915 | signed right_fringe_offset : FRINGE_HEIGHT_BITS; |
| 916 | |
| 917 | /* 1 means that at least one of the left and right fringe bitmaps is |
| 918 | periodic and thus depends on the y-position of the row. */ |
| 919 | unsigned fringe_bitmap_periodic_p : 1; |
| 920 | |
| 921 | /* 1 means that we must draw the bitmaps of this row. */ |
| 922 | unsigned redraw_fringe_bitmaps_p : 1; |
| 923 | |
| 924 | /* In a desired matrix, 1 means that this row must be updated. In a |
| 925 | current matrix, 0 means that the row has been invalidated, i.e. |
| 926 | the row's contents do not agree with what is visible on the |
| 927 | screen. */ |
| 928 | unsigned enabled_p : 1; |
| 929 | |
| 930 | /* 1 means row displays a text line that is truncated on the left or |
| 931 | right side. */ |
| 932 | unsigned truncated_on_left_p : 1; |
| 933 | unsigned truncated_on_right_p : 1; |
| 934 | |
| 935 | /* 1 means that this row displays a continued line, i.e. it has a |
| 936 | continuation mark at the right side. */ |
| 937 | unsigned continued_p : 1; |
| 938 | |
| 939 | /* 0 means that this row does not contain any text, i.e. it is |
| 940 | a blank line at the window and buffer end. */ |
| 941 | unsigned displays_text_p : 1; |
| 942 | |
| 943 | /* 1 means that this line ends at ZV. */ |
| 944 | unsigned ends_at_zv_p : 1; |
| 945 | |
| 946 | /* 1 means the face of the last glyph in the text area is drawn to |
| 947 | the right end of the window. This flag is used in |
| 948 | update_text_area to optimize clearing to the end of the area. */ |
| 949 | unsigned fill_line_p : 1; |
| 950 | |
| 951 | /* Non-zero means display a bitmap on X frames indicating that this |
| 952 | line contains no text and ends in ZV. */ |
| 953 | unsigned indicate_empty_line_p : 1; |
| 954 | |
| 955 | /* 1 means this row contains glyphs that overlap each other because |
| 956 | of lbearing or rbearing. */ |
| 957 | unsigned contains_overlapping_glyphs_p : 1; |
| 958 | |
| 959 | /* 1 means this row is as wide as the window it is displayed in, including |
| 960 | scroll bars, fringes, and internal borders. This also |
| 961 | implies that the row doesn't have marginal areas. */ |
| 962 | unsigned full_width_p : 1; |
| 963 | |
| 964 | /* Non-zero means row is a mode or header-line. */ |
| 965 | unsigned mode_line_p : 1; |
| 966 | |
| 967 | /* 1 in a current row means this row is overlapped by another row. */ |
| 968 | unsigned overlapped_p : 1; |
| 969 | |
| 970 | /* 1 means this line ends in the middle of a character consisting |
| 971 | of more than one glyph. Some glyphs have been put in this row, |
| 972 | the rest are put in rows below this one. */ |
| 973 | unsigned ends_in_middle_of_char_p : 1; |
| 974 | |
| 975 | /* 1 means this line starts in the middle of a character consisting |
| 976 | of more than one glyph. Some glyphs have been put in the |
| 977 | previous row, the rest are put in this row. */ |
| 978 | unsigned starts_in_middle_of_char_p : 1; |
| 979 | |
| 980 | /* 1 in a current row means this row overlaps others. */ |
| 981 | unsigned overlapping_p : 1; |
| 982 | |
| 983 | /* 1 means some glyphs in this row are displayed in mouse-face. */ |
| 984 | unsigned mouse_face_p : 1; |
| 985 | |
| 986 | /* 1 means this row was ended by a newline from a string. */ |
| 987 | unsigned ends_in_newline_from_string_p : 1; |
| 988 | |
| 989 | /* 1 means this row width is exactly the width of the window, and the |
| 990 | final newline character is hidden in the right fringe. */ |
| 991 | unsigned exact_window_width_line_p : 1; |
| 992 | |
| 993 | /* 1 means this row currently shows the cursor in the right fringe. */ |
| 994 | unsigned cursor_in_fringe_p : 1; |
| 995 | |
| 996 | /* 1 means the last glyph in the row is part of an ellipsis. */ |
| 997 | unsigned ends_in_ellipsis_p : 1; |
| 998 | |
| 999 | /* Non-zero means display a bitmap on X frames indicating that this |
| 1000 | the first line of the buffer. */ |
| 1001 | unsigned indicate_bob_p : 1; |
| 1002 | |
| 1003 | /* Non-zero means display a bitmap on X frames indicating that this |
| 1004 | the top line of the window, but not start of the buffer. */ |
| 1005 | unsigned indicate_top_line_p : 1; |
| 1006 | |
| 1007 | /* Non-zero means display a bitmap on X frames indicating that this |
| 1008 | the last line of the buffer. */ |
| 1009 | unsigned indicate_eob_p : 1; |
| 1010 | |
| 1011 | /* Non-zero means display a bitmap on X frames indicating that this |
| 1012 | the bottom line of the window, but not end of the buffer. */ |
| 1013 | unsigned indicate_bottom_line_p : 1; |
| 1014 | |
| 1015 | /* Non-zero means the row was reversed to display text in a |
| 1016 | right-to-left paragraph. */ |
| 1017 | unsigned reversed_p : 1; |
| 1018 | |
| 1019 | /* Continuation lines width at the start of the row. */ |
| 1020 | int continuation_lines_width; |
| 1021 | |
| 1022 | #ifdef HAVE_WINDOW_SYSTEM |
| 1023 | /* Non-NULL means the current clipping area. This is temporarily |
| 1024 | set while exposing a region. Coordinates are frame-relative. */ |
| 1025 | XRectangle *clip; |
| 1026 | #endif |
| 1027 | }; |
| 1028 | |
| 1029 | |
| 1030 | /* Get a pointer to row number ROW in matrix MATRIX. If GLYPH_DEBUG |
| 1031 | is defined, the function matrix_row checks that we don't try to |
| 1032 | access rows that are out of bounds. */ |
| 1033 | |
| 1034 | #ifdef GLYPH_DEBUG |
| 1035 | struct glyph_row *matrix_row (struct glyph_matrix *, int); |
| 1036 | #define MATRIX_ROW(MATRIX, ROW) matrix_row ((MATRIX), (ROW)) |
| 1037 | #else |
| 1038 | #define MATRIX_ROW(MATRIX, ROW) ((MATRIX)->rows + (ROW)) |
| 1039 | #endif |
| 1040 | |
| 1041 | /* Return a pointer to the row reserved for the mode line in MATRIX. |
| 1042 | Row MATRIX->nrows - 1 is always reserved for the mode line. */ |
| 1043 | |
| 1044 | #define MATRIX_MODE_LINE_ROW(MATRIX) \ |
| 1045 | ((MATRIX)->rows + (MATRIX)->nrows - 1) |
| 1046 | |
| 1047 | /* Return a pointer to the row reserved for the header line in MATRIX. |
| 1048 | This is always the first row in MATRIX because that's the only |
| 1049 | way that works in frame-based redisplay. */ |
| 1050 | |
| 1051 | #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows |
| 1052 | |
| 1053 | /* Return a pointer to first row in MATRIX used for text display. */ |
| 1054 | |
| 1055 | #define MATRIX_FIRST_TEXT_ROW(MATRIX) \ |
| 1056 | ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows) |
| 1057 | |
| 1058 | /* Return a pointer to the first glyph in the text area of a row. |
| 1059 | MATRIX is the glyph matrix accessed, and ROW is the row index in |
| 1060 | MATRIX. */ |
| 1061 | |
| 1062 | #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \ |
| 1063 | (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA]) |
| 1064 | |
| 1065 | /* Return the number of used glyphs in the text area of a row. */ |
| 1066 | |
| 1067 | #define MATRIX_ROW_USED(MATRIX, ROW) \ |
| 1068 | (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA]) |
| 1069 | |
| 1070 | /* Return the character/ byte position at which the display of ROW |
| 1071 | starts. BIDI Note: this is the smallest character/byte position |
| 1072 | among characters in ROW, i.e. the first logical-order character |
| 1073 | displayed by ROW, which is not necessarily the smallest horizontal |
| 1074 | position. */ |
| 1075 | |
| 1076 | #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->minpos.charpos) |
| 1077 | #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->minpos.bytepos) |
| 1078 | |
| 1079 | /* Return the character/ byte position at which ROW ends. BIDI Note: |
| 1080 | this is the largest character/byte position among characters in |
| 1081 | ROW, i.e. the last logical-order character displayed by ROW, which |
| 1082 | is not necessarily the largest horizontal position. */ |
| 1083 | |
| 1084 | #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->maxpos.charpos) |
| 1085 | #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->maxpos.bytepos) |
| 1086 | |
| 1087 | /* Return the vertical position of ROW in MATRIX. */ |
| 1088 | |
| 1089 | #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows) |
| 1090 | |
| 1091 | /* Return the last glyph row + 1 in MATRIX on window W reserved for |
| 1092 | text. If W has a mode line, the last row in the matrix is reserved |
| 1093 | for it. */ |
| 1094 | |
| 1095 | #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W) \ |
| 1096 | ((MATRIX)->rows \ |
| 1097 | + (MATRIX)->nrows \ |
| 1098 | - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0)) |
| 1099 | |
| 1100 | /* Non-zero if the face of the last glyph in ROW's text area has |
| 1101 | to be drawn to the end of the text area. */ |
| 1102 | |
| 1103 | #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p) |
| 1104 | |
| 1105 | /* Set and query the enabled_p flag of glyph row ROW in MATRIX. */ |
| 1106 | |
| 1107 | #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \ |
| 1108 | (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0) |
| 1109 | |
| 1110 | #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \ |
| 1111 | (MATRIX_ROW ((MATRIX), (ROW))->enabled_p) |
| 1112 | |
| 1113 | /* Non-zero if ROW displays text. Value is non-zero if the row is |
| 1114 | blank but displays a line end. */ |
| 1115 | |
| 1116 | #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p) |
| 1117 | |
| 1118 | |
| 1119 | /* Helper macros */ |
| 1120 | |
| 1121 | #define MR_PARTIALLY_VISIBLE(ROW) \ |
| 1122 | ((ROW)->height != (ROW)->visible_height) |
| 1123 | |
| 1124 | #define MR_PARTIALLY_VISIBLE_AT_TOP(W, ROW) \ |
| 1125 | ((ROW)->y < WINDOW_HEADER_LINE_HEIGHT ((W))) |
| 1126 | |
| 1127 | #define MR_PARTIALLY_VISIBLE_AT_BOTTOM(W, ROW) \ |
| 1128 | (((ROW)->y + (ROW)->height - (ROW)->extra_line_spacing) \ |
| 1129 | > WINDOW_BOX_HEIGHT_NO_MODE_LINE ((W))) |
| 1130 | |
| 1131 | /* Non-zero if ROW is not completely visible in window W. */ |
| 1132 | |
| 1133 | #define MATRIX_ROW_PARTIALLY_VISIBLE_P(W, ROW) \ |
| 1134 | (MR_PARTIALLY_VISIBLE ((ROW)) \ |
| 1135 | && (MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)) \ |
| 1136 | || MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW)))) |
| 1137 | |
| 1138 | |
| 1139 | |
| 1140 | /* Non-zero if ROW is partially visible at the top of window W. */ |
| 1141 | |
| 1142 | #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \ |
| 1143 | (MR_PARTIALLY_VISIBLE ((ROW)) \ |
| 1144 | && MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW))) |
| 1145 | |
| 1146 | /* Non-zero if ROW is partially visible at the bottom of window W. */ |
| 1147 | |
| 1148 | #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \ |
| 1149 | (MR_PARTIALLY_VISIBLE ((ROW)) \ |
| 1150 | && MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW))) |
| 1151 | |
| 1152 | /* Return the bottom Y + 1 of ROW. */ |
| 1153 | |
| 1154 | #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height) |
| 1155 | |
| 1156 | /* Is ROW the last visible one in the display described by the |
| 1157 | iterator structure pointed to by IT?. */ |
| 1158 | |
| 1159 | #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \ |
| 1160 | (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y) |
| 1161 | |
| 1162 | /* Non-zero if ROW displays a continuation line. */ |
| 1163 | |
| 1164 | #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \ |
| 1165 | ((ROW)->continuation_lines_width > 0) |
| 1166 | |
| 1167 | /* Non-zero if ROW ends in the middle of a character. This is the |
| 1168 | case for continued lines showing only part of a display table entry |
| 1169 | or a control char, or an overlay string. */ |
| 1170 | |
| 1171 | #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \ |
| 1172 | ((ROW)->end.dpvec_index > 0 \ |
| 1173 | || (ROW)->end.overlay_string_index >= 0 \ |
| 1174 | || (ROW)->ends_in_middle_of_char_p) |
| 1175 | |
| 1176 | /* Non-zero if ROW ends in the middle of an overlay string. */ |
| 1177 | |
| 1178 | #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \ |
| 1179 | ((ROW)->end.overlay_string_index >= 0) |
| 1180 | |
| 1181 | /* Non-zero if ROW starts in the middle of a character. See above. */ |
| 1182 | |
| 1183 | #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \ |
| 1184 | ((ROW)->start.dpvec_index > 0 \ |
| 1185 | || (ROW)->starts_in_middle_of_char_p \ |
| 1186 | || ((ROW)->start.overlay_string_index >= 0 \ |
| 1187 | && (ROW)->start.string_pos.charpos > 0)) |
| 1188 | |
| 1189 | /* Non-zero means ROW overlaps its predecessor. */ |
| 1190 | |
| 1191 | #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \ |
| 1192 | ((ROW)->phys_ascent > (ROW)->ascent) |
| 1193 | |
| 1194 | /* Non-zero means ROW overlaps its successor. */ |
| 1195 | |
| 1196 | #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW) \ |
| 1197 | ((ROW)->phys_height - (ROW)->phys_ascent \ |
| 1198 | > (ROW)->height - (ROW)->ascent) |
| 1199 | |
| 1200 | /* A glyph for a space. */ |
| 1201 | |
| 1202 | extern struct glyph space_glyph; |
| 1203 | |
| 1204 | /* Non-zero means last display completed. Zero means it was |
| 1205 | preempted. */ |
| 1206 | |
| 1207 | extern bool display_completed; |
| 1208 | |
| 1209 | |
| 1210 | \f |
| 1211 | /************************************************************************ |
| 1212 | Glyph Strings |
| 1213 | ************************************************************************/ |
| 1214 | |
| 1215 | /* Enumeration for overriding/changing the face to use for drawing |
| 1216 | glyphs in draw_glyphs. */ |
| 1217 | |
| 1218 | enum draw_glyphs_face |
| 1219 | { |
| 1220 | DRAW_NORMAL_TEXT, |
| 1221 | DRAW_INVERSE_VIDEO, |
| 1222 | DRAW_CURSOR, |
| 1223 | DRAW_MOUSE_FACE, |
| 1224 | DRAW_IMAGE_RAISED, |
| 1225 | DRAW_IMAGE_SUNKEN |
| 1226 | }; |
| 1227 | |
| 1228 | #ifdef HAVE_WINDOW_SYSTEM |
| 1229 | |
| 1230 | /* A sequence of glyphs to be drawn in the same face. */ |
| 1231 | |
| 1232 | struct glyph_string |
| 1233 | { |
| 1234 | /* X-origin of the string. */ |
| 1235 | int x; |
| 1236 | |
| 1237 | /* Y-origin and y-position of the base line of this string. */ |
| 1238 | int y, ybase; |
| 1239 | |
| 1240 | /* The width of the string, not including a face extension. */ |
| 1241 | int width; |
| 1242 | |
| 1243 | /* The width of the string, including a face extension. */ |
| 1244 | int background_width; |
| 1245 | |
| 1246 | /* The height of this string. This is the height of the line this |
| 1247 | string is drawn in, and can be different from the height of the |
| 1248 | font the string is drawn in. */ |
| 1249 | int height; |
| 1250 | |
| 1251 | /* Number of pixels this string overwrites in front of its x-origin. |
| 1252 | This number is zero if the string has an lbearing >= 0; it is |
| 1253 | -lbearing, if the string has an lbearing < 0. */ |
| 1254 | int left_overhang; |
| 1255 | |
| 1256 | /* Number of pixels this string overwrites past its right-most |
| 1257 | nominal x-position, i.e. x + width. Zero if the string's |
| 1258 | rbearing is <= its nominal width, rbearing - width otherwise. */ |
| 1259 | int right_overhang; |
| 1260 | |
| 1261 | /* The frame on which the glyph string is drawn. */ |
| 1262 | struct frame *f; |
| 1263 | |
| 1264 | /* The window on which the glyph string is drawn. */ |
| 1265 | struct window *w; |
| 1266 | |
| 1267 | /* X display and window for convenience. */ |
| 1268 | Display *display; |
| 1269 | Window window; |
| 1270 | |
| 1271 | /* The glyph row for which this string was built. It determines the |
| 1272 | y-origin and height of the string. */ |
| 1273 | struct glyph_row *row; |
| 1274 | |
| 1275 | /* The area within row. */ |
| 1276 | enum glyph_row_area area; |
| 1277 | |
| 1278 | /* Characters to be drawn, and number of characters. */ |
| 1279 | XChar2b *char2b; |
| 1280 | int nchars; |
| 1281 | |
| 1282 | /* A face-override for drawing cursors, mouse face and similar. */ |
| 1283 | enum draw_glyphs_face hl; |
| 1284 | |
| 1285 | /* Face in which this string is to be drawn. */ |
| 1286 | struct face *face; |
| 1287 | |
| 1288 | /* Font in which this string is to be drawn. */ |
| 1289 | struct font *font; |
| 1290 | |
| 1291 | /* Non-null means this string describes (part of) a static |
| 1292 | composition. */ |
| 1293 | struct composition *cmp; |
| 1294 | |
| 1295 | /* If not negative, this string describes a compos. */ |
| 1296 | ptrdiff_t cmp_id; |
| 1297 | |
| 1298 | /* Start and end glyph indices in a glyph-string. */ |
| 1299 | int cmp_from, cmp_to; |
| 1300 | |
| 1301 | /* 1 means this glyph strings face has to be drawn to the right end |
| 1302 | of the window's drawing area. */ |
| 1303 | unsigned extends_to_end_of_line_p : 1; |
| 1304 | |
| 1305 | /* 1 means the background of this string has been drawn. */ |
| 1306 | unsigned background_filled_p : 1; |
| 1307 | |
| 1308 | /* 1 means glyph string must be drawn with 16-bit functions. */ |
| 1309 | unsigned two_byte_p : 1; |
| 1310 | |
| 1311 | /* 1 means that the original font determined for drawing this glyph |
| 1312 | string could not be loaded. The member `font' has been set to |
| 1313 | the frame's default font in this case. */ |
| 1314 | unsigned font_not_found_p : 1; |
| 1315 | |
| 1316 | /* 1 means that the face in which this glyph string is drawn has a |
| 1317 | stipple pattern. */ |
| 1318 | unsigned stippled_p : 1; |
| 1319 | |
| 1320 | #define OVERLAPS_PRED (1 << 0) |
| 1321 | #define OVERLAPS_SUCC (1 << 1) |
| 1322 | #define OVERLAPS_BOTH (OVERLAPS_PRED | OVERLAPS_SUCC) |
| 1323 | #define OVERLAPS_ERASED_CURSOR (1 << 2) |
| 1324 | /* Non-zero means only the foreground of this glyph string must be |
| 1325 | drawn, and we should use the physical height of the line this |
| 1326 | glyph string appears in as clip rect. If the value is |
| 1327 | OVERLAPS_ERASED_CURSOR, the clip rect is restricted to the rect |
| 1328 | of the erased cursor. OVERLAPS_PRED and OVERLAPS_SUCC mean we |
| 1329 | draw overlaps with the preceding and the succeeding rows, |
| 1330 | respectively. */ |
| 1331 | unsigned for_overlaps : 3; |
| 1332 | |
| 1333 | /* 1 means that all glyphs in this glyph string has the flag |
| 1334 | padding_p set, and thus must be drawn one by one to have 1-pixel |
| 1335 | width even though the logical width in the font is zero. */ |
| 1336 | unsigned padding_p : 1; |
| 1337 | |
| 1338 | /* The GC to use for drawing this glyph string. */ |
| 1339 | #if defined (HAVE_X_WINDOWS) |
| 1340 | GC gc; |
| 1341 | #endif |
| 1342 | #if defined (HAVE_NTGUI) |
| 1343 | XGCValues *gc; |
| 1344 | HDC hdc; |
| 1345 | #endif |
| 1346 | |
| 1347 | /* A pointer to the first glyph in the string. This glyph |
| 1348 | corresponds to char2b[0]. Needed to draw rectangles if |
| 1349 | font_not_found_p is 1. */ |
| 1350 | struct glyph *first_glyph; |
| 1351 | |
| 1352 | /* Image, if any. */ |
| 1353 | struct image *img; |
| 1354 | |
| 1355 | /* Slice */ |
| 1356 | struct glyph_slice slice; |
| 1357 | |
| 1358 | /* Non-null means the horizontal clipping region starts from the |
| 1359 | left edge of *clip_head, and ends with the right edge of |
| 1360 | *clip_tail, not including their overhangs. */ |
| 1361 | struct glyph_string *clip_head, *clip_tail; |
| 1362 | |
| 1363 | /* The current clipping areas. */ |
| 1364 | NativeRectangle clip[2]; |
| 1365 | |
| 1366 | /* Number of clipping areas. */ |
| 1367 | int num_clips; |
| 1368 | |
| 1369 | int underline_position; |
| 1370 | |
| 1371 | int underline_thickness; |
| 1372 | |
| 1373 | struct glyph_string *next, *prev; |
| 1374 | }; |
| 1375 | |
| 1376 | #endif /* HAVE_WINDOW_SYSTEM */ |
| 1377 | |
| 1378 | \f |
| 1379 | /************************************************************************ |
| 1380 | Display Dimensions |
| 1381 | ************************************************************************/ |
| 1382 | |
| 1383 | /* Return the height of the mode line in glyph matrix MATRIX, or zero |
| 1384 | if not known. This macro is called under circumstances where |
| 1385 | MATRIX might not have been allocated yet. */ |
| 1386 | |
| 1387 | #define MATRIX_MODE_LINE_HEIGHT(MATRIX) \ |
| 1388 | ((MATRIX) && (MATRIX)->rows \ |
| 1389 | ? MATRIX_MODE_LINE_ROW (MATRIX)->height \ |
| 1390 | : 0) |
| 1391 | |
| 1392 | /* Return the height of the header line in glyph matrix MATRIX, or zero |
| 1393 | if not known. This macro is called under circumstances where |
| 1394 | MATRIX might not have been allocated yet. */ |
| 1395 | |
| 1396 | #define MATRIX_HEADER_LINE_HEIGHT(MATRIX) \ |
| 1397 | ((MATRIX) && (MATRIX)->rows \ |
| 1398 | ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \ |
| 1399 | : 0) |
| 1400 | |
| 1401 | /* Return the desired face id for the mode line of a window, depending |
| 1402 | on whether the window is selected or not, or if the window is the |
| 1403 | scrolling window for the currently active minibuffer window. |
| 1404 | |
| 1405 | Due to the way display_mode_lines manipulates with the contents of |
| 1406 | selected_window, this macro needs three arguments: SELW which is |
| 1407 | compared against the current value of selected_window, MBW which is |
| 1408 | compared against minibuf_window (if SELW doesn't match), and SCRW |
| 1409 | which is compared against minibuf_selected_window (if MBW matches). */ |
| 1410 | |
| 1411 | #define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW) \ |
| 1412 | ((!mode_line_in_non_selected_windows \ |
| 1413 | || (SELW) == XWINDOW (selected_window) \ |
| 1414 | || (minibuf_level > 0 \ |
| 1415 | && !NILP (minibuf_selected_window) \ |
| 1416 | && (MBW) == XWINDOW (minibuf_window) \ |
| 1417 | && (SCRW) == XWINDOW (minibuf_selected_window))) \ |
| 1418 | ? MODE_LINE_FACE_ID \ |
| 1419 | : MODE_LINE_INACTIVE_FACE_ID) |
| 1420 | |
| 1421 | |
| 1422 | /* Return the desired face id for the mode line of window W. */ |
| 1423 | |
| 1424 | #define CURRENT_MODE_LINE_FACE_ID(W) \ |
| 1425 | (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W))) |
| 1426 | |
| 1427 | /* Return the current height of the mode line of window W. If not known |
| 1428 | from W->mode_line_height, look at W's current glyph matrix, or return |
| 1429 | a default based on the height of the font of the face `mode-line'. */ |
| 1430 | |
| 1431 | #define CURRENT_MODE_LINE_HEIGHT(W) \ |
| 1432 | (W->mode_line_height >= 0 \ |
| 1433 | ? W->mode_line_height \ |
| 1434 | : (W->mode_line_height \ |
| 1435 | = (MATRIX_MODE_LINE_HEIGHT (W->current_matrix) \ |
| 1436 | ? MATRIX_MODE_LINE_HEIGHT (W->current_matrix) \ |
| 1437 | : estimate_mode_line_height \ |
| 1438 | (XFRAME (W->frame), CURRENT_MODE_LINE_FACE_ID (W))))) |
| 1439 | |
| 1440 | /* Return the current height of the header line of window W. If not known |
| 1441 | from W->header_line_height, look at W's current glyph matrix, or return |
| 1442 | an estimation based on the height of the font of the face `header-line'. */ |
| 1443 | |
| 1444 | #define CURRENT_HEADER_LINE_HEIGHT(W) \ |
| 1445 | (W->header_line_height >= 0 \ |
| 1446 | ? W->header_line_height \ |
| 1447 | : (W->header_line_height \ |
| 1448 | = (MATRIX_HEADER_LINE_HEIGHT (W->current_matrix) \ |
| 1449 | ? MATRIX_HEADER_LINE_HEIGHT (W->current_matrix) \ |
| 1450 | : estimate_mode_line_height \ |
| 1451 | (XFRAME (W->frame), HEADER_LINE_FACE_ID)))) |
| 1452 | |
| 1453 | /* Return the height of the desired mode line of window W. */ |
| 1454 | |
| 1455 | #define DESIRED_MODE_LINE_HEIGHT(W) \ |
| 1456 | MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix) |
| 1457 | |
| 1458 | /* Return the height of the desired header line of window W. */ |
| 1459 | |
| 1460 | #define DESIRED_HEADER_LINE_HEIGHT(W) \ |
| 1461 | MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix) |
| 1462 | |
| 1463 | /* Value is non-zero if window W wants a mode line. */ |
| 1464 | |
| 1465 | #define WINDOW_WANTS_MODELINE_P(W) \ |
| 1466 | (!MINI_WINDOW_P ((W)) \ |
| 1467 | && !(W)->pseudo_window_p \ |
| 1468 | && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \ |
| 1469 | && BUFFERP ((W)->contents) \ |
| 1470 | && !NILP (BVAR (XBUFFER ((W)->contents), mode_line_format)) \ |
| 1471 | && WINDOW_TOTAL_LINES (W) > 1) |
| 1472 | |
| 1473 | /* Value is true if window W wants a header line. */ |
| 1474 | |
| 1475 | #define WINDOW_WANTS_HEADER_LINE_P(W) \ |
| 1476 | (BUFFERP ((W)->contents) \ |
| 1477 | ? (!MINI_WINDOW_P ((W)) \ |
| 1478 | && !(W)->pseudo_window_p \ |
| 1479 | && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W)))) \ |
| 1480 | && !NILP (BVAR (XBUFFER ((W)->contents), header_line_format)) \ |
| 1481 | && WINDOW_TOTAL_LINES (W) > \ |
| 1482 | (1 + !NILP (BVAR (XBUFFER ((W)->contents), mode_line_format)))) \ |
| 1483 | : 0) |
| 1484 | |
| 1485 | /* Return proper value to be used as baseline offset of font that has |
| 1486 | ASCENT and DESCENT to draw characters by the font at the vertical |
| 1487 | center of the line of frame F. |
| 1488 | |
| 1489 | Here, our task is to find the value of BOFF in the following figure; |
| 1490 | |
| 1491 | -------------------------+-----------+- |
| 1492 | -+-+---------+-+ | | |
| 1493 | | | | | | | |
| 1494 | | | | | F_ASCENT F_HEIGHT |
| 1495 | | | | ASCENT | | |
| 1496 | HEIGHT | | | | | |
| 1497 | | | |-|-+------+-----------|------- baseline |
| 1498 | | | | | BOFF | | |
| 1499 | | |---------|-+-+ | | |
| 1500 | | | | DESCENT | | |
| 1501 | -+-+---------+-+ F_DESCENT | |
| 1502 | -------------------------+-----------+- |
| 1503 | |
| 1504 | -BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT |
| 1505 | BOFF = DESCENT + (F_HEIGHT - HEIGHT) / 2 - F_DESCENT |
| 1506 | DESCENT = FONT->descent |
| 1507 | HEIGHT = FONT_HEIGHT (FONT) |
| 1508 | F_DESCENT = (FRAME_FONT (F)->descent |
| 1509 | - F->terminal->output_data.x->baseline_offset) |
| 1510 | F_HEIGHT = FRAME_LINE_HEIGHT (F) |
| 1511 | */ |
| 1512 | |
| 1513 | #define VCENTER_BASELINE_OFFSET(FONT, F) \ |
| 1514 | (FONT_DESCENT (FONT) \ |
| 1515 | + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT)) \ |
| 1516 | + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2 \ |
| 1517 | - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F))) |
| 1518 | |
| 1519 | \f |
| 1520 | /*********************************************************************** |
| 1521 | Faces |
| 1522 | ***********************************************************************/ |
| 1523 | |
| 1524 | /* Indices of face attributes in Lisp face vectors. Slot zero is the |
| 1525 | symbol `face'. */ |
| 1526 | |
| 1527 | enum lface_attribute_index |
| 1528 | { |
| 1529 | LFACE_FAMILY_INDEX = 1, |
| 1530 | LFACE_FOUNDRY_INDEX, |
| 1531 | LFACE_SWIDTH_INDEX, |
| 1532 | LFACE_HEIGHT_INDEX, |
| 1533 | LFACE_WEIGHT_INDEX, |
| 1534 | LFACE_SLANT_INDEX, |
| 1535 | LFACE_UNDERLINE_INDEX, |
| 1536 | LFACE_INVERSE_INDEX, |
| 1537 | LFACE_FOREGROUND_INDEX, |
| 1538 | LFACE_BACKGROUND_INDEX, |
| 1539 | LFACE_STIPPLE_INDEX, |
| 1540 | LFACE_OVERLINE_INDEX, |
| 1541 | LFACE_STRIKE_THROUGH_INDEX, |
| 1542 | LFACE_BOX_INDEX, |
| 1543 | LFACE_FONT_INDEX, |
| 1544 | LFACE_INHERIT_INDEX, |
| 1545 | LFACE_FONTSET_INDEX, |
| 1546 | LFACE_VECTOR_SIZE |
| 1547 | }; |
| 1548 | |
| 1549 | |
| 1550 | /* Box types of faces. */ |
| 1551 | |
| 1552 | enum face_box_type |
| 1553 | { |
| 1554 | /* No box around text. */ |
| 1555 | FACE_NO_BOX, |
| 1556 | |
| 1557 | /* Simple box of specified width and color. Default width is 1, and |
| 1558 | default color is the foreground color of the face. */ |
| 1559 | FACE_SIMPLE_BOX, |
| 1560 | |
| 1561 | /* Boxes with 3D shadows. Color equals the background color of the |
| 1562 | face. Width is specified. */ |
| 1563 | FACE_RAISED_BOX, |
| 1564 | FACE_SUNKEN_BOX |
| 1565 | }; |
| 1566 | |
| 1567 | /* Underline type. */ |
| 1568 | |
| 1569 | enum face_underline_type |
| 1570 | { |
| 1571 | FACE_UNDER_LINE, |
| 1572 | FACE_UNDER_WAVE |
| 1573 | }; |
| 1574 | |
| 1575 | /* Structure describing a realized face. |
| 1576 | |
| 1577 | For each Lisp face, 0..N realized faces can exist for different |
| 1578 | frames and different charsets. Realized faces are built from Lisp |
| 1579 | faces and text properties/overlays by merging faces and adding |
| 1580 | unspecified attributes from the `default' face. */ |
| 1581 | |
| 1582 | struct face |
| 1583 | { |
| 1584 | /* The Lisp face attributes this face realizes. All attributes |
| 1585 | in this vector are non-nil. */ |
| 1586 | Lisp_Object lface[LFACE_VECTOR_SIZE]; |
| 1587 | |
| 1588 | /* The id of this face. The id equals the index of this face in the |
| 1589 | vector faces_by_id of its face cache. */ |
| 1590 | int id; |
| 1591 | |
| 1592 | #ifdef HAVE_WINDOW_SYSTEM |
| 1593 | |
| 1594 | /* If non-zero, this is a GC that we can use without modification for |
| 1595 | drawing the characters in this face. */ |
| 1596 | GC gc; |
| 1597 | |
| 1598 | /* Background stipple or bitmap used for this face. This is |
| 1599 | an id as returned from load_pixmap. */ |
| 1600 | ptrdiff_t stipple; |
| 1601 | |
| 1602 | #endif /* not HAVE_WINDOW_SYSTEM */ |
| 1603 | |
| 1604 | /* Pixel value of foreground color for X frames. Color index |
| 1605 | for tty frames. */ |
| 1606 | unsigned long foreground; |
| 1607 | |
| 1608 | /* Pixel value or color index of background color. */ |
| 1609 | unsigned long background; |
| 1610 | |
| 1611 | /* Pixel value or color index of underline color. */ |
| 1612 | unsigned long underline_color; |
| 1613 | |
| 1614 | /* Pixel value or color index of overlined, strike-through, or box |
| 1615 | color. */ |
| 1616 | unsigned long overline_color; |
| 1617 | unsigned long strike_through_color; |
| 1618 | unsigned long box_color; |
| 1619 | |
| 1620 | struct font *font; |
| 1621 | |
| 1622 | /* Fontset ID if for this face's fontset. Non-ASCII faces derived |
| 1623 | from the same ASCII face have the same fontset. */ |
| 1624 | int fontset; |
| 1625 | |
| 1626 | /* Non-zero means characters in this face have a box of that |
| 1627 | thickness around them. If this value is negative, its absolute |
| 1628 | value indicates the thickness, and the horizontal (top and |
| 1629 | bottom) borders of box are drawn inside of the character glyphs' |
| 1630 | area. The vertical (left and right) borders of the box are drawn |
| 1631 | in the same way as when this value is positive. */ |
| 1632 | int box_line_width; |
| 1633 | |
| 1634 | /* Type of box drawn. A value of FACE_NO_BOX means no box is drawn |
| 1635 | around text in this face. A value of FACE_SIMPLE_BOX means a box |
| 1636 | of width box_line_width is drawn in color box_color. A value of |
| 1637 | FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with |
| 1638 | shadow colors derived from the background color of the face. */ |
| 1639 | ENUM_BF (face_box_type) box : 2; |
| 1640 | |
| 1641 | /* Style of underlining. */ |
| 1642 | ENUM_BF (face_underline_type) underline_type : 1; |
| 1643 | |
| 1644 | /* If `box' above specifies a 3D type, 1 means use box_color for |
| 1645 | drawing shadows. */ |
| 1646 | unsigned use_box_color_for_shadows_p : 1; |
| 1647 | |
| 1648 | /* Non-zero if text in this face should be underlined, overlined, |
| 1649 | strike-through or have a box drawn around it. */ |
| 1650 | unsigned underline_p : 1; |
| 1651 | unsigned overline_p : 1; |
| 1652 | unsigned strike_through_p : 1; |
| 1653 | |
| 1654 | /* 1 means that the colors specified for this face could not be |
| 1655 | loaded, and were replaced by default colors, so they shouldn't be |
| 1656 | freed. */ |
| 1657 | unsigned foreground_defaulted_p : 1; |
| 1658 | unsigned background_defaulted_p : 1; |
| 1659 | |
| 1660 | /* 1 means that either no color is specified for underlining or that |
| 1661 | the specified color couldn't be loaded. Use the foreground |
| 1662 | color when drawing in that case. */ |
| 1663 | unsigned underline_defaulted_p : 1; |
| 1664 | |
| 1665 | /* 1 means that either no color is specified for the corresponding |
| 1666 | attribute or that the specified color couldn't be loaded. |
| 1667 | Use the foreground color when drawing in that case. */ |
| 1668 | unsigned overline_color_defaulted_p : 1; |
| 1669 | unsigned strike_through_color_defaulted_p : 1; |
| 1670 | unsigned box_color_defaulted_p : 1; |
| 1671 | |
| 1672 | /* TTY appearances. Colors are found in `lface' with empty color |
| 1673 | string meaning the default color of the TTY. */ |
| 1674 | unsigned tty_bold_p : 1; |
| 1675 | unsigned tty_italic_p : 1; |
| 1676 | unsigned tty_underline_p : 1; |
| 1677 | unsigned tty_reverse_p : 1; |
| 1678 | |
| 1679 | /* 1 means that colors of this face may not be freed because they |
| 1680 | have been copied bitwise from a base face (see |
| 1681 | realize_x_face). */ |
| 1682 | unsigned colors_copied_bitwise_p : 1; |
| 1683 | |
| 1684 | /* If non-zero, use overstrike (to simulate bold-face). */ |
| 1685 | unsigned overstrike : 1; |
| 1686 | |
| 1687 | /* NOTE: this is not used yet, but eventually this impl should be done |
| 1688 | similarly to overstrike */ |
| 1689 | #ifdef HAVE_NS |
| 1690 | /* If non-zero, use geometric rotation (to simulate italic). */ |
| 1691 | unsigned synth_ital : 1; |
| 1692 | #endif |
| 1693 | |
| 1694 | /* The hash value of this face. */ |
| 1695 | unsigned hash; |
| 1696 | |
| 1697 | /* Next and previous face in hash collision list of face cache. */ |
| 1698 | struct face *next, *prev; |
| 1699 | |
| 1700 | /* If this face is an ASCII face, this points to this face itself. |
| 1701 | Otherwise, this points to an ASCII face that has the same |
| 1702 | attributes except the font. */ |
| 1703 | struct face *ascii_face; |
| 1704 | |
| 1705 | /* Extra member that a font-driver uses privately. */ |
| 1706 | void *extra; |
| 1707 | }; |
| 1708 | |
| 1709 | |
| 1710 | /* Color index indicating that face uses a terminal's default color. */ |
| 1711 | |
| 1712 | #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1) |
| 1713 | |
| 1714 | /* Color index indicating that face uses an unknown foreground color. */ |
| 1715 | |
| 1716 | #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2) |
| 1717 | |
| 1718 | /* Color index indicating that face uses an unknown background color. */ |
| 1719 | |
| 1720 | #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3) |
| 1721 | |
| 1722 | /* Non-zero if FACE was realized for unibyte use. */ |
| 1723 | |
| 1724 | #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0) |
| 1725 | |
| 1726 | |
| 1727 | /* IDs of important faces known by the C face code. These are the IDs |
| 1728 | of the faces for CHARSET_ASCII. */ |
| 1729 | |
| 1730 | enum face_id |
| 1731 | { |
| 1732 | DEFAULT_FACE_ID, |
| 1733 | MODE_LINE_FACE_ID, |
| 1734 | MODE_LINE_INACTIVE_FACE_ID, |
| 1735 | TOOL_BAR_FACE_ID, |
| 1736 | FRINGE_FACE_ID, |
| 1737 | HEADER_LINE_FACE_ID, |
| 1738 | SCROLL_BAR_FACE_ID, |
| 1739 | BORDER_FACE_ID, |
| 1740 | CURSOR_FACE_ID, |
| 1741 | MOUSE_FACE_ID, |
| 1742 | MENU_FACE_ID, |
| 1743 | VERTICAL_BORDER_FACE_ID, |
| 1744 | BASIC_FACE_ID_SENTINEL |
| 1745 | }; |
| 1746 | |
| 1747 | #define MAX_FACE_ID ((1 << FACE_ID_BITS) - 1) |
| 1748 | |
| 1749 | /* A cache of realized faces. Each frame has its own cache because |
| 1750 | Emacs allows different frame-local face definitions. */ |
| 1751 | |
| 1752 | struct face_cache |
| 1753 | { |
| 1754 | /* Hash table of cached realized faces. */ |
| 1755 | struct face **buckets; |
| 1756 | |
| 1757 | /* Back-pointer to the frame this cache belongs to. */ |
| 1758 | struct frame *f; |
| 1759 | |
| 1760 | /* A vector of faces so that faces can be referenced by an ID. */ |
| 1761 | struct face **faces_by_id; |
| 1762 | |
| 1763 | /* The allocated size, and number of used slots of faces_by_id. */ |
| 1764 | ptrdiff_t size; |
| 1765 | int used; |
| 1766 | |
| 1767 | /* Flag indicating that attributes of the `menu' face have been |
| 1768 | changed. */ |
| 1769 | unsigned menu_face_changed_p : 1; |
| 1770 | }; |
| 1771 | |
| 1772 | |
| 1773 | /* Prepare face FACE for use on frame F. This must be called before |
| 1774 | using X resources of FACE. */ |
| 1775 | |
| 1776 | #define PREPARE_FACE_FOR_DISPLAY(F, FACE) \ |
| 1777 | if ((FACE)->gc == 0) \ |
| 1778 | prepare_face_for_display ((F), (FACE)); \ |
| 1779 | else \ |
| 1780 | (void) 0 |
| 1781 | |
| 1782 | /* Return a pointer to the face with ID on frame F, or null if such a |
| 1783 | face doesn't exist. */ |
| 1784 | |
| 1785 | #define FACE_FROM_ID(F, ID) \ |
| 1786 | (UNSIGNED_CMP (ID, <, FRAME_FACE_CACHE (F)->used) \ |
| 1787 | ? FRAME_FACE_CACHE (F)->faces_by_id[ID] \ |
| 1788 | : NULL) |
| 1789 | |
| 1790 | #ifdef HAVE_WINDOW_SYSTEM |
| 1791 | |
| 1792 | /* Non-zero if FACE is suitable for displaying character CHAR. */ |
| 1793 | |
| 1794 | #define FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE, CHAR) \ |
| 1795 | ((FACE) == (FACE)->ascii_face) |
| 1796 | |
| 1797 | #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) \ |
| 1798 | (ASCII_CHAR_P (CHAR) \ |
| 1799 | ? FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE) \ |
| 1800 | : face_suitable_for_char_p ((FACE), (CHAR))) |
| 1801 | |
| 1802 | /* Return the id of the realized face on frame F that is like the face |
| 1803 | with id ID but is suitable for displaying character CHAR. |
| 1804 | This macro is only meaningful for multibyte character CHAR. */ |
| 1805 | |
| 1806 | #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) \ |
| 1807 | ((ASCII_CHAR_P (CHAR) || CHAR_BYTE8_P (CHAR)) \ |
| 1808 | ? (FACE)->ascii_face->id \ |
| 1809 | : face_for_char ((F), (FACE), (CHAR), (POS), (OBJECT))) |
| 1810 | |
| 1811 | #else /* not HAVE_WINDOW_SYSTEM */ |
| 1812 | |
| 1813 | #define FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE, CHAR) 1 |
| 1814 | #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1 |
| 1815 | #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) ((FACE)->id) |
| 1816 | |
| 1817 | #endif /* not HAVE_WINDOW_SYSTEM */ |
| 1818 | |
| 1819 | /* Return true if G contains a valid character code. */ |
| 1820 | INLINE bool |
| 1821 | GLYPH_CHAR_VALID_P (GLYPH g) |
| 1822 | { |
| 1823 | return CHAR_VALID_P (GLYPH_CHAR (g)); |
| 1824 | } |
| 1825 | |
| 1826 | /* The glyph code from a display vector may either be an integer which |
| 1827 | encodes a char code in the lower CHARACTERBITS bits and a (very small) |
| 1828 | face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */ |
| 1829 | |
| 1830 | INLINE bool |
| 1831 | GLYPH_CODE_P (Lisp_Object gc) |
| 1832 | { |
| 1833 | return (CONSP (gc) |
| 1834 | ? (CHARACTERP (XCAR (gc)) |
| 1835 | && RANGED_INTEGERP (0, XCDR (gc), MAX_FACE_ID)) |
| 1836 | : (RANGED_INTEGERP |
| 1837 | (0, gc, |
| 1838 | (MAX_FACE_ID < TYPE_MAXIMUM (EMACS_INT) >> CHARACTERBITS |
| 1839 | ? ((EMACS_INT) MAX_FACE_ID << CHARACTERBITS) | MAX_CHAR |
| 1840 | : TYPE_MAXIMUM (EMACS_INT))))); |
| 1841 | } |
| 1842 | |
| 1843 | /* Non-zero means face attributes have been changed since the last |
| 1844 | redisplay. Used in redisplay_internal. */ |
| 1845 | |
| 1846 | extern int face_change_count; |
| 1847 | |
| 1848 | /* For reordering of bidirectional text. */ |
| 1849 | #define BIDI_MAXLEVEL 64 |
| 1850 | |
| 1851 | /* Data type for describing the bidirectional character types. The |
| 1852 | first 7 must be at the beginning, because they are the only values |
| 1853 | valid in the `bidi_type' member of `struct glyph'; we only reserve |
| 1854 | 3 bits for it, so we cannot use there values larger than 7. |
| 1855 | |
| 1856 | The order of members must be in sync with the 8th element of the |
| 1857 | member of unidata-prop-alist (in admin/unidata/unidata-gen.el) for |
| 1858 | Unicode character property `bidi-class'. */ |
| 1859 | typedef enum { |
| 1860 | UNKNOWN_BT = 0, |
| 1861 | STRONG_L, /* strong left-to-right */ |
| 1862 | STRONG_R, /* strong right-to-left */ |
| 1863 | WEAK_EN, /* european number */ |
| 1864 | WEAK_AN, /* arabic number */ |
| 1865 | WEAK_BN, /* boundary neutral */ |
| 1866 | NEUTRAL_B, /* paragraph separator */ |
| 1867 | STRONG_AL, /* arabic right-to-left letter */ |
| 1868 | LRE, /* left-to-right embedding */ |
| 1869 | LRO, /* left-to-right override */ |
| 1870 | RLE, /* right-to-left embedding */ |
| 1871 | RLO, /* right-to-left override */ |
| 1872 | PDF, /* pop directional format */ |
| 1873 | WEAK_ES, /* european number separator */ |
| 1874 | WEAK_ET, /* european number terminator */ |
| 1875 | WEAK_CS, /* common separator */ |
| 1876 | WEAK_NSM, /* non-spacing mark */ |
| 1877 | NEUTRAL_S, /* segment separator */ |
| 1878 | NEUTRAL_WS, /* whitespace */ |
| 1879 | NEUTRAL_ON /* other neutrals */ |
| 1880 | } bidi_type_t; |
| 1881 | |
| 1882 | /* The basic directionality data type. */ |
| 1883 | typedef enum { NEUTRAL_DIR, L2R, R2L } bidi_dir_t; |
| 1884 | |
| 1885 | /* Data type for storing information about characters we need to |
| 1886 | remember. */ |
| 1887 | struct bidi_saved_info { |
| 1888 | ptrdiff_t bytepos, charpos; /* character's buffer position */ |
| 1889 | bidi_type_t type; /* character's resolved bidi type */ |
| 1890 | bidi_type_t type_after_w1; /* original type of the character, after W1 */ |
| 1891 | bidi_type_t orig_type; /* type as we found it in the buffer */ |
| 1892 | }; |
| 1893 | |
| 1894 | /* Data type for keeping track of saved embedding levels and override |
| 1895 | status information. */ |
| 1896 | struct bidi_stack { |
| 1897 | int level; |
| 1898 | bidi_dir_t override; |
| 1899 | }; |
| 1900 | |
| 1901 | /* Data type for storing information about a string being iterated on. */ |
| 1902 | struct bidi_string_data { |
| 1903 | Lisp_Object lstring; /* Lisp string to reorder, or nil */ |
| 1904 | const unsigned char *s; /* string data, or NULL if reordering buffer */ |
| 1905 | ptrdiff_t schars; /* the number of characters in the string, |
| 1906 | excluding the terminating null */ |
| 1907 | ptrdiff_t bufpos; /* buffer position of lstring, or 0 if N/A */ |
| 1908 | unsigned from_disp_str : 1; /* 1 means the string comes from a |
| 1909 | display property */ |
| 1910 | unsigned unibyte : 1; /* 1 means the string is unibyte */ |
| 1911 | }; |
| 1912 | |
| 1913 | /* Data type for reordering bidirectional text. */ |
| 1914 | struct bidi_it { |
| 1915 | ptrdiff_t bytepos; /* iterator's position in buffer/string */ |
| 1916 | ptrdiff_t charpos; |
| 1917 | int ch; /* character at that position, or u+FFFC |
| 1918 | ("object replacement character") for a run |
| 1919 | of characters covered by a display string */ |
| 1920 | ptrdiff_t nchars; /* its "length", usually 1; it's > 1 for a run |
| 1921 | of characters covered by a display string */ |
| 1922 | ptrdiff_t ch_len; /* its length in bytes */ |
| 1923 | bidi_type_t type; /* bidi type of this character, after |
| 1924 | resolving weak and neutral types */ |
| 1925 | bidi_type_t type_after_w1; /* original type, after overrides and W1 */ |
| 1926 | bidi_type_t orig_type; /* original type, as found in the buffer */ |
| 1927 | int resolved_level; /* final resolved level of this character */ |
| 1928 | int invalid_levels; /* how many PDFs to ignore */ |
| 1929 | int invalid_rl_levels; /* how many PDFs from RLE/RLO to ignore */ |
| 1930 | struct bidi_saved_info prev; /* info about previous character */ |
| 1931 | struct bidi_saved_info last_strong; /* last-seen strong directional char */ |
| 1932 | struct bidi_saved_info next_for_neutral; /* surrounding characters for... */ |
| 1933 | struct bidi_saved_info prev_for_neutral; /* ...resolving neutrals */ |
| 1934 | struct bidi_saved_info next_for_ws; /* character after sequence of ws */ |
| 1935 | ptrdiff_t next_en_pos; /* pos. of next char for determining ET type */ |
| 1936 | bidi_type_t next_en_type; /* type of char at next_en_pos */ |
| 1937 | ptrdiff_t ignore_bn_limit; /* position until which to ignore BNs */ |
| 1938 | bidi_dir_t sor; /* direction of start-of-run in effect */ |
| 1939 | int scan_dir; /* direction of text scan, 1: forw, -1: back */ |
| 1940 | ptrdiff_t disp_pos; /* position of display string after ch */ |
| 1941 | int disp_prop; /* if non-zero, there really is a |
| 1942 | `display' property/string at disp_pos; |
| 1943 | if 2, the property is a `space' spec */ |
| 1944 | int stack_idx; /* index of current data on the stack */ |
| 1945 | /* Note: Everything from here on is not copied/saved when the bidi |
| 1946 | iterator state is saved, pushed, or popped. So only put here |
| 1947 | stuff that is not part of the bidi iterator's state! */ |
| 1948 | struct bidi_stack level_stack[BIDI_MAXLEVEL]; /* stack of embedding levels */ |
| 1949 | struct bidi_string_data string; /* string to reorder */ |
| 1950 | struct window *w; /* the window being displayed */ |
| 1951 | bidi_dir_t paragraph_dir; /* current paragraph direction */ |
| 1952 | ptrdiff_t separator_limit; /* where paragraph separator should end */ |
| 1953 | unsigned prev_was_pdf : 1; /* if non-zero, previous char was PDF */ |
| 1954 | unsigned first_elt : 1; /* if non-zero, examine current char first */ |
| 1955 | unsigned new_paragraph : 1; /* if non-zero, we expect a new paragraph */ |
| 1956 | unsigned frame_window_p : 1; /* non-zero if displaying on a GUI frame */ |
| 1957 | }; |
| 1958 | |
| 1959 | /* Value is non-zero when the bidi iterator is at base paragraph |
| 1960 | embedding level. */ |
| 1961 | #define BIDI_AT_BASE_LEVEL(BIDI_IT) \ |
| 1962 | ((BIDI_IT).resolved_level == (BIDI_IT).level_stack[0].level) |
| 1963 | |
| 1964 | \f |
| 1965 | /*********************************************************************** |
| 1966 | Fringes |
| 1967 | ***********************************************************************/ |
| 1968 | |
| 1969 | /* Structure used to describe where and how to draw a fringe bitmap. |
| 1970 | WHICH is the fringe bitmap to draw. WD and H is the (adjusted) |
| 1971 | width and height of the bitmap, DH is the height adjustment (if |
| 1972 | bitmap is periodic). X and Y are frame coordinates of the area to |
| 1973 | display the bitmap, DY is relative offset of the bitmap into that |
| 1974 | area. BX, NX, BY, NY specifies the area to clear if the bitmap |
| 1975 | does not fill the entire area. FACE is the fringe face. */ |
| 1976 | |
| 1977 | struct draw_fringe_bitmap_params |
| 1978 | { |
| 1979 | int which; /* enum fringe_bitmap_type */ |
| 1980 | unsigned short *bits; |
| 1981 | int wd, h, dh; |
| 1982 | int x, y; |
| 1983 | int bx, nx, by, ny; |
| 1984 | unsigned cursor_p : 1; |
| 1985 | unsigned overlay_p : 1; |
| 1986 | struct face *face; |
| 1987 | }; |
| 1988 | |
| 1989 | #define MAX_FRINGE_BITMAPS (1<<FRINGE_ID_BITS) |
| 1990 | |
| 1991 | \f |
| 1992 | /*********************************************************************** |
| 1993 | Display Iterator |
| 1994 | ***********************************************************************/ |
| 1995 | |
| 1996 | /* Iteration over things to display in current_buffer or in a string. |
| 1997 | |
| 1998 | The iterator handles: |
| 1999 | |
| 2000 | 1. Overlay strings (after-string, before-string). |
| 2001 | 2. Face properties. |
| 2002 | 3. Invisible text properties. |
| 2003 | 4. Selective display. |
| 2004 | 5. Translation of characters via display tables. |
| 2005 | 6. Translation of control characters to the forms `\003' or `^C'. |
| 2006 | 7. `glyph' and `space-width' properties. |
| 2007 | |
| 2008 | Iterators are initialized by calling init_iterator or one of the |
| 2009 | equivalent functions below. A call to get_next_display_element |
| 2010 | loads the iterator structure with information about what next to |
| 2011 | display. A call to set_iterator_to_next increments the iterator's |
| 2012 | position. |
| 2013 | |
| 2014 | Characters from overlay strings, display table entries or control |
| 2015 | character translations are returned one at a time. For example, if |
| 2016 | we have a text of `a\x01' where `a' has a display table definition |
| 2017 | of `cd' and the control character is displayed with a leading |
| 2018 | arrow, then the iterator will return: |
| 2019 | |
| 2020 | Call Return Source Call next |
| 2021 | ----------------------------------------------------------------- |
| 2022 | next c display table move |
| 2023 | next d display table move |
| 2024 | next ^ control char move |
| 2025 | next A control char move |
| 2026 | |
| 2027 | The same mechanism is also used to return characters for ellipses |
| 2028 | displayed at the end of invisible text. |
| 2029 | |
| 2030 | CAVEAT: Under some circumstances, move_.* functions can be called |
| 2031 | asynchronously, e.g. when computing a buffer position from an x and |
| 2032 | y pixel position. This means that these functions and functions |
| 2033 | called from them SHOULD NOT USE xmalloc and alike. See also the |
| 2034 | comment at the start of xdisp.c. */ |
| 2035 | |
| 2036 | /* Enumeration describing what kind of display element an iterator is |
| 2037 | loaded with after a call to get_next_display_element. */ |
| 2038 | |
| 2039 | enum display_element_type |
| 2040 | { |
| 2041 | /* A normal character. */ |
| 2042 | IT_CHARACTER, |
| 2043 | |
| 2044 | /* A composition (static and automatic). */ |
| 2045 | IT_COMPOSITION, |
| 2046 | |
| 2047 | /* A glyphless character (e.g. ZWNJ, LRE). */ |
| 2048 | IT_GLYPHLESS, |
| 2049 | |
| 2050 | /* An image. */ |
| 2051 | IT_IMAGE, |
| 2052 | |
| 2053 | /* A flexible width and height space. */ |
| 2054 | IT_STRETCH, |
| 2055 | |
| 2056 | /* End of buffer or string. */ |
| 2057 | IT_EOB, |
| 2058 | |
| 2059 | /* Truncation glyphs. Never returned by get_next_display_element. |
| 2060 | Used to get display information about truncation glyphs via |
| 2061 | produce_glyphs. */ |
| 2062 | IT_TRUNCATION, |
| 2063 | |
| 2064 | /* Continuation glyphs. See the comment for IT_TRUNCATION. */ |
| 2065 | IT_CONTINUATION |
| 2066 | }; |
| 2067 | |
| 2068 | |
| 2069 | /* An enumerator for each text property that has a meaning for display |
| 2070 | purposes. */ |
| 2071 | |
| 2072 | enum prop_idx |
| 2073 | { |
| 2074 | FONTIFIED_PROP_IDX, |
| 2075 | FACE_PROP_IDX, |
| 2076 | INVISIBLE_PROP_IDX, |
| 2077 | DISPLAY_PROP_IDX, |
| 2078 | COMPOSITION_PROP_IDX, |
| 2079 | |
| 2080 | /* Not a property. Used to indicate changes in overlays. */ |
| 2081 | OVERLAY_PROP_IDX, |
| 2082 | |
| 2083 | /* Sentinel. */ |
| 2084 | LAST_PROP_IDX |
| 2085 | }; |
| 2086 | |
| 2087 | /* An enumerator for the method of wrapping long lines. */ |
| 2088 | |
| 2089 | enum line_wrap_method |
| 2090 | { |
| 2091 | TRUNCATE, |
| 2092 | WORD_WRAP, |
| 2093 | WINDOW_WRAP |
| 2094 | }; |
| 2095 | |
| 2096 | /* An enumerator for the method of displaying glyphless characters. */ |
| 2097 | |
| 2098 | enum glyphless_display_method |
| 2099 | { |
| 2100 | /* Display a thin (1-pixel width) space. On a TTY, display a |
| 2101 | 1-character width space. */ |
| 2102 | GLYPHLESS_DISPLAY_THIN_SPACE, |
| 2103 | /* Display an empty box of proper width. */ |
| 2104 | GLYPHLESS_DISPLAY_EMPTY_BOX, |
| 2105 | /* Display an acronym string in a box. */ |
| 2106 | GLYPHLESS_DISPLAY_ACRONYM, |
| 2107 | /* Display the hexadecimal code of the character in a box. */ |
| 2108 | GLYPHLESS_DISPLAY_HEX_CODE |
| 2109 | }; |
| 2110 | |
| 2111 | struct it_slice |
| 2112 | { |
| 2113 | Lisp_Object x; |
| 2114 | Lisp_Object y; |
| 2115 | Lisp_Object width; |
| 2116 | Lisp_Object height; |
| 2117 | }; |
| 2118 | |
| 2119 | /* Input sources for fetching characters or data to display. |
| 2120 | The input source is found in the `method' field. */ |
| 2121 | |
| 2122 | enum it_method { |
| 2123 | GET_FROM_BUFFER = 0, |
| 2124 | GET_FROM_DISPLAY_VECTOR, |
| 2125 | GET_FROM_STRING, |
| 2126 | GET_FROM_C_STRING, |
| 2127 | GET_FROM_IMAGE, |
| 2128 | GET_FROM_STRETCH, |
| 2129 | NUM_IT_METHODS |
| 2130 | }; |
| 2131 | |
| 2132 | /* FIXME: What is this? Why 5? */ |
| 2133 | #define IT_STACK_SIZE 5 |
| 2134 | |
| 2135 | /* Iterator for composition (both for static and automatic). */ |
| 2136 | struct composition_it |
| 2137 | { |
| 2138 | /* Next position at which to check the composition. */ |
| 2139 | ptrdiff_t stop_pos; |
| 2140 | /* ID number of the composition or glyph-string. If negative, we |
| 2141 | are not iterating over a composition now. */ |
| 2142 | ptrdiff_t id; |
| 2143 | /* If non-negative, character that triggers the automatic |
| 2144 | composition at `stop_pos', and this is an automatic composition. |
| 2145 | If negative, this is a static composition. This is set to -2 |
| 2146 | temporarily if searching of composition reach a limit or a |
| 2147 | newline. */ |
| 2148 | int ch; |
| 2149 | /* If this is an automatic composition, index of a rule for making |
| 2150 | the automatic composition. Provided that ELT is an element of |
| 2151 | Vcomposition_function_table for CH, (nth ELT RULE_IDX) is the |
| 2152 | rule for the composition. */ |
| 2153 | int rule_idx; |
| 2154 | /* If this is an automatic composition, how many characters to look |
| 2155 | back from the position where a character triggering the |
| 2156 | composition exists. */ |
| 2157 | ptrdiff_t lookback; |
| 2158 | /* If non-negative, number of glyphs of the glyph-string. */ |
| 2159 | int nglyphs; |
| 2160 | /* True iff the composition is created while buffer is scanned in |
| 2161 | reverse order, and thus the grapheme clusters must be rendered |
| 2162 | from the last to the first. */ |
| 2163 | bool reversed_p; |
| 2164 | |
| 2165 | /** The following members contain information about the current |
| 2166 | grapheme cluster. */ |
| 2167 | /* Position of the first character of the current grapheme cluster. */ |
| 2168 | ptrdiff_t charpos; |
| 2169 | /* Number of characters and bytes of the current grapheme cluster. */ |
| 2170 | int nchars, nbytes; |
| 2171 | /* Indices of the glyphs for the current grapheme cluster. */ |
| 2172 | int from, to; |
| 2173 | /* Width of the current grapheme cluster in units of pixels on a |
| 2174 | graphic display and in units of canonical characters on a |
| 2175 | terminal display. */ |
| 2176 | int width; |
| 2177 | }; |
| 2178 | |
| 2179 | struct it |
| 2180 | { |
| 2181 | /* The window in which we iterate over current_buffer (or a string). */ |
| 2182 | Lisp_Object window; |
| 2183 | struct window *w; |
| 2184 | |
| 2185 | /* The window's frame. */ |
| 2186 | struct frame *f; |
| 2187 | |
| 2188 | /* Method to use to load this structure with the next display element. */ |
| 2189 | enum it_method method; |
| 2190 | |
| 2191 | /* The next position at which to check for face changes, invisible |
| 2192 | text, overlay strings, end of text etc., which see. */ |
| 2193 | ptrdiff_t stop_charpos; |
| 2194 | |
| 2195 | /* Previous stop position, i.e. the last one before the current |
| 2196 | iterator position in `current'. */ |
| 2197 | ptrdiff_t prev_stop; |
| 2198 | |
| 2199 | /* Last stop position iterated across whose bidi embedding level is |
| 2200 | equal to the current paragraph's base embedding level. */ |
| 2201 | ptrdiff_t base_level_stop; |
| 2202 | |
| 2203 | /* Maximum string or buffer position + 1. ZV when iterating over |
| 2204 | current_buffer. */ |
| 2205 | ptrdiff_t end_charpos; |
| 2206 | |
| 2207 | /* C string to iterate over. Non-null means get characters from |
| 2208 | this string, otherwise characters are read from current_buffer |
| 2209 | or it->string. */ |
| 2210 | const unsigned char *s; |
| 2211 | |
| 2212 | /* Number of characters in the string (s, or it->string) we iterate |
| 2213 | over. Used only in display_string and its subroutines; never |
| 2214 | used for overlay strings and strings from display properties. */ |
| 2215 | ptrdiff_t string_nchars; |
| 2216 | |
| 2217 | /* Start and end of a visible region; -1 if the region is not |
| 2218 | visible in the window. */ |
| 2219 | ptrdiff_t region_beg_charpos, region_end_charpos; |
| 2220 | |
| 2221 | /* Position at which redisplay end trigger functions should be run. */ |
| 2222 | ptrdiff_t redisplay_end_trigger_charpos; |
| 2223 | |
| 2224 | /* 1 means multibyte characters are enabled. */ |
| 2225 | unsigned multibyte_p : 1; |
| 2226 | |
| 2227 | /* 1 means window has a mode line at its top. */ |
| 2228 | unsigned header_line_p : 1; |
| 2229 | |
| 2230 | /* 1 means `string' is the value of a `display' property. |
| 2231 | Don't handle some `display' properties in these strings. */ |
| 2232 | unsigned string_from_display_prop_p : 1; |
| 2233 | |
| 2234 | /* 1 means `string' comes from a `line-prefix' or `wrap-prefix' |
| 2235 | property. */ |
| 2236 | unsigned string_from_prefix_prop_p : 1; |
| 2237 | |
| 2238 | /* 1 means we are iterating an object that came from a value of a |
| 2239 | `display' property. */ |
| 2240 | unsigned from_disp_prop_p : 1; |
| 2241 | |
| 2242 | /* When METHOD == next_element_from_display_vector, |
| 2243 | this is 1 if we're doing an ellipsis. Otherwise meaningless. */ |
| 2244 | unsigned ellipsis_p : 1; |
| 2245 | |
| 2246 | /* True means cursor shouldn't be displayed here. */ |
| 2247 | unsigned avoid_cursor_p : 1; |
| 2248 | |
| 2249 | /* Display table in effect or null for none. */ |
| 2250 | struct Lisp_Char_Table *dp; |
| 2251 | |
| 2252 | /* Current display table vector to return characters from and its |
| 2253 | end. dpvec null means we are not returning characters from a |
| 2254 | display table entry; current.dpvec_index gives the current index |
| 2255 | into dpvec. This same mechanism is also used to return |
| 2256 | characters from translated control characters, i.e. `\003' or |
| 2257 | `^C'. */ |
| 2258 | Lisp_Object *dpvec, *dpend; |
| 2259 | |
| 2260 | /* Length in bytes of the char that filled dpvec. A value of zero |
| 2261 | means that no such character is involved. A negative value means |
| 2262 | the rest of the line from the current iterator position onwards |
| 2263 | is hidden by selective display or ellipsis. */ |
| 2264 | int dpvec_char_len; |
| 2265 | |
| 2266 | /* Face id to use for all characters in display vector. -1 if unused. */ |
| 2267 | int dpvec_face_id; |
| 2268 | |
| 2269 | /* Face id of the iterator saved in case a glyph from dpvec contains |
| 2270 | a face. The face is restored when all glyphs from dpvec have |
| 2271 | been delivered. */ |
| 2272 | int saved_face_id; |
| 2273 | |
| 2274 | /* Vector of glyphs for control character translation. The pointer |
| 2275 | dpvec is set to ctl_chars when a control character is translated. |
| 2276 | This vector is also used for incomplete multibyte character |
| 2277 | translation (e.g \222\244). Such a character is at most 4 bytes, |
| 2278 | thus we need at most 16 bytes here. */ |
| 2279 | Lisp_Object ctl_chars[16]; |
| 2280 | |
| 2281 | /* Initial buffer or string position of the iterator, before skipping |
| 2282 | over display properties and invisible text. */ |
| 2283 | struct display_pos start; |
| 2284 | |
| 2285 | /* Current buffer or string position of the iterator, including |
| 2286 | position in overlay strings etc. */ |
| 2287 | struct display_pos current; |
| 2288 | |
| 2289 | /* Total number of overlay strings to process. This can be > |
| 2290 | OVERLAY_STRING_CHUNK_SIZE. Value is dependable only when |
| 2291 | current.overlay_string_index >= 0. Use the latter to determine |
| 2292 | whether an overlay string is being iterated over, because |
| 2293 | n_overlay_strings can be positive even when we are not rendering |
| 2294 | an overlay string. */ |
| 2295 | ptrdiff_t n_overlay_strings; |
| 2296 | |
| 2297 | /* The charpos where n_overlay_strings was calculated. This should |
| 2298 | be set at the same time as n_overlay_strings. It is needed |
| 2299 | because we show before-strings at the start of invisible text; |
| 2300 | see handle_invisible_prop in xdisp.c. */ |
| 2301 | ptrdiff_t overlay_strings_charpos; |
| 2302 | |
| 2303 | /* Vector of overlays to process. Overlay strings are processed |
| 2304 | OVERLAY_STRING_CHUNK_SIZE at a time. */ |
| 2305 | #define OVERLAY_STRING_CHUNK_SIZE 16 |
| 2306 | Lisp_Object overlay_strings[OVERLAY_STRING_CHUNK_SIZE]; |
| 2307 | |
| 2308 | /* For each overlay string, the overlay it came from. */ |
| 2309 | Lisp_Object string_overlays[OVERLAY_STRING_CHUNK_SIZE]; |
| 2310 | |
| 2311 | /* If non-nil, a Lisp string being processed. If |
| 2312 | current.overlay_string_index >= 0, this is an overlay string from |
| 2313 | pos. Use STRINGP (it.string) to test whether we are rendering a |
| 2314 | string or something else; do NOT use BUFFERP (it.object). */ |
| 2315 | Lisp_Object string; |
| 2316 | |
| 2317 | /* If non-nil, we are processing a string that came |
| 2318 | from a `display' property given by an overlay. */ |
| 2319 | Lisp_Object from_overlay; |
| 2320 | |
| 2321 | /* Stack of saved values. New entries are pushed when we begin to |
| 2322 | process an overlay string or a string from a `glyph' property. |
| 2323 | Entries are popped when we return to deliver display elements |
| 2324 | from what we previously had. */ |
| 2325 | struct iterator_stack_entry |
| 2326 | { |
| 2327 | Lisp_Object string; |
| 2328 | int string_nchars; |
| 2329 | ptrdiff_t end_charpos; |
| 2330 | ptrdiff_t stop_charpos; |
| 2331 | ptrdiff_t prev_stop; |
| 2332 | ptrdiff_t base_level_stop; |
| 2333 | struct composition_it cmp_it; |
| 2334 | int face_id; |
| 2335 | |
| 2336 | /* Save values specific to a given method. */ |
| 2337 | union { |
| 2338 | /* method == GET_FROM_IMAGE */ |
| 2339 | struct { |
| 2340 | Lisp_Object object; |
| 2341 | struct it_slice slice; |
| 2342 | ptrdiff_t image_id; |
| 2343 | } image; |
| 2344 | /* method == GET_FROM_COMPOSITION */ |
| 2345 | struct { |
| 2346 | Lisp_Object object; |
| 2347 | } comp; |
| 2348 | /* method == GET_FROM_STRETCH */ |
| 2349 | struct { |
| 2350 | Lisp_Object object; |
| 2351 | } stretch; |
| 2352 | } u; |
| 2353 | |
| 2354 | /* current text and display positions. */ |
| 2355 | struct text_pos position; |
| 2356 | struct display_pos current; |
| 2357 | Lisp_Object from_overlay; |
| 2358 | enum glyph_row_area area; |
| 2359 | enum it_method method; |
| 2360 | bidi_dir_t paragraph_embedding; |
| 2361 | unsigned multibyte_p : 1; |
| 2362 | unsigned string_from_display_prop_p : 1; |
| 2363 | unsigned string_from_prefix_prop_p : 1; |
| 2364 | unsigned display_ellipsis_p : 1; |
| 2365 | unsigned avoid_cursor_p : 1; |
| 2366 | unsigned bidi_p:1; |
| 2367 | unsigned from_disp_prop_p : 1; |
| 2368 | enum line_wrap_method line_wrap; |
| 2369 | |
| 2370 | /* properties from display property that are reset by another display property. */ |
| 2371 | short voffset; |
| 2372 | Lisp_Object space_width; |
| 2373 | Lisp_Object font_height; |
| 2374 | } |
| 2375 | stack[IT_STACK_SIZE]; |
| 2376 | |
| 2377 | /* Stack pointer. */ |
| 2378 | int sp; |
| 2379 | |
| 2380 | /* -1 means selective display hides everything between a \r and the |
| 2381 | next newline; > 0 means hide lines indented more than that value. */ |
| 2382 | ptrdiff_t selective; |
| 2383 | |
| 2384 | /* An enumeration describing what the next display element is |
| 2385 | after a call to get_next_display_element. */ |
| 2386 | enum display_element_type what; |
| 2387 | |
| 2388 | /* Face to use. */ |
| 2389 | int face_id; |
| 2390 | |
| 2391 | /* Setting of buffer-local variable selective-display-ellipsis. */ |
| 2392 | unsigned selective_display_ellipsis_p : 1; |
| 2393 | |
| 2394 | /* 1 means control characters are translated into the form `^C' |
| 2395 | where the `^' can be replaced by a display table entry. */ |
| 2396 | unsigned ctl_arrow_p : 1; |
| 2397 | |
| 2398 | /* Non-zero means that the current face has a box. */ |
| 2399 | unsigned face_box_p : 1; |
| 2400 | |
| 2401 | /* Non-null means that the current character is the first in a run |
| 2402 | of characters with box face. */ |
| 2403 | unsigned start_of_box_run_p : 1; |
| 2404 | |
| 2405 | /* Non-zero means that the current character is the last in a run |
| 2406 | of characters with box face. */ |
| 2407 | unsigned end_of_box_run_p : 1; |
| 2408 | |
| 2409 | /* 1 means overlay strings at end_charpos have been processed. */ |
| 2410 | unsigned overlay_strings_at_end_processed_p : 1; |
| 2411 | |
| 2412 | /* 1 means to ignore overlay strings at current pos, as they have |
| 2413 | already been processed. */ |
| 2414 | unsigned ignore_overlay_strings_at_pos_p : 1; |
| 2415 | |
| 2416 | /* 1 means the actual glyph is not available in the current |
| 2417 | system. */ |
| 2418 | unsigned glyph_not_available_p : 1; |
| 2419 | |
| 2420 | /* 1 means the next line in display_line continues a character |
| 2421 | consisting of more than one glyph, and some glyphs of this |
| 2422 | character have been put on the previous line. */ |
| 2423 | unsigned starts_in_middle_of_char_p : 1; |
| 2424 | |
| 2425 | /* If 1, saved_face_id contains the id of the face in front of text |
| 2426 | skipped due to selective display. */ |
| 2427 | unsigned face_before_selective_p : 1; |
| 2428 | |
| 2429 | /* If 1, adjust current glyph so it does not increase current row |
| 2430 | descent/ascent (line-height property). Reset after this glyph. */ |
| 2431 | unsigned constrain_row_ascent_descent_p : 1; |
| 2432 | |
| 2433 | enum line_wrap_method line_wrap; |
| 2434 | |
| 2435 | /* The ID of the default face to use. One of DEFAULT_FACE_ID, |
| 2436 | MODE_LINE_FACE_ID, etc, depending on what we are displaying. */ |
| 2437 | int base_face_id; |
| 2438 | |
| 2439 | /* If `what' == IT_CHARACTER, the character and the length in bytes |
| 2440 | of its multibyte sequence. The character comes from a buffer or |
| 2441 | a string. It may be different from the character displayed in |
| 2442 | case that unibyte_display_via_language_environment is set. |
| 2443 | |
| 2444 | If `what' == IT_COMPOSITION, the first component of a composition |
| 2445 | and length in bytes of the composition. |
| 2446 | |
| 2447 | If `what' is anything else, these two are undefined (will |
| 2448 | probably hold values for the last IT_CHARACTER or IT_COMPOSITION |
| 2449 | traversed by the iterator. |
| 2450 | |
| 2451 | The values are updated by get_next_display_element, so they are |
| 2452 | out of sync with the value returned by IT_CHARPOS between the |
| 2453 | time set_iterator_to_next advances the position and the time |
| 2454 | get_next_display_element loads the new values into c and len. */ |
| 2455 | int c, len; |
| 2456 | |
| 2457 | /* If what == IT_COMPOSITION, iterator substructure for the |
| 2458 | composition. */ |
| 2459 | struct composition_it cmp_it; |
| 2460 | |
| 2461 | /* The character to display, possibly translated to multibyte if |
| 2462 | multibyte_p is zero or unibyte_display_via_language_environment |
| 2463 | is set. This is set after get_next_display_element has been |
| 2464 | called. If we are setting it->C directly before calling |
| 2465 | PRODUCE_GLYPHS, this should be set beforehand too. */ |
| 2466 | int char_to_display; |
| 2467 | |
| 2468 | /* If what == IT_GLYPHLESS, the method to display such a |
| 2469 | character. */ |
| 2470 | enum glyphless_display_method glyphless_method; |
| 2471 | |
| 2472 | /* If what == IT_IMAGE, the id of the image to display. */ |
| 2473 | ptrdiff_t image_id; |
| 2474 | |
| 2475 | /* Values from `slice' property. */ |
| 2476 | struct it_slice slice; |
| 2477 | |
| 2478 | /* Value of the `space-width' property, if any; nil if none. */ |
| 2479 | Lisp_Object space_width; |
| 2480 | |
| 2481 | /* Computed from the value of the `raise' property. */ |
| 2482 | short voffset; |
| 2483 | |
| 2484 | /* Number of columns per \t. */ |
| 2485 | short tab_width; |
| 2486 | |
| 2487 | /* Value of the `height' property, if any; nil if none. */ |
| 2488 | Lisp_Object font_height; |
| 2489 | |
| 2490 | /* Object and position where the current display element came from. |
| 2491 | Object is normally the buffer which is being rendered, but it can |
| 2492 | also be a Lisp string in case the current display element comes |
| 2493 | from an overlay string or from a display string (before- or |
| 2494 | after-string). It may also be nil when a C string is being |
| 2495 | rendered, e.g., during mode-line or header-line update. It can |
| 2496 | also be a cons cell of the form `(space ...)', when we produce a |
| 2497 | stretch glyph from a `display' specification. Finally, it can be |
| 2498 | a zero-valued Lisp integer, but only temporarily, when we are |
| 2499 | producing special glyphs for display purposes, like truncation |
| 2500 | and continuation glyphs, or blanks that extend each line to the |
| 2501 | edge of the window on a TTY. |
| 2502 | |
| 2503 | Do NOT use !BUFFERP (it.object) as a test whether we are |
| 2504 | iterating over a string; use STRINGP (it.string) instead. |
| 2505 | |
| 2506 | Position is the current iterator position in object. */ |
| 2507 | Lisp_Object object; |
| 2508 | struct text_pos position; |
| 2509 | |
| 2510 | /* Width in pixels of truncation and continuation glyphs. */ |
| 2511 | short truncation_pixel_width, continuation_pixel_width; |
| 2512 | |
| 2513 | /* First and last visible x-position in the display area. If window |
| 2514 | is hscrolled by n columns, first_visible_x == n * FRAME_COLUMN_WIDTH |
| 2515 | (f), and last_visible_x == pixel width of W + first_visible_x. */ |
| 2516 | int first_visible_x, last_visible_x; |
| 2517 | |
| 2518 | /* Last visible y-position + 1 in the display area without a mode |
| 2519 | line, if the window has one. */ |
| 2520 | int last_visible_y; |
| 2521 | |
| 2522 | /* Default amount of additional space in pixels between lines (for |
| 2523 | window systems only.) */ |
| 2524 | int extra_line_spacing; |
| 2525 | |
| 2526 | /* Max extra line spacing added in this row. */ |
| 2527 | int max_extra_line_spacing; |
| 2528 | |
| 2529 | /* Override font height information for this glyph. |
| 2530 | Used if override_ascent >= 0. Cleared after this glyph. */ |
| 2531 | int override_ascent, override_descent, override_boff; |
| 2532 | |
| 2533 | /* If non-null, glyphs are produced in glyph_row with each call to |
| 2534 | produce_glyphs. */ |
| 2535 | struct glyph_row *glyph_row; |
| 2536 | |
| 2537 | /* The area of glyph_row to which glyphs are added. */ |
| 2538 | enum glyph_row_area area; |
| 2539 | |
| 2540 | /* Number of glyphs needed for the last character requested via |
| 2541 | produce_glyphs. This is 1 except for tabs. */ |
| 2542 | int nglyphs; |
| 2543 | |
| 2544 | /* Width of the display element in pixels. Result of |
| 2545 | produce_glyphs. */ |
| 2546 | int pixel_width; |
| 2547 | |
| 2548 | /* Current, maximum logical, and maximum physical line height |
| 2549 | information. Result of produce_glyphs. */ |
| 2550 | int ascent, descent, max_ascent, max_descent; |
| 2551 | int phys_ascent, phys_descent, max_phys_ascent, max_phys_descent; |
| 2552 | |
| 2553 | /* Current x pixel position within the display line. This value |
| 2554 | does not include the width of continuation lines in front of the |
| 2555 | line. The value of current_x is automatically incremented by |
| 2556 | pixel_width with each call to produce_glyphs. */ |
| 2557 | int current_x; |
| 2558 | |
| 2559 | /* Accumulated width of continuation lines. If > 0, this means we |
| 2560 | are currently in a continuation line. This is initially zero and |
| 2561 | incremented/reset by display_line, move_it_to etc. */ |
| 2562 | int continuation_lines_width; |
| 2563 | |
| 2564 | /* Buffer position that ends the buffer text line being iterated. |
| 2565 | This is normally the position after the newline at EOL. If this |
| 2566 | is the last line of the buffer and it doesn't have a newline, |
| 2567 | value is ZV/ZV_BYTE. Set and used only if IT->bidi_p, for |
| 2568 | setting the end position of glyph rows produced for continuation |
| 2569 | lines, see display_line. */ |
| 2570 | struct text_pos eol_pos; |
| 2571 | |
| 2572 | /* Current y-position. Automatically incremented by the height of |
| 2573 | glyph_row in move_it_to and display_line. */ |
| 2574 | int current_y; |
| 2575 | |
| 2576 | /* Vertical matrix position of first text line in window. */ |
| 2577 | int first_vpos; |
| 2578 | |
| 2579 | /* Current vertical matrix position, or line number. Automatically |
| 2580 | incremented by move_it_to and display_line. */ |
| 2581 | int vpos; |
| 2582 | |
| 2583 | /* Horizontal matrix position reached in move_it_in_display_line. |
| 2584 | Only set there, not in display_line. */ |
| 2585 | int hpos; |
| 2586 | |
| 2587 | /* Left fringe bitmap number (enum fringe_bitmap_type). */ |
| 2588 | unsigned left_user_fringe_bitmap : FRINGE_ID_BITS; |
| 2589 | |
| 2590 | /* Right fringe bitmap number (enum fringe_bitmap_type). */ |
| 2591 | unsigned right_user_fringe_bitmap : FRINGE_ID_BITS; |
| 2592 | |
| 2593 | /* Face of the left fringe glyph. */ |
| 2594 | unsigned left_user_fringe_face_id : FACE_ID_BITS; |
| 2595 | |
| 2596 | /* Face of the right fringe glyph. */ |
| 2597 | unsigned right_user_fringe_face_id : FACE_ID_BITS; |
| 2598 | |
| 2599 | /* Non-zero means we need to reorder bidirectional text for display |
| 2600 | in the visual order. */ |
| 2601 | unsigned bidi_p : 1; |
| 2602 | |
| 2603 | /* For iterating over bidirectional text. */ |
| 2604 | struct bidi_it bidi_it; |
| 2605 | bidi_dir_t paragraph_embedding; |
| 2606 | }; |
| 2607 | |
| 2608 | |
| 2609 | /* Access to positions of iterator IT. */ |
| 2610 | |
| 2611 | #define IT_CHARPOS(IT) CHARPOS ((IT).current.pos) |
| 2612 | #define IT_BYTEPOS(IT) BYTEPOS ((IT).current.pos) |
| 2613 | #define IT_STRING_CHARPOS(IT) CHARPOS ((IT).current.string_pos) |
| 2614 | #define IT_STRING_BYTEPOS(IT) BYTEPOS ((IT).current.string_pos) |
| 2615 | |
| 2616 | /* Test if IT has reached the end of its buffer or string. This will |
| 2617 | only work after get_next_display_element has been called. */ |
| 2618 | |
| 2619 | #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB) |
| 2620 | |
| 2621 | /* Non-zero means IT is at the end of a line. This is the case if it |
| 2622 | is either on a newline or on a carriage return and selective |
| 2623 | display hides the rest of the line. */ |
| 2624 | |
| 2625 | #define ITERATOR_AT_END_OF_LINE_P(IT) \ |
| 2626 | ((IT)->what == IT_CHARACTER \ |
| 2627 | && ((IT)->c == '\n' \ |
| 2628 | || ((IT)->c == '\r' && (IT)->selective))) |
| 2629 | |
| 2630 | /* Call produce_glyphs or FRAME_RIF->produce_glyphs, if set. Shortcut |
| 2631 | to avoid the function call overhead. */ |
| 2632 | |
| 2633 | #define PRODUCE_GLYPHS(IT) \ |
| 2634 | do { \ |
| 2635 | if ((IT)->glyph_row != NULL && (IT)->bidi_p) \ |
| 2636 | { \ |
| 2637 | if ((IT)->bidi_it.paragraph_dir == R2L) \ |
| 2638 | (IT)->glyph_row->reversed_p = 1; \ |
| 2639 | else \ |
| 2640 | (IT)->glyph_row->reversed_p = 0; \ |
| 2641 | } \ |
| 2642 | if (FRAME_RIF ((IT)->f) != NULL) \ |
| 2643 | FRAME_RIF ((IT)->f)->produce_glyphs ((IT)); \ |
| 2644 | else \ |
| 2645 | produce_glyphs ((IT)); \ |
| 2646 | if ((IT)->glyph_row != NULL) \ |
| 2647 | inhibit_free_realized_faces = 1; \ |
| 2648 | } while (0) |
| 2649 | |
| 2650 | /* Bit-flags indicating what operation move_it_to should perform. */ |
| 2651 | |
| 2652 | enum move_operation_enum |
| 2653 | { |
| 2654 | /* Stop if specified x-position is reached. */ |
| 2655 | MOVE_TO_X = 0x01, |
| 2656 | |
| 2657 | /* Stop if specified y-position is reached. */ |
| 2658 | MOVE_TO_Y = 0x02, |
| 2659 | |
| 2660 | /* Stop if specified vpos is reached. */ |
| 2661 | MOVE_TO_VPOS = 0x04, |
| 2662 | |
| 2663 | /* Stop if specified buffer or string position is reached. */ |
| 2664 | MOVE_TO_POS = 0x08 |
| 2665 | }; |
| 2666 | |
| 2667 | /*********************************************************************** |
| 2668 | Mouse Highlight |
| 2669 | ***********************************************************************/ |
| 2670 | |
| 2671 | /* Structure to hold mouse highlight data. */ |
| 2672 | |
| 2673 | typedef struct { |
| 2674 | /* These variables describe the range of text currently shown in its |
| 2675 | mouse-face, together with the window they apply to. As long as |
| 2676 | the mouse stays within this range, we need not redraw anything on |
| 2677 | its account. Rows and columns are glyph matrix positions in |
| 2678 | MOUSE_FACE_WINDOW. */ |
| 2679 | int mouse_face_beg_row, mouse_face_beg_col, mouse_face_beg_x; |
| 2680 | int mouse_face_end_row, mouse_face_end_col, mouse_face_end_x; |
| 2681 | Lisp_Object mouse_face_window; |
| 2682 | int mouse_face_face_id; |
| 2683 | Lisp_Object mouse_face_overlay; |
| 2684 | |
| 2685 | /* FRAME and X, Y position of mouse when last checked for |
| 2686 | highlighting. X and Y can be negative or out of range for the frame. */ |
| 2687 | struct frame *mouse_face_mouse_frame; |
| 2688 | int mouse_face_mouse_x, mouse_face_mouse_y; |
| 2689 | |
| 2690 | /* Nonzero if part of the text currently shown in |
| 2691 | its mouse-face is beyond the window end. */ |
| 2692 | unsigned mouse_face_past_end : 1; |
| 2693 | |
| 2694 | /* Nonzero means defer mouse-motion highlighting. */ |
| 2695 | unsigned mouse_face_defer : 1; |
| 2696 | |
| 2697 | /* Nonzero means that the mouse highlight should not be shown. */ |
| 2698 | unsigned mouse_face_hidden : 1; |
| 2699 | } Mouse_HLInfo; |
| 2700 | |
| 2701 | INLINE void |
| 2702 | reset_mouse_highlight (Mouse_HLInfo *hlinfo) |
| 2703 | { |
| 2704 | |
| 2705 | hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1; |
| 2706 | hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1; |
| 2707 | hlinfo->mouse_face_mouse_x = hlinfo->mouse_face_mouse_y = 0; |
| 2708 | hlinfo->mouse_face_beg_x = hlinfo->mouse_face_end_x = 0; |
| 2709 | hlinfo->mouse_face_face_id = DEFAULT_FACE_ID; |
| 2710 | hlinfo->mouse_face_mouse_frame = NULL; |
| 2711 | hlinfo->mouse_face_window = Qnil; |
| 2712 | hlinfo->mouse_face_overlay = Qnil; |
| 2713 | hlinfo->mouse_face_past_end = 0; |
| 2714 | hlinfo->mouse_face_hidden = 0; |
| 2715 | hlinfo->mouse_face_defer = 0; |
| 2716 | } |
| 2717 | |
| 2718 | /*********************************************************************** |
| 2719 | Window-based redisplay interface |
| 2720 | ***********************************************************************/ |
| 2721 | |
| 2722 | /* Structure used to describe runs of lines that must be scrolled. */ |
| 2723 | |
| 2724 | struct run |
| 2725 | { |
| 2726 | /* Source and destination y pixel position. */ |
| 2727 | int desired_y, current_y; |
| 2728 | |
| 2729 | /* Source and destination vpos in matrix. */ |
| 2730 | int desired_vpos, current_vpos; |
| 2731 | |
| 2732 | /* Height in pixels, number of glyph rows. */ |
| 2733 | int height, nrows; |
| 2734 | }; |
| 2735 | |
| 2736 | |
| 2737 | /* Handlers for setting frame parameters. */ |
| 2738 | |
| 2739 | typedef void (*frame_parm_handler) (struct frame *, Lisp_Object, Lisp_Object); |
| 2740 | |
| 2741 | |
| 2742 | /* Structure holding system-dependent interface functions needed |
| 2743 | for window-based redisplay. */ |
| 2744 | |
| 2745 | struct redisplay_interface |
| 2746 | { |
| 2747 | /* Handlers for setting frame parameters. */ |
| 2748 | frame_parm_handler *frame_parm_handlers; |
| 2749 | |
| 2750 | /* Produce glyphs/get display metrics for the display element IT is |
| 2751 | loaded with. */ |
| 2752 | void (*produce_glyphs) (struct it *it); |
| 2753 | |
| 2754 | /* Write or insert LEN glyphs from STRING at the nominal output |
| 2755 | position. */ |
| 2756 | void (*write_glyphs) (struct window *w, struct glyph_row *row, |
| 2757 | struct glyph *string, enum glyph_row_area area, |
| 2758 | int len); |
| 2759 | void (*insert_glyphs) (struct window *w, struct glyph_row *row, |
| 2760 | struct glyph *start, enum glyph_row_area area, |
| 2761 | int len); |
| 2762 | |
| 2763 | /* Clear from nominal output position to X. X < 0 means clear |
| 2764 | to right end of display. */ |
| 2765 | void (*clear_end_of_line) (struct window *w, struct glyph_row *row, |
| 2766 | enum glyph_row_area area, int x); |
| 2767 | |
| 2768 | /* Function to call to scroll the display as described by RUN on |
| 2769 | window W. */ |
| 2770 | void (*scroll_run_hook) (struct window *w, struct run *run); |
| 2771 | |
| 2772 | /* Function to call after a line in a display has been completely |
| 2773 | updated. Used to draw truncation marks and alike. DESIRED_ROW |
| 2774 | is the desired row which has been updated. */ |
| 2775 | void (*after_update_window_line_hook) (struct window *w, |
| 2776 | struct glyph_row *desired_row); |
| 2777 | |
| 2778 | /* Function to call before beginning to update window W in |
| 2779 | window-based redisplay. */ |
| 2780 | void (*update_window_begin_hook) (struct window *w); |
| 2781 | |
| 2782 | /* Function to call after window W has been updated in window-based |
| 2783 | redisplay. CURSOR_ON_P non-zero means switch cursor on. |
| 2784 | MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W |
| 2785 | that contained glyphs in mouse-face were overwritten, so we |
| 2786 | have to update the mouse highlight. */ |
| 2787 | void (*update_window_end_hook) (struct window *w, bool cursor_on_p, |
| 2788 | bool mouse_face_overwritten_p); |
| 2789 | |
| 2790 | /* Flush the display of frame F. For X, this is XFlush. */ |
| 2791 | void (*flush_display) (struct frame *f); |
| 2792 | |
| 2793 | /* Clear the mouse highlight in window W, if there is any. */ |
| 2794 | void (*clear_window_mouse_face) (struct window *w); |
| 2795 | |
| 2796 | /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on |
| 2797 | frame F. */ |
| 2798 | void (*get_glyph_overhangs) (struct glyph *glyph, struct frame *f, |
| 2799 | int *left, int *right); |
| 2800 | |
| 2801 | /* Fix the display of AREA of ROW in window W for overlapping rows. |
| 2802 | This function is called from redraw_overlapping_rows after |
| 2803 | desired rows have been made current. */ |
| 2804 | void (*fix_overlapping_area) (struct window *w, struct glyph_row *row, |
| 2805 | enum glyph_row_area area, int); |
| 2806 | |
| 2807 | #ifdef HAVE_WINDOW_SYSTEM |
| 2808 | |
| 2809 | /* Draw a fringe bitmap in window W of row ROW using parameters P. */ |
| 2810 | void (*draw_fringe_bitmap) (struct window *w, struct glyph_row *row, |
| 2811 | struct draw_fringe_bitmap_params *p); |
| 2812 | |
| 2813 | /* Define and destroy fringe bitmap no. WHICH. */ |
| 2814 | void (*define_fringe_bitmap) (int which, unsigned short *bits, |
| 2815 | int h, int wd); |
| 2816 | void (*destroy_fringe_bitmap) (int which); |
| 2817 | |
| 2818 | /* Compute left and right overhang of glyph string S. |
| 2819 | A NULL pointer if platform does not support this. */ |
| 2820 | void (*compute_glyph_string_overhangs) (struct glyph_string *s); |
| 2821 | |
| 2822 | /* Draw a glyph string S. */ |
| 2823 | void (*draw_glyph_string) (struct glyph_string *s); |
| 2824 | |
| 2825 | /* Define cursor CURSOR on frame F. */ |
| 2826 | void (*define_frame_cursor) (struct frame *f, Cursor cursor); |
| 2827 | |
| 2828 | /* Clear the area at (X,Y,WIDTH,HEIGHT) of frame F. */ |
| 2829 | void (*clear_frame_area) (struct frame *f, int x, int y, |
| 2830 | int width, int height); |
| 2831 | |
| 2832 | /* Draw specified cursor CURSOR_TYPE of width CURSOR_WIDTH |
| 2833 | at row GLYPH_ROW on window W if ON_P is 1. If ON_P is |
| 2834 | 0, don't draw cursor. If ACTIVE_P is 1, system caret |
| 2835 | should track this cursor (when applicable). */ |
| 2836 | void (*draw_window_cursor) (struct window *w, |
| 2837 | struct glyph_row *glyph_row, |
| 2838 | int x, int y, |
| 2839 | enum text_cursor_kinds cursor_type, |
| 2840 | int cursor_width, bool on_p, bool active_p); |
| 2841 | |
| 2842 | /* Draw vertical border for window W from (X,Y_0) to (X,Y_1). */ |
| 2843 | void (*draw_vertical_window_border) (struct window *w, |
| 2844 | int x, int y_0, int y_1); |
| 2845 | |
| 2846 | /* Shift display of frame F to make room for inserted glyphs. |
| 2847 | The area at pixel (X,Y) of width WIDTH and height HEIGHT is |
| 2848 | shifted right by SHIFT_BY pixels. */ |
| 2849 | void (*shift_glyphs_for_insert) (struct frame *f, |
| 2850 | int x, int y, int width, |
| 2851 | int height, int shift_by); |
| 2852 | |
| 2853 | #endif /* HAVE_WINDOW_SYSTEM */ |
| 2854 | }; |
| 2855 | |
| 2856 | \f |
| 2857 | /*********************************************************************** |
| 2858 | Images |
| 2859 | ***********************************************************************/ |
| 2860 | |
| 2861 | #ifdef HAVE_WINDOW_SYSTEM |
| 2862 | |
| 2863 | /* Each image format (JPEG, TIFF, ...) supported is described by |
| 2864 | a structure of the type below. */ |
| 2865 | |
| 2866 | struct image_type |
| 2867 | { |
| 2868 | /* A symbol uniquely identifying the image type, .e.g `jpeg'. */ |
| 2869 | Lisp_Object *type; |
| 2870 | |
| 2871 | /* Check that SPEC is a valid image specification for the given |
| 2872 | image type. Value is true if SPEC is valid. */ |
| 2873 | bool (* valid_p) (Lisp_Object spec); |
| 2874 | |
| 2875 | /* Load IMG which is used on frame F from information contained in |
| 2876 | IMG->spec. Value is true if successful. */ |
| 2877 | bool (* load) (struct frame *f, struct image *img); |
| 2878 | |
| 2879 | /* Free resources of image IMG which is used on frame F. */ |
| 2880 | void (* free) (struct frame *f, struct image *img); |
| 2881 | |
| 2882 | /* Initialization function (used for dynamic loading of image |
| 2883 | libraries on Windows), or NULL if none. */ |
| 2884 | bool (* init) (void); |
| 2885 | |
| 2886 | /* Next in list of all supported image types. */ |
| 2887 | struct image_type *next; |
| 2888 | }; |
| 2889 | |
| 2890 | |
| 2891 | /* Structure describing an image. Specific image formats like XBM are |
| 2892 | converted into this form, so that display only has to deal with |
| 2893 | this type of image. */ |
| 2894 | |
| 2895 | struct image |
| 2896 | { |
| 2897 | /* The time in seconds at which the image was last displayed. Set |
| 2898 | in prepare_image_for_display. */ |
| 2899 | struct timespec timestamp; |
| 2900 | |
| 2901 | /* Pixmaps of the image. */ |
| 2902 | Pixmap pixmap, mask; |
| 2903 | |
| 2904 | #ifdef HAVE_X_WINDOWS |
| 2905 | /* X images of the image, corresponding to the above Pixmaps. |
| 2906 | Non-NULL means it and its Pixmap counterpart may be out of sync |
| 2907 | and the latter is outdated. NULL means the X image has been |
| 2908 | synchronized to Pixmap. */ |
| 2909 | XImagePtr ximg, mask_img; |
| 2910 | #endif |
| 2911 | |
| 2912 | /* Colors allocated for this image, if any. Allocated via xmalloc. */ |
| 2913 | unsigned long *colors; |
| 2914 | int ncolors; |
| 2915 | |
| 2916 | /* A single `background color' for this image, for the use of anyone that |
| 2917 | cares about such a thing. Only valid if the `background_valid' field |
| 2918 | is true. This should generally be accessed by calling the accessor |
| 2919 | macro `IMAGE_BACKGROUND', which will heuristically calculate a value |
| 2920 | if necessary. */ |
| 2921 | unsigned long background; |
| 2922 | |
| 2923 | /* Foreground and background colors of the frame on which the image |
| 2924 | is created. */ |
| 2925 | unsigned long frame_foreground, frame_background; |
| 2926 | |
| 2927 | /* True if this image has a `transparent' background -- that is, is |
| 2928 | uses an image mask. The accessor macro for this is |
| 2929 | `IMAGE_BACKGROUND_TRANSPARENT'. */ |
| 2930 | unsigned background_transparent : 1; |
| 2931 | |
| 2932 | /* True if the `background' and `background_transparent' fields are |
| 2933 | valid, respectively. */ |
| 2934 | unsigned background_valid : 1, background_transparent_valid : 1; |
| 2935 | |
| 2936 | /* Width and height of the image. */ |
| 2937 | int width, height; |
| 2938 | |
| 2939 | /* These values are used for the rectangles displayed for images |
| 2940 | that can't be loaded. */ |
| 2941 | #define DEFAULT_IMAGE_WIDTH 30 |
| 2942 | #define DEFAULT_IMAGE_HEIGHT 30 |
| 2943 | |
| 2944 | /* Top/left and bottom/right corner pixel of actual image data. |
| 2945 | Used by four_corners_best to consider the real image data, |
| 2946 | rather than looking at the optional image margin. */ |
| 2947 | int corners[4]; |
| 2948 | #define TOP_CORNER 0 |
| 2949 | #define LEFT_CORNER 1 |
| 2950 | #define BOT_CORNER 2 |
| 2951 | #define RIGHT_CORNER 3 |
| 2952 | |
| 2953 | /* Percent of image height used as ascent. A value of |
| 2954 | CENTERED_IMAGE_ASCENT means draw the image centered on the |
| 2955 | line. */ |
| 2956 | int ascent; |
| 2957 | #define DEFAULT_IMAGE_ASCENT 50 |
| 2958 | #define CENTERED_IMAGE_ASCENT -1 |
| 2959 | |
| 2960 | /* Lisp specification of this image. */ |
| 2961 | Lisp_Object spec; |
| 2962 | |
| 2963 | /* List of "references" followed to build the image. |
| 2964 | Typically will just contain the name of the image file. |
| 2965 | Used to allow fine-grained cache flushing. */ |
| 2966 | Lisp_Object dependencies; |
| 2967 | |
| 2968 | /* Relief to draw around the image. */ |
| 2969 | int relief; |
| 2970 | |
| 2971 | /* Optional margins around the image. This includes the relief. */ |
| 2972 | int hmargin, vmargin; |
| 2973 | |
| 2974 | /* Reference to the type of the image. */ |
| 2975 | struct image_type *type; |
| 2976 | |
| 2977 | /* 1 means that loading the image failed. Don't try again. */ |
| 2978 | unsigned load_failed_p; |
| 2979 | |
| 2980 | /* A place for image types to store additional data. It is marked |
| 2981 | during GC. */ |
| 2982 | Lisp_Object lisp_data; |
| 2983 | |
| 2984 | /* Hash value of image specification to speed up comparisons. */ |
| 2985 | EMACS_UINT hash; |
| 2986 | |
| 2987 | /* Image id of this image. */ |
| 2988 | ptrdiff_t id; |
| 2989 | |
| 2990 | /* Hash collision chain. */ |
| 2991 | struct image *next, *prev; |
| 2992 | }; |
| 2993 | |
| 2994 | |
| 2995 | /* Cache of images. Each frame has a cache. X frames with the same |
| 2996 | x_display_info share their caches. */ |
| 2997 | |
| 2998 | struct image_cache |
| 2999 | { |
| 3000 | /* Hash table of images. */ |
| 3001 | struct image **buckets; |
| 3002 | |
| 3003 | /* Vector mapping image ids to images. */ |
| 3004 | struct image **images; |
| 3005 | |
| 3006 | /* Allocated size of `images'. */ |
| 3007 | ptrdiff_t size; |
| 3008 | |
| 3009 | /* Number of images in the cache. */ |
| 3010 | ptrdiff_t used; |
| 3011 | |
| 3012 | /* Reference count (number of frames sharing this cache). */ |
| 3013 | ptrdiff_t refcount; |
| 3014 | }; |
| 3015 | |
| 3016 | |
| 3017 | /* Value is a pointer to the image with id ID on frame F, or null if |
| 3018 | no image with that id exists. */ |
| 3019 | |
| 3020 | #define IMAGE_FROM_ID(F, ID) \ |
| 3021 | (((ID) >= 0 && (ID) < (FRAME_IMAGE_CACHE (F)->used)) \ |
| 3022 | ? FRAME_IMAGE_CACHE (F)->images[ID] \ |
| 3023 | : NULL) |
| 3024 | |
| 3025 | /* Size of bucket vector of image caches. Should be prime. */ |
| 3026 | |
| 3027 | #define IMAGE_CACHE_BUCKETS_SIZE 1001 |
| 3028 | |
| 3029 | #endif /* HAVE_WINDOW_SYSTEM */ |
| 3030 | |
| 3031 | |
| 3032 | \f |
| 3033 | /*********************************************************************** |
| 3034 | Tool-bars |
| 3035 | ***********************************************************************/ |
| 3036 | |
| 3037 | /* Enumeration defining where to find tool-bar item information in |
| 3038 | tool-bar items vectors stored with frames. Each tool-bar item |
| 3039 | occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector. */ |
| 3040 | |
| 3041 | enum tool_bar_item_idx |
| 3042 | { |
| 3043 | /* The key of the tool-bar item. Used to remove items when a binding |
| 3044 | for `undefined' is found. */ |
| 3045 | TOOL_BAR_ITEM_KEY, |
| 3046 | |
| 3047 | /* Non-nil if item is enabled. */ |
| 3048 | TOOL_BAR_ITEM_ENABLED_P, |
| 3049 | |
| 3050 | /* Non-nil if item is selected (pressed). */ |
| 3051 | TOOL_BAR_ITEM_SELECTED_P, |
| 3052 | |
| 3053 | /* Caption. */ |
| 3054 | TOOL_BAR_ITEM_CAPTION, |
| 3055 | |
| 3056 | /* Image(s) to display. This is either a single image specification |
| 3057 | or a vector of specifications. */ |
| 3058 | TOOL_BAR_ITEM_IMAGES, |
| 3059 | |
| 3060 | /* The binding. */ |
| 3061 | TOOL_BAR_ITEM_BINDING, |
| 3062 | |
| 3063 | /* Button type. One of nil (default button), t (a separator), |
| 3064 | `:radio', or `:toggle'. The latter two currently do nothing. */ |
| 3065 | TOOL_BAR_ITEM_TYPE, |
| 3066 | |
| 3067 | /* Help string. */ |
| 3068 | TOOL_BAR_ITEM_HELP, |
| 3069 | |
| 3070 | /* Icon file name of right to left image when an RTL locale is used. */ |
| 3071 | TOOL_BAR_ITEM_RTL_IMAGE, |
| 3072 | |
| 3073 | /* Label to show when text labels are enabled. */ |
| 3074 | TOOL_BAR_ITEM_LABEL, |
| 3075 | |
| 3076 | /* If we shall show the label only below the icon and not beside it. */ |
| 3077 | TOOL_BAR_ITEM_VERT_ONLY, |
| 3078 | |
| 3079 | /* Sentinel = number of slots in tool_bar_items occupied by one |
| 3080 | tool-bar item. */ |
| 3081 | TOOL_BAR_ITEM_NSLOTS |
| 3082 | }; |
| 3083 | |
| 3084 | |
| 3085 | /* An enumeration for the different images that can be specified |
| 3086 | for a tool-bar item. */ |
| 3087 | |
| 3088 | enum tool_bar_item_image |
| 3089 | { |
| 3090 | TOOL_BAR_IMAGE_ENABLED_SELECTED, |
| 3091 | TOOL_BAR_IMAGE_ENABLED_DESELECTED, |
| 3092 | TOOL_BAR_IMAGE_DISABLED_SELECTED, |
| 3093 | TOOL_BAR_IMAGE_DISABLED_DESELECTED |
| 3094 | }; |
| 3095 | |
| 3096 | #define DEFAULT_TOOL_BAR_LABEL_SIZE 14 |
| 3097 | |
| 3098 | /* Default values of the above variables. */ |
| 3099 | |
| 3100 | #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4 |
| 3101 | #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1 |
| 3102 | |
| 3103 | /* The height in pixels of the default tool-bar images. */ |
| 3104 | |
| 3105 | #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24 |
| 3106 | |
| 3107 | \f |
| 3108 | /*********************************************************************** |
| 3109 | Terminal Capabilities |
| 3110 | ***********************************************************************/ |
| 3111 | |
| 3112 | /* Each of these is a bit representing a terminal `capability' (bold, |
| 3113 | inverse, etc). They are or'd together to specify the set of |
| 3114 | capabilities being queried for when calling `tty_capable_p' (which |
| 3115 | returns true if the terminal supports all of them). */ |
| 3116 | |
| 3117 | #define TTY_CAP_INVERSE 0x01 |
| 3118 | #define TTY_CAP_UNDERLINE 0x02 |
| 3119 | #define TTY_CAP_BOLD 0x04 |
| 3120 | #define TTY_CAP_DIM 0x08 |
| 3121 | #define TTY_CAP_ITALIC 0x10 |
| 3122 | |
| 3123 | \f |
| 3124 | /*********************************************************************** |
| 3125 | Function Prototypes |
| 3126 | ***********************************************************************/ |
| 3127 | |
| 3128 | /* Defined in bidi.c */ |
| 3129 | |
| 3130 | extern void bidi_init_it (ptrdiff_t, ptrdiff_t, bool, struct bidi_it *); |
| 3131 | extern void bidi_move_to_visually_next (struct bidi_it *); |
| 3132 | extern void bidi_paragraph_init (bidi_dir_t, struct bidi_it *, bool); |
| 3133 | extern int bidi_mirror_char (int); |
| 3134 | extern void bidi_push_it (struct bidi_it *); |
| 3135 | extern void bidi_pop_it (struct bidi_it *); |
| 3136 | extern void *bidi_shelve_cache (void); |
| 3137 | extern void bidi_unshelve_cache (void *, bool); |
| 3138 | |
| 3139 | /* Defined in xdisp.c */ |
| 3140 | |
| 3141 | struct glyph_row *row_containing_pos (struct window *, ptrdiff_t, |
| 3142 | struct glyph_row *, |
| 3143 | struct glyph_row *, int); |
| 3144 | int line_bottom_y (struct it *); |
| 3145 | int default_line_pixel_height (struct window *); |
| 3146 | int display_prop_intangible_p (Lisp_Object, Lisp_Object, ptrdiff_t, ptrdiff_t); |
| 3147 | void resize_echo_area_exactly (void); |
| 3148 | int resize_mini_window (struct window *, int); |
| 3149 | #if defined USE_TOOLKIT_SCROLL_BARS && !defined USE_GTK |
| 3150 | void set_vertical_scroll_bar (struct window *); |
| 3151 | #endif |
| 3152 | int try_window (Lisp_Object, struct text_pos, int); |
| 3153 | void window_box (struct window *, enum glyph_row_area, |
| 3154 | int *, int *, int *, int *); |
| 3155 | int window_box_height (struct window *); |
| 3156 | int window_text_bottom_y (struct window *); |
| 3157 | int window_box_width (struct window *, enum glyph_row_area); |
| 3158 | int window_box_left (struct window *, enum glyph_row_area); |
| 3159 | int window_box_left_offset (struct window *, enum glyph_row_area); |
| 3160 | int window_box_right (struct window *, enum glyph_row_area); |
| 3161 | int window_box_right_offset (struct window *, enum glyph_row_area); |
| 3162 | int estimate_mode_line_height (struct frame *, enum face_id); |
| 3163 | void pixel_to_glyph_coords (struct frame *, int, int, int *, int *, |
| 3164 | NativeRectangle *, int); |
| 3165 | void remember_mouse_glyph (struct frame *, int, int, NativeRectangle *); |
| 3166 | |
| 3167 | void mark_window_display_accurate (Lisp_Object, int); |
| 3168 | void redisplay_preserve_echo_area (int); |
| 3169 | void init_iterator (struct it *, struct window *, ptrdiff_t, |
| 3170 | ptrdiff_t, struct glyph_row *, enum face_id); |
| 3171 | void init_iterator_to_row_start (struct it *, struct window *, |
| 3172 | struct glyph_row *); |
| 3173 | void start_display (struct it *, struct window *, struct text_pos); |
| 3174 | void move_it_to (struct it *, ptrdiff_t, int, int, int, int); |
| 3175 | void move_it_vertically (struct it *, int); |
| 3176 | void move_it_vertically_backward (struct it *, int); |
| 3177 | void move_it_by_lines (struct it *, ptrdiff_t); |
| 3178 | void move_it_past_eol (struct it *); |
| 3179 | void move_it_in_display_line (struct it *it, |
| 3180 | ptrdiff_t to_charpos, int to_x, |
| 3181 | enum move_operation_enum op); |
| 3182 | int in_display_vector_p (struct it *); |
| 3183 | int frame_mode_line_height (struct frame *); |
| 3184 | extern Lisp_Object Qtool_bar; |
| 3185 | extern bool redisplaying_p; |
| 3186 | extern bool help_echo_showing_p; |
| 3187 | extern Lisp_Object help_echo_string, help_echo_window; |
| 3188 | extern Lisp_Object help_echo_object, previous_help_echo_string; |
| 3189 | extern ptrdiff_t help_echo_pos; |
| 3190 | extern int last_tool_bar_item; |
| 3191 | extern void reseat_at_previous_visible_line_start (struct it *); |
| 3192 | extern Lisp_Object lookup_glyphless_char_display (int, struct it *); |
| 3193 | extern ptrdiff_t compute_display_string_pos (struct text_pos *, |
| 3194 | struct bidi_string_data *, |
| 3195 | struct window *, int, int *); |
| 3196 | extern ptrdiff_t compute_display_string_end (ptrdiff_t, |
| 3197 | struct bidi_string_data *); |
| 3198 | extern void produce_stretch_glyph (struct it *); |
| 3199 | extern int merge_glyphless_glyph_face (struct it *); |
| 3200 | |
| 3201 | #ifdef HAVE_WINDOW_SYSTEM |
| 3202 | |
| 3203 | #ifdef GLYPH_DEBUG |
| 3204 | extern void dump_glyph_string (struct glyph_string *) EXTERNALLY_VISIBLE; |
| 3205 | #endif |
| 3206 | |
| 3207 | extern void x_get_glyph_overhangs (struct glyph *, struct frame *, |
| 3208 | int *, int *); |
| 3209 | extern void x_produce_glyphs (struct it *); |
| 3210 | |
| 3211 | extern void x_write_glyphs (struct window *, struct glyph_row *, |
| 3212 | struct glyph *, enum glyph_row_area, int); |
| 3213 | extern void x_insert_glyphs (struct window *, struct glyph_row *, |
| 3214 | struct glyph *, enum glyph_row_area, int); |
| 3215 | extern void x_clear_end_of_line (struct window *, struct glyph_row *, |
| 3216 | enum glyph_row_area, int); |
| 3217 | extern void x_fix_overlapping_area (struct window *, struct glyph_row *, |
| 3218 | enum glyph_row_area, int); |
| 3219 | extern void draw_phys_cursor_glyph (struct window *, |
| 3220 | struct glyph_row *, |
| 3221 | enum draw_glyphs_face); |
| 3222 | extern void get_phys_cursor_geometry (struct window *, struct glyph_row *, |
| 3223 | struct glyph *, int *, int *, int *); |
| 3224 | #ifdef WINDOWSNT |
| 3225 | extern void erase_phys_cursor (struct window *); |
| 3226 | #endif |
| 3227 | extern void display_and_set_cursor (struct window *, bool, int, int, int, int); |
| 3228 | extern void x_update_cursor (struct frame *, bool); |
| 3229 | extern void x_clear_cursor (struct window *); |
| 3230 | extern void x_draw_vertical_border (struct window *w); |
| 3231 | |
| 3232 | extern int get_glyph_string_clip_rects (struct glyph_string *, |
| 3233 | NativeRectangle *, int); |
| 3234 | extern void get_glyph_string_clip_rect (struct glyph_string *, |
| 3235 | NativeRectangle *nr); |
| 3236 | extern Lisp_Object find_hot_spot (Lisp_Object, int, int); |
| 3237 | |
| 3238 | extern void handle_tool_bar_click (struct frame *, |
| 3239 | int, int, int, int); |
| 3240 | |
| 3241 | extern void expose_frame (struct frame *, int, int, int, int); |
| 3242 | extern int x_intersect_rectangles (XRectangle *, XRectangle *, |
| 3243 | XRectangle *); |
| 3244 | #endif /* HAVE_WINDOW_SYSTEM */ |
| 3245 | |
| 3246 | extern void note_mouse_highlight (struct frame *, int, int); |
| 3247 | extern void x_clear_window_mouse_face (struct window *); |
| 3248 | extern void cancel_mouse_face (struct frame *); |
| 3249 | extern int clear_mouse_face (Mouse_HLInfo *); |
| 3250 | extern int cursor_in_mouse_face_p (struct window *w); |
| 3251 | extern void tty_draw_row_with_mouse_face (struct window *, struct glyph_row *, |
| 3252 | int, int, enum draw_glyphs_face); |
| 3253 | extern void display_tty_menu_item (const char *, int, int, int, int, int); |
| 3254 | |
| 3255 | /* Flags passed to try_window. */ |
| 3256 | #define TRY_WINDOW_CHECK_MARGINS (1 << 0) |
| 3257 | #define TRY_WINDOW_IGNORE_FONTS_CHANGE (1 << 1) |
| 3258 | |
| 3259 | int lookup_fringe_bitmap (Lisp_Object); |
| 3260 | void draw_fringe_bitmap (struct window *, struct glyph_row *, int); |
| 3261 | void draw_row_fringe_bitmaps (struct window *, struct glyph_row *); |
| 3262 | bool draw_window_fringes (struct window *, bool); |
| 3263 | bool update_window_fringes (struct window *, bool); |
| 3264 | void compute_fringe_widths (struct frame *, bool); |
| 3265 | |
| 3266 | #ifdef HAVE_NTGUI |
| 3267 | void w32_init_fringe (struct redisplay_interface *); |
| 3268 | void w32_reset_fringes (void); |
| 3269 | #endif |
| 3270 | |
| 3271 | extern unsigned row_hash (struct glyph_row *); |
| 3272 | |
| 3273 | /* Defined in image.c */ |
| 3274 | |
| 3275 | #ifdef HAVE_WINDOW_SYSTEM |
| 3276 | |
| 3277 | extern ptrdiff_t x_bitmap_pixmap (struct frame *, ptrdiff_t); |
| 3278 | extern void x_reference_bitmap (struct frame *, ptrdiff_t); |
| 3279 | extern ptrdiff_t x_create_bitmap_from_data (struct frame *, char *, |
| 3280 | unsigned int, unsigned int); |
| 3281 | extern ptrdiff_t x_create_bitmap_from_file (struct frame *, Lisp_Object); |
| 3282 | #if defined HAVE_XPM && defined HAVE_X_WINDOWS && !defined USE_GTK |
| 3283 | extern ptrdiff_t x_create_bitmap_from_xpm_data (struct frame *, const char **); |
| 3284 | #endif |
| 3285 | #ifndef x_destroy_bitmap |
| 3286 | extern void x_destroy_bitmap (struct frame *, ptrdiff_t); |
| 3287 | #endif |
| 3288 | extern void x_destroy_all_bitmaps (Display_Info *); |
| 3289 | extern void x_create_bitmap_mask (struct frame *, ptrdiff_t); |
| 3290 | extern Lisp_Object x_find_image_file (Lisp_Object); |
| 3291 | |
| 3292 | void x_kill_gs_process (Pixmap, struct frame *); |
| 3293 | struct image_cache *make_image_cache (void); |
| 3294 | void free_image_cache (struct frame *); |
| 3295 | void clear_image_caches (Lisp_Object); |
| 3296 | void mark_image_cache (struct image_cache *); |
| 3297 | bool valid_image_p (Lisp_Object); |
| 3298 | void prepare_image_for_display (struct frame *, struct image *); |
| 3299 | ptrdiff_t lookup_image (struct frame *, Lisp_Object); |
| 3300 | |
| 3301 | #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS) |
| 3302 | #define RGB_PIXEL_COLOR unsigned long |
| 3303 | #endif |
| 3304 | |
| 3305 | #ifdef HAVE_NTGUI |
| 3306 | #define RGB_PIXEL_COLOR COLORREF |
| 3307 | #endif |
| 3308 | |
| 3309 | RGB_PIXEL_COLOR image_background (struct image *, struct frame *, |
| 3310 | XImagePtr_or_DC ximg); |
| 3311 | int image_background_transparent (struct image *, struct frame *, |
| 3312 | XImagePtr_or_DC mask); |
| 3313 | |
| 3314 | int image_ascent (struct image *, struct face *, struct glyph_slice *); |
| 3315 | |
| 3316 | #endif |
| 3317 | |
| 3318 | /* Defined in sysdep.c */ |
| 3319 | |
| 3320 | void get_tty_size (int, int *, int *); |
| 3321 | void request_sigio (void); |
| 3322 | void unrequest_sigio (void); |
| 3323 | bool tabs_safe_p (int); |
| 3324 | void init_baud_rate (int); |
| 3325 | void init_sigio (int); |
| 3326 | void ignore_sigio (void); |
| 3327 | |
| 3328 | /* Defined in xfaces.c */ |
| 3329 | |
| 3330 | #ifdef HAVE_X_WINDOWS |
| 3331 | void x_free_colors (struct frame *, unsigned long *, int); |
| 3332 | #endif |
| 3333 | |
| 3334 | void update_face_from_frame_parameter (struct frame *, Lisp_Object, |
| 3335 | Lisp_Object); |
| 3336 | Lisp_Object tty_color_name (struct frame *, int); |
| 3337 | void clear_face_cache (int); |
| 3338 | #ifdef MSDOS |
| 3339 | unsigned long load_color (struct frame *, struct face *, Lisp_Object, |
| 3340 | enum lface_attribute_index); |
| 3341 | #endif |
| 3342 | void unload_color (struct frame *, unsigned long); |
| 3343 | char *choose_face_font (struct frame *, Lisp_Object *, Lisp_Object, |
| 3344 | int *); |
| 3345 | void prepare_face_for_display (struct frame *, struct face *); |
| 3346 | int lookup_named_face (struct frame *, Lisp_Object, int); |
| 3347 | int lookup_basic_face (struct frame *, int); |
| 3348 | int smaller_face (struct frame *, int, int); |
| 3349 | int face_with_height (struct frame *, int, int); |
| 3350 | int lookup_derived_face (struct frame *, Lisp_Object, int, int); |
| 3351 | void init_frame_faces (struct frame *); |
| 3352 | void free_frame_faces (struct frame *); |
| 3353 | void recompute_basic_faces (struct frame *); |
| 3354 | int face_at_buffer_position (struct window *w, ptrdiff_t pos, |
| 3355 | ptrdiff_t region_beg, ptrdiff_t region_end, |
| 3356 | ptrdiff_t *endptr, ptrdiff_t limit, |
| 3357 | int mouse, int base_face_id); |
| 3358 | int face_for_overlay_string (struct window *w, ptrdiff_t pos, |
| 3359 | ptrdiff_t region_beg, ptrdiff_t region_end, |
| 3360 | ptrdiff_t *endptr, ptrdiff_t limit, |
| 3361 | int mouse, Lisp_Object overlay); |
| 3362 | int face_at_string_position (struct window *w, Lisp_Object string, |
| 3363 | ptrdiff_t pos, ptrdiff_t bufpos, |
| 3364 | ptrdiff_t region_beg, ptrdiff_t region_end, |
| 3365 | ptrdiff_t *endptr, enum face_id, int mouse); |
| 3366 | int merge_faces (struct frame *, Lisp_Object, int, int); |
| 3367 | int compute_char_face (struct frame *, int, Lisp_Object); |
| 3368 | void free_all_realized_faces (Lisp_Object); |
| 3369 | extern Lisp_Object Qforeground_color, Qbackground_color; |
| 3370 | extern char unspecified_fg[], unspecified_bg[]; |
| 3371 | |
| 3372 | /* Defined in xfns.c */ |
| 3373 | |
| 3374 | #ifdef HAVE_X_WINDOWS |
| 3375 | void gamma_correct (struct frame *, XColor *); |
| 3376 | #endif |
| 3377 | #ifdef HAVE_NTGUI |
| 3378 | void gamma_correct (struct frame *, COLORREF *); |
| 3379 | #endif |
| 3380 | |
| 3381 | #ifdef HAVE_WINDOW_SYSTEM |
| 3382 | |
| 3383 | void x_implicitly_set_name (struct frame *, Lisp_Object, Lisp_Object); |
| 3384 | |
| 3385 | extern Lisp_Object tip_frame; |
| 3386 | extern Window tip_window; |
| 3387 | extern frame_parm_handler x_frame_parm_handlers[]; |
| 3388 | |
| 3389 | extern void start_hourglass (void); |
| 3390 | extern void cancel_hourglass (void); |
| 3391 | extern bool hourglass_shown_p; |
| 3392 | /* If non-null, an asynchronous timer that, when it expires, displays |
| 3393 | an hourglass cursor on all frames. */ |
| 3394 | extern struct atimer *hourglass_atimer; |
| 3395 | |
| 3396 | /* Each GUI implements these. FIXME: move into RIF. */ |
| 3397 | extern void show_hourglass (struct atimer *); |
| 3398 | extern void hide_hourglass (void); |
| 3399 | |
| 3400 | /* Returns the background color of IMG, calculating one heuristically if |
| 3401 | necessary. If non-zero, XIMG is an existing XImage object to use for |
| 3402 | the heuristic. */ |
| 3403 | |
| 3404 | #define IMAGE_BACKGROUND(img, f, ximg) \ |
| 3405 | ((img)->background_valid \ |
| 3406 | ? (img)->background \ |
| 3407 | : image_background (img, f, ximg)) |
| 3408 | |
| 3409 | /* Returns true if IMG has a `transparent' background, using heuristics |
| 3410 | to decide if necessary. If non-zero, MASK is an existing XImage |
| 3411 | object to use for the heuristic. */ |
| 3412 | |
| 3413 | #define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask) \ |
| 3414 | ((img)->background_transparent_valid \ |
| 3415 | ? (img)->background_transparent \ |
| 3416 | : image_background_transparent (img, f, mask)) |
| 3417 | |
| 3418 | #endif /* HAVE_WINDOW_SYSTEM */ |
| 3419 | |
| 3420 | |
| 3421 | /* Defined in xmenu.c */ |
| 3422 | |
| 3423 | int popup_activated (void); |
| 3424 | |
| 3425 | /* Defined in dispnew.c */ |
| 3426 | |
| 3427 | extern Lisp_Object buffer_posn_from_coords (struct window *, |
| 3428 | int *, int *, |
| 3429 | struct display_pos *, |
| 3430 | Lisp_Object *, |
| 3431 | int *, int *, int *, int *); |
| 3432 | extern Lisp_Object mode_line_string (struct window *, enum window_part, |
| 3433 | int *, int *, ptrdiff_t *, |
| 3434 | Lisp_Object *, |
| 3435 | int *, int *, int *, int *); |
| 3436 | extern Lisp_Object marginal_area_string (struct window *, enum window_part, |
| 3437 | int *, int *, ptrdiff_t *, |
| 3438 | Lisp_Object *, |
| 3439 | int *, int *, int *, int *); |
| 3440 | extern void redraw_frame (struct frame *); |
| 3441 | extern bool update_frame (struct frame *, bool, bool); |
| 3442 | extern void update_frame_with_menu (struct frame *); |
| 3443 | extern void bitch_at_user (void); |
| 3444 | extern void adjust_frame_glyphs (struct frame *); |
| 3445 | void free_glyphs (struct frame *); |
| 3446 | void free_window_matrices (struct window *); |
| 3447 | void check_glyph_memory (void); |
| 3448 | void mirrored_line_dance (struct glyph_matrix *, int, int, int *, char *); |
| 3449 | void clear_glyph_matrix (struct glyph_matrix *); |
| 3450 | void clear_current_matrices (struct frame *f); |
| 3451 | void clear_desired_matrices (struct frame *); |
| 3452 | void shift_glyph_matrix (struct window *, struct glyph_matrix *, |
| 3453 | int, int, int); |
| 3454 | void rotate_matrix (struct glyph_matrix *, int, int, int); |
| 3455 | void increment_matrix_positions (struct glyph_matrix *, |
| 3456 | int, int, ptrdiff_t, ptrdiff_t); |
| 3457 | void blank_row (struct window *, struct glyph_row *, int); |
| 3458 | void clear_glyph_matrix_rows (struct glyph_matrix *, int, int); |
| 3459 | void clear_glyph_row (struct glyph_row *); |
| 3460 | void prepare_desired_row (struct glyph_row *); |
| 3461 | void set_window_update_flags (struct window *, struct buffer *, bool); |
| 3462 | void update_single_window (struct window *, bool); |
| 3463 | void do_pending_window_change (bool); |
| 3464 | void change_frame_size (struct frame *, int, int, bool, bool, bool); |
| 3465 | void init_display (void); |
| 3466 | void syms_of_display (void); |
| 3467 | extern Lisp_Object Qredisplay_dont_pause; |
| 3468 | extern void spec_glyph_lookup_face (struct window *, GLYPH *); |
| 3469 | extern void fill_up_frame_row_with_spaces (struct glyph_row *, int); |
| 3470 | |
| 3471 | /* Defined in terminal.c */ |
| 3472 | |
| 3473 | extern void ring_bell (struct frame *); |
| 3474 | extern void update_begin (struct frame *); |
| 3475 | extern void update_end (struct frame *); |
| 3476 | extern void set_terminal_window (struct frame *, int); |
| 3477 | extern void cursor_to (struct frame *, int, int); |
| 3478 | extern void raw_cursor_to (struct frame *, int, int); |
| 3479 | extern void clear_to_end (struct frame *); |
| 3480 | extern void clear_frame (struct frame *); |
| 3481 | extern void clear_end_of_line (struct frame *, int); |
| 3482 | extern void write_glyphs (struct frame *, struct glyph *, int); |
| 3483 | extern void insert_glyphs (struct frame *, struct glyph *, int); |
| 3484 | extern void delete_glyphs (struct frame *, int); |
| 3485 | extern void ins_del_lines (struct frame *, int, int); |
| 3486 | |
| 3487 | extern struct terminal *init_initial_terminal (void); |
| 3488 | |
| 3489 | |
| 3490 | /* Defined in term.c */ |
| 3491 | |
| 3492 | extern void tty_turn_off_insert (struct tty_display_info *); |
| 3493 | extern int string_cost (const char *); |
| 3494 | extern int per_line_cost (const char *); |
| 3495 | extern void calculate_costs (struct frame *); |
| 3496 | extern void produce_glyphs (struct it *); |
| 3497 | extern bool tty_capable_p (struct tty_display_info *, unsigned, |
| 3498 | unsigned long, unsigned long); |
| 3499 | extern void set_tty_color_mode (struct tty_display_info *, struct frame *); |
| 3500 | extern struct terminal *get_named_tty (const char *); |
| 3501 | extern void create_tty_output (struct frame *); |
| 3502 | extern struct terminal *init_tty (const char *, const char *, bool); |
| 3503 | extern void tty_append_glyph (struct it *); |
| 3504 | |
| 3505 | |
| 3506 | /* Defined in scroll.c */ |
| 3507 | |
| 3508 | extern int scrolling_max_lines_saved (int, int, int *, int *, int *); |
| 3509 | extern void do_line_insertion_deletion_costs (struct frame *, const char *, |
| 3510 | const char *, const char *, |
| 3511 | const char *, const char *, |
| 3512 | const char *, int); |
| 3513 | void scrolling_1 (struct frame *, int, int, int, int *, int *, int *, |
| 3514 | int *, int); |
| 3515 | |
| 3516 | /* Defined in frame.c */ |
| 3517 | |
| 3518 | #ifdef HAVE_WINDOW_SYSTEM |
| 3519 | |
| 3520 | /* Types we might convert a resource string into. */ |
| 3521 | enum resource_types |
| 3522 | { |
| 3523 | RES_TYPE_NUMBER, |
| 3524 | RES_TYPE_FLOAT, |
| 3525 | RES_TYPE_BOOLEAN, |
| 3526 | RES_TYPE_STRING, |
| 3527 | RES_TYPE_SYMBOL, |
| 3528 | RES_TYPE_BOOLEAN_NUMBER |
| 3529 | }; |
| 3530 | |
| 3531 | extern Display_Info *check_x_display_info (Lisp_Object); |
| 3532 | extern Lisp_Object x_get_arg (Display_Info *, Lisp_Object, |
| 3533 | Lisp_Object, const char *, const char *class, |
| 3534 | enum resource_types); |
| 3535 | extern Lisp_Object x_frame_get_and_record_arg (struct frame *, Lisp_Object, |
| 3536 | Lisp_Object, |
| 3537 | const char *, const char *, |
| 3538 | enum resource_types); |
| 3539 | extern Lisp_Object x_default_parameter (struct frame *, Lisp_Object, |
| 3540 | Lisp_Object, Lisp_Object, |
| 3541 | const char *, const char *, |
| 3542 | enum resource_types); |
| 3543 | extern char *x_get_string_resource (XrmDatabase, const char *, |
| 3544 | const char *); |
| 3545 | |
| 3546 | #ifndef HAVE_NS /* These both used on W32 and X only. */ |
| 3547 | extern bool x_mouse_grabbed (Display_Info *); |
| 3548 | extern void x_redo_mouse_highlight (Display_Info *); |
| 3549 | #endif /* HAVE_NS */ |
| 3550 | |
| 3551 | #endif /* HAVE_WINDOW_SYSTEM */ |
| 3552 | |
| 3553 | INLINE_HEADER_END |
| 3554 | |
| 3555 | #endif /* not DISPEXTERN_H_INCLUDED */ |