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