]> code.delx.au - gnu-emacs/blob - src/xdisp.c
Avoid assertion violations in push_prefix_prop
[gnu-emacs] / src / xdisp.c
1 /* Display generation from window structure and buffer text.
2
3 Copyright (C) 1985-1988, 1993-1995, 1997-2015 Free Software Foundation,
4 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 Redisplay.
24
25 Emacs separates the task of updating the display from code
26 modifying global state, e.g. buffer text. This way functions
27 operating on buffers don't also have to be concerned with updating
28 the display.
29
30 Updating the display is triggered by the Lisp interpreter when it
31 decides it's time to do it. This is done either automatically for
32 you as part of the interpreter's command loop or as the result of
33 calling Lisp functions like `sit-for'. The C function `redisplay'
34 in xdisp.c is the only entry into the inner redisplay code.
35
36 The following diagram shows how redisplay code is invoked. As you
37 can see, Lisp calls redisplay and vice versa. Under window systems
38 like X, some portions of the redisplay code are also called
39 asynchronously during mouse movement or expose events. It is very
40 important that these code parts do NOT use the C library (malloc,
41 free) because many C libraries under Unix are not reentrant. They
42 may also NOT call functions of the Lisp interpreter which could
43 change the interpreter's state. If you don't follow these rules,
44 you will encounter bugs which are very hard to explain.
45
46 +--------------+ redisplay +----------------+
47 | Lisp machine |---------------->| Redisplay code |<--+
48 +--------------+ (xdisp.c) +----------------+ |
49 ^ | |
50 +----------------------------------+ |
51 Don't use this path when called |
52 asynchronously! |
53 |
54 expose_window (asynchronous) |
55 |
56 X expose events -----+
57
58 What does redisplay do? Obviously, it has to figure out somehow what
59 has been changed since the last time the display has been updated,
60 and to make these changes visible. Preferably it would do that in
61 a moderately intelligent way, i.e. fast.
62
63 Changes in buffer text can be deduced from window and buffer
64 structures, and from some global variables like `beg_unchanged' and
65 `end_unchanged'. The contents of the display are additionally
66 recorded in a `glyph matrix', a two-dimensional matrix of glyph
67 structures. Each row in such a matrix corresponds to a line on the
68 display, and each glyph in a row corresponds to a column displaying
69 a character, an image, or what else. This matrix is called the
70 `current glyph matrix' or `current matrix' in redisplay
71 terminology.
72
73 For buffer parts that have been changed since the last update, a
74 second glyph matrix is constructed, the so called `desired glyph
75 matrix' or short `desired matrix'. Current and desired matrix are
76 then compared to find a cheap way to update the display, e.g. by
77 reusing part of the display by scrolling lines.
78
79 You will find a lot of redisplay optimizations when you start
80 looking at the innards of redisplay. The overall goal of all these
81 optimizations is to make redisplay fast because it is done
82 frequently. Some of these optimizations are implemented by the
83 following functions:
84
85 . try_cursor_movement
86
87 This function tries to update the display if the text in the
88 window did not change and did not scroll, only point moved, and
89 it did not move off the displayed portion of the text.
90
91 . try_window_reusing_current_matrix
92
93 This function reuses the current matrix of a window when text
94 has not changed, but the window start changed (e.g., due to
95 scrolling).
96
97 . try_window_id
98
99 This function attempts to redisplay a window by reusing parts of
100 its existing display. It finds and reuses the part that was not
101 changed, and redraws the rest. (The "id" part in the function's
102 name stands for "insert/delete", not for "identification" or
103 somesuch.)
104
105 . try_window
106
107 This function performs the full redisplay of a single window
108 assuming that its fonts were not changed and that the cursor
109 will not end up in the scroll margins. (Loading fonts requires
110 re-adjustment of dimensions of glyph matrices, which makes this
111 method impossible to use.)
112
113 These optimizations are tried in sequence (some can be skipped if
114 it is known that they are not applicable). If none of the
115 optimizations were successful, redisplay calls redisplay_windows,
116 which performs a full redisplay of all windows.
117
118 Note that there's one more important optimization up Emacs's
119 sleeve, but it is related to actually redrawing the potentially
120 changed portions of the window/frame, not to reproducing the
121 desired matrices of those potentially changed portions. Namely,
122 the function update_frame and its subroutines, which you will find
123 in dispnew.c, compare the desired matrices with the current
124 matrices, and only redraw the portions that changed. So it could
125 happen that the functions in this file for some reason decide that
126 the entire desired matrix needs to be regenerated from scratch, and
127 still only parts of the Emacs display, or even nothing at all, will
128 be actually delivered to the glass, because update_frame has found
129 that the new and the old screen contents are similar or identical.
130
131 Desired matrices.
132
133 Desired matrices are always built per Emacs window. The function
134 `display_line' is the central function to look at if you are
135 interested. It constructs one row in a desired matrix given an
136 iterator structure containing both a buffer position and a
137 description of the environment in which the text is to be
138 displayed. But this is too early, read on.
139
140 Characters and pixmaps displayed for a range of buffer text depend
141 on various settings of buffers and windows, on overlays and text
142 properties, on display tables, on selective display. The good news
143 is that all this hairy stuff is hidden behind a small set of
144 interface functions taking an iterator structure (struct it)
145 argument.
146
147 Iteration over things to be displayed is then simple. It is
148 started by initializing an iterator with a call to init_iterator,
149 passing it the buffer position where to start iteration. For
150 iteration over strings, pass -1 as the position to init_iterator,
151 and call reseat_to_string when the string is ready, to initialize
152 the iterator for that string. Thereafter, calls to
153 get_next_display_element fill the iterator structure with relevant
154 information about the next thing to display. Calls to
155 set_iterator_to_next move the iterator to the next thing.
156
157 Besides this, an iterator also contains information about the
158 display environment in which glyphs for display elements are to be
159 produced. It has fields for the width and height of the display,
160 the information whether long lines are truncated or continued, a
161 current X and Y position, and lots of other stuff you can better
162 see in dispextern.h.
163
164 Glyphs in a desired matrix are normally constructed in a loop
165 calling get_next_display_element and then PRODUCE_GLYPHS. The call
166 to PRODUCE_GLYPHS will fill the iterator structure with pixel
167 information about the element being displayed and at the same time
168 produce glyphs for it. If the display element fits on the line
169 being displayed, set_iterator_to_next is called next, otherwise the
170 glyphs produced are discarded. The function display_line is the
171 workhorse of filling glyph rows in the desired matrix with glyphs.
172 In addition to producing glyphs, it also handles line truncation
173 and continuation, word wrap, and cursor positioning (for the
174 latter, see also set_cursor_from_row).
175
176 Frame matrices.
177
178 That just couldn't be all, could it? What about terminal types not
179 supporting operations on sub-windows of the screen? To update the
180 display on such a terminal, window-based glyph matrices are not
181 well suited. To be able to reuse part of the display (scrolling
182 lines up and down), we must instead have a view of the whole
183 screen. This is what `frame matrices' are for. They are a trick.
184
185 Frames on terminals like above have a glyph pool. Windows on such
186 a frame sub-allocate their glyph memory from their frame's glyph
187 pool. The frame itself is given its own glyph matrices. By
188 coincidence---or maybe something else---rows in window glyph
189 matrices are slices of corresponding rows in frame matrices. Thus
190 writing to window matrices implicitly updates a frame matrix which
191 provides us with the view of the whole screen that we originally
192 wanted to have without having to move many bytes around. To be
193 honest, there is a little bit more done, but not much more. If you
194 plan to extend that code, take a look at dispnew.c. The function
195 build_frame_matrix is a good starting point.
196
197 Bidirectional display.
198
199 Bidirectional display adds quite some hair to this already complex
200 design. The good news are that a large portion of that hairy stuff
201 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
202 reordering engine which is called by set_iterator_to_next and
203 returns the next character to display in the visual order. See
204 commentary on bidi.c for more details. As far as redisplay is
205 concerned, the effect of calling bidi_move_to_visually_next, the
206 main interface of the reordering engine, is that the iterator gets
207 magically placed on the buffer or string position that is to be
208 displayed next. In other words, a linear iteration through the
209 buffer/string is replaced with a non-linear one. All the rest of
210 the redisplay is oblivious to the bidi reordering.
211
212 Well, almost oblivious---there are still complications, most of
213 them due to the fact that buffer and string positions no longer
214 change monotonously with glyph indices in a glyph row. Moreover,
215 for continued lines, the buffer positions may not even be
216 monotonously changing with vertical positions. Also, accounting
217 for face changes, overlays, etc. becomes more complex because
218 non-linear iteration could potentially skip many positions with
219 changes, and then cross them again on the way back...
220
221 One other prominent effect of bidirectional display is that some
222 paragraphs of text need to be displayed starting at the right
223 margin of the window---the so-called right-to-left, or R2L
224 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
225 which have their reversed_p flag set. The bidi reordering engine
226 produces characters in such rows starting from the character which
227 should be the rightmost on display. PRODUCE_GLYPHS then reverses
228 the order, when it fills up the glyph row whose reversed_p flag is
229 set, by prepending each new glyph to what is already there, instead
230 of appending it. When the glyph row is complete, the function
231 extend_face_to_end_of_line fills the empty space to the left of the
232 leftmost character with special glyphs, which will display as,
233 well, empty. On text terminals, these special glyphs are simply
234 blank characters. On graphics terminals, there's a single stretch
235 glyph of a suitably computed width. Both the blanks and the
236 stretch glyph are given the face of the background of the line.
237 This way, the terminal-specific back-end can still draw the glyphs
238 left to right, even for R2L lines.
239
240 Bidirectional display and character compositions
241
242 Some scripts cannot be displayed by drawing each character
243 individually, because adjacent characters change each other's shape
244 on display. For example, Arabic and Indic scripts belong to this
245 category.
246
247 Emacs display supports this by providing "character compositions",
248 most of which is implemented in composite.c. During the buffer
249 scan that delivers characters to PRODUCE_GLYPHS, if the next
250 character to be delivered is a composed character, the iteration
251 calls composition_reseat_it and next_element_from_composition. If
252 they succeed to compose the character with one or more of the
253 following characters, the whole sequence of characters that where
254 composed is recorded in the `struct composition_it' object that is
255 part of the buffer iterator. The composed sequence could produce
256 one or more font glyphs (called "grapheme clusters") on the screen.
257 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
258 in the direction corresponding to the current bidi scan direction
259 (recorded in the scan_dir member of the `struct bidi_it' object
260 that is part of the buffer iterator). In particular, if the bidi
261 iterator currently scans the buffer backwards, the grapheme
262 clusters are delivered back to front. This reorders the grapheme
263 clusters as appropriate for the current bidi context. Note that
264 this means that the grapheme clusters are always stored in the
265 LGSTRING object (see composite.c) in the logical order.
266
267 Moving an iterator in bidirectional text
268 without producing glyphs
269
270 Note one important detail mentioned above: that the bidi reordering
271 engine, driven by the iterator, produces characters in R2L rows
272 starting at the character that will be the rightmost on display.
273 As far as the iterator is concerned, the geometry of such rows is
274 still left to right, i.e. the iterator "thinks" the first character
275 is at the leftmost pixel position. The iterator does not know that
276 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
277 delivers. This is important when functions from the move_it_*
278 family are used to get to certain screen position or to match
279 screen coordinates with buffer coordinates: these functions use the
280 iterator geometry, which is left to right even in R2L paragraphs.
281 This works well with most callers of move_it_*, because they need
282 to get to a specific column, and columns are still numbered in the
283 reading order, i.e. the rightmost character in a R2L paragraph is
284 still column zero. But some callers do not get well with this; a
285 notable example is mouse clicks that need to find the character
286 that corresponds to certain pixel coordinates. See
287 buffer_posn_from_coords in dispnew.c for how this is handled. */
288
289 #include <config.h>
290 #include <stdio.h>
291 #include <limits.h>
292
293 #include "lisp.h"
294 #include "atimer.h"
295 #include "keyboard.h"
296 #include "frame.h"
297 #include "window.h"
298 #include "termchar.h"
299 #include "dispextern.h"
300 #include "character.h"
301 #include "buffer.h"
302 #include "charset.h"
303 #include "indent.h"
304 #include "commands.h"
305 #include "keymap.h"
306 #include "macros.h"
307 #include "disptab.h"
308 #include "termhooks.h"
309 #include "termopts.h"
310 #include "intervals.h"
311 #include "coding.h"
312 #include "process.h"
313 #include "region-cache.h"
314 #include "font.h"
315 #include "fontset.h"
316 #include "blockinput.h"
317 #ifdef HAVE_WINDOW_SYSTEM
318 #include TERM_HEADER
319 #endif /* HAVE_WINDOW_SYSTEM */
320
321 #ifndef FRAME_X_OUTPUT
322 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
323 #endif
324
325 #define INFINITY 10000000
326
327 /* Holds the list (error). */
328 static Lisp_Object list_of_error;
329
330 #ifdef HAVE_WINDOW_SYSTEM
331
332 /* Test if overflow newline into fringe. Called with iterator IT
333 at or past right window margin, and with IT->current_x set. */
334
335 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
336 (!NILP (Voverflow_newline_into_fringe) \
337 && FRAME_WINDOW_P ((IT)->f) \
338 && ((IT)->bidi_it.paragraph_dir == R2L \
339 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
340 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
341 && (IT)->current_x == (IT)->last_visible_x)
342
343 #else /* !HAVE_WINDOW_SYSTEM */
344 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) false
345 #endif /* HAVE_WINDOW_SYSTEM */
346
347 /* Test if the display element loaded in IT, or the underlying buffer
348 or string character, is a space or a TAB character. This is used
349 to determine where word wrapping can occur. */
350
351 #define IT_DISPLAYING_WHITESPACE(it) \
352 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
353 || ((STRINGP (it->string) \
354 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
355 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
356 || (it->s \
357 && (it->s[IT_BYTEPOS (*it)] == ' ' \
358 || it->s[IT_BYTEPOS (*it)] == '\t')) \
359 || (IT_BYTEPOS (*it) < ZV_BYTE \
360 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
361 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
362
363 /* True means print newline to stdout before next mini-buffer message. */
364
365 bool noninteractive_need_newline;
366
367 /* True means print newline to message log before next message. */
368
369 static bool message_log_need_newline;
370
371 /* Three markers that message_dolog uses.
372 It could allocate them itself, but that causes trouble
373 in handling memory-full errors. */
374 static Lisp_Object message_dolog_marker1;
375 static Lisp_Object message_dolog_marker2;
376 static Lisp_Object message_dolog_marker3;
377 \f
378 /* The buffer position of the first character appearing entirely or
379 partially on the line of the selected window which contains the
380 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
381 redisplay optimization in redisplay_internal. */
382
383 static struct text_pos this_line_start_pos;
384
385 /* Number of characters past the end of the line above, including the
386 terminating newline. */
387
388 static struct text_pos this_line_end_pos;
389
390 /* The vertical positions and the height of this line. */
391
392 static int this_line_vpos;
393 static int this_line_y;
394 static int this_line_pixel_height;
395
396 /* X position at which this display line starts. Usually zero;
397 negative if first character is partially visible. */
398
399 static int this_line_start_x;
400
401 /* The smallest character position seen by move_it_* functions as they
402 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
403 hscrolled lines, see display_line. */
404
405 static struct text_pos this_line_min_pos;
406
407 /* Buffer that this_line_.* variables are referring to. */
408
409 static struct buffer *this_line_buffer;
410
411 /* True if an overlay arrow has been displayed in this window. */
412
413 static bool overlay_arrow_seen;
414
415 /* Vector containing glyphs for an ellipsis `...'. */
416
417 static Lisp_Object default_invis_vector[3];
418
419 /* This is the window where the echo area message was displayed. It
420 is always a mini-buffer window, but it may not be the same window
421 currently active as a mini-buffer. */
422
423 Lisp_Object echo_area_window;
424
425 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
426 pushes the current message and the value of
427 message_enable_multibyte on the stack, the function restore_message
428 pops the stack and displays MESSAGE again. */
429
430 static Lisp_Object Vmessage_stack;
431
432 /* True means multibyte characters were enabled when the echo area
433 message was specified. */
434
435 static bool message_enable_multibyte;
436
437 /* Nonzero if we should redraw the mode lines on the next redisplay.
438 If it has value REDISPLAY_SOME, then only redisplay the mode lines where
439 the `redisplay' bit has been set. Otherwise, redisplay all mode lines
440 (the number used is then only used to track down the cause for this
441 full-redisplay). */
442
443 int update_mode_lines;
444
445 /* Nonzero if window sizes or contents other than selected-window have changed
446 since last redisplay that finished.
447 If it has value REDISPLAY_SOME, then only redisplay the windows where
448 the `redisplay' bit has been set. Otherwise, redisplay all windows
449 (the number used is then only used to track down the cause for this
450 full-redisplay). */
451
452 int windows_or_buffers_changed;
453
454 /* True after display_mode_line if %l was used and it displayed a
455 line number. */
456
457 static bool line_number_displayed;
458
459 /* The name of the *Messages* buffer, a string. */
460
461 static Lisp_Object Vmessages_buffer_name;
462
463 /* Current, index 0, and last displayed echo area message. Either
464 buffers from echo_buffers, or nil to indicate no message. */
465
466 Lisp_Object echo_area_buffer[2];
467
468 /* The buffers referenced from echo_area_buffer. */
469
470 static Lisp_Object echo_buffer[2];
471
472 /* A vector saved used in with_area_buffer to reduce consing. */
473
474 static Lisp_Object Vwith_echo_area_save_vector;
475
476 /* True means display_echo_area should display the last echo area
477 message again. Set by redisplay_preserve_echo_area. */
478
479 static bool display_last_displayed_message_p;
480
481 /* True if echo area is being used by print; false if being used by
482 message. */
483
484 static bool message_buf_print;
485
486 /* Set to true in clear_message to make redisplay_internal aware
487 of an emptied echo area. */
488
489 static bool message_cleared_p;
490
491 /* A scratch glyph row with contents used for generating truncation
492 glyphs. Also used in direct_output_for_insert. */
493
494 #define MAX_SCRATCH_GLYPHS 100
495 static struct glyph_row scratch_glyph_row;
496 static struct glyph scratch_glyphs[MAX_SCRATCH_GLYPHS];
497
498 /* Ascent and height of the last line processed by move_it_to. */
499
500 static int last_height;
501
502 /* True if there's a help-echo in the echo area. */
503
504 bool help_echo_showing_p;
505
506 /* The maximum distance to look ahead for text properties. Values
507 that are too small let us call compute_char_face and similar
508 functions too often which is expensive. Values that are too large
509 let us call compute_char_face and alike too often because we
510 might not be interested in text properties that far away. */
511
512 #define TEXT_PROP_DISTANCE_LIMIT 100
513
514 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
515 iterator state and later restore it. This is needed because the
516 bidi iterator on bidi.c keeps a stacked cache of its states, which
517 is really a singleton. When we use scratch iterator objects to
518 move around the buffer, we can cause the bidi cache to be pushed or
519 popped, and therefore we need to restore the cache state when we
520 return to the original iterator. */
521 #define SAVE_IT(ITCOPY, ITORIG, CACHE) \
522 do { \
523 if (CACHE) \
524 bidi_unshelve_cache (CACHE, true); \
525 ITCOPY = ITORIG; \
526 CACHE = bidi_shelve_cache (); \
527 } while (false)
528
529 #define RESTORE_IT(pITORIG, pITCOPY, CACHE) \
530 do { \
531 if (pITORIG != pITCOPY) \
532 *(pITORIG) = *(pITCOPY); \
533 bidi_unshelve_cache (CACHE, false); \
534 CACHE = NULL; \
535 } while (false)
536
537 /* Functions to mark elements as needing redisplay. */
538 enum { REDISPLAY_SOME = 2}; /* Arbitrary choice. */
539
540 void
541 redisplay_other_windows (void)
542 {
543 if (!windows_or_buffers_changed)
544 windows_or_buffers_changed = REDISPLAY_SOME;
545 }
546
547 void
548 wset_redisplay (struct window *w)
549 {
550 /* Beware: selected_window can be nil during early stages. */
551 if (!EQ (make_lisp_ptr (w, Lisp_Vectorlike), selected_window))
552 redisplay_other_windows ();
553 w->redisplay = true;
554 }
555
556 void
557 fset_redisplay (struct frame *f)
558 {
559 redisplay_other_windows ();
560 f->redisplay = true;
561 }
562
563 void
564 bset_redisplay (struct buffer *b)
565 {
566 int count = buffer_window_count (b);
567 if (count > 0)
568 {
569 /* ... it's visible in other window than selected, */
570 if (count > 1 || b != XBUFFER (XWINDOW (selected_window)->contents))
571 redisplay_other_windows ();
572 /* Even if we don't set windows_or_buffers_changed, do set `redisplay'
573 so that if we later set windows_or_buffers_changed, this buffer will
574 not be omitted. */
575 b->text->redisplay = true;
576 }
577 }
578
579 void
580 bset_update_mode_line (struct buffer *b)
581 {
582 if (!update_mode_lines)
583 update_mode_lines = REDISPLAY_SOME;
584 b->text->redisplay = true;
585 }
586
587 #ifdef GLYPH_DEBUG
588
589 /* True means print traces of redisplay if compiled with
590 GLYPH_DEBUG defined. */
591
592 bool trace_redisplay_p;
593
594 #endif /* GLYPH_DEBUG */
595
596 #ifdef DEBUG_TRACE_MOVE
597 /* True means trace with TRACE_MOVE to stderr. */
598 static bool trace_move;
599
600 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
601 #else
602 #define TRACE_MOVE(x) (void) 0
603 #endif
604
605 /* Buffer being redisplayed -- for redisplay_window_error. */
606
607 static struct buffer *displayed_buffer;
608
609 /* Value returned from text property handlers (see below). */
610
611 enum prop_handled
612 {
613 HANDLED_NORMALLY,
614 HANDLED_RECOMPUTE_PROPS,
615 HANDLED_OVERLAY_STRING_CONSUMED,
616 HANDLED_RETURN
617 };
618
619 /* A description of text properties that redisplay is interested
620 in. */
621
622 struct props
623 {
624 /* The symbol index of the name of the property. */
625 short name;
626
627 /* A unique index for the property. */
628 enum prop_idx idx;
629
630 /* A handler function called to set up iterator IT from the property
631 at IT's current position. Value is used to steer handle_stop. */
632 enum prop_handled (*handler) (struct it *it);
633 };
634
635 static enum prop_handled handle_face_prop (struct it *);
636 static enum prop_handled handle_invisible_prop (struct it *);
637 static enum prop_handled handle_display_prop (struct it *);
638 static enum prop_handled handle_composition_prop (struct it *);
639 static enum prop_handled handle_overlay_change (struct it *);
640 static enum prop_handled handle_fontified_prop (struct it *);
641
642 /* Properties handled by iterators. */
643
644 static struct props it_props[] =
645 {
646 {SYMBOL_INDEX (Qfontified), FONTIFIED_PROP_IDX, handle_fontified_prop},
647 /* Handle `face' before `display' because some sub-properties of
648 `display' need to know the face. */
649 {SYMBOL_INDEX (Qface), FACE_PROP_IDX, handle_face_prop},
650 {SYMBOL_INDEX (Qdisplay), DISPLAY_PROP_IDX, handle_display_prop},
651 {SYMBOL_INDEX (Qinvisible), INVISIBLE_PROP_IDX, handle_invisible_prop},
652 {SYMBOL_INDEX (Qcomposition), COMPOSITION_PROP_IDX, handle_composition_prop},
653 {0, 0, NULL}
654 };
655
656 /* Value is the position described by X. If X is a marker, value is
657 the marker_position of X. Otherwise, value is X. */
658
659 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
660
661 /* Enumeration returned by some move_it_.* functions internally. */
662
663 enum move_it_result
664 {
665 /* Not used. Undefined value. */
666 MOVE_UNDEFINED,
667
668 /* Move ended at the requested buffer position or ZV. */
669 MOVE_POS_MATCH_OR_ZV,
670
671 /* Move ended at the requested X pixel position. */
672 MOVE_X_REACHED,
673
674 /* Move within a line ended at the end of a line that must be
675 continued. */
676 MOVE_LINE_CONTINUED,
677
678 /* Move within a line ended at the end of a line that would
679 be displayed truncated. */
680 MOVE_LINE_TRUNCATED,
681
682 /* Move within a line ended at a line end. */
683 MOVE_NEWLINE_OR_CR
684 };
685
686 /* This counter is used to clear the face cache every once in a while
687 in redisplay_internal. It is incremented for each redisplay.
688 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
689 cleared. */
690
691 #define CLEAR_FACE_CACHE_COUNT 500
692 static int clear_face_cache_count;
693
694 /* Similarly for the image cache. */
695
696 #ifdef HAVE_WINDOW_SYSTEM
697 #define CLEAR_IMAGE_CACHE_COUNT 101
698 static int clear_image_cache_count;
699
700 /* Null glyph slice */
701 static struct glyph_slice null_glyph_slice = { 0, 0, 0, 0 };
702 #endif
703
704 /* True while redisplay_internal is in progress. */
705
706 bool redisplaying_p;
707
708 /* If a string, XTread_socket generates an event to display that string.
709 (The display is done in read_char.) */
710
711 Lisp_Object help_echo_string;
712 Lisp_Object help_echo_window;
713 Lisp_Object help_echo_object;
714 ptrdiff_t help_echo_pos;
715
716 /* Temporary variable for XTread_socket. */
717
718 Lisp_Object previous_help_echo_string;
719
720 /* Platform-independent portion of hourglass implementation. */
721
722 #ifdef HAVE_WINDOW_SYSTEM
723
724 /* True means an hourglass cursor is currently shown. */
725 static bool hourglass_shown_p;
726
727 /* If non-null, an asynchronous timer that, when it expires, displays
728 an hourglass cursor on all frames. */
729 static struct atimer *hourglass_atimer;
730
731 #endif /* HAVE_WINDOW_SYSTEM */
732
733 /* Default number of seconds to wait before displaying an hourglass
734 cursor. */
735 #define DEFAULT_HOURGLASS_DELAY 1
736
737 #ifdef HAVE_WINDOW_SYSTEM
738
739 /* Default pixel width of `thin-space' display method. */
740 #define THIN_SPACE_WIDTH 1
741
742 #endif /* HAVE_WINDOW_SYSTEM */
743
744 /* Function prototypes. */
745
746 static void setup_for_ellipsis (struct it *, int);
747 static void set_iterator_to_next (struct it *, bool);
748 static void mark_window_display_accurate_1 (struct window *, bool);
749 static bool row_for_charpos_p (struct glyph_row *, ptrdiff_t);
750 static bool cursor_row_p (struct glyph_row *);
751 static int redisplay_mode_lines (Lisp_Object, bool);
752
753 static void handle_line_prefix (struct it *);
754
755 static void handle_stop_backwards (struct it *, ptrdiff_t);
756 static void unwind_with_echo_area_buffer (Lisp_Object);
757 static Lisp_Object with_echo_area_buffer_unwind_data (struct window *);
758 static bool current_message_1 (ptrdiff_t, Lisp_Object);
759 static bool truncate_message_1 (ptrdiff_t, Lisp_Object);
760 static void set_message (Lisp_Object);
761 static bool set_message_1 (ptrdiff_t, Lisp_Object);
762 static bool display_echo_area_1 (ptrdiff_t, Lisp_Object);
763 static bool resize_mini_window_1 (ptrdiff_t, Lisp_Object);
764 static void unwind_redisplay (void);
765 static void extend_face_to_end_of_line (struct it *);
766 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
767 static void push_it (struct it *, struct text_pos *);
768 static void iterate_out_of_display_property (struct it *);
769 static void pop_it (struct it *);
770 static void redisplay_internal (void);
771 static void echo_area_display (bool);
772 static void redisplay_windows (Lisp_Object);
773 static void redisplay_window (Lisp_Object, bool);
774 static Lisp_Object redisplay_window_error (Lisp_Object);
775 static Lisp_Object redisplay_window_0 (Lisp_Object);
776 static Lisp_Object redisplay_window_1 (Lisp_Object);
777 static bool set_cursor_from_row (struct window *, struct glyph_row *,
778 struct glyph_matrix *, ptrdiff_t, ptrdiff_t,
779 int, int);
780 static bool update_menu_bar (struct frame *, bool, bool);
781 static bool try_window_reusing_current_matrix (struct window *);
782 static int try_window_id (struct window *);
783 static bool display_line (struct it *);
784 static int display_mode_lines (struct window *);
785 static int display_mode_line (struct window *, enum face_id, Lisp_Object);
786 static int display_mode_element (struct it *, int, int, int, Lisp_Object,
787 Lisp_Object, bool);
788 static int store_mode_line_string (const char *, Lisp_Object, bool, int, int,
789 Lisp_Object);
790 static const char *decode_mode_spec (struct window *, int, int, Lisp_Object *);
791 static void display_menu_bar (struct window *);
792 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
793 ptrdiff_t *);
794 static int display_string (const char *, Lisp_Object, Lisp_Object,
795 ptrdiff_t, ptrdiff_t, struct it *, int, int, int, int);
796 static void compute_line_metrics (struct it *);
797 static void run_redisplay_end_trigger_hook (struct it *);
798 static bool get_overlay_strings (struct it *, ptrdiff_t);
799 static bool get_overlay_strings_1 (struct it *, ptrdiff_t, bool);
800 static void next_overlay_string (struct it *);
801 static void reseat (struct it *, struct text_pos, bool);
802 static void reseat_1 (struct it *, struct text_pos, bool);
803 static bool next_element_from_display_vector (struct it *);
804 static bool next_element_from_string (struct it *);
805 static bool next_element_from_c_string (struct it *);
806 static bool next_element_from_buffer (struct it *);
807 static bool next_element_from_composition (struct it *);
808 static bool next_element_from_image (struct it *);
809 static bool next_element_from_stretch (struct it *);
810 static void load_overlay_strings (struct it *, ptrdiff_t);
811 static bool get_next_display_element (struct it *);
812 static enum move_it_result
813 move_it_in_display_line_to (struct it *, ptrdiff_t, int,
814 enum move_operation_enum);
815 static void get_visually_first_element (struct it *);
816 static void compute_stop_pos (struct it *);
817 static int face_before_or_after_it_pos (struct it *, bool);
818 static ptrdiff_t next_overlay_change (ptrdiff_t);
819 static int handle_display_spec (struct it *, Lisp_Object, Lisp_Object,
820 Lisp_Object, struct text_pos *, ptrdiff_t, bool);
821 static int handle_single_display_spec (struct it *, Lisp_Object,
822 Lisp_Object, Lisp_Object,
823 struct text_pos *, ptrdiff_t, int, bool);
824 static int underlying_face_id (struct it *);
825
826 #define face_before_it_pos(IT) face_before_or_after_it_pos (IT, true)
827 #define face_after_it_pos(IT) face_before_or_after_it_pos (IT, false)
828
829 #ifdef HAVE_WINDOW_SYSTEM
830
831 static void update_tool_bar (struct frame *, bool);
832 static void x_draw_bottom_divider (struct window *w);
833 static void notice_overwritten_cursor (struct window *,
834 enum glyph_row_area,
835 int, int, int, int);
836 static int normal_char_height (struct font *, int);
837 static void normal_char_ascent_descent (struct font *, int, int *, int *);
838
839 static void append_stretch_glyph (struct it *, Lisp_Object,
840 int, int, int);
841
842 static Lisp_Object get_it_property (struct it *, Lisp_Object);
843 static Lisp_Object calc_line_height_property (struct it *, Lisp_Object,
844 struct font *, int, bool);
845
846 #endif /* HAVE_WINDOW_SYSTEM */
847
848 static void produce_special_glyphs (struct it *, enum display_element_type);
849 static void show_mouse_face (Mouse_HLInfo *, enum draw_glyphs_face);
850 static bool coords_in_mouse_face_p (struct window *, int, int);
851
852
853 \f
854 /***********************************************************************
855 Window display dimensions
856 ***********************************************************************/
857
858 /* Return the bottom boundary y-position for text lines in window W.
859 This is the first y position at which a line cannot start.
860 It is relative to the top of the window.
861
862 This is the height of W minus the height of a mode line, if any. */
863
864 int
865 window_text_bottom_y (struct window *w)
866 {
867 int height = WINDOW_PIXEL_HEIGHT (w);
868
869 height -= WINDOW_BOTTOM_DIVIDER_WIDTH (w);
870
871 if (WINDOW_WANTS_MODELINE_P (w))
872 height -= CURRENT_MODE_LINE_HEIGHT (w);
873
874 height -= WINDOW_SCROLL_BAR_AREA_HEIGHT (w);
875
876 return height;
877 }
878
879 /* Return the pixel width of display area AREA of window W.
880 ANY_AREA means return the total width of W, not including
881 fringes to the left and right of the window. */
882
883 int
884 window_box_width (struct window *w, enum glyph_row_area area)
885 {
886 int width = w->pixel_width;
887
888 if (!w->pseudo_window_p)
889 {
890 width -= WINDOW_SCROLL_BAR_AREA_WIDTH (w);
891 width -= WINDOW_RIGHT_DIVIDER_WIDTH (w);
892
893 if (area == TEXT_AREA)
894 width -= (WINDOW_MARGINS_WIDTH (w)
895 + WINDOW_FRINGES_WIDTH (w));
896 else if (area == LEFT_MARGIN_AREA)
897 width = WINDOW_LEFT_MARGIN_WIDTH (w);
898 else if (area == RIGHT_MARGIN_AREA)
899 width = WINDOW_RIGHT_MARGIN_WIDTH (w);
900 }
901
902 /* With wide margins, fringes, etc. we might end up with a negative
903 width, correct that here. */
904 return max (0, width);
905 }
906
907
908 /* Return the pixel height of the display area of window W, not
909 including mode lines of W, if any. */
910
911 int
912 window_box_height (struct window *w)
913 {
914 struct frame *f = XFRAME (w->frame);
915 int height = WINDOW_PIXEL_HEIGHT (w);
916
917 eassert (height >= 0);
918
919 height -= WINDOW_BOTTOM_DIVIDER_WIDTH (w);
920 height -= WINDOW_SCROLL_BAR_AREA_HEIGHT (w);
921
922 /* Note: the code below that determines the mode-line/header-line
923 height is essentially the same as that contained in the macro
924 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
925 the appropriate glyph row has its `mode_line_p' flag set,
926 and if it doesn't, uses estimate_mode_line_height instead. */
927
928 if (WINDOW_WANTS_MODELINE_P (w))
929 {
930 struct glyph_row *ml_row
931 = (w->current_matrix && w->current_matrix->rows
932 ? MATRIX_MODE_LINE_ROW (w->current_matrix)
933 : 0);
934 if (ml_row && ml_row->mode_line_p)
935 height -= ml_row->height;
936 else
937 height -= estimate_mode_line_height (f, CURRENT_MODE_LINE_FACE_ID (w));
938 }
939
940 if (WINDOW_WANTS_HEADER_LINE_P (w))
941 {
942 struct glyph_row *hl_row
943 = (w->current_matrix && w->current_matrix->rows
944 ? MATRIX_HEADER_LINE_ROW (w->current_matrix)
945 : 0);
946 if (hl_row && hl_row->mode_line_p)
947 height -= hl_row->height;
948 else
949 height -= estimate_mode_line_height (f, HEADER_LINE_FACE_ID);
950 }
951
952 /* With a very small font and a mode-line that's taller than
953 default, we might end up with a negative height. */
954 return max (0, height);
955 }
956
957 /* Return the window-relative coordinate of the left edge of display
958 area AREA of window W. ANY_AREA means return the left edge of the
959 whole window, to the right of the left fringe of W. */
960
961 int
962 window_box_left_offset (struct window *w, enum glyph_row_area area)
963 {
964 int x;
965
966 if (w->pseudo_window_p)
967 return 0;
968
969 x = WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w);
970
971 if (area == TEXT_AREA)
972 x += (WINDOW_LEFT_FRINGE_WIDTH (w)
973 + window_box_width (w, LEFT_MARGIN_AREA));
974 else if (area == RIGHT_MARGIN_AREA)
975 x += (WINDOW_LEFT_FRINGE_WIDTH (w)
976 + window_box_width (w, LEFT_MARGIN_AREA)
977 + window_box_width (w, TEXT_AREA)
978 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
979 ? 0
980 : WINDOW_RIGHT_FRINGE_WIDTH (w)));
981 else if (area == LEFT_MARGIN_AREA
982 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
983 x += WINDOW_LEFT_FRINGE_WIDTH (w);
984
985 /* Don't return more than the window's pixel width. */
986 return min (x, w->pixel_width);
987 }
988
989
990 /* Return the window-relative coordinate of the right edge of display
991 area AREA of window W. ANY_AREA means return the right edge of the
992 whole window, to the left of the right fringe of W. */
993
994 static int
995 window_box_right_offset (struct window *w, enum glyph_row_area area)
996 {
997 /* Don't return more than the window's pixel width. */
998 return min (window_box_left_offset (w, area) + window_box_width (w, area),
999 w->pixel_width);
1000 }
1001
1002 /* Return the frame-relative coordinate of the left edge of display
1003 area AREA of window W. ANY_AREA means return the left edge of the
1004 whole window, to the right of the left fringe of W. */
1005
1006 int
1007 window_box_left (struct window *w, enum glyph_row_area area)
1008 {
1009 struct frame *f = XFRAME (w->frame);
1010 int x;
1011
1012 if (w->pseudo_window_p)
1013 return FRAME_INTERNAL_BORDER_WIDTH (f);
1014
1015 x = (WINDOW_LEFT_EDGE_X (w)
1016 + window_box_left_offset (w, area));
1017
1018 return x;
1019 }
1020
1021
1022 /* Return the frame-relative coordinate of the right edge of display
1023 area AREA of window W. ANY_AREA means return the right edge of the
1024 whole window, to the left of the right fringe of W. */
1025
1026 int
1027 window_box_right (struct window *w, enum glyph_row_area area)
1028 {
1029 return window_box_left (w, area) + window_box_width (w, area);
1030 }
1031
1032 /* Get the bounding box of the display area AREA of window W, without
1033 mode lines, in frame-relative coordinates. ANY_AREA means the
1034 whole window, not including the left and right fringes of
1035 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1036 coordinates of the upper-left corner of the box. Return in
1037 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1038
1039 void
1040 window_box (struct window *w, enum glyph_row_area area, int *box_x,
1041 int *box_y, int *box_width, int *box_height)
1042 {
1043 if (box_width)
1044 *box_width = window_box_width (w, area);
1045 if (box_height)
1046 *box_height = window_box_height (w);
1047 if (box_x)
1048 *box_x = window_box_left (w, area);
1049 if (box_y)
1050 {
1051 *box_y = WINDOW_TOP_EDGE_Y (w);
1052 if (WINDOW_WANTS_HEADER_LINE_P (w))
1053 *box_y += CURRENT_HEADER_LINE_HEIGHT (w);
1054 }
1055 }
1056
1057 #ifdef HAVE_WINDOW_SYSTEM
1058
1059 /* Get the bounding box of the display area AREA of window W, without
1060 mode lines and both fringes of the window. Return in *TOP_LEFT_X
1061 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1062 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1063 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1064 box. */
1065
1066 static void
1067 window_box_edges (struct window *w, int *top_left_x, int *top_left_y,
1068 int *bottom_right_x, int *bottom_right_y)
1069 {
1070 window_box (w, ANY_AREA, top_left_x, top_left_y,
1071 bottom_right_x, bottom_right_y);
1072 *bottom_right_x += *top_left_x;
1073 *bottom_right_y += *top_left_y;
1074 }
1075
1076 #endif /* HAVE_WINDOW_SYSTEM */
1077
1078 /***********************************************************************
1079 Utilities
1080 ***********************************************************************/
1081
1082 /* Return the bottom y-position of the line the iterator IT is in.
1083 This can modify IT's settings. */
1084
1085 int
1086 line_bottom_y (struct it *it)
1087 {
1088 int line_height = it->max_ascent + it->max_descent;
1089 int line_top_y = it->current_y;
1090
1091 if (line_height == 0)
1092 {
1093 if (last_height)
1094 line_height = last_height;
1095 else if (IT_CHARPOS (*it) < ZV)
1096 {
1097 move_it_by_lines (it, 1);
1098 line_height = (it->max_ascent || it->max_descent
1099 ? it->max_ascent + it->max_descent
1100 : last_height);
1101 }
1102 else
1103 {
1104 struct glyph_row *row = it->glyph_row;
1105
1106 /* Use the default character height. */
1107 it->glyph_row = NULL;
1108 it->what = IT_CHARACTER;
1109 it->c = ' ';
1110 it->len = 1;
1111 PRODUCE_GLYPHS (it);
1112 line_height = it->ascent + it->descent;
1113 it->glyph_row = row;
1114 }
1115 }
1116
1117 return line_top_y + line_height;
1118 }
1119
1120 DEFUN ("line-pixel-height", Fline_pixel_height,
1121 Sline_pixel_height, 0, 0, 0,
1122 doc: /* Return height in pixels of text line in the selected window.
1123
1124 Value is the height in pixels of the line at point. */)
1125 (void)
1126 {
1127 struct it it;
1128 struct text_pos pt;
1129 struct window *w = XWINDOW (selected_window);
1130 struct buffer *old_buffer = NULL;
1131 Lisp_Object result;
1132
1133 if (XBUFFER (w->contents) != current_buffer)
1134 {
1135 old_buffer = current_buffer;
1136 set_buffer_internal_1 (XBUFFER (w->contents));
1137 }
1138 SET_TEXT_POS (pt, PT, PT_BYTE);
1139 start_display (&it, w, pt);
1140 it.vpos = it.current_y = 0;
1141 last_height = 0;
1142 result = make_number (line_bottom_y (&it));
1143 if (old_buffer)
1144 set_buffer_internal_1 (old_buffer);
1145
1146 return result;
1147 }
1148
1149 /* Return the default pixel height of text lines in window W. The
1150 value is the canonical height of the W frame's default font, plus
1151 any extra space required by the line-spacing variable or frame
1152 parameter.
1153
1154 Implementation note: this ignores any line-spacing text properties
1155 put on the newline characters. This is because those properties
1156 only affect the _screen_ line ending in the newline (i.e., in a
1157 continued line, only the last screen line will be affected), which
1158 means only a small number of lines in a buffer can ever use this
1159 feature. Since this function is used to compute the default pixel
1160 equivalent of text lines in a window, we can safely ignore those
1161 few lines. For the same reasons, we ignore the line-height
1162 properties. */
1163 int
1164 default_line_pixel_height (struct window *w)
1165 {
1166 struct frame *f = WINDOW_XFRAME (w);
1167 int height = FRAME_LINE_HEIGHT (f);
1168
1169 if (!FRAME_INITIAL_P (f) && BUFFERP (w->contents))
1170 {
1171 struct buffer *b = XBUFFER (w->contents);
1172 Lisp_Object val = BVAR (b, extra_line_spacing);
1173
1174 if (NILP (val))
1175 val = BVAR (&buffer_defaults, extra_line_spacing);
1176 if (!NILP (val))
1177 {
1178 if (RANGED_INTEGERP (0, val, INT_MAX))
1179 height += XFASTINT (val);
1180 else if (FLOATP (val))
1181 {
1182 int addon = XFLOAT_DATA (val) * height + 0.5;
1183
1184 if (addon >= 0)
1185 height += addon;
1186 }
1187 }
1188 else
1189 height += f->extra_line_spacing;
1190 }
1191
1192 return height;
1193 }
1194
1195 /* Subroutine of pos_visible_p below. Extracts a display string, if
1196 any, from the display spec given as its argument. */
1197 static Lisp_Object
1198 string_from_display_spec (Lisp_Object spec)
1199 {
1200 if (CONSP (spec))
1201 {
1202 while (CONSP (spec))
1203 {
1204 if (STRINGP (XCAR (spec)))
1205 return XCAR (spec);
1206 spec = XCDR (spec);
1207 }
1208 }
1209 else if (VECTORP (spec))
1210 {
1211 ptrdiff_t i;
1212
1213 for (i = 0; i < ASIZE (spec); i++)
1214 {
1215 if (STRINGP (AREF (spec, i)))
1216 return AREF (spec, i);
1217 }
1218 return Qnil;
1219 }
1220
1221 return spec;
1222 }
1223
1224
1225 /* Limit insanely large values of W->hscroll on frame F to the largest
1226 value that will still prevent first_visible_x and last_visible_x of
1227 'struct it' from overflowing an int. */
1228 static int
1229 window_hscroll_limited (struct window *w, struct frame *f)
1230 {
1231 ptrdiff_t window_hscroll = w->hscroll;
1232 int window_text_width = window_box_width (w, TEXT_AREA);
1233 int colwidth = FRAME_COLUMN_WIDTH (f);
1234
1235 if (window_hscroll > (INT_MAX - window_text_width) / colwidth - 1)
1236 window_hscroll = (INT_MAX - window_text_width) / colwidth - 1;
1237
1238 return window_hscroll;
1239 }
1240
1241 /* Return true if position CHARPOS is visible in window W.
1242 CHARPOS < 0 means return info about WINDOW_END position.
1243 If visible, set *X and *Y to pixel coordinates of top left corner.
1244 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1245 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1246
1247 bool
1248 pos_visible_p (struct window *w, ptrdiff_t charpos, int *x, int *y,
1249 int *rtop, int *rbot, int *rowh, int *vpos)
1250 {
1251 struct it it;
1252 void *itdata = bidi_shelve_cache ();
1253 struct text_pos top;
1254 bool visible_p = false;
1255 struct buffer *old_buffer = NULL;
1256 bool r2l = false;
1257
1258 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w))))
1259 return visible_p;
1260
1261 if (XBUFFER (w->contents) != current_buffer)
1262 {
1263 old_buffer = current_buffer;
1264 set_buffer_internal_1 (XBUFFER (w->contents));
1265 }
1266
1267 SET_TEXT_POS_FROM_MARKER (top, w->start);
1268 /* Scrolling a minibuffer window via scroll bar when the echo area
1269 shows long text sometimes resets the minibuffer contents behind
1270 our backs. */
1271 if (CHARPOS (top) > ZV)
1272 SET_TEXT_POS (top, BEGV, BEGV_BYTE);
1273
1274 /* Compute exact mode line heights. */
1275 if (WINDOW_WANTS_MODELINE_P (w))
1276 w->mode_line_height
1277 = display_mode_line (w, CURRENT_MODE_LINE_FACE_ID (w),
1278 BVAR (current_buffer, mode_line_format));
1279
1280 if (WINDOW_WANTS_HEADER_LINE_P (w))
1281 w->header_line_height
1282 = display_mode_line (w, HEADER_LINE_FACE_ID,
1283 BVAR (current_buffer, header_line_format));
1284
1285 start_display (&it, w, top);
1286 move_it_to (&it, charpos, -1, it.last_visible_y - 1, -1,
1287 (charpos >= 0 ? MOVE_TO_POS : 0) | MOVE_TO_Y);
1288
1289 if (charpos >= 0
1290 && (((!it.bidi_p || it.bidi_it.scan_dir != -1)
1291 && IT_CHARPOS (it) >= charpos)
1292 /* When scanning backwards under bidi iteration, move_it_to
1293 stops at or _before_ CHARPOS, because it stops at or to
1294 the _right_ of the character at CHARPOS. */
1295 || (it.bidi_p && it.bidi_it.scan_dir == -1
1296 && IT_CHARPOS (it) <= charpos)))
1297 {
1298 /* We have reached CHARPOS, or passed it. How the call to
1299 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1300 or covered by a display property, move_it_to stops at the end
1301 of the invisible text, to the right of CHARPOS. (ii) If
1302 CHARPOS is in a display vector, move_it_to stops on its last
1303 glyph. */
1304 int top_x = it.current_x;
1305 int top_y = it.current_y;
1306 int window_top_y = WINDOW_HEADER_LINE_HEIGHT (w);
1307 int bottom_y;
1308 struct it save_it;
1309 void *save_it_data = NULL;
1310
1311 /* Calling line_bottom_y may change it.method, it.position, etc. */
1312 SAVE_IT (save_it, it, save_it_data);
1313 last_height = 0;
1314 bottom_y = line_bottom_y (&it);
1315 if (top_y < window_top_y)
1316 visible_p = bottom_y > window_top_y;
1317 else if (top_y < it.last_visible_y)
1318 visible_p = true;
1319 if (bottom_y >= it.last_visible_y
1320 && it.bidi_p && it.bidi_it.scan_dir == -1
1321 && IT_CHARPOS (it) < charpos)
1322 {
1323 /* When the last line of the window is scanned backwards
1324 under bidi iteration, we could be duped into thinking
1325 that we have passed CHARPOS, when in fact move_it_to
1326 simply stopped short of CHARPOS because it reached
1327 last_visible_y. To see if that's what happened, we call
1328 move_it_to again with a slightly larger vertical limit,
1329 and see if it actually moved vertically; if it did, we
1330 didn't really reach CHARPOS, which is beyond window end. */
1331 /* Why 10? because we don't know how many canonical lines
1332 will the height of the next line(s) be. So we guess. */
1333 int ten_more_lines = 10 * default_line_pixel_height (w);
1334
1335 move_it_to (&it, charpos, -1, bottom_y + ten_more_lines, -1,
1336 MOVE_TO_POS | MOVE_TO_Y);
1337 if (it.current_y > top_y)
1338 visible_p = false;
1339
1340 }
1341 RESTORE_IT (&it, &save_it, save_it_data);
1342 if (visible_p)
1343 {
1344 if (it.method == GET_FROM_DISPLAY_VECTOR)
1345 {
1346 /* We stopped on the last glyph of a display vector.
1347 Try and recompute. Hack alert! */
1348 if (charpos < 2 || top.charpos >= charpos)
1349 top_x = it.glyph_row->x;
1350 else
1351 {
1352 struct it it2, it2_prev;
1353 /* The idea is to get to the previous buffer
1354 position, consume the character there, and use
1355 the pixel coordinates we get after that. But if
1356 the previous buffer position is also displayed
1357 from a display vector, we need to consume all of
1358 the glyphs from that display vector. */
1359 start_display (&it2, w, top);
1360 move_it_to (&it2, charpos - 1, -1, -1, -1, MOVE_TO_POS);
1361 /* If we didn't get to CHARPOS - 1, there's some
1362 replacing display property at that position, and
1363 we stopped after it. That is exactly the place
1364 whose coordinates we want. */
1365 if (IT_CHARPOS (it2) != charpos - 1)
1366 it2_prev = it2;
1367 else
1368 {
1369 /* Iterate until we get out of the display
1370 vector that displays the character at
1371 CHARPOS - 1. */
1372 do {
1373 get_next_display_element (&it2);
1374 PRODUCE_GLYPHS (&it2);
1375 it2_prev = it2;
1376 set_iterator_to_next (&it2, true);
1377 } while (it2.method == GET_FROM_DISPLAY_VECTOR
1378 && IT_CHARPOS (it2) < charpos);
1379 }
1380 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev)
1381 || it2_prev.current_x > it2_prev.last_visible_x)
1382 top_x = it.glyph_row->x;
1383 else
1384 {
1385 top_x = it2_prev.current_x;
1386 top_y = it2_prev.current_y;
1387 }
1388 }
1389 }
1390 else if (IT_CHARPOS (it) != charpos)
1391 {
1392 Lisp_Object cpos = make_number (charpos);
1393 Lisp_Object spec = Fget_char_property (cpos, Qdisplay, Qnil);
1394 Lisp_Object string = string_from_display_spec (spec);
1395 struct text_pos tpos;
1396 bool newline_in_string
1397 = (STRINGP (string)
1398 && memchr (SDATA (string), '\n', SBYTES (string)));
1399
1400 SET_TEXT_POS (tpos, charpos, CHAR_TO_BYTE (charpos));
1401 bool replacing_spec_p
1402 = (!NILP (spec)
1403 && handle_display_spec (NULL, spec, Qnil, Qnil, &tpos,
1404 charpos, FRAME_WINDOW_P (it.f)));
1405 /* The tricky code below is needed because there's a
1406 discrepancy between move_it_to and how we set cursor
1407 when PT is at the beginning of a portion of text
1408 covered by a display property or an overlay with a
1409 display property, or the display line ends in a
1410 newline from a display string. move_it_to will stop
1411 _after_ such display strings, whereas
1412 set_cursor_from_row conspires with cursor_row_p to
1413 place the cursor on the first glyph produced from the
1414 display string. */
1415
1416 /* We have overshoot PT because it is covered by a
1417 display property that replaces the text it covers.
1418 If the string includes embedded newlines, we are also
1419 in the wrong display line. Backtrack to the correct
1420 line, where the display property begins. */
1421 if (replacing_spec_p)
1422 {
1423 Lisp_Object startpos, endpos;
1424 EMACS_INT start, end;
1425 struct it it3;
1426
1427 /* Find the first and the last buffer positions
1428 covered by the display string. */
1429 endpos =
1430 Fnext_single_char_property_change (cpos, Qdisplay,
1431 Qnil, Qnil);
1432 startpos =
1433 Fprevious_single_char_property_change (endpos, Qdisplay,
1434 Qnil, Qnil);
1435 start = XFASTINT (startpos);
1436 end = XFASTINT (endpos);
1437 /* Move to the last buffer position before the
1438 display property. */
1439 start_display (&it3, w, top);
1440 if (start > CHARPOS (top))
1441 move_it_to (&it3, start - 1, -1, -1, -1, MOVE_TO_POS);
1442 /* Move forward one more line if the position before
1443 the display string is a newline or if it is the
1444 rightmost character on a line that is
1445 continued or word-wrapped. */
1446 if (it3.method == GET_FROM_BUFFER
1447 && (it3.c == '\n'
1448 || FETCH_BYTE (IT_BYTEPOS (it3)) == '\n'))
1449 move_it_by_lines (&it3, 1);
1450 else if (move_it_in_display_line_to (&it3, -1,
1451 it3.current_x
1452 + it3.pixel_width,
1453 MOVE_TO_X)
1454 == MOVE_LINE_CONTINUED)
1455 {
1456 move_it_by_lines (&it3, 1);
1457 /* When we are under word-wrap, the #$@%!
1458 move_it_by_lines moves 2 lines, so we need to
1459 fix that up. */
1460 if (it3.line_wrap == WORD_WRAP)
1461 move_it_by_lines (&it3, -1);
1462 }
1463
1464 /* Record the vertical coordinate of the display
1465 line where we wound up. */
1466 top_y = it3.current_y;
1467 if (it3.bidi_p)
1468 {
1469 /* When characters are reordered for display,
1470 the character displayed to the left of the
1471 display string could be _after_ the display
1472 property in the logical order. Use the
1473 smallest vertical position of these two. */
1474 start_display (&it3, w, top);
1475 move_it_to (&it3, end + 1, -1, -1, -1, MOVE_TO_POS);
1476 if (it3.current_y < top_y)
1477 top_y = it3.current_y;
1478 }
1479 /* Move from the top of the window to the beginning
1480 of the display line where the display string
1481 begins. */
1482 start_display (&it3, w, top);
1483 move_it_to (&it3, -1, 0, top_y, -1, MOVE_TO_X | MOVE_TO_Y);
1484 /* If it3_moved stays false after the 'while' loop
1485 below, that means we already were at a newline
1486 before the loop (e.g., the display string begins
1487 with a newline), so we don't need to (and cannot)
1488 inspect the glyphs of it3.glyph_row, because
1489 PRODUCE_GLYPHS will not produce anything for a
1490 newline, and thus it3.glyph_row stays at its
1491 stale content it got at top of the window. */
1492 bool it3_moved = false;
1493 /* Finally, advance the iterator until we hit the
1494 first display element whose character position is
1495 CHARPOS, or until the first newline from the
1496 display string, which signals the end of the
1497 display line. */
1498 while (get_next_display_element (&it3))
1499 {
1500 PRODUCE_GLYPHS (&it3);
1501 if (IT_CHARPOS (it3) == charpos
1502 || ITERATOR_AT_END_OF_LINE_P (&it3))
1503 break;
1504 it3_moved = true;
1505 set_iterator_to_next (&it3, false);
1506 }
1507 top_x = it3.current_x - it3.pixel_width;
1508 /* Normally, we would exit the above loop because we
1509 found the display element whose character
1510 position is CHARPOS. For the contingency that we
1511 didn't, and stopped at the first newline from the
1512 display string, move back over the glyphs
1513 produced from the string, until we find the
1514 rightmost glyph not from the string. */
1515 if (it3_moved
1516 && newline_in_string
1517 && IT_CHARPOS (it3) != charpos && EQ (it3.object, string))
1518 {
1519 struct glyph *g = it3.glyph_row->glyphs[TEXT_AREA]
1520 + it3.glyph_row->used[TEXT_AREA];
1521
1522 while (EQ ((g - 1)->object, string))
1523 {
1524 --g;
1525 top_x -= g->pixel_width;
1526 }
1527 eassert (g < it3.glyph_row->glyphs[TEXT_AREA]
1528 + it3.glyph_row->used[TEXT_AREA]);
1529 }
1530 }
1531 }
1532
1533 *x = top_x;
1534 *y = max (top_y + max (0, it.max_ascent - it.ascent), window_top_y);
1535 *rtop = max (0, window_top_y - top_y);
1536 *rbot = max (0, bottom_y - it.last_visible_y);
1537 *rowh = max (0, (min (bottom_y, it.last_visible_y)
1538 - max (top_y, window_top_y)));
1539 *vpos = it.vpos;
1540 if (it.bidi_it.paragraph_dir == R2L)
1541 r2l = true;
1542 }
1543 }
1544 else
1545 {
1546 /* Either we were asked to provide info about WINDOW_END, or
1547 CHARPOS is in the partially visible glyph row at end of
1548 window. */
1549 struct it it2;
1550 void *it2data = NULL;
1551
1552 SAVE_IT (it2, it, it2data);
1553 if (IT_CHARPOS (it) < ZV && FETCH_BYTE (IT_BYTEPOS (it)) != '\n')
1554 move_it_by_lines (&it, 1);
1555 if (charpos < IT_CHARPOS (it)
1556 || (it.what == IT_EOB && charpos == IT_CHARPOS (it)))
1557 {
1558 visible_p = true;
1559 RESTORE_IT (&it2, &it2, it2data);
1560 move_it_to (&it2, charpos, -1, -1, -1, MOVE_TO_POS);
1561 *x = it2.current_x;
1562 *y = it2.current_y + it2.max_ascent - it2.ascent;
1563 *rtop = max (0, -it2.current_y);
1564 *rbot = max (0, ((it2.current_y + it2.max_ascent + it2.max_descent)
1565 - it.last_visible_y));
1566 *rowh = max (0, (min (it2.current_y + it2.max_ascent + it2.max_descent,
1567 it.last_visible_y)
1568 - max (it2.current_y,
1569 WINDOW_HEADER_LINE_HEIGHT (w))));
1570 *vpos = it2.vpos;
1571 if (it2.bidi_it.paragraph_dir == R2L)
1572 r2l = true;
1573 }
1574 else
1575 bidi_unshelve_cache (it2data, true);
1576 }
1577 bidi_unshelve_cache (itdata, false);
1578
1579 if (old_buffer)
1580 set_buffer_internal_1 (old_buffer);
1581
1582 if (visible_p)
1583 {
1584 if (w->hscroll > 0)
1585 *x -=
1586 window_hscroll_limited (w, WINDOW_XFRAME (w))
1587 * WINDOW_FRAME_COLUMN_WIDTH (w);
1588 /* For lines in an R2L paragraph, we need to mirror the X pixel
1589 coordinate wrt the text area. For the reasons, see the
1590 commentary in buffer_posn_from_coords and the explanation of
1591 the geometry used by the move_it_* functions at the end of
1592 the large commentary near the beginning of this file. */
1593 if (r2l)
1594 *x = window_box_width (w, TEXT_AREA) - *x - 1;
1595 }
1596
1597 #if false
1598 /* Debugging code. */
1599 if (visible_p)
1600 fprintf (stderr, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1601 charpos, w->vscroll, *x, *y, *rtop, *rbot, *rowh, *vpos);
1602 else
1603 fprintf (stderr, "-pv pt=%d vs=%d\n", charpos, w->vscroll);
1604 #endif
1605
1606 return visible_p;
1607 }
1608
1609
1610 /* Return the next character from STR. Return in *LEN the length of
1611 the character. This is like STRING_CHAR_AND_LENGTH but never
1612 returns an invalid character. If we find one, we return a `?', but
1613 with the length of the invalid character. */
1614
1615 static int
1616 string_char_and_length (const unsigned char *str, int *len)
1617 {
1618 int c;
1619
1620 c = STRING_CHAR_AND_LENGTH (str, *len);
1621 if (!CHAR_VALID_P (c))
1622 /* We may not change the length here because other places in Emacs
1623 don't use this function, i.e. they silently accept invalid
1624 characters. */
1625 c = '?';
1626
1627 return c;
1628 }
1629
1630
1631
1632 /* Given a position POS containing a valid character and byte position
1633 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1634
1635 static struct text_pos
1636 string_pos_nchars_ahead (struct text_pos pos, Lisp_Object string, ptrdiff_t nchars)
1637 {
1638 eassert (STRINGP (string) && nchars >= 0);
1639
1640 if (STRING_MULTIBYTE (string))
1641 {
1642 const unsigned char *p = SDATA (string) + BYTEPOS (pos);
1643 int len;
1644
1645 while (nchars--)
1646 {
1647 string_char_and_length (p, &len);
1648 p += len;
1649 CHARPOS (pos) += 1;
1650 BYTEPOS (pos) += len;
1651 }
1652 }
1653 else
1654 SET_TEXT_POS (pos, CHARPOS (pos) + nchars, BYTEPOS (pos) + nchars);
1655
1656 return pos;
1657 }
1658
1659
1660 /* Value is the text position, i.e. character and byte position,
1661 for character position CHARPOS in STRING. */
1662
1663 static struct text_pos
1664 string_pos (ptrdiff_t charpos, Lisp_Object string)
1665 {
1666 struct text_pos pos;
1667 eassert (STRINGP (string));
1668 eassert (charpos >= 0);
1669 SET_TEXT_POS (pos, charpos, string_char_to_byte (string, charpos));
1670 return pos;
1671 }
1672
1673
1674 /* Value is a text position, i.e. character and byte position, for
1675 character position CHARPOS in C string S. MULTIBYTE_P
1676 means recognize multibyte characters. */
1677
1678 static struct text_pos
1679 c_string_pos (ptrdiff_t charpos, const char *s, bool multibyte_p)
1680 {
1681 struct text_pos pos;
1682
1683 eassert (s != NULL);
1684 eassert (charpos >= 0);
1685
1686 if (multibyte_p)
1687 {
1688 int len;
1689
1690 SET_TEXT_POS (pos, 0, 0);
1691 while (charpos--)
1692 {
1693 string_char_and_length ((const unsigned char *) s, &len);
1694 s += len;
1695 CHARPOS (pos) += 1;
1696 BYTEPOS (pos) += len;
1697 }
1698 }
1699 else
1700 SET_TEXT_POS (pos, charpos, charpos);
1701
1702 return pos;
1703 }
1704
1705
1706 /* Value is the number of characters in C string S. MULTIBYTE_P
1707 means recognize multibyte characters. */
1708
1709 static ptrdiff_t
1710 number_of_chars (const char *s, bool multibyte_p)
1711 {
1712 ptrdiff_t nchars;
1713
1714 if (multibyte_p)
1715 {
1716 ptrdiff_t rest = strlen (s);
1717 int len;
1718 const unsigned char *p = (const unsigned char *) s;
1719
1720 for (nchars = 0; rest > 0; ++nchars)
1721 {
1722 string_char_and_length (p, &len);
1723 rest -= len, p += len;
1724 }
1725 }
1726 else
1727 nchars = strlen (s);
1728
1729 return nchars;
1730 }
1731
1732
1733 /* Compute byte position NEWPOS->bytepos corresponding to
1734 NEWPOS->charpos. POS is a known position in string STRING.
1735 NEWPOS->charpos must be >= POS.charpos. */
1736
1737 static void
1738 compute_string_pos (struct text_pos *newpos, struct text_pos pos, Lisp_Object string)
1739 {
1740 eassert (STRINGP (string));
1741 eassert (CHARPOS (*newpos) >= CHARPOS (pos));
1742
1743 if (STRING_MULTIBYTE (string))
1744 *newpos = string_pos_nchars_ahead (pos, string,
1745 CHARPOS (*newpos) - CHARPOS (pos));
1746 else
1747 BYTEPOS (*newpos) = CHARPOS (*newpos);
1748 }
1749
1750 /* EXPORT:
1751 Return an estimation of the pixel height of mode or header lines on
1752 frame F. FACE_ID specifies what line's height to estimate. */
1753
1754 int
1755 estimate_mode_line_height (struct frame *f, enum face_id face_id)
1756 {
1757 #ifdef HAVE_WINDOW_SYSTEM
1758 if (FRAME_WINDOW_P (f))
1759 {
1760 int height = FONT_HEIGHT (FRAME_FONT (f));
1761
1762 /* This function is called so early when Emacs starts that the face
1763 cache and mode line face are not yet initialized. */
1764 if (FRAME_FACE_CACHE (f))
1765 {
1766 struct face *face = FACE_FROM_ID (f, face_id);
1767 if (face)
1768 {
1769 if (face->font)
1770 height = normal_char_height (face->font, -1);
1771 if (face->box_line_width > 0)
1772 height += 2 * face->box_line_width;
1773 }
1774 }
1775
1776 return height;
1777 }
1778 #endif
1779
1780 return 1;
1781 }
1782
1783 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1784 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1785 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP, do
1786 not force the value into range. */
1787
1788 void
1789 pixel_to_glyph_coords (struct frame *f, int pix_x, int pix_y, int *x, int *y,
1790 NativeRectangle *bounds, bool noclip)
1791 {
1792
1793 #ifdef HAVE_WINDOW_SYSTEM
1794 if (FRAME_WINDOW_P (f))
1795 {
1796 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1797 even for negative values. */
1798 if (pix_x < 0)
1799 pix_x -= FRAME_COLUMN_WIDTH (f) - 1;
1800 if (pix_y < 0)
1801 pix_y -= FRAME_LINE_HEIGHT (f) - 1;
1802
1803 pix_x = FRAME_PIXEL_X_TO_COL (f, pix_x);
1804 pix_y = FRAME_PIXEL_Y_TO_LINE (f, pix_y);
1805
1806 if (bounds)
1807 STORE_NATIVE_RECT (*bounds,
1808 FRAME_COL_TO_PIXEL_X (f, pix_x),
1809 FRAME_LINE_TO_PIXEL_Y (f, pix_y),
1810 FRAME_COLUMN_WIDTH (f) - 1,
1811 FRAME_LINE_HEIGHT (f) - 1);
1812
1813 /* PXW: Should we clip pixels before converting to columns/lines? */
1814 if (!noclip)
1815 {
1816 if (pix_x < 0)
1817 pix_x = 0;
1818 else if (pix_x > FRAME_TOTAL_COLS (f))
1819 pix_x = FRAME_TOTAL_COLS (f);
1820
1821 if (pix_y < 0)
1822 pix_y = 0;
1823 else if (pix_y > FRAME_TOTAL_LINES (f))
1824 pix_y = FRAME_TOTAL_LINES (f);
1825 }
1826 }
1827 #endif
1828
1829 *x = pix_x;
1830 *y = pix_y;
1831 }
1832
1833
1834 /* Find the glyph under window-relative coordinates X/Y in window W.
1835 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1836 strings. Return in *HPOS and *VPOS the row and column number of
1837 the glyph found. Return in *AREA the glyph area containing X.
1838 Value is a pointer to the glyph found or null if X/Y is not on
1839 text, or we can't tell because W's current matrix is not up to
1840 date. */
1841
1842 static struct glyph *
1843 x_y_to_hpos_vpos (struct window *w, int x, int y, int *hpos, int *vpos,
1844 int *dx, int *dy, int *area)
1845 {
1846 struct glyph *glyph, *end;
1847 struct glyph_row *row = NULL;
1848 int x0, i;
1849
1850 /* Find row containing Y. Give up if some row is not enabled. */
1851 for (i = 0; i < w->current_matrix->nrows; ++i)
1852 {
1853 row = MATRIX_ROW (w->current_matrix, i);
1854 if (!row->enabled_p)
1855 return NULL;
1856 if (y >= row->y && y < MATRIX_ROW_BOTTOM_Y (row))
1857 break;
1858 }
1859
1860 *vpos = i;
1861 *hpos = 0;
1862
1863 /* Give up if Y is not in the window. */
1864 if (i == w->current_matrix->nrows)
1865 return NULL;
1866
1867 /* Get the glyph area containing X. */
1868 if (w->pseudo_window_p)
1869 {
1870 *area = TEXT_AREA;
1871 x0 = 0;
1872 }
1873 else
1874 {
1875 if (x < window_box_left_offset (w, TEXT_AREA))
1876 {
1877 *area = LEFT_MARGIN_AREA;
1878 x0 = window_box_left_offset (w, LEFT_MARGIN_AREA);
1879 }
1880 else if (x < window_box_right_offset (w, TEXT_AREA))
1881 {
1882 *area = TEXT_AREA;
1883 x0 = window_box_left_offset (w, TEXT_AREA) + min (row->x, 0);
1884 }
1885 else
1886 {
1887 *area = RIGHT_MARGIN_AREA;
1888 x0 = window_box_left_offset (w, RIGHT_MARGIN_AREA);
1889 }
1890 }
1891
1892 /* Find glyph containing X. */
1893 glyph = row->glyphs[*area];
1894 end = glyph + row->used[*area];
1895 x -= x0;
1896 while (glyph < end && x >= glyph->pixel_width)
1897 {
1898 x -= glyph->pixel_width;
1899 ++glyph;
1900 }
1901
1902 if (glyph == end)
1903 return NULL;
1904
1905 if (dx)
1906 {
1907 *dx = x;
1908 *dy = y - (row->y + row->ascent - glyph->ascent);
1909 }
1910
1911 *hpos = glyph - row->glyphs[*area];
1912 return glyph;
1913 }
1914
1915 /* Convert frame-relative x/y to coordinates relative to window W.
1916 Takes pseudo-windows into account. */
1917
1918 static void
1919 frame_to_window_pixel_xy (struct window *w, int *x, int *y)
1920 {
1921 if (w->pseudo_window_p)
1922 {
1923 /* A pseudo-window is always full-width, and starts at the
1924 left edge of the frame, plus a frame border. */
1925 struct frame *f = XFRAME (w->frame);
1926 *x -= FRAME_INTERNAL_BORDER_WIDTH (f);
1927 *y = FRAME_TO_WINDOW_PIXEL_Y (w, *y);
1928 }
1929 else
1930 {
1931 *x -= WINDOW_LEFT_EDGE_X (w);
1932 *y = FRAME_TO_WINDOW_PIXEL_Y (w, *y);
1933 }
1934 }
1935
1936 #ifdef HAVE_WINDOW_SYSTEM
1937
1938 /* EXPORT:
1939 Return in RECTS[] at most N clipping rectangles for glyph string S.
1940 Return the number of stored rectangles. */
1941
1942 int
1943 get_glyph_string_clip_rects (struct glyph_string *s, NativeRectangle *rects, int n)
1944 {
1945 XRectangle r;
1946
1947 if (n <= 0)
1948 return 0;
1949
1950 if (s->row->full_width_p)
1951 {
1952 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1953 r.x = WINDOW_LEFT_EDGE_X (s->w);
1954 if (s->row->mode_line_p)
1955 r.width = WINDOW_PIXEL_WIDTH (s->w) - WINDOW_RIGHT_DIVIDER_WIDTH (s->w);
1956 else
1957 r.width = WINDOW_PIXEL_WIDTH (s->w);
1958
1959 /* Unless displaying a mode or menu bar line, which are always
1960 fully visible, clip to the visible part of the row. */
1961 if (s->w->pseudo_window_p)
1962 r.height = s->row->visible_height;
1963 else
1964 r.height = s->height;
1965 }
1966 else
1967 {
1968 /* This is a text line that may be partially visible. */
1969 r.x = window_box_left (s->w, s->area);
1970 r.width = window_box_width (s->w, s->area);
1971 r.height = s->row->visible_height;
1972 }
1973
1974 if (s->clip_head)
1975 if (r.x < s->clip_head->x)
1976 {
1977 if (r.width >= s->clip_head->x - r.x)
1978 r.width -= s->clip_head->x - r.x;
1979 else
1980 r.width = 0;
1981 r.x = s->clip_head->x;
1982 }
1983 if (s->clip_tail)
1984 if (r.x + r.width > s->clip_tail->x + s->clip_tail->background_width)
1985 {
1986 if (s->clip_tail->x + s->clip_tail->background_width >= r.x)
1987 r.width = s->clip_tail->x + s->clip_tail->background_width - r.x;
1988 else
1989 r.width = 0;
1990 }
1991
1992 /* If S draws overlapping rows, it's sufficient to use the top and
1993 bottom of the window for clipping because this glyph string
1994 intentionally draws over other lines. */
1995 if (s->for_overlaps)
1996 {
1997 r.y = WINDOW_HEADER_LINE_HEIGHT (s->w);
1998 r.height = window_text_bottom_y (s->w) - r.y;
1999
2000 /* Alas, the above simple strategy does not work for the
2001 environments with anti-aliased text: if the same text is
2002 drawn onto the same place multiple times, it gets thicker.
2003 If the overlap we are processing is for the erased cursor, we
2004 take the intersection with the rectangle of the cursor. */
2005 if (s->for_overlaps & OVERLAPS_ERASED_CURSOR)
2006 {
2007 XRectangle rc, r_save = r;
2008
2009 rc.x = WINDOW_TEXT_TO_FRAME_PIXEL_X (s->w, s->w->phys_cursor.x);
2010 rc.y = s->w->phys_cursor.y;
2011 rc.width = s->w->phys_cursor_width;
2012 rc.height = s->w->phys_cursor_height;
2013
2014 x_intersect_rectangles (&r_save, &rc, &r);
2015 }
2016 }
2017 else
2018 {
2019 /* Don't use S->y for clipping because it doesn't take partially
2020 visible lines into account. For example, it can be negative for
2021 partially visible lines at the top of a window. */
2022 if (!s->row->full_width_p
2023 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s->w, s->row))
2024 r.y = WINDOW_HEADER_LINE_HEIGHT (s->w);
2025 else
2026 r.y = max (0, s->row->y);
2027 }
2028
2029 r.y = WINDOW_TO_FRAME_PIXEL_Y (s->w, r.y);
2030
2031 /* If drawing the cursor, don't let glyph draw outside its
2032 advertised boundaries. Cleartype does this under some circumstances. */
2033 if (s->hl == DRAW_CURSOR)
2034 {
2035 struct glyph *glyph = s->first_glyph;
2036 int height, max_y;
2037
2038 if (s->x > r.x)
2039 {
2040 if (r.width >= s->x - r.x)
2041 r.width -= s->x - r.x;
2042 else /* R2L hscrolled row with cursor outside text area */
2043 r.width = 0;
2044 r.x = s->x;
2045 }
2046 r.width = min (r.width, glyph->pixel_width);
2047
2048 /* If r.y is below window bottom, ensure that we still see a cursor. */
2049 height = min (glyph->ascent + glyph->descent,
2050 min (FRAME_LINE_HEIGHT (s->f), s->row->visible_height));
2051 max_y = window_text_bottom_y (s->w) - height;
2052 max_y = WINDOW_TO_FRAME_PIXEL_Y (s->w, max_y);
2053 if (s->ybase - glyph->ascent > max_y)
2054 {
2055 r.y = max_y;
2056 r.height = height;
2057 }
2058 else
2059 {
2060 /* Don't draw cursor glyph taller than our actual glyph. */
2061 height = max (FRAME_LINE_HEIGHT (s->f), glyph->ascent + glyph->descent);
2062 if (height < r.height)
2063 {
2064 max_y = r.y + r.height;
2065 r.y = min (max_y, max (r.y, s->ybase + glyph->descent - height));
2066 r.height = min (max_y - r.y, height);
2067 }
2068 }
2069 }
2070
2071 if (s->row->clip)
2072 {
2073 XRectangle r_save = r;
2074
2075 if (! x_intersect_rectangles (&r_save, s->row->clip, &r))
2076 r.width = 0;
2077 }
2078
2079 if ((s->for_overlaps & OVERLAPS_BOTH) == 0
2080 || ((s->for_overlaps & OVERLAPS_BOTH) == OVERLAPS_BOTH && n == 1))
2081 {
2082 #ifdef CONVERT_FROM_XRECT
2083 CONVERT_FROM_XRECT (r, *rects);
2084 #else
2085 *rects = r;
2086 #endif
2087 return 1;
2088 }
2089 else
2090 {
2091 /* If we are processing overlapping and allowed to return
2092 multiple clipping rectangles, we exclude the row of the glyph
2093 string from the clipping rectangle. This is to avoid drawing
2094 the same text on the environment with anti-aliasing. */
2095 #ifdef CONVERT_FROM_XRECT
2096 XRectangle rs[2];
2097 #else
2098 XRectangle *rs = rects;
2099 #endif
2100 int i = 0, row_y = WINDOW_TO_FRAME_PIXEL_Y (s->w, s->row->y);
2101
2102 if (s->for_overlaps & OVERLAPS_PRED)
2103 {
2104 rs[i] = r;
2105 if (r.y + r.height > row_y)
2106 {
2107 if (r.y < row_y)
2108 rs[i].height = row_y - r.y;
2109 else
2110 rs[i].height = 0;
2111 }
2112 i++;
2113 }
2114 if (s->for_overlaps & OVERLAPS_SUCC)
2115 {
2116 rs[i] = r;
2117 if (r.y < row_y + s->row->visible_height)
2118 {
2119 if (r.y + r.height > row_y + s->row->visible_height)
2120 {
2121 rs[i].y = row_y + s->row->visible_height;
2122 rs[i].height = r.y + r.height - rs[i].y;
2123 }
2124 else
2125 rs[i].height = 0;
2126 }
2127 i++;
2128 }
2129
2130 n = i;
2131 #ifdef CONVERT_FROM_XRECT
2132 for (i = 0; i < n; i++)
2133 CONVERT_FROM_XRECT (rs[i], rects[i]);
2134 #endif
2135 return n;
2136 }
2137 }
2138
2139 /* EXPORT:
2140 Return in *NR the clipping rectangle for glyph string S. */
2141
2142 void
2143 get_glyph_string_clip_rect (struct glyph_string *s, NativeRectangle *nr)
2144 {
2145 get_glyph_string_clip_rects (s, nr, 1);
2146 }
2147
2148
2149 /* EXPORT:
2150 Return the position and height of the phys cursor in window W.
2151 Set w->phys_cursor_width to width of phys cursor.
2152 */
2153
2154 void
2155 get_phys_cursor_geometry (struct window *w, struct glyph_row *row,
2156 struct glyph *glyph, int *xp, int *yp, int *heightp)
2157 {
2158 struct frame *f = XFRAME (WINDOW_FRAME (w));
2159 int x, y, wd, h, h0, y0, ascent;
2160
2161 /* Compute the width of the rectangle to draw. If on a stretch
2162 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2163 rectangle as wide as the glyph, but use a canonical character
2164 width instead. */
2165 wd = glyph->pixel_width;
2166
2167 x = w->phys_cursor.x;
2168 if (x < 0)
2169 {
2170 wd += x;
2171 x = 0;
2172 }
2173
2174 if (glyph->type == STRETCH_GLYPH
2175 && !x_stretch_cursor_p)
2176 wd = min (FRAME_COLUMN_WIDTH (f), wd);
2177 w->phys_cursor_width = wd;
2178
2179 /* Don't let the hollow cursor glyph descend below the glyph row's
2180 ascent value, lest the hollow cursor looks funny. */
2181 y = w->phys_cursor.y;
2182 ascent = row->ascent;
2183 if (row->ascent < glyph->ascent)
2184 {
2185 y =- glyph->ascent - row->ascent;
2186 ascent = glyph->ascent;
2187 }
2188
2189 /* If y is below window bottom, ensure that we still see a cursor. */
2190 h0 = min (FRAME_LINE_HEIGHT (f), row->visible_height);
2191
2192 h = max (h0, ascent + glyph->descent);
2193 h0 = min (h0, ascent + glyph->descent);
2194
2195 y0 = WINDOW_HEADER_LINE_HEIGHT (w);
2196 if (y < y0)
2197 {
2198 h = max (h - (y0 - y) + 1, h0);
2199 y = y0 - 1;
2200 }
2201 else
2202 {
2203 y0 = window_text_bottom_y (w) - h0;
2204 if (y > y0)
2205 {
2206 h += y - y0;
2207 y = y0;
2208 }
2209 }
2210
2211 *xp = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, x);
2212 *yp = WINDOW_TO_FRAME_PIXEL_Y (w, y);
2213 *heightp = h;
2214 }
2215
2216 /*
2217 * Remember which glyph the mouse is over.
2218 */
2219
2220 void
2221 remember_mouse_glyph (struct frame *f, int gx, int gy, NativeRectangle *rect)
2222 {
2223 Lisp_Object window;
2224 struct window *w;
2225 struct glyph_row *r, *gr, *end_row;
2226 enum window_part part;
2227 enum glyph_row_area area;
2228 int x, y, width, height;
2229
2230 /* Try to determine frame pixel position and size of the glyph under
2231 frame pixel coordinates X/Y on frame F. */
2232
2233 if (window_resize_pixelwise)
2234 {
2235 width = height = 1;
2236 goto virtual_glyph;
2237 }
2238 else if (!f->glyphs_initialized_p
2239 || (window = window_from_coordinates (f, gx, gy, &part, false),
2240 NILP (window)))
2241 {
2242 width = FRAME_SMALLEST_CHAR_WIDTH (f);
2243 height = FRAME_SMALLEST_FONT_HEIGHT (f);
2244 goto virtual_glyph;
2245 }
2246
2247 w = XWINDOW (window);
2248 width = WINDOW_FRAME_COLUMN_WIDTH (w);
2249 height = WINDOW_FRAME_LINE_HEIGHT (w);
2250
2251 x = window_relative_x_coord (w, part, gx);
2252 y = gy - WINDOW_TOP_EDGE_Y (w);
2253
2254 r = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
2255 end_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
2256
2257 if (w->pseudo_window_p)
2258 {
2259 area = TEXT_AREA;
2260 part = ON_MODE_LINE; /* Don't adjust margin. */
2261 goto text_glyph;
2262 }
2263
2264 switch (part)
2265 {
2266 case ON_LEFT_MARGIN:
2267 area = LEFT_MARGIN_AREA;
2268 goto text_glyph;
2269
2270 case ON_RIGHT_MARGIN:
2271 area = RIGHT_MARGIN_AREA;
2272 goto text_glyph;
2273
2274 case ON_HEADER_LINE:
2275 case ON_MODE_LINE:
2276 gr = (part == ON_HEADER_LINE
2277 ? MATRIX_HEADER_LINE_ROW (w->current_matrix)
2278 : MATRIX_MODE_LINE_ROW (w->current_matrix));
2279 gy = gr->y;
2280 area = TEXT_AREA;
2281 goto text_glyph_row_found;
2282
2283 case ON_TEXT:
2284 area = TEXT_AREA;
2285
2286 text_glyph:
2287 gr = 0; gy = 0;
2288 for (; r <= end_row && r->enabled_p; ++r)
2289 if (r->y + r->height > y)
2290 {
2291 gr = r; gy = r->y;
2292 break;
2293 }
2294
2295 text_glyph_row_found:
2296 if (gr && gy <= y)
2297 {
2298 struct glyph *g = gr->glyphs[area];
2299 struct glyph *end = g + gr->used[area];
2300
2301 height = gr->height;
2302 for (gx = gr->x; g < end; gx += g->pixel_width, ++g)
2303 if (gx + g->pixel_width > x)
2304 break;
2305
2306 if (g < end)
2307 {
2308 if (g->type == IMAGE_GLYPH)
2309 {
2310 /* Don't remember when mouse is over image, as
2311 image may have hot-spots. */
2312 STORE_NATIVE_RECT (*rect, 0, 0, 0, 0);
2313 return;
2314 }
2315 width = g->pixel_width;
2316 }
2317 else
2318 {
2319 /* Use nominal char spacing at end of line. */
2320 x -= gx;
2321 gx += (x / width) * width;
2322 }
2323
2324 if (part != ON_MODE_LINE && part != ON_HEADER_LINE)
2325 {
2326 gx += window_box_left_offset (w, area);
2327 /* Don't expand over the modeline to make sure the vertical
2328 drag cursor is shown early enough. */
2329 height = min (height,
2330 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w) - gy));
2331 }
2332 }
2333 else
2334 {
2335 /* Use nominal line height at end of window. */
2336 gx = (x / width) * width;
2337 y -= gy;
2338 gy += (y / height) * height;
2339 if (part != ON_MODE_LINE && part != ON_HEADER_LINE)
2340 /* See comment above. */
2341 height = min (height,
2342 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w) - gy));
2343 }
2344 break;
2345
2346 case ON_LEFT_FRINGE:
2347 gx = (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
2348 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w)
2349 : window_box_right_offset (w, LEFT_MARGIN_AREA));
2350 width = WINDOW_LEFT_FRINGE_WIDTH (w);
2351 goto row_glyph;
2352
2353 case ON_RIGHT_FRINGE:
2354 gx = (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
2355 ? window_box_right_offset (w, RIGHT_MARGIN_AREA)
2356 : window_box_right_offset (w, TEXT_AREA));
2357 if (WINDOW_RIGHT_DIVIDER_WIDTH (w) == 0
2358 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
2359 && !WINDOW_RIGHTMOST_P (w))
2360 if (gx < WINDOW_PIXEL_WIDTH (w) - width)
2361 /* Make sure the vertical border can get her own glyph to the
2362 right of the one we build here. */
2363 width = WINDOW_RIGHT_FRINGE_WIDTH (w) - width;
2364 else
2365 width = WINDOW_PIXEL_WIDTH (w) - gx;
2366 else
2367 width = WINDOW_RIGHT_FRINGE_WIDTH (w);
2368
2369 goto row_glyph;
2370
2371 case ON_VERTICAL_BORDER:
2372 gx = WINDOW_PIXEL_WIDTH (w) - width;
2373 goto row_glyph;
2374
2375 case ON_VERTICAL_SCROLL_BAR:
2376 gx = (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
2377 ? 0
2378 : (window_box_right_offset (w, RIGHT_MARGIN_AREA)
2379 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
2380 ? WINDOW_RIGHT_FRINGE_WIDTH (w)
2381 : 0)));
2382 width = WINDOW_SCROLL_BAR_AREA_WIDTH (w);
2383
2384 row_glyph:
2385 gr = 0, gy = 0;
2386 for (; r <= end_row && r->enabled_p; ++r)
2387 if (r->y + r->height > y)
2388 {
2389 gr = r; gy = r->y;
2390 break;
2391 }
2392
2393 if (gr && gy <= y)
2394 height = gr->height;
2395 else
2396 {
2397 /* Use nominal line height at end of window. */
2398 y -= gy;
2399 gy += (y / height) * height;
2400 }
2401 break;
2402
2403 case ON_RIGHT_DIVIDER:
2404 gx = WINDOW_PIXEL_WIDTH (w) - WINDOW_RIGHT_DIVIDER_WIDTH (w);
2405 width = WINDOW_RIGHT_DIVIDER_WIDTH (w);
2406 gy = 0;
2407 /* The bottom divider prevails. */
2408 height = WINDOW_PIXEL_HEIGHT (w) - WINDOW_BOTTOM_DIVIDER_WIDTH (w);
2409 goto add_edge;
2410
2411 case ON_BOTTOM_DIVIDER:
2412 gx = 0;
2413 width = WINDOW_PIXEL_WIDTH (w);
2414 gy = WINDOW_PIXEL_HEIGHT (w) - WINDOW_BOTTOM_DIVIDER_WIDTH (w);
2415 height = WINDOW_BOTTOM_DIVIDER_WIDTH (w);
2416 goto add_edge;
2417
2418 default:
2419 ;
2420 virtual_glyph:
2421 /* If there is no glyph under the mouse, then we divide the screen
2422 into a grid of the smallest glyph in the frame, and use that
2423 as our "glyph". */
2424
2425 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2426 round down even for negative values. */
2427 if (gx < 0)
2428 gx -= width - 1;
2429 if (gy < 0)
2430 gy -= height - 1;
2431
2432 gx = (gx / width) * width;
2433 gy = (gy / height) * height;
2434
2435 goto store_rect;
2436 }
2437
2438 add_edge:
2439 gx += WINDOW_LEFT_EDGE_X (w);
2440 gy += WINDOW_TOP_EDGE_Y (w);
2441
2442 store_rect:
2443 STORE_NATIVE_RECT (*rect, gx, gy, width, height);
2444
2445 /* Visible feedback for debugging. */
2446 #if false && defined HAVE_X_WINDOWS
2447 XDrawRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2448 f->output_data.x->normal_gc,
2449 gx, gy, width, height);
2450 #endif
2451 }
2452
2453
2454 #endif /* HAVE_WINDOW_SYSTEM */
2455
2456 static void
2457 adjust_window_ends (struct window *w, struct glyph_row *row, bool current)
2458 {
2459 eassert (w);
2460 w->window_end_pos = Z - MATRIX_ROW_END_CHARPOS (row);
2461 w->window_end_bytepos = Z_BYTE - MATRIX_ROW_END_BYTEPOS (row);
2462 w->window_end_vpos
2463 = MATRIX_ROW_VPOS (row, current ? w->current_matrix : w->desired_matrix);
2464 }
2465
2466 /***********************************************************************
2467 Lisp form evaluation
2468 ***********************************************************************/
2469
2470 /* Error handler for safe_eval and safe_call. */
2471
2472 static Lisp_Object
2473 safe_eval_handler (Lisp_Object arg, ptrdiff_t nargs, Lisp_Object *args)
2474 {
2475 add_to_log ("Error during redisplay: %S signaled %S",
2476 Flist (nargs, args), arg);
2477 return Qnil;
2478 }
2479
2480 /* Call function FUNC with the rest of NARGS - 1 arguments
2481 following. Return the result, or nil if something went
2482 wrong. Prevent redisplay during the evaluation. */
2483
2484 static Lisp_Object
2485 safe__call (bool inhibit_quit, ptrdiff_t nargs, Lisp_Object func, va_list ap)
2486 {
2487 Lisp_Object val;
2488
2489 if (inhibit_eval_during_redisplay)
2490 val = Qnil;
2491 else
2492 {
2493 ptrdiff_t i;
2494 ptrdiff_t count = SPECPDL_INDEX ();
2495 Lisp_Object *args;
2496 USE_SAFE_ALLOCA;
2497 SAFE_ALLOCA_LISP (args, nargs);
2498
2499 args[0] = func;
2500 for (i = 1; i < nargs; i++)
2501 args[i] = va_arg (ap, Lisp_Object);
2502
2503 specbind (Qinhibit_redisplay, Qt);
2504 if (inhibit_quit)
2505 specbind (Qinhibit_quit, Qt);
2506 /* Use Qt to ensure debugger does not run,
2507 so there is no possibility of wanting to redisplay. */
2508 val = internal_condition_case_n (Ffuncall, nargs, args, Qt,
2509 safe_eval_handler);
2510 SAFE_FREE ();
2511 val = unbind_to (count, val);
2512 }
2513
2514 return val;
2515 }
2516
2517 Lisp_Object
2518 safe_call (ptrdiff_t nargs, Lisp_Object func, ...)
2519 {
2520 Lisp_Object retval;
2521 va_list ap;
2522
2523 va_start (ap, func);
2524 retval = safe__call (false, nargs, func, ap);
2525 va_end (ap);
2526 return retval;
2527 }
2528
2529 /* Call function FN with one argument ARG.
2530 Return the result, or nil if something went wrong. */
2531
2532 Lisp_Object
2533 safe_call1 (Lisp_Object fn, Lisp_Object arg)
2534 {
2535 return safe_call (2, fn, arg);
2536 }
2537
2538 static Lisp_Object
2539 safe__call1 (bool inhibit_quit, Lisp_Object fn, ...)
2540 {
2541 Lisp_Object retval;
2542 va_list ap;
2543
2544 va_start (ap, fn);
2545 retval = safe__call (inhibit_quit, 2, fn, ap);
2546 va_end (ap);
2547 return retval;
2548 }
2549
2550 Lisp_Object
2551 safe_eval (Lisp_Object sexpr)
2552 {
2553 return safe__call1 (false, Qeval, sexpr);
2554 }
2555
2556 static Lisp_Object
2557 safe__eval (bool inhibit_quit, Lisp_Object sexpr)
2558 {
2559 return safe__call1 (inhibit_quit, Qeval, sexpr);
2560 }
2561
2562 /* Call function FN with two arguments ARG1 and ARG2.
2563 Return the result, or nil if something went wrong. */
2564
2565 Lisp_Object
2566 safe_call2 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2)
2567 {
2568 return safe_call (3, fn, arg1, arg2);
2569 }
2570
2571
2572 \f
2573 /***********************************************************************
2574 Debugging
2575 ***********************************************************************/
2576
2577 /* Define CHECK_IT to perform sanity checks on iterators.
2578 This is for debugging. It is too slow to do unconditionally. */
2579
2580 static void
2581 CHECK_IT (struct it *it)
2582 {
2583 #if false
2584 if (it->method == GET_FROM_STRING)
2585 {
2586 eassert (STRINGP (it->string));
2587 eassert (IT_STRING_CHARPOS (*it) >= 0);
2588 }
2589 else
2590 {
2591 eassert (IT_STRING_CHARPOS (*it) < 0);
2592 if (it->method == GET_FROM_BUFFER)
2593 {
2594 /* Check that character and byte positions agree. */
2595 eassert (IT_CHARPOS (*it) == BYTE_TO_CHAR (IT_BYTEPOS (*it)));
2596 }
2597 }
2598
2599 if (it->dpvec)
2600 eassert (it->current.dpvec_index >= 0);
2601 else
2602 eassert (it->current.dpvec_index < 0);
2603 #endif
2604 }
2605
2606
2607 /* Check that the window end of window W is what we expect it
2608 to be---the last row in the current matrix displaying text. */
2609
2610 static void
2611 CHECK_WINDOW_END (struct window *w)
2612 {
2613 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2614 if (!MINI_WINDOW_P (w) && w->window_end_valid)
2615 {
2616 struct glyph_row *row;
2617 eassert ((row = MATRIX_ROW (w->current_matrix, w->window_end_vpos),
2618 !row->enabled_p
2619 || MATRIX_ROW_DISPLAYS_TEXT_P (row)
2620 || MATRIX_ROW_VPOS (row, w->current_matrix) == 0));
2621 }
2622 #endif
2623 }
2624
2625 /***********************************************************************
2626 Iterator initialization
2627 ***********************************************************************/
2628
2629 /* Initialize IT for displaying current_buffer in window W, starting
2630 at character position CHARPOS. CHARPOS < 0 means that no buffer
2631 position is specified which is useful when the iterator is assigned
2632 a position later. BYTEPOS is the byte position corresponding to
2633 CHARPOS.
2634
2635 If ROW is not null, calls to produce_glyphs with IT as parameter
2636 will produce glyphs in that row.
2637
2638 BASE_FACE_ID is the id of a base face to use. It must be one of
2639 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2640 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2641 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2642
2643 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2644 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2645 will be initialized to use the corresponding mode line glyph row of
2646 the desired matrix of W. */
2647
2648 void
2649 init_iterator (struct it *it, struct window *w,
2650 ptrdiff_t charpos, ptrdiff_t bytepos,
2651 struct glyph_row *row, enum face_id base_face_id)
2652 {
2653 enum face_id remapped_base_face_id = base_face_id;
2654
2655 /* Some precondition checks. */
2656 eassert (w != NULL && it != NULL);
2657 eassert (charpos < 0 || (charpos >= BUF_BEG (current_buffer)
2658 && charpos <= ZV));
2659
2660 /* If face attributes have been changed since the last redisplay,
2661 free realized faces now because they depend on face definitions
2662 that might have changed. Don't free faces while there might be
2663 desired matrices pending which reference these faces. */
2664 if (!inhibit_free_realized_faces)
2665 {
2666 if (face_change)
2667 {
2668 face_change = false;
2669 free_all_realized_faces (Qnil);
2670 }
2671 else if (XFRAME (w->frame)->face_change)
2672 {
2673 XFRAME (w->frame)->face_change = 0;
2674 free_all_realized_faces (w->frame);
2675 }
2676 }
2677
2678 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2679 if (! NILP (Vface_remapping_alist))
2680 remapped_base_face_id
2681 = lookup_basic_face (XFRAME (w->frame), base_face_id);
2682
2683 /* Use one of the mode line rows of W's desired matrix if
2684 appropriate. */
2685 if (row == NULL)
2686 {
2687 if (base_face_id == MODE_LINE_FACE_ID
2688 || base_face_id == MODE_LINE_INACTIVE_FACE_ID)
2689 row = MATRIX_MODE_LINE_ROW (w->desired_matrix);
2690 else if (base_face_id == HEADER_LINE_FACE_ID)
2691 row = MATRIX_HEADER_LINE_ROW (w->desired_matrix);
2692 }
2693
2694 /* Clear IT, and set it->object and other IT's Lisp objects to Qnil.
2695 Other parts of redisplay rely on that. */
2696 memclear (it, sizeof *it);
2697 it->current.overlay_string_index = -1;
2698 it->current.dpvec_index = -1;
2699 it->base_face_id = remapped_base_face_id;
2700 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = -1;
2701 it->paragraph_embedding = L2R;
2702 it->bidi_it.w = w;
2703
2704 /* The window in which we iterate over current_buffer: */
2705 XSETWINDOW (it->window, w);
2706 it->w = w;
2707 it->f = XFRAME (w->frame);
2708
2709 it->cmp_it.id = -1;
2710
2711 /* Extra space between lines (on window systems only). */
2712 if (base_face_id == DEFAULT_FACE_ID
2713 && FRAME_WINDOW_P (it->f))
2714 {
2715 if (NATNUMP (BVAR (current_buffer, extra_line_spacing)))
2716 it->extra_line_spacing = XFASTINT (BVAR (current_buffer, extra_line_spacing));
2717 else if (FLOATP (BVAR (current_buffer, extra_line_spacing)))
2718 it->extra_line_spacing = (XFLOAT_DATA (BVAR (current_buffer, extra_line_spacing))
2719 * FRAME_LINE_HEIGHT (it->f));
2720 else if (it->f->extra_line_spacing > 0)
2721 it->extra_line_spacing = it->f->extra_line_spacing;
2722 }
2723
2724 /* If realized faces have been removed, e.g. because of face
2725 attribute changes of named faces, recompute them. When running
2726 in batch mode, the face cache of the initial frame is null. If
2727 we happen to get called, make a dummy face cache. */
2728 if (FRAME_FACE_CACHE (it->f) == NULL)
2729 init_frame_faces (it->f);
2730 if (FRAME_FACE_CACHE (it->f)->used == 0)
2731 recompute_basic_faces (it->f);
2732
2733 it->override_ascent = -1;
2734
2735 /* Are control characters displayed as `^C'? */
2736 it->ctl_arrow_p = !NILP (BVAR (current_buffer, ctl_arrow));
2737
2738 /* -1 means everything between a CR and the following line end
2739 is invisible. >0 means lines indented more than this value are
2740 invisible. */
2741 it->selective = (INTEGERP (BVAR (current_buffer, selective_display))
2742 ? (clip_to_bounds
2743 (-1, XINT (BVAR (current_buffer, selective_display)),
2744 PTRDIFF_MAX))
2745 : (!NILP (BVAR (current_buffer, selective_display))
2746 ? -1 : 0));
2747 it->selective_display_ellipsis_p
2748 = !NILP (BVAR (current_buffer, selective_display_ellipses));
2749
2750 /* Display table to use. */
2751 it->dp = window_display_table (w);
2752
2753 /* Are multibyte characters enabled in current_buffer? */
2754 it->multibyte_p = !NILP (BVAR (current_buffer, enable_multibyte_characters));
2755
2756 /* Get the position at which the redisplay_end_trigger hook should
2757 be run, if it is to be run at all. */
2758 if (MARKERP (w->redisplay_end_trigger)
2759 && XMARKER (w->redisplay_end_trigger)->buffer != 0)
2760 it->redisplay_end_trigger_charpos
2761 = marker_position (w->redisplay_end_trigger);
2762 else if (INTEGERP (w->redisplay_end_trigger))
2763 it->redisplay_end_trigger_charpos
2764 = clip_to_bounds (PTRDIFF_MIN, XINT (w->redisplay_end_trigger),
2765 PTRDIFF_MAX);
2766
2767 it->tab_width = SANE_TAB_WIDTH (current_buffer);
2768
2769 /* Are lines in the display truncated? */
2770 if (TRUNCATE != 0)
2771 it->line_wrap = TRUNCATE;
2772 if (base_face_id == DEFAULT_FACE_ID
2773 && !it->w->hscroll
2774 && (WINDOW_FULL_WIDTH_P (it->w)
2775 || NILP (Vtruncate_partial_width_windows)
2776 || (INTEGERP (Vtruncate_partial_width_windows)
2777 /* PXW: Shall we do something about this? */
2778 && (XINT (Vtruncate_partial_width_windows)
2779 <= WINDOW_TOTAL_COLS (it->w))))
2780 && NILP (BVAR (current_buffer, truncate_lines)))
2781 it->line_wrap = NILP (BVAR (current_buffer, word_wrap))
2782 ? WINDOW_WRAP : WORD_WRAP;
2783
2784 /* Get dimensions of truncation and continuation glyphs. These are
2785 displayed as fringe bitmaps under X, but we need them for such
2786 frames when the fringes are turned off. But leave the dimensions
2787 zero for tooltip frames, as these glyphs look ugly there and also
2788 sabotage calculations of tooltip dimensions in x-show-tip. */
2789 #ifdef HAVE_WINDOW_SYSTEM
2790 if (!(FRAME_WINDOW_P (it->f)
2791 && FRAMEP (tip_frame)
2792 && it->f == XFRAME (tip_frame)))
2793 #endif
2794 {
2795 if (it->line_wrap == TRUNCATE)
2796 {
2797 /* We will need the truncation glyph. */
2798 eassert (it->glyph_row == NULL);
2799 produce_special_glyphs (it, IT_TRUNCATION);
2800 it->truncation_pixel_width = it->pixel_width;
2801 }
2802 else
2803 {
2804 /* We will need the continuation glyph. */
2805 eassert (it->glyph_row == NULL);
2806 produce_special_glyphs (it, IT_CONTINUATION);
2807 it->continuation_pixel_width = it->pixel_width;
2808 }
2809 }
2810
2811 /* Reset these values to zero because the produce_special_glyphs
2812 above has changed them. */
2813 it->pixel_width = it->ascent = it->descent = 0;
2814 it->phys_ascent = it->phys_descent = 0;
2815
2816 /* Set this after getting the dimensions of truncation and
2817 continuation glyphs, so that we don't produce glyphs when calling
2818 produce_special_glyphs, above. */
2819 it->glyph_row = row;
2820 it->area = TEXT_AREA;
2821
2822 /* Get the dimensions of the display area. The display area
2823 consists of the visible window area plus a horizontally scrolled
2824 part to the left of the window. All x-values are relative to the
2825 start of this total display area. */
2826 if (base_face_id != DEFAULT_FACE_ID)
2827 {
2828 /* Mode lines, menu bar in terminal frames. */
2829 it->first_visible_x = 0;
2830 it->last_visible_x = WINDOW_PIXEL_WIDTH (w);
2831 }
2832 else
2833 {
2834 it->first_visible_x
2835 = window_hscroll_limited (it->w, it->f) * FRAME_COLUMN_WIDTH (it->f);
2836 it->last_visible_x = (it->first_visible_x
2837 + window_box_width (w, TEXT_AREA));
2838
2839 /* If we truncate lines, leave room for the truncation glyph(s) at
2840 the right margin. Otherwise, leave room for the continuation
2841 glyph(s). Done only if the window has no right fringe. */
2842 if (WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0)
2843 {
2844 if (it->line_wrap == TRUNCATE)
2845 it->last_visible_x -= it->truncation_pixel_width;
2846 else
2847 it->last_visible_x -= it->continuation_pixel_width;
2848 }
2849
2850 it->header_line_p = WINDOW_WANTS_HEADER_LINE_P (w);
2851 it->current_y = WINDOW_HEADER_LINE_HEIGHT (w) + w->vscroll;
2852 }
2853
2854 /* Leave room for a border glyph. */
2855 if (!FRAME_WINDOW_P (it->f)
2856 && !WINDOW_RIGHTMOST_P (it->w))
2857 it->last_visible_x -= 1;
2858
2859 it->last_visible_y = window_text_bottom_y (w);
2860
2861 /* For mode lines and alike, arrange for the first glyph having a
2862 left box line if the face specifies a box. */
2863 if (base_face_id != DEFAULT_FACE_ID)
2864 {
2865 struct face *face;
2866
2867 it->face_id = remapped_base_face_id;
2868
2869 /* If we have a boxed mode line, make the first character appear
2870 with a left box line. */
2871 face = FACE_FROM_ID (it->f, remapped_base_face_id);
2872 if (face && face->box != FACE_NO_BOX)
2873 it->start_of_box_run_p = true;
2874 }
2875
2876 /* If a buffer position was specified, set the iterator there,
2877 getting overlays and face properties from that position. */
2878 if (charpos >= BUF_BEG (current_buffer))
2879 {
2880 it->stop_charpos = charpos;
2881 it->end_charpos = ZV;
2882 eassert (charpos == BYTE_TO_CHAR (bytepos));
2883 IT_CHARPOS (*it) = charpos;
2884 IT_BYTEPOS (*it) = bytepos;
2885
2886 /* We will rely on `reseat' to set this up properly, via
2887 handle_face_prop. */
2888 it->face_id = it->base_face_id;
2889
2890 it->start = it->current;
2891 /* Do we need to reorder bidirectional text? Not if this is a
2892 unibyte buffer: by definition, none of the single-byte
2893 characters are strong R2L, so no reordering is needed. And
2894 bidi.c doesn't support unibyte buffers anyway. Also, don't
2895 reorder while we are loading loadup.el, since the tables of
2896 character properties needed for reordering are not yet
2897 available. */
2898 it->bidi_p =
2899 NILP (Vpurify_flag)
2900 && !NILP (BVAR (current_buffer, bidi_display_reordering))
2901 && it->multibyte_p;
2902
2903 /* If we are to reorder bidirectional text, init the bidi
2904 iterator. */
2905 if (it->bidi_p)
2906 {
2907 /* Since we don't know at this point whether there will be
2908 any R2L lines in the window, we reserve space for
2909 truncation/continuation glyphs even if only the left
2910 fringe is absent. */
2911 if (base_face_id == DEFAULT_FACE_ID
2912 && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0
2913 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) != 0)
2914 {
2915 if (it->line_wrap == TRUNCATE)
2916 it->last_visible_x -= it->truncation_pixel_width;
2917 else
2918 it->last_visible_x -= it->continuation_pixel_width;
2919 }
2920 /* Note the paragraph direction that this buffer wants to
2921 use. */
2922 if (EQ (BVAR (current_buffer, bidi_paragraph_direction),
2923 Qleft_to_right))
2924 it->paragraph_embedding = L2R;
2925 else if (EQ (BVAR (current_buffer, bidi_paragraph_direction),
2926 Qright_to_left))
2927 it->paragraph_embedding = R2L;
2928 else
2929 it->paragraph_embedding = NEUTRAL_DIR;
2930 bidi_unshelve_cache (NULL, false);
2931 bidi_init_it (charpos, IT_BYTEPOS (*it), FRAME_WINDOW_P (it->f),
2932 &it->bidi_it);
2933 }
2934
2935 /* Compute faces etc. */
2936 reseat (it, it->current.pos, true);
2937 }
2938
2939 CHECK_IT (it);
2940 }
2941
2942
2943 /* Initialize IT for the display of window W with window start POS. */
2944
2945 void
2946 start_display (struct it *it, struct window *w, struct text_pos pos)
2947 {
2948 struct glyph_row *row;
2949 bool first_vpos = WINDOW_WANTS_HEADER_LINE_P (w);
2950
2951 row = w->desired_matrix->rows + first_vpos;
2952 init_iterator (it, w, CHARPOS (pos), BYTEPOS (pos), row, DEFAULT_FACE_ID);
2953 it->first_vpos = first_vpos;
2954
2955 /* Don't reseat to previous visible line start if current start
2956 position is in a string or image. */
2957 if (it->method == GET_FROM_BUFFER && it->line_wrap != TRUNCATE)
2958 {
2959 int first_y = it->current_y;
2960
2961 /* If window start is not at a line start, skip forward to POS to
2962 get the correct continuation lines width. */
2963 bool start_at_line_beg_p = (CHARPOS (pos) == BEGV
2964 || FETCH_BYTE (BYTEPOS (pos) - 1) == '\n');
2965 if (!start_at_line_beg_p)
2966 {
2967 int new_x;
2968
2969 reseat_at_previous_visible_line_start (it);
2970 move_it_to (it, CHARPOS (pos), -1, -1, -1, MOVE_TO_POS);
2971
2972 new_x = it->current_x + it->pixel_width;
2973
2974 /* If lines are continued, this line may end in the middle
2975 of a multi-glyph character (e.g. a control character
2976 displayed as \003, or in the middle of an overlay
2977 string). In this case move_it_to above will not have
2978 taken us to the start of the continuation line but to the
2979 end of the continued line. */
2980 if (it->current_x > 0
2981 && it->line_wrap != TRUNCATE /* Lines are continued. */
2982 && (/* And glyph doesn't fit on the line. */
2983 new_x > it->last_visible_x
2984 /* Or it fits exactly and we're on a window
2985 system frame. */
2986 || (new_x == it->last_visible_x
2987 && FRAME_WINDOW_P (it->f)
2988 && ((it->bidi_p && it->bidi_it.paragraph_dir == R2L)
2989 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
2990 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)))))
2991 {
2992 if ((it->current.dpvec_index >= 0
2993 || it->current.overlay_string_index >= 0)
2994 /* If we are on a newline from a display vector or
2995 overlay string, then we are already at the end of
2996 a screen line; no need to go to the next line in
2997 that case, as this line is not really continued.
2998 (If we do go to the next line, C-e will not DTRT.) */
2999 && it->c != '\n')
3000 {
3001 set_iterator_to_next (it, true);
3002 move_it_in_display_line_to (it, -1, -1, 0);
3003 }
3004
3005 it->continuation_lines_width += it->current_x;
3006 }
3007 /* If the character at POS is displayed via a display
3008 vector, move_it_to above stops at the final glyph of
3009 IT->dpvec. To make the caller redisplay that character
3010 again (a.k.a. start at POS), we need to reset the
3011 dpvec_index to the beginning of IT->dpvec. */
3012 else if (it->current.dpvec_index >= 0)
3013 it->current.dpvec_index = 0;
3014
3015 /* We're starting a new display line, not affected by the
3016 height of the continued line, so clear the appropriate
3017 fields in the iterator structure. */
3018 it->max_ascent = it->max_descent = 0;
3019 it->max_phys_ascent = it->max_phys_descent = 0;
3020
3021 it->current_y = first_y;
3022 it->vpos = 0;
3023 it->current_x = it->hpos = 0;
3024 }
3025 }
3026 }
3027
3028
3029 /* Return true if POS is a position in ellipses displayed for invisible
3030 text. W is the window we display, for text property lookup. */
3031
3032 static bool
3033 in_ellipses_for_invisible_text_p (struct display_pos *pos, struct window *w)
3034 {
3035 Lisp_Object prop, window;
3036 bool ellipses_p = false;
3037 ptrdiff_t charpos = CHARPOS (pos->pos);
3038
3039 /* If POS specifies a position in a display vector, this might
3040 be for an ellipsis displayed for invisible text. We won't
3041 get the iterator set up for delivering that ellipsis unless
3042 we make sure that it gets aware of the invisible text. */
3043 if (pos->dpvec_index >= 0
3044 && pos->overlay_string_index < 0
3045 && CHARPOS (pos->string_pos) < 0
3046 && charpos > BEGV
3047 && (XSETWINDOW (window, w),
3048 prop = Fget_char_property (make_number (charpos),
3049 Qinvisible, window),
3050 TEXT_PROP_MEANS_INVISIBLE (prop) == 0))
3051 {
3052 prop = Fget_char_property (make_number (charpos - 1), Qinvisible,
3053 window);
3054 ellipses_p = 2 == TEXT_PROP_MEANS_INVISIBLE (prop);
3055 }
3056
3057 return ellipses_p;
3058 }
3059
3060
3061 /* Initialize IT for stepping through current_buffer in window W,
3062 starting at position POS that includes overlay string and display
3063 vector/ control character translation position information. Value
3064 is false if there are overlay strings with newlines at POS. */
3065
3066 static bool
3067 init_from_display_pos (struct it *it, struct window *w, struct display_pos *pos)
3068 {
3069 ptrdiff_t charpos = CHARPOS (pos->pos), bytepos = BYTEPOS (pos->pos);
3070 int i;
3071 bool overlay_strings_with_newlines = false;
3072
3073 /* If POS specifies a position in a display vector, this might
3074 be for an ellipsis displayed for invisible text. We won't
3075 get the iterator set up for delivering that ellipsis unless
3076 we make sure that it gets aware of the invisible text. */
3077 if (in_ellipses_for_invisible_text_p (pos, w))
3078 {
3079 --charpos;
3080 bytepos = 0;
3081 }
3082
3083 /* Keep in mind: the call to reseat in init_iterator skips invisible
3084 text, so we might end up at a position different from POS. This
3085 is only a problem when POS is a row start after a newline and an
3086 overlay starts there with an after-string, and the overlay has an
3087 invisible property. Since we don't skip invisible text in
3088 display_line and elsewhere immediately after consuming the
3089 newline before the row start, such a POS will not be in a string,
3090 but the call to init_iterator below will move us to the
3091 after-string. */
3092 init_iterator (it, w, charpos, bytepos, NULL, DEFAULT_FACE_ID);
3093
3094 /* This only scans the current chunk -- it should scan all chunks.
3095 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3096 to 16 in 22.1 to make this a lesser problem. */
3097 for (i = 0; i < it->n_overlay_strings && i < OVERLAY_STRING_CHUNK_SIZE; ++i)
3098 {
3099 const char *s = SSDATA (it->overlay_strings[i]);
3100 const char *e = s + SBYTES (it->overlay_strings[i]);
3101
3102 while (s < e && *s != '\n')
3103 ++s;
3104
3105 if (s < e)
3106 {
3107 overlay_strings_with_newlines = true;
3108 break;
3109 }
3110 }
3111
3112 /* If position is within an overlay string, set up IT to the right
3113 overlay string. */
3114 if (pos->overlay_string_index >= 0)
3115 {
3116 int relative_index;
3117
3118 /* If the first overlay string happens to have a `display'
3119 property for an image, the iterator will be set up for that
3120 image, and we have to undo that setup first before we can
3121 correct the overlay string index. */
3122 if (it->method == GET_FROM_IMAGE)
3123 pop_it (it);
3124
3125 /* We already have the first chunk of overlay strings in
3126 IT->overlay_strings. Load more until the one for
3127 pos->overlay_string_index is in IT->overlay_strings. */
3128 if (pos->overlay_string_index >= OVERLAY_STRING_CHUNK_SIZE)
3129 {
3130 ptrdiff_t n = pos->overlay_string_index / OVERLAY_STRING_CHUNK_SIZE;
3131 it->current.overlay_string_index = 0;
3132 while (n--)
3133 {
3134 load_overlay_strings (it, 0);
3135 it->current.overlay_string_index += OVERLAY_STRING_CHUNK_SIZE;
3136 }
3137 }
3138
3139 it->current.overlay_string_index = pos->overlay_string_index;
3140 relative_index = (it->current.overlay_string_index
3141 % OVERLAY_STRING_CHUNK_SIZE);
3142 it->string = it->overlay_strings[relative_index];
3143 eassert (STRINGP (it->string));
3144 it->current.string_pos = pos->string_pos;
3145 it->method = GET_FROM_STRING;
3146 it->end_charpos = SCHARS (it->string);
3147 /* Set up the bidi iterator for this overlay string. */
3148 if (it->bidi_p)
3149 {
3150 it->bidi_it.string.lstring = it->string;
3151 it->bidi_it.string.s = NULL;
3152 it->bidi_it.string.schars = SCHARS (it->string);
3153 it->bidi_it.string.bufpos = it->overlay_strings_charpos;
3154 it->bidi_it.string.from_disp_str = it->string_from_display_prop_p;
3155 it->bidi_it.string.unibyte = !it->multibyte_p;
3156 it->bidi_it.w = it->w;
3157 bidi_init_it (IT_STRING_CHARPOS (*it), IT_STRING_BYTEPOS (*it),
3158 FRAME_WINDOW_P (it->f), &it->bidi_it);
3159
3160 /* Synchronize the state of the bidi iterator with
3161 pos->string_pos. For any string position other than
3162 zero, this will be done automagically when we resume
3163 iteration over the string and get_visually_first_element
3164 is called. But if string_pos is zero, and the string is
3165 to be reordered for display, we need to resync manually,
3166 since it could be that the iteration state recorded in
3167 pos ended at string_pos of 0 moving backwards in string. */
3168 if (CHARPOS (pos->string_pos) == 0)
3169 {
3170 get_visually_first_element (it);
3171 if (IT_STRING_CHARPOS (*it) != 0)
3172 do {
3173 /* Paranoia. */
3174 eassert (it->bidi_it.charpos < it->bidi_it.string.schars);
3175 bidi_move_to_visually_next (&it->bidi_it);
3176 } while (it->bidi_it.charpos != 0);
3177 }
3178 eassert (IT_STRING_CHARPOS (*it) == it->bidi_it.charpos
3179 && IT_STRING_BYTEPOS (*it) == it->bidi_it.bytepos);
3180 }
3181 }
3182
3183 if (CHARPOS (pos->string_pos) >= 0)
3184 {
3185 /* Recorded position is not in an overlay string, but in another
3186 string. This can only be a string from a `display' property.
3187 IT should already be filled with that string. */
3188 it->current.string_pos = pos->string_pos;
3189 eassert (STRINGP (it->string));
3190 if (it->bidi_p)
3191 bidi_init_it (IT_STRING_CHARPOS (*it), IT_STRING_BYTEPOS (*it),
3192 FRAME_WINDOW_P (it->f), &it->bidi_it);
3193 }
3194
3195 /* Restore position in display vector translations, control
3196 character translations or ellipses. */
3197 if (pos->dpvec_index >= 0)
3198 {
3199 if (it->dpvec == NULL)
3200 get_next_display_element (it);
3201 eassert (it->dpvec && it->current.dpvec_index == 0);
3202 it->current.dpvec_index = pos->dpvec_index;
3203 }
3204
3205 CHECK_IT (it);
3206 return !overlay_strings_with_newlines;
3207 }
3208
3209
3210 /* Initialize IT for stepping through current_buffer in window W
3211 starting at ROW->start. */
3212
3213 static void
3214 init_to_row_start (struct it *it, struct window *w, struct glyph_row *row)
3215 {
3216 init_from_display_pos (it, w, &row->start);
3217 it->start = row->start;
3218 it->continuation_lines_width = row->continuation_lines_width;
3219 CHECK_IT (it);
3220 }
3221
3222
3223 /* Initialize IT for stepping through current_buffer in window W
3224 starting in the line following ROW, i.e. starting at ROW->end.
3225 Value is false if there are overlay strings with newlines at ROW's
3226 end position. */
3227
3228 static bool
3229 init_to_row_end (struct it *it, struct window *w, struct glyph_row *row)
3230 {
3231 bool success = false;
3232
3233 if (init_from_display_pos (it, w, &row->end))
3234 {
3235 if (row->continued_p)
3236 it->continuation_lines_width
3237 = row->continuation_lines_width + row->pixel_width;
3238 CHECK_IT (it);
3239 success = true;
3240 }
3241
3242 return success;
3243 }
3244
3245
3246
3247 \f
3248 /***********************************************************************
3249 Text properties
3250 ***********************************************************************/
3251
3252 /* Called when IT reaches IT->stop_charpos. Handle text property and
3253 overlay changes. Set IT->stop_charpos to the next position where
3254 to stop. */
3255
3256 static void
3257 handle_stop (struct it *it)
3258 {
3259 enum prop_handled handled;
3260 bool handle_overlay_change_p;
3261 struct props *p;
3262
3263 it->dpvec = NULL;
3264 it->current.dpvec_index = -1;
3265 handle_overlay_change_p = !it->ignore_overlay_strings_at_pos_p;
3266 it->ellipsis_p = false;
3267
3268 /* Use face of preceding text for ellipsis (if invisible) */
3269 if (it->selective_display_ellipsis_p)
3270 it->saved_face_id = it->face_id;
3271
3272 /* Here's the description of the semantics of, and the logic behind,
3273 the various HANDLED_* statuses:
3274
3275 HANDLED_NORMALLY means the handler did its job, and the loop
3276 should proceed to calling the next handler in order.
3277
3278 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3279 change in the properties and overlays at current position, so the
3280 loop should be restarted, to re-invoke the handlers that were
3281 already called. This happens when fontification-functions were
3282 called by handle_fontified_prop, and actually fontified
3283 something. Another case where HANDLED_RECOMPUTE_PROPS is
3284 returned is when we discover overlay strings that need to be
3285 displayed right away. The loop below will continue for as long
3286 as the status is HANDLED_RECOMPUTE_PROPS.
3287
3288 HANDLED_RETURN means return immediately to the caller, to
3289 continue iteration without calling any further handlers. This is
3290 used when we need to act on some property right away, for example
3291 when we need to display the ellipsis or a replacing display
3292 property, such as display string or image.
3293
3294 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3295 consumed, and the handler switched to the next overlay string.
3296 This signals the loop below to refrain from looking for more
3297 overlays before all the overlay strings of the current overlay
3298 are processed.
3299
3300 Some of the handlers called by the loop push the iterator state
3301 onto the stack (see 'push_it'), and arrange for the iteration to
3302 continue with another object, such as an image, a display string,
3303 or an overlay string. In most such cases, it->stop_charpos is
3304 set to the first character of the string, so that when the
3305 iteration resumes, this function will immediately be called
3306 again, to examine the properties at the beginning of the string.
3307
3308 When a display or overlay string is exhausted, the iterator state
3309 is popped (see 'pop_it'), and iteration continues with the
3310 previous object. Again, in many such cases this function is
3311 called again to find the next position where properties might
3312 change. */
3313
3314 do
3315 {
3316 handled = HANDLED_NORMALLY;
3317
3318 /* Call text property handlers. */
3319 for (p = it_props; p->handler; ++p)
3320 {
3321 handled = p->handler (it);
3322
3323 if (handled == HANDLED_RECOMPUTE_PROPS)
3324 break;
3325 else if (handled == HANDLED_RETURN)
3326 {
3327 /* We still want to show before and after strings from
3328 overlays even if the actual buffer text is replaced. */
3329 if (!handle_overlay_change_p
3330 || it->sp > 1
3331 /* Don't call get_overlay_strings_1 if we already
3332 have overlay strings loaded, because doing so
3333 will load them again and push the iterator state
3334 onto the stack one more time, which is not
3335 expected by the rest of the code that processes
3336 overlay strings. */
3337 || (it->current.overlay_string_index < 0
3338 && !get_overlay_strings_1 (it, 0, false)))
3339 {
3340 if (it->ellipsis_p)
3341 setup_for_ellipsis (it, 0);
3342 /* When handling a display spec, we might load an
3343 empty string. In that case, discard it here. We
3344 used to discard it in handle_single_display_spec,
3345 but that causes get_overlay_strings_1, above, to
3346 ignore overlay strings that we must check. */
3347 if (STRINGP (it->string) && !SCHARS (it->string))
3348 pop_it (it);
3349 return;
3350 }
3351 else if (STRINGP (it->string) && !SCHARS (it->string))
3352 pop_it (it);
3353 else
3354 {
3355 it->string_from_display_prop_p = false;
3356 it->from_disp_prop_p = false;
3357 handle_overlay_change_p = false;
3358 }
3359 handled = HANDLED_RECOMPUTE_PROPS;
3360 break;
3361 }
3362 else if (handled == HANDLED_OVERLAY_STRING_CONSUMED)
3363 handle_overlay_change_p = false;
3364 }
3365
3366 if (handled != HANDLED_RECOMPUTE_PROPS)
3367 {
3368 /* Don't check for overlay strings below when set to deliver
3369 characters from a display vector. */
3370 if (it->method == GET_FROM_DISPLAY_VECTOR)
3371 handle_overlay_change_p = false;
3372
3373 /* Handle overlay changes.
3374 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3375 if it finds overlays. */
3376 if (handle_overlay_change_p)
3377 handled = handle_overlay_change (it);
3378 }
3379
3380 if (it->ellipsis_p)
3381 {
3382 setup_for_ellipsis (it, 0);
3383 break;
3384 }
3385 }
3386 while (handled == HANDLED_RECOMPUTE_PROPS);
3387
3388 /* Determine where to stop next. */
3389 if (handled == HANDLED_NORMALLY)
3390 compute_stop_pos (it);
3391 }
3392
3393
3394 /* Compute IT->stop_charpos from text property and overlay change
3395 information for IT's current position. */
3396
3397 static void
3398 compute_stop_pos (struct it *it)
3399 {
3400 register INTERVAL iv, next_iv;
3401 Lisp_Object object, limit, position;
3402 ptrdiff_t charpos, bytepos;
3403
3404 if (STRINGP (it->string))
3405 {
3406 /* Strings are usually short, so don't limit the search for
3407 properties. */
3408 it->stop_charpos = it->end_charpos;
3409 object = it->string;
3410 limit = Qnil;
3411 charpos = IT_STRING_CHARPOS (*it);
3412 bytepos = IT_STRING_BYTEPOS (*it);
3413 }
3414 else
3415 {
3416 ptrdiff_t pos;
3417
3418 /* If end_charpos is out of range for some reason, such as a
3419 misbehaving display function, rationalize it (Bug#5984). */
3420 if (it->end_charpos > ZV)
3421 it->end_charpos = ZV;
3422 it->stop_charpos = it->end_charpos;
3423
3424 /* If next overlay change is in front of the current stop pos
3425 (which is IT->end_charpos), stop there. Note: value of
3426 next_overlay_change is point-max if no overlay change
3427 follows. */
3428 charpos = IT_CHARPOS (*it);
3429 bytepos = IT_BYTEPOS (*it);
3430 pos = next_overlay_change (charpos);
3431 if (pos < it->stop_charpos)
3432 it->stop_charpos = pos;
3433
3434 /* Set up variables for computing the stop position from text
3435 property changes. */
3436 XSETBUFFER (object, current_buffer);
3437 limit = make_number (IT_CHARPOS (*it) + TEXT_PROP_DISTANCE_LIMIT);
3438 }
3439
3440 /* Get the interval containing IT's position. Value is a null
3441 interval if there isn't such an interval. */
3442 position = make_number (charpos);
3443 iv = validate_interval_range (object, &position, &position, false);
3444 if (iv)
3445 {
3446 Lisp_Object values_here[LAST_PROP_IDX];
3447 struct props *p;
3448
3449 /* Get properties here. */
3450 for (p = it_props; p->handler; ++p)
3451 values_here[p->idx] = textget (iv->plist,
3452 builtin_lisp_symbol (p->name));
3453
3454 /* Look for an interval following iv that has different
3455 properties. */
3456 for (next_iv = next_interval (iv);
3457 (next_iv
3458 && (NILP (limit)
3459 || XFASTINT (limit) > next_iv->position));
3460 next_iv = next_interval (next_iv))
3461 {
3462 for (p = it_props; p->handler; ++p)
3463 {
3464 Lisp_Object new_value = textget (next_iv->plist,
3465 builtin_lisp_symbol (p->name));
3466 if (!EQ (values_here[p->idx], new_value))
3467 break;
3468 }
3469
3470 if (p->handler)
3471 break;
3472 }
3473
3474 if (next_iv)
3475 {
3476 if (INTEGERP (limit)
3477 && next_iv->position >= XFASTINT (limit))
3478 /* No text property change up to limit. */
3479 it->stop_charpos = min (XFASTINT (limit), it->stop_charpos);
3480 else
3481 /* Text properties change in next_iv. */
3482 it->stop_charpos = min (it->stop_charpos, next_iv->position);
3483 }
3484 }
3485
3486 if (it->cmp_it.id < 0)
3487 {
3488 ptrdiff_t stoppos = it->end_charpos;
3489
3490 if (it->bidi_p && it->bidi_it.scan_dir < 0)
3491 stoppos = -1;
3492 composition_compute_stop_pos (&it->cmp_it, charpos, bytepos,
3493 stoppos, it->string);
3494 }
3495
3496 eassert (STRINGP (it->string)
3497 || (it->stop_charpos >= BEGV
3498 && it->stop_charpos >= IT_CHARPOS (*it)));
3499 }
3500
3501
3502 /* Return the position of the next overlay change after POS in
3503 current_buffer. Value is point-max if no overlay change
3504 follows. This is like `next-overlay-change' but doesn't use
3505 xmalloc. */
3506
3507 static ptrdiff_t
3508 next_overlay_change (ptrdiff_t pos)
3509 {
3510 ptrdiff_t i, noverlays;
3511 ptrdiff_t endpos;
3512 Lisp_Object *overlays;
3513 USE_SAFE_ALLOCA;
3514
3515 /* Get all overlays at the given position. */
3516 GET_OVERLAYS_AT (pos, overlays, noverlays, &endpos, true);
3517
3518 /* If any of these overlays ends before endpos,
3519 use its ending point instead. */
3520 for (i = 0; i < noverlays; ++i)
3521 {
3522 Lisp_Object oend;
3523 ptrdiff_t oendpos;
3524
3525 oend = OVERLAY_END (overlays[i]);
3526 oendpos = OVERLAY_POSITION (oend);
3527 endpos = min (endpos, oendpos);
3528 }
3529
3530 SAFE_FREE ();
3531 return endpos;
3532 }
3533
3534 /* How many characters forward to search for a display property or
3535 display string. Searching too far forward makes the bidi display
3536 sluggish, especially in small windows. */
3537 #define MAX_DISP_SCAN 250
3538
3539 /* Return the character position of a display string at or after
3540 position specified by POSITION. If no display string exists at or
3541 after POSITION, return ZV. A display string is either an overlay
3542 with `display' property whose value is a string, or a `display'
3543 text property whose value is a string. STRING is data about the
3544 string to iterate; if STRING->lstring is nil, we are iterating a
3545 buffer. FRAME_WINDOW_P is true when we are displaying a window
3546 on a GUI frame. DISP_PROP is set to zero if we searched
3547 MAX_DISP_SCAN characters forward without finding any display
3548 strings, non-zero otherwise. It is set to 2 if the display string
3549 uses any kind of `(space ...)' spec that will produce a stretch of
3550 white space in the text area. */
3551 ptrdiff_t
3552 compute_display_string_pos (struct text_pos *position,
3553 struct bidi_string_data *string,
3554 struct window *w,
3555 bool frame_window_p, int *disp_prop)
3556 {
3557 /* OBJECT = nil means current buffer. */
3558 Lisp_Object object, object1;
3559 Lisp_Object pos, spec, limpos;
3560 bool string_p = string && (STRINGP (string->lstring) || string->s);
3561 ptrdiff_t eob = string_p ? string->schars : ZV;
3562 ptrdiff_t begb = string_p ? 0 : BEGV;
3563 ptrdiff_t bufpos, charpos = CHARPOS (*position);
3564 ptrdiff_t lim =
3565 (charpos < eob - MAX_DISP_SCAN) ? charpos + MAX_DISP_SCAN : eob;
3566 struct text_pos tpos;
3567 int rv = 0;
3568
3569 if (string && STRINGP (string->lstring))
3570 object1 = object = string->lstring;
3571 else if (w && !string_p)
3572 {
3573 XSETWINDOW (object, w);
3574 object1 = Qnil;
3575 }
3576 else
3577 object1 = object = Qnil;
3578
3579 *disp_prop = 1;
3580
3581 if (charpos >= eob
3582 /* We don't support display properties whose values are strings
3583 that have display string properties. */
3584 || string->from_disp_str
3585 /* C strings cannot have display properties. */
3586 || (string->s && !STRINGP (object)))
3587 {
3588 *disp_prop = 0;
3589 return eob;
3590 }
3591
3592 /* If the character at CHARPOS is where the display string begins,
3593 return CHARPOS. */
3594 pos = make_number (charpos);
3595 if (STRINGP (object))
3596 bufpos = string->bufpos;
3597 else
3598 bufpos = charpos;
3599 tpos = *position;
3600 if (!NILP (spec = Fget_char_property (pos, Qdisplay, object))
3601 && (charpos <= begb
3602 || !EQ (Fget_char_property (make_number (charpos - 1), Qdisplay,
3603 object),
3604 spec))
3605 && (rv = handle_display_spec (NULL, spec, object, Qnil, &tpos, bufpos,
3606 frame_window_p)))
3607 {
3608 if (rv == 2)
3609 *disp_prop = 2;
3610 return charpos;
3611 }
3612
3613 /* Look forward for the first character with a `display' property
3614 that will replace the underlying text when displayed. */
3615 limpos = make_number (lim);
3616 do {
3617 pos = Fnext_single_char_property_change (pos, Qdisplay, object1, limpos);
3618 CHARPOS (tpos) = XFASTINT (pos);
3619 if (CHARPOS (tpos) >= lim)
3620 {
3621 *disp_prop = 0;
3622 break;
3623 }
3624 if (STRINGP (object))
3625 BYTEPOS (tpos) = string_char_to_byte (object, CHARPOS (tpos));
3626 else
3627 BYTEPOS (tpos) = CHAR_TO_BYTE (CHARPOS (tpos));
3628 spec = Fget_char_property (pos, Qdisplay, object);
3629 if (!STRINGP (object))
3630 bufpos = CHARPOS (tpos);
3631 } while (NILP (spec)
3632 || !(rv = handle_display_spec (NULL, spec, object, Qnil, &tpos,
3633 bufpos, frame_window_p)));
3634 if (rv == 2)
3635 *disp_prop = 2;
3636
3637 return CHARPOS (tpos);
3638 }
3639
3640 /* Return the character position of the end of the display string that
3641 started at CHARPOS. If there's no display string at CHARPOS,
3642 return -1. A display string is either an overlay with `display'
3643 property whose value is a string or a `display' text property whose
3644 value is a string. */
3645 ptrdiff_t
3646 compute_display_string_end (ptrdiff_t charpos, struct bidi_string_data *string)
3647 {
3648 /* OBJECT = nil means current buffer. */
3649 Lisp_Object object =
3650 (string && STRINGP (string->lstring)) ? string->lstring : Qnil;
3651 Lisp_Object pos = make_number (charpos);
3652 ptrdiff_t eob =
3653 (STRINGP (object) || (string && string->s)) ? string->schars : ZV;
3654
3655 if (charpos >= eob || (string->s && !STRINGP (object)))
3656 return eob;
3657
3658 /* It could happen that the display property or overlay was removed
3659 since we found it in compute_display_string_pos above. One way
3660 this can happen is if JIT font-lock was called (through
3661 handle_fontified_prop), and jit-lock-functions remove text
3662 properties or overlays from the portion of buffer that includes
3663 CHARPOS. Muse mode is known to do that, for example. In this
3664 case, we return -1 to the caller, to signal that no display
3665 string is actually present at CHARPOS. See bidi_fetch_char for
3666 how this is handled.
3667
3668 An alternative would be to never look for display properties past
3669 it->stop_charpos. But neither compute_display_string_pos nor
3670 bidi_fetch_char that calls it know or care where the next
3671 stop_charpos is. */
3672 if (NILP (Fget_char_property (pos, Qdisplay, object)))
3673 return -1;
3674
3675 /* Look forward for the first character where the `display' property
3676 changes. */
3677 pos = Fnext_single_char_property_change (pos, Qdisplay, object, Qnil);
3678
3679 return XFASTINT (pos);
3680 }
3681
3682
3683 \f
3684 /***********************************************************************
3685 Fontification
3686 ***********************************************************************/
3687
3688 /* Handle changes in the `fontified' property of the current buffer by
3689 calling hook functions from Qfontification_functions to fontify
3690 regions of text. */
3691
3692 static enum prop_handled
3693 handle_fontified_prop (struct it *it)
3694 {
3695 Lisp_Object prop, pos;
3696 enum prop_handled handled = HANDLED_NORMALLY;
3697
3698 if (!NILP (Vmemory_full))
3699 return handled;
3700
3701 /* Get the value of the `fontified' property at IT's current buffer
3702 position. (The `fontified' property doesn't have a special
3703 meaning in strings.) If the value is nil, call functions from
3704 Qfontification_functions. */
3705 if (!STRINGP (it->string)
3706 && it->s == NULL
3707 && !NILP (Vfontification_functions)
3708 && !NILP (Vrun_hooks)
3709 && (pos = make_number (IT_CHARPOS (*it)),
3710 prop = Fget_char_property (pos, Qfontified, Qnil),
3711 /* Ignore the special cased nil value always present at EOB since
3712 no amount of fontifying will be able to change it. */
3713 NILP (prop) && IT_CHARPOS (*it) < Z))
3714 {
3715 ptrdiff_t count = SPECPDL_INDEX ();
3716 Lisp_Object val;
3717 struct buffer *obuf = current_buffer;
3718 ptrdiff_t begv = BEGV, zv = ZV;
3719 bool old_clip_changed = current_buffer->clip_changed;
3720
3721 val = Vfontification_functions;
3722 specbind (Qfontification_functions, Qnil);
3723
3724 eassert (it->end_charpos == ZV);
3725
3726 if (!CONSP (val) || EQ (XCAR (val), Qlambda))
3727 safe_call1 (val, pos);
3728 else
3729 {
3730 Lisp_Object fns, fn;
3731
3732 fns = Qnil;
3733
3734 for (; CONSP (val); val = XCDR (val))
3735 {
3736 fn = XCAR (val);
3737
3738 if (EQ (fn, Qt))
3739 {
3740 /* A value of t indicates this hook has a local
3741 binding; it means to run the global binding too.
3742 In a global value, t should not occur. If it
3743 does, we must ignore it to avoid an endless
3744 loop. */
3745 for (fns = Fdefault_value (Qfontification_functions);
3746 CONSP (fns);
3747 fns = XCDR (fns))
3748 {
3749 fn = XCAR (fns);
3750 if (!EQ (fn, Qt))
3751 safe_call1 (fn, pos);
3752 }
3753 }
3754 else
3755 safe_call1 (fn, pos);
3756 }
3757 }
3758
3759 unbind_to (count, Qnil);
3760
3761 /* Fontification functions routinely call `save-restriction'.
3762 Normally, this tags clip_changed, which can confuse redisplay
3763 (see discussion in Bug#6671). Since we don't perform any
3764 special handling of fontification changes in the case where
3765 `save-restriction' isn't called, there's no point doing so in
3766 this case either. So, if the buffer's restrictions are
3767 actually left unchanged, reset clip_changed. */
3768 if (obuf == current_buffer)
3769 {
3770 if (begv == BEGV && zv == ZV)
3771 current_buffer->clip_changed = old_clip_changed;
3772 }
3773 /* There isn't much we can reasonably do to protect against
3774 misbehaving fontification, but here's a fig leaf. */
3775 else if (BUFFER_LIVE_P (obuf))
3776 set_buffer_internal_1 (obuf);
3777
3778 /* The fontification code may have added/removed text.
3779 It could do even a lot worse, but let's at least protect against
3780 the most obvious case where only the text past `pos' gets changed',
3781 as is/was done in grep.el where some escapes sequences are turned
3782 into face properties (bug#7876). */
3783 it->end_charpos = ZV;
3784
3785 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3786 something. This avoids an endless loop if they failed to
3787 fontify the text for which reason ever. */
3788 if (!NILP (Fget_char_property (pos, Qfontified, Qnil)))
3789 handled = HANDLED_RECOMPUTE_PROPS;
3790 }
3791
3792 return handled;
3793 }
3794
3795
3796 \f
3797 /***********************************************************************
3798 Faces
3799 ***********************************************************************/
3800
3801 /* Set up iterator IT from face properties at its current position.
3802 Called from handle_stop. */
3803
3804 static enum prop_handled
3805 handle_face_prop (struct it *it)
3806 {
3807 int new_face_id;
3808 ptrdiff_t next_stop;
3809
3810 if (!STRINGP (it->string))
3811 {
3812 new_face_id
3813 = face_at_buffer_position (it->w,
3814 IT_CHARPOS (*it),
3815 &next_stop,
3816 (IT_CHARPOS (*it)
3817 + TEXT_PROP_DISTANCE_LIMIT),
3818 false, it->base_face_id);
3819
3820 /* Is this a start of a run of characters with box face?
3821 Caveat: this can be called for a freshly initialized
3822 iterator; face_id is -1 in this case. We know that the new
3823 face will not change until limit, i.e. if the new face has a
3824 box, all characters up to limit will have one. But, as
3825 usual, we don't know whether limit is really the end. */
3826 if (new_face_id != it->face_id)
3827 {
3828 struct face *new_face = FACE_FROM_ID (it->f, new_face_id);
3829 /* If it->face_id is -1, old_face below will be NULL, see
3830 the definition of FACE_FROM_ID. This will happen if this
3831 is the initial call that gets the face. */
3832 struct face *old_face = FACE_FROM_ID (it->f, it->face_id);
3833
3834 /* If the value of face_id of the iterator is -1, we have to
3835 look in front of IT's position and see whether there is a
3836 face there that's different from new_face_id. */
3837 if (!old_face && IT_CHARPOS (*it) > BEG)
3838 {
3839 int prev_face_id = face_before_it_pos (it);
3840
3841 old_face = FACE_FROM_ID (it->f, prev_face_id);
3842 }
3843
3844 /* If the new face has a box, but the old face does not,
3845 this is the start of a run of characters with box face,
3846 i.e. this character has a shadow on the left side. */
3847 it->start_of_box_run_p = (new_face->box != FACE_NO_BOX
3848 && (old_face == NULL || !old_face->box));
3849 it->face_box_p = new_face->box != FACE_NO_BOX;
3850 }
3851 }
3852 else
3853 {
3854 int base_face_id;
3855 ptrdiff_t bufpos;
3856 int i;
3857 Lisp_Object from_overlay
3858 = (it->current.overlay_string_index >= 0
3859 ? it->string_overlays[it->current.overlay_string_index
3860 % OVERLAY_STRING_CHUNK_SIZE]
3861 : Qnil);
3862
3863 /* See if we got to this string directly or indirectly from
3864 an overlay property. That includes the before-string or
3865 after-string of an overlay, strings in display properties
3866 provided by an overlay, their text properties, etc.
3867
3868 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3869 if (! NILP (from_overlay))
3870 for (i = it->sp - 1; i >= 0; i--)
3871 {
3872 if (it->stack[i].current.overlay_string_index >= 0)
3873 from_overlay
3874 = it->string_overlays[it->stack[i].current.overlay_string_index
3875 % OVERLAY_STRING_CHUNK_SIZE];
3876 else if (! NILP (it->stack[i].from_overlay))
3877 from_overlay = it->stack[i].from_overlay;
3878
3879 if (!NILP (from_overlay))
3880 break;
3881 }
3882
3883 if (! NILP (from_overlay))
3884 {
3885 bufpos = IT_CHARPOS (*it);
3886 /* For a string from an overlay, the base face depends
3887 only on text properties and ignores overlays. */
3888 base_face_id
3889 = face_for_overlay_string (it->w,
3890 IT_CHARPOS (*it),
3891 &next_stop,
3892 (IT_CHARPOS (*it)
3893 + TEXT_PROP_DISTANCE_LIMIT),
3894 false,
3895 from_overlay);
3896 }
3897 else
3898 {
3899 bufpos = 0;
3900
3901 /* For strings from a `display' property, use the face at
3902 IT's current buffer position as the base face to merge
3903 with, so that overlay strings appear in the same face as
3904 surrounding text, unless they specify their own faces.
3905 For strings from wrap-prefix and line-prefix properties,
3906 use the default face, possibly remapped via
3907 Vface_remapping_alist. */
3908 /* Note that the fact that we use the face at _buffer_
3909 position means that a 'display' property on an overlay
3910 string will not inherit the face of that overlay string,
3911 but will instead revert to the face of buffer text
3912 covered by the overlay. This is visible, e.g., when the
3913 overlay specifies a box face, but neither the buffer nor
3914 the display string do. This sounds like a design bug,
3915 but Emacs always did that since v21.1, so changing that
3916 might be a big deal. */
3917 base_face_id = it->string_from_prefix_prop_p
3918 ? (!NILP (Vface_remapping_alist)
3919 ? lookup_basic_face (it->f, DEFAULT_FACE_ID)
3920 : DEFAULT_FACE_ID)
3921 : underlying_face_id (it);
3922 }
3923
3924 new_face_id = face_at_string_position (it->w,
3925 it->string,
3926 IT_STRING_CHARPOS (*it),
3927 bufpos,
3928 &next_stop,
3929 base_face_id, false);
3930
3931 /* Is this a start of a run of characters with box? Caveat:
3932 this can be called for a freshly allocated iterator; face_id
3933 is -1 is this case. We know that the new face will not
3934 change until the next check pos, i.e. if the new face has a
3935 box, all characters up to that position will have a
3936 box. But, as usual, we don't know whether that position
3937 is really the end. */
3938 if (new_face_id != it->face_id)
3939 {
3940 struct face *new_face = FACE_FROM_ID (it->f, new_face_id);
3941 struct face *old_face = FACE_FROM_ID (it->f, it->face_id);
3942
3943 /* If new face has a box but old face hasn't, this is the
3944 start of a run of characters with box, i.e. it has a
3945 shadow on the left side. */
3946 it->start_of_box_run_p
3947 = new_face->box && (old_face == NULL || !old_face->box);
3948 it->face_box_p = new_face->box != FACE_NO_BOX;
3949 }
3950 }
3951
3952 it->face_id = new_face_id;
3953 return HANDLED_NORMALLY;
3954 }
3955
3956
3957 /* Return the ID of the face ``underlying'' IT's current position,
3958 which is in a string. If the iterator is associated with a
3959 buffer, return the face at IT's current buffer position.
3960 Otherwise, use the iterator's base_face_id. */
3961
3962 static int
3963 underlying_face_id (struct it *it)
3964 {
3965 int face_id = it->base_face_id, i;
3966
3967 eassert (STRINGP (it->string));
3968
3969 for (i = it->sp - 1; i >= 0; --i)
3970 if (NILP (it->stack[i].string))
3971 face_id = it->stack[i].face_id;
3972
3973 return face_id;
3974 }
3975
3976
3977 /* Compute the face one character before or after the current position
3978 of IT, in the visual order. BEFORE_P means get the face
3979 in front (to the left in L2R paragraphs, to the right in R2L
3980 paragraphs) of IT's screen position. Value is the ID of the face. */
3981
3982 static int
3983 face_before_or_after_it_pos (struct it *it, bool before_p)
3984 {
3985 int face_id, limit;
3986 ptrdiff_t next_check_charpos;
3987 struct it it_copy;
3988 void *it_copy_data = NULL;
3989
3990 eassert (it->s == NULL);
3991
3992 if (STRINGP (it->string))
3993 {
3994 ptrdiff_t bufpos, charpos;
3995 int base_face_id;
3996
3997 /* No face change past the end of the string (for the case
3998 we are padding with spaces). No face change before the
3999 string start. */
4000 if (IT_STRING_CHARPOS (*it) >= SCHARS (it->string)
4001 || (IT_STRING_CHARPOS (*it) == 0 && before_p))
4002 return it->face_id;
4003
4004 if (!it->bidi_p)
4005 {
4006 /* Set charpos to the position before or after IT's current
4007 position, in the logical order, which in the non-bidi
4008 case is the same as the visual order. */
4009 if (before_p)
4010 charpos = IT_STRING_CHARPOS (*it) - 1;
4011 else if (it->what == IT_COMPOSITION)
4012 /* For composition, we must check the character after the
4013 composition. */
4014 charpos = IT_STRING_CHARPOS (*it) + it->cmp_it.nchars;
4015 else
4016 charpos = IT_STRING_CHARPOS (*it) + 1;
4017 }
4018 else
4019 {
4020 if (before_p)
4021 {
4022 /* With bidi iteration, the character before the current
4023 in the visual order cannot be found by simple
4024 iteration, because "reverse" reordering is not
4025 supported. Instead, we need to start from the string
4026 beginning and go all the way to the current string
4027 position, remembering the previous position. */
4028 /* Ignore face changes before the first visible
4029 character on this display line. */
4030 if (it->current_x <= it->first_visible_x)
4031 return it->face_id;
4032 SAVE_IT (it_copy, *it, it_copy_data);
4033 IT_STRING_CHARPOS (it_copy) = 0;
4034 bidi_init_it (0, 0, FRAME_WINDOW_P (it_copy.f), &it_copy.bidi_it);
4035
4036 do
4037 {
4038 charpos = IT_STRING_CHARPOS (it_copy);
4039 if (charpos >= SCHARS (it->string))
4040 break;
4041 bidi_move_to_visually_next (&it_copy.bidi_it);
4042 }
4043 while (IT_STRING_CHARPOS (it_copy) != IT_STRING_CHARPOS (*it));
4044
4045 RESTORE_IT (it, it, it_copy_data);
4046 }
4047 else
4048 {
4049 /* Set charpos to the string position of the character
4050 that comes after IT's current position in the visual
4051 order. */
4052 int n = (it->what == IT_COMPOSITION ? it->cmp_it.nchars : 1);
4053
4054 it_copy = *it;
4055 while (n--)
4056 bidi_move_to_visually_next (&it_copy.bidi_it);
4057
4058 charpos = it_copy.bidi_it.charpos;
4059 }
4060 }
4061 eassert (0 <= charpos && charpos <= SCHARS (it->string));
4062
4063 if (it->current.overlay_string_index >= 0)
4064 bufpos = IT_CHARPOS (*it);
4065 else
4066 bufpos = 0;
4067
4068 base_face_id = underlying_face_id (it);
4069
4070 /* Get the face for ASCII, or unibyte. */
4071 face_id = face_at_string_position (it->w,
4072 it->string,
4073 charpos,
4074 bufpos,
4075 &next_check_charpos,
4076 base_face_id, false);
4077
4078 /* Correct the face for charsets different from ASCII. Do it
4079 for the multibyte case only. The face returned above is
4080 suitable for unibyte text if IT->string is unibyte. */
4081 if (STRING_MULTIBYTE (it->string))
4082 {
4083 struct text_pos pos1 = string_pos (charpos, it->string);
4084 const unsigned char *p = SDATA (it->string) + BYTEPOS (pos1);
4085 int c, len;
4086 struct face *face = FACE_FROM_ID (it->f, face_id);
4087
4088 c = string_char_and_length (p, &len);
4089 face_id = FACE_FOR_CHAR (it->f, face, c, charpos, it->string);
4090 }
4091 }
4092 else
4093 {
4094 struct text_pos pos;
4095
4096 if ((IT_CHARPOS (*it) >= ZV && !before_p)
4097 || (IT_CHARPOS (*it) <= BEGV && before_p))
4098 return it->face_id;
4099
4100 limit = IT_CHARPOS (*it) + TEXT_PROP_DISTANCE_LIMIT;
4101 pos = it->current.pos;
4102
4103 if (!it->bidi_p)
4104 {
4105 if (before_p)
4106 DEC_TEXT_POS (pos, it->multibyte_p);
4107 else
4108 {
4109 if (it->what == IT_COMPOSITION)
4110 {
4111 /* For composition, we must check the position after
4112 the composition. */
4113 pos.charpos += it->cmp_it.nchars;
4114 pos.bytepos += it->len;
4115 }
4116 else
4117 INC_TEXT_POS (pos, it->multibyte_p);
4118 }
4119 }
4120 else
4121 {
4122 if (before_p)
4123 {
4124 int current_x;
4125
4126 /* With bidi iteration, the character before the current
4127 in the visual order cannot be found by simple
4128 iteration, because "reverse" reordering is not
4129 supported. Instead, we need to use the move_it_*
4130 family of functions, and move to the previous
4131 character starting from the beginning of the visual
4132 line. */
4133 /* Ignore face changes before the first visible
4134 character on this display line. */
4135 if (it->current_x <= it->first_visible_x)
4136 return it->face_id;
4137 SAVE_IT (it_copy, *it, it_copy_data);
4138 /* Implementation note: Since move_it_in_display_line
4139 works in the iterator geometry, and thinks the first
4140 character is always the leftmost, even in R2L lines,
4141 we don't need to distinguish between the R2L and L2R
4142 cases here. */
4143 current_x = it_copy.current_x;
4144 move_it_vertically_backward (&it_copy, 0);
4145 move_it_in_display_line (&it_copy, ZV, current_x - 1, MOVE_TO_X);
4146 pos = it_copy.current.pos;
4147 RESTORE_IT (it, it, it_copy_data);
4148 }
4149 else
4150 {
4151 /* Set charpos to the buffer position of the character
4152 that comes after IT's current position in the visual
4153 order. */
4154 int n = (it->what == IT_COMPOSITION ? it->cmp_it.nchars : 1);
4155
4156 it_copy = *it;
4157 while (n--)
4158 bidi_move_to_visually_next (&it_copy.bidi_it);
4159
4160 SET_TEXT_POS (pos,
4161 it_copy.bidi_it.charpos, it_copy.bidi_it.bytepos);
4162 }
4163 }
4164 eassert (BEGV <= CHARPOS (pos) && CHARPOS (pos) <= ZV);
4165
4166 /* Determine face for CHARSET_ASCII, or unibyte. */
4167 face_id = face_at_buffer_position (it->w,
4168 CHARPOS (pos),
4169 &next_check_charpos,
4170 limit, false, -1);
4171
4172 /* Correct the face for charsets different from ASCII. Do it
4173 for the multibyte case only. The face returned above is
4174 suitable for unibyte text if current_buffer is unibyte. */
4175 if (it->multibyte_p)
4176 {
4177 int c = FETCH_MULTIBYTE_CHAR (BYTEPOS (pos));
4178 struct face *face = FACE_FROM_ID (it->f, face_id);
4179 face_id = FACE_FOR_CHAR (it->f, face, c, CHARPOS (pos), Qnil);
4180 }
4181 }
4182
4183 return face_id;
4184 }
4185
4186
4187 \f
4188 /***********************************************************************
4189 Invisible text
4190 ***********************************************************************/
4191
4192 /* Set up iterator IT from invisible properties at its current
4193 position. Called from handle_stop. */
4194
4195 static enum prop_handled
4196 handle_invisible_prop (struct it *it)
4197 {
4198 enum prop_handled handled = HANDLED_NORMALLY;
4199 int invis;
4200 Lisp_Object prop;
4201
4202 if (STRINGP (it->string))
4203 {
4204 Lisp_Object end_charpos, limit;
4205
4206 /* Get the value of the invisible text property at the
4207 current position. Value will be nil if there is no such
4208 property. */
4209 end_charpos = make_number (IT_STRING_CHARPOS (*it));
4210 prop = Fget_text_property (end_charpos, Qinvisible, it->string);
4211 invis = TEXT_PROP_MEANS_INVISIBLE (prop);
4212
4213 if (invis != 0 && IT_STRING_CHARPOS (*it) < it->end_charpos)
4214 {
4215 /* Record whether we have to display an ellipsis for the
4216 invisible text. */
4217 bool display_ellipsis_p = (invis == 2);
4218 ptrdiff_t len, endpos;
4219
4220 handled = HANDLED_RECOMPUTE_PROPS;
4221
4222 /* Get the position at which the next visible text can be
4223 found in IT->string, if any. */
4224 endpos = len = SCHARS (it->string);
4225 XSETINT (limit, len);
4226 do
4227 {
4228 end_charpos
4229 = Fnext_single_property_change (end_charpos, Qinvisible,
4230 it->string, limit);
4231 /* Since LIMIT is always an integer, so should be the
4232 value returned by Fnext_single_property_change. */
4233 eassert (INTEGERP (end_charpos));
4234 if (INTEGERP (end_charpos))
4235 {
4236 endpos = XFASTINT (end_charpos);
4237 prop = Fget_text_property (end_charpos, Qinvisible, it->string);
4238 invis = TEXT_PROP_MEANS_INVISIBLE (prop);
4239 if (invis == 2)
4240 display_ellipsis_p = true;
4241 }
4242 else /* Should never happen; but if it does, exit the loop. */
4243 endpos = len;
4244 }
4245 while (invis != 0 && endpos < len);
4246
4247 if (display_ellipsis_p)
4248 it->ellipsis_p = true;
4249
4250 if (endpos < len)
4251 {
4252 /* Text at END_CHARPOS is visible. Move IT there. */
4253 struct text_pos old;
4254 ptrdiff_t oldpos;
4255
4256 old = it->current.string_pos;
4257 oldpos = CHARPOS (old);
4258 if (it->bidi_p)
4259 {
4260 if (it->bidi_it.first_elt
4261 && it->bidi_it.charpos < SCHARS (it->string))
4262 bidi_paragraph_init (it->paragraph_embedding,
4263 &it->bidi_it, true);
4264 /* Bidi-iterate out of the invisible text. */
4265 do
4266 {
4267 bidi_move_to_visually_next (&it->bidi_it);
4268 }
4269 while (oldpos <= it->bidi_it.charpos
4270 && it->bidi_it.charpos < endpos);
4271
4272 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
4273 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
4274 if (IT_CHARPOS (*it) >= endpos)
4275 it->prev_stop = endpos;
4276 }
4277 else
4278 {
4279 IT_STRING_CHARPOS (*it) = endpos;
4280 compute_string_pos (&it->current.string_pos, old, it->string);
4281 }
4282 }
4283 else
4284 {
4285 /* The rest of the string is invisible. If this is an
4286 overlay string, proceed with the next overlay string
4287 or whatever comes and return a character from there. */
4288 if (it->current.overlay_string_index >= 0
4289 && !display_ellipsis_p)
4290 {
4291 next_overlay_string (it);
4292 /* Don't check for overlay strings when we just
4293 finished processing them. */
4294 handled = HANDLED_OVERLAY_STRING_CONSUMED;
4295 }
4296 else
4297 {
4298 IT_STRING_CHARPOS (*it) = SCHARS (it->string);
4299 IT_STRING_BYTEPOS (*it) = SBYTES (it->string);
4300 }
4301 }
4302 }
4303 }
4304 else
4305 {
4306 ptrdiff_t newpos, next_stop, start_charpos, tem;
4307 Lisp_Object pos, overlay;
4308
4309 /* First of all, is there invisible text at this position? */
4310 tem = start_charpos = IT_CHARPOS (*it);
4311 pos = make_number (tem);
4312 prop = get_char_property_and_overlay (pos, Qinvisible, it->window,
4313 &overlay);
4314 invis = TEXT_PROP_MEANS_INVISIBLE (prop);
4315
4316 /* If we are on invisible text, skip over it. */
4317 if (invis != 0 && start_charpos < it->end_charpos)
4318 {
4319 /* Record whether we have to display an ellipsis for the
4320 invisible text. */
4321 bool display_ellipsis_p = invis == 2;
4322
4323 handled = HANDLED_RECOMPUTE_PROPS;
4324
4325 /* Loop skipping over invisible text. The loop is left at
4326 ZV or with IT on the first char being visible again. */
4327 do
4328 {
4329 /* Try to skip some invisible text. Return value is the
4330 position reached which can be equal to where we start
4331 if there is nothing invisible there. This skips both
4332 over invisible text properties and overlays with
4333 invisible property. */
4334 newpos = skip_invisible (tem, &next_stop, ZV, it->window);
4335
4336 /* If we skipped nothing at all we weren't at invisible
4337 text in the first place. If everything to the end of
4338 the buffer was skipped, end the loop. */
4339 if (newpos == tem || newpos >= ZV)
4340 invis = 0;
4341 else
4342 {
4343 /* We skipped some characters but not necessarily
4344 all there are. Check if we ended up on visible
4345 text. Fget_char_property returns the property of
4346 the char before the given position, i.e. if we
4347 get invis = 0, this means that the char at
4348 newpos is visible. */
4349 pos = make_number (newpos);
4350 prop = Fget_char_property (pos, Qinvisible, it->window);
4351 invis = TEXT_PROP_MEANS_INVISIBLE (prop);
4352 }
4353
4354 /* If we ended up on invisible text, proceed to
4355 skip starting with next_stop. */
4356 if (invis != 0)
4357 tem = next_stop;
4358
4359 /* If there are adjacent invisible texts, don't lose the
4360 second one's ellipsis. */
4361 if (invis == 2)
4362 display_ellipsis_p = true;
4363 }
4364 while (invis != 0);
4365
4366 /* The position newpos is now either ZV or on visible text. */
4367 if (it->bidi_p)
4368 {
4369 ptrdiff_t bpos = CHAR_TO_BYTE (newpos);
4370 bool on_newline
4371 = bpos == ZV_BYTE || FETCH_BYTE (bpos) == '\n';
4372 bool after_newline
4373 = newpos <= BEGV || FETCH_BYTE (bpos - 1) == '\n';
4374
4375 /* If the invisible text ends on a newline or on a
4376 character after a newline, we can avoid the costly,
4377 character by character, bidi iteration to NEWPOS, and
4378 instead simply reseat the iterator there. That's
4379 because all bidi reordering information is tossed at
4380 the newline. This is a big win for modes that hide
4381 complete lines, like Outline, Org, etc. */
4382 if (on_newline || after_newline)
4383 {
4384 struct text_pos tpos;
4385 bidi_dir_t pdir = it->bidi_it.paragraph_dir;
4386
4387 SET_TEXT_POS (tpos, newpos, bpos);
4388 reseat_1 (it, tpos, false);
4389 /* If we reseat on a newline/ZV, we need to prep the
4390 bidi iterator for advancing to the next character
4391 after the newline/EOB, keeping the current paragraph
4392 direction (so that PRODUCE_GLYPHS does TRT wrt
4393 prepending/appending glyphs to a glyph row). */
4394 if (on_newline)
4395 {
4396 it->bidi_it.first_elt = false;
4397 it->bidi_it.paragraph_dir = pdir;
4398 it->bidi_it.ch = (bpos == ZV_BYTE) ? -1 : '\n';
4399 it->bidi_it.nchars = 1;
4400 it->bidi_it.ch_len = 1;
4401 }
4402 }
4403 else /* Must use the slow method. */
4404 {
4405 /* With bidi iteration, the region of invisible text
4406 could start and/or end in the middle of a
4407 non-base embedding level. Therefore, we need to
4408 skip invisible text using the bidi iterator,
4409 starting at IT's current position, until we find
4410 ourselves outside of the invisible text.
4411 Skipping invisible text _after_ bidi iteration
4412 avoids affecting the visual order of the
4413 displayed text when invisible properties are
4414 added or removed. */
4415 if (it->bidi_it.first_elt && it->bidi_it.charpos < ZV)
4416 {
4417 /* If we were `reseat'ed to a new paragraph,
4418 determine the paragraph base direction. We
4419 need to do it now because
4420 next_element_from_buffer may not have a
4421 chance to do it, if we are going to skip any
4422 text at the beginning, which resets the
4423 FIRST_ELT flag. */
4424 bidi_paragraph_init (it->paragraph_embedding,
4425 &it->bidi_it, true);
4426 }
4427 do
4428 {
4429 bidi_move_to_visually_next (&it->bidi_it);
4430 }
4431 while (it->stop_charpos <= it->bidi_it.charpos
4432 && it->bidi_it.charpos < newpos);
4433 IT_CHARPOS (*it) = it->bidi_it.charpos;
4434 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
4435 /* If we overstepped NEWPOS, record its position in
4436 the iterator, so that we skip invisible text if
4437 later the bidi iteration lands us in the
4438 invisible region again. */
4439 if (IT_CHARPOS (*it) >= newpos)
4440 it->prev_stop = newpos;
4441 }
4442 }
4443 else
4444 {
4445 IT_CHARPOS (*it) = newpos;
4446 IT_BYTEPOS (*it) = CHAR_TO_BYTE (newpos);
4447 }
4448
4449 if (display_ellipsis_p)
4450 {
4451 /* Make sure that the glyphs of the ellipsis will get
4452 correct `charpos' values. If we would not update
4453 it->position here, the glyphs would belong to the
4454 last visible character _before_ the invisible
4455 text, which confuses `set_cursor_from_row'.
4456
4457 We use the last invisible position instead of the
4458 first because this way the cursor is always drawn on
4459 the first "." of the ellipsis, whenever PT is inside
4460 the invisible text. Otherwise the cursor would be
4461 placed _after_ the ellipsis when the point is after the
4462 first invisible character. */
4463 if (!STRINGP (it->object))
4464 {
4465 it->position.charpos = newpos - 1;
4466 it->position.bytepos = CHAR_TO_BYTE (it->position.charpos);
4467 }
4468 }
4469
4470 /* If there are before-strings at the start of invisible
4471 text, and the text is invisible because of a text
4472 property, arrange to show before-strings because 20.x did
4473 it that way. (If the text is invisible because of an
4474 overlay property instead of a text property, this is
4475 already handled in the overlay code.) */
4476 if (NILP (overlay)
4477 && get_overlay_strings (it, it->stop_charpos))
4478 {
4479 handled = HANDLED_RECOMPUTE_PROPS;
4480 if (it->sp > 0)
4481 {
4482 it->stack[it->sp - 1].display_ellipsis_p = display_ellipsis_p;
4483 /* The call to get_overlay_strings above recomputes
4484 it->stop_charpos, but it only considers changes
4485 in properties and overlays beyond iterator's
4486 current position. This causes us to miss changes
4487 that happen exactly where the invisible property
4488 ended. So we play it safe here and force the
4489 iterator to check for potential stop positions
4490 immediately after the invisible text. Note that
4491 if get_overlay_strings returns true, it
4492 normally also pushed the iterator stack, so we
4493 need to update the stop position in the slot
4494 below the current one. */
4495 it->stack[it->sp - 1].stop_charpos
4496 = CHARPOS (it->stack[it->sp - 1].current.pos);
4497 }
4498 }
4499 else if (display_ellipsis_p)
4500 {
4501 it->ellipsis_p = true;
4502 /* Let the ellipsis display before
4503 considering any properties of the following char.
4504 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4505 handled = HANDLED_RETURN;
4506 }
4507 }
4508 }
4509
4510 return handled;
4511 }
4512
4513
4514 /* Make iterator IT return `...' next.
4515 Replaces LEN characters from buffer. */
4516
4517 static void
4518 setup_for_ellipsis (struct it *it, int len)
4519 {
4520 /* Use the display table definition for `...'. Invalid glyphs
4521 will be handled by the method returning elements from dpvec. */
4522 if (it->dp && VECTORP (DISP_INVIS_VECTOR (it->dp)))
4523 {
4524 struct Lisp_Vector *v = XVECTOR (DISP_INVIS_VECTOR (it->dp));
4525 it->dpvec = v->contents;
4526 it->dpend = v->contents + v->header.size;
4527 }
4528 else
4529 {
4530 /* Default `...'. */
4531 it->dpvec = default_invis_vector;
4532 it->dpend = default_invis_vector + 3;
4533 }
4534
4535 it->dpvec_char_len = len;
4536 it->current.dpvec_index = 0;
4537 it->dpvec_face_id = -1;
4538
4539 /* Remember the current face id in case glyphs specify faces.
4540 IT's face is restored in set_iterator_to_next.
4541 saved_face_id was set to preceding char's face in handle_stop. */
4542 if (it->saved_face_id < 0 || it->saved_face_id != it->face_id)
4543 it->saved_face_id = it->face_id = DEFAULT_FACE_ID;
4544
4545 /* If the ellipsis represents buffer text, it means we advanced in
4546 the buffer, so we should no longer ignore overlay strings. */
4547 if (it->method == GET_FROM_BUFFER)
4548 it->ignore_overlay_strings_at_pos_p = false;
4549
4550 it->method = GET_FROM_DISPLAY_VECTOR;
4551 it->ellipsis_p = true;
4552 }
4553
4554
4555 \f
4556 /***********************************************************************
4557 'display' property
4558 ***********************************************************************/
4559
4560 /* Set up iterator IT from `display' property at its current position.
4561 Called from handle_stop.
4562 We return HANDLED_RETURN if some part of the display property
4563 overrides the display of the buffer text itself.
4564 Otherwise we return HANDLED_NORMALLY. */
4565
4566 static enum prop_handled
4567 handle_display_prop (struct it *it)
4568 {
4569 Lisp_Object propval, object, overlay;
4570 struct text_pos *position;
4571 ptrdiff_t bufpos;
4572 /* Nonzero if some property replaces the display of the text itself. */
4573 int display_replaced = 0;
4574
4575 if (STRINGP (it->string))
4576 {
4577 object = it->string;
4578 position = &it->current.string_pos;
4579 bufpos = CHARPOS (it->current.pos);
4580 }
4581 else
4582 {
4583 XSETWINDOW (object, it->w);
4584 position = &it->current.pos;
4585 bufpos = CHARPOS (*position);
4586 }
4587
4588 /* Reset those iterator values set from display property values. */
4589 it->slice.x = it->slice.y = it->slice.width = it->slice.height = Qnil;
4590 it->space_width = Qnil;
4591 it->font_height = Qnil;
4592 it->voffset = 0;
4593
4594 /* We don't support recursive `display' properties, i.e. string
4595 values that have a string `display' property, that have a string
4596 `display' property etc. */
4597 if (!it->string_from_display_prop_p)
4598 it->area = TEXT_AREA;
4599
4600 propval = get_char_property_and_overlay (make_number (position->charpos),
4601 Qdisplay, object, &overlay);
4602 if (NILP (propval))
4603 return HANDLED_NORMALLY;
4604 /* Now OVERLAY is the overlay that gave us this property, or nil
4605 if it was a text property. */
4606
4607 if (!STRINGP (it->string))
4608 object = it->w->contents;
4609
4610 display_replaced = handle_display_spec (it, propval, object, overlay,
4611 position, bufpos,
4612 FRAME_WINDOW_P (it->f));
4613 return display_replaced != 0 ? HANDLED_RETURN : HANDLED_NORMALLY;
4614 }
4615
4616 /* Subroutine of handle_display_prop. Returns non-zero if the display
4617 specification in SPEC is a replacing specification, i.e. it would
4618 replace the text covered by `display' property with something else,
4619 such as an image or a display string. If SPEC includes any kind or
4620 `(space ...) specification, the value is 2; this is used by
4621 compute_display_string_pos, which see.
4622
4623 See handle_single_display_spec for documentation of arguments.
4624 FRAME_WINDOW_P is true if the window being redisplayed is on a
4625 GUI frame; this argument is used only if IT is NULL, see below.
4626
4627 IT can be NULL, if this is called by the bidi reordering code
4628 through compute_display_string_pos, which see. In that case, this
4629 function only examines SPEC, but does not otherwise "handle" it, in
4630 the sense that it doesn't set up members of IT from the display
4631 spec. */
4632 static int
4633 handle_display_spec (struct it *it, Lisp_Object spec, Lisp_Object object,
4634 Lisp_Object overlay, struct text_pos *position,
4635 ptrdiff_t bufpos, bool frame_window_p)
4636 {
4637 int replacing = 0;
4638
4639 if (CONSP (spec)
4640 /* Simple specifications. */
4641 && !EQ (XCAR (spec), Qimage)
4642 && !EQ (XCAR (spec), Qspace)
4643 && !EQ (XCAR (spec), Qwhen)
4644 && !EQ (XCAR (spec), Qslice)
4645 && !EQ (XCAR (spec), Qspace_width)
4646 && !EQ (XCAR (spec), Qheight)
4647 && !EQ (XCAR (spec), Qraise)
4648 /* Marginal area specifications. */
4649 && !(CONSP (XCAR (spec)) && EQ (XCAR (XCAR (spec)), Qmargin))
4650 && !EQ (XCAR (spec), Qleft_fringe)
4651 && !EQ (XCAR (spec), Qright_fringe)
4652 && !NILP (XCAR (spec)))
4653 {
4654 for (; CONSP (spec); spec = XCDR (spec))
4655 {
4656 int rv = handle_single_display_spec (it, XCAR (spec), object,
4657 overlay, position, bufpos,
4658 replacing, frame_window_p);
4659 if (rv != 0)
4660 {
4661 replacing = rv;
4662 /* If some text in a string is replaced, `position' no
4663 longer points to the position of `object'. */
4664 if (!it || STRINGP (object))
4665 break;
4666 }
4667 }
4668 }
4669 else if (VECTORP (spec))
4670 {
4671 ptrdiff_t i;
4672 for (i = 0; i < ASIZE (spec); ++i)
4673 {
4674 int rv = handle_single_display_spec (it, AREF (spec, i), object,
4675 overlay, position, bufpos,
4676 replacing, frame_window_p);
4677 if (rv != 0)
4678 {
4679 replacing = rv;
4680 /* If some text in a string is replaced, `position' no
4681 longer points to the position of `object'. */
4682 if (!it || STRINGP (object))
4683 break;
4684 }
4685 }
4686 }
4687 else
4688 replacing = handle_single_display_spec (it, spec, object, overlay, position,
4689 bufpos, 0, frame_window_p);
4690 return replacing;
4691 }
4692
4693 /* Value is the position of the end of the `display' property starting
4694 at START_POS in OBJECT. */
4695
4696 static struct text_pos
4697 display_prop_end (struct it *it, Lisp_Object object, struct text_pos start_pos)
4698 {
4699 Lisp_Object end;
4700 struct text_pos end_pos;
4701
4702 end = Fnext_single_char_property_change (make_number (CHARPOS (start_pos)),
4703 Qdisplay, object, Qnil);
4704 CHARPOS (end_pos) = XFASTINT (end);
4705 if (STRINGP (object))
4706 compute_string_pos (&end_pos, start_pos, it->string);
4707 else
4708 BYTEPOS (end_pos) = CHAR_TO_BYTE (XFASTINT (end));
4709
4710 return end_pos;
4711 }
4712
4713
4714 /* Set up IT from a single `display' property specification SPEC. OBJECT
4715 is the object in which the `display' property was found. *POSITION
4716 is the position in OBJECT at which the `display' property was found.
4717 BUFPOS is the buffer position of OBJECT (different from POSITION if
4718 OBJECT is not a buffer). DISPLAY_REPLACED non-zero means that we
4719 previously saw a display specification which already replaced text
4720 display with something else, for example an image; we ignore such
4721 properties after the first one has been processed.
4722
4723 OVERLAY is the overlay this `display' property came from,
4724 or nil if it was a text property.
4725
4726 If SPEC is a `space' or `image' specification, and in some other
4727 cases too, set *POSITION to the position where the `display'
4728 property ends.
4729
4730 If IT is NULL, only examine the property specification in SPEC, but
4731 don't set up IT. In that case, FRAME_WINDOW_P means SPEC
4732 is intended to be displayed in a window on a GUI frame.
4733
4734 Value is non-zero if something was found which replaces the display
4735 of buffer or string text. */
4736
4737 static int
4738 handle_single_display_spec (struct it *it, Lisp_Object spec, Lisp_Object object,
4739 Lisp_Object overlay, struct text_pos *position,
4740 ptrdiff_t bufpos, int display_replaced,
4741 bool frame_window_p)
4742 {
4743 Lisp_Object form;
4744 Lisp_Object location, value;
4745 struct text_pos start_pos = *position;
4746
4747 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4748 If the result is non-nil, use VALUE instead of SPEC. */
4749 form = Qt;
4750 if (CONSP (spec) && EQ (XCAR (spec), Qwhen))
4751 {
4752 spec = XCDR (spec);
4753 if (!CONSP (spec))
4754 return 0;
4755 form = XCAR (spec);
4756 spec = XCDR (spec);
4757 }
4758
4759 if (!NILP (form) && !EQ (form, Qt))
4760 {
4761 ptrdiff_t count = SPECPDL_INDEX ();
4762
4763 /* Bind `object' to the object having the `display' property, a
4764 buffer or string. Bind `position' to the position in the
4765 object where the property was found, and `buffer-position'
4766 to the current position in the buffer. */
4767
4768 if (NILP (object))
4769 XSETBUFFER (object, current_buffer);
4770 specbind (Qobject, object);
4771 specbind (Qposition, make_number (CHARPOS (*position)));
4772 specbind (Qbuffer_position, make_number (bufpos));
4773 form = safe_eval (form);
4774 unbind_to (count, Qnil);
4775 }
4776
4777 if (NILP (form))
4778 return 0;
4779
4780 /* Handle `(height HEIGHT)' specifications. */
4781 if (CONSP (spec)
4782 && EQ (XCAR (spec), Qheight)
4783 && CONSP (XCDR (spec)))
4784 {
4785 if (it)
4786 {
4787 if (!FRAME_WINDOW_P (it->f))
4788 return 0;
4789
4790 it->font_height = XCAR (XCDR (spec));
4791 if (!NILP (it->font_height))
4792 {
4793 struct face *face = FACE_FROM_ID (it->f, it->face_id);
4794 int new_height = -1;
4795
4796 if (CONSP (it->font_height)
4797 && (EQ (XCAR (it->font_height), Qplus)
4798 || EQ (XCAR (it->font_height), Qminus))
4799 && CONSP (XCDR (it->font_height))
4800 && RANGED_INTEGERP (0, XCAR (XCDR (it->font_height)), INT_MAX))
4801 {
4802 /* `(+ N)' or `(- N)' where N is an integer. */
4803 int steps = XINT (XCAR (XCDR (it->font_height)));
4804 if (EQ (XCAR (it->font_height), Qplus))
4805 steps = - steps;
4806 it->face_id = smaller_face (it->f, it->face_id, steps);
4807 }
4808 else if (FUNCTIONP (it->font_height))
4809 {
4810 /* Call function with current height as argument.
4811 Value is the new height. */
4812 Lisp_Object height;
4813 height = safe_call1 (it->font_height,
4814 face->lface[LFACE_HEIGHT_INDEX]);
4815 if (NUMBERP (height))
4816 new_height = XFLOATINT (height);
4817 }
4818 else if (NUMBERP (it->font_height))
4819 {
4820 /* Value is a multiple of the canonical char height. */
4821 struct face *f;
4822
4823 f = FACE_FROM_ID (it->f,
4824 lookup_basic_face (it->f, DEFAULT_FACE_ID));
4825 new_height = (XFLOATINT (it->font_height)
4826 * XINT (f->lface[LFACE_HEIGHT_INDEX]));
4827 }
4828 else
4829 {
4830 /* Evaluate IT->font_height with `height' bound to the
4831 current specified height to get the new height. */
4832 ptrdiff_t count = SPECPDL_INDEX ();
4833
4834 specbind (Qheight, face->lface[LFACE_HEIGHT_INDEX]);
4835 value = safe_eval (it->font_height);
4836 unbind_to (count, Qnil);
4837
4838 if (NUMBERP (value))
4839 new_height = XFLOATINT (value);
4840 }
4841
4842 if (new_height > 0)
4843 it->face_id = face_with_height (it->f, it->face_id, new_height);
4844 }
4845 }
4846
4847 return 0;
4848 }
4849
4850 /* Handle `(space-width WIDTH)'. */
4851 if (CONSP (spec)
4852 && EQ (XCAR (spec), Qspace_width)
4853 && CONSP (XCDR (spec)))
4854 {
4855 if (it)
4856 {
4857 if (!FRAME_WINDOW_P (it->f))
4858 return 0;
4859
4860 value = XCAR (XCDR (spec));
4861 if (NUMBERP (value) && XFLOATINT (value) > 0)
4862 it->space_width = value;
4863 }
4864
4865 return 0;
4866 }
4867
4868 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4869 if (CONSP (spec)
4870 && EQ (XCAR (spec), Qslice))
4871 {
4872 Lisp_Object tem;
4873
4874 if (it)
4875 {
4876 if (!FRAME_WINDOW_P (it->f))
4877 return 0;
4878
4879 if (tem = XCDR (spec), CONSP (tem))
4880 {
4881 it->slice.x = XCAR (tem);
4882 if (tem = XCDR (tem), CONSP (tem))
4883 {
4884 it->slice.y = XCAR (tem);
4885 if (tem = XCDR (tem), CONSP (tem))
4886 {
4887 it->slice.width = XCAR (tem);
4888 if (tem = XCDR (tem), CONSP (tem))
4889 it->slice.height = XCAR (tem);
4890 }
4891 }
4892 }
4893 }
4894
4895 return 0;
4896 }
4897
4898 /* Handle `(raise FACTOR)'. */
4899 if (CONSP (spec)
4900 && EQ (XCAR (spec), Qraise)
4901 && CONSP (XCDR (spec)))
4902 {
4903 if (it)
4904 {
4905 if (!FRAME_WINDOW_P (it->f))
4906 return 0;
4907
4908 #ifdef HAVE_WINDOW_SYSTEM
4909 value = XCAR (XCDR (spec));
4910 if (NUMBERP (value))
4911 {
4912 struct face *face = FACE_FROM_ID (it->f, it->face_id);
4913 it->voffset = - (XFLOATINT (value)
4914 * (normal_char_height (face->font, -1)));
4915 }
4916 #endif /* HAVE_WINDOW_SYSTEM */
4917 }
4918
4919 return 0;
4920 }
4921
4922 /* Don't handle the other kinds of display specifications
4923 inside a string that we got from a `display' property. */
4924 if (it && it->string_from_display_prop_p)
4925 return 0;
4926
4927 /* Characters having this form of property are not displayed, so
4928 we have to find the end of the property. */
4929 if (it)
4930 {
4931 start_pos = *position;
4932 *position = display_prop_end (it, object, start_pos);
4933 /* If the display property comes from an overlay, don't consider
4934 any potential stop_charpos values before the end of that
4935 overlay. Since display_prop_end will happily find another
4936 'display' property coming from some other overlay or text
4937 property on buffer positions before this overlay's end, we
4938 need to ignore them, or else we risk displaying this
4939 overlay's display string/image twice. */
4940 if (!NILP (overlay))
4941 {
4942 ptrdiff_t ovendpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4943
4944 if (ovendpos > CHARPOS (*position))
4945 SET_TEXT_POS (*position, ovendpos, CHAR_TO_BYTE (ovendpos));
4946 }
4947 }
4948 value = Qnil;
4949
4950 /* Stop the scan at that end position--we assume that all
4951 text properties change there. */
4952 if (it)
4953 it->stop_charpos = position->charpos;
4954
4955 /* Handle `(left-fringe BITMAP [FACE])'
4956 and `(right-fringe BITMAP [FACE])'. */
4957 if (CONSP (spec)
4958 && (EQ (XCAR (spec), Qleft_fringe)
4959 || EQ (XCAR (spec), Qright_fringe))
4960 && CONSP (XCDR (spec)))
4961 {
4962 int fringe_bitmap;
4963
4964 if (it)
4965 {
4966 if (!FRAME_WINDOW_P (it->f))
4967 /* If we return here, POSITION has been advanced
4968 across the text with this property. */
4969 {
4970 /* Synchronize the bidi iterator with POSITION. This is
4971 needed because we are not going to push the iterator
4972 on behalf of this display property, so there will be
4973 no pop_it call to do this synchronization for us. */
4974 if (it->bidi_p)
4975 {
4976 it->position = *position;
4977 iterate_out_of_display_property (it);
4978 *position = it->position;
4979 }
4980 return 1;
4981 }
4982 }
4983 else if (!frame_window_p)
4984 return 1;
4985
4986 #ifdef HAVE_WINDOW_SYSTEM
4987 value = XCAR (XCDR (spec));
4988 if (!SYMBOLP (value)
4989 || !(fringe_bitmap = lookup_fringe_bitmap (value)))
4990 /* If we return here, POSITION has been advanced
4991 across the text with this property. */
4992 {
4993 if (it && it->bidi_p)
4994 {
4995 it->position = *position;
4996 iterate_out_of_display_property (it);
4997 *position = it->position;
4998 }
4999 return 1;
5000 }
5001
5002 if (it)
5003 {
5004 int face_id = lookup_basic_face (it->f, DEFAULT_FACE_ID);
5005
5006 if (CONSP (XCDR (XCDR (spec))))
5007 {
5008 Lisp_Object face_name = XCAR (XCDR (XCDR (spec)));
5009 int face_id2 = lookup_derived_face (it->f, face_name,
5010 FRINGE_FACE_ID, false);
5011 if (face_id2 >= 0)
5012 face_id = face_id2;
5013 }
5014
5015 /* Save current settings of IT so that we can restore them
5016 when we are finished with the glyph property value. */
5017 push_it (it, position);
5018
5019 it->area = TEXT_AREA;
5020 it->what = IT_IMAGE;
5021 it->image_id = -1; /* no image */
5022 it->position = start_pos;
5023 it->object = NILP (object) ? it->w->contents : object;
5024 it->method = GET_FROM_IMAGE;
5025 it->from_overlay = Qnil;
5026 it->face_id = face_id;
5027 it->from_disp_prop_p = true;
5028
5029 /* Say that we haven't consumed the characters with
5030 `display' property yet. The call to pop_it in
5031 set_iterator_to_next will clean this up. */
5032 *position = start_pos;
5033
5034 if (EQ (XCAR (spec), Qleft_fringe))
5035 {
5036 it->left_user_fringe_bitmap = fringe_bitmap;
5037 it->left_user_fringe_face_id = face_id;
5038 }
5039 else
5040 {
5041 it->right_user_fringe_bitmap = fringe_bitmap;
5042 it->right_user_fringe_face_id = face_id;
5043 }
5044 }
5045 #endif /* HAVE_WINDOW_SYSTEM */
5046 return 1;
5047 }
5048
5049 /* Prepare to handle `((margin left-margin) ...)',
5050 `((margin right-margin) ...)' and `((margin nil) ...)'
5051 prefixes for display specifications. */
5052 location = Qunbound;
5053 if (CONSP (spec) && CONSP (XCAR (spec)))
5054 {
5055 Lisp_Object tem;
5056
5057 value = XCDR (spec);
5058 if (CONSP (value))
5059 value = XCAR (value);
5060
5061 tem = XCAR (spec);
5062 if (EQ (XCAR (tem), Qmargin)
5063 && (tem = XCDR (tem),
5064 tem = CONSP (tem) ? XCAR (tem) : Qnil,
5065 (NILP (tem)
5066 || EQ (tem, Qleft_margin)
5067 || EQ (tem, Qright_margin))))
5068 location = tem;
5069 }
5070
5071 if (EQ (location, Qunbound))
5072 {
5073 location = Qnil;
5074 value = spec;
5075 }
5076
5077 /* After this point, VALUE is the property after any
5078 margin prefix has been stripped. It must be a string,
5079 an image specification, or `(space ...)'.
5080
5081 LOCATION specifies where to display: `left-margin',
5082 `right-margin' or nil. */
5083
5084 bool valid_p = (STRINGP (value)
5085 #ifdef HAVE_WINDOW_SYSTEM
5086 || ((it ? FRAME_WINDOW_P (it->f) : frame_window_p)
5087 && valid_image_p (value))
5088 #endif /* not HAVE_WINDOW_SYSTEM */
5089 || (CONSP (value) && EQ (XCAR (value), Qspace)));
5090
5091 if (valid_p && display_replaced == 0)
5092 {
5093 int retval = 1;
5094
5095 if (!it)
5096 {
5097 /* Callers need to know whether the display spec is any kind
5098 of `(space ...)' spec that is about to affect text-area
5099 display. */
5100 if (CONSP (value) && EQ (XCAR (value), Qspace) && NILP (location))
5101 retval = 2;
5102 return retval;
5103 }
5104
5105 /* Save current settings of IT so that we can restore them
5106 when we are finished with the glyph property value. */
5107 push_it (it, position);
5108 it->from_overlay = overlay;
5109 it->from_disp_prop_p = true;
5110
5111 if (NILP (location))
5112 it->area = TEXT_AREA;
5113 else if (EQ (location, Qleft_margin))
5114 it->area = LEFT_MARGIN_AREA;
5115 else
5116 it->area = RIGHT_MARGIN_AREA;
5117
5118 if (STRINGP (value))
5119 {
5120 it->string = value;
5121 it->multibyte_p = STRING_MULTIBYTE (it->string);
5122 it->current.overlay_string_index = -1;
5123 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = 0;
5124 it->end_charpos = it->string_nchars = SCHARS (it->string);
5125 it->method = GET_FROM_STRING;
5126 it->stop_charpos = 0;
5127 it->prev_stop = 0;
5128 it->base_level_stop = 0;
5129 it->string_from_display_prop_p = true;
5130 /* Say that we haven't consumed the characters with
5131 `display' property yet. The call to pop_it in
5132 set_iterator_to_next will clean this up. */
5133 if (BUFFERP (object))
5134 *position = start_pos;
5135
5136 /* Force paragraph direction to be that of the parent
5137 object. If the parent object's paragraph direction is
5138 not yet determined, default to L2R. */
5139 if (it->bidi_p && it->bidi_it.paragraph_dir == R2L)
5140 it->paragraph_embedding = it->bidi_it.paragraph_dir;
5141 else
5142 it->paragraph_embedding = L2R;
5143
5144 /* Set up the bidi iterator for this display string. */
5145 if (it->bidi_p)
5146 {
5147 it->bidi_it.string.lstring = it->string;
5148 it->bidi_it.string.s = NULL;
5149 it->bidi_it.string.schars = it->end_charpos;
5150 it->bidi_it.string.bufpos = bufpos;
5151 it->bidi_it.string.from_disp_str = true;
5152 it->bidi_it.string.unibyte = !it->multibyte_p;
5153 it->bidi_it.w = it->w;
5154 bidi_init_it (0, 0, FRAME_WINDOW_P (it->f), &it->bidi_it);
5155 }
5156 }
5157 else if (CONSP (value) && EQ (XCAR (value), Qspace))
5158 {
5159 it->method = GET_FROM_STRETCH;
5160 it->object = value;
5161 *position = it->position = start_pos;
5162 retval = 1 + (it->area == TEXT_AREA);
5163 }
5164 #ifdef HAVE_WINDOW_SYSTEM
5165 else
5166 {
5167 it->what = IT_IMAGE;
5168 it->image_id = lookup_image (it->f, value);
5169 it->position = start_pos;
5170 it->object = NILP (object) ? it->w->contents : object;
5171 it->method = GET_FROM_IMAGE;
5172
5173 /* Say that we haven't consumed the characters with
5174 `display' property yet. The call to pop_it in
5175 set_iterator_to_next will clean this up. */
5176 *position = start_pos;
5177 }
5178 #endif /* HAVE_WINDOW_SYSTEM */
5179
5180 return retval;
5181 }
5182
5183 /* Invalid property or property not supported. Restore
5184 POSITION to what it was before. */
5185 *position = start_pos;
5186 return 0;
5187 }
5188
5189 /* Check if PROP is a display property value whose text should be
5190 treated as intangible. OVERLAY is the overlay from which PROP
5191 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5192 specify the buffer position covered by PROP. */
5193
5194 bool
5195 display_prop_intangible_p (Lisp_Object prop, Lisp_Object overlay,
5196 ptrdiff_t charpos, ptrdiff_t bytepos)
5197 {
5198 bool frame_window_p = FRAME_WINDOW_P (XFRAME (selected_frame));
5199 struct text_pos position;
5200
5201 SET_TEXT_POS (position, charpos, bytepos);
5202 return (handle_display_spec (NULL, prop, Qnil, overlay,
5203 &position, charpos, frame_window_p)
5204 != 0);
5205 }
5206
5207
5208 /* Return true if PROP is a display sub-property value containing STRING.
5209
5210 Implementation note: this and the following function are really
5211 special cases of handle_display_spec and
5212 handle_single_display_spec, and should ideally use the same code.
5213 Until they do, these two pairs must be consistent and must be
5214 modified in sync. */
5215
5216 static bool
5217 single_display_spec_string_p (Lisp_Object prop, Lisp_Object string)
5218 {
5219 if (EQ (string, prop))
5220 return true;
5221
5222 /* Skip over `when FORM'. */
5223 if (CONSP (prop) && EQ (XCAR (prop), Qwhen))
5224 {
5225 prop = XCDR (prop);
5226 if (!CONSP (prop))
5227 return false;
5228 /* Actually, the condition following `when' should be eval'ed,
5229 like handle_single_display_spec does, and we should return
5230 false if it evaluates to nil. However, this function is
5231 called only when the buffer was already displayed and some
5232 glyph in the glyph matrix was found to come from a display
5233 string. Therefore, the condition was already evaluated, and
5234 the result was non-nil, otherwise the display string wouldn't
5235 have been displayed and we would have never been called for
5236 this property. Thus, we can skip the evaluation and assume
5237 its result is non-nil. */
5238 prop = XCDR (prop);
5239 }
5240
5241 if (CONSP (prop))
5242 /* Skip over `margin LOCATION'. */
5243 if (EQ (XCAR (prop), Qmargin))
5244 {
5245 prop = XCDR (prop);
5246 if (!CONSP (prop))
5247 return false;
5248
5249 prop = XCDR (prop);
5250 if (!CONSP (prop))
5251 return false;
5252 }
5253
5254 return EQ (prop, string) || (CONSP (prop) && EQ (XCAR (prop), string));
5255 }
5256
5257
5258 /* Return true if STRING appears in the `display' property PROP. */
5259
5260 static bool
5261 display_prop_string_p (Lisp_Object prop, Lisp_Object string)
5262 {
5263 if (CONSP (prop)
5264 && !EQ (XCAR (prop), Qwhen)
5265 && !(CONSP (XCAR (prop)) && EQ (Qmargin, XCAR (XCAR (prop)))))
5266 {
5267 /* A list of sub-properties. */
5268 while (CONSP (prop))
5269 {
5270 if (single_display_spec_string_p (XCAR (prop), string))
5271 return true;
5272 prop = XCDR (prop);
5273 }
5274 }
5275 else if (VECTORP (prop))
5276 {
5277 /* A vector of sub-properties. */
5278 ptrdiff_t i;
5279 for (i = 0; i < ASIZE (prop); ++i)
5280 if (single_display_spec_string_p (AREF (prop, i), string))
5281 return true;
5282 }
5283 else
5284 return single_display_spec_string_p (prop, string);
5285
5286 return false;
5287 }
5288
5289 /* Look for STRING in overlays and text properties in the current
5290 buffer, between character positions FROM and TO (excluding TO).
5291 BACK_P means look back (in this case, TO is supposed to be
5292 less than FROM).
5293 Value is the first character position where STRING was found, or
5294 zero if it wasn't found before hitting TO.
5295
5296 This function may only use code that doesn't eval because it is
5297 called asynchronously from note_mouse_highlight. */
5298
5299 static ptrdiff_t
5300 string_buffer_position_lim (Lisp_Object string,
5301 ptrdiff_t from, ptrdiff_t to, bool back_p)
5302 {
5303 Lisp_Object limit, prop, pos;
5304 bool found = false;
5305
5306 pos = make_number (max (from, BEGV));
5307
5308 if (!back_p) /* looking forward */
5309 {
5310 limit = make_number (min (to, ZV));
5311 while (!found && !EQ (pos, limit))
5312 {
5313 prop = Fget_char_property (pos, Qdisplay, Qnil);
5314 if (!NILP (prop) && display_prop_string_p (prop, string))
5315 found = true;
5316 else
5317 pos = Fnext_single_char_property_change (pos, Qdisplay, Qnil,
5318 limit);
5319 }
5320 }
5321 else /* looking back */
5322 {
5323 limit = make_number (max (to, BEGV));
5324 while (!found && !EQ (pos, limit))
5325 {
5326 prop = Fget_char_property (pos, Qdisplay, Qnil);
5327 if (!NILP (prop) && display_prop_string_p (prop, string))
5328 found = true;
5329 else
5330 pos = Fprevious_single_char_property_change (pos, Qdisplay, Qnil,
5331 limit);
5332 }
5333 }
5334
5335 return found ? XINT (pos) : 0;
5336 }
5337
5338 /* Determine which buffer position in current buffer STRING comes from.
5339 AROUND_CHARPOS is an approximate position where it could come from.
5340 Value is the buffer position or 0 if it couldn't be determined.
5341
5342 This function is necessary because we don't record buffer positions
5343 in glyphs generated from strings (to keep struct glyph small).
5344 This function may only use code that doesn't eval because it is
5345 called asynchronously from note_mouse_highlight. */
5346
5347 static ptrdiff_t
5348 string_buffer_position (Lisp_Object string, ptrdiff_t around_charpos)
5349 {
5350 const int MAX_DISTANCE = 1000;
5351 ptrdiff_t found = string_buffer_position_lim (string, around_charpos,
5352 around_charpos + MAX_DISTANCE,
5353 false);
5354
5355 if (!found)
5356 found = string_buffer_position_lim (string, around_charpos,
5357 around_charpos - MAX_DISTANCE, true);
5358 return found;
5359 }
5360
5361
5362 \f
5363 /***********************************************************************
5364 `composition' property
5365 ***********************************************************************/
5366
5367 /* Set up iterator IT from `composition' property at its current
5368 position. Called from handle_stop. */
5369
5370 static enum prop_handled
5371 handle_composition_prop (struct it *it)
5372 {
5373 Lisp_Object prop, string;
5374 ptrdiff_t pos, pos_byte, start, end;
5375
5376 if (STRINGP (it->string))
5377 {
5378 unsigned char *s;
5379
5380 pos = IT_STRING_CHARPOS (*it);
5381 pos_byte = IT_STRING_BYTEPOS (*it);
5382 string = it->string;
5383 s = SDATA (string) + pos_byte;
5384 it->c = STRING_CHAR (s);
5385 }
5386 else
5387 {
5388 pos = IT_CHARPOS (*it);
5389 pos_byte = IT_BYTEPOS (*it);
5390 string = Qnil;
5391 it->c = FETCH_CHAR (pos_byte);
5392 }
5393
5394 /* If there's a valid composition and point is not inside of the
5395 composition (in the case that the composition is from the current
5396 buffer), draw a glyph composed from the composition components. */
5397 if (find_composition (pos, -1, &start, &end, &prop, string)
5398 && composition_valid_p (start, end, prop)
5399 && (STRINGP (it->string) || (PT <= start || PT >= end)))
5400 {
5401 if (start < pos)
5402 /* As we can't handle this situation (perhaps font-lock added
5403 a new composition), we just return here hoping that next
5404 redisplay will detect this composition much earlier. */
5405 return HANDLED_NORMALLY;
5406 if (start != pos)
5407 {
5408 if (STRINGP (it->string))
5409 pos_byte = string_char_to_byte (it->string, start);
5410 else
5411 pos_byte = CHAR_TO_BYTE (start);
5412 }
5413 it->cmp_it.id = get_composition_id (start, pos_byte, end - start,
5414 prop, string);
5415
5416 if (it->cmp_it.id >= 0)
5417 {
5418 it->cmp_it.ch = -1;
5419 it->cmp_it.nchars = COMPOSITION_LENGTH (prop);
5420 it->cmp_it.nglyphs = -1;
5421 }
5422 }
5423
5424 return HANDLED_NORMALLY;
5425 }
5426
5427
5428 \f
5429 /***********************************************************************
5430 Overlay strings
5431 ***********************************************************************/
5432
5433 /* The following structure is used to record overlay strings for
5434 later sorting in load_overlay_strings. */
5435
5436 struct overlay_entry
5437 {
5438 Lisp_Object overlay;
5439 Lisp_Object string;
5440 EMACS_INT priority;
5441 bool after_string_p;
5442 };
5443
5444
5445 /* Set up iterator IT from overlay strings at its current position.
5446 Called from handle_stop. */
5447
5448 static enum prop_handled
5449 handle_overlay_change (struct it *it)
5450 {
5451 if (!STRINGP (it->string) && get_overlay_strings (it, 0))
5452 return HANDLED_RECOMPUTE_PROPS;
5453 else
5454 return HANDLED_NORMALLY;
5455 }
5456
5457
5458 /* Set up the next overlay string for delivery by IT, if there is an
5459 overlay string to deliver. Called by set_iterator_to_next when the
5460 end of the current overlay string is reached. If there are more
5461 overlay strings to display, IT->string and
5462 IT->current.overlay_string_index are set appropriately here.
5463 Otherwise IT->string is set to nil. */
5464
5465 static void
5466 next_overlay_string (struct it *it)
5467 {
5468 ++it->current.overlay_string_index;
5469 if (it->current.overlay_string_index == it->n_overlay_strings)
5470 {
5471 /* No more overlay strings. Restore IT's settings to what
5472 they were before overlay strings were processed, and
5473 continue to deliver from current_buffer. */
5474
5475 it->ellipsis_p = it->stack[it->sp - 1].display_ellipsis_p;
5476 pop_it (it);
5477 eassert (it->sp > 0
5478 || (NILP (it->string)
5479 && it->method == GET_FROM_BUFFER
5480 && it->stop_charpos >= BEGV
5481 && it->stop_charpos <= it->end_charpos));
5482 it->current.overlay_string_index = -1;
5483 it->n_overlay_strings = 0;
5484 /* If there's an empty display string on the stack, pop the
5485 stack, to resync the bidi iterator with IT's position. Such
5486 empty strings are pushed onto the stack in
5487 get_overlay_strings_1. */
5488 if (it->sp > 0 && STRINGP (it->string) && !SCHARS (it->string))
5489 pop_it (it);
5490
5491 /* Since we've exhausted overlay strings at this buffer
5492 position, set the flag to ignore overlays until we move to
5493 another position. The flag is reset in
5494 next_element_from_buffer. */
5495 it->ignore_overlay_strings_at_pos_p = true;
5496
5497 /* If we're at the end of the buffer, record that we have
5498 processed the overlay strings there already, so that
5499 next_element_from_buffer doesn't try it again. */
5500 if (NILP (it->string)
5501 && IT_CHARPOS (*it) >= it->end_charpos
5502 && it->overlay_strings_charpos >= it->end_charpos)
5503 it->overlay_strings_at_end_processed_p = true;
5504 /* Note: we reset overlay_strings_charpos only here, to make
5505 sure the just-processed overlays were indeed at EOB.
5506 Otherwise, overlays on text with invisible text property,
5507 which are processed with IT's position past the invisible
5508 text, might fool us into thinking the overlays at EOB were
5509 already processed (linum-mode can cause this, for
5510 example). */
5511 it->overlay_strings_charpos = -1;
5512 }
5513 else
5514 {
5515 /* There are more overlay strings to process. If
5516 IT->current.overlay_string_index has advanced to a position
5517 where we must load IT->overlay_strings with more strings, do
5518 it. We must load at the IT->overlay_strings_charpos where
5519 IT->n_overlay_strings was originally computed; when invisible
5520 text is present, this might not be IT_CHARPOS (Bug#7016). */
5521 int i = it->current.overlay_string_index % OVERLAY_STRING_CHUNK_SIZE;
5522
5523 if (it->current.overlay_string_index && i == 0)
5524 load_overlay_strings (it, it->overlay_strings_charpos);
5525
5526 /* Initialize IT to deliver display elements from the overlay
5527 string. */
5528 it->string = it->overlay_strings[i];
5529 it->multibyte_p = STRING_MULTIBYTE (it->string);
5530 SET_TEXT_POS (it->current.string_pos, 0, 0);
5531 it->method = GET_FROM_STRING;
5532 it->stop_charpos = 0;
5533 it->end_charpos = SCHARS (it->string);
5534 if (it->cmp_it.stop_pos >= 0)
5535 it->cmp_it.stop_pos = 0;
5536 it->prev_stop = 0;
5537 it->base_level_stop = 0;
5538
5539 /* Set up the bidi iterator for this overlay string. */
5540 if (it->bidi_p)
5541 {
5542 it->bidi_it.string.lstring = it->string;
5543 it->bidi_it.string.s = NULL;
5544 it->bidi_it.string.schars = SCHARS (it->string);
5545 it->bidi_it.string.bufpos = it->overlay_strings_charpos;
5546 it->bidi_it.string.from_disp_str = it->string_from_display_prop_p;
5547 it->bidi_it.string.unibyte = !it->multibyte_p;
5548 it->bidi_it.w = it->w;
5549 bidi_init_it (0, 0, FRAME_WINDOW_P (it->f), &it->bidi_it);
5550 }
5551 }
5552
5553 CHECK_IT (it);
5554 }
5555
5556
5557 /* Compare two overlay_entry structures E1 and E2. Used as a
5558 comparison function for qsort in load_overlay_strings. Overlay
5559 strings for the same position are sorted so that
5560
5561 1. All after-strings come in front of before-strings, except
5562 when they come from the same overlay.
5563
5564 2. Within after-strings, strings are sorted so that overlay strings
5565 from overlays with higher priorities come first.
5566
5567 2. Within before-strings, strings are sorted so that overlay
5568 strings from overlays with higher priorities come last.
5569
5570 Value is analogous to strcmp. */
5571
5572
5573 static int
5574 compare_overlay_entries (const void *e1, const void *e2)
5575 {
5576 struct overlay_entry const *entry1 = e1;
5577 struct overlay_entry const *entry2 = e2;
5578 int result;
5579
5580 if (entry1->after_string_p != entry2->after_string_p)
5581 {
5582 /* Let after-strings appear in front of before-strings if
5583 they come from different overlays. */
5584 if (EQ (entry1->overlay, entry2->overlay))
5585 result = entry1->after_string_p ? 1 : -1;
5586 else
5587 result = entry1->after_string_p ? -1 : 1;
5588 }
5589 else if (entry1->priority != entry2->priority)
5590 {
5591 if (entry1->after_string_p)
5592 /* After-strings sorted in order of decreasing priority. */
5593 result = entry2->priority < entry1->priority ? -1 : 1;
5594 else
5595 /* Before-strings sorted in order of increasing priority. */
5596 result = entry1->priority < entry2->priority ? -1 : 1;
5597 }
5598 else
5599 result = 0;
5600
5601 return result;
5602 }
5603
5604
5605 /* Load the vector IT->overlay_strings with overlay strings from IT's
5606 current buffer position, or from CHARPOS if that is > 0. Set
5607 IT->n_overlays to the total number of overlay strings found.
5608
5609 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5610 a time. On entry into load_overlay_strings,
5611 IT->current.overlay_string_index gives the number of overlay
5612 strings that have already been loaded by previous calls to this
5613 function.
5614
5615 IT->add_overlay_start contains an additional overlay start
5616 position to consider for taking overlay strings from, if non-zero.
5617 This position comes into play when the overlay has an `invisible'
5618 property, and both before and after-strings. When we've skipped to
5619 the end of the overlay, because of its `invisible' property, we
5620 nevertheless want its before-string to appear.
5621 IT->add_overlay_start will contain the overlay start position
5622 in this case.
5623
5624 Overlay strings are sorted so that after-string strings come in
5625 front of before-string strings. Within before and after-strings,
5626 strings are sorted by overlay priority. See also function
5627 compare_overlay_entries. */
5628
5629 static void
5630 load_overlay_strings (struct it *it, ptrdiff_t charpos)
5631 {
5632 Lisp_Object overlay, window, str, invisible;
5633 struct Lisp_Overlay *ov;
5634 ptrdiff_t start, end;
5635 ptrdiff_t n = 0, i, j;
5636 int invis;
5637 struct overlay_entry entriesbuf[20];
5638 ptrdiff_t size = ARRAYELTS (entriesbuf);
5639 struct overlay_entry *entries = entriesbuf;
5640 USE_SAFE_ALLOCA;
5641
5642 if (charpos <= 0)
5643 charpos = IT_CHARPOS (*it);
5644
5645 /* Append the overlay string STRING of overlay OVERLAY to vector
5646 `entries' which has size `size' and currently contains `n'
5647 elements. AFTER_P means STRING is an after-string of
5648 OVERLAY. */
5649 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5650 do \
5651 { \
5652 Lisp_Object priority; \
5653 \
5654 if (n == size) \
5655 { \
5656 struct overlay_entry *old = entries; \
5657 SAFE_NALLOCA (entries, 2, size); \
5658 memcpy (entries, old, size * sizeof *entries); \
5659 size *= 2; \
5660 } \
5661 \
5662 entries[n].string = (STRING); \
5663 entries[n].overlay = (OVERLAY); \
5664 priority = Foverlay_get ((OVERLAY), Qpriority); \
5665 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5666 entries[n].after_string_p = (AFTER_P); \
5667 ++n; \
5668 } \
5669 while (false)
5670
5671 /* Process overlay before the overlay center. */
5672 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
5673 {
5674 XSETMISC (overlay, ov);
5675 eassert (OVERLAYP (overlay));
5676 start = OVERLAY_POSITION (OVERLAY_START (overlay));
5677 end = OVERLAY_POSITION (OVERLAY_END (overlay));
5678
5679 if (end < charpos)
5680 break;
5681
5682 /* Skip this overlay if it doesn't start or end at IT's current
5683 position. */
5684 if (end != charpos && start != charpos)
5685 continue;
5686
5687 /* Skip this overlay if it doesn't apply to IT->w. */
5688 window = Foverlay_get (overlay, Qwindow);
5689 if (WINDOWP (window) && XWINDOW (window) != it->w)
5690 continue;
5691
5692 /* If the text ``under'' the overlay is invisible, both before-
5693 and after-strings from this overlay are visible; start and
5694 end position are indistinguishable. */
5695 invisible = Foverlay_get (overlay, Qinvisible);
5696 invis = TEXT_PROP_MEANS_INVISIBLE (invisible);
5697
5698 /* If overlay has a non-empty before-string, record it. */
5699 if ((start == charpos || (end == charpos && invis != 0))
5700 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str))
5701 && SCHARS (str))
5702 RECORD_OVERLAY_STRING (overlay, str, false);
5703
5704 /* If overlay has a non-empty after-string, record it. */
5705 if ((end == charpos || (start == charpos && invis != 0))
5706 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str))
5707 && SCHARS (str))
5708 RECORD_OVERLAY_STRING (overlay, str, true);
5709 }
5710
5711 /* Process overlays after the overlay center. */
5712 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
5713 {
5714 XSETMISC (overlay, ov);
5715 eassert (OVERLAYP (overlay));
5716 start = OVERLAY_POSITION (OVERLAY_START (overlay));
5717 end = OVERLAY_POSITION (OVERLAY_END (overlay));
5718
5719 if (start > charpos)
5720 break;
5721
5722 /* Skip this overlay if it doesn't start or end at IT's current
5723 position. */
5724 if (end != charpos && start != charpos)
5725 continue;
5726
5727 /* Skip this overlay if it doesn't apply to IT->w. */
5728 window = Foverlay_get (overlay, Qwindow);
5729 if (WINDOWP (window) && XWINDOW (window) != it->w)
5730 continue;
5731
5732 /* If the text ``under'' the overlay is invisible, it has a zero
5733 dimension, and both before- and after-strings apply. */
5734 invisible = Foverlay_get (overlay, Qinvisible);
5735 invis = TEXT_PROP_MEANS_INVISIBLE (invisible);
5736
5737 /* If overlay has a non-empty before-string, record it. */
5738 if ((start == charpos || (end == charpos && invis != 0))
5739 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str))
5740 && SCHARS (str))
5741 RECORD_OVERLAY_STRING (overlay, str, false);
5742
5743 /* If overlay has a non-empty after-string, record it. */
5744 if ((end == charpos || (start == charpos && invis != 0))
5745 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str))
5746 && SCHARS (str))
5747 RECORD_OVERLAY_STRING (overlay, str, true);
5748 }
5749
5750 #undef RECORD_OVERLAY_STRING
5751
5752 /* Sort entries. */
5753 if (n > 1)
5754 qsort (entries, n, sizeof *entries, compare_overlay_entries);
5755
5756 /* Record number of overlay strings, and where we computed it. */
5757 it->n_overlay_strings = n;
5758 it->overlay_strings_charpos = charpos;
5759
5760 /* IT->current.overlay_string_index is the number of overlay strings
5761 that have already been consumed by IT. Copy some of the
5762 remaining overlay strings to IT->overlay_strings. */
5763 i = 0;
5764 j = it->current.overlay_string_index;
5765 while (i < OVERLAY_STRING_CHUNK_SIZE && j < n)
5766 {
5767 it->overlay_strings[i] = entries[j].string;
5768 it->string_overlays[i++] = entries[j++].overlay;
5769 }
5770
5771 CHECK_IT (it);
5772 SAFE_FREE ();
5773 }
5774
5775
5776 /* Get the first chunk of overlay strings at IT's current buffer
5777 position, or at CHARPOS if that is > 0. Value is true if at
5778 least one overlay string was found. */
5779
5780 static bool
5781 get_overlay_strings_1 (struct it *it, ptrdiff_t charpos, bool compute_stop_p)
5782 {
5783 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5784 process. This fills IT->overlay_strings with strings, and sets
5785 IT->n_overlay_strings to the total number of strings to process.
5786 IT->pos.overlay_string_index has to be set temporarily to zero
5787 because load_overlay_strings needs this; it must be set to -1
5788 when no overlay strings are found because a zero value would
5789 indicate a position in the first overlay string. */
5790 it->current.overlay_string_index = 0;
5791 load_overlay_strings (it, charpos);
5792
5793 /* If we found overlay strings, set up IT to deliver display
5794 elements from the first one. Otherwise set up IT to deliver
5795 from current_buffer. */
5796 if (it->n_overlay_strings)
5797 {
5798 /* Make sure we know settings in current_buffer, so that we can
5799 restore meaningful values when we're done with the overlay
5800 strings. */
5801 if (compute_stop_p)
5802 compute_stop_pos (it);
5803 eassert (it->face_id >= 0);
5804
5805 /* Save IT's settings. They are restored after all overlay
5806 strings have been processed. */
5807 eassert (!compute_stop_p || it->sp == 0);
5808
5809 /* When called from handle_stop, there might be an empty display
5810 string loaded. In that case, don't bother saving it. But
5811 don't use this optimization with the bidi iterator, since we
5812 need the corresponding pop_it call to resync the bidi
5813 iterator's position with IT's position, after we are done
5814 with the overlay strings. (The corresponding call to pop_it
5815 in case of an empty display string is in
5816 next_overlay_string.) */
5817 if (!(!it->bidi_p
5818 && STRINGP (it->string) && !SCHARS (it->string)))
5819 push_it (it, NULL);
5820
5821 /* Set up IT to deliver display elements from the first overlay
5822 string. */
5823 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = 0;
5824 it->string = it->overlay_strings[0];
5825 it->from_overlay = Qnil;
5826 it->stop_charpos = 0;
5827 eassert (STRINGP (it->string));
5828 it->end_charpos = SCHARS (it->string);
5829 it->prev_stop = 0;
5830 it->base_level_stop = 0;
5831 it->multibyte_p = STRING_MULTIBYTE (it->string);
5832 it->method = GET_FROM_STRING;
5833 it->from_disp_prop_p = 0;
5834
5835 /* Force paragraph direction to be that of the parent
5836 buffer. */
5837 if (it->bidi_p && it->bidi_it.paragraph_dir == R2L)
5838 it->paragraph_embedding = it->bidi_it.paragraph_dir;
5839 else
5840 it->paragraph_embedding = L2R;
5841
5842 /* Set up the bidi iterator for this overlay string. */
5843 if (it->bidi_p)
5844 {
5845 ptrdiff_t pos = (charpos > 0 ? charpos : IT_CHARPOS (*it));
5846
5847 it->bidi_it.string.lstring = it->string;
5848 it->bidi_it.string.s = NULL;
5849 it->bidi_it.string.schars = SCHARS (it->string);
5850 it->bidi_it.string.bufpos = pos;
5851 it->bidi_it.string.from_disp_str = it->string_from_display_prop_p;
5852 it->bidi_it.string.unibyte = !it->multibyte_p;
5853 it->bidi_it.w = it->w;
5854 bidi_init_it (0, 0, FRAME_WINDOW_P (it->f), &it->bidi_it);
5855 }
5856 return true;
5857 }
5858
5859 it->current.overlay_string_index = -1;
5860 return false;
5861 }
5862
5863 static bool
5864 get_overlay_strings (struct it *it, ptrdiff_t charpos)
5865 {
5866 it->string = Qnil;
5867 it->method = GET_FROM_BUFFER;
5868
5869 get_overlay_strings_1 (it, charpos, true);
5870
5871 CHECK_IT (it);
5872
5873 /* Value is true if we found at least one overlay string. */
5874 return STRINGP (it->string);
5875 }
5876
5877
5878 \f
5879 /***********************************************************************
5880 Saving and restoring state
5881 ***********************************************************************/
5882
5883 /* Save current settings of IT on IT->stack. Called, for example,
5884 before setting up IT for an overlay string, to be able to restore
5885 IT's settings to what they were after the overlay string has been
5886 processed. If POSITION is non-NULL, it is the position to save on
5887 the stack instead of IT->position. */
5888
5889 static void
5890 push_it (struct it *it, struct text_pos *position)
5891 {
5892 struct iterator_stack_entry *p;
5893
5894 eassert (it->sp < IT_STACK_SIZE);
5895 p = it->stack + it->sp;
5896
5897 p->stop_charpos = it->stop_charpos;
5898 p->prev_stop = it->prev_stop;
5899 p->base_level_stop = it->base_level_stop;
5900 p->cmp_it = it->cmp_it;
5901 eassert (it->face_id >= 0);
5902 p->face_id = it->face_id;
5903 p->string = it->string;
5904 p->method = it->method;
5905 p->from_overlay = it->from_overlay;
5906 switch (p->method)
5907 {
5908 case GET_FROM_IMAGE:
5909 p->u.image.object = it->object;
5910 p->u.image.image_id = it->image_id;
5911 p->u.image.slice = it->slice;
5912 break;
5913 case GET_FROM_STRETCH:
5914 p->u.stretch.object = it->object;
5915 break;
5916 case GET_FROM_BUFFER:
5917 case GET_FROM_DISPLAY_VECTOR:
5918 case GET_FROM_STRING:
5919 case GET_FROM_C_STRING:
5920 break;
5921 default:
5922 emacs_abort ();
5923 }
5924 p->position = position ? *position : it->position;
5925 p->current = it->current;
5926 p->end_charpos = it->end_charpos;
5927 p->string_nchars = it->string_nchars;
5928 p->area = it->area;
5929 p->multibyte_p = it->multibyte_p;
5930 p->avoid_cursor_p = it->avoid_cursor_p;
5931 p->space_width = it->space_width;
5932 p->font_height = it->font_height;
5933 p->voffset = it->voffset;
5934 p->string_from_display_prop_p = it->string_from_display_prop_p;
5935 p->string_from_prefix_prop_p = it->string_from_prefix_prop_p;
5936 p->display_ellipsis_p = false;
5937 p->line_wrap = it->line_wrap;
5938 p->bidi_p = it->bidi_p;
5939 p->paragraph_embedding = it->paragraph_embedding;
5940 p->from_disp_prop_p = it->from_disp_prop_p;
5941 ++it->sp;
5942
5943 /* Save the state of the bidi iterator as well. */
5944 if (it->bidi_p)
5945 bidi_push_it (&it->bidi_it);
5946 }
5947
5948 static void
5949 iterate_out_of_display_property (struct it *it)
5950 {
5951 bool buffer_p = !STRINGP (it->string);
5952 ptrdiff_t eob = (buffer_p ? ZV : it->end_charpos);
5953 ptrdiff_t bob = (buffer_p ? BEGV : 0);
5954
5955 eassert (eob >= CHARPOS (it->position) && CHARPOS (it->position) >= bob);
5956
5957 /* Maybe initialize paragraph direction. If we are at the beginning
5958 of a new paragraph, next_element_from_buffer may not have a
5959 chance to do that. */
5960 if (it->bidi_it.first_elt && it->bidi_it.charpos < eob)
5961 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, true);
5962 /* prev_stop can be zero, so check against BEGV as well. */
5963 while (it->bidi_it.charpos >= bob
5964 && it->prev_stop <= it->bidi_it.charpos
5965 && it->bidi_it.charpos < CHARPOS (it->position)
5966 && it->bidi_it.charpos < eob)
5967 bidi_move_to_visually_next (&it->bidi_it);
5968 /* Record the stop_pos we just crossed, for when we cross it
5969 back, maybe. */
5970 if (it->bidi_it.charpos > CHARPOS (it->position))
5971 it->prev_stop = CHARPOS (it->position);
5972 /* If we ended up not where pop_it put us, resync IT's
5973 positional members with the bidi iterator. */
5974 if (it->bidi_it.charpos != CHARPOS (it->position))
5975 SET_TEXT_POS (it->position, it->bidi_it.charpos, it->bidi_it.bytepos);
5976 if (buffer_p)
5977 it->current.pos = it->position;
5978 else
5979 it->current.string_pos = it->position;
5980 }
5981
5982 /* Restore IT's settings from IT->stack. Called, for example, when no
5983 more overlay strings must be processed, and we return to delivering
5984 display elements from a buffer, or when the end of a string from a
5985 `display' property is reached and we return to delivering display
5986 elements from an overlay string, or from a buffer. */
5987
5988 static void
5989 pop_it (struct it *it)
5990 {
5991 struct iterator_stack_entry *p;
5992 bool from_display_prop = it->from_disp_prop_p;
5993 ptrdiff_t prev_pos = IT_CHARPOS (*it);
5994
5995 eassert (it->sp > 0);
5996 --it->sp;
5997 p = it->stack + it->sp;
5998 it->stop_charpos = p->stop_charpos;
5999 it->prev_stop = p->prev_stop;
6000 it->base_level_stop = p->base_level_stop;
6001 it->cmp_it = p->cmp_it;
6002 it->face_id = p->face_id;
6003 it->current = p->current;
6004 it->position = p->position;
6005 it->string = p->string;
6006 it->from_overlay = p->from_overlay;
6007 if (NILP (it->string))
6008 SET_TEXT_POS (it->current.string_pos, -1, -1);
6009 it->method = p->method;
6010 switch (it->method)
6011 {
6012 case GET_FROM_IMAGE:
6013 it->image_id = p->u.image.image_id;
6014 it->object = p->u.image.object;
6015 it->slice = p->u.image.slice;
6016 break;
6017 case GET_FROM_STRETCH:
6018 it->object = p->u.stretch.object;
6019 break;
6020 case GET_FROM_BUFFER:
6021 it->object = it->w->contents;
6022 break;
6023 case GET_FROM_STRING:
6024 {
6025 struct face *face = FACE_FROM_ID (it->f, it->face_id);
6026
6027 /* Restore the face_box_p flag, since it could have been
6028 overwritten by the face of the object that we just finished
6029 displaying. */
6030 if (face)
6031 it->face_box_p = face->box != FACE_NO_BOX;
6032 it->object = it->string;
6033 }
6034 break;
6035 case GET_FROM_DISPLAY_VECTOR:
6036 if (it->s)
6037 it->method = GET_FROM_C_STRING;
6038 else if (STRINGP (it->string))
6039 it->method = GET_FROM_STRING;
6040 else
6041 {
6042 it->method = GET_FROM_BUFFER;
6043 it->object = it->w->contents;
6044 }
6045 break;
6046 case GET_FROM_C_STRING:
6047 break;
6048 default:
6049 emacs_abort ();
6050 }
6051 it->end_charpos = p->end_charpos;
6052 it->string_nchars = p->string_nchars;
6053 it->area = p->area;
6054 it->multibyte_p = p->multibyte_p;
6055 it->avoid_cursor_p = p->avoid_cursor_p;
6056 it->space_width = p->space_width;
6057 it->font_height = p->font_height;
6058 it->voffset = p->voffset;
6059 it->string_from_display_prop_p = p->string_from_display_prop_p;
6060 it->string_from_prefix_prop_p = p->string_from_prefix_prop_p;
6061 it->line_wrap = p->line_wrap;
6062 it->bidi_p = p->bidi_p;
6063 it->paragraph_embedding = p->paragraph_embedding;
6064 it->from_disp_prop_p = p->from_disp_prop_p;
6065 if (it->bidi_p)
6066 {
6067 bidi_pop_it (&it->bidi_it);
6068 /* Bidi-iterate until we get out of the portion of text, if any,
6069 covered by a `display' text property or by an overlay with
6070 `display' property. (We cannot just jump there, because the
6071 internal coherency of the bidi iterator state can not be
6072 preserved across such jumps.) We also must determine the
6073 paragraph base direction if the overlay we just processed is
6074 at the beginning of a new paragraph. */
6075 if (from_display_prop
6076 && (it->method == GET_FROM_BUFFER || it->method == GET_FROM_STRING))
6077 iterate_out_of_display_property (it);
6078
6079 eassert ((BUFFERP (it->object)
6080 && IT_CHARPOS (*it) == it->bidi_it.charpos
6081 && IT_BYTEPOS (*it) == it->bidi_it.bytepos)
6082 || (STRINGP (it->object)
6083 && IT_STRING_CHARPOS (*it) == it->bidi_it.charpos
6084 && IT_STRING_BYTEPOS (*it) == it->bidi_it.bytepos)
6085 || (CONSP (it->object) && it->method == GET_FROM_STRETCH));
6086 }
6087 /* If we move the iterator over text covered by a display property
6088 to a new buffer position, any info about previously seen overlays
6089 is no longer valid. */
6090 if (from_display_prop && it->sp == 0 && CHARPOS (it->position) != prev_pos)
6091 it->ignore_overlay_strings_at_pos_p = false;
6092 }
6093
6094
6095 \f
6096 /***********************************************************************
6097 Moving over lines
6098 ***********************************************************************/
6099
6100 /* Set IT's current position to the previous line start. */
6101
6102 static void
6103 back_to_previous_line_start (struct it *it)
6104 {
6105 ptrdiff_t cp = IT_CHARPOS (*it), bp = IT_BYTEPOS (*it);
6106
6107 DEC_BOTH (cp, bp);
6108 IT_CHARPOS (*it) = find_newline_no_quit (cp, bp, -1, &IT_BYTEPOS (*it));
6109 }
6110
6111
6112 /* Move IT to the next line start.
6113
6114 Value is true if a newline was found. Set *SKIPPED_P to true if
6115 we skipped over part of the text (as opposed to moving the iterator
6116 continuously over the text). Otherwise, don't change the value
6117 of *SKIPPED_P.
6118
6119 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6120 iterator on the newline, if it was found.
6121
6122 Newlines may come from buffer text, overlay strings, or strings
6123 displayed via the `display' property. That's the reason we can't
6124 simply use find_newline_no_quit.
6125
6126 Note that this function may not skip over invisible text that is so
6127 because of text properties and immediately follows a newline. If
6128 it would, function reseat_at_next_visible_line_start, when called
6129 from set_iterator_to_next, would effectively make invisible
6130 characters following a newline part of the wrong glyph row, which
6131 leads to wrong cursor motion. */
6132
6133 static bool
6134 forward_to_next_line_start (struct it *it, bool *skipped_p,
6135 struct bidi_it *bidi_it_prev)
6136 {
6137 ptrdiff_t old_selective;
6138 bool newline_found_p = false;
6139 int n;
6140 const int MAX_NEWLINE_DISTANCE = 500;
6141
6142 /* If already on a newline, just consume it to avoid unintended
6143 skipping over invisible text below. */
6144 if (it->what == IT_CHARACTER
6145 && it->c == '\n'
6146 && CHARPOS (it->position) == IT_CHARPOS (*it))
6147 {
6148 if (it->bidi_p && bidi_it_prev)
6149 *bidi_it_prev = it->bidi_it;
6150 set_iterator_to_next (it, false);
6151 it->c = 0;
6152 return true;
6153 }
6154
6155 /* Don't handle selective display in the following. It's (a)
6156 unnecessary because it's done by the caller, and (b) leads to an
6157 infinite recursion because next_element_from_ellipsis indirectly
6158 calls this function. */
6159 old_selective = it->selective;
6160 it->selective = 0;
6161
6162 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6163 from buffer text. */
6164 for (n = 0;
6165 !newline_found_p && n < MAX_NEWLINE_DISTANCE;
6166 n += !STRINGP (it->string))
6167 {
6168 if (!get_next_display_element (it))
6169 return false;
6170 newline_found_p = it->what == IT_CHARACTER && it->c == '\n';
6171 if (newline_found_p && it->bidi_p && bidi_it_prev)
6172 *bidi_it_prev = it->bidi_it;
6173 set_iterator_to_next (it, false);
6174 }
6175
6176 /* If we didn't find a newline near enough, see if we can use a
6177 short-cut. */
6178 if (!newline_found_p)
6179 {
6180 ptrdiff_t bytepos, start = IT_CHARPOS (*it);
6181 ptrdiff_t limit = find_newline_no_quit (start, IT_BYTEPOS (*it),
6182 1, &bytepos);
6183 Lisp_Object pos;
6184
6185 eassert (!STRINGP (it->string));
6186
6187 /* If there isn't any `display' property in sight, and no
6188 overlays, we can just use the position of the newline in
6189 buffer text. */
6190 if (it->stop_charpos >= limit
6191 || ((pos = Fnext_single_property_change (make_number (start),
6192 Qdisplay, Qnil,
6193 make_number (limit)),
6194 NILP (pos))
6195 && next_overlay_change (start) == ZV))
6196 {
6197 if (!it->bidi_p)
6198 {
6199 IT_CHARPOS (*it) = limit;
6200 IT_BYTEPOS (*it) = bytepos;
6201 }
6202 else
6203 {
6204 struct bidi_it bprev;
6205
6206 /* Help bidi.c avoid expensive searches for display
6207 properties and overlays, by telling it that there are
6208 none up to `limit'. */
6209 if (it->bidi_it.disp_pos < limit)
6210 {
6211 it->bidi_it.disp_pos = limit;
6212 it->bidi_it.disp_prop = 0;
6213 }
6214 do {
6215 bprev = it->bidi_it;
6216 bidi_move_to_visually_next (&it->bidi_it);
6217 } while (it->bidi_it.charpos != limit);
6218 IT_CHARPOS (*it) = limit;
6219 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
6220 if (bidi_it_prev)
6221 *bidi_it_prev = bprev;
6222 }
6223 *skipped_p = newline_found_p = true;
6224 }
6225 else
6226 {
6227 while (get_next_display_element (it)
6228 && !newline_found_p)
6229 {
6230 newline_found_p = ITERATOR_AT_END_OF_LINE_P (it);
6231 if (newline_found_p && it->bidi_p && bidi_it_prev)
6232 *bidi_it_prev = it->bidi_it;
6233 set_iterator_to_next (it, false);
6234 }
6235 }
6236 }
6237
6238 it->selective = old_selective;
6239 return newline_found_p;
6240 }
6241
6242
6243 /* Set IT's current position to the previous visible line start. Skip
6244 invisible text that is so either due to text properties or due to
6245 selective display. Caution: this does not change IT->current_x and
6246 IT->hpos. */
6247
6248 static void
6249 back_to_previous_visible_line_start (struct it *it)
6250 {
6251 while (IT_CHARPOS (*it) > BEGV)
6252 {
6253 back_to_previous_line_start (it);
6254
6255 if (IT_CHARPOS (*it) <= BEGV)
6256 break;
6257
6258 /* If selective > 0, then lines indented more than its value are
6259 invisible. */
6260 if (it->selective > 0
6261 && indented_beyond_p (IT_CHARPOS (*it), IT_BYTEPOS (*it),
6262 it->selective))
6263 continue;
6264
6265 /* Check the newline before point for invisibility. */
6266 {
6267 Lisp_Object prop;
6268 prop = Fget_char_property (make_number (IT_CHARPOS (*it) - 1),
6269 Qinvisible, it->window);
6270 if (TEXT_PROP_MEANS_INVISIBLE (prop) != 0)
6271 continue;
6272 }
6273
6274 if (IT_CHARPOS (*it) <= BEGV)
6275 break;
6276
6277 {
6278 struct it it2;
6279 void *it2data = NULL;
6280 ptrdiff_t pos;
6281 ptrdiff_t beg, end;
6282 Lisp_Object val, overlay;
6283
6284 SAVE_IT (it2, *it, it2data);
6285
6286 /* If newline is part of a composition, continue from start of composition */
6287 if (find_composition (IT_CHARPOS (*it), -1, &beg, &end, &val, Qnil)
6288 && beg < IT_CHARPOS (*it))
6289 goto replaced;
6290
6291 /* If newline is replaced by a display property, find start of overlay
6292 or interval and continue search from that point. */
6293 pos = --IT_CHARPOS (it2);
6294 --IT_BYTEPOS (it2);
6295 it2.sp = 0;
6296 bidi_unshelve_cache (NULL, false);
6297 it2.string_from_display_prop_p = false;
6298 it2.from_disp_prop_p = false;
6299 if (handle_display_prop (&it2) == HANDLED_RETURN
6300 && !NILP (val = get_char_property_and_overlay
6301 (make_number (pos), Qdisplay, Qnil, &overlay))
6302 && (OVERLAYP (overlay)
6303 ? (beg = OVERLAY_POSITION (OVERLAY_START (overlay)))
6304 : get_property_and_range (pos, Qdisplay, &val, &beg, &end, Qnil)))
6305 {
6306 RESTORE_IT (it, it, it2data);
6307 goto replaced;
6308 }
6309
6310 /* Newline is not replaced by anything -- so we are done. */
6311 RESTORE_IT (it, it, it2data);
6312 break;
6313
6314 replaced:
6315 if (beg < BEGV)
6316 beg = BEGV;
6317 IT_CHARPOS (*it) = beg;
6318 IT_BYTEPOS (*it) = buf_charpos_to_bytepos (current_buffer, beg);
6319 }
6320 }
6321
6322 it->continuation_lines_width = 0;
6323
6324 eassert (IT_CHARPOS (*it) >= BEGV);
6325 eassert (IT_CHARPOS (*it) == BEGV
6326 || FETCH_BYTE (IT_BYTEPOS (*it) - 1) == '\n');
6327 CHECK_IT (it);
6328 }
6329
6330
6331 /* Reseat iterator IT at the previous visible line start. Skip
6332 invisible text that is so either due to text properties or due to
6333 selective display. At the end, update IT's overlay information,
6334 face information etc. */
6335
6336 void
6337 reseat_at_previous_visible_line_start (struct it *it)
6338 {
6339 back_to_previous_visible_line_start (it);
6340 reseat (it, it->current.pos, true);
6341 CHECK_IT (it);
6342 }
6343
6344
6345 /* Reseat iterator IT on the next visible line start in the current
6346 buffer. ON_NEWLINE_P means position IT on the newline
6347 preceding the line start. Skip over invisible text that is so
6348 because of selective display. Compute faces, overlays etc at the
6349 new position. Note that this function does not skip over text that
6350 is invisible because of text properties. */
6351
6352 static void
6353 reseat_at_next_visible_line_start (struct it *it, bool on_newline_p)
6354 {
6355 bool skipped_p = false;
6356 struct bidi_it bidi_it_prev;
6357 bool newline_found_p
6358 = forward_to_next_line_start (it, &skipped_p, &bidi_it_prev);
6359
6360 /* Skip over lines that are invisible because they are indented
6361 more than the value of IT->selective. */
6362 if (it->selective > 0)
6363 while (IT_CHARPOS (*it) < ZV
6364 && indented_beyond_p (IT_CHARPOS (*it), IT_BYTEPOS (*it),
6365 it->selective))
6366 {
6367 eassert (IT_BYTEPOS (*it) == BEGV
6368 || FETCH_BYTE (IT_BYTEPOS (*it) - 1) == '\n');
6369 newline_found_p =
6370 forward_to_next_line_start (it, &skipped_p, &bidi_it_prev);
6371 }
6372
6373 /* Position on the newline if that's what's requested. */
6374 if (on_newline_p && newline_found_p)
6375 {
6376 if (STRINGP (it->string))
6377 {
6378 if (IT_STRING_CHARPOS (*it) > 0)
6379 {
6380 if (!it->bidi_p)
6381 {
6382 --IT_STRING_CHARPOS (*it);
6383 --IT_STRING_BYTEPOS (*it);
6384 }
6385 else
6386 {
6387 /* We need to restore the bidi iterator to the state
6388 it had on the newline, and resync the IT's
6389 position with that. */
6390 it->bidi_it = bidi_it_prev;
6391 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
6392 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
6393 }
6394 }
6395 }
6396 else if (IT_CHARPOS (*it) > BEGV)
6397 {
6398 if (!it->bidi_p)
6399 {
6400 --IT_CHARPOS (*it);
6401 --IT_BYTEPOS (*it);
6402 }
6403 else
6404 {
6405 /* We need to restore the bidi iterator to the state it
6406 had on the newline and resync IT with that. */
6407 it->bidi_it = bidi_it_prev;
6408 IT_CHARPOS (*it) = it->bidi_it.charpos;
6409 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
6410 }
6411 reseat (it, it->current.pos, false);
6412 }
6413 }
6414 else if (skipped_p)
6415 reseat (it, it->current.pos, false);
6416
6417 CHECK_IT (it);
6418 }
6419
6420
6421 \f
6422 /***********************************************************************
6423 Changing an iterator's position
6424 ***********************************************************************/
6425
6426 /* Change IT's current position to POS in current_buffer.
6427 If FORCE_P, always check for text properties at the new position.
6428 Otherwise, text properties are only looked up if POS >=
6429 IT->check_charpos of a property. */
6430
6431 static void
6432 reseat (struct it *it, struct text_pos pos, bool force_p)
6433 {
6434 ptrdiff_t original_pos = IT_CHARPOS (*it);
6435
6436 reseat_1 (it, pos, false);
6437
6438 /* Determine where to check text properties. Avoid doing it
6439 where possible because text property lookup is very expensive. */
6440 if (force_p
6441 || CHARPOS (pos) > it->stop_charpos
6442 || CHARPOS (pos) < original_pos)
6443 {
6444 if (it->bidi_p)
6445 {
6446 /* For bidi iteration, we need to prime prev_stop and
6447 base_level_stop with our best estimations. */
6448 /* Implementation note: Of course, POS is not necessarily a
6449 stop position, so assigning prev_pos to it is a lie; we
6450 should have called compute_stop_backwards. However, if
6451 the current buffer does not include any R2L characters,
6452 that call would be a waste of cycles, because the
6453 iterator will never move back, and thus never cross this
6454 "fake" stop position. So we delay that backward search
6455 until the time we really need it, in next_element_from_buffer. */
6456 if (CHARPOS (pos) != it->prev_stop)
6457 it->prev_stop = CHARPOS (pos);
6458 if (CHARPOS (pos) < it->base_level_stop)
6459 it->base_level_stop = 0; /* meaning it's unknown */
6460 handle_stop (it);
6461 }
6462 else
6463 {
6464 handle_stop (it);
6465 it->prev_stop = it->base_level_stop = 0;
6466 }
6467
6468 }
6469
6470 CHECK_IT (it);
6471 }
6472
6473
6474 /* Change IT's buffer position to POS. SET_STOP_P means set
6475 IT->stop_pos to POS, also. */
6476
6477 static void
6478 reseat_1 (struct it *it, struct text_pos pos, bool set_stop_p)
6479 {
6480 /* Don't call this function when scanning a C string. */
6481 eassert (it->s == NULL);
6482
6483 /* POS must be a reasonable value. */
6484 eassert (CHARPOS (pos) >= BEGV && CHARPOS (pos) <= ZV);
6485
6486 it->current.pos = it->position = pos;
6487 it->end_charpos = ZV;
6488 it->dpvec = NULL;
6489 it->current.dpvec_index = -1;
6490 it->current.overlay_string_index = -1;
6491 IT_STRING_CHARPOS (*it) = -1;
6492 IT_STRING_BYTEPOS (*it) = -1;
6493 it->string = Qnil;
6494 it->method = GET_FROM_BUFFER;
6495 it->object = it->w->contents;
6496 it->area = TEXT_AREA;
6497 it->multibyte_p = !NILP (BVAR (current_buffer, enable_multibyte_characters));
6498 it->sp = 0;
6499 it->string_from_display_prop_p = false;
6500 it->string_from_prefix_prop_p = false;
6501
6502 it->from_disp_prop_p = false;
6503 it->face_before_selective_p = false;
6504 if (it->bidi_p)
6505 {
6506 bidi_init_it (IT_CHARPOS (*it), IT_BYTEPOS (*it), FRAME_WINDOW_P (it->f),
6507 &it->bidi_it);
6508 bidi_unshelve_cache (NULL, false);
6509 it->bidi_it.paragraph_dir = NEUTRAL_DIR;
6510 it->bidi_it.string.s = NULL;
6511 it->bidi_it.string.lstring = Qnil;
6512 it->bidi_it.string.bufpos = 0;
6513 it->bidi_it.string.from_disp_str = false;
6514 it->bidi_it.string.unibyte = false;
6515 it->bidi_it.w = it->w;
6516 }
6517
6518 if (set_stop_p)
6519 {
6520 it->stop_charpos = CHARPOS (pos);
6521 it->base_level_stop = CHARPOS (pos);
6522 }
6523 /* This make the information stored in it->cmp_it invalidate. */
6524 it->cmp_it.id = -1;
6525 }
6526
6527
6528 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6529 If S is non-null, it is a C string to iterate over. Otherwise,
6530 STRING gives a Lisp string to iterate over.
6531
6532 If PRECISION > 0, don't return more then PRECISION number of
6533 characters from the string.
6534
6535 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6536 characters have been returned. FIELD_WIDTH < 0 means an infinite
6537 field width.
6538
6539 MULTIBYTE = 0 means disable processing of multibyte characters,
6540 MULTIBYTE > 0 means enable it,
6541 MULTIBYTE < 0 means use IT->multibyte_p.
6542
6543 IT must be initialized via a prior call to init_iterator before
6544 calling this function. */
6545
6546 static void
6547 reseat_to_string (struct it *it, const char *s, Lisp_Object string,
6548 ptrdiff_t charpos, ptrdiff_t precision, int field_width,
6549 int multibyte)
6550 {
6551 /* No text property checks performed by default, but see below. */
6552 it->stop_charpos = -1;
6553
6554 /* Set iterator position and end position. */
6555 memset (&it->current, 0, sizeof it->current);
6556 it->current.overlay_string_index = -1;
6557 it->current.dpvec_index = -1;
6558 eassert (charpos >= 0);
6559
6560 /* If STRING is specified, use its multibyteness, otherwise use the
6561 setting of MULTIBYTE, if specified. */
6562 if (multibyte >= 0)
6563 it->multibyte_p = multibyte > 0;
6564
6565 /* Bidirectional reordering of strings is controlled by the default
6566 value of bidi-display-reordering. Don't try to reorder while
6567 loading loadup.el, as the necessary character property tables are
6568 not yet available. */
6569 it->bidi_p =
6570 NILP (Vpurify_flag)
6571 && !NILP (BVAR (&buffer_defaults, bidi_display_reordering));
6572
6573 if (s == NULL)
6574 {
6575 eassert (STRINGP (string));
6576 it->string = string;
6577 it->s = NULL;
6578 it->end_charpos = it->string_nchars = SCHARS (string);
6579 it->method = GET_FROM_STRING;
6580 it->current.string_pos = string_pos (charpos, string);
6581
6582 if (it->bidi_p)
6583 {
6584 it->bidi_it.string.lstring = string;
6585 it->bidi_it.string.s = NULL;
6586 it->bidi_it.string.schars = it->end_charpos;
6587 it->bidi_it.string.bufpos = 0;
6588 it->bidi_it.string.from_disp_str = false;
6589 it->bidi_it.string.unibyte = !it->multibyte_p;
6590 it->bidi_it.w = it->w;
6591 bidi_init_it (charpos, IT_STRING_BYTEPOS (*it),
6592 FRAME_WINDOW_P (it->f), &it->bidi_it);
6593 }
6594 }
6595 else
6596 {
6597 it->s = (const unsigned char *) s;
6598 it->string = Qnil;
6599
6600 /* Note that we use IT->current.pos, not it->current.string_pos,
6601 for displaying C strings. */
6602 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = -1;
6603 if (it->multibyte_p)
6604 {
6605 it->current.pos = c_string_pos (charpos, s, true);
6606 it->end_charpos = it->string_nchars = number_of_chars (s, true);
6607 }
6608 else
6609 {
6610 IT_CHARPOS (*it) = IT_BYTEPOS (*it) = charpos;
6611 it->end_charpos = it->string_nchars = strlen (s);
6612 }
6613
6614 if (it->bidi_p)
6615 {
6616 it->bidi_it.string.lstring = Qnil;
6617 it->bidi_it.string.s = (const unsigned char *) s;
6618 it->bidi_it.string.schars = it->end_charpos;
6619 it->bidi_it.string.bufpos = 0;
6620 it->bidi_it.string.from_disp_str = false;
6621 it->bidi_it.string.unibyte = !it->multibyte_p;
6622 it->bidi_it.w = it->w;
6623 bidi_init_it (charpos, IT_BYTEPOS (*it), FRAME_WINDOW_P (it->f),
6624 &it->bidi_it);
6625 }
6626 it->method = GET_FROM_C_STRING;
6627 }
6628
6629 /* PRECISION > 0 means don't return more than PRECISION characters
6630 from the string. */
6631 if (precision > 0 && it->end_charpos - charpos > precision)
6632 {
6633 it->end_charpos = it->string_nchars = charpos + precision;
6634 if (it->bidi_p)
6635 it->bidi_it.string.schars = it->end_charpos;
6636 }
6637
6638 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6639 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6640 FIELD_WIDTH < 0 means infinite field width. This is useful for
6641 padding with `-' at the end of a mode line. */
6642 if (field_width < 0)
6643 field_width = INFINITY;
6644 /* Implementation note: We deliberately don't enlarge
6645 it->bidi_it.string.schars here to fit it->end_charpos, because
6646 the bidi iterator cannot produce characters out of thin air. */
6647 if (field_width > it->end_charpos - charpos)
6648 it->end_charpos = charpos + field_width;
6649
6650 /* Use the standard display table for displaying strings. */
6651 if (DISP_TABLE_P (Vstandard_display_table))
6652 it->dp = XCHAR_TABLE (Vstandard_display_table);
6653
6654 it->stop_charpos = charpos;
6655 it->prev_stop = charpos;
6656 it->base_level_stop = 0;
6657 if (it->bidi_p)
6658 {
6659 it->bidi_it.first_elt = true;
6660 it->bidi_it.paragraph_dir = NEUTRAL_DIR;
6661 it->bidi_it.disp_pos = -1;
6662 }
6663 if (s == NULL && it->multibyte_p)
6664 {
6665 ptrdiff_t endpos = SCHARS (it->string);
6666 if (endpos > it->end_charpos)
6667 endpos = it->end_charpos;
6668 composition_compute_stop_pos (&it->cmp_it, charpos, -1, endpos,
6669 it->string);
6670 }
6671 CHECK_IT (it);
6672 }
6673
6674
6675 \f
6676 /***********************************************************************
6677 Iteration
6678 ***********************************************************************/
6679
6680 /* Map enum it_method value to corresponding next_element_from_* function. */
6681
6682 typedef bool (*next_element_function) (struct it *);
6683
6684 static next_element_function const get_next_element[NUM_IT_METHODS] =
6685 {
6686 next_element_from_buffer,
6687 next_element_from_display_vector,
6688 next_element_from_string,
6689 next_element_from_c_string,
6690 next_element_from_image,
6691 next_element_from_stretch
6692 };
6693
6694 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6695
6696
6697 /* Return true iff a character at CHARPOS (and BYTEPOS) is composed
6698 (possibly with the following characters). */
6699
6700 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6701 ((IT)->cmp_it.id >= 0 \
6702 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6703 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6704 END_CHARPOS, (IT)->w, \
6705 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6706 (IT)->string)))
6707
6708
6709 /* Lookup the char-table Vglyphless_char_display for character C (-1
6710 if we want information for no-font case), and return the display
6711 method symbol. By side-effect, update it->what and
6712 it->glyphless_method. This function is called from
6713 get_next_display_element for each character element, and from
6714 x_produce_glyphs when no suitable font was found. */
6715
6716 Lisp_Object
6717 lookup_glyphless_char_display (int c, struct it *it)
6718 {
6719 Lisp_Object glyphless_method = Qnil;
6720
6721 if (CHAR_TABLE_P (Vglyphless_char_display)
6722 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display)) >= 1)
6723 {
6724 if (c >= 0)
6725 {
6726 glyphless_method = CHAR_TABLE_REF (Vglyphless_char_display, c);
6727 if (CONSP (glyphless_method))
6728 glyphless_method = FRAME_WINDOW_P (it->f)
6729 ? XCAR (glyphless_method)
6730 : XCDR (glyphless_method);
6731 }
6732 else
6733 glyphless_method = XCHAR_TABLE (Vglyphless_char_display)->extras[0];
6734 }
6735
6736 retry:
6737 if (NILP (glyphless_method))
6738 {
6739 if (c >= 0)
6740 /* The default is to display the character by a proper font. */
6741 return Qnil;
6742 /* The default for the no-font case is to display an empty box. */
6743 glyphless_method = Qempty_box;
6744 }
6745 if (EQ (glyphless_method, Qzero_width))
6746 {
6747 if (c >= 0)
6748 return glyphless_method;
6749 /* This method can't be used for the no-font case. */
6750 glyphless_method = Qempty_box;
6751 }
6752 if (EQ (glyphless_method, Qthin_space))
6753 it->glyphless_method = GLYPHLESS_DISPLAY_THIN_SPACE;
6754 else if (EQ (glyphless_method, Qempty_box))
6755 it->glyphless_method = GLYPHLESS_DISPLAY_EMPTY_BOX;
6756 else if (EQ (glyphless_method, Qhex_code))
6757 it->glyphless_method = GLYPHLESS_DISPLAY_HEX_CODE;
6758 else if (STRINGP (glyphless_method))
6759 it->glyphless_method = GLYPHLESS_DISPLAY_ACRONYM;
6760 else
6761 {
6762 /* Invalid value. We use the default method. */
6763 glyphless_method = Qnil;
6764 goto retry;
6765 }
6766 it->what = IT_GLYPHLESS;
6767 return glyphless_method;
6768 }
6769
6770 /* Merge escape glyph face and cache the result. */
6771
6772 static struct frame *last_escape_glyph_frame = NULL;
6773 static int last_escape_glyph_face_id = (1 << FACE_ID_BITS);
6774 static int last_escape_glyph_merged_face_id = 0;
6775
6776 static int
6777 merge_escape_glyph_face (struct it *it)
6778 {
6779 int face_id;
6780
6781 if (it->f == last_escape_glyph_frame
6782 && it->face_id == last_escape_glyph_face_id)
6783 face_id = last_escape_glyph_merged_face_id;
6784 else
6785 {
6786 /* Merge the `escape-glyph' face into the current face. */
6787 face_id = merge_faces (it->f, Qescape_glyph, 0, it->face_id);
6788 last_escape_glyph_frame = it->f;
6789 last_escape_glyph_face_id = it->face_id;
6790 last_escape_glyph_merged_face_id = face_id;
6791 }
6792 return face_id;
6793 }
6794
6795 /* Likewise for glyphless glyph face. */
6796
6797 static struct frame *last_glyphless_glyph_frame = NULL;
6798 static int last_glyphless_glyph_face_id = (1 << FACE_ID_BITS);
6799 static int last_glyphless_glyph_merged_face_id = 0;
6800
6801 int
6802 merge_glyphless_glyph_face (struct it *it)
6803 {
6804 int face_id;
6805
6806 if (it->f == last_glyphless_glyph_frame
6807 && it->face_id == last_glyphless_glyph_face_id)
6808 face_id = last_glyphless_glyph_merged_face_id;
6809 else
6810 {
6811 /* Merge the `glyphless-char' face into the current face. */
6812 face_id = merge_faces (it->f, Qglyphless_char, 0, it->face_id);
6813 last_glyphless_glyph_frame = it->f;
6814 last_glyphless_glyph_face_id = it->face_id;
6815 last_glyphless_glyph_merged_face_id = face_id;
6816 }
6817 return face_id;
6818 }
6819
6820 /* Forget the `escape-glyph' and `glyphless-char' faces. This should
6821 be called before redisplaying windows, and when the frame's face
6822 cache is freed. */
6823 void
6824 forget_escape_and_glyphless_faces (void)
6825 {
6826 last_escape_glyph_frame = NULL;
6827 last_escape_glyph_face_id = (1 << FACE_ID_BITS);
6828 last_glyphless_glyph_frame = NULL;
6829 last_glyphless_glyph_face_id = (1 << FACE_ID_BITS);
6830 }
6831
6832 /* Load IT's display element fields with information about the next
6833 display element from the current position of IT. Value is false if
6834 end of buffer (or C string) is reached. */
6835
6836 static bool
6837 get_next_display_element (struct it *it)
6838 {
6839 /* True means that we found a display element. False means that
6840 we hit the end of what we iterate over. Performance note: the
6841 function pointer `method' used here turns out to be faster than
6842 using a sequence of if-statements. */
6843 bool success_p;
6844
6845 get_next:
6846 success_p = GET_NEXT_DISPLAY_ELEMENT (it);
6847
6848 if (it->what == IT_CHARACTER)
6849 {
6850 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6851 and only if (a) the resolved directionality of that character
6852 is R..." */
6853 /* FIXME: Do we need an exception for characters from display
6854 tables? */
6855 if (it->bidi_p && it->bidi_it.type == STRONG_R
6856 && !inhibit_bidi_mirroring)
6857 it->c = bidi_mirror_char (it->c);
6858 /* Map via display table or translate control characters.
6859 IT->c, IT->len etc. have been set to the next character by
6860 the function call above. If we have a display table, and it
6861 contains an entry for IT->c, translate it. Don't do this if
6862 IT->c itself comes from a display table, otherwise we could
6863 end up in an infinite recursion. (An alternative could be to
6864 count the recursion depth of this function and signal an
6865 error when a certain maximum depth is reached.) Is it worth
6866 it? */
6867 if (success_p && it->dpvec == NULL)
6868 {
6869 Lisp_Object dv;
6870 struct charset *unibyte = CHARSET_FROM_ID (charset_unibyte);
6871 bool nonascii_space_p = false;
6872 bool nonascii_hyphen_p = false;
6873 int c = it->c; /* This is the character to display. */
6874
6875 if (! it->multibyte_p && ! ASCII_CHAR_P (c))
6876 {
6877 eassert (SINGLE_BYTE_CHAR_P (c));
6878 if (unibyte_display_via_language_environment)
6879 {
6880 c = DECODE_CHAR (unibyte, c);
6881 if (c < 0)
6882 c = BYTE8_TO_CHAR (it->c);
6883 }
6884 else
6885 c = BYTE8_TO_CHAR (it->c);
6886 }
6887
6888 if (it->dp
6889 && (dv = DISP_CHAR_VECTOR (it->dp, c),
6890 VECTORP (dv)))
6891 {
6892 struct Lisp_Vector *v = XVECTOR (dv);
6893
6894 /* Return the first character from the display table
6895 entry, if not empty. If empty, don't display the
6896 current character. */
6897 if (v->header.size)
6898 {
6899 it->dpvec_char_len = it->len;
6900 it->dpvec = v->contents;
6901 it->dpend = v->contents + v->header.size;
6902 it->current.dpvec_index = 0;
6903 it->dpvec_face_id = -1;
6904 it->saved_face_id = it->face_id;
6905 it->method = GET_FROM_DISPLAY_VECTOR;
6906 it->ellipsis_p = false;
6907 }
6908 else
6909 {
6910 set_iterator_to_next (it, false);
6911 }
6912 goto get_next;
6913 }
6914
6915 if (! NILP (lookup_glyphless_char_display (c, it)))
6916 {
6917 if (it->what == IT_GLYPHLESS)
6918 goto done;
6919 /* Don't display this character. */
6920 set_iterator_to_next (it, false);
6921 goto get_next;
6922 }
6923
6924 /* If `nobreak-char-display' is non-nil, we display
6925 non-ASCII spaces and hyphens specially. */
6926 if (! ASCII_CHAR_P (c) && ! NILP (Vnobreak_char_display))
6927 {
6928 if (c == NO_BREAK_SPACE)
6929 nonascii_space_p = true;
6930 else if (c == SOFT_HYPHEN || c == HYPHEN
6931 || c == NON_BREAKING_HYPHEN)
6932 nonascii_hyphen_p = true;
6933 }
6934
6935 /* Translate control characters into `\003' or `^C' form.
6936 Control characters coming from a display table entry are
6937 currently not translated because we use IT->dpvec to hold
6938 the translation. This could easily be changed but I
6939 don't believe that it is worth doing.
6940
6941 The characters handled by `nobreak-char-display' must be
6942 translated too.
6943
6944 Non-printable characters and raw-byte characters are also
6945 translated to octal form. */
6946 if (((c < ' ' || c == 127) /* ASCII control chars. */
6947 ? (it->area != TEXT_AREA
6948 /* In mode line, treat \n, \t like other crl chars. */
6949 || (c != '\t'
6950 && it->glyph_row
6951 && (it->glyph_row->mode_line_p || it->avoid_cursor_p))
6952 || (c != '\n' && c != '\t'))
6953 : (nonascii_space_p
6954 || nonascii_hyphen_p
6955 || CHAR_BYTE8_P (c)
6956 || ! CHAR_PRINTABLE_P (c))))
6957 {
6958 /* C is a control character, non-ASCII space/hyphen,
6959 raw-byte, or a non-printable character which must be
6960 displayed either as '\003' or as `^C' where the '\\'
6961 and '^' can be defined in the display table. Fill
6962 IT->ctl_chars with glyphs for what we have to
6963 display. Then, set IT->dpvec to these glyphs. */
6964 Lisp_Object gc;
6965 int ctl_len;
6966 int face_id;
6967 int lface_id = 0;
6968 int escape_glyph;
6969
6970 /* Handle control characters with ^. */
6971
6972 if (ASCII_CHAR_P (c) && it->ctl_arrow_p)
6973 {
6974 int g;
6975
6976 g = '^'; /* default glyph for Control */
6977 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6978 if (it->dp
6979 && (gc = DISP_CTRL_GLYPH (it->dp), GLYPH_CODE_P (gc)))
6980 {
6981 g = GLYPH_CODE_CHAR (gc);
6982 lface_id = GLYPH_CODE_FACE (gc);
6983 }
6984
6985 face_id = (lface_id
6986 ? merge_faces (it->f, Qt, lface_id, it->face_id)
6987 : merge_escape_glyph_face (it));
6988
6989 XSETINT (it->ctl_chars[0], g);
6990 XSETINT (it->ctl_chars[1], c ^ 0100);
6991 ctl_len = 2;
6992 goto display_control;
6993 }
6994
6995 /* Handle non-ascii space in the mode where it only gets
6996 highlighting. */
6997
6998 if (nonascii_space_p && EQ (Vnobreak_char_display, Qt))
6999 {
7000 /* Merge `nobreak-space' into the current face. */
7001 face_id = merge_faces (it->f, Qnobreak_space, 0,
7002 it->face_id);
7003 XSETINT (it->ctl_chars[0], ' ');
7004 ctl_len = 1;
7005 goto display_control;
7006 }
7007
7008 /* Handle sequences that start with the "escape glyph". */
7009
7010 /* the default escape glyph is \. */
7011 escape_glyph = '\\';
7012
7013 if (it->dp
7014 && (gc = DISP_ESCAPE_GLYPH (it->dp), GLYPH_CODE_P (gc)))
7015 {
7016 escape_glyph = GLYPH_CODE_CHAR (gc);
7017 lface_id = GLYPH_CODE_FACE (gc);
7018 }
7019
7020 face_id = (lface_id
7021 ? merge_faces (it->f, Qt, lface_id, it->face_id)
7022 : merge_escape_glyph_face (it));
7023
7024 /* Draw non-ASCII hyphen with just highlighting: */
7025
7026 if (nonascii_hyphen_p && EQ (Vnobreak_char_display, Qt))
7027 {
7028 XSETINT (it->ctl_chars[0], '-');
7029 ctl_len = 1;
7030 goto display_control;
7031 }
7032
7033 /* Draw non-ASCII space/hyphen with escape glyph: */
7034
7035 if (nonascii_space_p || nonascii_hyphen_p)
7036 {
7037 XSETINT (it->ctl_chars[0], escape_glyph);
7038 XSETINT (it->ctl_chars[1], nonascii_space_p ? ' ' : '-');
7039 ctl_len = 2;
7040 goto display_control;
7041 }
7042
7043 {
7044 char str[10];
7045 int len, i;
7046
7047 if (CHAR_BYTE8_P (c))
7048 /* Display \200 instead of \17777600. */
7049 c = CHAR_TO_BYTE8 (c);
7050 len = sprintf (str, "%03o", c + 0u);
7051
7052 XSETINT (it->ctl_chars[0], escape_glyph);
7053 for (i = 0; i < len; i++)
7054 XSETINT (it->ctl_chars[i + 1], str[i]);
7055 ctl_len = len + 1;
7056 }
7057
7058 display_control:
7059 /* Set up IT->dpvec and return first character from it. */
7060 it->dpvec_char_len = it->len;
7061 it->dpvec = it->ctl_chars;
7062 it->dpend = it->dpvec + ctl_len;
7063 it->current.dpvec_index = 0;
7064 it->dpvec_face_id = face_id;
7065 it->saved_face_id = it->face_id;
7066 it->method = GET_FROM_DISPLAY_VECTOR;
7067 it->ellipsis_p = false;
7068 goto get_next;
7069 }
7070 it->char_to_display = c;
7071 }
7072 else if (success_p)
7073 {
7074 it->char_to_display = it->c;
7075 }
7076 }
7077
7078 #ifdef HAVE_WINDOW_SYSTEM
7079 /* Adjust face id for a multibyte character. There are no multibyte
7080 character in unibyte text. */
7081 if ((it->what == IT_CHARACTER || it->what == IT_COMPOSITION)
7082 && it->multibyte_p
7083 && success_p
7084 && FRAME_WINDOW_P (it->f))
7085 {
7086 struct face *face = FACE_FROM_ID (it->f, it->face_id);
7087
7088 if (it->what == IT_COMPOSITION && it->cmp_it.ch >= 0)
7089 {
7090 /* Automatic composition with glyph-string. */
7091 Lisp_Object gstring = composition_gstring_from_id (it->cmp_it.id);
7092
7093 it->face_id = face_for_font (it->f, LGSTRING_FONT (gstring), face);
7094 }
7095 else
7096 {
7097 ptrdiff_t pos = (it->s ? -1
7098 : STRINGP (it->string) ? IT_STRING_CHARPOS (*it)
7099 : IT_CHARPOS (*it));
7100 int c;
7101
7102 if (it->what == IT_CHARACTER)
7103 c = it->char_to_display;
7104 else
7105 {
7106 struct composition *cmp = composition_table[it->cmp_it.id];
7107 int i;
7108
7109 c = ' ';
7110 for (i = 0; i < cmp->glyph_len; i++)
7111 /* TAB in a composition means display glyphs with
7112 padding space on the left or right. */
7113 if ((c = COMPOSITION_GLYPH (cmp, i)) != '\t')
7114 break;
7115 }
7116 it->face_id = FACE_FOR_CHAR (it->f, face, c, pos, it->string);
7117 }
7118 }
7119 #endif /* HAVE_WINDOW_SYSTEM */
7120
7121 done:
7122 /* Is this character the last one of a run of characters with
7123 box? If yes, set IT->end_of_box_run_p to true. */
7124 if (it->face_box_p
7125 && it->s == NULL)
7126 {
7127 if (it->method == GET_FROM_STRING && it->sp)
7128 {
7129 int face_id = underlying_face_id (it);
7130 struct face *face = FACE_FROM_ID (it->f, face_id);
7131
7132 if (face)
7133 {
7134 if (face->box == FACE_NO_BOX)
7135 {
7136 /* If the box comes from face properties in a
7137 display string, check faces in that string. */
7138 int string_face_id = face_after_it_pos (it);
7139 it->end_of_box_run_p
7140 = (FACE_FROM_ID (it->f, string_face_id)->box
7141 == FACE_NO_BOX);
7142 }
7143 /* Otherwise, the box comes from the underlying face.
7144 If this is the last string character displayed, check
7145 the next buffer location. */
7146 else if ((IT_STRING_CHARPOS (*it) >= SCHARS (it->string) - 1)
7147 /* n_overlay_strings is unreliable unless
7148 overlay_string_index is non-negative. */
7149 && ((it->current.overlay_string_index >= 0
7150 && (it->current.overlay_string_index
7151 == it->n_overlay_strings - 1))
7152 /* A string from display property. */
7153 || it->from_disp_prop_p))
7154 {
7155 ptrdiff_t ignore;
7156 int next_face_id;
7157 struct text_pos pos = it->current.pos;
7158
7159 /* For a string from a display property, the next
7160 buffer position is stored in the 'position'
7161 member of the iteration stack slot below the
7162 current one, see handle_single_display_spec. By
7163 contrast, it->current.pos was is not yet updated
7164 to point to that buffer position; that will
7165 happen in pop_it, after we finish displaying the
7166 current string. Note that we already checked
7167 above that it->sp is positive, so subtracting one
7168 from it is safe. */
7169 if (it->from_disp_prop_p)
7170 pos = (it->stack + it->sp - 1)->position;
7171 else
7172 INC_TEXT_POS (pos, it->multibyte_p);
7173
7174 if (CHARPOS (pos) >= ZV)
7175 it->end_of_box_run_p = true;
7176 else
7177 {
7178 next_face_id = face_at_buffer_position
7179 (it->w, CHARPOS (pos), &ignore,
7180 CHARPOS (pos) + TEXT_PROP_DISTANCE_LIMIT, false, -1);
7181 it->end_of_box_run_p
7182 = (FACE_FROM_ID (it->f, next_face_id)->box
7183 == FACE_NO_BOX);
7184 }
7185 }
7186 }
7187 }
7188 /* next_element_from_display_vector sets this flag according to
7189 faces of the display vector glyphs, see there. */
7190 else if (it->method != GET_FROM_DISPLAY_VECTOR)
7191 {
7192 int face_id = face_after_it_pos (it);
7193 it->end_of_box_run_p
7194 = (face_id != it->face_id
7195 && FACE_FROM_ID (it->f, face_id)->box == FACE_NO_BOX);
7196 }
7197 }
7198 /* If we reached the end of the object we've been iterating (e.g., a
7199 display string or an overlay string), and there's something on
7200 IT->stack, proceed with what's on the stack. It doesn't make
7201 sense to return false if there's unprocessed stuff on the stack,
7202 because otherwise that stuff will never be displayed. */
7203 if (!success_p && it->sp > 0)
7204 {
7205 set_iterator_to_next (it, false);
7206 success_p = get_next_display_element (it);
7207 }
7208
7209 /* Value is false if end of buffer or string reached. */
7210 return success_p;
7211 }
7212
7213
7214 /* Move IT to the next display element.
7215
7216 RESEAT_P means if called on a newline in buffer text,
7217 skip to the next visible line start.
7218
7219 Functions get_next_display_element and set_iterator_to_next are
7220 separate because I find this arrangement easier to handle than a
7221 get_next_display_element function that also increments IT's
7222 position. The way it is we can first look at an iterator's current
7223 display element, decide whether it fits on a line, and if it does,
7224 increment the iterator position. The other way around we probably
7225 would either need a flag indicating whether the iterator has to be
7226 incremented the next time, or we would have to implement a
7227 decrement position function which would not be easy to write. */
7228
7229 void
7230 set_iterator_to_next (struct it *it, bool reseat_p)
7231 {
7232 /* Reset flags indicating start and end of a sequence of characters
7233 with box. Reset them at the start of this function because
7234 moving the iterator to a new position might set them. */
7235 it->start_of_box_run_p = it->end_of_box_run_p = false;
7236
7237 switch (it->method)
7238 {
7239 case GET_FROM_BUFFER:
7240 /* The current display element of IT is a character from
7241 current_buffer. Advance in the buffer, and maybe skip over
7242 invisible lines that are so because of selective display. */
7243 if (ITERATOR_AT_END_OF_LINE_P (it) && reseat_p)
7244 reseat_at_next_visible_line_start (it, false);
7245 else if (it->cmp_it.id >= 0)
7246 {
7247 /* We are currently getting glyphs from a composition. */
7248 if (! it->bidi_p)
7249 {
7250 IT_CHARPOS (*it) += it->cmp_it.nchars;
7251 IT_BYTEPOS (*it) += it->cmp_it.nbytes;
7252 }
7253 else
7254 {
7255 int i;
7256
7257 /* Update IT's char/byte positions to point to the first
7258 character of the next grapheme cluster, or to the
7259 character visually after the current composition. */
7260 for (i = 0; i < it->cmp_it.nchars; i++)
7261 bidi_move_to_visually_next (&it->bidi_it);
7262 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7263 IT_CHARPOS (*it) = it->bidi_it.charpos;
7264 }
7265
7266 if ((! it->bidi_p || ! it->cmp_it.reversed_p)
7267 && it->cmp_it.to < it->cmp_it.nglyphs)
7268 {
7269 /* Composition created while scanning forward. Proceed
7270 to the next grapheme cluster. */
7271 it->cmp_it.from = it->cmp_it.to;
7272 }
7273 else if ((it->bidi_p && it->cmp_it.reversed_p)
7274 && it->cmp_it.from > 0)
7275 {
7276 /* Composition created while scanning backward. Proceed
7277 to the previous grapheme cluster. */
7278 it->cmp_it.to = it->cmp_it.from;
7279 }
7280 else
7281 {
7282 /* No more grapheme clusters in this composition.
7283 Find the next stop position. */
7284 ptrdiff_t stop = it->end_charpos;
7285
7286 if (it->bidi_it.scan_dir < 0)
7287 /* Now we are scanning backward and don't know
7288 where to stop. */
7289 stop = -1;
7290 composition_compute_stop_pos (&it->cmp_it, IT_CHARPOS (*it),
7291 IT_BYTEPOS (*it), stop, Qnil);
7292 }
7293 }
7294 else
7295 {
7296 eassert (it->len != 0);
7297
7298 if (!it->bidi_p)
7299 {
7300 IT_BYTEPOS (*it) += it->len;
7301 IT_CHARPOS (*it) += 1;
7302 }
7303 else
7304 {
7305 int prev_scan_dir = it->bidi_it.scan_dir;
7306 /* If this is a new paragraph, determine its base
7307 direction (a.k.a. its base embedding level). */
7308 if (it->bidi_it.new_paragraph)
7309 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it,
7310 false);
7311 bidi_move_to_visually_next (&it->bidi_it);
7312 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7313 IT_CHARPOS (*it) = it->bidi_it.charpos;
7314 if (prev_scan_dir != it->bidi_it.scan_dir)
7315 {
7316 /* As the scan direction was changed, we must
7317 re-compute the stop position for composition. */
7318 ptrdiff_t stop = it->end_charpos;
7319 if (it->bidi_it.scan_dir < 0)
7320 stop = -1;
7321 composition_compute_stop_pos (&it->cmp_it, IT_CHARPOS (*it),
7322 IT_BYTEPOS (*it), stop, Qnil);
7323 }
7324 }
7325 eassert (IT_BYTEPOS (*it) == CHAR_TO_BYTE (IT_CHARPOS (*it)));
7326 }
7327 break;
7328
7329 case GET_FROM_C_STRING:
7330 /* Current display element of IT is from a C string. */
7331 if (!it->bidi_p
7332 /* If the string position is beyond string's end, it means
7333 next_element_from_c_string is padding the string with
7334 blanks, in which case we bypass the bidi iterator,
7335 because it cannot deal with such virtual characters. */
7336 || IT_CHARPOS (*it) >= it->bidi_it.string.schars)
7337 {
7338 IT_BYTEPOS (*it) += it->len;
7339 IT_CHARPOS (*it) += 1;
7340 }
7341 else
7342 {
7343 bidi_move_to_visually_next (&it->bidi_it);
7344 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7345 IT_CHARPOS (*it) = it->bidi_it.charpos;
7346 }
7347 break;
7348
7349 case GET_FROM_DISPLAY_VECTOR:
7350 /* Current display element of IT is from a display table entry.
7351 Advance in the display table definition. Reset it to null if
7352 end reached, and continue with characters from buffers/
7353 strings. */
7354 ++it->current.dpvec_index;
7355
7356 /* Restore face of the iterator to what they were before the
7357 display vector entry (these entries may contain faces). */
7358 it->face_id = it->saved_face_id;
7359
7360 if (it->dpvec + it->current.dpvec_index >= it->dpend)
7361 {
7362 bool recheck_faces = it->ellipsis_p;
7363
7364 if (it->s)
7365 it->method = GET_FROM_C_STRING;
7366 else if (STRINGP (it->string))
7367 it->method = GET_FROM_STRING;
7368 else
7369 {
7370 it->method = GET_FROM_BUFFER;
7371 it->object = it->w->contents;
7372 }
7373
7374 it->dpvec = NULL;
7375 it->current.dpvec_index = -1;
7376
7377 /* Skip over characters which were displayed via IT->dpvec. */
7378 if (it->dpvec_char_len < 0)
7379 reseat_at_next_visible_line_start (it, true);
7380 else if (it->dpvec_char_len > 0)
7381 {
7382 it->len = it->dpvec_char_len;
7383 set_iterator_to_next (it, reseat_p);
7384 }
7385
7386 /* Maybe recheck faces after display vector. */
7387 if (recheck_faces)
7388 {
7389 if (it->method == GET_FROM_STRING)
7390 it->stop_charpos = IT_STRING_CHARPOS (*it);
7391 else
7392 it->stop_charpos = IT_CHARPOS (*it);
7393 }
7394 }
7395 break;
7396
7397 case GET_FROM_STRING:
7398 /* Current display element is a character from a Lisp string. */
7399 eassert (it->s == NULL && STRINGP (it->string));
7400 /* Don't advance past string end. These conditions are true
7401 when set_iterator_to_next is called at the end of
7402 get_next_display_element, in which case the Lisp string is
7403 already exhausted, and all we want is pop the iterator
7404 stack. */
7405 if (it->current.overlay_string_index >= 0)
7406 {
7407 /* This is an overlay string, so there's no padding with
7408 spaces, and the number of characters in the string is
7409 where the string ends. */
7410 if (IT_STRING_CHARPOS (*it) >= SCHARS (it->string))
7411 goto consider_string_end;
7412 }
7413 else
7414 {
7415 /* Not an overlay string. There could be padding, so test
7416 against it->end_charpos. */
7417 if (IT_STRING_CHARPOS (*it) >= it->end_charpos)
7418 goto consider_string_end;
7419 }
7420 if (it->cmp_it.id >= 0)
7421 {
7422 /* We are delivering display elements from a composition.
7423 Update the string position past the grapheme cluster
7424 we've just processed. */
7425 if (! it->bidi_p)
7426 {
7427 IT_STRING_CHARPOS (*it) += it->cmp_it.nchars;
7428 IT_STRING_BYTEPOS (*it) += it->cmp_it.nbytes;
7429 }
7430 else
7431 {
7432 int i;
7433
7434 for (i = 0; i < it->cmp_it.nchars; i++)
7435 bidi_move_to_visually_next (&it->bidi_it);
7436 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
7437 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
7438 }
7439
7440 /* Did we exhaust all the grapheme clusters of this
7441 composition? */
7442 if ((! it->bidi_p || ! it->cmp_it.reversed_p)
7443 && (it->cmp_it.to < it->cmp_it.nglyphs))
7444 {
7445 /* Not all the grapheme clusters were processed yet;
7446 advance to the next cluster. */
7447 it->cmp_it.from = it->cmp_it.to;
7448 }
7449 else if ((it->bidi_p && it->cmp_it.reversed_p)
7450 && it->cmp_it.from > 0)
7451 {
7452 /* Likewise: advance to the next cluster, but going in
7453 the reverse direction. */
7454 it->cmp_it.to = it->cmp_it.from;
7455 }
7456 else
7457 {
7458 /* This composition was fully processed; find the next
7459 candidate place for checking for composed
7460 characters. */
7461 /* Always limit string searches to the string length;
7462 any padding spaces are not part of the string, and
7463 there cannot be any compositions in that padding. */
7464 ptrdiff_t stop = SCHARS (it->string);
7465
7466 if (it->bidi_p && it->bidi_it.scan_dir < 0)
7467 stop = -1;
7468 else if (it->end_charpos < stop)
7469 {
7470 /* Cf. PRECISION in reseat_to_string: we might be
7471 limited in how many of the string characters we
7472 need to deliver. */
7473 stop = it->end_charpos;
7474 }
7475 composition_compute_stop_pos (&it->cmp_it,
7476 IT_STRING_CHARPOS (*it),
7477 IT_STRING_BYTEPOS (*it), stop,
7478 it->string);
7479 }
7480 }
7481 else
7482 {
7483 if (!it->bidi_p
7484 /* If the string position is beyond string's end, it
7485 means next_element_from_string is padding the string
7486 with blanks, in which case we bypass the bidi
7487 iterator, because it cannot deal with such virtual
7488 characters. */
7489 || IT_STRING_CHARPOS (*it) >= it->bidi_it.string.schars)
7490 {
7491 IT_STRING_BYTEPOS (*it) += it->len;
7492 IT_STRING_CHARPOS (*it) += 1;
7493 }
7494 else
7495 {
7496 int prev_scan_dir = it->bidi_it.scan_dir;
7497
7498 bidi_move_to_visually_next (&it->bidi_it);
7499 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
7500 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
7501 /* If the scan direction changes, we may need to update
7502 the place where to check for composed characters. */
7503 if (prev_scan_dir != it->bidi_it.scan_dir)
7504 {
7505 ptrdiff_t stop = SCHARS (it->string);
7506
7507 if (it->bidi_it.scan_dir < 0)
7508 stop = -1;
7509 else if (it->end_charpos < stop)
7510 stop = it->end_charpos;
7511
7512 composition_compute_stop_pos (&it->cmp_it,
7513 IT_STRING_CHARPOS (*it),
7514 IT_STRING_BYTEPOS (*it), stop,
7515 it->string);
7516 }
7517 }
7518 }
7519
7520 consider_string_end:
7521
7522 if (it->current.overlay_string_index >= 0)
7523 {
7524 /* IT->string is an overlay string. Advance to the
7525 next, if there is one. */
7526 if (IT_STRING_CHARPOS (*it) >= SCHARS (it->string))
7527 {
7528 it->ellipsis_p = false;
7529 next_overlay_string (it);
7530 if (it->ellipsis_p)
7531 setup_for_ellipsis (it, 0);
7532 }
7533 }
7534 else
7535 {
7536 /* IT->string is not an overlay string. If we reached
7537 its end, and there is something on IT->stack, proceed
7538 with what is on the stack. This can be either another
7539 string, this time an overlay string, or a buffer. */
7540 if (IT_STRING_CHARPOS (*it) == SCHARS (it->string)
7541 && it->sp > 0)
7542 {
7543 pop_it (it);
7544 if (it->method == GET_FROM_STRING)
7545 goto consider_string_end;
7546 }
7547 }
7548 break;
7549
7550 case GET_FROM_IMAGE:
7551 case GET_FROM_STRETCH:
7552 /* The position etc with which we have to proceed are on
7553 the stack. The position may be at the end of a string,
7554 if the `display' property takes up the whole string. */
7555 eassert (it->sp > 0);
7556 pop_it (it);
7557 if (it->method == GET_FROM_STRING)
7558 goto consider_string_end;
7559 break;
7560
7561 default:
7562 /* There are no other methods defined, so this should be a bug. */
7563 emacs_abort ();
7564 }
7565
7566 eassert (it->method != GET_FROM_STRING
7567 || (STRINGP (it->string)
7568 && IT_STRING_CHARPOS (*it) >= 0));
7569 }
7570
7571 /* Load IT's display element fields with information about the next
7572 display element which comes from a display table entry or from the
7573 result of translating a control character to one of the forms `^C'
7574 or `\003'.
7575
7576 IT->dpvec holds the glyphs to return as characters.
7577 IT->saved_face_id holds the face id before the display vector--it
7578 is restored into IT->face_id in set_iterator_to_next. */
7579
7580 static bool
7581 next_element_from_display_vector (struct it *it)
7582 {
7583 Lisp_Object gc;
7584 int prev_face_id = it->face_id;
7585 int next_face_id;
7586
7587 /* Precondition. */
7588 eassert (it->dpvec && it->current.dpvec_index >= 0);
7589
7590 it->face_id = it->saved_face_id;
7591
7592 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7593 That seemed totally bogus - so I changed it... */
7594 gc = it->dpvec[it->current.dpvec_index];
7595
7596 if (GLYPH_CODE_P (gc))
7597 {
7598 struct face *this_face, *prev_face, *next_face;
7599
7600 it->c = GLYPH_CODE_CHAR (gc);
7601 it->len = CHAR_BYTES (it->c);
7602
7603 /* The entry may contain a face id to use. Such a face id is
7604 the id of a Lisp face, not a realized face. A face id of
7605 zero means no face is specified. */
7606 if (it->dpvec_face_id >= 0)
7607 it->face_id = it->dpvec_face_id;
7608 else
7609 {
7610 int lface_id = GLYPH_CODE_FACE (gc);
7611 if (lface_id > 0)
7612 it->face_id = merge_faces (it->f, Qt, lface_id,
7613 it->saved_face_id);
7614 }
7615
7616 /* Glyphs in the display vector could have the box face, so we
7617 need to set the related flags in the iterator, as
7618 appropriate. */
7619 this_face = FACE_FROM_ID (it->f, it->face_id);
7620 prev_face = FACE_FROM_ID (it->f, prev_face_id);
7621
7622 /* Is this character the first character of a box-face run? */
7623 it->start_of_box_run_p = (this_face && this_face->box != FACE_NO_BOX
7624 && (!prev_face
7625 || prev_face->box == FACE_NO_BOX));
7626
7627 /* For the last character of the box-face run, we need to look
7628 either at the next glyph from the display vector, or at the
7629 face we saw before the display vector. */
7630 next_face_id = it->saved_face_id;
7631 if (it->current.dpvec_index < it->dpend - it->dpvec - 1)
7632 {
7633 if (it->dpvec_face_id >= 0)
7634 next_face_id = it->dpvec_face_id;
7635 else
7636 {
7637 int lface_id =
7638 GLYPH_CODE_FACE (it->dpvec[it->current.dpvec_index + 1]);
7639
7640 if (lface_id > 0)
7641 next_face_id = merge_faces (it->f, Qt, lface_id,
7642 it->saved_face_id);
7643 }
7644 }
7645 next_face = FACE_FROM_ID (it->f, next_face_id);
7646 it->end_of_box_run_p = (this_face && this_face->box != FACE_NO_BOX
7647 && (!next_face
7648 || next_face->box == FACE_NO_BOX));
7649 it->face_box_p = this_face && this_face->box != FACE_NO_BOX;
7650 }
7651 else
7652 /* Display table entry is invalid. Return a space. */
7653 it->c = ' ', it->len = 1;
7654
7655 /* Don't change position and object of the iterator here. They are
7656 still the values of the character that had this display table
7657 entry or was translated, and that's what we want. */
7658 it->what = IT_CHARACTER;
7659 return true;
7660 }
7661
7662 /* Get the first element of string/buffer in the visual order, after
7663 being reseated to a new position in a string or a buffer. */
7664 static void
7665 get_visually_first_element (struct it *it)
7666 {
7667 bool string_p = STRINGP (it->string) || it->s;
7668 ptrdiff_t eob = (string_p ? it->bidi_it.string.schars : ZV);
7669 ptrdiff_t bob = (string_p ? 0 : BEGV);
7670
7671 if (STRINGP (it->string))
7672 {
7673 it->bidi_it.charpos = IT_STRING_CHARPOS (*it);
7674 it->bidi_it.bytepos = IT_STRING_BYTEPOS (*it);
7675 }
7676 else
7677 {
7678 it->bidi_it.charpos = IT_CHARPOS (*it);
7679 it->bidi_it.bytepos = IT_BYTEPOS (*it);
7680 }
7681
7682 if (it->bidi_it.charpos == eob)
7683 {
7684 /* Nothing to do, but reset the FIRST_ELT flag, like
7685 bidi_paragraph_init does, because we are not going to
7686 call it. */
7687 it->bidi_it.first_elt = false;
7688 }
7689 else if (it->bidi_it.charpos == bob
7690 || (!string_p
7691 && (FETCH_CHAR (it->bidi_it.bytepos - 1) == '\n'
7692 || FETCH_CHAR (it->bidi_it.bytepos) == '\n')))
7693 {
7694 /* If we are at the beginning of a line/string, we can produce
7695 the next element right away. */
7696 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, true);
7697 bidi_move_to_visually_next (&it->bidi_it);
7698 }
7699 else
7700 {
7701 ptrdiff_t orig_bytepos = it->bidi_it.bytepos;
7702
7703 /* We need to prime the bidi iterator starting at the line's or
7704 string's beginning, before we will be able to produce the
7705 next element. */
7706 if (string_p)
7707 it->bidi_it.charpos = it->bidi_it.bytepos = 0;
7708 else
7709 it->bidi_it.charpos = find_newline_no_quit (IT_CHARPOS (*it),
7710 IT_BYTEPOS (*it), -1,
7711 &it->bidi_it.bytepos);
7712 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, true);
7713 do
7714 {
7715 /* Now return to buffer/string position where we were asked
7716 to get the next display element, and produce that. */
7717 bidi_move_to_visually_next (&it->bidi_it);
7718 }
7719 while (it->bidi_it.bytepos != orig_bytepos
7720 && it->bidi_it.charpos < eob);
7721 }
7722
7723 /* Adjust IT's position information to where we ended up. */
7724 if (STRINGP (it->string))
7725 {
7726 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
7727 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
7728 }
7729 else
7730 {
7731 IT_CHARPOS (*it) = it->bidi_it.charpos;
7732 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7733 }
7734
7735 if (STRINGP (it->string) || !it->s)
7736 {
7737 ptrdiff_t stop, charpos, bytepos;
7738
7739 if (STRINGP (it->string))
7740 {
7741 eassert (!it->s);
7742 stop = SCHARS (it->string);
7743 if (stop > it->end_charpos)
7744 stop = it->end_charpos;
7745 charpos = IT_STRING_CHARPOS (*it);
7746 bytepos = IT_STRING_BYTEPOS (*it);
7747 }
7748 else
7749 {
7750 stop = it->end_charpos;
7751 charpos = IT_CHARPOS (*it);
7752 bytepos = IT_BYTEPOS (*it);
7753 }
7754 if (it->bidi_it.scan_dir < 0)
7755 stop = -1;
7756 composition_compute_stop_pos (&it->cmp_it, charpos, bytepos, stop,
7757 it->string);
7758 }
7759 }
7760
7761 /* Load IT with the next display element from Lisp string IT->string.
7762 IT->current.string_pos is the current position within the string.
7763 If IT->current.overlay_string_index >= 0, the Lisp string is an
7764 overlay string. */
7765
7766 static bool
7767 next_element_from_string (struct it *it)
7768 {
7769 struct text_pos position;
7770
7771 eassert (STRINGP (it->string));
7772 eassert (!it->bidi_p || EQ (it->string, it->bidi_it.string.lstring));
7773 eassert (IT_STRING_CHARPOS (*it) >= 0);
7774 position = it->current.string_pos;
7775
7776 /* With bidi reordering, the character to display might not be the
7777 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT means
7778 that we were reseat()ed to a new string, whose paragraph
7779 direction is not known. */
7780 if (it->bidi_p && it->bidi_it.first_elt)
7781 {
7782 get_visually_first_element (it);
7783 SET_TEXT_POS (position, IT_STRING_CHARPOS (*it), IT_STRING_BYTEPOS (*it));
7784 }
7785
7786 /* Time to check for invisible text? */
7787 if (IT_STRING_CHARPOS (*it) < it->end_charpos)
7788 {
7789 if (IT_STRING_CHARPOS (*it) >= it->stop_charpos)
7790 {
7791 if (!(!it->bidi_p
7792 || BIDI_AT_BASE_LEVEL (it->bidi_it)
7793 || IT_STRING_CHARPOS (*it) == it->stop_charpos))
7794 {
7795 /* With bidi non-linear iteration, we could find
7796 ourselves far beyond the last computed stop_charpos,
7797 with several other stop positions in between that we
7798 missed. Scan them all now, in buffer's logical
7799 order, until we find and handle the last stop_charpos
7800 that precedes our current position. */
7801 handle_stop_backwards (it, it->stop_charpos);
7802 return GET_NEXT_DISPLAY_ELEMENT (it);
7803 }
7804 else
7805 {
7806 if (it->bidi_p)
7807 {
7808 /* Take note of the stop position we just moved
7809 across, for when we will move back across it. */
7810 it->prev_stop = it->stop_charpos;
7811 /* If we are at base paragraph embedding level, take
7812 note of the last stop position seen at this
7813 level. */
7814 if (BIDI_AT_BASE_LEVEL (it->bidi_it))
7815 it->base_level_stop = it->stop_charpos;
7816 }
7817 handle_stop (it);
7818
7819 /* Since a handler may have changed IT->method, we must
7820 recurse here. */
7821 return GET_NEXT_DISPLAY_ELEMENT (it);
7822 }
7823 }
7824 else if (it->bidi_p
7825 /* If we are before prev_stop, we may have overstepped
7826 on our way backwards a stop_pos, and if so, we need
7827 to handle that stop_pos. */
7828 && IT_STRING_CHARPOS (*it) < it->prev_stop
7829 /* We can sometimes back up for reasons that have nothing
7830 to do with bidi reordering. E.g., compositions. The
7831 code below is only needed when we are above the base
7832 embedding level, so test for that explicitly. */
7833 && !BIDI_AT_BASE_LEVEL (it->bidi_it))
7834 {
7835 /* If we lost track of base_level_stop, we have no better
7836 place for handle_stop_backwards to start from than string
7837 beginning. This happens, e.g., when we were reseated to
7838 the previous screenful of text by vertical-motion. */
7839 if (it->base_level_stop <= 0
7840 || IT_STRING_CHARPOS (*it) < it->base_level_stop)
7841 it->base_level_stop = 0;
7842 handle_stop_backwards (it, it->base_level_stop);
7843 return GET_NEXT_DISPLAY_ELEMENT (it);
7844 }
7845 }
7846
7847 if (it->current.overlay_string_index >= 0)
7848 {
7849 /* Get the next character from an overlay string. In overlay
7850 strings, there is no field width or padding with spaces to
7851 do. */
7852 if (IT_STRING_CHARPOS (*it) >= SCHARS (it->string))
7853 {
7854 it->what = IT_EOB;
7855 return false;
7856 }
7857 else if (CHAR_COMPOSED_P (it, IT_STRING_CHARPOS (*it),
7858 IT_STRING_BYTEPOS (*it),
7859 it->bidi_it.scan_dir < 0
7860 ? -1
7861 : SCHARS (it->string))
7862 && next_element_from_composition (it))
7863 {
7864 return true;
7865 }
7866 else if (STRING_MULTIBYTE (it->string))
7867 {
7868 const unsigned char *s = (SDATA (it->string)
7869 + IT_STRING_BYTEPOS (*it));
7870 it->c = string_char_and_length (s, &it->len);
7871 }
7872 else
7873 {
7874 it->c = SREF (it->string, IT_STRING_BYTEPOS (*it));
7875 it->len = 1;
7876 }
7877 }
7878 else
7879 {
7880 /* Get the next character from a Lisp string that is not an
7881 overlay string. Such strings come from the mode line, for
7882 example. We may have to pad with spaces, or truncate the
7883 string. See also next_element_from_c_string. */
7884 if (IT_STRING_CHARPOS (*it) >= it->end_charpos)
7885 {
7886 it->what = IT_EOB;
7887 return false;
7888 }
7889 else if (IT_STRING_CHARPOS (*it) >= it->string_nchars)
7890 {
7891 /* Pad with spaces. */
7892 it->c = ' ', it->len = 1;
7893 CHARPOS (position) = BYTEPOS (position) = -1;
7894 }
7895 else if (CHAR_COMPOSED_P (it, IT_STRING_CHARPOS (*it),
7896 IT_STRING_BYTEPOS (*it),
7897 it->bidi_it.scan_dir < 0
7898 ? -1
7899 : it->string_nchars)
7900 && next_element_from_composition (it))
7901 {
7902 return true;
7903 }
7904 else if (STRING_MULTIBYTE (it->string))
7905 {
7906 const unsigned char *s = (SDATA (it->string)
7907 + IT_STRING_BYTEPOS (*it));
7908 it->c = string_char_and_length (s, &it->len);
7909 }
7910 else
7911 {
7912 it->c = SREF (it->string, IT_STRING_BYTEPOS (*it));
7913 it->len = 1;
7914 }
7915 }
7916
7917 /* Record what we have and where it came from. */
7918 it->what = IT_CHARACTER;
7919 it->object = it->string;
7920 it->position = position;
7921 return true;
7922 }
7923
7924
7925 /* Load IT with next display element from C string IT->s.
7926 IT->string_nchars is the maximum number of characters to return
7927 from the string. IT->end_charpos may be greater than
7928 IT->string_nchars when this function is called, in which case we
7929 may have to return padding spaces. Value is false if end of string
7930 reached, including padding spaces. */
7931
7932 static bool
7933 next_element_from_c_string (struct it *it)
7934 {
7935 bool success_p = true;
7936
7937 eassert (it->s);
7938 eassert (!it->bidi_p || it->s == it->bidi_it.string.s);
7939 it->what = IT_CHARACTER;
7940 BYTEPOS (it->position) = CHARPOS (it->position) = 0;
7941 it->object = make_number (0);
7942
7943 /* With bidi reordering, the character to display might not be the
7944 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
7945 we were reseated to a new string, whose paragraph direction is
7946 not known. */
7947 if (it->bidi_p && it->bidi_it.first_elt)
7948 get_visually_first_element (it);
7949
7950 /* IT's position can be greater than IT->string_nchars in case a
7951 field width or precision has been specified when the iterator was
7952 initialized. */
7953 if (IT_CHARPOS (*it) >= it->end_charpos)
7954 {
7955 /* End of the game. */
7956 it->what = IT_EOB;
7957 success_p = false;
7958 }
7959 else if (IT_CHARPOS (*it) >= it->string_nchars)
7960 {
7961 /* Pad with spaces. */
7962 it->c = ' ', it->len = 1;
7963 BYTEPOS (it->position) = CHARPOS (it->position) = -1;
7964 }
7965 else if (it->multibyte_p)
7966 it->c = string_char_and_length (it->s + IT_BYTEPOS (*it), &it->len);
7967 else
7968 it->c = it->s[IT_BYTEPOS (*it)], it->len = 1;
7969
7970 return success_p;
7971 }
7972
7973
7974 /* Set up IT to return characters from an ellipsis, if appropriate.
7975 The definition of the ellipsis glyphs may come from a display table
7976 entry. This function fills IT with the first glyph from the
7977 ellipsis if an ellipsis is to be displayed. */
7978
7979 static bool
7980 next_element_from_ellipsis (struct it *it)
7981 {
7982 if (it->selective_display_ellipsis_p)
7983 setup_for_ellipsis (it, it->len);
7984 else
7985 {
7986 /* The face at the current position may be different from the
7987 face we find after the invisible text. Remember what it
7988 was in IT->saved_face_id, and signal that it's there by
7989 setting face_before_selective_p. */
7990 it->saved_face_id = it->face_id;
7991 it->method = GET_FROM_BUFFER;
7992 it->object = it->w->contents;
7993 reseat_at_next_visible_line_start (it, true);
7994 it->face_before_selective_p = true;
7995 }
7996
7997 return GET_NEXT_DISPLAY_ELEMENT (it);
7998 }
7999
8000
8001 /* Deliver an image display element. The iterator IT is already
8002 filled with image information (done in handle_display_prop). Value
8003 is always true. */
8004
8005
8006 static bool
8007 next_element_from_image (struct it *it)
8008 {
8009 it->what = IT_IMAGE;
8010 return true;
8011 }
8012
8013
8014 /* Fill iterator IT with next display element from a stretch glyph
8015 property. IT->object is the value of the text property. Value is
8016 always true. */
8017
8018 static bool
8019 next_element_from_stretch (struct it *it)
8020 {
8021 it->what = IT_STRETCH;
8022 return true;
8023 }
8024
8025 /* Scan backwards from IT's current position until we find a stop
8026 position, or until BEGV. This is called when we find ourself
8027 before both the last known prev_stop and base_level_stop while
8028 reordering bidirectional text. */
8029
8030 static void
8031 compute_stop_pos_backwards (struct it *it)
8032 {
8033 const int SCAN_BACK_LIMIT = 1000;
8034 struct text_pos pos;
8035 struct display_pos save_current = it->current;
8036 struct text_pos save_position = it->position;
8037 ptrdiff_t charpos = IT_CHARPOS (*it);
8038 ptrdiff_t where_we_are = charpos;
8039 ptrdiff_t save_stop_pos = it->stop_charpos;
8040 ptrdiff_t save_end_pos = it->end_charpos;
8041
8042 eassert (NILP (it->string) && !it->s);
8043 eassert (it->bidi_p);
8044 it->bidi_p = false;
8045 do
8046 {
8047 it->end_charpos = min (charpos + 1, ZV);
8048 charpos = max (charpos - SCAN_BACK_LIMIT, BEGV);
8049 SET_TEXT_POS (pos, charpos, CHAR_TO_BYTE (charpos));
8050 reseat_1 (it, pos, false);
8051 compute_stop_pos (it);
8052 /* We must advance forward, right? */
8053 if (it->stop_charpos <= charpos)
8054 emacs_abort ();
8055 }
8056 while (charpos > BEGV && it->stop_charpos >= it->end_charpos);
8057
8058 if (it->stop_charpos <= where_we_are)
8059 it->prev_stop = it->stop_charpos;
8060 else
8061 it->prev_stop = BEGV;
8062 it->bidi_p = true;
8063 it->current = save_current;
8064 it->position = save_position;
8065 it->stop_charpos = save_stop_pos;
8066 it->end_charpos = save_end_pos;
8067 }
8068
8069 /* Scan forward from CHARPOS in the current buffer/string, until we
8070 find a stop position > current IT's position. Then handle the stop
8071 position before that. This is called when we bump into a stop
8072 position while reordering bidirectional text. CHARPOS should be
8073 the last previously processed stop_pos (or BEGV/0, if none were
8074 processed yet) whose position is less that IT's current
8075 position. */
8076
8077 static void
8078 handle_stop_backwards (struct it *it, ptrdiff_t charpos)
8079 {
8080 bool bufp = !STRINGP (it->string);
8081 ptrdiff_t where_we_are = (bufp ? IT_CHARPOS (*it) : IT_STRING_CHARPOS (*it));
8082 struct display_pos save_current = it->current;
8083 struct text_pos save_position = it->position;
8084 struct text_pos pos1;
8085 ptrdiff_t next_stop;
8086
8087 /* Scan in strict logical order. */
8088 eassert (it->bidi_p);
8089 it->bidi_p = false;
8090 do
8091 {
8092 it->prev_stop = charpos;
8093 if (bufp)
8094 {
8095 SET_TEXT_POS (pos1, charpos, CHAR_TO_BYTE (charpos));
8096 reseat_1 (it, pos1, false);
8097 }
8098 else
8099 it->current.string_pos = string_pos (charpos, it->string);
8100 compute_stop_pos (it);
8101 /* We must advance forward, right? */
8102 if (it->stop_charpos <= it->prev_stop)
8103 emacs_abort ();
8104 charpos = it->stop_charpos;
8105 }
8106 while (charpos <= where_we_are);
8107
8108 it->bidi_p = true;
8109 it->current = save_current;
8110 it->position = save_position;
8111 next_stop = it->stop_charpos;
8112 it->stop_charpos = it->prev_stop;
8113 handle_stop (it);
8114 it->stop_charpos = next_stop;
8115 }
8116
8117 /* Load IT with the next display element from current_buffer. Value
8118 is false if end of buffer reached. IT->stop_charpos is the next
8119 position at which to stop and check for text properties or buffer
8120 end. */
8121
8122 static bool
8123 next_element_from_buffer (struct it *it)
8124 {
8125 bool success_p = true;
8126
8127 eassert (IT_CHARPOS (*it) >= BEGV);
8128 eassert (NILP (it->string) && !it->s);
8129 eassert (!it->bidi_p
8130 || (EQ (it->bidi_it.string.lstring, Qnil)
8131 && it->bidi_it.string.s == NULL));
8132
8133 /* With bidi reordering, the character to display might not be the
8134 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
8135 we were reseat()ed to a new buffer position, which is potentially
8136 a different paragraph. */
8137 if (it->bidi_p && it->bidi_it.first_elt)
8138 {
8139 get_visually_first_element (it);
8140 SET_TEXT_POS (it->position, IT_CHARPOS (*it), IT_BYTEPOS (*it));
8141 }
8142
8143 if (IT_CHARPOS (*it) >= it->stop_charpos)
8144 {
8145 if (IT_CHARPOS (*it) >= it->end_charpos)
8146 {
8147 bool overlay_strings_follow_p;
8148
8149 /* End of the game, except when overlay strings follow that
8150 haven't been returned yet. */
8151 if (it->overlay_strings_at_end_processed_p)
8152 overlay_strings_follow_p = false;
8153 else
8154 {
8155 it->overlay_strings_at_end_processed_p = true;
8156 overlay_strings_follow_p = get_overlay_strings (it, 0);
8157 }
8158
8159 if (overlay_strings_follow_p)
8160 success_p = GET_NEXT_DISPLAY_ELEMENT (it);
8161 else
8162 {
8163 it->what = IT_EOB;
8164 it->position = it->current.pos;
8165 success_p = false;
8166 }
8167 }
8168 else if (!(!it->bidi_p
8169 || BIDI_AT_BASE_LEVEL (it->bidi_it)
8170 || IT_CHARPOS (*it) == it->stop_charpos))
8171 {
8172 /* With bidi non-linear iteration, we could find ourselves
8173 far beyond the last computed stop_charpos, with several
8174 other stop positions in between that we missed. Scan
8175 them all now, in buffer's logical order, until we find
8176 and handle the last stop_charpos that precedes our
8177 current position. */
8178 handle_stop_backwards (it, it->stop_charpos);
8179 it->ignore_overlay_strings_at_pos_p = false;
8180 return GET_NEXT_DISPLAY_ELEMENT (it);
8181 }
8182 else
8183 {
8184 if (it->bidi_p)
8185 {
8186 /* Take note of the stop position we just moved across,
8187 for when we will move back across it. */
8188 it->prev_stop = it->stop_charpos;
8189 /* If we are at base paragraph embedding level, take
8190 note of the last stop position seen at this
8191 level. */
8192 if (BIDI_AT_BASE_LEVEL (it->bidi_it))
8193 it->base_level_stop = it->stop_charpos;
8194 }
8195 handle_stop (it);
8196 it->ignore_overlay_strings_at_pos_p = false;
8197 return GET_NEXT_DISPLAY_ELEMENT (it);
8198 }
8199 }
8200 else if (it->bidi_p
8201 /* If we are before prev_stop, we may have overstepped on
8202 our way backwards a stop_pos, and if so, we need to
8203 handle that stop_pos. */
8204 && IT_CHARPOS (*it) < it->prev_stop
8205 /* We can sometimes back up for reasons that have nothing
8206 to do with bidi reordering. E.g., compositions. The
8207 code below is only needed when we are above the base
8208 embedding level, so test for that explicitly. */
8209 && !BIDI_AT_BASE_LEVEL (it->bidi_it))
8210 {
8211 if (it->base_level_stop <= 0
8212 || IT_CHARPOS (*it) < it->base_level_stop)
8213 {
8214 /* If we lost track of base_level_stop, we need to find
8215 prev_stop by looking backwards. This happens, e.g., when
8216 we were reseated to the previous screenful of text by
8217 vertical-motion. */
8218 it->base_level_stop = BEGV;
8219 compute_stop_pos_backwards (it);
8220 handle_stop_backwards (it, it->prev_stop);
8221 }
8222 else
8223 handle_stop_backwards (it, it->base_level_stop);
8224 it->ignore_overlay_strings_at_pos_p = false;
8225 return GET_NEXT_DISPLAY_ELEMENT (it);
8226 }
8227 else
8228 {
8229 /* No face changes, overlays etc. in sight, so just return a
8230 character from current_buffer. */
8231 unsigned char *p;
8232 ptrdiff_t stop;
8233
8234 /* We moved to the next buffer position, so any info about
8235 previously seen overlays is no longer valid. */
8236 it->ignore_overlay_strings_at_pos_p = false;
8237
8238 /* Maybe run the redisplay end trigger hook. Performance note:
8239 This doesn't seem to cost measurable time. */
8240 if (it->redisplay_end_trigger_charpos
8241 && it->glyph_row
8242 && IT_CHARPOS (*it) >= it->redisplay_end_trigger_charpos)
8243 run_redisplay_end_trigger_hook (it);
8244
8245 stop = it->bidi_it.scan_dir < 0 ? -1 : it->end_charpos;
8246 if (CHAR_COMPOSED_P (it, IT_CHARPOS (*it), IT_BYTEPOS (*it),
8247 stop)
8248 && next_element_from_composition (it))
8249 {
8250 return true;
8251 }
8252
8253 /* Get the next character, maybe multibyte. */
8254 p = BYTE_POS_ADDR (IT_BYTEPOS (*it));
8255 if (it->multibyte_p && !ASCII_CHAR_P (*p))
8256 it->c = STRING_CHAR_AND_LENGTH (p, it->len);
8257 else
8258 it->c = *p, it->len = 1;
8259
8260 /* Record what we have and where it came from. */
8261 it->what = IT_CHARACTER;
8262 it->object = it->w->contents;
8263 it->position = it->current.pos;
8264
8265 /* Normally we return the character found above, except when we
8266 really want to return an ellipsis for selective display. */
8267 if (it->selective)
8268 {
8269 if (it->c == '\n')
8270 {
8271 /* A value of selective > 0 means hide lines indented more
8272 than that number of columns. */
8273 if (it->selective > 0
8274 && IT_CHARPOS (*it) + 1 < ZV
8275 && indented_beyond_p (IT_CHARPOS (*it) + 1,
8276 IT_BYTEPOS (*it) + 1,
8277 it->selective))
8278 {
8279 success_p = next_element_from_ellipsis (it);
8280 it->dpvec_char_len = -1;
8281 }
8282 }
8283 else if (it->c == '\r' && it->selective == -1)
8284 {
8285 /* A value of selective == -1 means that everything from the
8286 CR to the end of the line is invisible, with maybe an
8287 ellipsis displayed for it. */
8288 success_p = next_element_from_ellipsis (it);
8289 it->dpvec_char_len = -1;
8290 }
8291 }
8292 }
8293
8294 /* Value is false if end of buffer reached. */
8295 eassert (!success_p || it->what != IT_CHARACTER || it->len > 0);
8296 return success_p;
8297 }
8298
8299
8300 /* Run the redisplay end trigger hook for IT. */
8301
8302 static void
8303 run_redisplay_end_trigger_hook (struct it *it)
8304 {
8305 /* IT->glyph_row should be non-null, i.e. we should be actually
8306 displaying something, or otherwise we should not run the hook. */
8307 eassert (it->glyph_row);
8308
8309 ptrdiff_t charpos = it->redisplay_end_trigger_charpos;
8310 it->redisplay_end_trigger_charpos = 0;
8311
8312 /* Since we are *trying* to run these functions, don't try to run
8313 them again, even if they get an error. */
8314 wset_redisplay_end_trigger (it->w, Qnil);
8315 CALLN (Frun_hook_with_args, Qredisplay_end_trigger_functions, it->window,
8316 make_number (charpos));
8317
8318 /* Notice if it changed the face of the character we are on. */
8319 handle_face_prop (it);
8320 }
8321
8322
8323 /* Deliver a composition display element. Unlike the other
8324 next_element_from_XXX, this function is not registered in the array
8325 get_next_element[]. It is called from next_element_from_buffer and
8326 next_element_from_string when necessary. */
8327
8328 static bool
8329 next_element_from_composition (struct it *it)
8330 {
8331 it->what = IT_COMPOSITION;
8332 it->len = it->cmp_it.nbytes;
8333 if (STRINGP (it->string))
8334 {
8335 if (it->c < 0)
8336 {
8337 IT_STRING_CHARPOS (*it) += it->cmp_it.nchars;
8338 IT_STRING_BYTEPOS (*it) += it->cmp_it.nbytes;
8339 return false;
8340 }
8341 it->position = it->current.string_pos;
8342 it->object = it->string;
8343 it->c = composition_update_it (&it->cmp_it, IT_STRING_CHARPOS (*it),
8344 IT_STRING_BYTEPOS (*it), it->string);
8345 }
8346 else
8347 {
8348 if (it->c < 0)
8349 {
8350 IT_CHARPOS (*it) += it->cmp_it.nchars;
8351 IT_BYTEPOS (*it) += it->cmp_it.nbytes;
8352 if (it->bidi_p)
8353 {
8354 if (it->bidi_it.new_paragraph)
8355 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it,
8356 false);
8357 /* Resync the bidi iterator with IT's new position.
8358 FIXME: this doesn't support bidirectional text. */
8359 while (it->bidi_it.charpos < IT_CHARPOS (*it))
8360 bidi_move_to_visually_next (&it->bidi_it);
8361 }
8362 return false;
8363 }
8364 it->position = it->current.pos;
8365 it->object = it->w->contents;
8366 it->c = composition_update_it (&it->cmp_it, IT_CHARPOS (*it),
8367 IT_BYTEPOS (*it), Qnil);
8368 }
8369 return true;
8370 }
8371
8372
8373 \f
8374 /***********************************************************************
8375 Moving an iterator without producing glyphs
8376 ***********************************************************************/
8377
8378 /* Check if iterator is at a position corresponding to a valid buffer
8379 position after some move_it_ call. */
8380
8381 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8382 ((it)->method != GET_FROM_STRING || IT_STRING_CHARPOS (*it) == 0)
8383
8384
8385 /* Move iterator IT to a specified buffer or X position within one
8386 line on the display without producing glyphs.
8387
8388 OP should be a bit mask including some or all of these bits:
8389 MOVE_TO_X: Stop upon reaching x-position TO_X.
8390 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8391 Regardless of OP's value, stop upon reaching the end of the display line.
8392
8393 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8394 This means, in particular, that TO_X includes window's horizontal
8395 scroll amount.
8396
8397 The return value has several possible values that
8398 say what condition caused the scan to stop:
8399
8400 MOVE_POS_MATCH_OR_ZV
8401 - when TO_POS or ZV was reached.
8402
8403 MOVE_X_REACHED
8404 -when TO_X was reached before TO_POS or ZV were reached.
8405
8406 MOVE_LINE_CONTINUED
8407 - when we reached the end of the display area and the line must
8408 be continued.
8409
8410 MOVE_LINE_TRUNCATED
8411 - when we reached the end of the display area and the line is
8412 truncated.
8413
8414 MOVE_NEWLINE_OR_CR
8415 - when we stopped at a line end, i.e. a newline or a CR and selective
8416 display is on. */
8417
8418 static enum move_it_result
8419 move_it_in_display_line_to (struct it *it,
8420 ptrdiff_t to_charpos, int to_x,
8421 enum move_operation_enum op)
8422 {
8423 enum move_it_result result = MOVE_UNDEFINED;
8424 struct glyph_row *saved_glyph_row;
8425 struct it wrap_it, atpos_it, atx_it, ppos_it;
8426 void *wrap_data = NULL, *atpos_data = NULL, *atx_data = NULL;
8427 void *ppos_data = NULL;
8428 bool may_wrap = false;
8429 enum it_method prev_method = it->method;
8430 ptrdiff_t closest_pos IF_LINT (= 0), prev_pos = IT_CHARPOS (*it);
8431 bool saw_smaller_pos = prev_pos < to_charpos;
8432
8433 /* Don't produce glyphs in produce_glyphs. */
8434 saved_glyph_row = it->glyph_row;
8435 it->glyph_row = NULL;
8436
8437 /* Use wrap_it to save a copy of IT wherever a word wrap could
8438 occur. Use atpos_it to save a copy of IT at the desired buffer
8439 position, if found, so that we can scan ahead and check if the
8440 word later overshoots the window edge. Use atx_it similarly, for
8441 pixel positions. */
8442 wrap_it.sp = -1;
8443 atpos_it.sp = -1;
8444 atx_it.sp = -1;
8445
8446 /* Use ppos_it under bidi reordering to save a copy of IT for the
8447 initial position. We restore that position in IT when we have
8448 scanned the entire display line without finding a match for
8449 TO_CHARPOS and all the character positions are greater than
8450 TO_CHARPOS. We then restart the scan from the initial position,
8451 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8452 the closest to TO_CHARPOS. */
8453 if (it->bidi_p)
8454 {
8455 if ((op & MOVE_TO_POS) && IT_CHARPOS (*it) >= to_charpos)
8456 {
8457 SAVE_IT (ppos_it, *it, ppos_data);
8458 closest_pos = IT_CHARPOS (*it);
8459 }
8460 else
8461 closest_pos = ZV;
8462 }
8463
8464 #define BUFFER_POS_REACHED_P() \
8465 ((op & MOVE_TO_POS) != 0 \
8466 && BUFFERP (it->object) \
8467 && (IT_CHARPOS (*it) == to_charpos \
8468 || ((!it->bidi_p \
8469 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8470 && IT_CHARPOS (*it) > to_charpos) \
8471 || (it->what == IT_COMPOSITION \
8472 && ((IT_CHARPOS (*it) > to_charpos \
8473 && to_charpos >= it->cmp_it.charpos) \
8474 || (IT_CHARPOS (*it) < to_charpos \
8475 && to_charpos <= it->cmp_it.charpos)))) \
8476 && (it->method == GET_FROM_BUFFER \
8477 || (it->method == GET_FROM_DISPLAY_VECTOR \
8478 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8479
8480 /* If there's a line-/wrap-prefix, handle it. */
8481 if (it->hpos == 0 && it->method == GET_FROM_BUFFER
8482 && it->current_y < it->last_visible_y)
8483 handle_line_prefix (it);
8484
8485 if (IT_CHARPOS (*it) < CHARPOS (this_line_min_pos))
8486 SET_TEXT_POS (this_line_min_pos, IT_CHARPOS (*it), IT_BYTEPOS (*it));
8487
8488 while (true)
8489 {
8490 int x, i, ascent = 0, descent = 0;
8491
8492 /* Utility macro to reset an iterator with x, ascent, and descent. */
8493 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8494 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8495 (IT)->max_descent = descent)
8496
8497 /* Stop if we move beyond TO_CHARPOS (after an image or a
8498 display string or stretch glyph). */
8499 if ((op & MOVE_TO_POS) != 0
8500 && BUFFERP (it->object)
8501 && it->method == GET_FROM_BUFFER
8502 && (((!it->bidi_p
8503 /* When the iterator is at base embedding level, we
8504 are guaranteed that characters are delivered for
8505 display in strictly increasing order of their
8506 buffer positions. */
8507 || BIDI_AT_BASE_LEVEL (it->bidi_it))
8508 && IT_CHARPOS (*it) > to_charpos)
8509 || (it->bidi_p
8510 && (prev_method == GET_FROM_IMAGE
8511 || prev_method == GET_FROM_STRETCH
8512 || prev_method == GET_FROM_STRING)
8513 /* Passed TO_CHARPOS from left to right. */
8514 && ((prev_pos < to_charpos
8515 && IT_CHARPOS (*it) > to_charpos)
8516 /* Passed TO_CHARPOS from right to left. */
8517 || (prev_pos > to_charpos
8518 && IT_CHARPOS (*it) < to_charpos)))))
8519 {
8520 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8521 {
8522 result = MOVE_POS_MATCH_OR_ZV;
8523 break;
8524 }
8525 else if (it->line_wrap == WORD_WRAP && atpos_it.sp < 0)
8526 /* If wrap_it is valid, the current position might be in a
8527 word that is wrapped. So, save the iterator in
8528 atpos_it and continue to see if wrapping happens. */
8529 SAVE_IT (atpos_it, *it, atpos_data);
8530 }
8531
8532 /* Stop when ZV reached.
8533 We used to stop here when TO_CHARPOS reached as well, but that is
8534 too soon if this glyph does not fit on this line. So we handle it
8535 explicitly below. */
8536 if (!get_next_display_element (it))
8537 {
8538 result = MOVE_POS_MATCH_OR_ZV;
8539 break;
8540 }
8541
8542 if (it->line_wrap == TRUNCATE)
8543 {
8544 if (BUFFER_POS_REACHED_P ())
8545 {
8546 result = MOVE_POS_MATCH_OR_ZV;
8547 break;
8548 }
8549 }
8550 else
8551 {
8552 if (it->line_wrap == WORD_WRAP && it->area == TEXT_AREA)
8553 {
8554 if (IT_DISPLAYING_WHITESPACE (it))
8555 may_wrap = true;
8556 else if (may_wrap)
8557 {
8558 /* We have reached a glyph that follows one or more
8559 whitespace characters. If the position is
8560 already found, we are done. */
8561 if (atpos_it.sp >= 0)
8562 {
8563 RESTORE_IT (it, &atpos_it, atpos_data);
8564 result = MOVE_POS_MATCH_OR_ZV;
8565 goto done;
8566 }
8567 if (atx_it.sp >= 0)
8568 {
8569 RESTORE_IT (it, &atx_it, atx_data);
8570 result = MOVE_X_REACHED;
8571 goto done;
8572 }
8573 /* Otherwise, we can wrap here. */
8574 SAVE_IT (wrap_it, *it, wrap_data);
8575 may_wrap = false;
8576 }
8577 }
8578 }
8579
8580 /* Remember the line height for the current line, in case
8581 the next element doesn't fit on the line. */
8582 ascent = it->max_ascent;
8583 descent = it->max_descent;
8584
8585 /* The call to produce_glyphs will get the metrics of the
8586 display element IT is loaded with. Record the x-position
8587 before this display element, in case it doesn't fit on the
8588 line. */
8589 x = it->current_x;
8590
8591 PRODUCE_GLYPHS (it);
8592
8593 if (it->area != TEXT_AREA)
8594 {
8595 prev_method = it->method;
8596 if (it->method == GET_FROM_BUFFER)
8597 prev_pos = IT_CHARPOS (*it);
8598 set_iterator_to_next (it, true);
8599 if (IT_CHARPOS (*it) < CHARPOS (this_line_min_pos))
8600 SET_TEXT_POS (this_line_min_pos,
8601 IT_CHARPOS (*it), IT_BYTEPOS (*it));
8602 if (it->bidi_p
8603 && (op & MOVE_TO_POS)
8604 && IT_CHARPOS (*it) > to_charpos
8605 && IT_CHARPOS (*it) < closest_pos)
8606 closest_pos = IT_CHARPOS (*it);
8607 continue;
8608 }
8609
8610 /* The number of glyphs we get back in IT->nglyphs will normally
8611 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8612 character on a terminal frame, or (iii) a line end. For the
8613 second case, IT->nglyphs - 1 padding glyphs will be present.
8614 (On X frames, there is only one glyph produced for a
8615 composite character.)
8616
8617 The behavior implemented below means, for continuation lines,
8618 that as many spaces of a TAB as fit on the current line are
8619 displayed there. For terminal frames, as many glyphs of a
8620 multi-glyph character are displayed in the current line, too.
8621 This is what the old redisplay code did, and we keep it that
8622 way. Under X, the whole shape of a complex character must
8623 fit on the line or it will be completely displayed in the
8624 next line.
8625
8626 Note that both for tabs and padding glyphs, all glyphs have
8627 the same width. */
8628 if (it->nglyphs)
8629 {
8630 /* More than one glyph or glyph doesn't fit on line. All
8631 glyphs have the same width. */
8632 int single_glyph_width = it->pixel_width / it->nglyphs;
8633 int new_x;
8634 int x_before_this_char = x;
8635 int hpos_before_this_char = it->hpos;
8636
8637 for (i = 0; i < it->nglyphs; ++i, x = new_x)
8638 {
8639 new_x = x + single_glyph_width;
8640
8641 /* We want to leave anything reaching TO_X to the caller. */
8642 if ((op & MOVE_TO_X) && new_x > to_x)
8643 {
8644 if (BUFFER_POS_REACHED_P ())
8645 {
8646 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8647 goto buffer_pos_reached;
8648 if (atpos_it.sp < 0)
8649 {
8650 SAVE_IT (atpos_it, *it, atpos_data);
8651 IT_RESET_X_ASCENT_DESCENT (&atpos_it);
8652 }
8653 }
8654 else
8655 {
8656 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8657 {
8658 it->current_x = x;
8659 result = MOVE_X_REACHED;
8660 break;
8661 }
8662 if (atx_it.sp < 0)
8663 {
8664 SAVE_IT (atx_it, *it, atx_data);
8665 IT_RESET_X_ASCENT_DESCENT (&atx_it);
8666 }
8667 }
8668 }
8669
8670 if (/* Lines are continued. */
8671 it->line_wrap != TRUNCATE
8672 && (/* And glyph doesn't fit on the line. */
8673 new_x > it->last_visible_x
8674 /* Or it fits exactly and we're on a window
8675 system frame. */
8676 || (new_x == it->last_visible_x
8677 && FRAME_WINDOW_P (it->f)
8678 && ((it->bidi_p && it->bidi_it.paragraph_dir == R2L)
8679 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
8680 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)))))
8681 {
8682 if (/* IT->hpos == 0 means the very first glyph
8683 doesn't fit on the line, e.g. a wide image. */
8684 it->hpos == 0
8685 || (new_x == it->last_visible_x
8686 && FRAME_WINDOW_P (it->f)))
8687 {
8688 ++it->hpos;
8689 it->current_x = new_x;
8690
8691 /* The character's last glyph just barely fits
8692 in this row. */
8693 if (i == it->nglyphs - 1)
8694 {
8695 /* If this is the destination position,
8696 return a position *before* it in this row,
8697 now that we know it fits in this row. */
8698 if (BUFFER_POS_REACHED_P ())
8699 {
8700 if (it->line_wrap != WORD_WRAP
8701 || wrap_it.sp < 0
8702 /* If we've just found whitespace to
8703 wrap, effectively ignore the
8704 previous wrap point -- it is no
8705 longer relevant, but we won't
8706 have an opportunity to update it,
8707 since we've reached the edge of
8708 this screen line. */
8709 || (may_wrap
8710 && IT_OVERFLOW_NEWLINE_INTO_FRINGE (it)))
8711 {
8712 it->hpos = hpos_before_this_char;
8713 it->current_x = x_before_this_char;
8714 result = MOVE_POS_MATCH_OR_ZV;
8715 break;
8716 }
8717 if (it->line_wrap == WORD_WRAP
8718 && atpos_it.sp < 0)
8719 {
8720 SAVE_IT (atpos_it, *it, atpos_data);
8721 atpos_it.current_x = x_before_this_char;
8722 atpos_it.hpos = hpos_before_this_char;
8723 }
8724 }
8725
8726 prev_method = it->method;
8727 if (it->method == GET_FROM_BUFFER)
8728 prev_pos = IT_CHARPOS (*it);
8729 set_iterator_to_next (it, true);
8730 if (IT_CHARPOS (*it) < CHARPOS (this_line_min_pos))
8731 SET_TEXT_POS (this_line_min_pos,
8732 IT_CHARPOS (*it), IT_BYTEPOS (*it));
8733 /* On graphical terminals, newlines may
8734 "overflow" into the fringe if
8735 overflow-newline-into-fringe is non-nil.
8736 On text terminals, and on graphical
8737 terminals with no right margin, newlines
8738 may overflow into the last glyph on the
8739 display line.*/
8740 if (!FRAME_WINDOW_P (it->f)
8741 || ((it->bidi_p
8742 && it->bidi_it.paragraph_dir == R2L)
8743 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
8744 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0
8745 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
8746 {
8747 if (!get_next_display_element (it))
8748 {
8749 result = MOVE_POS_MATCH_OR_ZV;
8750 break;
8751 }
8752 if (BUFFER_POS_REACHED_P ())
8753 {
8754 if (ITERATOR_AT_END_OF_LINE_P (it))
8755 result = MOVE_POS_MATCH_OR_ZV;
8756 else
8757 result = MOVE_LINE_CONTINUED;
8758 break;
8759 }
8760 if (ITERATOR_AT_END_OF_LINE_P (it)
8761 && (it->line_wrap != WORD_WRAP
8762 || wrap_it.sp < 0
8763 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it)))
8764 {
8765 result = MOVE_NEWLINE_OR_CR;
8766 break;
8767 }
8768 }
8769 }
8770 }
8771 else
8772 IT_RESET_X_ASCENT_DESCENT (it);
8773
8774 /* If the screen line ends with whitespace, and we
8775 are under word-wrap, don't use wrap_it: it is no
8776 longer relevant, but we won't have an opportunity
8777 to update it, since we are done with this screen
8778 line. */
8779 if (may_wrap && IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
8780 {
8781 /* If we've found TO_X, go back there, as we now
8782 know the last word fits on this screen line. */
8783 if ((op & MOVE_TO_X) && new_x == it->last_visible_x
8784 && atx_it.sp >= 0)
8785 {
8786 RESTORE_IT (it, &atx_it, atx_data);
8787 atpos_it.sp = -1;
8788 atx_it.sp = -1;
8789 result = MOVE_X_REACHED;
8790 break;
8791 }
8792 }
8793 else if (wrap_it.sp >= 0)
8794 {
8795 RESTORE_IT (it, &wrap_it, wrap_data);
8796 atpos_it.sp = -1;
8797 atx_it.sp = -1;
8798 }
8799
8800 TRACE_MOVE ((stderr, "move_it_in: continued at %d\n",
8801 IT_CHARPOS (*it)));
8802 result = MOVE_LINE_CONTINUED;
8803 break;
8804 }
8805
8806 if (BUFFER_POS_REACHED_P ())
8807 {
8808 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8809 goto buffer_pos_reached;
8810 if (it->line_wrap == WORD_WRAP && atpos_it.sp < 0)
8811 {
8812 SAVE_IT (atpos_it, *it, atpos_data);
8813 IT_RESET_X_ASCENT_DESCENT (&atpos_it);
8814 }
8815 }
8816
8817 if (new_x > it->first_visible_x)
8818 {
8819 /* Glyph is visible. Increment number of glyphs that
8820 would be displayed. */
8821 ++it->hpos;
8822 }
8823 }
8824
8825 if (result != MOVE_UNDEFINED)
8826 break;
8827 }
8828 else if (BUFFER_POS_REACHED_P ())
8829 {
8830 buffer_pos_reached:
8831 IT_RESET_X_ASCENT_DESCENT (it);
8832 result = MOVE_POS_MATCH_OR_ZV;
8833 break;
8834 }
8835 else if ((op & MOVE_TO_X) && it->current_x >= to_x)
8836 {
8837 /* Stop when TO_X specified and reached. This check is
8838 necessary here because of lines consisting of a line end,
8839 only. The line end will not produce any glyphs and we
8840 would never get MOVE_X_REACHED. */
8841 eassert (it->nglyphs == 0);
8842 result = MOVE_X_REACHED;
8843 break;
8844 }
8845
8846 /* Is this a line end? If yes, we're done. */
8847 if (ITERATOR_AT_END_OF_LINE_P (it))
8848 {
8849 /* If we are past TO_CHARPOS, but never saw any character
8850 positions smaller than TO_CHARPOS, return
8851 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8852 did. */
8853 if (it->bidi_p && (op & MOVE_TO_POS) != 0)
8854 {
8855 if (!saw_smaller_pos && IT_CHARPOS (*it) > to_charpos)
8856 {
8857 if (closest_pos < ZV)
8858 {
8859 RESTORE_IT (it, &ppos_it, ppos_data);
8860 /* Don't recurse if closest_pos is equal to
8861 to_charpos, since we have just tried that. */
8862 if (closest_pos != to_charpos)
8863 move_it_in_display_line_to (it, closest_pos, -1,
8864 MOVE_TO_POS);
8865 result = MOVE_POS_MATCH_OR_ZV;
8866 }
8867 else
8868 goto buffer_pos_reached;
8869 }
8870 else if (it->line_wrap == WORD_WRAP && atpos_it.sp >= 0
8871 && IT_CHARPOS (*it) > to_charpos)
8872 goto buffer_pos_reached;
8873 else
8874 result = MOVE_NEWLINE_OR_CR;
8875 }
8876 else
8877 result = MOVE_NEWLINE_OR_CR;
8878 break;
8879 }
8880
8881 prev_method = it->method;
8882 if (it->method == GET_FROM_BUFFER)
8883 prev_pos = IT_CHARPOS (*it);
8884 /* The current display element has been consumed. Advance
8885 to the next. */
8886 set_iterator_to_next (it, true);
8887 if (IT_CHARPOS (*it) < CHARPOS (this_line_min_pos))
8888 SET_TEXT_POS (this_line_min_pos, IT_CHARPOS (*it), IT_BYTEPOS (*it));
8889 if (IT_CHARPOS (*it) < to_charpos)
8890 saw_smaller_pos = true;
8891 if (it->bidi_p
8892 && (op & MOVE_TO_POS)
8893 && IT_CHARPOS (*it) >= to_charpos
8894 && IT_CHARPOS (*it) < closest_pos)
8895 closest_pos = IT_CHARPOS (*it);
8896
8897 /* Stop if lines are truncated and IT's current x-position is
8898 past the right edge of the window now. */
8899 if (it->line_wrap == TRUNCATE
8900 && it->current_x >= it->last_visible_x)
8901 {
8902 if (!FRAME_WINDOW_P (it->f)
8903 || ((it->bidi_p && it->bidi_it.paragraph_dir == R2L)
8904 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
8905 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0
8906 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
8907 {
8908 bool at_eob_p = false;
8909
8910 if ((at_eob_p = !get_next_display_element (it))
8911 || BUFFER_POS_REACHED_P ()
8912 /* If we are past TO_CHARPOS, but never saw any
8913 character positions smaller than TO_CHARPOS,
8914 return MOVE_POS_MATCH_OR_ZV, like the
8915 unidirectional display did. */
8916 || (it->bidi_p && (op & MOVE_TO_POS) != 0
8917 && !saw_smaller_pos
8918 && IT_CHARPOS (*it) > to_charpos))
8919 {
8920 if (it->bidi_p
8921 && !BUFFER_POS_REACHED_P ()
8922 && !at_eob_p && closest_pos < ZV)
8923 {
8924 RESTORE_IT (it, &ppos_it, ppos_data);
8925 if (closest_pos != to_charpos)
8926 move_it_in_display_line_to (it, closest_pos, -1,
8927 MOVE_TO_POS);
8928 }
8929 result = MOVE_POS_MATCH_OR_ZV;
8930 break;
8931 }
8932 if (ITERATOR_AT_END_OF_LINE_P (it))
8933 {
8934 result = MOVE_NEWLINE_OR_CR;
8935 break;
8936 }
8937 }
8938 else if (it->bidi_p && (op & MOVE_TO_POS) != 0
8939 && !saw_smaller_pos
8940 && IT_CHARPOS (*it) > to_charpos)
8941 {
8942 if (closest_pos < ZV)
8943 {
8944 RESTORE_IT (it, &ppos_it, ppos_data);
8945 if (closest_pos != to_charpos)
8946 move_it_in_display_line_to (it, closest_pos, -1,
8947 MOVE_TO_POS);
8948 }
8949 result = MOVE_POS_MATCH_OR_ZV;
8950 break;
8951 }
8952 result = MOVE_LINE_TRUNCATED;
8953 break;
8954 }
8955 #undef IT_RESET_X_ASCENT_DESCENT
8956 }
8957
8958 #undef BUFFER_POS_REACHED_P
8959
8960 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8961 restore the saved iterator. */
8962 if (atpos_it.sp >= 0)
8963 RESTORE_IT (it, &atpos_it, atpos_data);
8964 else if (atx_it.sp >= 0)
8965 RESTORE_IT (it, &atx_it, atx_data);
8966
8967 done:
8968
8969 if (atpos_data)
8970 bidi_unshelve_cache (atpos_data, true);
8971 if (atx_data)
8972 bidi_unshelve_cache (atx_data, true);
8973 if (wrap_data)
8974 bidi_unshelve_cache (wrap_data, true);
8975 if (ppos_data)
8976 bidi_unshelve_cache (ppos_data, true);
8977
8978 /* Restore the iterator settings altered at the beginning of this
8979 function. */
8980 it->glyph_row = saved_glyph_row;
8981 return result;
8982 }
8983
8984 /* For external use. */
8985 void
8986 move_it_in_display_line (struct it *it,
8987 ptrdiff_t to_charpos, int to_x,
8988 enum move_operation_enum op)
8989 {
8990 if (it->line_wrap == WORD_WRAP
8991 && (op & MOVE_TO_X))
8992 {
8993 struct it save_it;
8994 void *save_data = NULL;
8995 int skip;
8996
8997 SAVE_IT (save_it, *it, save_data);
8998 skip = move_it_in_display_line_to (it, to_charpos, to_x, op);
8999 /* When word-wrap is on, TO_X may lie past the end
9000 of a wrapped line. Then it->current is the
9001 character on the next line, so backtrack to the
9002 space before the wrap point. */
9003 if (skip == MOVE_LINE_CONTINUED)
9004 {
9005 int prev_x = max (it->current_x - 1, 0);
9006 RESTORE_IT (it, &save_it, save_data);
9007 move_it_in_display_line_to
9008 (it, -1, prev_x, MOVE_TO_X);
9009 }
9010 else
9011 bidi_unshelve_cache (save_data, true);
9012 }
9013 else
9014 move_it_in_display_line_to (it, to_charpos, to_x, op);
9015 }
9016
9017
9018 /* Move IT forward until it satisfies one or more of the criteria in
9019 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9020
9021 OP is a bit-mask that specifies where to stop, and in particular,
9022 which of those four position arguments makes a difference. See the
9023 description of enum move_operation_enum.
9024
9025 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9026 screen line, this function will set IT to the next position that is
9027 displayed to the right of TO_CHARPOS on the screen.
9028
9029 Return the maximum pixel length of any line scanned but never more
9030 than it.last_visible_x. */
9031
9032 int
9033 move_it_to (struct it *it, ptrdiff_t to_charpos, int to_x, int to_y, int to_vpos, int op)
9034 {
9035 enum move_it_result skip, skip2 = MOVE_X_REACHED;
9036 int line_height, line_start_x = 0, reached = 0;
9037 int max_current_x = 0;
9038 void *backup_data = NULL;
9039
9040 for (;;)
9041 {
9042 if (op & MOVE_TO_VPOS)
9043 {
9044 /* If no TO_CHARPOS and no TO_X specified, stop at the
9045 start of the line TO_VPOS. */
9046 if ((op & (MOVE_TO_X | MOVE_TO_POS)) == 0)
9047 {
9048 if (it->vpos == to_vpos)
9049 {
9050 reached = 1;
9051 break;
9052 }
9053 else
9054 skip = move_it_in_display_line_to (it, -1, -1, 0);
9055 }
9056 else
9057 {
9058 /* TO_VPOS >= 0 means stop at TO_X in the line at
9059 TO_VPOS, or at TO_POS, whichever comes first. */
9060 if (it->vpos == to_vpos)
9061 {
9062 reached = 2;
9063 break;
9064 }
9065
9066 skip = move_it_in_display_line_to (it, to_charpos, to_x, op);
9067
9068 if (skip == MOVE_POS_MATCH_OR_ZV || it->vpos == to_vpos)
9069 {
9070 reached = 3;
9071 break;
9072 }
9073 else if (skip == MOVE_X_REACHED && it->vpos != to_vpos)
9074 {
9075 /* We have reached TO_X but not in the line we want. */
9076 skip = move_it_in_display_line_to (it, to_charpos,
9077 -1, MOVE_TO_POS);
9078 if (skip == MOVE_POS_MATCH_OR_ZV)
9079 {
9080 reached = 4;
9081 break;
9082 }
9083 }
9084 }
9085 }
9086 else if (op & MOVE_TO_Y)
9087 {
9088 struct it it_backup;
9089
9090 if (it->line_wrap == WORD_WRAP)
9091 SAVE_IT (it_backup, *it, backup_data);
9092
9093 /* TO_Y specified means stop at TO_X in the line containing
9094 TO_Y---or at TO_CHARPOS if this is reached first. The
9095 problem is that we can't really tell whether the line
9096 contains TO_Y before we have completely scanned it, and
9097 this may skip past TO_X. What we do is to first scan to
9098 TO_X.
9099
9100 If TO_X is not specified, use a TO_X of zero. The reason
9101 is to make the outcome of this function more predictable.
9102 If we didn't use TO_X == 0, we would stop at the end of
9103 the line which is probably not what a caller would expect
9104 to happen. */
9105 skip = move_it_in_display_line_to
9106 (it, to_charpos, ((op & MOVE_TO_X) ? to_x : 0),
9107 (MOVE_TO_X | (op & MOVE_TO_POS)));
9108
9109 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9110 if (skip == MOVE_POS_MATCH_OR_ZV)
9111 reached = 5;
9112 else if (skip == MOVE_X_REACHED)
9113 {
9114 /* If TO_X was reached, we want to know whether TO_Y is
9115 in the line. We know this is the case if the already
9116 scanned glyphs make the line tall enough. Otherwise,
9117 we must check by scanning the rest of the line. */
9118 line_height = it->max_ascent + it->max_descent;
9119 if (to_y >= it->current_y
9120 && to_y < it->current_y + line_height)
9121 {
9122 reached = 6;
9123 break;
9124 }
9125 SAVE_IT (it_backup, *it, backup_data);
9126 TRACE_MOVE ((stderr, "move_it: from %d\n", IT_CHARPOS (*it)));
9127 skip2 = move_it_in_display_line_to (it, to_charpos, -1,
9128 op & MOVE_TO_POS);
9129 TRACE_MOVE ((stderr, "move_it: to %d\n", IT_CHARPOS (*it)));
9130 line_height = it->max_ascent + it->max_descent;
9131 TRACE_MOVE ((stderr, "move_it: line_height = %d\n", line_height));
9132
9133 if (to_y >= it->current_y
9134 && to_y < it->current_y + line_height)
9135 {
9136 /* If TO_Y is in this line and TO_X was reached
9137 above, we scanned too far. We have to restore
9138 IT's settings to the ones before skipping. But
9139 keep the more accurate values of max_ascent and
9140 max_descent we've found while skipping the rest
9141 of the line, for the sake of callers, such as
9142 pos_visible_p, that need to know the line
9143 height. */
9144 int max_ascent = it->max_ascent;
9145 int max_descent = it->max_descent;
9146
9147 RESTORE_IT (it, &it_backup, backup_data);
9148 it->max_ascent = max_ascent;
9149 it->max_descent = max_descent;
9150 reached = 6;
9151 }
9152 else
9153 {
9154 skip = skip2;
9155 if (skip == MOVE_POS_MATCH_OR_ZV)
9156 reached = 7;
9157 }
9158 }
9159 else
9160 {
9161 /* Check whether TO_Y is in this line. */
9162 line_height = it->max_ascent + it->max_descent;
9163 TRACE_MOVE ((stderr, "move_it: line_height = %d\n", line_height));
9164
9165 if (to_y >= it->current_y
9166 && to_y < it->current_y + line_height)
9167 {
9168 if (to_y > it->current_y)
9169 max_current_x = max (it->current_x, max_current_x);
9170
9171 /* When word-wrap is on, TO_X may lie past the end
9172 of a wrapped line. Then it->current is the
9173 character on the next line, so backtrack to the
9174 space before the wrap point. */
9175 if (skip == MOVE_LINE_CONTINUED
9176 && it->line_wrap == WORD_WRAP)
9177 {
9178 int prev_x = max (it->current_x - 1, 0);
9179 RESTORE_IT (it, &it_backup, backup_data);
9180 skip = move_it_in_display_line_to
9181 (it, -1, prev_x, MOVE_TO_X);
9182 }
9183
9184 reached = 6;
9185 }
9186 }
9187
9188 if (reached)
9189 {
9190 max_current_x = max (it->current_x, max_current_x);
9191 break;
9192 }
9193 }
9194 else if (BUFFERP (it->object)
9195 && (it->method == GET_FROM_BUFFER
9196 || it->method == GET_FROM_STRETCH)
9197 && IT_CHARPOS (*it) >= to_charpos
9198 /* Under bidi iteration, a call to set_iterator_to_next
9199 can scan far beyond to_charpos if the initial
9200 portion of the next line needs to be reordered. In
9201 that case, give move_it_in_display_line_to another
9202 chance below. */
9203 && !(it->bidi_p
9204 && it->bidi_it.scan_dir == -1))
9205 skip = MOVE_POS_MATCH_OR_ZV;
9206 else
9207 skip = move_it_in_display_line_to (it, to_charpos, -1, MOVE_TO_POS);
9208
9209 switch (skip)
9210 {
9211 case MOVE_POS_MATCH_OR_ZV:
9212 max_current_x = max (it->current_x, max_current_x);
9213 reached = 8;
9214 goto out;
9215
9216 case MOVE_NEWLINE_OR_CR:
9217 max_current_x = max (it->current_x, max_current_x);
9218 set_iterator_to_next (it, true);
9219 it->continuation_lines_width = 0;
9220 break;
9221
9222 case MOVE_LINE_TRUNCATED:
9223 max_current_x = it->last_visible_x;
9224 it->continuation_lines_width = 0;
9225 reseat_at_next_visible_line_start (it, false);
9226 if ((op & MOVE_TO_POS) != 0
9227 && IT_CHARPOS (*it) > to_charpos)
9228 {
9229 reached = 9;
9230 goto out;
9231 }
9232 break;
9233
9234 case MOVE_LINE_CONTINUED:
9235 max_current_x = it->last_visible_x;
9236 /* For continued lines ending in a tab, some of the glyphs
9237 associated with the tab are displayed on the current
9238 line. Since it->current_x does not include these glyphs,
9239 we use it->last_visible_x instead. */
9240 if (it->c == '\t')
9241 {
9242 it->continuation_lines_width += it->last_visible_x;
9243 /* When moving by vpos, ensure that the iterator really
9244 advances to the next line (bug#847, bug#969). Fixme:
9245 do we need to do this in other circumstances? */
9246 if (it->current_x != it->last_visible_x
9247 && (op & MOVE_TO_VPOS)
9248 && !(op & (MOVE_TO_X | MOVE_TO_POS)))
9249 {
9250 line_start_x = it->current_x + it->pixel_width
9251 - it->last_visible_x;
9252 if (FRAME_WINDOW_P (it->f))
9253 {
9254 struct face *face = FACE_FROM_ID (it->f, it->face_id);
9255 struct font *face_font = face->font;
9256
9257 /* When display_line produces a continued line
9258 that ends in a TAB, it skips a tab stop that
9259 is closer than the font's space character
9260 width (see x_produce_glyphs where it produces
9261 the stretch glyph which represents a TAB).
9262 We need to reproduce the same logic here. */
9263 eassert (face_font);
9264 if (face_font)
9265 {
9266 if (line_start_x < face_font->space_width)
9267 line_start_x
9268 += it->tab_width * face_font->space_width;
9269 }
9270 }
9271 set_iterator_to_next (it, false);
9272 }
9273 }
9274 else
9275 it->continuation_lines_width += it->current_x;
9276 break;
9277
9278 default:
9279 emacs_abort ();
9280 }
9281
9282 /* Reset/increment for the next run. */
9283 recenter_overlay_lists (current_buffer, IT_CHARPOS (*it));
9284 it->current_x = line_start_x;
9285 line_start_x = 0;
9286 it->hpos = 0;
9287 it->current_y += it->max_ascent + it->max_descent;
9288 ++it->vpos;
9289 last_height = it->max_ascent + it->max_descent;
9290 it->max_ascent = it->max_descent = 0;
9291 }
9292
9293 out:
9294
9295 /* On text terminals, we may stop at the end of a line in the middle
9296 of a multi-character glyph. If the glyph itself is continued,
9297 i.e. it is actually displayed on the next line, don't treat this
9298 stopping point as valid; move to the next line instead (unless
9299 that brings us offscreen). */
9300 if (!FRAME_WINDOW_P (it->f)
9301 && op & MOVE_TO_POS
9302 && IT_CHARPOS (*it) == to_charpos
9303 && it->what == IT_CHARACTER
9304 && it->nglyphs > 1
9305 && it->line_wrap == WINDOW_WRAP
9306 && it->current_x == it->last_visible_x - 1
9307 && it->c != '\n'
9308 && it->c != '\t'
9309 && it->w->window_end_valid
9310 && it->vpos < it->w->window_end_vpos)
9311 {
9312 it->continuation_lines_width += it->current_x;
9313 it->current_x = it->hpos = it->max_ascent = it->max_descent = 0;
9314 it->current_y += it->max_ascent + it->max_descent;
9315 ++it->vpos;
9316 last_height = it->max_ascent + it->max_descent;
9317 }
9318
9319 if (backup_data)
9320 bidi_unshelve_cache (backup_data, true);
9321
9322 TRACE_MOVE ((stderr, "move_it_to: reached %d\n", reached));
9323
9324 return max_current_x;
9325 }
9326
9327
9328 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9329
9330 If DY > 0, move IT backward at least that many pixels. DY = 0
9331 means move IT backward to the preceding line start or BEGV. This
9332 function may move over more than DY pixels if IT->current_y - DY
9333 ends up in the middle of a line; in this case IT->current_y will be
9334 set to the top of the line moved to. */
9335
9336 void
9337 move_it_vertically_backward (struct it *it, int dy)
9338 {
9339 int nlines, h;
9340 struct it it2, it3;
9341 void *it2data = NULL, *it3data = NULL;
9342 ptrdiff_t start_pos;
9343 int nchars_per_row
9344 = (it->last_visible_x - it->first_visible_x) / FRAME_COLUMN_WIDTH (it->f);
9345 ptrdiff_t pos_limit;
9346
9347 move_further_back:
9348 eassert (dy >= 0);
9349
9350 start_pos = IT_CHARPOS (*it);
9351
9352 /* Estimate how many newlines we must move back. */
9353 nlines = max (1, dy / default_line_pixel_height (it->w));
9354 if (it->line_wrap == TRUNCATE || nchars_per_row == 0)
9355 pos_limit = BEGV;
9356 else
9357 pos_limit = max (start_pos - nlines * nchars_per_row, BEGV);
9358
9359 /* Set the iterator's position that many lines back. But don't go
9360 back more than NLINES full screen lines -- this wins a day with
9361 buffers which have very long lines. */
9362 while (nlines-- && IT_CHARPOS (*it) > pos_limit)
9363 back_to_previous_visible_line_start (it);
9364
9365 /* Reseat the iterator here. When moving backward, we don't want
9366 reseat to skip forward over invisible text, set up the iterator
9367 to deliver from overlay strings at the new position etc. So,
9368 use reseat_1 here. */
9369 reseat_1 (it, it->current.pos, true);
9370
9371 /* We are now surely at a line start. */
9372 it->current_x = it->hpos = 0; /* FIXME: this is incorrect when bidi
9373 reordering is in effect. */
9374 it->continuation_lines_width = 0;
9375
9376 /* Move forward and see what y-distance we moved. First move to the
9377 start of the next line so that we get its height. We need this
9378 height to be able to tell whether we reached the specified
9379 y-distance. */
9380 SAVE_IT (it2, *it, it2data);
9381 it2.max_ascent = it2.max_descent = 0;
9382 do
9383 {
9384 move_it_to (&it2, start_pos, -1, -1, it2.vpos + 1,
9385 MOVE_TO_POS | MOVE_TO_VPOS);
9386 }
9387 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2)
9388 /* If we are in a display string which starts at START_POS,
9389 and that display string includes a newline, and we are
9390 right after that newline (i.e. at the beginning of a
9391 display line), exit the loop, because otherwise we will
9392 infloop, since move_it_to will see that it is already at
9393 START_POS and will not move. */
9394 || (it2.method == GET_FROM_STRING
9395 && IT_CHARPOS (it2) == start_pos
9396 && SREF (it2.string, IT_STRING_BYTEPOS (it2) - 1) == '\n')));
9397 eassert (IT_CHARPOS (*it) >= BEGV);
9398 SAVE_IT (it3, it2, it3data);
9399
9400 move_it_to (&it2, start_pos, -1, -1, -1, MOVE_TO_POS);
9401 eassert (IT_CHARPOS (*it) >= BEGV);
9402 /* H is the actual vertical distance from the position in *IT
9403 and the starting position. */
9404 h = it2.current_y - it->current_y;
9405 /* NLINES is the distance in number of lines. */
9406 nlines = it2.vpos - it->vpos;
9407
9408 /* Correct IT's y and vpos position
9409 so that they are relative to the starting point. */
9410 it->vpos -= nlines;
9411 it->current_y -= h;
9412
9413 if (dy == 0)
9414 {
9415 /* DY == 0 means move to the start of the screen line. The
9416 value of nlines is > 0 if continuation lines were involved,
9417 or if the original IT position was at start of a line. */
9418 RESTORE_IT (it, it, it2data);
9419 if (nlines > 0)
9420 move_it_by_lines (it, nlines);
9421 /* The above code moves us to some position NLINES down,
9422 usually to its first glyph (leftmost in an L2R line), but
9423 that's not necessarily the start of the line, under bidi
9424 reordering. We want to get to the character position
9425 that is immediately after the newline of the previous
9426 line. */
9427 if (it->bidi_p
9428 && !it->continuation_lines_width
9429 && !STRINGP (it->string)
9430 && IT_CHARPOS (*it) > BEGV
9431 && FETCH_BYTE (IT_BYTEPOS (*it) - 1) != '\n')
9432 {
9433 ptrdiff_t cp = IT_CHARPOS (*it), bp = IT_BYTEPOS (*it);
9434
9435 DEC_BOTH (cp, bp);
9436 cp = find_newline_no_quit (cp, bp, -1, NULL);
9437 move_it_to (it, cp, -1, -1, -1, MOVE_TO_POS);
9438 }
9439 bidi_unshelve_cache (it3data, true);
9440 }
9441 else
9442 {
9443 /* The y-position we try to reach, relative to *IT.
9444 Note that H has been subtracted in front of the if-statement. */
9445 int target_y = it->current_y + h - dy;
9446 int y0 = it3.current_y;
9447 int y1;
9448 int line_height;
9449
9450 RESTORE_IT (&it3, &it3, it3data);
9451 y1 = line_bottom_y (&it3);
9452 line_height = y1 - y0;
9453 RESTORE_IT (it, it, it2data);
9454 /* If we did not reach target_y, try to move further backward if
9455 we can. If we moved too far backward, try to move forward. */
9456 if (target_y < it->current_y
9457 /* This is heuristic. In a window that's 3 lines high, with
9458 a line height of 13 pixels each, recentering with point
9459 on the bottom line will try to move -39/2 = 19 pixels
9460 backward. Try to avoid moving into the first line. */
9461 && (it->current_y - target_y
9462 > min (window_box_height (it->w), line_height * 2 / 3))
9463 && IT_CHARPOS (*it) > BEGV)
9464 {
9465 TRACE_MOVE ((stderr, " not far enough -> move_vert %d\n",
9466 target_y - it->current_y));
9467 dy = it->current_y - target_y;
9468 goto move_further_back;
9469 }
9470 else if (target_y >= it->current_y + line_height
9471 && IT_CHARPOS (*it) < ZV)
9472 {
9473 /* Should move forward by at least one line, maybe more.
9474
9475 Note: Calling move_it_by_lines can be expensive on
9476 terminal frames, where compute_motion is used (via
9477 vmotion) to do the job, when there are very long lines
9478 and truncate-lines is nil. That's the reason for
9479 treating terminal frames specially here. */
9480
9481 if (!FRAME_WINDOW_P (it->f))
9482 move_it_vertically (it, target_y - it->current_y);
9483 else
9484 {
9485 do
9486 {
9487 move_it_by_lines (it, 1);
9488 }
9489 while (target_y >= line_bottom_y (it) && IT_CHARPOS (*it) < ZV);
9490 }
9491 }
9492 }
9493 }
9494
9495
9496 /* Move IT by a specified amount of pixel lines DY. DY negative means
9497 move backwards. DY = 0 means move to start of screen line. At the
9498 end, IT will be on the start of a screen line. */
9499
9500 void
9501 move_it_vertically (struct it *it, int dy)
9502 {
9503 if (dy <= 0)
9504 move_it_vertically_backward (it, -dy);
9505 else
9506 {
9507 TRACE_MOVE ((stderr, "move_it_v: from %d, %d\n", IT_CHARPOS (*it), dy));
9508 move_it_to (it, ZV, -1, it->current_y + dy, -1,
9509 MOVE_TO_POS | MOVE_TO_Y);
9510 TRACE_MOVE ((stderr, "move_it_v: to %d\n", IT_CHARPOS (*it)));
9511
9512 /* If buffer ends in ZV without a newline, move to the start of
9513 the line to satisfy the post-condition. */
9514 if (IT_CHARPOS (*it) == ZV
9515 && ZV > BEGV
9516 && FETCH_BYTE (IT_BYTEPOS (*it) - 1) != '\n')
9517 move_it_by_lines (it, 0);
9518 }
9519 }
9520
9521
9522 /* Move iterator IT past the end of the text line it is in. */
9523
9524 void
9525 move_it_past_eol (struct it *it)
9526 {
9527 enum move_it_result rc;
9528
9529 rc = move_it_in_display_line_to (it, Z, 0, MOVE_TO_POS);
9530 if (rc == MOVE_NEWLINE_OR_CR)
9531 set_iterator_to_next (it, false);
9532 }
9533
9534
9535 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9536 negative means move up. DVPOS == 0 means move to the start of the
9537 screen line.
9538
9539 Optimization idea: If we would know that IT->f doesn't use
9540 a face with proportional font, we could be faster for
9541 truncate-lines nil. */
9542
9543 void
9544 move_it_by_lines (struct it *it, ptrdiff_t dvpos)
9545 {
9546
9547 /* The commented-out optimization uses vmotion on terminals. This
9548 gives bad results, because elements like it->what, on which
9549 callers such as pos_visible_p rely, aren't updated. */
9550 /* struct position pos;
9551 if (!FRAME_WINDOW_P (it->f))
9552 {
9553 struct text_pos textpos;
9554
9555 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9556 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9557 reseat (it, textpos, true);
9558 it->vpos += pos.vpos;
9559 it->current_y += pos.vpos;
9560 }
9561 else */
9562
9563 if (dvpos == 0)
9564 {
9565 /* DVPOS == 0 means move to the start of the screen line. */
9566 move_it_vertically_backward (it, 0);
9567 /* Let next call to line_bottom_y calculate real line height. */
9568 last_height = 0;
9569 }
9570 else if (dvpos > 0)
9571 {
9572 move_it_to (it, -1, -1, -1, it->vpos + dvpos, MOVE_TO_VPOS);
9573 if (!IT_POS_VALID_AFTER_MOVE_P (it))
9574 {
9575 /* Only move to the next buffer position if we ended up in a
9576 string from display property, not in an overlay string
9577 (before-string or after-string). That is because the
9578 latter don't conceal the underlying buffer position, so
9579 we can ask to move the iterator to the exact position we
9580 are interested in. Note that, even if we are already at
9581 IT_CHARPOS (*it), the call below is not a no-op, as it
9582 will detect that we are at the end of the string, pop the
9583 iterator, and compute it->current_x and it->hpos
9584 correctly. */
9585 move_it_to (it, IT_CHARPOS (*it) + it->string_from_display_prop_p,
9586 -1, -1, -1, MOVE_TO_POS);
9587 }
9588 }
9589 else
9590 {
9591 struct it it2;
9592 void *it2data = NULL;
9593 ptrdiff_t start_charpos, i;
9594 int nchars_per_row
9595 = (it->last_visible_x - it->first_visible_x) / FRAME_COLUMN_WIDTH (it->f);
9596 bool hit_pos_limit = false;
9597 ptrdiff_t pos_limit;
9598
9599 /* Start at the beginning of the screen line containing IT's
9600 position. This may actually move vertically backwards,
9601 in case of overlays, so adjust dvpos accordingly. */
9602 dvpos += it->vpos;
9603 move_it_vertically_backward (it, 0);
9604 dvpos -= it->vpos;
9605
9606 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9607 screen lines, and reseat the iterator there. */
9608 start_charpos = IT_CHARPOS (*it);
9609 if (it->line_wrap == TRUNCATE || nchars_per_row == 0)
9610 pos_limit = BEGV;
9611 else
9612 pos_limit = max (start_charpos + dvpos * nchars_per_row, BEGV);
9613
9614 for (i = -dvpos; i > 0 && IT_CHARPOS (*it) > pos_limit; --i)
9615 back_to_previous_visible_line_start (it);
9616 if (i > 0 && IT_CHARPOS (*it) <= pos_limit)
9617 hit_pos_limit = true;
9618 reseat (it, it->current.pos, true);
9619
9620 /* Move further back if we end up in a string or an image. */
9621 while (!IT_POS_VALID_AFTER_MOVE_P (it))
9622 {
9623 /* First try to move to start of display line. */
9624 dvpos += it->vpos;
9625 move_it_vertically_backward (it, 0);
9626 dvpos -= it->vpos;
9627 if (IT_POS_VALID_AFTER_MOVE_P (it))
9628 break;
9629 /* If start of line is still in string or image,
9630 move further back. */
9631 back_to_previous_visible_line_start (it);
9632 reseat (it, it->current.pos, true);
9633 dvpos--;
9634 }
9635
9636 it->current_x = it->hpos = 0;
9637
9638 /* Above call may have moved too far if continuation lines
9639 are involved. Scan forward and see if it did. */
9640 SAVE_IT (it2, *it, it2data);
9641 it2.vpos = it2.current_y = 0;
9642 move_it_to (&it2, start_charpos, -1, -1, -1, MOVE_TO_POS);
9643 it->vpos -= it2.vpos;
9644 it->current_y -= it2.current_y;
9645 it->current_x = it->hpos = 0;
9646
9647 /* If we moved too far back, move IT some lines forward. */
9648 if (it2.vpos > -dvpos)
9649 {
9650 int delta = it2.vpos + dvpos;
9651
9652 RESTORE_IT (&it2, &it2, it2data);
9653 SAVE_IT (it2, *it, it2data);
9654 move_it_to (it, -1, -1, -1, it->vpos + delta, MOVE_TO_VPOS);
9655 /* Move back again if we got too far ahead. */
9656 if (IT_CHARPOS (*it) >= start_charpos)
9657 RESTORE_IT (it, &it2, it2data);
9658 else
9659 bidi_unshelve_cache (it2data, true);
9660 }
9661 else if (hit_pos_limit && pos_limit > BEGV
9662 && dvpos < 0 && it2.vpos < -dvpos)
9663 {
9664 /* If we hit the limit, but still didn't make it far enough
9665 back, that means there's a display string with a newline
9666 covering a large chunk of text, and that caused
9667 back_to_previous_visible_line_start try to go too far.
9668 Punish those who commit such atrocities by going back
9669 until we've reached DVPOS, after lifting the limit, which
9670 could make it slow for very long lines. "If it hurts,
9671 don't do that!" */
9672 dvpos += it2.vpos;
9673 RESTORE_IT (it, it, it2data);
9674 for (i = -dvpos; i > 0; --i)
9675 {
9676 back_to_previous_visible_line_start (it);
9677 it->vpos--;
9678 }
9679 reseat_1 (it, it->current.pos, true);
9680 }
9681 else
9682 RESTORE_IT (it, it, it2data);
9683 }
9684 }
9685
9686 /* Return true if IT points into the middle of a display vector. */
9687
9688 bool
9689 in_display_vector_p (struct it *it)
9690 {
9691 return (it->method == GET_FROM_DISPLAY_VECTOR
9692 && it->current.dpvec_index > 0
9693 && it->dpvec + it->current.dpvec_index != it->dpend);
9694 }
9695
9696 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size, Swindow_text_pixel_size, 0, 6, 0,
9697 doc: /* Return the size of the text of WINDOW's buffer in pixels.
9698 WINDOW must be a live window and defaults to the selected one. The
9699 return value is a cons of the maximum pixel-width of any text line and
9700 the maximum pixel-height of all text lines.
9701
9702 The optional argument FROM, if non-nil, specifies the first text
9703 position and defaults to the minimum accessible position of the buffer.
9704 If FROM is t, use the minimum accessible position that is not a newline
9705 character. TO, if non-nil, specifies the last text position and
9706 defaults to the maximum accessible position of the buffer. If TO is t,
9707 use the maximum accessible position that is not a newline character.
9708
9709 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9710 width that can be returned. X-LIMIT nil or omitted, means to use the
9711 pixel-width of WINDOW's body; use this if you do not intend to change
9712 the width of WINDOW. Use the maximum width WINDOW may assume if you
9713 intend to change WINDOW's width. In any case, text whose x-coordinate
9714 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9715 can take some time, it's always a good idea to make this argument as
9716 small as possible; in particular, if the buffer contains long lines that
9717 shall be truncated anyway.
9718
9719 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9720 height that can be returned. Text lines whose y-coordinate is beyond
9721 Y-LIMIT are ignored. Since calculating the text height of a large
9722 buffer can take some time, it makes sense to specify this argument if
9723 the size of the buffer is unknown.
9724
9725 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9726 include the height of the mode- or header-line of WINDOW in the return
9727 value. If it is either the symbol `mode-line' or `header-line', include
9728 only the height of that line, if present, in the return value. If t,
9729 include the height of both, if present, in the return value. */)
9730 (Lisp_Object window, Lisp_Object from, Lisp_Object to, Lisp_Object x_limit,
9731 Lisp_Object y_limit, Lisp_Object mode_and_header_line)
9732 {
9733 struct window *w = decode_live_window (window);
9734 Lisp_Object buffer = w->contents;
9735 struct buffer *b;
9736 struct it it;
9737 struct buffer *old_b = NULL;
9738 ptrdiff_t start, end, pos;
9739 struct text_pos startp;
9740 void *itdata = NULL;
9741 int c, max_y = -1, x = 0, y = 0;
9742
9743 CHECK_BUFFER (buffer);
9744 b = XBUFFER (buffer);
9745
9746 if (b != current_buffer)
9747 {
9748 old_b = current_buffer;
9749 set_buffer_internal (b);
9750 }
9751
9752 if (NILP (from))
9753 start = BEGV;
9754 else if (EQ (from, Qt))
9755 {
9756 start = pos = BEGV;
9757 while ((pos++ < ZV) && (c = FETCH_CHAR (pos))
9758 && (c == ' ' || c == '\t' || c == '\n' || c == '\r'))
9759 start = pos;
9760 while ((pos-- > BEGV) && (c = FETCH_CHAR (pos)) && (c == ' ' || c == '\t'))
9761 start = pos;
9762 }
9763 else
9764 {
9765 CHECK_NUMBER_COERCE_MARKER (from);
9766 start = min (max (XINT (from), BEGV), ZV);
9767 }
9768
9769 if (NILP (to))
9770 end = ZV;
9771 else if (EQ (to, Qt))
9772 {
9773 end = pos = ZV;
9774 while ((pos-- > BEGV) && (c = FETCH_CHAR (pos))
9775 && (c == ' ' || c == '\t' || c == '\n' || c == '\r'))
9776 end = pos;
9777 while ((pos++ < ZV) && (c = FETCH_CHAR (pos)) && (c == ' ' || c == '\t'))
9778 end = pos;
9779 }
9780 else
9781 {
9782 CHECK_NUMBER_COERCE_MARKER (to);
9783 end = max (start, min (XINT (to), ZV));
9784 }
9785
9786 if (!NILP (y_limit))
9787 {
9788 CHECK_NUMBER (y_limit);
9789 max_y = min (XINT (y_limit), INT_MAX);
9790 }
9791
9792 itdata = bidi_shelve_cache ();
9793 SET_TEXT_POS (startp, start, CHAR_TO_BYTE (start));
9794 start_display (&it, w, startp);
9795
9796 if (NILP (x_limit))
9797 x = move_it_to (&it, end, -1, max_y, -1, MOVE_TO_POS | MOVE_TO_Y);
9798 else
9799 {
9800 CHECK_NUMBER (x_limit);
9801 it.last_visible_x = min (XINT (x_limit), INFINITY);
9802 /* Actually, we never want move_it_to stop at to_x. But to make
9803 sure that move_it_in_display_line_to always moves far enough,
9804 we set it to INT_MAX and specify MOVE_TO_X. */
9805 x = move_it_to (&it, end, INT_MAX, max_y, -1,
9806 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
9807 }
9808
9809 y = it.current_y + it.max_ascent + it.max_descent;
9810
9811 if (!EQ (mode_and_header_line, Qheader_line)
9812 && !EQ (mode_and_header_line, Qt))
9813 /* Do not count the header-line which was counted automatically by
9814 start_display. */
9815 y = y - WINDOW_HEADER_LINE_HEIGHT (w);
9816
9817 if (EQ (mode_and_header_line, Qmode_line)
9818 || EQ (mode_and_header_line, Qt))
9819 /* Do count the mode-line which is not included automatically by
9820 start_display. */
9821 y = y + WINDOW_MODE_LINE_HEIGHT (w);
9822
9823 bidi_unshelve_cache (itdata, false);
9824
9825 if (old_b)
9826 set_buffer_internal (old_b);
9827
9828 return Fcons (make_number (x), make_number (y));
9829 }
9830 \f
9831 /***********************************************************************
9832 Messages
9833 ***********************************************************************/
9834
9835 /* Return the number of arguments the format string FORMAT needs. */
9836
9837 static ptrdiff_t
9838 format_nargs (char const *format)
9839 {
9840 ptrdiff_t nargs = 0;
9841 for (char const *p = format; (p = strchr (p, '%')); p++)
9842 if (p[1] == '%')
9843 p++;
9844 else
9845 nargs++;
9846 return nargs;
9847 }
9848
9849 /* Add a message with format string FORMAT and formatted arguments
9850 to *Messages*. */
9851
9852 void
9853 add_to_log (const char *format, ...)
9854 {
9855 va_list ap;
9856 va_start (ap, format);
9857 vadd_to_log (format, ap);
9858 va_end (ap);
9859 }
9860
9861 void
9862 vadd_to_log (char const *format, va_list ap)
9863 {
9864 ptrdiff_t form_nargs = format_nargs (format);
9865 ptrdiff_t nargs = 1 + form_nargs;
9866 Lisp_Object args[10];
9867 eassert (nargs <= ARRAYELTS (args));
9868 AUTO_STRING (args0, format);
9869 args[0] = args0;
9870 for (ptrdiff_t i = 1; i <= nargs; i++)
9871 args[i] = va_arg (ap, Lisp_Object);
9872 Lisp_Object msg = Qnil;
9873 msg = Fformat_message (nargs, args);
9874
9875 ptrdiff_t len = SBYTES (msg) + 1;
9876 USE_SAFE_ALLOCA;
9877 char *buffer = SAFE_ALLOCA (len);
9878 memcpy (buffer, SDATA (msg), len);
9879
9880 message_dolog (buffer, len - 1, true, STRING_MULTIBYTE (msg));
9881 SAFE_FREE ();
9882 }
9883
9884
9885 /* Output a newline in the *Messages* buffer if "needs" one. */
9886
9887 void
9888 message_log_maybe_newline (void)
9889 {
9890 if (message_log_need_newline)
9891 message_dolog ("", 0, true, false);
9892 }
9893
9894
9895 /* Add a string M of length NBYTES to the message log, optionally
9896 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9897 true, means interpret the contents of M as multibyte. This
9898 function calls low-level routines in order to bypass text property
9899 hooks, etc. which might not be safe to run.
9900
9901 This may GC (insert may run before/after change hooks),
9902 so the buffer M must NOT point to a Lisp string. */
9903
9904 void
9905 message_dolog (const char *m, ptrdiff_t nbytes, bool nlflag, bool multibyte)
9906 {
9907 const unsigned char *msg = (const unsigned char *) m;
9908
9909 if (!NILP (Vmemory_full))
9910 return;
9911
9912 if (!NILP (Vmessage_log_max))
9913 {
9914 struct buffer *oldbuf;
9915 Lisp_Object oldpoint, oldbegv, oldzv;
9916 int old_windows_or_buffers_changed = windows_or_buffers_changed;
9917 ptrdiff_t point_at_end = 0;
9918 ptrdiff_t zv_at_end = 0;
9919 Lisp_Object old_deactivate_mark;
9920
9921 old_deactivate_mark = Vdeactivate_mark;
9922 oldbuf = current_buffer;
9923
9924 /* Ensure the Messages buffer exists, and switch to it.
9925 If we created it, set the major-mode. */
9926 bool newbuffer = NILP (Fget_buffer (Vmessages_buffer_name));
9927 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name));
9928 if (newbuffer
9929 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9930 call0 (intern ("messages-buffer-mode"));
9931
9932 bset_undo_list (current_buffer, Qt);
9933 bset_cache_long_scans (current_buffer, Qnil);
9934
9935 oldpoint = message_dolog_marker1;
9936 set_marker_restricted_both (oldpoint, Qnil, PT, PT_BYTE);
9937 oldbegv = message_dolog_marker2;
9938 set_marker_restricted_both (oldbegv, Qnil, BEGV, BEGV_BYTE);
9939 oldzv = message_dolog_marker3;
9940 set_marker_restricted_both (oldzv, Qnil, ZV, ZV_BYTE);
9941
9942 if (PT == Z)
9943 point_at_end = 1;
9944 if (ZV == Z)
9945 zv_at_end = 1;
9946
9947 BEGV = BEG;
9948 BEGV_BYTE = BEG_BYTE;
9949 ZV = Z;
9950 ZV_BYTE = Z_BYTE;
9951 TEMP_SET_PT_BOTH (Z, Z_BYTE);
9952
9953 /* Insert the string--maybe converting multibyte to single byte
9954 or vice versa, so that all the text fits the buffer. */
9955 if (multibyte
9956 && NILP (BVAR (current_buffer, enable_multibyte_characters)))
9957 {
9958 ptrdiff_t i;
9959 int c, char_bytes;
9960 char work[1];
9961
9962 /* Convert a multibyte string to single-byte
9963 for the *Message* buffer. */
9964 for (i = 0; i < nbytes; i += char_bytes)
9965 {
9966 c = string_char_and_length (msg + i, &char_bytes);
9967 work[0] = CHAR_TO_BYTE8 (c);
9968 insert_1_both (work, 1, 1, true, false, false);
9969 }
9970 }
9971 else if (! multibyte
9972 && ! NILP (BVAR (current_buffer, enable_multibyte_characters)))
9973 {
9974 ptrdiff_t i;
9975 int c, char_bytes;
9976 unsigned char str[MAX_MULTIBYTE_LENGTH];
9977 /* Convert a single-byte string to multibyte
9978 for the *Message* buffer. */
9979 for (i = 0; i < nbytes; i++)
9980 {
9981 c = msg[i];
9982 MAKE_CHAR_MULTIBYTE (c);
9983 char_bytes = CHAR_STRING (c, str);
9984 insert_1_both ((char *) str, 1, char_bytes, true, false, false);
9985 }
9986 }
9987 else if (nbytes)
9988 insert_1_both (m, chars_in_text (msg, nbytes), nbytes,
9989 true, false, false);
9990
9991 if (nlflag)
9992 {
9993 ptrdiff_t this_bol, this_bol_byte, prev_bol, prev_bol_byte;
9994 printmax_t dups;
9995
9996 insert_1_both ("\n", 1, 1, true, false, false);
9997
9998 scan_newline (Z, Z_BYTE, BEG, BEG_BYTE, -2, false);
9999 this_bol = PT;
10000 this_bol_byte = PT_BYTE;
10001
10002 /* See if this line duplicates the previous one.
10003 If so, combine duplicates. */
10004 if (this_bol > BEG)
10005 {
10006 scan_newline (PT, PT_BYTE, BEG, BEG_BYTE, -2, false);
10007 prev_bol = PT;
10008 prev_bol_byte = PT_BYTE;
10009
10010 dups = message_log_check_duplicate (prev_bol_byte,
10011 this_bol_byte);
10012 if (dups)
10013 {
10014 del_range_both (prev_bol, prev_bol_byte,
10015 this_bol, this_bol_byte, false);
10016 if (dups > 1)
10017 {
10018 char dupstr[sizeof " [ times]"
10019 + INT_STRLEN_BOUND (printmax_t)];
10020
10021 /* If you change this format, don't forget to also
10022 change message_log_check_duplicate. */
10023 int duplen = sprintf (dupstr, " [%"pMd" times]", dups);
10024 TEMP_SET_PT_BOTH (Z - 1, Z_BYTE - 1);
10025 insert_1_both (dupstr, duplen, duplen,
10026 true, false, true);
10027 }
10028 }
10029 }
10030
10031 /* If we have more than the desired maximum number of lines
10032 in the *Messages* buffer now, delete the oldest ones.
10033 This is safe because we don't have undo in this buffer. */
10034
10035 if (NATNUMP (Vmessage_log_max))
10036 {
10037 scan_newline (Z, Z_BYTE, BEG, BEG_BYTE,
10038 -XFASTINT (Vmessage_log_max) - 1, false);
10039 del_range_both (BEG, BEG_BYTE, PT, PT_BYTE, false);
10040 }
10041 }
10042 BEGV = marker_position (oldbegv);
10043 BEGV_BYTE = marker_byte_position (oldbegv);
10044
10045 if (zv_at_end)
10046 {
10047 ZV = Z;
10048 ZV_BYTE = Z_BYTE;
10049 }
10050 else
10051 {
10052 ZV = marker_position (oldzv);
10053 ZV_BYTE = marker_byte_position (oldzv);
10054 }
10055
10056 if (point_at_end)
10057 TEMP_SET_PT_BOTH (Z, Z_BYTE);
10058 else
10059 /* We can't do Fgoto_char (oldpoint) because it will run some
10060 Lisp code. */
10061 TEMP_SET_PT_BOTH (marker_position (oldpoint),
10062 marker_byte_position (oldpoint));
10063
10064 unchain_marker (XMARKER (oldpoint));
10065 unchain_marker (XMARKER (oldbegv));
10066 unchain_marker (XMARKER (oldzv));
10067
10068 /* We called insert_1_both above with its 5th argument (PREPARE)
10069 false, which prevents insert_1_both from calling
10070 prepare_to_modify_buffer, which in turns prevents us from
10071 incrementing windows_or_buffers_changed even if *Messages* is
10072 shown in some window. So we must manually set
10073 windows_or_buffers_changed here to make up for that. */
10074 windows_or_buffers_changed = old_windows_or_buffers_changed;
10075 bset_redisplay (current_buffer);
10076
10077 set_buffer_internal (oldbuf);
10078
10079 message_log_need_newline = !nlflag;
10080 Vdeactivate_mark = old_deactivate_mark;
10081 }
10082 }
10083
10084
10085 /* We are at the end of the buffer after just having inserted a newline.
10086 (Note: We depend on the fact we won't be crossing the gap.)
10087 Check to see if the most recent message looks a lot like the previous one.
10088 Return 0 if different, 1 if the new one should just replace it, or a
10089 value N > 1 if we should also append " [N times]". */
10090
10091 static intmax_t
10092 message_log_check_duplicate (ptrdiff_t prev_bol_byte, ptrdiff_t this_bol_byte)
10093 {
10094 ptrdiff_t i;
10095 ptrdiff_t len = Z_BYTE - 1 - this_bol_byte;
10096 bool seen_dots = false;
10097 unsigned char *p1 = BUF_BYTE_ADDRESS (current_buffer, prev_bol_byte);
10098 unsigned char *p2 = BUF_BYTE_ADDRESS (current_buffer, this_bol_byte);
10099
10100 for (i = 0; i < len; i++)
10101 {
10102 if (i >= 3 && p1[i - 3] == '.' && p1[i - 2] == '.' && p1[i - 1] == '.')
10103 seen_dots = true;
10104 if (p1[i] != p2[i])
10105 return seen_dots;
10106 }
10107 p1 += len;
10108 if (*p1 == '\n')
10109 return 2;
10110 if (*p1++ == ' ' && *p1++ == '[')
10111 {
10112 char *pend;
10113 intmax_t n = strtoimax ((char *) p1, &pend, 10);
10114 if (0 < n && n < INTMAX_MAX && strncmp (pend, " times]\n", 8) == 0)
10115 return n + 1;
10116 }
10117 return 0;
10118 }
10119 \f
10120
10121 /* Display an echo area message M with a specified length of NBYTES
10122 bytes. The string may include null characters. If M is not a
10123 string, clear out any existing message, and let the mini-buffer
10124 text show through.
10125
10126 This function cancels echoing. */
10127
10128 void
10129 message3 (Lisp_Object m)
10130 {
10131 clear_message (true, true);
10132 cancel_echoing ();
10133
10134 /* First flush out any partial line written with print. */
10135 message_log_maybe_newline ();
10136 if (STRINGP (m))
10137 {
10138 ptrdiff_t nbytes = SBYTES (m);
10139 bool multibyte = STRING_MULTIBYTE (m);
10140 char *buffer;
10141 USE_SAFE_ALLOCA;
10142 SAFE_ALLOCA_STRING (buffer, m);
10143 message_dolog (buffer, nbytes, true, multibyte);
10144 SAFE_FREE ();
10145 }
10146 if (! inhibit_message)
10147 message3_nolog (m);
10148 }
10149
10150 /* Log the message M to stderr. Log an empty line if M is not a string. */
10151
10152 static void
10153 message_to_stderr (Lisp_Object m)
10154 {
10155 if (noninteractive_need_newline)
10156 {
10157 noninteractive_need_newline = false;
10158 fputc ('\n', stderr);
10159 }
10160 if (STRINGP (m))
10161 {
10162 Lisp_Object s = ENCODE_SYSTEM (m);
10163 fwrite (SDATA (s), SBYTES (s), 1, stderr);
10164 }
10165 if (!cursor_in_echo_area)
10166 fputc ('\n', stderr);
10167 fflush (stderr);
10168 }
10169
10170 /* The non-logging version of message3.
10171 This does not cancel echoing, because it is used for echoing.
10172 Perhaps we need to make a separate function for echoing
10173 and make this cancel echoing. */
10174
10175 void
10176 message3_nolog (Lisp_Object m)
10177 {
10178 struct frame *sf = SELECTED_FRAME ();
10179
10180 if (FRAME_INITIAL_P (sf))
10181 message_to_stderr (m);
10182 /* Error messages get reported properly by cmd_error, so this must be just an
10183 informative message; if the frame hasn't really been initialized yet, just
10184 toss it. */
10185 else if (INTERACTIVE && sf->glyphs_initialized_p)
10186 {
10187 /* Get the frame containing the mini-buffer
10188 that the selected frame is using. */
10189 Lisp_Object mini_window = FRAME_MINIBUF_WINDOW (sf);
10190 Lisp_Object frame = XWINDOW (mini_window)->frame;
10191 struct frame *f = XFRAME (frame);
10192
10193 if (FRAME_VISIBLE_P (sf) && !FRAME_VISIBLE_P (f))
10194 Fmake_frame_visible (frame);
10195
10196 if (STRINGP (m) && SCHARS (m) > 0)
10197 {
10198 set_message (m);
10199 if (minibuffer_auto_raise)
10200 Fraise_frame (frame);
10201 /* Assume we are not echoing.
10202 (If we are, echo_now will override this.) */
10203 echo_message_buffer = Qnil;
10204 }
10205 else
10206 clear_message (true, true);
10207
10208 do_pending_window_change (false);
10209 echo_area_display (true);
10210 do_pending_window_change (false);
10211 if (FRAME_TERMINAL (f)->frame_up_to_date_hook)
10212 (*FRAME_TERMINAL (f)->frame_up_to_date_hook) (f);
10213 }
10214 }
10215
10216
10217 /* Display a null-terminated echo area message M. If M is 0, clear
10218 out any existing message, and let the mini-buffer text show through.
10219
10220 The buffer M must continue to exist until after the echo area gets
10221 cleared or some other message gets displayed there. Do not pass
10222 text that is stored in a Lisp string. Do not pass text in a buffer
10223 that was alloca'd. */
10224
10225 void
10226 message1 (const char *m)
10227 {
10228 message3 (m ? build_unibyte_string (m) : Qnil);
10229 }
10230
10231
10232 /* The non-logging counterpart of message1. */
10233
10234 void
10235 message1_nolog (const char *m)
10236 {
10237 message3_nolog (m ? build_unibyte_string (m) : Qnil);
10238 }
10239
10240 /* Display a message M which contains a single %s
10241 which gets replaced with STRING. */
10242
10243 void
10244 message_with_string (const char *m, Lisp_Object string, bool log)
10245 {
10246 CHECK_STRING (string);
10247
10248 bool need_message;
10249 if (noninteractive)
10250 need_message = !!m;
10251 else if (!INTERACTIVE)
10252 need_message = false;
10253 else
10254 {
10255 /* The frame whose minibuffer we're going to display the message on.
10256 It may be larger than the selected frame, so we need
10257 to use its buffer, not the selected frame's buffer. */
10258 Lisp_Object mini_window;
10259 struct frame *f, *sf = SELECTED_FRAME ();
10260
10261 /* Get the frame containing the minibuffer
10262 that the selected frame is using. */
10263 mini_window = FRAME_MINIBUF_WINDOW (sf);
10264 f = XFRAME (WINDOW_FRAME (XWINDOW (mini_window)));
10265
10266 /* Error messages get reported properly by cmd_error, so this must be
10267 just an informative message; if the frame hasn't really been
10268 initialized yet, just toss it. */
10269 need_message = f->glyphs_initialized_p;
10270 }
10271
10272 if (need_message)
10273 {
10274 AUTO_STRING (fmt, m);
10275 Lisp_Object msg = CALLN (Fformat_message, fmt, string);
10276
10277 if (noninteractive)
10278 message_to_stderr (msg);
10279 else
10280 {
10281 if (log)
10282 message3 (msg);
10283 else
10284 message3_nolog (msg);
10285
10286 /* Print should start at the beginning of the message
10287 buffer next time. */
10288 message_buf_print = false;
10289 }
10290 }
10291 }
10292
10293
10294 /* Dump an informative message to the minibuf. If M is 0, clear out
10295 any existing message, and let the mini-buffer text show through.
10296
10297 The message must be safe ASCII and the format must not contain ` or
10298 '. If your message and format do not fit into this category,
10299 convert your arguments to Lisp objects and use Fmessage instead. */
10300
10301 static void ATTRIBUTE_FORMAT_PRINTF (1, 0)
10302 vmessage (const char *m, va_list ap)
10303 {
10304 if (noninteractive)
10305 {
10306 if (m)
10307 {
10308 if (noninteractive_need_newline)
10309 putc ('\n', stderr);
10310 noninteractive_need_newline = false;
10311 vfprintf (stderr, m, ap);
10312 if (!cursor_in_echo_area)
10313 fprintf (stderr, "\n");
10314 fflush (stderr);
10315 }
10316 }
10317 else if (INTERACTIVE)
10318 {
10319 /* The frame whose mini-buffer we're going to display the message
10320 on. It may be larger than the selected frame, so we need to
10321 use its buffer, not the selected frame's buffer. */
10322 Lisp_Object mini_window;
10323 struct frame *f, *sf = SELECTED_FRAME ();
10324
10325 /* Get the frame containing the mini-buffer
10326 that the selected frame is using. */
10327 mini_window = FRAME_MINIBUF_WINDOW (sf);
10328 f = XFRAME (WINDOW_FRAME (XWINDOW (mini_window)));
10329
10330 /* Error messages get reported properly by cmd_error, so this must be
10331 just an informative message; if the frame hasn't really been
10332 initialized yet, just toss it. */
10333 if (f->glyphs_initialized_p)
10334 {
10335 if (m)
10336 {
10337 ptrdiff_t len;
10338 ptrdiff_t maxsize = FRAME_MESSAGE_BUF_SIZE (f);
10339 USE_SAFE_ALLOCA;
10340 char *message_buf = SAFE_ALLOCA (maxsize + 1);
10341
10342 len = doprnt (message_buf, maxsize, m, 0, ap);
10343
10344 message3 (make_string (message_buf, len));
10345 SAFE_FREE ();
10346 }
10347 else
10348 message1 (0);
10349
10350 /* Print should start at the beginning of the message
10351 buffer next time. */
10352 message_buf_print = false;
10353 }
10354 }
10355 }
10356
10357 void
10358 message (const char *m, ...)
10359 {
10360 va_list ap;
10361 va_start (ap, m);
10362 vmessage (m, ap);
10363 va_end (ap);
10364 }
10365
10366
10367 /* Display the current message in the current mini-buffer. This is
10368 only called from error handlers in process.c, and is not time
10369 critical. */
10370
10371 void
10372 update_echo_area (void)
10373 {
10374 if (!NILP (echo_area_buffer[0]))
10375 {
10376 Lisp_Object string;
10377 string = Fcurrent_message ();
10378 message3 (string);
10379 }
10380 }
10381
10382
10383 /* Make sure echo area buffers in `echo_buffers' are live.
10384 If they aren't, make new ones. */
10385
10386 static void
10387 ensure_echo_area_buffers (void)
10388 {
10389 int i;
10390
10391 for (i = 0; i < 2; ++i)
10392 if (!BUFFERP (echo_buffer[i])
10393 || !BUFFER_LIVE_P (XBUFFER (echo_buffer[i])))
10394 {
10395 char name[30];
10396 Lisp_Object old_buffer;
10397 int j;
10398
10399 old_buffer = echo_buffer[i];
10400 echo_buffer[i] = Fget_buffer_create
10401 (make_formatted_string (name, " *Echo Area %d*", i));
10402 bset_truncate_lines (XBUFFER (echo_buffer[i]), Qnil);
10403 /* to force word wrap in echo area -
10404 it was decided to postpone this*/
10405 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10406
10407 for (j = 0; j < 2; ++j)
10408 if (EQ (old_buffer, echo_area_buffer[j]))
10409 echo_area_buffer[j] = echo_buffer[i];
10410 }
10411 }
10412
10413
10414 /* Call FN with args A1..A2 with either the current or last displayed
10415 echo_area_buffer as current buffer.
10416
10417 WHICH zero means use the current message buffer
10418 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10419 from echo_buffer[] and clear it.
10420
10421 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10422 suitable buffer from echo_buffer[] and clear it.
10423
10424 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10425 that the current message becomes the last displayed one, make
10426 choose a suitable buffer for echo_area_buffer[0], and clear it.
10427
10428 Value is what FN returns. */
10429
10430 static bool
10431 with_echo_area_buffer (struct window *w, int which,
10432 bool (*fn) (ptrdiff_t, Lisp_Object),
10433 ptrdiff_t a1, Lisp_Object a2)
10434 {
10435 Lisp_Object buffer;
10436 bool this_one, the_other, clear_buffer_p, rc;
10437 ptrdiff_t count = SPECPDL_INDEX ();
10438
10439 /* If buffers aren't live, make new ones. */
10440 ensure_echo_area_buffers ();
10441
10442 clear_buffer_p = false;
10443
10444 if (which == 0)
10445 this_one = false, the_other = true;
10446 else if (which > 0)
10447 this_one = true, the_other = false;
10448 else
10449 {
10450 this_one = false, the_other = true;
10451 clear_buffer_p = true;
10452
10453 /* We need a fresh one in case the current echo buffer equals
10454 the one containing the last displayed echo area message. */
10455 if (!NILP (echo_area_buffer[this_one])
10456 && EQ (echo_area_buffer[this_one], echo_area_buffer[the_other]))
10457 echo_area_buffer[this_one] = Qnil;
10458 }
10459
10460 /* Choose a suitable buffer from echo_buffer[] is we don't
10461 have one. */
10462 if (NILP (echo_area_buffer[this_one]))
10463 {
10464 echo_area_buffer[this_one]
10465 = (EQ (echo_area_buffer[the_other], echo_buffer[this_one])
10466 ? echo_buffer[the_other]
10467 : echo_buffer[this_one]);
10468 clear_buffer_p = true;
10469 }
10470
10471 buffer = echo_area_buffer[this_one];
10472
10473 /* Don't get confused by reusing the buffer used for echoing
10474 for a different purpose. */
10475 if (echo_kboard == NULL && EQ (buffer, echo_message_buffer))
10476 cancel_echoing ();
10477
10478 record_unwind_protect (unwind_with_echo_area_buffer,
10479 with_echo_area_buffer_unwind_data (w));
10480
10481 /* Make the echo area buffer current. Note that for display
10482 purposes, it is not necessary that the displayed window's buffer
10483 == current_buffer, except for text property lookup. So, let's
10484 only set that buffer temporarily here without doing a full
10485 Fset_window_buffer. We must also change w->pointm, though,
10486 because otherwise an assertions in unshow_buffer fails, and Emacs
10487 aborts. */
10488 set_buffer_internal_1 (XBUFFER (buffer));
10489 if (w)
10490 {
10491 wset_buffer (w, buffer);
10492 set_marker_both (w->pointm, buffer, BEG, BEG_BYTE);
10493 set_marker_both (w->old_pointm, buffer, BEG, BEG_BYTE);
10494 }
10495
10496 bset_undo_list (current_buffer, Qt);
10497 bset_read_only (current_buffer, Qnil);
10498 specbind (Qinhibit_read_only, Qt);
10499 specbind (Qinhibit_modification_hooks, Qt);
10500
10501 if (clear_buffer_p && Z > BEG)
10502 del_range (BEG, Z);
10503
10504 eassert (BEGV >= BEG);
10505 eassert (ZV <= Z && ZV >= BEGV);
10506
10507 rc = fn (a1, a2);
10508
10509 eassert (BEGV >= BEG);
10510 eassert (ZV <= Z && ZV >= BEGV);
10511
10512 unbind_to (count, Qnil);
10513 return rc;
10514 }
10515
10516
10517 /* Save state that should be preserved around the call to the function
10518 FN called in with_echo_area_buffer. */
10519
10520 static Lisp_Object
10521 with_echo_area_buffer_unwind_data (struct window *w)
10522 {
10523 int i = 0;
10524 Lisp_Object vector, tmp;
10525
10526 /* Reduce consing by keeping one vector in
10527 Vwith_echo_area_save_vector. */
10528 vector = Vwith_echo_area_save_vector;
10529 Vwith_echo_area_save_vector = Qnil;
10530
10531 if (NILP (vector))
10532 vector = Fmake_vector (make_number (11), Qnil);
10533
10534 XSETBUFFER (tmp, current_buffer); ASET (vector, i, tmp); ++i;
10535 ASET (vector, i, Vdeactivate_mark); ++i;
10536 ASET (vector, i, make_number (windows_or_buffers_changed)); ++i;
10537
10538 if (w)
10539 {
10540 XSETWINDOW (tmp, w); ASET (vector, i, tmp); ++i;
10541 ASET (vector, i, w->contents); ++i;
10542 ASET (vector, i, make_number (marker_position (w->pointm))); ++i;
10543 ASET (vector, i, make_number (marker_byte_position (w->pointm))); ++i;
10544 ASET (vector, i, make_number (marker_position (w->old_pointm))); ++i;
10545 ASET (vector, i, make_number (marker_byte_position (w->old_pointm))); ++i;
10546 ASET (vector, i, make_number (marker_position (w->start))); ++i;
10547 ASET (vector, i, make_number (marker_byte_position (w->start))); ++i;
10548 }
10549 else
10550 {
10551 int end = i + 8;
10552 for (; i < end; ++i)
10553 ASET (vector, i, Qnil);
10554 }
10555
10556 eassert (i == ASIZE (vector));
10557 return vector;
10558 }
10559
10560
10561 /* Restore global state from VECTOR which was created by
10562 with_echo_area_buffer_unwind_data. */
10563
10564 static void
10565 unwind_with_echo_area_buffer (Lisp_Object vector)
10566 {
10567 set_buffer_internal_1 (XBUFFER (AREF (vector, 0)));
10568 Vdeactivate_mark = AREF (vector, 1);
10569 windows_or_buffers_changed = XFASTINT (AREF (vector, 2));
10570
10571 if (WINDOWP (AREF (vector, 3)))
10572 {
10573 struct window *w;
10574 Lisp_Object buffer;
10575
10576 w = XWINDOW (AREF (vector, 3));
10577 buffer = AREF (vector, 4);
10578
10579 wset_buffer (w, buffer);
10580 set_marker_both (w->pointm, buffer,
10581 XFASTINT (AREF (vector, 5)),
10582 XFASTINT (AREF (vector, 6)));
10583 set_marker_both (w->old_pointm, buffer,
10584 XFASTINT (AREF (vector, 7)),
10585 XFASTINT (AREF (vector, 8)));
10586 set_marker_both (w->start, buffer,
10587 XFASTINT (AREF (vector, 9)),
10588 XFASTINT (AREF (vector, 10)));
10589 }
10590
10591 Vwith_echo_area_save_vector = vector;
10592 }
10593
10594
10595 /* Set up the echo area for use by print functions. MULTIBYTE_P
10596 means we will print multibyte. */
10597
10598 void
10599 setup_echo_area_for_printing (bool multibyte_p)
10600 {
10601 /* If we can't find an echo area any more, exit. */
10602 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
10603 Fkill_emacs (Qnil);
10604
10605 ensure_echo_area_buffers ();
10606
10607 if (!message_buf_print)
10608 {
10609 /* A message has been output since the last time we printed.
10610 Choose a fresh echo area buffer. */
10611 if (EQ (echo_area_buffer[1], echo_buffer[0]))
10612 echo_area_buffer[0] = echo_buffer[1];
10613 else
10614 echo_area_buffer[0] = echo_buffer[0];
10615
10616 /* Switch to that buffer and clear it. */
10617 set_buffer_internal (XBUFFER (echo_area_buffer[0]));
10618 bset_truncate_lines (current_buffer, Qnil);
10619
10620 if (Z > BEG)
10621 {
10622 ptrdiff_t count = SPECPDL_INDEX ();
10623 specbind (Qinhibit_read_only, Qt);
10624 /* Note that undo recording is always disabled. */
10625 del_range (BEG, Z);
10626 unbind_to (count, Qnil);
10627 }
10628 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
10629
10630 /* Set up the buffer for the multibyteness we need. */
10631 if (multibyte_p
10632 != !NILP (BVAR (current_buffer, enable_multibyte_characters)))
10633 Fset_buffer_multibyte (multibyte_p ? Qt : Qnil);
10634
10635 /* Raise the frame containing the echo area. */
10636 if (minibuffer_auto_raise)
10637 {
10638 struct frame *sf = SELECTED_FRAME ();
10639 Lisp_Object mini_window;
10640 mini_window = FRAME_MINIBUF_WINDOW (sf);
10641 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window)));
10642 }
10643
10644 message_log_maybe_newline ();
10645 message_buf_print = true;
10646 }
10647 else
10648 {
10649 if (NILP (echo_area_buffer[0]))
10650 {
10651 if (EQ (echo_area_buffer[1], echo_buffer[0]))
10652 echo_area_buffer[0] = echo_buffer[1];
10653 else
10654 echo_area_buffer[0] = echo_buffer[0];
10655 }
10656
10657 if (current_buffer != XBUFFER (echo_area_buffer[0]))
10658 {
10659 /* Someone switched buffers between print requests. */
10660 set_buffer_internal (XBUFFER (echo_area_buffer[0]));
10661 bset_truncate_lines (current_buffer, Qnil);
10662 }
10663 }
10664 }
10665
10666
10667 /* Display an echo area message in window W. Value is true if W's
10668 height is changed. If display_last_displayed_message_p,
10669 display the message that was last displayed, otherwise
10670 display the current message. */
10671
10672 static bool
10673 display_echo_area (struct window *w)
10674 {
10675 bool no_message_p, window_height_changed_p;
10676
10677 /* Temporarily disable garbage collections while displaying the echo
10678 area. This is done because a GC can print a message itself.
10679 That message would modify the echo area buffer's contents while a
10680 redisplay of the buffer is going on, and seriously confuse
10681 redisplay. */
10682 ptrdiff_t count = inhibit_garbage_collection ();
10683
10684 /* If there is no message, we must call display_echo_area_1
10685 nevertheless because it resizes the window. But we will have to
10686 reset the echo_area_buffer in question to nil at the end because
10687 with_echo_area_buffer will sets it to an empty buffer. */
10688 bool i = display_last_displayed_message_p;
10689 no_message_p = NILP (echo_area_buffer[i]);
10690
10691 window_height_changed_p
10692 = with_echo_area_buffer (w, display_last_displayed_message_p,
10693 display_echo_area_1,
10694 (intptr_t) w, Qnil);
10695
10696 if (no_message_p)
10697 echo_area_buffer[i] = Qnil;
10698
10699 unbind_to (count, Qnil);
10700 return window_height_changed_p;
10701 }
10702
10703
10704 /* Helper for display_echo_area. Display the current buffer which
10705 contains the current echo area message in window W, a mini-window,
10706 a pointer to which is passed in A1. A2..A4 are currently not used.
10707 Change the height of W so that all of the message is displayed.
10708 Value is true if height of W was changed. */
10709
10710 static bool
10711 display_echo_area_1 (ptrdiff_t a1, Lisp_Object a2)
10712 {
10713 intptr_t i1 = a1;
10714 struct window *w = (struct window *) i1;
10715 Lisp_Object window;
10716 struct text_pos start;
10717
10718 /* We are about to enter redisplay without going through
10719 redisplay_internal, so we need to forget these faces by hand
10720 here. */
10721 forget_escape_and_glyphless_faces ();
10722
10723 /* Do this before displaying, so that we have a large enough glyph
10724 matrix for the display. If we can't get enough space for the
10725 whole text, display the last N lines. That works by setting w->start. */
10726 bool window_height_changed_p = resize_mini_window (w, false);
10727
10728 /* Use the starting position chosen by resize_mini_window. */
10729 SET_TEXT_POS_FROM_MARKER (start, w->start);
10730
10731 /* Display. */
10732 clear_glyph_matrix (w->desired_matrix);
10733 XSETWINDOW (window, w);
10734 try_window (window, start, 0);
10735
10736 return window_height_changed_p;
10737 }
10738
10739
10740 /* Resize the echo area window to exactly the size needed for the
10741 currently displayed message, if there is one. If a mini-buffer
10742 is active, don't shrink it. */
10743
10744 void
10745 resize_echo_area_exactly (void)
10746 {
10747 if (BUFFERP (echo_area_buffer[0])
10748 && WINDOWP (echo_area_window))
10749 {
10750 struct window *w = XWINDOW (echo_area_window);
10751 Lisp_Object resize_exactly = (minibuf_level == 0 ? Qt : Qnil);
10752 bool resized_p = with_echo_area_buffer (w, 0, resize_mini_window_1,
10753 (intptr_t) w, resize_exactly);
10754 if (resized_p)
10755 {
10756 windows_or_buffers_changed = 42;
10757 update_mode_lines = 30;
10758 redisplay_internal ();
10759 }
10760 }
10761 }
10762
10763
10764 /* Callback function for with_echo_area_buffer, when used from
10765 resize_echo_area_exactly. A1 contains a pointer to the window to
10766 resize, EXACTLY non-nil means resize the mini-window exactly to the
10767 size of the text displayed. A3 and A4 are not used. Value is what
10768 resize_mini_window returns. */
10769
10770 static bool
10771 resize_mini_window_1 (ptrdiff_t a1, Lisp_Object exactly)
10772 {
10773 intptr_t i1 = a1;
10774 return resize_mini_window ((struct window *) i1, !NILP (exactly));
10775 }
10776
10777
10778 /* Resize mini-window W to fit the size of its contents. EXACT_P
10779 means size the window exactly to the size needed. Otherwise, it's
10780 only enlarged until W's buffer is empty.
10781
10782 Set W->start to the right place to begin display. If the whole
10783 contents fit, start at the beginning. Otherwise, start so as
10784 to make the end of the contents appear. This is particularly
10785 important for y-or-n-p, but seems desirable generally.
10786
10787 Value is true if the window height has been changed. */
10788
10789 bool
10790 resize_mini_window (struct window *w, bool exact_p)
10791 {
10792 struct frame *f = XFRAME (w->frame);
10793 bool window_height_changed_p = false;
10794
10795 eassert (MINI_WINDOW_P (w));
10796
10797 /* By default, start display at the beginning. */
10798 set_marker_both (w->start, w->contents,
10799 BUF_BEGV (XBUFFER (w->contents)),
10800 BUF_BEGV_BYTE (XBUFFER (w->contents)));
10801
10802 /* Don't resize windows while redisplaying a window; it would
10803 confuse redisplay functions when the size of the window they are
10804 displaying changes from under them. Such a resizing can happen,
10805 for instance, when which-func prints a long message while
10806 we are running fontification-functions. We're running these
10807 functions with safe_call which binds inhibit-redisplay to t. */
10808 if (!NILP (Vinhibit_redisplay))
10809 return false;
10810
10811 /* Nil means don't try to resize. */
10812 if (NILP (Vresize_mini_windows)
10813 || (FRAME_X_P (f) && FRAME_X_OUTPUT (f) == NULL))
10814 return false;
10815
10816 if (!FRAME_MINIBUF_ONLY_P (f))
10817 {
10818 struct it it;
10819 int total_height = (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f)))
10820 + WINDOW_PIXEL_HEIGHT (w));
10821 int unit = FRAME_LINE_HEIGHT (f);
10822 int height, max_height;
10823 struct text_pos start;
10824 struct buffer *old_current_buffer = NULL;
10825
10826 if (current_buffer != XBUFFER (w->contents))
10827 {
10828 old_current_buffer = current_buffer;
10829 set_buffer_internal (XBUFFER (w->contents));
10830 }
10831
10832 init_iterator (&it, w, BEGV, BEGV_BYTE, NULL, DEFAULT_FACE_ID);
10833
10834 /* Compute the max. number of lines specified by the user. */
10835 if (FLOATP (Vmax_mini_window_height))
10836 max_height = XFLOATINT (Vmax_mini_window_height) * total_height;
10837 else if (INTEGERP (Vmax_mini_window_height))
10838 max_height = XINT (Vmax_mini_window_height) * unit;
10839 else
10840 max_height = total_height / 4;
10841
10842 /* Correct that max. height if it's bogus. */
10843 max_height = clip_to_bounds (unit, max_height, total_height);
10844
10845 /* Find out the height of the text in the window. */
10846 if (it.line_wrap == TRUNCATE)
10847 height = unit;
10848 else
10849 {
10850 last_height = 0;
10851 move_it_to (&it, ZV, -1, -1, -1, MOVE_TO_POS);
10852 if (it.max_ascent == 0 && it.max_descent == 0)
10853 height = it.current_y + last_height;
10854 else
10855 height = it.current_y + it.max_ascent + it.max_descent;
10856 height -= min (it.extra_line_spacing, it.max_extra_line_spacing);
10857 }
10858
10859 /* Compute a suitable window start. */
10860 if (height > max_height)
10861 {
10862 height = (max_height / unit) * unit;
10863 init_iterator (&it, w, ZV, ZV_BYTE, NULL, DEFAULT_FACE_ID);
10864 move_it_vertically_backward (&it, height - unit);
10865 start = it.current.pos;
10866 }
10867 else
10868 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
10869 SET_MARKER_FROM_TEXT_POS (w->start, start);
10870
10871 if (EQ (Vresize_mini_windows, Qgrow_only))
10872 {
10873 /* Let it grow only, until we display an empty message, in which
10874 case the window shrinks again. */
10875 if (height > WINDOW_PIXEL_HEIGHT (w))
10876 {
10877 int old_height = WINDOW_PIXEL_HEIGHT (w);
10878
10879 FRAME_WINDOWS_FROZEN (f) = true;
10880 grow_mini_window (w, height - WINDOW_PIXEL_HEIGHT (w), true);
10881 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
10882 }
10883 else if (height < WINDOW_PIXEL_HEIGHT (w)
10884 && (exact_p || BEGV == ZV))
10885 {
10886 int old_height = WINDOW_PIXEL_HEIGHT (w);
10887
10888 FRAME_WINDOWS_FROZEN (f) = false;
10889 shrink_mini_window (w, true);
10890 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
10891 }
10892 }
10893 else
10894 {
10895 /* Always resize to exact size needed. */
10896 if (height > WINDOW_PIXEL_HEIGHT (w))
10897 {
10898 int old_height = WINDOW_PIXEL_HEIGHT (w);
10899
10900 FRAME_WINDOWS_FROZEN (f) = true;
10901 grow_mini_window (w, height - WINDOW_PIXEL_HEIGHT (w), true);
10902 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
10903 }
10904 else if (height < WINDOW_PIXEL_HEIGHT (w))
10905 {
10906 int old_height = WINDOW_PIXEL_HEIGHT (w);
10907
10908 FRAME_WINDOWS_FROZEN (f) = false;
10909 shrink_mini_window (w, true);
10910
10911 if (height)
10912 {
10913 FRAME_WINDOWS_FROZEN (f) = true;
10914 grow_mini_window (w, height - WINDOW_PIXEL_HEIGHT (w), true);
10915 }
10916
10917 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
10918 }
10919 }
10920
10921 if (old_current_buffer)
10922 set_buffer_internal (old_current_buffer);
10923 }
10924
10925 return window_height_changed_p;
10926 }
10927
10928
10929 /* Value is the current message, a string, or nil if there is no
10930 current message. */
10931
10932 Lisp_Object
10933 current_message (void)
10934 {
10935 Lisp_Object msg;
10936
10937 if (!BUFFERP (echo_area_buffer[0]))
10938 msg = Qnil;
10939 else
10940 {
10941 with_echo_area_buffer (0, 0, current_message_1,
10942 (intptr_t) &msg, Qnil);
10943 if (NILP (msg))
10944 echo_area_buffer[0] = Qnil;
10945 }
10946
10947 return msg;
10948 }
10949
10950
10951 static bool
10952 current_message_1 (ptrdiff_t a1, Lisp_Object a2)
10953 {
10954 intptr_t i1 = a1;
10955 Lisp_Object *msg = (Lisp_Object *) i1;
10956
10957 if (Z > BEG)
10958 *msg = make_buffer_string (BEG, Z, true);
10959 else
10960 *msg = Qnil;
10961 return false;
10962 }
10963
10964
10965 /* Push the current message on Vmessage_stack for later restoration
10966 by restore_message. Value is true if the current message isn't
10967 empty. This is a relatively infrequent operation, so it's not
10968 worth optimizing. */
10969
10970 bool
10971 push_message (void)
10972 {
10973 Lisp_Object msg = current_message ();
10974 Vmessage_stack = Fcons (msg, Vmessage_stack);
10975 return STRINGP (msg);
10976 }
10977
10978
10979 /* Restore message display from the top of Vmessage_stack. */
10980
10981 void
10982 restore_message (void)
10983 {
10984 eassert (CONSP (Vmessage_stack));
10985 message3_nolog (XCAR (Vmessage_stack));
10986 }
10987
10988
10989 /* Handler for unwind-protect calling pop_message. */
10990
10991 void
10992 pop_message_unwind (void)
10993 {
10994 /* Pop the top-most entry off Vmessage_stack. */
10995 eassert (CONSP (Vmessage_stack));
10996 Vmessage_stack = XCDR (Vmessage_stack);
10997 }
10998
10999
11000 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11001 exits. If the stack is not empty, we have a missing pop_message
11002 somewhere. */
11003
11004 void
11005 check_message_stack (void)
11006 {
11007 if (!NILP (Vmessage_stack))
11008 emacs_abort ();
11009 }
11010
11011
11012 /* Truncate to NCHARS what will be displayed in the echo area the next
11013 time we display it---but don't redisplay it now. */
11014
11015 void
11016 truncate_echo_area (ptrdiff_t nchars)
11017 {
11018 if (nchars == 0)
11019 echo_area_buffer[0] = Qnil;
11020 else if (!noninteractive
11021 && INTERACTIVE
11022 && !NILP (echo_area_buffer[0]))
11023 {
11024 struct frame *sf = SELECTED_FRAME ();
11025 /* Error messages get reported properly by cmd_error, so this must be
11026 just an informative message; if the frame hasn't really been
11027 initialized yet, just toss it. */
11028 if (sf->glyphs_initialized_p)
11029 with_echo_area_buffer (0, 0, truncate_message_1, nchars, Qnil);
11030 }
11031 }
11032
11033
11034 /* Helper function for truncate_echo_area. Truncate the current
11035 message to at most NCHARS characters. */
11036
11037 static bool
11038 truncate_message_1 (ptrdiff_t nchars, Lisp_Object a2)
11039 {
11040 if (BEG + nchars < Z)
11041 del_range (BEG + nchars, Z);
11042 if (Z == BEG)
11043 echo_area_buffer[0] = Qnil;
11044 return false;
11045 }
11046
11047 /* Set the current message to STRING. */
11048
11049 static void
11050 set_message (Lisp_Object string)
11051 {
11052 eassert (STRINGP (string));
11053
11054 message_enable_multibyte = STRING_MULTIBYTE (string);
11055
11056 with_echo_area_buffer (0, -1, set_message_1, 0, string);
11057 message_buf_print = false;
11058 help_echo_showing_p = false;
11059
11060 if (STRINGP (Vdebug_on_message)
11061 && STRINGP (string)
11062 && fast_string_match (Vdebug_on_message, string) >= 0)
11063 call_debugger (list2 (Qerror, string));
11064 }
11065
11066
11067 /* Helper function for set_message. First argument is ignored and second
11068 argument has the same meaning as for set_message.
11069 This function is called with the echo area buffer being current. */
11070
11071 static bool
11072 set_message_1 (ptrdiff_t a1, Lisp_Object string)
11073 {
11074 eassert (STRINGP (string));
11075
11076 /* Change multibyteness of the echo buffer appropriately. */
11077 if (message_enable_multibyte
11078 != !NILP (BVAR (current_buffer, enable_multibyte_characters)))
11079 Fset_buffer_multibyte (message_enable_multibyte ? Qt : Qnil);
11080
11081 bset_truncate_lines (current_buffer, message_truncate_lines ? Qt : Qnil);
11082 if (!NILP (BVAR (current_buffer, bidi_display_reordering)))
11083 bset_bidi_paragraph_direction (current_buffer, Qleft_to_right);
11084
11085 /* Insert new message at BEG. */
11086 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
11087
11088 /* This function takes care of single/multibyte conversion.
11089 We just have to ensure that the echo area buffer has the right
11090 setting of enable_multibyte_characters. */
11091 insert_from_string (string, 0, 0, SCHARS (string), SBYTES (string), true);
11092
11093 return false;
11094 }
11095
11096
11097 /* Clear messages. CURRENT_P means clear the current message.
11098 LAST_DISPLAYED_P means clear the message last displayed. */
11099
11100 void
11101 clear_message (bool current_p, bool last_displayed_p)
11102 {
11103 if (current_p)
11104 {
11105 echo_area_buffer[0] = Qnil;
11106 message_cleared_p = true;
11107 }
11108
11109 if (last_displayed_p)
11110 echo_area_buffer[1] = Qnil;
11111
11112 message_buf_print = false;
11113 }
11114
11115 /* Clear garbaged frames.
11116
11117 This function is used where the old redisplay called
11118 redraw_garbaged_frames which in turn called redraw_frame which in
11119 turn called clear_frame. The call to clear_frame was a source of
11120 flickering. I believe a clear_frame is not necessary. It should
11121 suffice in the new redisplay to invalidate all current matrices,
11122 and ensure a complete redisplay of all windows. */
11123
11124 static void
11125 clear_garbaged_frames (void)
11126 {
11127 if (frame_garbaged)
11128 {
11129 Lisp_Object tail, frame;
11130
11131 FOR_EACH_FRAME (tail, frame)
11132 {
11133 struct frame *f = XFRAME (frame);
11134
11135 if (FRAME_VISIBLE_P (f) && FRAME_GARBAGED_P (f))
11136 {
11137 if (f->resized_p)
11138 redraw_frame (f);
11139 else
11140 clear_current_matrices (f);
11141 fset_redisplay (f);
11142 f->garbaged = false;
11143 f->resized_p = false;
11144 }
11145 }
11146
11147 frame_garbaged = false;
11148 }
11149 }
11150
11151
11152 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P, update
11153 selected_frame. */
11154
11155 static void
11156 echo_area_display (bool update_frame_p)
11157 {
11158 Lisp_Object mini_window;
11159 struct window *w;
11160 struct frame *f;
11161 bool window_height_changed_p = false;
11162 struct frame *sf = SELECTED_FRAME ();
11163
11164 mini_window = FRAME_MINIBUF_WINDOW (sf);
11165 w = XWINDOW (mini_window);
11166 f = XFRAME (WINDOW_FRAME (w));
11167
11168 /* Don't display if frame is invisible or not yet initialized. */
11169 if (!FRAME_VISIBLE_P (f) || !f->glyphs_initialized_p)
11170 return;
11171
11172 #ifdef HAVE_WINDOW_SYSTEM
11173 /* When Emacs starts, selected_frame may be the initial terminal
11174 frame. If we let this through, a message would be displayed on
11175 the terminal. */
11176 if (FRAME_INITIAL_P (XFRAME (selected_frame)))
11177 return;
11178 #endif /* HAVE_WINDOW_SYSTEM */
11179
11180 /* Redraw garbaged frames. */
11181 clear_garbaged_frames ();
11182
11183 if (!NILP (echo_area_buffer[0]) || minibuf_level == 0)
11184 {
11185 echo_area_window = mini_window;
11186 window_height_changed_p = display_echo_area (w);
11187 w->must_be_updated_p = true;
11188
11189 /* Update the display, unless called from redisplay_internal.
11190 Also don't update the screen during redisplay itself. The
11191 update will happen at the end of redisplay, and an update
11192 here could cause confusion. */
11193 if (update_frame_p && !redisplaying_p)
11194 {
11195 int n = 0;
11196
11197 /* If the display update has been interrupted by pending
11198 input, update mode lines in the frame. Due to the
11199 pending input, it might have been that redisplay hasn't
11200 been called, so that mode lines above the echo area are
11201 garbaged. This looks odd, so we prevent it here. */
11202 if (!display_completed)
11203 n = redisplay_mode_lines (FRAME_ROOT_WINDOW (f), false);
11204
11205 if (window_height_changed_p
11206 /* Don't do this if Emacs is shutting down. Redisplay
11207 needs to run hooks. */
11208 && !NILP (Vrun_hooks))
11209 {
11210 /* Must update other windows. Likewise as in other
11211 cases, don't let this update be interrupted by
11212 pending input. */
11213 ptrdiff_t count = SPECPDL_INDEX ();
11214 specbind (Qredisplay_dont_pause, Qt);
11215 fset_redisplay (f);
11216 redisplay_internal ();
11217 unbind_to (count, Qnil);
11218 }
11219 else if (FRAME_WINDOW_P (f) && n == 0)
11220 {
11221 /* Window configuration is the same as before.
11222 Can do with a display update of the echo area,
11223 unless we displayed some mode lines. */
11224 update_single_window (w);
11225 flush_frame (f);
11226 }
11227 else
11228 update_frame (f, true, true);
11229
11230 /* If cursor is in the echo area, make sure that the next
11231 redisplay displays the minibuffer, so that the cursor will
11232 be replaced with what the minibuffer wants. */
11233 if (cursor_in_echo_area)
11234 wset_redisplay (XWINDOW (mini_window));
11235 }
11236 }
11237 else if (!EQ (mini_window, selected_window))
11238 wset_redisplay (XWINDOW (mini_window));
11239
11240 /* Last displayed message is now the current message. */
11241 echo_area_buffer[1] = echo_area_buffer[0];
11242 /* Inform read_char that we're not echoing. */
11243 echo_message_buffer = Qnil;
11244
11245 /* Prevent redisplay optimization in redisplay_internal by resetting
11246 this_line_start_pos. This is done because the mini-buffer now
11247 displays the message instead of its buffer text. */
11248 if (EQ (mini_window, selected_window))
11249 CHARPOS (this_line_start_pos) = 0;
11250
11251 if (window_height_changed_p)
11252 {
11253 fset_redisplay (f);
11254
11255 /* If window configuration was changed, frames may have been
11256 marked garbaged. Clear them or we will experience
11257 surprises wrt scrolling.
11258 FIXME: How/why/when? */
11259 clear_garbaged_frames ();
11260 }
11261 }
11262
11263 /* True if W's buffer was changed but not saved. */
11264
11265 static bool
11266 window_buffer_changed (struct window *w)
11267 {
11268 struct buffer *b = XBUFFER (w->contents);
11269
11270 eassert (BUFFER_LIVE_P (b));
11271
11272 return (BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)) != w->last_had_star;
11273 }
11274
11275 /* True if W has %c in its mode line and mode line should be updated. */
11276
11277 static bool
11278 mode_line_update_needed (struct window *w)
11279 {
11280 return (w->column_number_displayed != -1
11281 && !(PT == w->last_point && !window_outdated (w))
11282 && (w->column_number_displayed != current_column ()));
11283 }
11284
11285 /* True if window start of W is frozen and may not be changed during
11286 redisplay. */
11287
11288 static bool
11289 window_frozen_p (struct window *w)
11290 {
11291 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w))))
11292 {
11293 Lisp_Object window;
11294
11295 XSETWINDOW (window, w);
11296 if (MINI_WINDOW_P (w))
11297 return false;
11298 else if (EQ (window, selected_window))
11299 return false;
11300 else if (MINI_WINDOW_P (XWINDOW (selected_window))
11301 && EQ (window, Vminibuf_scroll_window))
11302 /* This special window can't be frozen too. */
11303 return false;
11304 else
11305 return true;
11306 }
11307 return false;
11308 }
11309
11310 /***********************************************************************
11311 Mode Lines and Frame Titles
11312 ***********************************************************************/
11313
11314 /* A buffer for constructing non-propertized mode-line strings and
11315 frame titles in it; allocated from the heap in init_xdisp and
11316 resized as needed in store_mode_line_noprop_char. */
11317
11318 static char *mode_line_noprop_buf;
11319
11320 /* The buffer's end, and a current output position in it. */
11321
11322 static char *mode_line_noprop_buf_end;
11323 static char *mode_line_noprop_ptr;
11324
11325 #define MODE_LINE_NOPROP_LEN(start) \
11326 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11327
11328 static enum {
11329 MODE_LINE_DISPLAY = 0,
11330 MODE_LINE_TITLE,
11331 MODE_LINE_NOPROP,
11332 MODE_LINE_STRING
11333 } mode_line_target;
11334
11335 /* Alist that caches the results of :propertize.
11336 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11337 static Lisp_Object mode_line_proptrans_alist;
11338
11339 /* List of strings making up the mode-line. */
11340 static Lisp_Object mode_line_string_list;
11341
11342 /* Base face property when building propertized mode line string. */
11343 static Lisp_Object mode_line_string_face;
11344 static Lisp_Object mode_line_string_face_prop;
11345
11346
11347 /* Unwind data for mode line strings */
11348
11349 static Lisp_Object Vmode_line_unwind_vector;
11350
11351 static Lisp_Object
11352 format_mode_line_unwind_data (struct frame *target_frame,
11353 struct buffer *obuf,
11354 Lisp_Object owin,
11355 bool save_proptrans)
11356 {
11357 Lisp_Object vector, tmp;
11358
11359 /* Reduce consing by keeping one vector in
11360 Vwith_echo_area_save_vector. */
11361 vector = Vmode_line_unwind_vector;
11362 Vmode_line_unwind_vector = Qnil;
11363
11364 if (NILP (vector))
11365 vector = Fmake_vector (make_number (10), Qnil);
11366
11367 ASET (vector, 0, make_number (mode_line_target));
11368 ASET (vector, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11369 ASET (vector, 2, mode_line_string_list);
11370 ASET (vector, 3, save_proptrans ? mode_line_proptrans_alist : Qt);
11371 ASET (vector, 4, mode_line_string_face);
11372 ASET (vector, 5, mode_line_string_face_prop);
11373
11374 if (obuf)
11375 XSETBUFFER (tmp, obuf);
11376 else
11377 tmp = Qnil;
11378 ASET (vector, 6, tmp);
11379 ASET (vector, 7, owin);
11380 if (target_frame)
11381 {
11382 /* Similarly to `with-selected-window', if the operation selects
11383 a window on another frame, we must restore that frame's
11384 selected window, and (for a tty) the top-frame. */
11385 ASET (vector, 8, target_frame->selected_window);
11386 if (FRAME_TERMCAP_P (target_frame))
11387 ASET (vector, 9, FRAME_TTY (target_frame)->top_frame);
11388 }
11389
11390 return vector;
11391 }
11392
11393 static void
11394 unwind_format_mode_line (Lisp_Object vector)
11395 {
11396 Lisp_Object old_window = AREF (vector, 7);
11397 Lisp_Object target_frame_window = AREF (vector, 8);
11398 Lisp_Object old_top_frame = AREF (vector, 9);
11399
11400 mode_line_target = XINT (AREF (vector, 0));
11401 mode_line_noprop_ptr = mode_line_noprop_buf + XINT (AREF (vector, 1));
11402 mode_line_string_list = AREF (vector, 2);
11403 if (! EQ (AREF (vector, 3), Qt))
11404 mode_line_proptrans_alist = AREF (vector, 3);
11405 mode_line_string_face = AREF (vector, 4);
11406 mode_line_string_face_prop = AREF (vector, 5);
11407
11408 /* Select window before buffer, since it may change the buffer. */
11409 if (!NILP (old_window))
11410 {
11411 /* If the operation that we are unwinding had selected a window
11412 on a different frame, reset its frame-selected-window. For a
11413 text terminal, reset its top-frame if necessary. */
11414 if (!NILP (target_frame_window))
11415 {
11416 Lisp_Object frame
11417 = WINDOW_FRAME (XWINDOW (target_frame_window));
11418
11419 if (!EQ (frame, WINDOW_FRAME (XWINDOW (old_window))))
11420 Fselect_window (target_frame_window, Qt);
11421
11422 if (!NILP (old_top_frame) && !EQ (old_top_frame, frame))
11423 Fselect_frame (old_top_frame, Qt);
11424 }
11425
11426 Fselect_window (old_window, Qt);
11427 }
11428
11429 if (!NILP (AREF (vector, 6)))
11430 {
11431 set_buffer_internal_1 (XBUFFER (AREF (vector, 6)));
11432 ASET (vector, 6, Qnil);
11433 }
11434
11435 Vmode_line_unwind_vector = vector;
11436 }
11437
11438
11439 /* Store a single character C for the frame title in mode_line_noprop_buf.
11440 Re-allocate mode_line_noprop_buf if necessary. */
11441
11442 static void
11443 store_mode_line_noprop_char (char c)
11444 {
11445 /* If output position has reached the end of the allocated buffer,
11446 increase the buffer's size. */
11447 if (mode_line_noprop_ptr == mode_line_noprop_buf_end)
11448 {
11449 ptrdiff_t len = MODE_LINE_NOPROP_LEN (0);
11450 ptrdiff_t size = len;
11451 mode_line_noprop_buf =
11452 xpalloc (mode_line_noprop_buf, &size, 1, STRING_BYTES_BOUND, 1);
11453 mode_line_noprop_buf_end = mode_line_noprop_buf + size;
11454 mode_line_noprop_ptr = mode_line_noprop_buf + len;
11455 }
11456
11457 *mode_line_noprop_ptr++ = c;
11458 }
11459
11460
11461 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11462 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11463 characters that yield more columns than PRECISION; PRECISION <= 0
11464 means copy the whole string. Pad with spaces until FIELD_WIDTH
11465 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11466 pad. Called from display_mode_element when it is used to build a
11467 frame title. */
11468
11469 static int
11470 store_mode_line_noprop (const char *string, int field_width, int precision)
11471 {
11472 const unsigned char *str = (const unsigned char *) string;
11473 int n = 0;
11474 ptrdiff_t dummy, nbytes;
11475
11476 /* Copy at most PRECISION chars from STR. */
11477 nbytes = strlen (string);
11478 n += c_string_width (str, nbytes, precision, &dummy, &nbytes);
11479 while (nbytes--)
11480 store_mode_line_noprop_char (*str++);
11481
11482 /* Fill up with spaces until FIELD_WIDTH reached. */
11483 while (field_width > 0
11484 && n < field_width)
11485 {
11486 store_mode_line_noprop_char (' ');
11487 ++n;
11488 }
11489
11490 return n;
11491 }
11492
11493 /***********************************************************************
11494 Frame Titles
11495 ***********************************************************************/
11496
11497 #ifdef HAVE_WINDOW_SYSTEM
11498
11499 /* Set the title of FRAME, if it has changed. The title format is
11500 Vicon_title_format if FRAME is iconified, otherwise it is
11501 frame_title_format. */
11502
11503 static void
11504 x_consider_frame_title (Lisp_Object frame)
11505 {
11506 struct frame *f = XFRAME (frame);
11507
11508 if (FRAME_WINDOW_P (f)
11509 || FRAME_MINIBUF_ONLY_P (f)
11510 || f->explicit_name)
11511 {
11512 /* Do we have more than one visible frame on this X display? */
11513 Lisp_Object tail, other_frame, fmt;
11514 ptrdiff_t title_start;
11515 char *title;
11516 ptrdiff_t len;
11517 struct it it;
11518 ptrdiff_t count = SPECPDL_INDEX ();
11519
11520 FOR_EACH_FRAME (tail, other_frame)
11521 {
11522 struct frame *tf = XFRAME (other_frame);
11523
11524 if (tf != f
11525 && FRAME_KBOARD (tf) == FRAME_KBOARD (f)
11526 && !FRAME_MINIBUF_ONLY_P (tf)
11527 && !EQ (other_frame, tip_frame)
11528 && (FRAME_VISIBLE_P (tf) || FRAME_ICONIFIED_P (tf)))
11529 break;
11530 }
11531
11532 /* Set global variable indicating that multiple frames exist. */
11533 multiple_frames = CONSP (tail);
11534
11535 /* Switch to the buffer of selected window of the frame. Set up
11536 mode_line_target so that display_mode_element will output into
11537 mode_line_noprop_buf; then display the title. */
11538 record_unwind_protect (unwind_format_mode_line,
11539 format_mode_line_unwind_data
11540 (f, current_buffer, selected_window, false));
11541
11542 Fselect_window (f->selected_window, Qt);
11543 set_buffer_internal_1
11544 (XBUFFER (XWINDOW (f->selected_window)->contents));
11545 fmt = FRAME_ICONIFIED_P (f) ? Vicon_title_format : Vframe_title_format;
11546
11547 mode_line_target = MODE_LINE_TITLE;
11548 title_start = MODE_LINE_NOPROP_LEN (0);
11549 init_iterator (&it, XWINDOW (f->selected_window), -1, -1,
11550 NULL, DEFAULT_FACE_ID);
11551 display_mode_element (&it, 0, -1, -1, fmt, Qnil, false);
11552 len = MODE_LINE_NOPROP_LEN (title_start);
11553 title = mode_line_noprop_buf + title_start;
11554 unbind_to (count, Qnil);
11555
11556 /* Set the title only if it's changed. This avoids consing in
11557 the common case where it hasn't. (If it turns out that we've
11558 already wasted too much time by walking through the list with
11559 display_mode_element, then we might need to optimize at a
11560 higher level than this.) */
11561 if (! STRINGP (f->name)
11562 || SBYTES (f->name) != len
11563 || memcmp (title, SDATA (f->name), len) != 0)
11564 x_implicitly_set_name (f, make_string (title, len), Qnil);
11565 }
11566 }
11567
11568 #endif /* not HAVE_WINDOW_SYSTEM */
11569
11570 \f
11571 /***********************************************************************
11572 Menu Bars
11573 ***********************************************************************/
11574
11575 /* True if we will not redisplay all visible windows. */
11576 #define REDISPLAY_SOME_P() \
11577 ((windows_or_buffers_changed == 0 \
11578 || windows_or_buffers_changed == REDISPLAY_SOME) \
11579 && (update_mode_lines == 0 \
11580 || update_mode_lines == REDISPLAY_SOME))
11581
11582 /* Prepare for redisplay by updating menu-bar item lists when
11583 appropriate. This can call eval. */
11584
11585 static void
11586 prepare_menu_bars (void)
11587 {
11588 bool all_windows = windows_or_buffers_changed || update_mode_lines;
11589 bool some_windows = REDISPLAY_SOME_P ();
11590 Lisp_Object tooltip_frame;
11591
11592 #ifdef HAVE_WINDOW_SYSTEM
11593 tooltip_frame = tip_frame;
11594 #else
11595 tooltip_frame = Qnil;
11596 #endif
11597
11598 if (FUNCTIONP (Vpre_redisplay_function))
11599 {
11600 Lisp_Object windows = all_windows ? Qt : Qnil;
11601 if (all_windows && some_windows)
11602 {
11603 Lisp_Object ws = window_list ();
11604 for (windows = Qnil; CONSP (ws); ws = XCDR (ws))
11605 {
11606 Lisp_Object this = XCAR (ws);
11607 struct window *w = XWINDOW (this);
11608 if (w->redisplay
11609 || XFRAME (w->frame)->redisplay
11610 || XBUFFER (w->contents)->text->redisplay)
11611 {
11612 windows = Fcons (this, windows);
11613 }
11614 }
11615 }
11616 safe__call1 (true, Vpre_redisplay_function, windows);
11617 }
11618
11619 /* Update all frame titles based on their buffer names, etc. We do
11620 this before the menu bars so that the buffer-menu will show the
11621 up-to-date frame titles. */
11622 #ifdef HAVE_WINDOW_SYSTEM
11623 if (all_windows)
11624 {
11625 Lisp_Object tail, frame;
11626
11627 FOR_EACH_FRAME (tail, frame)
11628 {
11629 struct frame *f = XFRAME (frame);
11630 struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
11631 if (some_windows
11632 && !f->redisplay
11633 && !w->redisplay
11634 && !XBUFFER (w->contents)->text->redisplay)
11635 continue;
11636
11637 if (!EQ (frame, tooltip_frame)
11638 && (FRAME_ICONIFIED_P (f)
11639 || FRAME_VISIBLE_P (f) == 1
11640 /* Exclude TTY frames that are obscured because they
11641 are not the top frame on their console. This is
11642 because x_consider_frame_title actually switches
11643 to the frame, which for TTY frames means it is
11644 marked as garbaged, and will be completely
11645 redrawn on the next redisplay cycle. This causes
11646 TTY frames to be completely redrawn, when there
11647 are more than one of them, even though nothing
11648 should be changed on display. */
11649 || (FRAME_VISIBLE_P (f) == 2 && FRAME_WINDOW_P (f))))
11650 x_consider_frame_title (frame);
11651 }
11652 }
11653 #endif /* HAVE_WINDOW_SYSTEM */
11654
11655 /* Update the menu bar item lists, if appropriate. This has to be
11656 done before any actual redisplay or generation of display lines. */
11657
11658 if (all_windows)
11659 {
11660 Lisp_Object tail, frame;
11661 ptrdiff_t count = SPECPDL_INDEX ();
11662 /* True means that update_menu_bar has run its hooks
11663 so any further calls to update_menu_bar shouldn't do so again. */
11664 bool menu_bar_hooks_run = false;
11665
11666 record_unwind_save_match_data ();
11667
11668 FOR_EACH_FRAME (tail, frame)
11669 {
11670 struct frame *f = XFRAME (frame);
11671 struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
11672
11673 /* Ignore tooltip frame. */
11674 if (EQ (frame, tooltip_frame))
11675 continue;
11676
11677 if (some_windows
11678 && !f->redisplay
11679 && !w->redisplay
11680 && !XBUFFER (w->contents)->text->redisplay)
11681 continue;
11682
11683 /* If a window on this frame changed size, report that to
11684 the user and clear the size-change flag. */
11685 if (FRAME_WINDOW_SIZES_CHANGED (f))
11686 {
11687 Lisp_Object functions;
11688
11689 /* Clear flag first in case we get an error below. */
11690 FRAME_WINDOW_SIZES_CHANGED (f) = false;
11691 functions = Vwindow_size_change_functions;
11692
11693 while (CONSP (functions))
11694 {
11695 if (!EQ (XCAR (functions), Qt))
11696 call1 (XCAR (functions), frame);
11697 functions = XCDR (functions);
11698 }
11699 }
11700
11701 menu_bar_hooks_run = update_menu_bar (f, false, menu_bar_hooks_run);
11702 #ifdef HAVE_WINDOW_SYSTEM
11703 update_tool_bar (f, false);
11704 #endif
11705 }
11706
11707 unbind_to (count, Qnil);
11708 }
11709 else
11710 {
11711 struct frame *sf = SELECTED_FRAME ();
11712 update_menu_bar (sf, true, false);
11713 #ifdef HAVE_WINDOW_SYSTEM
11714 update_tool_bar (sf, true);
11715 #endif
11716 }
11717 }
11718
11719
11720 /* Update the menu bar item list for frame F. This has to be done
11721 before we start to fill in any display lines, because it can call
11722 eval.
11723
11724 If SAVE_MATCH_DATA, we must save and restore it here.
11725
11726 If HOOKS_RUN, a previous call to update_menu_bar
11727 already ran the menu bar hooks for this redisplay, so there
11728 is no need to run them again. The return value is the
11729 updated value of this flag, to pass to the next call. */
11730
11731 static bool
11732 update_menu_bar (struct frame *f, bool save_match_data, bool hooks_run)
11733 {
11734 Lisp_Object window;
11735 struct window *w;
11736
11737 /* If called recursively during a menu update, do nothing. This can
11738 happen when, for instance, an activate-menubar-hook causes a
11739 redisplay. */
11740 if (inhibit_menubar_update)
11741 return hooks_run;
11742
11743 window = FRAME_SELECTED_WINDOW (f);
11744 w = XWINDOW (window);
11745
11746 if (FRAME_WINDOW_P (f)
11747 ?
11748 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11749 || defined (HAVE_NS) || defined (USE_GTK)
11750 FRAME_EXTERNAL_MENU_BAR (f)
11751 #else
11752 FRAME_MENU_BAR_LINES (f) > 0
11753 #endif
11754 : FRAME_MENU_BAR_LINES (f) > 0)
11755 {
11756 /* If the user has switched buffers or windows, we need to
11757 recompute to reflect the new bindings. But we'll
11758 recompute when update_mode_lines is set too; that means
11759 that people can use force-mode-line-update to request
11760 that the menu bar be recomputed. The adverse effect on
11761 the rest of the redisplay algorithm is about the same as
11762 windows_or_buffers_changed anyway. */
11763 if (windows_or_buffers_changed
11764 /* This used to test w->update_mode_line, but we believe
11765 there is no need to recompute the menu in that case. */
11766 || update_mode_lines
11767 || window_buffer_changed (w))
11768 {
11769 struct buffer *prev = current_buffer;
11770 ptrdiff_t count = SPECPDL_INDEX ();
11771
11772 specbind (Qinhibit_menubar_update, Qt);
11773
11774 set_buffer_internal_1 (XBUFFER (w->contents));
11775 if (save_match_data)
11776 record_unwind_save_match_data ();
11777 if (NILP (Voverriding_local_map_menu_flag))
11778 {
11779 specbind (Qoverriding_terminal_local_map, Qnil);
11780 specbind (Qoverriding_local_map, Qnil);
11781 }
11782
11783 if (!hooks_run)
11784 {
11785 /* Run the Lucid hook. */
11786 safe_run_hooks (Qactivate_menubar_hook);
11787
11788 /* If it has changed current-menubar from previous value,
11789 really recompute the menu-bar from the value. */
11790 if (! NILP (Vlucid_menu_bar_dirty_flag))
11791 call0 (Qrecompute_lucid_menubar);
11792
11793 safe_run_hooks (Qmenu_bar_update_hook);
11794
11795 hooks_run = true;
11796 }
11797
11798 XSETFRAME (Vmenu_updating_frame, f);
11799 fset_menu_bar_items (f, menu_bar_items (FRAME_MENU_BAR_ITEMS (f)));
11800
11801 /* Redisplay the menu bar in case we changed it. */
11802 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11803 || defined (HAVE_NS) || defined (USE_GTK)
11804 if (FRAME_WINDOW_P (f))
11805 {
11806 #if defined (HAVE_NS)
11807 /* All frames on Mac OS share the same menubar. So only
11808 the selected frame should be allowed to set it. */
11809 if (f == SELECTED_FRAME ())
11810 #endif
11811 set_frame_menubar (f, false, false);
11812 }
11813 else
11814 /* On a terminal screen, the menu bar is an ordinary screen
11815 line, and this makes it get updated. */
11816 w->update_mode_line = true;
11817 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11818 /* In the non-toolkit version, the menu bar is an ordinary screen
11819 line, and this makes it get updated. */
11820 w->update_mode_line = true;
11821 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11822
11823 unbind_to (count, Qnil);
11824 set_buffer_internal_1 (prev);
11825 }
11826 }
11827
11828 return hooks_run;
11829 }
11830
11831 /***********************************************************************
11832 Tool-bars
11833 ***********************************************************************/
11834
11835 #ifdef HAVE_WINDOW_SYSTEM
11836
11837 /* Select `frame' temporarily without running all the code in
11838 do_switch_frame.
11839 FIXME: Maybe do_switch_frame should be trimmed down similarly
11840 when `norecord' is set. */
11841 static void
11842 fast_set_selected_frame (Lisp_Object frame)
11843 {
11844 if (!EQ (selected_frame, frame))
11845 {
11846 selected_frame = frame;
11847 selected_window = XFRAME (frame)->selected_window;
11848 }
11849 }
11850
11851 /* Update the tool-bar item list for frame F. This has to be done
11852 before we start to fill in any display lines. Called from
11853 prepare_menu_bars. If SAVE_MATCH_DATA, we must save
11854 and restore it here. */
11855
11856 static void
11857 update_tool_bar (struct frame *f, bool save_match_data)
11858 {
11859 #if defined (USE_GTK) || defined (HAVE_NS)
11860 bool do_update = FRAME_EXTERNAL_TOOL_BAR (f);
11861 #else
11862 bool do_update = (WINDOWP (f->tool_bar_window)
11863 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)) > 0);
11864 #endif
11865
11866 if (do_update)
11867 {
11868 Lisp_Object window;
11869 struct window *w;
11870
11871 window = FRAME_SELECTED_WINDOW (f);
11872 w = XWINDOW (window);
11873
11874 /* If the user has switched buffers or windows, we need to
11875 recompute to reflect the new bindings. But we'll
11876 recompute when update_mode_lines is set too; that means
11877 that people can use force-mode-line-update to request
11878 that the menu bar be recomputed. The adverse effect on
11879 the rest of the redisplay algorithm is about the same as
11880 windows_or_buffers_changed anyway. */
11881 if (windows_or_buffers_changed
11882 || w->update_mode_line
11883 || update_mode_lines
11884 || window_buffer_changed (w))
11885 {
11886 struct buffer *prev = current_buffer;
11887 ptrdiff_t count = SPECPDL_INDEX ();
11888 Lisp_Object frame, new_tool_bar;
11889 int new_n_tool_bar;
11890
11891 /* Set current_buffer to the buffer of the selected
11892 window of the frame, so that we get the right local
11893 keymaps. */
11894 set_buffer_internal_1 (XBUFFER (w->contents));
11895
11896 /* Save match data, if we must. */
11897 if (save_match_data)
11898 record_unwind_save_match_data ();
11899
11900 /* Make sure that we don't accidentally use bogus keymaps. */
11901 if (NILP (Voverriding_local_map_menu_flag))
11902 {
11903 specbind (Qoverriding_terminal_local_map, Qnil);
11904 specbind (Qoverriding_local_map, Qnil);
11905 }
11906
11907 /* We must temporarily set the selected frame to this frame
11908 before calling tool_bar_items, because the calculation of
11909 the tool-bar keymap uses the selected frame (see
11910 `tool-bar-make-keymap' in tool-bar.el). */
11911 eassert (EQ (selected_window,
11912 /* Since we only explicitly preserve selected_frame,
11913 check that selected_window would be redundant. */
11914 XFRAME (selected_frame)->selected_window));
11915 record_unwind_protect (fast_set_selected_frame, selected_frame);
11916 XSETFRAME (frame, f);
11917 fast_set_selected_frame (frame);
11918
11919 /* Build desired tool-bar items from keymaps. */
11920 new_tool_bar
11921 = tool_bar_items (Fcopy_sequence (f->tool_bar_items),
11922 &new_n_tool_bar);
11923
11924 /* Redisplay the tool-bar if we changed it. */
11925 if (new_n_tool_bar != f->n_tool_bar_items
11926 || NILP (Fequal (new_tool_bar, f->tool_bar_items)))
11927 {
11928 /* Redisplay that happens asynchronously due to an expose event
11929 may access f->tool_bar_items. Make sure we update both
11930 variables within BLOCK_INPUT so no such event interrupts. */
11931 block_input ();
11932 fset_tool_bar_items (f, new_tool_bar);
11933 f->n_tool_bar_items = new_n_tool_bar;
11934 w->update_mode_line = true;
11935 unblock_input ();
11936 }
11937
11938 unbind_to (count, Qnil);
11939 set_buffer_internal_1 (prev);
11940 }
11941 }
11942 }
11943
11944 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
11945
11946 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11947 F's desired tool-bar contents. F->tool_bar_items must have
11948 been set up previously by calling prepare_menu_bars. */
11949
11950 static void
11951 build_desired_tool_bar_string (struct frame *f)
11952 {
11953 int i, size, size_needed;
11954 Lisp_Object image, plist;
11955
11956 image = plist = Qnil;
11957
11958 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11959 Otherwise, make a new string. */
11960
11961 /* The size of the string we might be able to reuse. */
11962 size = (STRINGP (f->desired_tool_bar_string)
11963 ? SCHARS (f->desired_tool_bar_string)
11964 : 0);
11965
11966 /* We need one space in the string for each image. */
11967 size_needed = f->n_tool_bar_items;
11968
11969 /* Reuse f->desired_tool_bar_string, if possible. */
11970 if (size < size_needed || NILP (f->desired_tool_bar_string))
11971 fset_desired_tool_bar_string
11972 (f, Fmake_string (make_number (size_needed), make_number (' ')));
11973 else
11974 {
11975 AUTO_LIST4 (props, Qdisplay, Qnil, Qmenu_item, Qnil);
11976 Fremove_text_properties (make_number (0), make_number (size),
11977 props, f->desired_tool_bar_string);
11978 }
11979
11980 /* Put a `display' property on the string for the images to display,
11981 put a `menu_item' property on tool-bar items with a value that
11982 is the index of the item in F's tool-bar item vector. */
11983 for (i = 0; i < f->n_tool_bar_items; ++i)
11984 {
11985 #define PROP(IDX) \
11986 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11987
11988 bool enabled_p = !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P));
11989 bool selected_p = !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P));
11990 int hmargin, vmargin, relief, idx, end;
11991
11992 /* If image is a vector, choose the image according to the
11993 button state. */
11994 image = PROP (TOOL_BAR_ITEM_IMAGES);
11995 if (VECTORP (image))
11996 {
11997 if (enabled_p)
11998 idx = (selected_p
11999 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12000 : TOOL_BAR_IMAGE_ENABLED_DESELECTED);
12001 else
12002 idx = (selected_p
12003 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12004 : TOOL_BAR_IMAGE_DISABLED_DESELECTED);
12005
12006 eassert (ASIZE (image) >= idx);
12007 image = AREF (image, idx);
12008 }
12009 else
12010 idx = -1;
12011
12012 /* Ignore invalid image specifications. */
12013 if (!valid_image_p (image))
12014 continue;
12015
12016 /* Display the tool-bar button pressed, or depressed. */
12017 plist = Fcopy_sequence (XCDR (image));
12018
12019 /* Compute margin and relief to draw. */
12020 relief = (tool_bar_button_relief >= 0
12021 ? tool_bar_button_relief
12022 : DEFAULT_TOOL_BAR_BUTTON_RELIEF);
12023 hmargin = vmargin = relief;
12024
12025 if (RANGED_INTEGERP (1, Vtool_bar_button_margin,
12026 INT_MAX - max (hmargin, vmargin)))
12027 {
12028 hmargin += XFASTINT (Vtool_bar_button_margin);
12029 vmargin += XFASTINT (Vtool_bar_button_margin);
12030 }
12031 else if (CONSP (Vtool_bar_button_margin))
12032 {
12033 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin),
12034 INT_MAX - hmargin))
12035 hmargin += XFASTINT (XCAR (Vtool_bar_button_margin));
12036
12037 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin),
12038 INT_MAX - vmargin))
12039 vmargin += XFASTINT (XCDR (Vtool_bar_button_margin));
12040 }
12041
12042 if (auto_raise_tool_bar_buttons_p)
12043 {
12044 /* Add a `:relief' property to the image spec if the item is
12045 selected. */
12046 if (selected_p)
12047 {
12048 plist = Fplist_put (plist, QCrelief, make_number (-relief));
12049 hmargin -= relief;
12050 vmargin -= relief;
12051 }
12052 }
12053 else
12054 {
12055 /* If image is selected, display it pressed, i.e. with a
12056 negative relief. If it's not selected, display it with a
12057 raised relief. */
12058 plist = Fplist_put (plist, QCrelief,
12059 (selected_p
12060 ? make_number (-relief)
12061 : make_number (relief)));
12062 hmargin -= relief;
12063 vmargin -= relief;
12064 }
12065
12066 /* Put a margin around the image. */
12067 if (hmargin || vmargin)
12068 {
12069 if (hmargin == vmargin)
12070 plist = Fplist_put (plist, QCmargin, make_number (hmargin));
12071 else
12072 plist = Fplist_put (plist, QCmargin,
12073 Fcons (make_number (hmargin),
12074 make_number (vmargin)));
12075 }
12076
12077 /* If button is not enabled, and we don't have special images
12078 for the disabled state, make the image appear disabled by
12079 applying an appropriate algorithm to it. */
12080 if (!enabled_p && idx < 0)
12081 plist = Fplist_put (plist, QCconversion, Qdisabled);
12082
12083 /* Put a `display' text property on the string for the image to
12084 display. Put a `menu-item' property on the string that gives
12085 the start of this item's properties in the tool-bar items
12086 vector. */
12087 image = Fcons (Qimage, plist);
12088 AUTO_LIST4 (props, Qdisplay, image, Qmenu_item,
12089 make_number (i * TOOL_BAR_ITEM_NSLOTS));
12090
12091 /* Let the last image hide all remaining spaces in the tool bar
12092 string. The string can be longer than needed when we reuse a
12093 previous string. */
12094 if (i + 1 == f->n_tool_bar_items)
12095 end = SCHARS (f->desired_tool_bar_string);
12096 else
12097 end = i + 1;
12098 Fadd_text_properties (make_number (i), make_number (end),
12099 props, f->desired_tool_bar_string);
12100 #undef PROP
12101 }
12102 }
12103
12104
12105 /* Display one line of the tool-bar of frame IT->f.
12106
12107 HEIGHT specifies the desired height of the tool-bar line.
12108 If the actual height of the glyph row is less than HEIGHT, the
12109 row's height is increased to HEIGHT, and the icons are centered
12110 vertically in the new height.
12111
12112 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12113 count a final empty row in case the tool-bar width exactly matches
12114 the window width.
12115 */
12116
12117 static void
12118 display_tool_bar_line (struct it *it, int height)
12119 {
12120 struct glyph_row *row = it->glyph_row;
12121 int max_x = it->last_visible_x;
12122 struct glyph *last;
12123
12124 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12125 clear_glyph_row (row);
12126 row->enabled_p = true;
12127 row->y = it->current_y;
12128
12129 /* Note that this isn't made use of if the face hasn't a box,
12130 so there's no need to check the face here. */
12131 it->start_of_box_run_p = true;
12132
12133 while (it->current_x < max_x)
12134 {
12135 int x, n_glyphs_before, i, nglyphs;
12136 struct it it_before;
12137
12138 /* Get the next display element. */
12139 if (!get_next_display_element (it))
12140 {
12141 /* Don't count empty row if we are counting needed tool-bar lines. */
12142 if (height < 0 && !it->hpos)
12143 return;
12144 break;
12145 }
12146
12147 /* Produce glyphs. */
12148 n_glyphs_before = row->used[TEXT_AREA];
12149 it_before = *it;
12150
12151 PRODUCE_GLYPHS (it);
12152
12153 nglyphs = row->used[TEXT_AREA] - n_glyphs_before;
12154 i = 0;
12155 x = it_before.current_x;
12156 while (i < nglyphs)
12157 {
12158 struct glyph *glyph = row->glyphs[TEXT_AREA] + n_glyphs_before + i;
12159
12160 if (x + glyph->pixel_width > max_x)
12161 {
12162 /* Glyph doesn't fit on line. Backtrack. */
12163 row->used[TEXT_AREA] = n_glyphs_before;
12164 *it = it_before;
12165 /* If this is the only glyph on this line, it will never fit on the
12166 tool-bar, so skip it. But ensure there is at least one glyph,
12167 so we don't accidentally disable the tool-bar. */
12168 if (n_glyphs_before == 0
12169 && (it->vpos > 0 || IT_STRING_CHARPOS (*it) < it->end_charpos-1))
12170 break;
12171 goto out;
12172 }
12173
12174 ++it->hpos;
12175 x += glyph->pixel_width;
12176 ++i;
12177 }
12178
12179 /* Stop at line end. */
12180 if (ITERATOR_AT_END_OF_LINE_P (it))
12181 break;
12182
12183 set_iterator_to_next (it, true);
12184 }
12185
12186 out:;
12187
12188 row->displays_text_p = row->used[TEXT_AREA] != 0;
12189
12190 /* Use default face for the border below the tool bar.
12191
12192 FIXME: When auto-resize-tool-bars is grow-only, there is
12193 no additional border below the possibly empty tool-bar lines.
12194 So to make the extra empty lines look "normal", we have to
12195 use the tool-bar face for the border too. */
12196 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row)
12197 && !EQ (Vauto_resize_tool_bars, Qgrow_only))
12198 it->face_id = DEFAULT_FACE_ID;
12199
12200 extend_face_to_end_of_line (it);
12201 last = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1;
12202 last->right_box_line_p = true;
12203 if (last == row->glyphs[TEXT_AREA])
12204 last->left_box_line_p = true;
12205
12206 /* Make line the desired height and center it vertically. */
12207 if ((height -= it->max_ascent + it->max_descent) > 0)
12208 {
12209 /* Don't add more than one line height. */
12210 height %= FRAME_LINE_HEIGHT (it->f);
12211 it->max_ascent += height / 2;
12212 it->max_descent += (height + 1) / 2;
12213 }
12214
12215 compute_line_metrics (it);
12216
12217 /* If line is empty, make it occupy the rest of the tool-bar. */
12218 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row))
12219 {
12220 row->height = row->phys_height = it->last_visible_y - row->y;
12221 row->visible_height = row->height;
12222 row->ascent = row->phys_ascent = 0;
12223 row->extra_line_spacing = 0;
12224 }
12225
12226 row->full_width_p = true;
12227 row->continued_p = false;
12228 row->truncated_on_left_p = false;
12229 row->truncated_on_right_p = false;
12230
12231 it->current_x = it->hpos = 0;
12232 it->current_y += row->height;
12233 ++it->vpos;
12234 ++it->glyph_row;
12235 }
12236
12237
12238 /* Value is the number of pixels needed to make all tool-bar items of
12239 frame F visible. The actual number of glyph rows needed is
12240 returned in *N_ROWS if non-NULL. */
12241 static int
12242 tool_bar_height (struct frame *f, int *n_rows, bool pixelwise)
12243 {
12244 struct window *w = XWINDOW (f->tool_bar_window);
12245 struct it it;
12246 /* tool_bar_height is called from redisplay_tool_bar after building
12247 the desired matrix, so use (unused) mode-line row as temporary row to
12248 avoid destroying the first tool-bar row. */
12249 struct glyph_row *temp_row = MATRIX_MODE_LINE_ROW (w->desired_matrix);
12250
12251 /* Initialize an iterator for iteration over
12252 F->desired_tool_bar_string in the tool-bar window of frame F. */
12253 init_iterator (&it, w, -1, -1, temp_row, TOOL_BAR_FACE_ID);
12254 temp_row->reversed_p = false;
12255 it.first_visible_x = 0;
12256 it.last_visible_x = WINDOW_PIXEL_WIDTH (w);
12257 reseat_to_string (&it, NULL, f->desired_tool_bar_string, 0, 0, 0, -1);
12258 it.paragraph_embedding = L2R;
12259
12260 while (!ITERATOR_AT_END_P (&it))
12261 {
12262 clear_glyph_row (temp_row);
12263 it.glyph_row = temp_row;
12264 display_tool_bar_line (&it, -1);
12265 }
12266 clear_glyph_row (temp_row);
12267
12268 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12269 if (n_rows)
12270 *n_rows = it.vpos > 0 ? it.vpos : -1;
12271
12272 if (pixelwise)
12273 return it.current_y;
12274 else
12275 return (it.current_y + FRAME_LINE_HEIGHT (f) - 1) / FRAME_LINE_HEIGHT (f);
12276 }
12277
12278 #endif /* !USE_GTK && !HAVE_NS */
12279
12280 DEFUN ("tool-bar-height", Ftool_bar_height, Stool_bar_height,
12281 0, 2, 0,
12282 doc: /* Return the number of lines occupied by the tool bar of FRAME.
12283 If FRAME is nil or omitted, use the selected frame. Optional argument
12284 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12285 (Lisp_Object frame, Lisp_Object pixelwise)
12286 {
12287 int height = 0;
12288
12289 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12290 struct frame *f = decode_any_frame (frame);
12291
12292 if (WINDOWP (f->tool_bar_window)
12293 && WINDOW_PIXEL_HEIGHT (XWINDOW (f->tool_bar_window)) > 0)
12294 {
12295 update_tool_bar (f, true);
12296 if (f->n_tool_bar_items)
12297 {
12298 build_desired_tool_bar_string (f);
12299 height = tool_bar_height (f, NULL, !NILP (pixelwise));
12300 }
12301 }
12302 #endif
12303
12304 return make_number (height);
12305 }
12306
12307
12308 /* Display the tool-bar of frame F. Value is true if tool-bar's
12309 height should be changed. */
12310 static bool
12311 redisplay_tool_bar (struct frame *f)
12312 {
12313 #if defined (USE_GTK) || defined (HAVE_NS)
12314
12315 if (FRAME_EXTERNAL_TOOL_BAR (f))
12316 update_frame_tool_bar (f);
12317 return false;
12318
12319 #else /* !USE_GTK && !HAVE_NS */
12320
12321 struct window *w;
12322 struct it it;
12323 struct glyph_row *row;
12324
12325 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12326 do anything. This means you must start with tool-bar-lines
12327 non-zero to get the auto-sizing effect. Or in other words, you
12328 can turn off tool-bars by specifying tool-bar-lines zero. */
12329 if (!WINDOWP (f->tool_bar_window)
12330 || (w = XWINDOW (f->tool_bar_window),
12331 WINDOW_TOTAL_LINES (w) == 0))
12332 return false;
12333
12334 /* Set up an iterator for the tool-bar window. */
12335 init_iterator (&it, w, -1, -1, w->desired_matrix->rows, TOOL_BAR_FACE_ID);
12336 it.first_visible_x = 0;
12337 it.last_visible_x = WINDOW_PIXEL_WIDTH (w);
12338 row = it.glyph_row;
12339 row->reversed_p = false;
12340
12341 /* Build a string that represents the contents of the tool-bar. */
12342 build_desired_tool_bar_string (f);
12343 reseat_to_string (&it, NULL, f->desired_tool_bar_string, 0, 0, 0, -1);
12344 /* FIXME: This should be controlled by a user option. But it
12345 doesn't make sense to have an R2L tool bar if the menu bar cannot
12346 be drawn also R2L, and making the menu bar R2L is tricky due
12347 toolkit-specific code that implements it. If an R2L tool bar is
12348 ever supported, display_tool_bar_line should also be augmented to
12349 call unproduce_glyphs like display_line and display_string
12350 do. */
12351 it.paragraph_embedding = L2R;
12352
12353 if (f->n_tool_bar_rows == 0)
12354 {
12355 int new_height = tool_bar_height (f, &f->n_tool_bar_rows, true);
12356
12357 if (new_height != WINDOW_PIXEL_HEIGHT (w))
12358 {
12359 x_change_tool_bar_height (f, new_height);
12360 frame_default_tool_bar_height = new_height;
12361 /* Always do that now. */
12362 clear_glyph_matrix (w->desired_matrix);
12363 f->fonts_changed = true;
12364 return true;
12365 }
12366 }
12367
12368 /* Display as many lines as needed to display all tool-bar items. */
12369
12370 if (f->n_tool_bar_rows > 0)
12371 {
12372 int border, rows, height, extra;
12373
12374 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border))
12375 border = XINT (Vtool_bar_border);
12376 else if (EQ (Vtool_bar_border, Qinternal_border_width))
12377 border = FRAME_INTERNAL_BORDER_WIDTH (f);
12378 else if (EQ (Vtool_bar_border, Qborder_width))
12379 border = f->border_width;
12380 else
12381 border = 0;
12382 if (border < 0)
12383 border = 0;
12384
12385 rows = f->n_tool_bar_rows;
12386 height = max (1, (it.last_visible_y - border) / rows);
12387 extra = it.last_visible_y - border - height * rows;
12388
12389 while (it.current_y < it.last_visible_y)
12390 {
12391 int h = 0;
12392 if (extra > 0 && rows-- > 0)
12393 {
12394 h = (extra + rows - 1) / rows;
12395 extra -= h;
12396 }
12397 display_tool_bar_line (&it, height + h);
12398 }
12399 }
12400 else
12401 {
12402 while (it.current_y < it.last_visible_y)
12403 display_tool_bar_line (&it, 0);
12404 }
12405
12406 /* It doesn't make much sense to try scrolling in the tool-bar
12407 window, so don't do it. */
12408 w->desired_matrix->no_scrolling_p = true;
12409 w->must_be_updated_p = true;
12410
12411 if (!NILP (Vauto_resize_tool_bars))
12412 {
12413 bool change_height_p = true;
12414
12415 /* If we couldn't display everything, change the tool-bar's
12416 height if there is room for more. */
12417 if (IT_STRING_CHARPOS (it) < it.end_charpos)
12418 change_height_p = true;
12419
12420 /* We subtract 1 because display_tool_bar_line advances the
12421 glyph_row pointer before returning to its caller. We want to
12422 examine the last glyph row produced by
12423 display_tool_bar_line. */
12424 row = it.glyph_row - 1;
12425
12426 /* If there are blank lines at the end, except for a partially
12427 visible blank line at the end that is smaller than
12428 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12429 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row)
12430 && row->height >= FRAME_LINE_HEIGHT (f))
12431 change_height_p = true;
12432
12433 /* If row displays tool-bar items, but is partially visible,
12434 change the tool-bar's height. */
12435 if (MATRIX_ROW_DISPLAYS_TEXT_P (row)
12436 && MATRIX_ROW_BOTTOM_Y (row) > it.last_visible_y)
12437 change_height_p = true;
12438
12439 /* Resize windows as needed by changing the `tool-bar-lines'
12440 frame parameter. */
12441 if (change_height_p)
12442 {
12443 int nrows;
12444 int new_height = tool_bar_height (f, &nrows, true);
12445
12446 change_height_p = ((EQ (Vauto_resize_tool_bars, Qgrow_only)
12447 && !f->minimize_tool_bar_window_p)
12448 ? (new_height > WINDOW_PIXEL_HEIGHT (w))
12449 : (new_height != WINDOW_PIXEL_HEIGHT (w)));
12450 f->minimize_tool_bar_window_p = false;
12451
12452 if (change_height_p)
12453 {
12454 x_change_tool_bar_height (f, new_height);
12455 frame_default_tool_bar_height = new_height;
12456 clear_glyph_matrix (w->desired_matrix);
12457 f->n_tool_bar_rows = nrows;
12458 f->fonts_changed = true;
12459
12460 return true;
12461 }
12462 }
12463 }
12464
12465 f->minimize_tool_bar_window_p = false;
12466 return false;
12467
12468 #endif /* USE_GTK || HAVE_NS */
12469 }
12470
12471 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12472
12473 /* Get information about the tool-bar item which is displayed in GLYPH
12474 on frame F. Return in *PROP_IDX the index where tool-bar item
12475 properties start in F->tool_bar_items. Value is false if
12476 GLYPH doesn't display a tool-bar item. */
12477
12478 static bool
12479 tool_bar_item_info (struct frame *f, struct glyph *glyph, int *prop_idx)
12480 {
12481 Lisp_Object prop;
12482 int charpos;
12483
12484 /* This function can be called asynchronously, which means we must
12485 exclude any possibility that Fget_text_property signals an
12486 error. */
12487 charpos = min (SCHARS (f->current_tool_bar_string), glyph->charpos);
12488 charpos = max (0, charpos);
12489
12490 /* Get the text property `menu-item' at pos. The value of that
12491 property is the start index of this item's properties in
12492 F->tool_bar_items. */
12493 prop = Fget_text_property (make_number (charpos),
12494 Qmenu_item, f->current_tool_bar_string);
12495 if (! INTEGERP (prop))
12496 return false;
12497 *prop_idx = XINT (prop);
12498 return true;
12499 }
12500
12501 \f
12502 /* Get information about the tool-bar item at position X/Y on frame F.
12503 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12504 the current matrix of the tool-bar window of F, or NULL if not
12505 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12506 item in F->tool_bar_items. Value is
12507
12508 -1 if X/Y is not on a tool-bar item
12509 0 if X/Y is on the same item that was highlighted before.
12510 1 otherwise. */
12511
12512 static int
12513 get_tool_bar_item (struct frame *f, int x, int y, struct glyph **glyph,
12514 int *hpos, int *vpos, int *prop_idx)
12515 {
12516 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
12517 struct window *w = XWINDOW (f->tool_bar_window);
12518 int area;
12519
12520 /* Find the glyph under X/Y. */
12521 *glyph = x_y_to_hpos_vpos (w, x, y, hpos, vpos, 0, 0, &area);
12522 if (*glyph == NULL)
12523 return -1;
12524
12525 /* Get the start of this tool-bar item's properties in
12526 f->tool_bar_items. */
12527 if (!tool_bar_item_info (f, *glyph, prop_idx))
12528 return -1;
12529
12530 /* Is mouse on the highlighted item? */
12531 if (EQ (f->tool_bar_window, hlinfo->mouse_face_window)
12532 && *vpos >= hlinfo->mouse_face_beg_row
12533 && *vpos <= hlinfo->mouse_face_end_row
12534 && (*vpos > hlinfo->mouse_face_beg_row
12535 || *hpos >= hlinfo->mouse_face_beg_col)
12536 && (*vpos < hlinfo->mouse_face_end_row
12537 || *hpos < hlinfo->mouse_face_end_col
12538 || hlinfo->mouse_face_past_end))
12539 return 0;
12540
12541 return 1;
12542 }
12543
12544
12545 /* EXPORT:
12546 Handle mouse button event on the tool-bar of frame F, at
12547 frame-relative coordinates X/Y. DOWN_P is true for a button press,
12548 false for button release. MODIFIERS is event modifiers for button
12549 release. */
12550
12551 void
12552 handle_tool_bar_click (struct frame *f, int x, int y, bool down_p,
12553 int modifiers)
12554 {
12555 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
12556 struct window *w = XWINDOW (f->tool_bar_window);
12557 int hpos, vpos, prop_idx;
12558 struct glyph *glyph;
12559 Lisp_Object enabled_p;
12560 int ts;
12561
12562 /* If not on the highlighted tool-bar item, and mouse-highlight is
12563 non-nil, return. This is so we generate the tool-bar button
12564 click only when the mouse button is released on the same item as
12565 where it was pressed. However, when mouse-highlight is disabled,
12566 generate the click when the button is released regardless of the
12567 highlight, since tool-bar items are not highlighted in that
12568 case. */
12569 frame_to_window_pixel_xy (w, &x, &y);
12570 ts = get_tool_bar_item (f, x, y, &glyph, &hpos, &vpos, &prop_idx);
12571 if (ts == -1
12572 || (ts != 0 && !NILP (Vmouse_highlight)))
12573 return;
12574
12575 /* When mouse-highlight is off, generate the click for the item
12576 where the button was pressed, disregarding where it was
12577 released. */
12578 if (NILP (Vmouse_highlight) && !down_p)
12579 prop_idx = f->last_tool_bar_item;
12580
12581 /* If item is disabled, do nothing. */
12582 enabled_p = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_ENABLED_P);
12583 if (NILP (enabled_p))
12584 return;
12585
12586 if (down_p)
12587 {
12588 /* Show item in pressed state. */
12589 if (!NILP (Vmouse_highlight))
12590 show_mouse_face (hlinfo, DRAW_IMAGE_SUNKEN);
12591 f->last_tool_bar_item = prop_idx;
12592 }
12593 else
12594 {
12595 Lisp_Object key, frame;
12596 struct input_event event;
12597 EVENT_INIT (event);
12598
12599 /* Show item in released state. */
12600 if (!NILP (Vmouse_highlight))
12601 show_mouse_face (hlinfo, DRAW_IMAGE_RAISED);
12602
12603 key = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_KEY);
12604
12605 XSETFRAME (frame, f);
12606 event.kind = TOOL_BAR_EVENT;
12607 event.frame_or_window = frame;
12608 event.arg = frame;
12609 kbd_buffer_store_event (&event);
12610
12611 event.kind = TOOL_BAR_EVENT;
12612 event.frame_or_window = frame;
12613 event.arg = key;
12614 event.modifiers = modifiers;
12615 kbd_buffer_store_event (&event);
12616 f->last_tool_bar_item = -1;
12617 }
12618 }
12619
12620
12621 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12622 tool-bar window-relative coordinates X/Y. Called from
12623 note_mouse_highlight. */
12624
12625 static void
12626 note_tool_bar_highlight (struct frame *f, int x, int y)
12627 {
12628 Lisp_Object window = f->tool_bar_window;
12629 struct window *w = XWINDOW (window);
12630 Display_Info *dpyinfo = FRAME_DISPLAY_INFO (f);
12631 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
12632 int hpos, vpos;
12633 struct glyph *glyph;
12634 struct glyph_row *row;
12635 int i;
12636 Lisp_Object enabled_p;
12637 int prop_idx;
12638 enum draw_glyphs_face draw = DRAW_IMAGE_RAISED;
12639 bool mouse_down_p;
12640 int rc;
12641
12642 /* Function note_mouse_highlight is called with negative X/Y
12643 values when mouse moves outside of the frame. */
12644 if (x <= 0 || y <= 0)
12645 {
12646 clear_mouse_face (hlinfo);
12647 return;
12648 }
12649
12650 rc = get_tool_bar_item (f, x, y, &glyph, &hpos, &vpos, &prop_idx);
12651 if (rc < 0)
12652 {
12653 /* Not on tool-bar item. */
12654 clear_mouse_face (hlinfo);
12655 return;
12656 }
12657 else if (rc == 0)
12658 /* On same tool-bar item as before. */
12659 goto set_help_echo;
12660
12661 clear_mouse_face (hlinfo);
12662
12663 /* Mouse is down, but on different tool-bar item? */
12664 mouse_down_p = (x_mouse_grabbed (dpyinfo)
12665 && f == dpyinfo->last_mouse_frame);
12666
12667 if (mouse_down_p && f->last_tool_bar_item != prop_idx)
12668 return;
12669
12670 draw = mouse_down_p ? DRAW_IMAGE_SUNKEN : DRAW_IMAGE_RAISED;
12671
12672 /* If tool-bar item is not enabled, don't highlight it. */
12673 enabled_p = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_ENABLED_P);
12674 if (!NILP (enabled_p) && !NILP (Vmouse_highlight))
12675 {
12676 /* Compute the x-position of the glyph. In front and past the
12677 image is a space. We include this in the highlighted area. */
12678 row = MATRIX_ROW (w->current_matrix, vpos);
12679 for (i = x = 0; i < hpos; ++i)
12680 x += row->glyphs[TEXT_AREA][i].pixel_width;
12681
12682 /* Record this as the current active region. */
12683 hlinfo->mouse_face_beg_col = hpos;
12684 hlinfo->mouse_face_beg_row = vpos;
12685 hlinfo->mouse_face_beg_x = x;
12686 hlinfo->mouse_face_past_end = false;
12687
12688 hlinfo->mouse_face_end_col = hpos + 1;
12689 hlinfo->mouse_face_end_row = vpos;
12690 hlinfo->mouse_face_end_x = x + glyph->pixel_width;
12691 hlinfo->mouse_face_window = window;
12692 hlinfo->mouse_face_face_id = TOOL_BAR_FACE_ID;
12693
12694 /* Display it as active. */
12695 show_mouse_face (hlinfo, draw);
12696 }
12697
12698 set_help_echo:
12699
12700 /* Set help_echo_string to a help string to display for this tool-bar item.
12701 XTread_socket does the rest. */
12702 help_echo_object = help_echo_window = Qnil;
12703 help_echo_pos = -1;
12704 help_echo_string = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_HELP);
12705 if (NILP (help_echo_string))
12706 help_echo_string = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_CAPTION);
12707 }
12708
12709 #endif /* !USE_GTK && !HAVE_NS */
12710
12711 #endif /* HAVE_WINDOW_SYSTEM */
12712
12713
12714 \f
12715 /************************************************************************
12716 Horizontal scrolling
12717 ************************************************************************/
12718
12719 /* For all leaf windows in the window tree rooted at WINDOW, set their
12720 hscroll value so that PT is (i) visible in the window, and (ii) so
12721 that it is not within a certain margin at the window's left and
12722 right border. Value is true if any window's hscroll has been
12723 changed. */
12724
12725 static bool
12726 hscroll_window_tree (Lisp_Object window)
12727 {
12728 bool hscrolled_p = false;
12729 bool hscroll_relative_p = FLOATP (Vhscroll_step);
12730 int hscroll_step_abs = 0;
12731 double hscroll_step_rel = 0;
12732
12733 if (hscroll_relative_p)
12734 {
12735 hscroll_step_rel = XFLOAT_DATA (Vhscroll_step);
12736 if (hscroll_step_rel < 0)
12737 {
12738 hscroll_relative_p = false;
12739 hscroll_step_abs = 0;
12740 }
12741 }
12742 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step))
12743 {
12744 hscroll_step_abs = XINT (Vhscroll_step);
12745 if (hscroll_step_abs < 0)
12746 hscroll_step_abs = 0;
12747 }
12748 else
12749 hscroll_step_abs = 0;
12750
12751 while (WINDOWP (window))
12752 {
12753 struct window *w = XWINDOW (window);
12754
12755 if (WINDOWP (w->contents))
12756 hscrolled_p |= hscroll_window_tree (w->contents);
12757 else if (w->cursor.vpos >= 0)
12758 {
12759 int h_margin;
12760 int text_area_width;
12761 struct glyph_row *cursor_row;
12762 struct glyph_row *bottom_row;
12763
12764 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->desired_matrix, w);
12765 if (w->cursor.vpos < bottom_row - w->desired_matrix->rows)
12766 cursor_row = MATRIX_ROW (w->desired_matrix, w->cursor.vpos);
12767 else
12768 cursor_row = bottom_row - 1;
12769
12770 if (!cursor_row->enabled_p)
12771 {
12772 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
12773 if (w->cursor.vpos < bottom_row - w->current_matrix->rows)
12774 cursor_row = MATRIX_ROW (w->current_matrix, w->cursor.vpos);
12775 else
12776 cursor_row = bottom_row - 1;
12777 }
12778 bool row_r2l_p = cursor_row->reversed_p;
12779
12780 text_area_width = window_box_width (w, TEXT_AREA);
12781
12782 /* Scroll when cursor is inside this scroll margin. */
12783 h_margin = hscroll_margin * WINDOW_FRAME_COLUMN_WIDTH (w);
12784
12785 /* If the position of this window's point has explicitly
12786 changed, no more suspend auto hscrolling. */
12787 if (NILP (Fequal (Fwindow_point (window), Fwindow_old_point (window))))
12788 w->suspend_auto_hscroll = false;
12789
12790 /* Remember window point. */
12791 Fset_marker (w->old_pointm,
12792 ((w == XWINDOW (selected_window))
12793 ? make_number (BUF_PT (XBUFFER (w->contents)))
12794 : Fmarker_position (w->pointm)),
12795 w->contents);
12796
12797 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode, w->contents))
12798 && !w->suspend_auto_hscroll
12799 /* In some pathological cases, like restoring a window
12800 configuration into a frame that is much smaller than
12801 the one from which the configuration was saved, we
12802 get glyph rows whose start and end have zero buffer
12803 positions, which we cannot handle below. Just skip
12804 such windows. */
12805 && CHARPOS (cursor_row->start.pos) >= BUF_BEG (w->contents)
12806 /* For left-to-right rows, hscroll when cursor is either
12807 (i) inside the right hscroll margin, or (ii) if it is
12808 inside the left margin and the window is already
12809 hscrolled. */
12810 && ((!row_r2l_p
12811 && ((w->hscroll && w->cursor.x <= h_margin)
12812 || (cursor_row->enabled_p
12813 && cursor_row->truncated_on_right_p
12814 && (w->cursor.x >= text_area_width - h_margin))))
12815 /* For right-to-left rows, the logic is similar,
12816 except that rules for scrolling to left and right
12817 are reversed. E.g., if cursor.x <= h_margin, we
12818 need to hscroll "to the right" unconditionally,
12819 and that will scroll the screen to the left so as
12820 to reveal the next portion of the row. */
12821 || (row_r2l_p
12822 && ((cursor_row->enabled_p
12823 /* FIXME: It is confusing to set the
12824 truncated_on_right_p flag when R2L rows
12825 are actually truncated on the left. */
12826 && cursor_row->truncated_on_right_p
12827 && w->cursor.x <= h_margin)
12828 || (w->hscroll
12829 && (w->cursor.x >= text_area_width - h_margin))))))
12830 {
12831 struct it it;
12832 ptrdiff_t hscroll;
12833 struct buffer *saved_current_buffer;
12834 ptrdiff_t pt;
12835 int wanted_x;
12836
12837 /* Find point in a display of infinite width. */
12838 saved_current_buffer = current_buffer;
12839 current_buffer = XBUFFER (w->contents);
12840
12841 if (w == XWINDOW (selected_window))
12842 pt = PT;
12843 else
12844 pt = clip_to_bounds (BEGV, marker_position (w->pointm), ZV);
12845
12846 /* Move iterator to pt starting at cursor_row->start in
12847 a line with infinite width. */
12848 init_to_row_start (&it, w, cursor_row);
12849 it.last_visible_x = INFINITY;
12850 move_it_in_display_line_to (&it, pt, -1, MOVE_TO_POS);
12851 current_buffer = saved_current_buffer;
12852
12853 /* Position cursor in window. */
12854 if (!hscroll_relative_p && hscroll_step_abs == 0)
12855 hscroll = max (0, (it.current_x
12856 - (ITERATOR_AT_END_OF_LINE_P (&it)
12857 ? (text_area_width - 4 * FRAME_COLUMN_WIDTH (it.f))
12858 : (text_area_width / 2))))
12859 / FRAME_COLUMN_WIDTH (it.f);
12860 else if ((!row_r2l_p
12861 && w->cursor.x >= text_area_width - h_margin)
12862 || (row_r2l_p && w->cursor.x <= h_margin))
12863 {
12864 if (hscroll_relative_p)
12865 wanted_x = text_area_width * (1 - hscroll_step_rel)
12866 - h_margin;
12867 else
12868 wanted_x = text_area_width
12869 - hscroll_step_abs * FRAME_COLUMN_WIDTH (it.f)
12870 - h_margin;
12871 hscroll
12872 = max (0, it.current_x - wanted_x) / FRAME_COLUMN_WIDTH (it.f);
12873 }
12874 else
12875 {
12876 if (hscroll_relative_p)
12877 wanted_x = text_area_width * hscroll_step_rel
12878 + h_margin;
12879 else
12880 wanted_x = hscroll_step_abs * FRAME_COLUMN_WIDTH (it.f)
12881 + h_margin;
12882 hscroll
12883 = max (0, it.current_x - wanted_x) / FRAME_COLUMN_WIDTH (it.f);
12884 }
12885 hscroll = max (hscroll, w->min_hscroll);
12886
12887 /* Don't prevent redisplay optimizations if hscroll
12888 hasn't changed, as it will unnecessarily slow down
12889 redisplay. */
12890 if (w->hscroll != hscroll)
12891 {
12892 struct buffer *b = XBUFFER (w->contents);
12893 b->prevent_redisplay_optimizations_p = true;
12894 w->hscroll = hscroll;
12895 hscrolled_p = true;
12896 }
12897 }
12898 }
12899
12900 window = w->next;
12901 }
12902
12903 /* Value is true if hscroll of any leaf window has been changed. */
12904 return hscrolled_p;
12905 }
12906
12907
12908 /* Set hscroll so that cursor is visible and not inside horizontal
12909 scroll margins for all windows in the tree rooted at WINDOW. See
12910 also hscroll_window_tree above. Value is true if any window's
12911 hscroll has been changed. If it has, desired matrices on the frame
12912 of WINDOW are cleared. */
12913
12914 static bool
12915 hscroll_windows (Lisp_Object window)
12916 {
12917 bool hscrolled_p = hscroll_window_tree (window);
12918 if (hscrolled_p)
12919 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window))));
12920 return hscrolled_p;
12921 }
12922
12923
12924 \f
12925 /************************************************************************
12926 Redisplay
12927 ************************************************************************/
12928
12929 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined.
12930 This is sometimes handy to have in a debugger session. */
12931
12932 #ifdef GLYPH_DEBUG
12933
12934 /* First and last unchanged row for try_window_id. */
12935
12936 static int debug_first_unchanged_at_end_vpos;
12937 static int debug_last_unchanged_at_beg_vpos;
12938
12939 /* Delta vpos and y. */
12940
12941 static int debug_dvpos, debug_dy;
12942
12943 /* Delta in characters and bytes for try_window_id. */
12944
12945 static ptrdiff_t debug_delta, debug_delta_bytes;
12946
12947 /* Values of window_end_pos and window_end_vpos at the end of
12948 try_window_id. */
12949
12950 static ptrdiff_t debug_end_vpos;
12951
12952 /* Append a string to W->desired_matrix->method. FMT is a printf
12953 format string. If trace_redisplay_p is true also printf the
12954 resulting string to stderr. */
12955
12956 static void debug_method_add (struct window *, char const *, ...)
12957 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12958
12959 static void
12960 debug_method_add (struct window *w, char const *fmt, ...)
12961 {
12962 void *ptr = w;
12963 char *method = w->desired_matrix->method;
12964 int len = strlen (method);
12965 int size = sizeof w->desired_matrix->method;
12966 int remaining = size - len - 1;
12967 va_list ap;
12968
12969 if (len && remaining)
12970 {
12971 method[len] = '|';
12972 --remaining, ++len;
12973 }
12974
12975 va_start (ap, fmt);
12976 vsnprintf (method + len, remaining + 1, fmt, ap);
12977 va_end (ap);
12978
12979 if (trace_redisplay_p)
12980 fprintf (stderr, "%p (%s): %s\n",
12981 ptr,
12982 ((BUFFERP (w->contents)
12983 && STRINGP (BVAR (XBUFFER (w->contents), name)))
12984 ? SSDATA (BVAR (XBUFFER (w->contents), name))
12985 : "no buffer"),
12986 method + len);
12987 }
12988
12989 #endif /* GLYPH_DEBUG */
12990
12991
12992 /* Value is true if all changes in window W, which displays
12993 current_buffer, are in the text between START and END. START is a
12994 buffer position, END is given as a distance from Z. Used in
12995 redisplay_internal for display optimization. */
12996
12997 static bool
12998 text_outside_line_unchanged_p (struct window *w,
12999 ptrdiff_t start, ptrdiff_t end)
13000 {
13001 bool unchanged_p = true;
13002
13003 /* If text or overlays have changed, see where. */
13004 if (window_outdated (w))
13005 {
13006 /* Gap in the line? */
13007 if (GPT < start || Z - GPT < end)
13008 unchanged_p = false;
13009
13010 /* Changes start in front of the line, or end after it? */
13011 if (unchanged_p
13012 && (BEG_UNCHANGED < start - 1
13013 || END_UNCHANGED < end))
13014 unchanged_p = false;
13015
13016 /* If selective display, can't optimize if changes start at the
13017 beginning of the line. */
13018 if (unchanged_p
13019 && INTEGERP (BVAR (current_buffer, selective_display))
13020 && XINT (BVAR (current_buffer, selective_display)) > 0
13021 && (BEG_UNCHANGED < start || GPT <= start))
13022 unchanged_p = false;
13023
13024 /* If there are overlays at the start or end of the line, these
13025 may have overlay strings with newlines in them. A change at
13026 START, for instance, may actually concern the display of such
13027 overlay strings as well, and they are displayed on different
13028 lines. So, quickly rule out this case. (For the future, it
13029 might be desirable to implement something more telling than
13030 just BEG/END_UNCHANGED.) */
13031 if (unchanged_p)
13032 {
13033 if (BEG + BEG_UNCHANGED == start
13034 && overlay_touches_p (start))
13035 unchanged_p = false;
13036 if (END_UNCHANGED == end
13037 && overlay_touches_p (Z - end))
13038 unchanged_p = false;
13039 }
13040
13041 /* Under bidi reordering, adding or deleting a character in the
13042 beginning of a paragraph, before the first strong directional
13043 character, can change the base direction of the paragraph (unless
13044 the buffer specifies a fixed paragraph direction), which will
13045 require to redisplay the whole paragraph. It might be worthwhile
13046 to find the paragraph limits and widen the range of redisplayed
13047 lines to that, but for now just give up this optimization. */
13048 if (!NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering))
13049 && NILP (BVAR (XBUFFER (w->contents), bidi_paragraph_direction)))
13050 unchanged_p = false;
13051 }
13052
13053 return unchanged_p;
13054 }
13055
13056
13057 /* Do a frame update, taking possible shortcuts into account. This is
13058 the main external entry point for redisplay.
13059
13060 If the last redisplay displayed an echo area message and that message
13061 is no longer requested, we clear the echo area or bring back the
13062 mini-buffer if that is in use. */
13063
13064 void
13065 redisplay (void)
13066 {
13067 redisplay_internal ();
13068 }
13069
13070
13071 static Lisp_Object
13072 overlay_arrow_string_or_property (Lisp_Object var)
13073 {
13074 Lisp_Object val;
13075
13076 if (val = Fget (var, Qoverlay_arrow_string), STRINGP (val))
13077 return val;
13078
13079 return Voverlay_arrow_string;
13080 }
13081
13082 /* Return true if there are any overlay-arrows in current_buffer. */
13083 static bool
13084 overlay_arrow_in_current_buffer_p (void)
13085 {
13086 Lisp_Object vlist;
13087
13088 for (vlist = Voverlay_arrow_variable_list;
13089 CONSP (vlist);
13090 vlist = XCDR (vlist))
13091 {
13092 Lisp_Object var = XCAR (vlist);
13093 Lisp_Object val;
13094
13095 if (!SYMBOLP (var))
13096 continue;
13097 val = find_symbol_value (var);
13098 if (MARKERP (val)
13099 && current_buffer == XMARKER (val)->buffer)
13100 return true;
13101 }
13102 return false;
13103 }
13104
13105
13106 /* Return true if any overlay_arrows have moved or overlay-arrow-string
13107 has changed. */
13108
13109 static bool
13110 overlay_arrows_changed_p (void)
13111 {
13112 Lisp_Object vlist;
13113
13114 for (vlist = Voverlay_arrow_variable_list;
13115 CONSP (vlist);
13116 vlist = XCDR (vlist))
13117 {
13118 Lisp_Object var = XCAR (vlist);
13119 Lisp_Object val, pstr;
13120
13121 if (!SYMBOLP (var))
13122 continue;
13123 val = find_symbol_value (var);
13124 if (!MARKERP (val))
13125 continue;
13126 if (! EQ (COERCE_MARKER (val),
13127 Fget (var, Qlast_arrow_position))
13128 || ! (pstr = overlay_arrow_string_or_property (var),
13129 EQ (pstr, Fget (var, Qlast_arrow_string))))
13130 return true;
13131 }
13132 return false;
13133 }
13134
13135 /* Mark overlay arrows to be updated on next redisplay. */
13136
13137 static void
13138 update_overlay_arrows (int up_to_date)
13139 {
13140 Lisp_Object vlist;
13141
13142 for (vlist = Voverlay_arrow_variable_list;
13143 CONSP (vlist);
13144 vlist = XCDR (vlist))
13145 {
13146 Lisp_Object var = XCAR (vlist);
13147
13148 if (!SYMBOLP (var))
13149 continue;
13150
13151 if (up_to_date > 0)
13152 {
13153 Lisp_Object val = find_symbol_value (var);
13154 Fput (var, Qlast_arrow_position,
13155 COERCE_MARKER (val));
13156 Fput (var, Qlast_arrow_string,
13157 overlay_arrow_string_or_property (var));
13158 }
13159 else if (up_to_date < 0
13160 || !NILP (Fget (var, Qlast_arrow_position)))
13161 {
13162 Fput (var, Qlast_arrow_position, Qt);
13163 Fput (var, Qlast_arrow_string, Qt);
13164 }
13165 }
13166 }
13167
13168
13169 /* Return overlay arrow string to display at row.
13170 Return integer (bitmap number) for arrow bitmap in left fringe.
13171 Return nil if no overlay arrow. */
13172
13173 static Lisp_Object
13174 overlay_arrow_at_row (struct it *it, struct glyph_row *row)
13175 {
13176 Lisp_Object vlist;
13177
13178 for (vlist = Voverlay_arrow_variable_list;
13179 CONSP (vlist);
13180 vlist = XCDR (vlist))
13181 {
13182 Lisp_Object var = XCAR (vlist);
13183 Lisp_Object val;
13184
13185 if (!SYMBOLP (var))
13186 continue;
13187
13188 val = find_symbol_value (var);
13189
13190 if (MARKERP (val)
13191 && current_buffer == XMARKER (val)->buffer
13192 && (MATRIX_ROW_START_CHARPOS (row) == marker_position (val)))
13193 {
13194 if (FRAME_WINDOW_P (it->f)
13195 /* FIXME: if ROW->reversed_p is set, this should test
13196 the right fringe, not the left one. */
13197 && WINDOW_LEFT_FRINGE_WIDTH (it->w) > 0)
13198 {
13199 #ifdef HAVE_WINDOW_SYSTEM
13200 if (val = Fget (var, Qoverlay_arrow_bitmap), SYMBOLP (val))
13201 {
13202 int fringe_bitmap = lookup_fringe_bitmap (val);
13203 if (fringe_bitmap != 0)
13204 return make_number (fringe_bitmap);
13205 }
13206 #endif
13207 return make_number (-1); /* Use default arrow bitmap. */
13208 }
13209 return overlay_arrow_string_or_property (var);
13210 }
13211 }
13212
13213 return Qnil;
13214 }
13215
13216 /* Return true if point moved out of or into a composition. Otherwise
13217 return false. PREV_BUF and PREV_PT are the last point buffer and
13218 position. BUF and PT are the current point buffer and position. */
13219
13220 static bool
13221 check_point_in_composition (struct buffer *prev_buf, ptrdiff_t prev_pt,
13222 struct buffer *buf, ptrdiff_t pt)
13223 {
13224 ptrdiff_t start, end;
13225 Lisp_Object prop;
13226 Lisp_Object buffer;
13227
13228 XSETBUFFER (buffer, buf);
13229 /* Check a composition at the last point if point moved within the
13230 same buffer. */
13231 if (prev_buf == buf)
13232 {
13233 if (prev_pt == pt)
13234 /* Point didn't move. */
13235 return false;
13236
13237 if (prev_pt > BUF_BEGV (buf) && prev_pt < BUF_ZV (buf)
13238 && find_composition (prev_pt, -1, &start, &end, &prop, buffer)
13239 && composition_valid_p (start, end, prop)
13240 && start < prev_pt && end > prev_pt)
13241 /* The last point was within the composition. Return true iff
13242 point moved out of the composition. */
13243 return (pt <= start || pt >= end);
13244 }
13245
13246 /* Check a composition at the current point. */
13247 return (pt > BUF_BEGV (buf) && pt < BUF_ZV (buf)
13248 && find_composition (pt, -1, &start, &end, &prop, buffer)
13249 && composition_valid_p (start, end, prop)
13250 && start < pt && end > pt);
13251 }
13252
13253 /* Reconsider the clip changes of buffer which is displayed in W. */
13254
13255 static void
13256 reconsider_clip_changes (struct window *w)
13257 {
13258 struct buffer *b = XBUFFER (w->contents);
13259
13260 if (b->clip_changed
13261 && w->window_end_valid
13262 && w->current_matrix->buffer == b
13263 && w->current_matrix->zv == BUF_ZV (b)
13264 && w->current_matrix->begv == BUF_BEGV (b))
13265 b->clip_changed = false;
13266
13267 /* If display wasn't paused, and W is not a tool bar window, see if
13268 point has been moved into or out of a composition. In that case,
13269 set b->clip_changed to force updating the screen. If
13270 b->clip_changed has already been set, skip this check. */
13271 if (!b->clip_changed && w->window_end_valid)
13272 {
13273 ptrdiff_t pt = (w == XWINDOW (selected_window)
13274 ? PT : marker_position (w->pointm));
13275
13276 if ((w->current_matrix->buffer != b || pt != w->last_point)
13277 && check_point_in_composition (w->current_matrix->buffer,
13278 w->last_point, b, pt))
13279 b->clip_changed = true;
13280 }
13281 }
13282
13283 static void
13284 propagate_buffer_redisplay (void)
13285 { /* Resetting b->text->redisplay is problematic!
13286 We can't just reset it in the case that some window that displays
13287 it has not been redisplayed; and such a window can stay
13288 unredisplayed for a long time if it's currently invisible.
13289 But we do want to reset it at the end of redisplay otherwise
13290 its displayed windows will keep being redisplayed over and over
13291 again.
13292 So we copy all b->text->redisplay flags up to their windows here,
13293 such that mark_window_display_accurate can safely reset
13294 b->text->redisplay. */
13295 Lisp_Object ws = window_list ();
13296 for (; CONSP (ws); ws = XCDR (ws))
13297 {
13298 struct window *thisw = XWINDOW (XCAR (ws));
13299 struct buffer *thisb = XBUFFER (thisw->contents);
13300 if (thisb->text->redisplay)
13301 thisw->redisplay = true;
13302 }
13303 }
13304
13305 #define STOP_POLLING \
13306 do { if (! polling_stopped_here) stop_polling (); \
13307 polling_stopped_here = true; } while (false)
13308
13309 #define RESUME_POLLING \
13310 do { if (polling_stopped_here) start_polling (); \
13311 polling_stopped_here = false; } while (false)
13312
13313
13314 /* Perhaps in the future avoid recentering windows if it
13315 is not necessary; currently that causes some problems. */
13316
13317 static void
13318 redisplay_internal (void)
13319 {
13320 struct window *w = XWINDOW (selected_window);
13321 struct window *sw;
13322 struct frame *fr;
13323 bool pending;
13324 bool must_finish = false, match_p;
13325 struct text_pos tlbufpos, tlendpos;
13326 int number_of_visible_frames;
13327 ptrdiff_t count;
13328 struct frame *sf;
13329 bool polling_stopped_here = false;
13330 Lisp_Object tail, frame;
13331
13332 /* True means redisplay has to consider all windows on all
13333 frames. False, only selected_window is considered. */
13334 bool consider_all_windows_p;
13335
13336 /* True means redisplay has to redisplay the miniwindow. */
13337 bool update_miniwindow_p = false;
13338
13339 /* True means we need to redraw frames whose 'redisplay' bit is set. */
13340 bool consider_some_frames_p = false;
13341
13342 TRACE ((stderr, "redisplay_internal %d\n", redisplaying_p));
13343
13344 /* No redisplay if running in batch mode or frame is not yet fully
13345 initialized, or redisplay is explicitly turned off by setting
13346 Vinhibit_redisplay. */
13347 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13348 || !NILP (Vinhibit_redisplay))
13349 return;
13350
13351 /* Don't examine these until after testing Vinhibit_redisplay.
13352 When Emacs is shutting down, perhaps because its connection to
13353 X has dropped, we should not look at them at all. */
13354 fr = XFRAME (w->frame);
13355 sf = SELECTED_FRAME ();
13356
13357 if (!fr->glyphs_initialized_p)
13358 return;
13359
13360 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13361 if (popup_activated ())
13362 return;
13363 #endif
13364
13365 /* I don't think this happens but let's be paranoid. */
13366 if (redisplaying_p)
13367 return;
13368
13369 /* Record a function that clears redisplaying_p
13370 when we leave this function. */
13371 count = SPECPDL_INDEX ();
13372 record_unwind_protect_void (unwind_redisplay);
13373 redisplaying_p = true;
13374 specbind (Qinhibit_free_realized_faces, Qnil);
13375
13376 /* Record this function, so it appears on the profiler's backtraces. */
13377 record_in_backtrace (Qredisplay_internal, 0, 0);
13378
13379 FOR_EACH_FRAME (tail, frame)
13380 XFRAME (frame)->already_hscrolled_p = false;
13381
13382 retry:
13383 /* Remember the currently selected window. */
13384 sw = w;
13385
13386 pending = false;
13387 forget_escape_and_glyphless_faces ();
13388
13389 inhibit_free_realized_faces = false;
13390
13391 /* If face_change, init_iterator will free all realized faces, which
13392 includes the faces referenced from current matrices. So, we
13393 can't reuse current matrices in this case. */
13394 if (face_change)
13395 windows_or_buffers_changed = 47;
13396
13397 if ((FRAME_TERMCAP_P (sf) || FRAME_MSDOS_P (sf))
13398 && FRAME_TTY (sf)->previous_frame != sf)
13399 {
13400 /* Since frames on a single ASCII terminal share the same
13401 display area, displaying a different frame means redisplay
13402 the whole thing. */
13403 SET_FRAME_GARBAGED (sf);
13404 #ifndef DOS_NT
13405 set_tty_color_mode (FRAME_TTY (sf), sf);
13406 #endif
13407 FRAME_TTY (sf)->previous_frame = sf;
13408 }
13409
13410 /* Set the visible flags for all frames. Do this before checking for
13411 resized or garbaged frames; they want to know if their frames are
13412 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13413 number_of_visible_frames = 0;
13414
13415 FOR_EACH_FRAME (tail, frame)
13416 {
13417 struct frame *f = XFRAME (frame);
13418
13419 if (FRAME_VISIBLE_P (f))
13420 {
13421 ++number_of_visible_frames;
13422 /* Adjust matrices for visible frames only. */
13423 if (f->fonts_changed)
13424 {
13425 adjust_frame_glyphs (f);
13426 /* Disable all redisplay optimizations for this frame.
13427 This is because adjust_frame_glyphs resets the
13428 enabled_p flag for all glyph rows of all windows, so
13429 many optimizations will fail anyway, and some might
13430 fail to test that flag and do bogus things as
13431 result. */
13432 SET_FRAME_GARBAGED (f);
13433 f->fonts_changed = false;
13434 }
13435 /* If cursor type has been changed on the frame
13436 other than selected, consider all frames. */
13437 if (f != sf && f->cursor_type_changed)
13438 fset_redisplay (f);
13439 }
13440 clear_desired_matrices (f);
13441 }
13442
13443 /* Notice any pending interrupt request to change frame size. */
13444 do_pending_window_change (true);
13445
13446 /* do_pending_window_change could change the selected_window due to
13447 frame resizing which makes the selected window too small. */
13448 if (WINDOWP (selected_window) && (w = XWINDOW (selected_window)) != sw)
13449 sw = w;
13450
13451 /* Clear frames marked as garbaged. */
13452 clear_garbaged_frames ();
13453
13454 /* Build menubar and tool-bar items. */
13455 if (NILP (Vmemory_full))
13456 prepare_menu_bars ();
13457
13458 reconsider_clip_changes (w);
13459
13460 /* In most cases selected window displays current buffer. */
13461 match_p = XBUFFER (w->contents) == current_buffer;
13462 if (match_p)
13463 {
13464 /* Detect case that we need to write or remove a star in the mode line. */
13465 if ((SAVE_MODIFF < MODIFF) != w->last_had_star)
13466 w->update_mode_line = true;
13467
13468 if (mode_line_update_needed (w))
13469 w->update_mode_line = true;
13470
13471 /* If reconsider_clip_changes above decided that the narrowing
13472 in the current buffer changed, make sure all other windows
13473 showing that buffer will be redisplayed. */
13474 if (current_buffer->clip_changed)
13475 bset_update_mode_line (current_buffer);
13476 }
13477
13478 /* Normally the message* functions will have already displayed and
13479 updated the echo area, but the frame may have been trashed, or
13480 the update may have been preempted, so display the echo area
13481 again here. Checking message_cleared_p captures the case that
13482 the echo area should be cleared. */
13483 if ((!NILP (echo_area_buffer[0]) && !display_last_displayed_message_p)
13484 || (!NILP (echo_area_buffer[1]) && display_last_displayed_message_p)
13485 || (message_cleared_p
13486 && minibuf_level == 0
13487 /* If the mini-window is currently selected, this means the
13488 echo-area doesn't show through. */
13489 && !MINI_WINDOW_P (XWINDOW (selected_window))))
13490 {
13491 echo_area_display (false);
13492
13493 if (message_cleared_p)
13494 update_miniwindow_p = true;
13495
13496 must_finish = true;
13497
13498 /* If we don't display the current message, don't clear the
13499 message_cleared_p flag, because, if we did, we wouldn't clear
13500 the echo area in the next redisplay which doesn't preserve
13501 the echo area. */
13502 if (!display_last_displayed_message_p)
13503 message_cleared_p = false;
13504 }
13505 else if (EQ (selected_window, minibuf_window)
13506 && (current_buffer->clip_changed || window_outdated (w))
13507 && resize_mini_window (w, false))
13508 {
13509 /* Resized active mini-window to fit the size of what it is
13510 showing if its contents might have changed. */
13511 must_finish = true;
13512
13513 /* If window configuration was changed, frames may have been
13514 marked garbaged. Clear them or we will experience
13515 surprises wrt scrolling. */
13516 clear_garbaged_frames ();
13517 }
13518
13519 if (windows_or_buffers_changed && !update_mode_lines)
13520 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13521 only the windows's contents needs to be refreshed, or whether the
13522 mode-lines also need a refresh. */
13523 update_mode_lines = (windows_or_buffers_changed == REDISPLAY_SOME
13524 ? REDISPLAY_SOME : 32);
13525
13526 /* If specs for an arrow have changed, do thorough redisplay
13527 to ensure we remove any arrow that should no longer exist. */
13528 if (overlay_arrows_changed_p ())
13529 /* Apparently, this is the only case where we update other windows,
13530 without updating other mode-lines. */
13531 windows_or_buffers_changed = 49;
13532
13533 consider_all_windows_p = (update_mode_lines
13534 || windows_or_buffers_changed);
13535
13536 #define AINC(a,i) \
13537 { \
13538 Lisp_Object entry = Fgethash (make_number (i), a, make_number (0)); \
13539 if (INTEGERP (entry)) \
13540 Fputhash (make_number (i), make_number (1 + XINT (entry)), a); \
13541 }
13542
13543 AINC (Vredisplay__all_windows_cause, windows_or_buffers_changed);
13544 AINC (Vredisplay__mode_lines_cause, update_mode_lines);
13545
13546 /* Optimize the case that only the line containing the cursor in the
13547 selected window has changed. Variables starting with this_ are
13548 set in display_line and record information about the line
13549 containing the cursor. */
13550 tlbufpos = this_line_start_pos;
13551 tlendpos = this_line_end_pos;
13552 if (!consider_all_windows_p
13553 && CHARPOS (tlbufpos) > 0
13554 && !w->update_mode_line
13555 && !current_buffer->clip_changed
13556 && !current_buffer->prevent_redisplay_optimizations_p
13557 && FRAME_VISIBLE_P (XFRAME (w->frame))
13558 && !FRAME_OBSCURED_P (XFRAME (w->frame))
13559 && !XFRAME (w->frame)->cursor_type_changed
13560 && !XFRAME (w->frame)->face_change
13561 && !XFRAME (w->frame)->redisplay
13562 /* Make sure recorded data applies to current buffer, etc. */
13563 && this_line_buffer == current_buffer
13564 && match_p
13565 && !w->force_start
13566 && !w->optional_new_start
13567 /* Point must be on the line that we have info recorded about. */
13568 && PT >= CHARPOS (tlbufpos)
13569 && PT <= Z - CHARPOS (tlendpos)
13570 /* All text outside that line, including its final newline,
13571 must be unchanged. */
13572 && text_outside_line_unchanged_p (w, CHARPOS (tlbufpos),
13573 CHARPOS (tlendpos)))
13574 {
13575 if (CHARPOS (tlbufpos) > BEGV
13576 && FETCH_BYTE (BYTEPOS (tlbufpos) - 1) != '\n'
13577 && (CHARPOS (tlbufpos) == ZV
13578 || FETCH_BYTE (BYTEPOS (tlbufpos)) == '\n'))
13579 /* Former continuation line has disappeared by becoming empty. */
13580 goto cancel;
13581 else if (window_outdated (w) || MINI_WINDOW_P (w))
13582 {
13583 /* We have to handle the case of continuation around a
13584 wide-column character (see the comment in indent.c around
13585 line 1340).
13586
13587 For instance, in the following case:
13588
13589 -------- Insert --------
13590 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13591 J_I_ ==> J_I_ `^^' are cursors.
13592 ^^ ^^
13593 -------- --------
13594
13595 As we have to redraw the line above, we cannot use this
13596 optimization. */
13597
13598 struct it it;
13599 int line_height_before = this_line_pixel_height;
13600
13601 /* Note that start_display will handle the case that the
13602 line starting at tlbufpos is a continuation line. */
13603 start_display (&it, w, tlbufpos);
13604
13605 /* Implementation note: It this still necessary? */
13606 if (it.current_x != this_line_start_x)
13607 goto cancel;
13608
13609 TRACE ((stderr, "trying display optimization 1\n"));
13610 w->cursor.vpos = -1;
13611 overlay_arrow_seen = false;
13612 it.vpos = this_line_vpos;
13613 it.current_y = this_line_y;
13614 it.glyph_row = MATRIX_ROW (w->desired_matrix, this_line_vpos);
13615 display_line (&it);
13616
13617 /* If line contains point, is not continued,
13618 and ends at same distance from eob as before, we win. */
13619 if (w->cursor.vpos >= 0
13620 /* Line is not continued, otherwise this_line_start_pos
13621 would have been set to 0 in display_line. */
13622 && CHARPOS (this_line_start_pos)
13623 /* Line ends as before. */
13624 && CHARPOS (this_line_end_pos) == CHARPOS (tlendpos)
13625 /* Line has same height as before. Otherwise other lines
13626 would have to be shifted up or down. */
13627 && this_line_pixel_height == line_height_before)
13628 {
13629 /* If this is not the window's last line, we must adjust
13630 the charstarts of the lines below. */
13631 if (it.current_y < it.last_visible_y)
13632 {
13633 struct glyph_row *row
13634 = MATRIX_ROW (w->current_matrix, this_line_vpos + 1);
13635 ptrdiff_t delta, delta_bytes;
13636
13637 /* We used to distinguish between two cases here,
13638 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13639 when the line ends in a newline or the end of the
13640 buffer's accessible portion. But both cases did
13641 the same, so they were collapsed. */
13642 delta = (Z
13643 - CHARPOS (tlendpos)
13644 - MATRIX_ROW_START_CHARPOS (row));
13645 delta_bytes = (Z_BYTE
13646 - BYTEPOS (tlendpos)
13647 - MATRIX_ROW_START_BYTEPOS (row));
13648
13649 increment_matrix_positions (w->current_matrix,
13650 this_line_vpos + 1,
13651 w->current_matrix->nrows,
13652 delta, delta_bytes);
13653 }
13654
13655 /* If this row displays text now but previously didn't,
13656 or vice versa, w->window_end_vpos may have to be
13657 adjusted. */
13658 if (MATRIX_ROW_DISPLAYS_TEXT_P (it.glyph_row - 1))
13659 {
13660 if (w->window_end_vpos < this_line_vpos)
13661 w->window_end_vpos = this_line_vpos;
13662 }
13663 else if (w->window_end_vpos == this_line_vpos
13664 && this_line_vpos > 0)
13665 w->window_end_vpos = this_line_vpos - 1;
13666 w->window_end_valid = false;
13667
13668 /* Update hint: No need to try to scroll in update_window. */
13669 w->desired_matrix->no_scrolling_p = true;
13670
13671 #ifdef GLYPH_DEBUG
13672 *w->desired_matrix->method = 0;
13673 debug_method_add (w, "optimization 1");
13674 #endif
13675 #ifdef HAVE_WINDOW_SYSTEM
13676 update_window_fringes (w, false);
13677 #endif
13678 goto update;
13679 }
13680 else
13681 goto cancel;
13682 }
13683 else if (/* Cursor position hasn't changed. */
13684 PT == w->last_point
13685 /* Make sure the cursor was last displayed
13686 in this window. Otherwise we have to reposition it. */
13687
13688 /* PXW: Must be converted to pixels, probably. */
13689 && 0 <= w->cursor.vpos
13690 && w->cursor.vpos < WINDOW_TOTAL_LINES (w))
13691 {
13692 if (!must_finish)
13693 {
13694 do_pending_window_change (true);
13695 /* If selected_window changed, redisplay again. */
13696 if (WINDOWP (selected_window)
13697 && (w = XWINDOW (selected_window)) != sw)
13698 goto retry;
13699
13700 /* We used to always goto end_of_redisplay here, but this
13701 isn't enough if we have a blinking cursor. */
13702 if (w->cursor_off_p == w->last_cursor_off_p)
13703 goto end_of_redisplay;
13704 }
13705 goto update;
13706 }
13707 /* If highlighting the region, or if the cursor is in the echo area,
13708 then we can't just move the cursor. */
13709 else if (NILP (Vshow_trailing_whitespace)
13710 && !cursor_in_echo_area)
13711 {
13712 struct it it;
13713 struct glyph_row *row;
13714
13715 /* Skip from tlbufpos to PT and see where it is. Note that
13716 PT may be in invisible text. If so, we will end at the
13717 next visible position. */
13718 init_iterator (&it, w, CHARPOS (tlbufpos), BYTEPOS (tlbufpos),
13719 NULL, DEFAULT_FACE_ID);
13720 it.current_x = this_line_start_x;
13721 it.current_y = this_line_y;
13722 it.vpos = this_line_vpos;
13723
13724 /* The call to move_it_to stops in front of PT, but
13725 moves over before-strings. */
13726 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
13727
13728 if (it.vpos == this_line_vpos
13729 && (row = MATRIX_ROW (w->current_matrix, this_line_vpos),
13730 row->enabled_p))
13731 {
13732 eassert (this_line_vpos == it.vpos);
13733 eassert (this_line_y == it.current_y);
13734 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
13735 #ifdef GLYPH_DEBUG
13736 *w->desired_matrix->method = 0;
13737 debug_method_add (w, "optimization 3");
13738 #endif
13739 goto update;
13740 }
13741 else
13742 goto cancel;
13743 }
13744
13745 cancel:
13746 /* Text changed drastically or point moved off of line. */
13747 SET_MATRIX_ROW_ENABLED_P (w->desired_matrix, this_line_vpos, false);
13748 }
13749
13750 CHARPOS (this_line_start_pos) = 0;
13751 ++clear_face_cache_count;
13752 #ifdef HAVE_WINDOW_SYSTEM
13753 ++clear_image_cache_count;
13754 #endif
13755
13756 /* Build desired matrices, and update the display. If
13757 consider_all_windows_p, do it for all windows on all frames. If
13758 a frame's 'redisplay' flag is set, do it for all windows on each
13759 such frame. Otherwise do it for selected_window, only. */
13760
13761 if (!consider_all_windows_p)
13762 {
13763 FOR_EACH_FRAME (tail, frame)
13764 {
13765 if (XFRAME (frame)->redisplay && XFRAME (frame) != sf)
13766 {
13767 consider_some_frames_p = true;
13768 break;
13769 }
13770 }
13771 }
13772
13773 if (consider_all_windows_p || consider_some_frames_p)
13774 {
13775 FOR_EACH_FRAME (tail, frame)
13776 {
13777 if (XFRAME (frame)->redisplay || consider_all_windows_p)
13778 XFRAME (frame)->updated_p = false;
13779 }
13780
13781 propagate_buffer_redisplay ();
13782
13783 FOR_EACH_FRAME (tail, frame)
13784 {
13785 struct frame *f = XFRAME (frame);
13786
13787 /* We don't have to do anything for unselected terminal
13788 frames. */
13789 if ((FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
13790 && !EQ (FRAME_TTY (f)->top_frame, frame))
13791 continue;
13792
13793 if (!consider_all_windows_p && !f->redisplay)
13794 continue;
13795
13796 retry_frame:
13797 if (FRAME_WINDOW_P (f) || FRAME_TERMCAP_P (f) || f == sf)
13798 {
13799 bool gcscrollbars
13800 /* Only GC scrollbars when we redisplay the whole frame. */
13801 = f->redisplay || !REDISPLAY_SOME_P ();
13802 /* Mark all the scroll bars to be removed; we'll redeem
13803 the ones we want when we redisplay their windows. */
13804 if (gcscrollbars && FRAME_TERMINAL (f)->condemn_scroll_bars_hook)
13805 FRAME_TERMINAL (f)->condemn_scroll_bars_hook (f);
13806
13807 if (FRAME_VISIBLE_P (f) && !FRAME_OBSCURED_P (f))
13808 redisplay_windows (FRAME_ROOT_WINDOW (f));
13809 /* Remember that the invisible frames need to be redisplayed next
13810 time they're visible. */
13811 else if (!REDISPLAY_SOME_P ())
13812 f->redisplay = true;
13813
13814 /* The X error handler may have deleted that frame. */
13815 if (!FRAME_LIVE_P (f))
13816 continue;
13817
13818 /* Any scroll bars which redisplay_windows should have
13819 nuked should now go away. */
13820 if (gcscrollbars && FRAME_TERMINAL (f)->judge_scroll_bars_hook)
13821 FRAME_TERMINAL (f)->judge_scroll_bars_hook (f);
13822
13823 if (FRAME_VISIBLE_P (f) && !FRAME_OBSCURED_P (f))
13824 {
13825 /* If fonts changed on visible frame, display again. */
13826 if (f->fonts_changed)
13827 {
13828 adjust_frame_glyphs (f);
13829 /* Disable all redisplay optimizations for this
13830 frame. For the reasons, see the comment near
13831 the previous call to adjust_frame_glyphs above. */
13832 SET_FRAME_GARBAGED (f);
13833 f->fonts_changed = false;
13834 goto retry_frame;
13835 }
13836
13837 /* See if we have to hscroll. */
13838 if (!f->already_hscrolled_p)
13839 {
13840 f->already_hscrolled_p = true;
13841 if (hscroll_windows (f->root_window))
13842 goto retry_frame;
13843 }
13844
13845 /* Prevent various kinds of signals during display
13846 update. stdio is not robust about handling
13847 signals, which can cause an apparent I/O error. */
13848 if (interrupt_input)
13849 unrequest_sigio ();
13850 STOP_POLLING;
13851
13852 pending |= update_frame (f, false, false);
13853 f->cursor_type_changed = false;
13854 f->updated_p = true;
13855 }
13856 }
13857 }
13858
13859 eassert (EQ (XFRAME (selected_frame)->selected_window, selected_window));
13860
13861 if (!pending)
13862 {
13863 /* Do the mark_window_display_accurate after all windows have
13864 been redisplayed because this call resets flags in buffers
13865 which are needed for proper redisplay. */
13866 FOR_EACH_FRAME (tail, frame)
13867 {
13868 struct frame *f = XFRAME (frame);
13869 if (f->updated_p)
13870 {
13871 f->redisplay = false;
13872 mark_window_display_accurate (f->root_window, true);
13873 if (FRAME_TERMINAL (f)->frame_up_to_date_hook)
13874 FRAME_TERMINAL (f)->frame_up_to_date_hook (f);
13875 }
13876 }
13877 }
13878 }
13879 else if (FRAME_VISIBLE_P (sf) && !FRAME_OBSCURED_P (sf))
13880 {
13881 Lisp_Object mini_window = FRAME_MINIBUF_WINDOW (sf);
13882 struct frame *mini_frame;
13883
13884 displayed_buffer = XBUFFER (XWINDOW (selected_window)->contents);
13885 /* Use list_of_error, not Qerror, so that
13886 we catch only errors and don't run the debugger. */
13887 internal_condition_case_1 (redisplay_window_1, selected_window,
13888 list_of_error,
13889 redisplay_window_error);
13890 if (update_miniwindow_p)
13891 internal_condition_case_1 (redisplay_window_1, mini_window,
13892 list_of_error,
13893 redisplay_window_error);
13894
13895 /* Compare desired and current matrices, perform output. */
13896
13897 update:
13898 /* If fonts changed, display again. */
13899 if (sf->fonts_changed)
13900 goto retry;
13901
13902 /* Prevent freeing of realized faces, since desired matrices are
13903 pending that reference the faces we computed and cached. */
13904 inhibit_free_realized_faces = true;
13905
13906 /* Prevent various kinds of signals during display update.
13907 stdio is not robust about handling signals,
13908 which can cause an apparent I/O error. */
13909 if (interrupt_input)
13910 unrequest_sigio ();
13911 STOP_POLLING;
13912
13913 if (FRAME_VISIBLE_P (sf) && !FRAME_OBSCURED_P (sf))
13914 {
13915 if (hscroll_windows (selected_window))
13916 goto retry;
13917
13918 XWINDOW (selected_window)->must_be_updated_p = true;
13919 pending = update_frame (sf, false, false);
13920 sf->cursor_type_changed = false;
13921 }
13922
13923 /* We may have called echo_area_display at the top of this
13924 function. If the echo area is on another frame, that may
13925 have put text on a frame other than the selected one, so the
13926 above call to update_frame would not have caught it. Catch
13927 it here. */
13928 mini_window = FRAME_MINIBUF_WINDOW (sf);
13929 mini_frame = XFRAME (WINDOW_FRAME (XWINDOW (mini_window)));
13930
13931 if (mini_frame != sf && FRAME_WINDOW_P (mini_frame))
13932 {
13933 XWINDOW (mini_window)->must_be_updated_p = true;
13934 pending |= update_frame (mini_frame, false, false);
13935 mini_frame->cursor_type_changed = false;
13936 if (!pending && hscroll_windows (mini_window))
13937 goto retry;
13938 }
13939 }
13940
13941 /* If display was paused because of pending input, make sure we do a
13942 thorough update the next time. */
13943 if (pending)
13944 {
13945 /* Prevent the optimization at the beginning of
13946 redisplay_internal that tries a single-line update of the
13947 line containing the cursor in the selected window. */
13948 CHARPOS (this_line_start_pos) = 0;
13949
13950 /* Let the overlay arrow be updated the next time. */
13951 update_overlay_arrows (0);
13952
13953 /* If we pause after scrolling, some rows in the current
13954 matrices of some windows are not valid. */
13955 if (!WINDOW_FULL_WIDTH_P (w)
13956 && !FRAME_WINDOW_P (XFRAME (w->frame)))
13957 update_mode_lines = 36;
13958 }
13959 else
13960 {
13961 if (!consider_all_windows_p)
13962 {
13963 /* This has already been done above if
13964 consider_all_windows_p is set. */
13965 if (XBUFFER (w->contents)->text->redisplay
13966 && buffer_window_count (XBUFFER (w->contents)) > 1)
13967 /* This can happen if b->text->redisplay was set during
13968 jit-lock. */
13969 propagate_buffer_redisplay ();
13970 mark_window_display_accurate_1 (w, true);
13971
13972 /* Say overlay arrows are up to date. */
13973 update_overlay_arrows (1);
13974
13975 if (FRAME_TERMINAL (sf)->frame_up_to_date_hook != 0)
13976 FRAME_TERMINAL (sf)->frame_up_to_date_hook (sf);
13977 }
13978
13979 update_mode_lines = 0;
13980 windows_or_buffers_changed = 0;
13981 }
13982
13983 /* Start SIGIO interrupts coming again. Having them off during the
13984 code above makes it less likely one will discard output, but not
13985 impossible, since there might be stuff in the system buffer here.
13986 But it is much hairier to try to do anything about that. */
13987 if (interrupt_input)
13988 request_sigio ();
13989 RESUME_POLLING;
13990
13991 /* If a frame has become visible which was not before, redisplay
13992 again, so that we display it. Expose events for such a frame
13993 (which it gets when becoming visible) don't call the parts of
13994 redisplay constructing glyphs, so simply exposing a frame won't
13995 display anything in this case. So, we have to display these
13996 frames here explicitly. */
13997 if (!pending)
13998 {
13999 int new_count = 0;
14000
14001 FOR_EACH_FRAME (tail, frame)
14002 {
14003 if (XFRAME (frame)->visible)
14004 new_count++;
14005 }
14006
14007 if (new_count != number_of_visible_frames)
14008 windows_or_buffers_changed = 52;
14009 }
14010
14011 /* Change frame size now if a change is pending. */
14012 do_pending_window_change (true);
14013
14014 /* If we just did a pending size change, or have additional
14015 visible frames, or selected_window changed, redisplay again. */
14016 if ((windows_or_buffers_changed && !pending)
14017 || (WINDOWP (selected_window) && (w = XWINDOW (selected_window)) != sw))
14018 goto retry;
14019
14020 /* Clear the face and image caches.
14021
14022 We used to do this only if consider_all_windows_p. But the cache
14023 needs to be cleared if a timer creates images in the current
14024 buffer (e.g. the test case in Bug#6230). */
14025
14026 if (clear_face_cache_count > CLEAR_FACE_CACHE_COUNT)
14027 {
14028 clear_face_cache (false);
14029 clear_face_cache_count = 0;
14030 }
14031
14032 #ifdef HAVE_WINDOW_SYSTEM
14033 if (clear_image_cache_count > CLEAR_IMAGE_CACHE_COUNT)
14034 {
14035 clear_image_caches (Qnil);
14036 clear_image_cache_count = 0;
14037 }
14038 #endif /* HAVE_WINDOW_SYSTEM */
14039
14040 end_of_redisplay:
14041 #ifdef HAVE_NS
14042 ns_set_doc_edited ();
14043 #endif
14044 if (interrupt_input && interrupts_deferred)
14045 request_sigio ();
14046
14047 unbind_to (count, Qnil);
14048 RESUME_POLLING;
14049 }
14050
14051
14052 /* Redisplay, but leave alone any recent echo area message unless
14053 another message has been requested in its place.
14054
14055 This is useful in situations where you need to redisplay but no
14056 user action has occurred, making it inappropriate for the message
14057 area to be cleared. See tracking_off and
14058 wait_reading_process_output for examples of these situations.
14059
14060 FROM_WHERE is an integer saying from where this function was
14061 called. This is useful for debugging. */
14062
14063 void
14064 redisplay_preserve_echo_area (int from_where)
14065 {
14066 TRACE ((stderr, "redisplay_preserve_echo_area (%d)\n", from_where));
14067
14068 if (!NILP (echo_area_buffer[1]))
14069 {
14070 /* We have a previously displayed message, but no current
14071 message. Redisplay the previous message. */
14072 display_last_displayed_message_p = true;
14073 redisplay_internal ();
14074 display_last_displayed_message_p = false;
14075 }
14076 else
14077 redisplay_internal ();
14078
14079 flush_frame (SELECTED_FRAME ());
14080 }
14081
14082
14083 /* Function registered with record_unwind_protect in redisplay_internal. */
14084
14085 static void
14086 unwind_redisplay (void)
14087 {
14088 redisplaying_p = false;
14089 }
14090
14091
14092 /* Mark the display of leaf window W as accurate or inaccurate.
14093 If ACCURATE_P, mark display of W as accurate.
14094 If !ACCURATE_P, arrange for W to be redisplayed the next
14095 time redisplay_internal is called. */
14096
14097 static void
14098 mark_window_display_accurate_1 (struct window *w, bool accurate_p)
14099 {
14100 struct buffer *b = XBUFFER (w->contents);
14101
14102 w->last_modified = accurate_p ? BUF_MODIFF (b) : 0;
14103 w->last_overlay_modified = accurate_p ? BUF_OVERLAY_MODIFF (b) : 0;
14104 w->last_had_star = BUF_MODIFF (b) > BUF_SAVE_MODIFF (b);
14105
14106 if (accurate_p)
14107 {
14108 b->clip_changed = false;
14109 b->prevent_redisplay_optimizations_p = false;
14110 eassert (buffer_window_count (b) > 0);
14111 /* Resetting b->text->redisplay is problematic!
14112 In order to make it safer to do it here, redisplay_internal must
14113 have copied all b->text->redisplay to their respective windows. */
14114 b->text->redisplay = false;
14115
14116 BUF_UNCHANGED_MODIFIED (b) = BUF_MODIFF (b);
14117 BUF_OVERLAY_UNCHANGED_MODIFIED (b) = BUF_OVERLAY_MODIFF (b);
14118 BUF_BEG_UNCHANGED (b) = BUF_GPT (b) - BUF_BEG (b);
14119 BUF_END_UNCHANGED (b) = BUF_Z (b) - BUF_GPT (b);
14120
14121 w->current_matrix->buffer = b;
14122 w->current_matrix->begv = BUF_BEGV (b);
14123 w->current_matrix->zv = BUF_ZV (b);
14124
14125 w->last_cursor_vpos = w->cursor.vpos;
14126 w->last_cursor_off_p = w->cursor_off_p;
14127
14128 if (w == XWINDOW (selected_window))
14129 w->last_point = BUF_PT (b);
14130 else
14131 w->last_point = marker_position (w->pointm);
14132
14133 w->window_end_valid = true;
14134 w->update_mode_line = false;
14135 }
14136
14137 w->redisplay = !accurate_p;
14138 }
14139
14140
14141 /* Mark the display of windows in the window tree rooted at WINDOW as
14142 accurate or inaccurate. If ACCURATE_P, mark display of
14143 windows as accurate. If !ACCURATE_P, arrange for windows to
14144 be redisplayed the next time redisplay_internal is called. */
14145
14146 void
14147 mark_window_display_accurate (Lisp_Object window, bool accurate_p)
14148 {
14149 struct window *w;
14150
14151 for (; !NILP (window); window = w->next)
14152 {
14153 w = XWINDOW (window);
14154 if (WINDOWP (w->contents))
14155 mark_window_display_accurate (w->contents, accurate_p);
14156 else
14157 mark_window_display_accurate_1 (w, accurate_p);
14158 }
14159
14160 if (accurate_p)
14161 update_overlay_arrows (1);
14162 else
14163 /* Force a thorough redisplay the next time by setting
14164 last_arrow_position and last_arrow_string to t, which is
14165 unequal to any useful value of Voverlay_arrow_... */
14166 update_overlay_arrows (-1);
14167 }
14168
14169
14170 /* Return value in display table DP (Lisp_Char_Table *) for character
14171 C. Since a display table doesn't have any parent, we don't have to
14172 follow parent. Do not call this function directly but use the
14173 macro DISP_CHAR_VECTOR. */
14174
14175 Lisp_Object
14176 disp_char_vector (struct Lisp_Char_Table *dp, int c)
14177 {
14178 Lisp_Object val;
14179
14180 if (ASCII_CHAR_P (c))
14181 {
14182 val = dp->ascii;
14183 if (SUB_CHAR_TABLE_P (val))
14184 val = XSUB_CHAR_TABLE (val)->contents[c];
14185 }
14186 else
14187 {
14188 Lisp_Object table;
14189
14190 XSETCHAR_TABLE (table, dp);
14191 val = char_table_ref (table, c);
14192 }
14193 if (NILP (val))
14194 val = dp->defalt;
14195 return val;
14196 }
14197
14198
14199 \f
14200 /***********************************************************************
14201 Window Redisplay
14202 ***********************************************************************/
14203
14204 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14205
14206 static void
14207 redisplay_windows (Lisp_Object window)
14208 {
14209 while (!NILP (window))
14210 {
14211 struct window *w = XWINDOW (window);
14212
14213 if (WINDOWP (w->contents))
14214 redisplay_windows (w->contents);
14215 else if (BUFFERP (w->contents))
14216 {
14217 displayed_buffer = XBUFFER (w->contents);
14218 /* Use list_of_error, not Qerror, so that
14219 we catch only errors and don't run the debugger. */
14220 internal_condition_case_1 (redisplay_window_0, window,
14221 list_of_error,
14222 redisplay_window_error);
14223 }
14224
14225 window = w->next;
14226 }
14227 }
14228
14229 static Lisp_Object
14230 redisplay_window_error (Lisp_Object ignore)
14231 {
14232 displayed_buffer->display_error_modiff = BUF_MODIFF (displayed_buffer);
14233 return Qnil;
14234 }
14235
14236 static Lisp_Object
14237 redisplay_window_0 (Lisp_Object window)
14238 {
14239 if (displayed_buffer->display_error_modiff < BUF_MODIFF (displayed_buffer))
14240 redisplay_window (window, false);
14241 return Qnil;
14242 }
14243
14244 static Lisp_Object
14245 redisplay_window_1 (Lisp_Object window)
14246 {
14247 if (displayed_buffer->display_error_modiff < BUF_MODIFF (displayed_buffer))
14248 redisplay_window (window, true);
14249 return Qnil;
14250 }
14251 \f
14252
14253 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14254 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14255 which positions recorded in ROW differ from current buffer
14256 positions.
14257
14258 Return true iff cursor is on this row. */
14259
14260 static bool
14261 set_cursor_from_row (struct window *w, struct glyph_row *row,
14262 struct glyph_matrix *matrix,
14263 ptrdiff_t delta, ptrdiff_t delta_bytes,
14264 int dy, int dvpos)
14265 {
14266 struct glyph *glyph = row->glyphs[TEXT_AREA];
14267 struct glyph *end = glyph + row->used[TEXT_AREA];
14268 struct glyph *cursor = NULL;
14269 /* The last known character position in row. */
14270 ptrdiff_t last_pos = MATRIX_ROW_START_CHARPOS (row) + delta;
14271 int x = row->x;
14272 ptrdiff_t pt_old = PT - delta;
14273 ptrdiff_t pos_before = MATRIX_ROW_START_CHARPOS (row) + delta;
14274 ptrdiff_t pos_after = MATRIX_ROW_END_CHARPOS (row) + delta;
14275 struct glyph *glyph_before = glyph - 1, *glyph_after = end;
14276 /* A glyph beyond the edge of TEXT_AREA which we should never
14277 touch. */
14278 struct glyph *glyphs_end = end;
14279 /* True means we've found a match for cursor position, but that
14280 glyph has the avoid_cursor_p flag set. */
14281 bool match_with_avoid_cursor = false;
14282 /* True means we've seen at least one glyph that came from a
14283 display string. */
14284 bool string_seen = false;
14285 /* Largest and smallest buffer positions seen so far during scan of
14286 glyph row. */
14287 ptrdiff_t bpos_max = pos_before;
14288 ptrdiff_t bpos_min = pos_after;
14289 /* Last buffer position covered by an overlay string with an integer
14290 `cursor' property. */
14291 ptrdiff_t bpos_covered = 0;
14292 /* True means the display string on which to display the cursor
14293 comes from a text property, not from an overlay. */
14294 bool string_from_text_prop = false;
14295
14296 /* Don't even try doing anything if called for a mode-line or
14297 header-line row, since the rest of the code isn't prepared to
14298 deal with such calamities. */
14299 eassert (!row->mode_line_p);
14300 if (row->mode_line_p)
14301 return false;
14302
14303 /* Skip over glyphs not having an object at the start and the end of
14304 the row. These are special glyphs like truncation marks on
14305 terminal frames. */
14306 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
14307 {
14308 if (!row->reversed_p)
14309 {
14310 while (glyph < end
14311 && NILP (glyph->object)
14312 && glyph->charpos < 0)
14313 {
14314 x += glyph->pixel_width;
14315 ++glyph;
14316 }
14317 while (end > glyph
14318 && NILP ((end - 1)->object)
14319 /* CHARPOS is zero for blanks and stretch glyphs
14320 inserted by extend_face_to_end_of_line. */
14321 && (end - 1)->charpos <= 0)
14322 --end;
14323 glyph_before = glyph - 1;
14324 glyph_after = end;
14325 }
14326 else
14327 {
14328 struct glyph *g;
14329
14330 /* If the glyph row is reversed, we need to process it from back
14331 to front, so swap the edge pointers. */
14332 glyphs_end = end = glyph - 1;
14333 glyph += row->used[TEXT_AREA] - 1;
14334
14335 while (glyph > end + 1
14336 && NILP (glyph->object)
14337 && glyph->charpos < 0)
14338 {
14339 --glyph;
14340 x -= glyph->pixel_width;
14341 }
14342 if (NILP (glyph->object) && glyph->charpos < 0)
14343 --glyph;
14344 /* By default, in reversed rows we put the cursor on the
14345 rightmost (first in the reading order) glyph. */
14346 for (g = end + 1; g < glyph; g++)
14347 x += g->pixel_width;
14348 while (end < glyph
14349 && NILP ((end + 1)->object)
14350 && (end + 1)->charpos <= 0)
14351 ++end;
14352 glyph_before = glyph + 1;
14353 glyph_after = end;
14354 }
14355 }
14356 else if (row->reversed_p)
14357 {
14358 /* In R2L rows that don't display text, put the cursor on the
14359 rightmost glyph. Case in point: an empty last line that is
14360 part of an R2L paragraph. */
14361 cursor = end - 1;
14362 /* Avoid placing the cursor on the last glyph of the row, where
14363 on terminal frames we hold the vertical border between
14364 adjacent windows. */
14365 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w))
14366 && !WINDOW_RIGHTMOST_P (w)
14367 && cursor == row->glyphs[LAST_AREA] - 1)
14368 cursor--;
14369 x = -1; /* will be computed below, at label compute_x */
14370 }
14371
14372 /* Step 1: Try to find the glyph whose character position
14373 corresponds to point. If that's not possible, find 2 glyphs
14374 whose character positions are the closest to point, one before
14375 point, the other after it. */
14376 if (!row->reversed_p)
14377 while (/* not marched to end of glyph row */
14378 glyph < end
14379 /* glyph was not inserted by redisplay for internal purposes */
14380 && !NILP (glyph->object))
14381 {
14382 if (BUFFERP (glyph->object))
14383 {
14384 ptrdiff_t dpos = glyph->charpos - pt_old;
14385
14386 if (glyph->charpos > bpos_max)
14387 bpos_max = glyph->charpos;
14388 if (glyph->charpos < bpos_min)
14389 bpos_min = glyph->charpos;
14390 if (!glyph->avoid_cursor_p)
14391 {
14392 /* If we hit point, we've found the glyph on which to
14393 display the cursor. */
14394 if (dpos == 0)
14395 {
14396 match_with_avoid_cursor = false;
14397 break;
14398 }
14399 /* See if we've found a better approximation to
14400 POS_BEFORE or to POS_AFTER. */
14401 if (0 > dpos && dpos > pos_before - pt_old)
14402 {
14403 pos_before = glyph->charpos;
14404 glyph_before = glyph;
14405 }
14406 else if (0 < dpos && dpos < pos_after - pt_old)
14407 {
14408 pos_after = glyph->charpos;
14409 glyph_after = glyph;
14410 }
14411 }
14412 else if (dpos == 0)
14413 match_with_avoid_cursor = true;
14414 }
14415 else if (STRINGP (glyph->object))
14416 {
14417 Lisp_Object chprop;
14418 ptrdiff_t glyph_pos = glyph->charpos;
14419
14420 chprop = Fget_char_property (make_number (glyph_pos), Qcursor,
14421 glyph->object);
14422 if (!NILP (chprop))
14423 {
14424 /* If the string came from a `display' text property,
14425 look up the buffer position of that property and
14426 use that position to update bpos_max, as if we
14427 actually saw such a position in one of the row's
14428 glyphs. This helps with supporting integer values
14429 of `cursor' property on the display string in
14430 situations where most or all of the row's buffer
14431 text is completely covered by display properties,
14432 so that no glyph with valid buffer positions is
14433 ever seen in the row. */
14434 ptrdiff_t prop_pos =
14435 string_buffer_position_lim (glyph->object, pos_before,
14436 pos_after, false);
14437
14438 if (prop_pos >= pos_before)
14439 bpos_max = prop_pos;
14440 }
14441 if (INTEGERP (chprop))
14442 {
14443 bpos_covered = bpos_max + XINT (chprop);
14444 /* If the `cursor' property covers buffer positions up
14445 to and including point, we should display cursor on
14446 this glyph. Note that, if a `cursor' property on one
14447 of the string's characters has an integer value, we
14448 will break out of the loop below _before_ we get to
14449 the position match above. IOW, integer values of
14450 the `cursor' property override the "exact match for
14451 point" strategy of positioning the cursor. */
14452 /* Implementation note: bpos_max == pt_old when, e.g.,
14453 we are in an empty line, where bpos_max is set to
14454 MATRIX_ROW_START_CHARPOS, see above. */
14455 if (bpos_max <= pt_old && bpos_covered >= pt_old)
14456 {
14457 cursor = glyph;
14458 break;
14459 }
14460 }
14461
14462 string_seen = true;
14463 }
14464 x += glyph->pixel_width;
14465 ++glyph;
14466 }
14467 else if (glyph > end) /* row is reversed */
14468 while (!NILP (glyph->object))
14469 {
14470 if (BUFFERP (glyph->object))
14471 {
14472 ptrdiff_t dpos = glyph->charpos - pt_old;
14473
14474 if (glyph->charpos > bpos_max)
14475 bpos_max = glyph->charpos;
14476 if (glyph->charpos < bpos_min)
14477 bpos_min = glyph->charpos;
14478 if (!glyph->avoid_cursor_p)
14479 {
14480 if (dpos == 0)
14481 {
14482 match_with_avoid_cursor = false;
14483 break;
14484 }
14485 if (0 > dpos && dpos > pos_before - pt_old)
14486 {
14487 pos_before = glyph->charpos;
14488 glyph_before = glyph;
14489 }
14490 else if (0 < dpos && dpos < pos_after - pt_old)
14491 {
14492 pos_after = glyph->charpos;
14493 glyph_after = glyph;
14494 }
14495 }
14496 else if (dpos == 0)
14497 match_with_avoid_cursor = true;
14498 }
14499 else if (STRINGP (glyph->object))
14500 {
14501 Lisp_Object chprop;
14502 ptrdiff_t glyph_pos = glyph->charpos;
14503
14504 chprop = Fget_char_property (make_number (glyph_pos), Qcursor,
14505 glyph->object);
14506 if (!NILP (chprop))
14507 {
14508 ptrdiff_t prop_pos =
14509 string_buffer_position_lim (glyph->object, pos_before,
14510 pos_after, false);
14511
14512 if (prop_pos >= pos_before)
14513 bpos_max = prop_pos;
14514 }
14515 if (INTEGERP (chprop))
14516 {
14517 bpos_covered = bpos_max + XINT (chprop);
14518 /* If the `cursor' property covers buffer positions up
14519 to and including point, we should display cursor on
14520 this glyph. */
14521 if (bpos_max <= pt_old && bpos_covered >= pt_old)
14522 {
14523 cursor = glyph;
14524 break;
14525 }
14526 }
14527 string_seen = true;
14528 }
14529 --glyph;
14530 if (glyph == glyphs_end) /* don't dereference outside TEXT_AREA */
14531 {
14532 x--; /* can't use any pixel_width */
14533 break;
14534 }
14535 x -= glyph->pixel_width;
14536 }
14537
14538 /* Step 2: If we didn't find an exact match for point, we need to
14539 look for a proper place to put the cursor among glyphs between
14540 GLYPH_BEFORE and GLYPH_AFTER. */
14541 if (!((row->reversed_p ? glyph > glyphs_end : glyph < glyphs_end)
14542 && BUFFERP (glyph->object) && glyph->charpos == pt_old)
14543 && !(bpos_max <= pt_old && pt_old <= bpos_covered))
14544 {
14545 /* An empty line has a single glyph whose OBJECT is nil and
14546 whose CHARPOS is the position of a newline on that line.
14547 Note that on a TTY, there are more glyphs after that, which
14548 were produced by extend_face_to_end_of_line, but their
14549 CHARPOS is zero or negative. */
14550 bool empty_line_p =
14551 ((row->reversed_p ? glyph > glyphs_end : glyph < glyphs_end)
14552 && NILP (glyph->object) && glyph->charpos > 0
14553 /* On a TTY, continued and truncated rows also have a glyph at
14554 their end whose OBJECT is nil and whose CHARPOS is
14555 positive (the continuation and truncation glyphs), but such
14556 rows are obviously not "empty". */
14557 && !(row->continued_p || row->truncated_on_right_p));
14558
14559 if (row->ends_in_ellipsis_p && pos_after == last_pos)
14560 {
14561 ptrdiff_t ellipsis_pos;
14562
14563 /* Scan back over the ellipsis glyphs. */
14564 if (!row->reversed_p)
14565 {
14566 ellipsis_pos = (glyph - 1)->charpos;
14567 while (glyph > row->glyphs[TEXT_AREA]
14568 && (glyph - 1)->charpos == ellipsis_pos)
14569 glyph--, x -= glyph->pixel_width;
14570 /* That loop always goes one position too far, including
14571 the glyph before the ellipsis. So scan forward over
14572 that one. */
14573 x += glyph->pixel_width;
14574 glyph++;
14575 }
14576 else /* row is reversed */
14577 {
14578 ellipsis_pos = (glyph + 1)->charpos;
14579 while (glyph < row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1
14580 && (glyph + 1)->charpos == ellipsis_pos)
14581 glyph++, x += glyph->pixel_width;
14582 x -= glyph->pixel_width;
14583 glyph--;
14584 }
14585 }
14586 else if (match_with_avoid_cursor)
14587 {
14588 cursor = glyph_after;
14589 x = -1;
14590 }
14591 else if (string_seen)
14592 {
14593 int incr = row->reversed_p ? -1 : +1;
14594
14595 /* Need to find the glyph that came out of a string which is
14596 present at point. That glyph is somewhere between
14597 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14598 positioned between POS_BEFORE and POS_AFTER in the
14599 buffer. */
14600 struct glyph *start, *stop;
14601 ptrdiff_t pos = pos_before;
14602
14603 x = -1;
14604
14605 /* If the row ends in a newline from a display string,
14606 reordering could have moved the glyphs belonging to the
14607 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14608 in this case we extend the search to the last glyph in
14609 the row that was not inserted by redisplay. */
14610 if (row->ends_in_newline_from_string_p)
14611 {
14612 glyph_after = end;
14613 pos_after = MATRIX_ROW_END_CHARPOS (row) + delta;
14614 }
14615
14616 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14617 correspond to POS_BEFORE and POS_AFTER, respectively. We
14618 need START and STOP in the order that corresponds to the
14619 row's direction as given by its reversed_p flag. If the
14620 directionality of characters between POS_BEFORE and
14621 POS_AFTER is the opposite of the row's base direction,
14622 these characters will have been reordered for display,
14623 and we need to reverse START and STOP. */
14624 if (!row->reversed_p)
14625 {
14626 start = min (glyph_before, glyph_after);
14627 stop = max (glyph_before, glyph_after);
14628 }
14629 else
14630 {
14631 start = max (glyph_before, glyph_after);
14632 stop = min (glyph_before, glyph_after);
14633 }
14634 for (glyph = start + incr;
14635 row->reversed_p ? glyph > stop : glyph < stop; )
14636 {
14637
14638 /* Any glyphs that come from the buffer are here because
14639 of bidi reordering. Skip them, and only pay
14640 attention to glyphs that came from some string. */
14641 if (STRINGP (glyph->object))
14642 {
14643 Lisp_Object str;
14644 ptrdiff_t tem;
14645 /* If the display property covers the newline, we
14646 need to search for it one position farther. */
14647 ptrdiff_t lim = pos_after
14648 + (pos_after == MATRIX_ROW_END_CHARPOS (row) + delta);
14649
14650 string_from_text_prop = false;
14651 str = glyph->object;
14652 tem = string_buffer_position_lim (str, pos, lim, false);
14653 if (tem == 0 /* from overlay */
14654 || pos <= tem)
14655 {
14656 /* If the string from which this glyph came is
14657 found in the buffer at point, or at position
14658 that is closer to point than pos_after, then
14659 we've found the glyph we've been looking for.
14660 If it comes from an overlay (tem == 0), and
14661 it has the `cursor' property on one of its
14662 glyphs, record that glyph as a candidate for
14663 displaying the cursor. (As in the
14664 unidirectional version, we will display the
14665 cursor on the last candidate we find.) */
14666 if (tem == 0
14667 || tem == pt_old
14668 || (tem - pt_old > 0 && tem < pos_after))
14669 {
14670 /* The glyphs from this string could have
14671 been reordered. Find the one with the
14672 smallest string position. Or there could
14673 be a character in the string with the
14674 `cursor' property, which means display
14675 cursor on that character's glyph. */
14676 ptrdiff_t strpos = glyph->charpos;
14677
14678 if (tem)
14679 {
14680 cursor = glyph;
14681 string_from_text_prop = true;
14682 }
14683 for ( ;
14684 (row->reversed_p ? glyph > stop : glyph < stop)
14685 && EQ (glyph->object, str);
14686 glyph += incr)
14687 {
14688 Lisp_Object cprop;
14689 ptrdiff_t gpos = glyph->charpos;
14690
14691 cprop = Fget_char_property (make_number (gpos),
14692 Qcursor,
14693 glyph->object);
14694 if (!NILP (cprop))
14695 {
14696 cursor = glyph;
14697 break;
14698 }
14699 if (tem && glyph->charpos < strpos)
14700 {
14701 strpos = glyph->charpos;
14702 cursor = glyph;
14703 }
14704 }
14705
14706 if (tem == pt_old
14707 || (tem - pt_old > 0 && tem < pos_after))
14708 goto compute_x;
14709 }
14710 if (tem)
14711 pos = tem + 1; /* don't find previous instances */
14712 }
14713 /* This string is not what we want; skip all of the
14714 glyphs that came from it. */
14715 while ((row->reversed_p ? glyph > stop : glyph < stop)
14716 && EQ (glyph->object, str))
14717 glyph += incr;
14718 }
14719 else
14720 glyph += incr;
14721 }
14722
14723 /* If we reached the end of the line, and END was from a string,
14724 the cursor is not on this line. */
14725 if (cursor == NULL
14726 && (row->reversed_p ? glyph <= end : glyph >= end)
14727 && (row->reversed_p ? end > glyphs_end : end < glyphs_end)
14728 && STRINGP (end->object)
14729 && row->continued_p)
14730 return false;
14731 }
14732 /* A truncated row may not include PT among its character positions.
14733 Setting the cursor inside the scroll margin will trigger
14734 recalculation of hscroll in hscroll_window_tree. But if a
14735 display string covers point, defer to the string-handling
14736 code below to figure this out. */
14737 else if (row->truncated_on_left_p && pt_old < bpos_min)
14738 {
14739 cursor = glyph_before;
14740 x = -1;
14741 }
14742 else if ((row->truncated_on_right_p && pt_old > bpos_max)
14743 /* Zero-width characters produce no glyphs. */
14744 || (!empty_line_p
14745 && (row->reversed_p
14746 ? glyph_after > glyphs_end
14747 : glyph_after < glyphs_end)))
14748 {
14749 cursor = glyph_after;
14750 x = -1;
14751 }
14752 }
14753
14754 compute_x:
14755 if (cursor != NULL)
14756 glyph = cursor;
14757 else if (glyph == glyphs_end
14758 && pos_before == pos_after
14759 && STRINGP ((row->reversed_p
14760 ? row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1
14761 : row->glyphs[TEXT_AREA])->object))
14762 {
14763 /* If all the glyphs of this row came from strings, put the
14764 cursor on the first glyph of the row. This avoids having the
14765 cursor outside of the text area in this very rare and hard
14766 use case. */
14767 glyph =
14768 row->reversed_p
14769 ? row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1
14770 : row->glyphs[TEXT_AREA];
14771 }
14772 if (x < 0)
14773 {
14774 struct glyph *g;
14775
14776 /* Need to compute x that corresponds to GLYPH. */
14777 for (g = row->glyphs[TEXT_AREA], x = row->x; g < glyph; g++)
14778 {
14779 if (g >= row->glyphs[TEXT_AREA] + row->used[TEXT_AREA])
14780 emacs_abort ();
14781 x += g->pixel_width;
14782 }
14783 }
14784
14785 /* ROW could be part of a continued line, which, under bidi
14786 reordering, might have other rows whose start and end charpos
14787 occlude point. Only set w->cursor if we found a better
14788 approximation to the cursor position than we have from previously
14789 examined candidate rows belonging to the same continued line. */
14790 if (/* We already have a candidate row. */
14791 w->cursor.vpos >= 0
14792 /* That candidate is not the row we are processing. */
14793 && MATRIX_ROW (matrix, w->cursor.vpos) != row
14794 /* Make sure cursor.vpos specifies a row whose start and end
14795 charpos occlude point, and it is valid candidate for being a
14796 cursor-row. This is because some callers of this function
14797 leave cursor.vpos at the row where the cursor was displayed
14798 during the last redisplay cycle. */
14799 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos)) <= pt_old
14800 && pt_old <= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos))
14801 && cursor_row_p (MATRIX_ROW (matrix, w->cursor.vpos)))
14802 {
14803 struct glyph *g1
14804 = MATRIX_ROW_GLYPH_START (matrix, w->cursor.vpos) + w->cursor.hpos;
14805
14806 /* Don't consider glyphs that are outside TEXT_AREA. */
14807 if (!(row->reversed_p ? glyph > glyphs_end : glyph < glyphs_end))
14808 return false;
14809 /* Keep the candidate whose buffer position is the closest to
14810 point or has the `cursor' property. */
14811 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14812 w->cursor.hpos >= 0
14813 && w->cursor.hpos < MATRIX_ROW_USED (matrix, w->cursor.vpos)
14814 && ((BUFFERP (g1->object)
14815 && (g1->charpos == pt_old /* An exact match always wins. */
14816 || (BUFFERP (glyph->object)
14817 && eabs (g1->charpos - pt_old)
14818 < eabs (glyph->charpos - pt_old))))
14819 /* Previous candidate is a glyph from a string that has
14820 a non-nil `cursor' property. */
14821 || (STRINGP (g1->object)
14822 && (!NILP (Fget_char_property (make_number (g1->charpos),
14823 Qcursor, g1->object))
14824 /* Previous candidate is from the same display
14825 string as this one, and the display string
14826 came from a text property. */
14827 || (EQ (g1->object, glyph->object)
14828 && string_from_text_prop)
14829 /* this candidate is from newline and its
14830 position is not an exact match */
14831 || (NILP (glyph->object)
14832 && glyph->charpos != pt_old)))))
14833 return false;
14834 /* If this candidate gives an exact match, use that. */
14835 if (!((BUFFERP (glyph->object) && glyph->charpos == pt_old)
14836 /* If this candidate is a glyph created for the
14837 terminating newline of a line, and point is on that
14838 newline, it wins because it's an exact match. */
14839 || (!row->continued_p
14840 && NILP (glyph->object)
14841 && glyph->charpos == 0
14842 && pt_old == MATRIX_ROW_END_CHARPOS (row) - 1))
14843 /* Otherwise, keep the candidate that comes from a row
14844 spanning less buffer positions. This may win when one or
14845 both candidate positions are on glyphs that came from
14846 display strings, for which we cannot compare buffer
14847 positions. */
14848 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos))
14849 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos))
14850 < MATRIX_ROW_END_CHARPOS (row) - MATRIX_ROW_START_CHARPOS (row))
14851 return false;
14852 }
14853 w->cursor.hpos = glyph - row->glyphs[TEXT_AREA];
14854 w->cursor.x = x;
14855 w->cursor.vpos = MATRIX_ROW_VPOS (row, matrix) + dvpos;
14856 w->cursor.y = row->y + dy;
14857
14858 if (w == XWINDOW (selected_window))
14859 {
14860 if (!row->continued_p
14861 && !MATRIX_ROW_CONTINUATION_LINE_P (row)
14862 && row->x == 0)
14863 {
14864 this_line_buffer = XBUFFER (w->contents);
14865
14866 CHARPOS (this_line_start_pos)
14867 = MATRIX_ROW_START_CHARPOS (row) + delta;
14868 BYTEPOS (this_line_start_pos)
14869 = MATRIX_ROW_START_BYTEPOS (row) + delta_bytes;
14870
14871 CHARPOS (this_line_end_pos)
14872 = Z - (MATRIX_ROW_END_CHARPOS (row) + delta);
14873 BYTEPOS (this_line_end_pos)
14874 = Z_BYTE - (MATRIX_ROW_END_BYTEPOS (row) + delta_bytes);
14875
14876 this_line_y = w->cursor.y;
14877 this_line_pixel_height = row->height;
14878 this_line_vpos = w->cursor.vpos;
14879 this_line_start_x = row->x;
14880 }
14881 else
14882 CHARPOS (this_line_start_pos) = 0;
14883 }
14884
14885 return true;
14886 }
14887
14888
14889 /* Run window scroll functions, if any, for WINDOW with new window
14890 start STARTP. Sets the window start of WINDOW to that position.
14891
14892 We assume that the window's buffer is really current. */
14893
14894 static struct text_pos
14895 run_window_scroll_functions (Lisp_Object window, struct text_pos startp)
14896 {
14897 struct window *w = XWINDOW (window);
14898 SET_MARKER_FROM_TEXT_POS (w->start, startp);
14899
14900 eassert (current_buffer == XBUFFER (w->contents));
14901
14902 if (!NILP (Vwindow_scroll_functions))
14903 {
14904 run_hook_with_args_2 (Qwindow_scroll_functions, window,
14905 make_number (CHARPOS (startp)));
14906 SET_TEXT_POS_FROM_MARKER (startp, w->start);
14907 /* In case the hook functions switch buffers. */
14908 set_buffer_internal (XBUFFER (w->contents));
14909 }
14910
14911 return startp;
14912 }
14913
14914
14915 /* Make sure the line containing the cursor is fully visible.
14916 A value of true means there is nothing to be done.
14917 (Either the line is fully visible, or it cannot be made so,
14918 or we cannot tell.)
14919
14920 If FORCE_P, return false even if partial visible cursor row
14921 is higher than window.
14922
14923 If CURRENT_MATRIX_P, use the information from the
14924 window's current glyph matrix; otherwise use the desired glyph
14925 matrix.
14926
14927 A value of false means the caller should do scrolling
14928 as if point had gone off the screen. */
14929
14930 static bool
14931 cursor_row_fully_visible_p (struct window *w, bool force_p,
14932 bool current_matrix_p)
14933 {
14934 struct glyph_matrix *matrix;
14935 struct glyph_row *row;
14936 int window_height;
14937
14938 if (!make_cursor_line_fully_visible_p)
14939 return true;
14940
14941 /* It's not always possible to find the cursor, e.g, when a window
14942 is full of overlay strings. Don't do anything in that case. */
14943 if (w->cursor.vpos < 0)
14944 return true;
14945
14946 matrix = current_matrix_p ? w->current_matrix : w->desired_matrix;
14947 row = MATRIX_ROW (matrix, w->cursor.vpos);
14948
14949 /* If the cursor row is not partially visible, there's nothing to do. */
14950 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w, row))
14951 return true;
14952
14953 /* If the row the cursor is in is taller than the window's height,
14954 it's not clear what to do, so do nothing. */
14955 window_height = window_box_height (w);
14956 if (row->height >= window_height)
14957 {
14958 if (!force_p || MINI_WINDOW_P (w)
14959 || w->vscroll || w->cursor.vpos == 0)
14960 return true;
14961 }
14962 return false;
14963 }
14964
14965
14966 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14967 means only WINDOW is redisplayed in redisplay_internal.
14968 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14969 in redisplay_window to bring a partially visible line into view in
14970 the case that only the cursor has moved.
14971
14972 LAST_LINE_MISFIT should be true if we're scrolling because the
14973 last screen line's vertical height extends past the end of the screen.
14974
14975 Value is
14976
14977 1 if scrolling succeeded
14978
14979 0 if scrolling didn't find point.
14980
14981 -1 if new fonts have been loaded so that we must interrupt
14982 redisplay, adjust glyph matrices, and try again. */
14983
14984 enum
14985 {
14986 SCROLLING_SUCCESS,
14987 SCROLLING_FAILED,
14988 SCROLLING_NEED_LARGER_MATRICES
14989 };
14990
14991 /* If scroll-conservatively is more than this, never recenter.
14992
14993 If you change this, don't forget to update the doc string of
14994 `scroll-conservatively' and the Emacs manual. */
14995 #define SCROLL_LIMIT 100
14996
14997 static int
14998 try_scrolling (Lisp_Object window, bool just_this_one_p,
14999 ptrdiff_t arg_scroll_conservatively, ptrdiff_t scroll_step,
15000 bool temp_scroll_step, bool last_line_misfit)
15001 {
15002 struct window *w = XWINDOW (window);
15003 struct frame *f = XFRAME (w->frame);
15004 struct text_pos pos, startp;
15005 struct it it;
15006 int this_scroll_margin, scroll_max, rc, height;
15007 int dy = 0, amount_to_scroll = 0;
15008 bool scroll_down_p = false;
15009 int extra_scroll_margin_lines = last_line_misfit;
15010 Lisp_Object aggressive;
15011 /* We will never try scrolling more than this number of lines. */
15012 int scroll_limit = SCROLL_LIMIT;
15013 int frame_line_height = default_line_pixel_height (w);
15014 int window_total_lines
15015 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
15016
15017 #ifdef GLYPH_DEBUG
15018 debug_method_add (w, "try_scrolling");
15019 #endif
15020
15021 SET_TEXT_POS_FROM_MARKER (startp, w->start);
15022
15023 /* Compute scroll margin height in pixels. We scroll when point is
15024 within this distance from the top or bottom of the window. */
15025 if (scroll_margin > 0)
15026 this_scroll_margin = min (scroll_margin, window_total_lines / 4)
15027 * frame_line_height;
15028 else
15029 this_scroll_margin = 0;
15030
15031 /* Force arg_scroll_conservatively to have a reasonable value, to
15032 avoid scrolling too far away with slow move_it_* functions. Note
15033 that the user can supply scroll-conservatively equal to
15034 `most-positive-fixnum', which can be larger than INT_MAX. */
15035 if (arg_scroll_conservatively > scroll_limit)
15036 {
15037 arg_scroll_conservatively = scroll_limit + 1;
15038 scroll_max = scroll_limit * frame_line_height;
15039 }
15040 else if (scroll_step || arg_scroll_conservatively || temp_scroll_step)
15041 /* Compute how much we should try to scroll maximally to bring
15042 point into view. */
15043 scroll_max = (max (scroll_step,
15044 max (arg_scroll_conservatively, temp_scroll_step))
15045 * frame_line_height);
15046 else if (NUMBERP (BVAR (current_buffer, scroll_down_aggressively))
15047 || NUMBERP (BVAR (current_buffer, scroll_up_aggressively)))
15048 /* We're trying to scroll because of aggressive scrolling but no
15049 scroll_step is set. Choose an arbitrary one. */
15050 scroll_max = 10 * frame_line_height;
15051 else
15052 scroll_max = 0;
15053
15054 too_near_end:
15055
15056 /* Decide whether to scroll down. */
15057 if (PT > CHARPOS (startp))
15058 {
15059 int scroll_margin_y;
15060
15061 /* Compute the pixel ypos of the scroll margin, then move IT to
15062 either that ypos or PT, whichever comes first. */
15063 start_display (&it, w, startp);
15064 scroll_margin_y = it.last_visible_y - this_scroll_margin
15065 - frame_line_height * extra_scroll_margin_lines;
15066 move_it_to (&it, PT, -1, scroll_margin_y - 1, -1,
15067 (MOVE_TO_POS | MOVE_TO_Y));
15068
15069 if (PT > CHARPOS (it.current.pos))
15070 {
15071 int y0 = line_bottom_y (&it);
15072 /* Compute how many pixels below window bottom to stop searching
15073 for PT. This avoids costly search for PT that is far away if
15074 the user limited scrolling by a small number of lines, but
15075 always finds PT if scroll_conservatively is set to a large
15076 number, such as most-positive-fixnum. */
15077 int slack = max (scroll_max, 10 * frame_line_height);
15078 int y_to_move = it.last_visible_y + slack;
15079
15080 /* Compute the distance from the scroll margin to PT or to
15081 the scroll limit, whichever comes first. This should
15082 include the height of the cursor line, to make that line
15083 fully visible. */
15084 move_it_to (&it, PT, -1, y_to_move,
15085 -1, MOVE_TO_POS | MOVE_TO_Y);
15086 dy = line_bottom_y (&it) - y0;
15087
15088 if (dy > scroll_max)
15089 return SCROLLING_FAILED;
15090
15091 if (dy > 0)
15092 scroll_down_p = true;
15093 }
15094 }
15095
15096 if (scroll_down_p)
15097 {
15098 /* Point is in or below the bottom scroll margin, so move the
15099 window start down. If scrolling conservatively, move it just
15100 enough down to make point visible. If scroll_step is set,
15101 move it down by scroll_step. */
15102 if (arg_scroll_conservatively)
15103 amount_to_scroll
15104 = min (max (dy, frame_line_height),
15105 frame_line_height * arg_scroll_conservatively);
15106 else if (scroll_step || temp_scroll_step)
15107 amount_to_scroll = scroll_max;
15108 else
15109 {
15110 aggressive = BVAR (current_buffer, scroll_up_aggressively);
15111 height = WINDOW_BOX_TEXT_HEIGHT (w);
15112 if (NUMBERP (aggressive))
15113 {
15114 double float_amount = XFLOATINT (aggressive) * height;
15115 int aggressive_scroll = float_amount;
15116 if (aggressive_scroll == 0 && float_amount > 0)
15117 aggressive_scroll = 1;
15118 /* Don't let point enter the scroll margin near top of
15119 the window. This could happen if the value of
15120 scroll_up_aggressively is too large and there are
15121 non-zero margins, because scroll_up_aggressively
15122 means put point that fraction of window height
15123 _from_the_bottom_margin_. */
15124 if (aggressive_scroll + 2 * this_scroll_margin > height)
15125 aggressive_scroll = height - 2 * this_scroll_margin;
15126 amount_to_scroll = dy + aggressive_scroll;
15127 }
15128 }
15129
15130 if (amount_to_scroll <= 0)
15131 return SCROLLING_FAILED;
15132
15133 start_display (&it, w, startp);
15134 if (arg_scroll_conservatively <= scroll_limit)
15135 move_it_vertically (&it, amount_to_scroll);
15136 else
15137 {
15138 /* Extra precision for users who set scroll-conservatively
15139 to a large number: make sure the amount we scroll
15140 the window start is never less than amount_to_scroll,
15141 which was computed as distance from window bottom to
15142 point. This matters when lines at window top and lines
15143 below window bottom have different height. */
15144 struct it it1;
15145 void *it1data = NULL;
15146 /* We use a temporary it1 because line_bottom_y can modify
15147 its argument, if it moves one line down; see there. */
15148 int start_y;
15149
15150 SAVE_IT (it1, it, it1data);
15151 start_y = line_bottom_y (&it1);
15152 do {
15153 RESTORE_IT (&it, &it, it1data);
15154 move_it_by_lines (&it, 1);
15155 SAVE_IT (it1, it, it1data);
15156 } while (IT_CHARPOS (it) < ZV
15157 && line_bottom_y (&it1) - start_y < amount_to_scroll);
15158 bidi_unshelve_cache (it1data, true);
15159 }
15160
15161 /* If STARTP is unchanged, move it down another screen line. */
15162 if (IT_CHARPOS (it) == CHARPOS (startp))
15163 move_it_by_lines (&it, 1);
15164 startp = it.current.pos;
15165 }
15166 else
15167 {
15168 struct text_pos scroll_margin_pos = startp;
15169 int y_offset = 0;
15170
15171 /* See if point is inside the scroll margin at the top of the
15172 window. */
15173 if (this_scroll_margin)
15174 {
15175 int y_start;
15176
15177 start_display (&it, w, startp);
15178 y_start = it.current_y;
15179 move_it_vertically (&it, this_scroll_margin);
15180 scroll_margin_pos = it.current.pos;
15181 /* If we didn't move enough before hitting ZV, request
15182 additional amount of scroll, to move point out of the
15183 scroll margin. */
15184 if (IT_CHARPOS (it) == ZV
15185 && it.current_y - y_start < this_scroll_margin)
15186 y_offset = this_scroll_margin - (it.current_y - y_start);
15187 }
15188
15189 if (PT < CHARPOS (scroll_margin_pos))
15190 {
15191 /* Point is in the scroll margin at the top of the window or
15192 above what is displayed in the window. */
15193 int y0, y_to_move;
15194
15195 /* Compute the vertical distance from PT to the scroll
15196 margin position. Move as far as scroll_max allows, or
15197 one screenful, or 10 screen lines, whichever is largest.
15198 Give up if distance is greater than scroll_max or if we
15199 didn't reach the scroll margin position. */
15200 SET_TEXT_POS (pos, PT, PT_BYTE);
15201 start_display (&it, w, pos);
15202 y0 = it.current_y;
15203 y_to_move = max (it.last_visible_y,
15204 max (scroll_max, 10 * frame_line_height));
15205 move_it_to (&it, CHARPOS (scroll_margin_pos), 0,
15206 y_to_move, -1,
15207 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
15208 dy = it.current_y - y0;
15209 if (dy > scroll_max
15210 || IT_CHARPOS (it) < CHARPOS (scroll_margin_pos))
15211 return SCROLLING_FAILED;
15212
15213 /* Additional scroll for when ZV was too close to point. */
15214 dy += y_offset;
15215
15216 /* Compute new window start. */
15217 start_display (&it, w, startp);
15218
15219 if (arg_scroll_conservatively)
15220 amount_to_scroll = max (dy, frame_line_height
15221 * max (scroll_step, temp_scroll_step));
15222 else if (scroll_step || temp_scroll_step)
15223 amount_to_scroll = scroll_max;
15224 else
15225 {
15226 aggressive = BVAR (current_buffer, scroll_down_aggressively);
15227 height = WINDOW_BOX_TEXT_HEIGHT (w);
15228 if (NUMBERP (aggressive))
15229 {
15230 double float_amount = XFLOATINT (aggressive) * height;
15231 int aggressive_scroll = float_amount;
15232 if (aggressive_scroll == 0 && float_amount > 0)
15233 aggressive_scroll = 1;
15234 /* Don't let point enter the scroll margin near
15235 bottom of the window, if the value of
15236 scroll_down_aggressively happens to be too
15237 large. */
15238 if (aggressive_scroll + 2 * this_scroll_margin > height)
15239 aggressive_scroll = height - 2 * this_scroll_margin;
15240 amount_to_scroll = dy + aggressive_scroll;
15241 }
15242 }
15243
15244 if (amount_to_scroll <= 0)
15245 return SCROLLING_FAILED;
15246
15247 move_it_vertically_backward (&it, amount_to_scroll);
15248 startp = it.current.pos;
15249 }
15250 }
15251
15252 /* Run window scroll functions. */
15253 startp = run_window_scroll_functions (window, startp);
15254
15255 /* Display the window. Give up if new fonts are loaded, or if point
15256 doesn't appear. */
15257 if (!try_window (window, startp, 0))
15258 rc = SCROLLING_NEED_LARGER_MATRICES;
15259 else if (w->cursor.vpos < 0)
15260 {
15261 clear_glyph_matrix (w->desired_matrix);
15262 rc = SCROLLING_FAILED;
15263 }
15264 else
15265 {
15266 /* Maybe forget recorded base line for line number display. */
15267 if (!just_this_one_p
15268 || current_buffer->clip_changed
15269 || BEG_UNCHANGED < CHARPOS (startp))
15270 w->base_line_number = 0;
15271
15272 /* If cursor ends up on a partially visible line,
15273 treat that as being off the bottom of the screen. */
15274 if (! cursor_row_fully_visible_p (w, extra_scroll_margin_lines <= 1,
15275 false)
15276 /* It's possible that the cursor is on the first line of the
15277 buffer, which is partially obscured due to a vscroll
15278 (Bug#7537). In that case, avoid looping forever. */
15279 && extra_scroll_margin_lines < w->desired_matrix->nrows - 1)
15280 {
15281 clear_glyph_matrix (w->desired_matrix);
15282 ++extra_scroll_margin_lines;
15283 goto too_near_end;
15284 }
15285 rc = SCROLLING_SUCCESS;
15286 }
15287
15288 return rc;
15289 }
15290
15291
15292 /* Compute a suitable window start for window W if display of W starts
15293 on a continuation line. Value is true if a new window start
15294 was computed.
15295
15296 The new window start will be computed, based on W's width, starting
15297 from the start of the continued line. It is the start of the
15298 screen line with the minimum distance from the old start W->start. */
15299
15300 static bool
15301 compute_window_start_on_continuation_line (struct window *w)
15302 {
15303 struct text_pos pos, start_pos;
15304 bool window_start_changed_p = false;
15305
15306 SET_TEXT_POS_FROM_MARKER (start_pos, w->start);
15307
15308 /* If window start is on a continuation line... Window start may be
15309 < BEGV in case there's invisible text at the start of the
15310 buffer (M-x rmail, for example). */
15311 if (CHARPOS (start_pos) > BEGV
15312 && FETCH_BYTE (BYTEPOS (start_pos) - 1) != '\n')
15313 {
15314 struct it it;
15315 struct glyph_row *row;
15316
15317 /* Handle the case that the window start is out of range. */
15318 if (CHARPOS (start_pos) < BEGV)
15319 SET_TEXT_POS (start_pos, BEGV, BEGV_BYTE);
15320 else if (CHARPOS (start_pos) > ZV)
15321 SET_TEXT_POS (start_pos, ZV, ZV_BYTE);
15322
15323 /* Find the start of the continued line. This should be fast
15324 because find_newline is fast (newline cache). */
15325 row = w->desired_matrix->rows + WINDOW_WANTS_HEADER_LINE_P (w);
15326 init_iterator (&it, w, CHARPOS (start_pos), BYTEPOS (start_pos),
15327 row, DEFAULT_FACE_ID);
15328 reseat_at_previous_visible_line_start (&it);
15329
15330 /* If the line start is "too far" away from the window start,
15331 say it takes too much time to compute a new window start. */
15332 if (CHARPOS (start_pos) - IT_CHARPOS (it)
15333 /* PXW: Do we need upper bounds here? */
15334 < WINDOW_TOTAL_LINES (w) * WINDOW_TOTAL_COLS (w))
15335 {
15336 int min_distance, distance;
15337
15338 /* Move forward by display lines to find the new window
15339 start. If window width was enlarged, the new start can
15340 be expected to be > the old start. If window width was
15341 decreased, the new window start will be < the old start.
15342 So, we're looking for the display line start with the
15343 minimum distance from the old window start. */
15344 pos = it.current.pos;
15345 min_distance = INFINITY;
15346 while ((distance = eabs (CHARPOS (start_pos) - IT_CHARPOS (it))),
15347 distance < min_distance)
15348 {
15349 min_distance = distance;
15350 pos = it.current.pos;
15351 if (it.line_wrap == WORD_WRAP)
15352 {
15353 /* Under WORD_WRAP, move_it_by_lines is likely to
15354 overshoot and stop not at the first, but the
15355 second character from the left margin. So in
15356 that case, we need a more tight control on the X
15357 coordinate of the iterator than move_it_by_lines
15358 promises in its contract. The method is to first
15359 go to the last (rightmost) visible character of a
15360 line, then move to the leftmost character on the
15361 next line in a separate call. */
15362 move_it_to (&it, ZV, it.last_visible_x, it.current_y, -1,
15363 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
15364 move_it_to (&it, ZV, 0,
15365 it.current_y + it.max_ascent + it.max_descent, -1,
15366 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
15367 }
15368 else
15369 move_it_by_lines (&it, 1);
15370 }
15371
15372 /* Set the window start there. */
15373 SET_MARKER_FROM_TEXT_POS (w->start, pos);
15374 window_start_changed_p = true;
15375 }
15376 }
15377
15378 return window_start_changed_p;
15379 }
15380
15381
15382 /* Try cursor movement in case text has not changed in window WINDOW,
15383 with window start STARTP. Value is
15384
15385 CURSOR_MOVEMENT_SUCCESS if successful
15386
15387 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15388
15389 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15390 display. *SCROLL_STEP is set to true, under certain circumstances, if
15391 we want to scroll as if scroll-step were set to 1. See the code.
15392
15393 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15394 which case we have to abort this redisplay, and adjust matrices
15395 first. */
15396
15397 enum
15398 {
15399 CURSOR_MOVEMENT_SUCCESS,
15400 CURSOR_MOVEMENT_CANNOT_BE_USED,
15401 CURSOR_MOVEMENT_MUST_SCROLL,
15402 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15403 };
15404
15405 static int
15406 try_cursor_movement (Lisp_Object window, struct text_pos startp,
15407 bool *scroll_step)
15408 {
15409 struct window *w = XWINDOW (window);
15410 struct frame *f = XFRAME (w->frame);
15411 int rc = CURSOR_MOVEMENT_CANNOT_BE_USED;
15412
15413 #ifdef GLYPH_DEBUG
15414 if (inhibit_try_cursor_movement)
15415 return rc;
15416 #endif
15417
15418 /* Previously, there was a check for Lisp integer in the
15419 if-statement below. Now, this field is converted to
15420 ptrdiff_t, thus zero means invalid position in a buffer. */
15421 eassert (w->last_point > 0);
15422 /* Likewise there was a check whether window_end_vpos is nil or larger
15423 than the window. Now window_end_vpos is int and so never nil, but
15424 let's leave eassert to check whether it fits in the window. */
15425 eassert (!w->window_end_valid
15426 || w->window_end_vpos < w->current_matrix->nrows);
15427
15428 /* Handle case where text has not changed, only point, and it has
15429 not moved off the frame. */
15430 if (/* Point may be in this window. */
15431 PT >= CHARPOS (startp)
15432 /* Selective display hasn't changed. */
15433 && !current_buffer->clip_changed
15434 /* Function force-mode-line-update is used to force a thorough
15435 redisplay. It sets either windows_or_buffers_changed or
15436 update_mode_lines. So don't take a shortcut here for these
15437 cases. */
15438 && !update_mode_lines
15439 && !windows_or_buffers_changed
15440 && !f->cursor_type_changed
15441 && !f->redisplay
15442 && NILP (Vshow_trailing_whitespace)
15443 /* This code is not used for mini-buffer for the sake of the case
15444 of redisplaying to replace an echo area message; since in
15445 that case the mini-buffer contents per se are usually
15446 unchanged. This code is of no real use in the mini-buffer
15447 since the handling of this_line_start_pos, etc., in redisplay
15448 handles the same cases. */
15449 && !EQ (window, minibuf_window)
15450 && (FRAME_WINDOW_P (f)
15451 || !overlay_arrow_in_current_buffer_p ()))
15452 {
15453 int this_scroll_margin, top_scroll_margin;
15454 struct glyph_row *row = NULL;
15455 int frame_line_height = default_line_pixel_height (w);
15456 int window_total_lines
15457 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
15458
15459 #ifdef GLYPH_DEBUG
15460 debug_method_add (w, "cursor movement");
15461 #endif
15462
15463 /* Scroll if point within this distance from the top or bottom
15464 of the window. This is a pixel value. */
15465 if (scroll_margin > 0)
15466 {
15467 this_scroll_margin = min (scroll_margin, window_total_lines / 4);
15468 this_scroll_margin *= frame_line_height;
15469 }
15470 else
15471 this_scroll_margin = 0;
15472
15473 top_scroll_margin = this_scroll_margin;
15474 if (WINDOW_WANTS_HEADER_LINE_P (w))
15475 top_scroll_margin += CURRENT_HEADER_LINE_HEIGHT (w);
15476
15477 /* Start with the row the cursor was displayed during the last
15478 not paused redisplay. Give up if that row is not valid. */
15479 if (w->last_cursor_vpos < 0
15480 || w->last_cursor_vpos >= w->current_matrix->nrows)
15481 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15482 else
15483 {
15484 row = MATRIX_ROW (w->current_matrix, w->last_cursor_vpos);
15485 if (row->mode_line_p)
15486 ++row;
15487 if (!row->enabled_p)
15488 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15489 }
15490
15491 if (rc == CURSOR_MOVEMENT_CANNOT_BE_USED)
15492 {
15493 bool scroll_p = false, must_scroll = false;
15494 int last_y = window_text_bottom_y (w) - this_scroll_margin;
15495
15496 if (PT > w->last_point)
15497 {
15498 /* Point has moved forward. */
15499 while (MATRIX_ROW_END_CHARPOS (row) < PT
15500 && MATRIX_ROW_BOTTOM_Y (row) < last_y)
15501 {
15502 eassert (row->enabled_p);
15503 ++row;
15504 }
15505
15506 /* If the end position of a row equals the start
15507 position of the next row, and PT is at that position,
15508 we would rather display cursor in the next line. */
15509 while (MATRIX_ROW_BOTTOM_Y (row) < last_y
15510 && MATRIX_ROW_END_CHARPOS (row) == PT
15511 && row < MATRIX_MODE_LINE_ROW (w->current_matrix)
15512 && MATRIX_ROW_START_CHARPOS (row+1) == PT
15513 && !cursor_row_p (row))
15514 ++row;
15515
15516 /* If within the scroll margin, scroll. Note that
15517 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15518 the next line would be drawn, and that
15519 this_scroll_margin can be zero. */
15520 if (MATRIX_ROW_BOTTOM_Y (row) > last_y
15521 || PT > MATRIX_ROW_END_CHARPOS (row)
15522 /* Line is completely visible last line in window
15523 and PT is to be set in the next line. */
15524 || (MATRIX_ROW_BOTTOM_Y (row) == last_y
15525 && PT == MATRIX_ROW_END_CHARPOS (row)
15526 && !row->ends_at_zv_p
15527 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row)))
15528 scroll_p = true;
15529 }
15530 else if (PT < w->last_point)
15531 {
15532 /* Cursor has to be moved backward. Note that PT >=
15533 CHARPOS (startp) because of the outer if-statement. */
15534 while (!row->mode_line_p
15535 && (MATRIX_ROW_START_CHARPOS (row) > PT
15536 || (MATRIX_ROW_START_CHARPOS (row) == PT
15537 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row)
15538 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15539 row > w->current_matrix->rows
15540 && (row-1)->ends_in_newline_from_string_p))))
15541 && (row->y > top_scroll_margin
15542 || CHARPOS (startp) == BEGV))
15543 {
15544 eassert (row->enabled_p);
15545 --row;
15546 }
15547
15548 /* Consider the following case: Window starts at BEGV,
15549 there is invisible, intangible text at BEGV, so that
15550 display starts at some point START > BEGV. It can
15551 happen that we are called with PT somewhere between
15552 BEGV and START. Try to handle that case. */
15553 if (row < w->current_matrix->rows
15554 || row->mode_line_p)
15555 {
15556 row = w->current_matrix->rows;
15557 if (row->mode_line_p)
15558 ++row;
15559 }
15560
15561 /* Due to newlines in overlay strings, we may have to
15562 skip forward over overlay strings. */
15563 while (MATRIX_ROW_BOTTOM_Y (row) < last_y
15564 && MATRIX_ROW_END_CHARPOS (row) == PT
15565 && !cursor_row_p (row))
15566 ++row;
15567
15568 /* If within the scroll margin, scroll. */
15569 if (row->y < top_scroll_margin
15570 && CHARPOS (startp) != BEGV)
15571 scroll_p = true;
15572 }
15573 else
15574 {
15575 /* Cursor did not move. So don't scroll even if cursor line
15576 is partially visible, as it was so before. */
15577 rc = CURSOR_MOVEMENT_SUCCESS;
15578 }
15579
15580 if (PT < MATRIX_ROW_START_CHARPOS (row)
15581 || PT > MATRIX_ROW_END_CHARPOS (row))
15582 {
15583 /* if PT is not in the glyph row, give up. */
15584 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15585 must_scroll = true;
15586 }
15587 else if (rc != CURSOR_MOVEMENT_SUCCESS
15588 && !NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering)))
15589 {
15590 struct glyph_row *row1;
15591
15592 /* If rows are bidi-reordered and point moved, back up
15593 until we find a row that does not belong to a
15594 continuation line. This is because we must consider
15595 all rows of a continued line as candidates for the
15596 new cursor positioning, since row start and end
15597 positions change non-linearly with vertical position
15598 in such rows. */
15599 /* FIXME: Revisit this when glyph ``spilling'' in
15600 continuation lines' rows is implemented for
15601 bidi-reordered rows. */
15602 for (row1 = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
15603 MATRIX_ROW_CONTINUATION_LINE_P (row);
15604 --row)
15605 {
15606 /* If we hit the beginning of the displayed portion
15607 without finding the first row of a continued
15608 line, give up. */
15609 if (row <= row1)
15610 {
15611 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15612 break;
15613 }
15614 eassert (row->enabled_p);
15615 }
15616 }
15617 if (must_scroll)
15618 ;
15619 else if (rc != CURSOR_MOVEMENT_SUCCESS
15620 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w, row)
15621 /* Make sure this isn't a header line by any chance, since
15622 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield true. */
15623 && !row->mode_line_p
15624 && make_cursor_line_fully_visible_p)
15625 {
15626 if (PT == MATRIX_ROW_END_CHARPOS (row)
15627 && !row->ends_at_zv_p
15628 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row))
15629 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15630 else if (row->height > window_box_height (w))
15631 {
15632 /* If we end up in a partially visible line, let's
15633 make it fully visible, except when it's taller
15634 than the window, in which case we can't do much
15635 about it. */
15636 *scroll_step = true;
15637 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15638 }
15639 else
15640 {
15641 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
15642 if (!cursor_row_fully_visible_p (w, false, true))
15643 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15644 else
15645 rc = CURSOR_MOVEMENT_SUCCESS;
15646 }
15647 }
15648 else if (scroll_p)
15649 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15650 else if (rc != CURSOR_MOVEMENT_SUCCESS
15651 && !NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering)))
15652 {
15653 /* With bidi-reordered rows, there could be more than
15654 one candidate row whose start and end positions
15655 occlude point. We need to let set_cursor_from_row
15656 find the best candidate. */
15657 /* FIXME: Revisit this when glyph ``spilling'' in
15658 continuation lines' rows is implemented for
15659 bidi-reordered rows. */
15660 bool rv = false;
15661
15662 do
15663 {
15664 bool at_zv_p = false, exact_match_p = false;
15665
15666 if (MATRIX_ROW_START_CHARPOS (row) <= PT
15667 && PT <= MATRIX_ROW_END_CHARPOS (row)
15668 && cursor_row_p (row))
15669 rv |= set_cursor_from_row (w, row, w->current_matrix,
15670 0, 0, 0, 0);
15671 /* As soon as we've found the exact match for point,
15672 or the first suitable row whose ends_at_zv_p flag
15673 is set, we are done. */
15674 if (rv)
15675 {
15676 at_zv_p = MATRIX_ROW (w->current_matrix,
15677 w->cursor.vpos)->ends_at_zv_p;
15678 if (!at_zv_p
15679 && w->cursor.hpos >= 0
15680 && w->cursor.hpos < MATRIX_ROW_USED (w->current_matrix,
15681 w->cursor.vpos))
15682 {
15683 struct glyph_row *candidate =
15684 MATRIX_ROW (w->current_matrix, w->cursor.vpos);
15685 struct glyph *g =
15686 candidate->glyphs[TEXT_AREA] + w->cursor.hpos;
15687 ptrdiff_t endpos = MATRIX_ROW_END_CHARPOS (candidate);
15688
15689 exact_match_p =
15690 (BUFFERP (g->object) && g->charpos == PT)
15691 || (NILP (g->object)
15692 && (g->charpos == PT
15693 || (g->charpos == 0 && endpos - 1 == PT)));
15694 }
15695 if (at_zv_p || exact_match_p)
15696 {
15697 rc = CURSOR_MOVEMENT_SUCCESS;
15698 break;
15699 }
15700 }
15701 if (MATRIX_ROW_BOTTOM_Y (row) == last_y)
15702 break;
15703 ++row;
15704 }
15705 while (((MATRIX_ROW_CONTINUATION_LINE_P (row)
15706 || row->continued_p)
15707 && MATRIX_ROW_BOTTOM_Y (row) <= last_y)
15708 || (MATRIX_ROW_START_CHARPOS (row) == PT
15709 && MATRIX_ROW_BOTTOM_Y (row) < last_y));
15710 /* If we didn't find any candidate rows, or exited the
15711 loop before all the candidates were examined, signal
15712 to the caller that this method failed. */
15713 if (rc != CURSOR_MOVEMENT_SUCCESS
15714 && !(rv
15715 && !MATRIX_ROW_CONTINUATION_LINE_P (row)
15716 && !row->continued_p))
15717 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15718 else if (rv)
15719 rc = CURSOR_MOVEMENT_SUCCESS;
15720 }
15721 else
15722 {
15723 do
15724 {
15725 if (set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0))
15726 {
15727 rc = CURSOR_MOVEMENT_SUCCESS;
15728 break;
15729 }
15730 ++row;
15731 }
15732 while (MATRIX_ROW_BOTTOM_Y (row) < last_y
15733 && MATRIX_ROW_START_CHARPOS (row) == PT
15734 && cursor_row_p (row));
15735 }
15736 }
15737 }
15738
15739 return rc;
15740 }
15741
15742
15743 void
15744 set_vertical_scroll_bar (struct window *w)
15745 {
15746 ptrdiff_t start, end, whole;
15747
15748 /* Calculate the start and end positions for the current window.
15749 At some point, it would be nice to choose between scrollbars
15750 which reflect the whole buffer size, with special markers
15751 indicating narrowing, and scrollbars which reflect only the
15752 visible region.
15753
15754 Note that mini-buffers sometimes aren't displaying any text. */
15755 if (!MINI_WINDOW_P (w)
15756 || (w == XWINDOW (minibuf_window)
15757 && NILP (echo_area_buffer[0])))
15758 {
15759 struct buffer *buf = XBUFFER (w->contents);
15760 whole = BUF_ZV (buf) - BUF_BEGV (buf);
15761 start = marker_position (w->start) - BUF_BEGV (buf);
15762 /* I don't think this is guaranteed to be right. For the
15763 moment, we'll pretend it is. */
15764 end = BUF_Z (buf) - w->window_end_pos - BUF_BEGV (buf);
15765
15766 if (end < start)
15767 end = start;
15768 if (whole < (end - start))
15769 whole = end - start;
15770 }
15771 else
15772 start = end = whole = 0;
15773
15774 /* Indicate what this scroll bar ought to be displaying now. */
15775 if (FRAME_TERMINAL (XFRAME (w->frame))->set_vertical_scroll_bar_hook)
15776 (*FRAME_TERMINAL (XFRAME (w->frame))->set_vertical_scroll_bar_hook)
15777 (w, end - start, whole, start);
15778 }
15779
15780
15781 void
15782 set_horizontal_scroll_bar (struct window *w)
15783 {
15784 int start, end, whole, portion;
15785
15786 if (!MINI_WINDOW_P (w)
15787 || (w == XWINDOW (minibuf_window)
15788 && NILP (echo_area_buffer[0])))
15789 {
15790 struct buffer *b = XBUFFER (w->contents);
15791 struct buffer *old_buffer = NULL;
15792 struct it it;
15793 struct text_pos startp;
15794
15795 if (b != current_buffer)
15796 {
15797 old_buffer = current_buffer;
15798 set_buffer_internal (b);
15799 }
15800
15801 SET_TEXT_POS_FROM_MARKER (startp, w->start);
15802 start_display (&it, w, startp);
15803 it.last_visible_x = INT_MAX;
15804 whole = move_it_to (&it, -1, INT_MAX, window_box_height (w), -1,
15805 MOVE_TO_X | MOVE_TO_Y);
15806 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15807 window_box_height (w), -1,
15808 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15809
15810 start = w->hscroll * FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w));
15811 end = start + window_box_width (w, TEXT_AREA);
15812 portion = end - start;
15813 /* After enlarging a horizontally scrolled window such that it
15814 gets at least as wide as the text it contains, make sure that
15815 the thumb doesn't fill the entire scroll bar so we can still
15816 drag it back to see the entire text. */
15817 whole = max (whole, end);
15818
15819 if (it.bidi_p)
15820 {
15821 Lisp_Object pdir;
15822
15823 pdir = Fcurrent_bidi_paragraph_direction (Qnil);
15824 if (EQ (pdir, Qright_to_left))
15825 {
15826 start = whole - end;
15827 end = start + portion;
15828 }
15829 }
15830
15831 if (old_buffer)
15832 set_buffer_internal (old_buffer);
15833 }
15834 else
15835 start = end = whole = portion = 0;
15836
15837 w->hscroll_whole = whole;
15838
15839 /* Indicate what this scroll bar ought to be displaying now. */
15840 if (FRAME_TERMINAL (XFRAME (w->frame))->set_horizontal_scroll_bar_hook)
15841 (*FRAME_TERMINAL (XFRAME (w->frame))->set_horizontal_scroll_bar_hook)
15842 (w, portion, whole, start);
15843 }
15844
15845
15846 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P means only
15847 selected_window is redisplayed.
15848
15849 We can return without actually redisplaying the window if fonts has been
15850 changed on window's frame. In that case, redisplay_internal will retry.
15851
15852 As one of the important parts of redisplaying a window, we need to
15853 decide whether the previous window-start position (stored in the
15854 window's w->start marker position) is still valid, and if it isn't,
15855 recompute it. Some details about that:
15856
15857 . The previous window-start could be in a continuation line, in
15858 which case we need to recompute it when the window width
15859 changes. See compute_window_start_on_continuation_line and its
15860 call below.
15861
15862 . The text that changed since last redisplay could include the
15863 previous window-start position. In that case, we try to salvage
15864 what we can from the current glyph matrix by calling
15865 try_scrolling, which see.
15866
15867 . Some Emacs command could force us to use a specific window-start
15868 position by setting the window's force_start flag, or gently
15869 propose doing that by setting the window's optional_new_start
15870 flag. In these cases, we try using the specified start point if
15871 that succeeds (i.e. the window desired matrix is successfully
15872 recomputed, and point location is within the window). In case
15873 of optional_new_start, we first check if the specified start
15874 position is feasible, i.e. if it will allow point to be
15875 displayed in the window. If using the specified start point
15876 fails, e.g., if new fonts are needed to be loaded, we abort the
15877 redisplay cycle and leave it up to the next cycle to figure out
15878 things.
15879
15880 . Note that the window's force_start flag is sometimes set by
15881 redisplay itself, when it decides that the previous window start
15882 point is fine and should be kept. Search for "goto force_start"
15883 below to see the details. Like the values of window-start
15884 specified outside of redisplay, these internally-deduced values
15885 are tested for feasibility, and ignored if found to be
15886 unfeasible.
15887
15888 . Note that the function try_window, used to completely redisplay
15889 a window, accepts the window's start point as its argument.
15890 This is used several times in the redisplay code to control
15891 where the window start will be, according to user options such
15892 as scroll-conservatively, and also to ensure the screen line
15893 showing point will be fully (as opposed to partially) visible on
15894 display. */
15895
15896 static void
15897 redisplay_window (Lisp_Object window, bool just_this_one_p)
15898 {
15899 struct window *w = XWINDOW (window);
15900 struct frame *f = XFRAME (w->frame);
15901 struct buffer *buffer = XBUFFER (w->contents);
15902 struct buffer *old = current_buffer;
15903 struct text_pos lpoint, opoint, startp;
15904 bool update_mode_line;
15905 int tem;
15906 struct it it;
15907 /* Record it now because it's overwritten. */
15908 bool current_matrix_up_to_date_p = false;
15909 bool used_current_matrix_p = false;
15910 /* This is less strict than current_matrix_up_to_date_p.
15911 It indicates that the buffer contents and narrowing are unchanged. */
15912 bool buffer_unchanged_p = false;
15913 bool temp_scroll_step = false;
15914 ptrdiff_t count = SPECPDL_INDEX ();
15915 int rc;
15916 int centering_position = -1;
15917 bool last_line_misfit = false;
15918 ptrdiff_t beg_unchanged, end_unchanged;
15919 int frame_line_height;
15920
15921 SET_TEXT_POS (lpoint, PT, PT_BYTE);
15922 opoint = lpoint;
15923
15924 #ifdef GLYPH_DEBUG
15925 *w->desired_matrix->method = 0;
15926 #endif
15927
15928 if (!just_this_one_p
15929 && REDISPLAY_SOME_P ()
15930 && !w->redisplay
15931 && !w->update_mode_line
15932 && !f->face_change
15933 && !f->redisplay
15934 && !buffer->text->redisplay
15935 && BUF_PT (buffer) == w->last_point)
15936 return;
15937
15938 /* Make sure that both W's markers are valid. */
15939 eassert (XMARKER (w->start)->buffer == buffer);
15940 eassert (XMARKER (w->pointm)->buffer == buffer);
15941
15942 /* We come here again if we need to run window-text-change-functions
15943 below. */
15944 restart:
15945 reconsider_clip_changes (w);
15946 frame_line_height = default_line_pixel_height (w);
15947
15948 /* Has the mode line to be updated? */
15949 update_mode_line = (w->update_mode_line
15950 || update_mode_lines
15951 || buffer->clip_changed
15952 || buffer->prevent_redisplay_optimizations_p);
15953
15954 if (!just_this_one_p)
15955 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15956 cleverly elsewhere. */
15957 w->must_be_updated_p = true;
15958
15959 if (MINI_WINDOW_P (w))
15960 {
15961 if (w == XWINDOW (echo_area_window)
15962 && !NILP (echo_area_buffer[0]))
15963 {
15964 if (update_mode_line)
15965 /* We may have to update a tty frame's menu bar or a
15966 tool-bar. Example `M-x C-h C-h C-g'. */
15967 goto finish_menu_bars;
15968 else
15969 /* We've already displayed the echo area glyphs in this window. */
15970 goto finish_scroll_bars;
15971 }
15972 else if ((w != XWINDOW (minibuf_window)
15973 || minibuf_level == 0)
15974 /* When buffer is nonempty, redisplay window normally. */
15975 && BUF_Z (XBUFFER (w->contents)) == BUF_BEG (XBUFFER (w->contents))
15976 /* Quail displays non-mini buffers in minibuffer window.
15977 In that case, redisplay the window normally. */
15978 && !NILP (Fmemq (w->contents, Vminibuffer_list)))
15979 {
15980 /* W is a mini-buffer window, but it's not active, so clear
15981 it. */
15982 int yb = window_text_bottom_y (w);
15983 struct glyph_row *row;
15984 int y;
15985
15986 for (y = 0, row = w->desired_matrix->rows;
15987 y < yb;
15988 y += row->height, ++row)
15989 blank_row (w, row, y);
15990 goto finish_scroll_bars;
15991 }
15992
15993 clear_glyph_matrix (w->desired_matrix);
15994 }
15995
15996 /* Otherwise set up data on this window; select its buffer and point
15997 value. */
15998 /* Really select the buffer, for the sake of buffer-local
15999 variables. */
16000 set_buffer_internal_1 (XBUFFER (w->contents));
16001
16002 current_matrix_up_to_date_p
16003 = (w->window_end_valid
16004 && !current_buffer->clip_changed
16005 && !current_buffer->prevent_redisplay_optimizations_p
16006 && !window_outdated (w));
16007
16008 /* Run the window-text-change-functions
16009 if it is possible that the text on the screen has changed
16010 (either due to modification of the text, or any other reason). */
16011 if (!current_matrix_up_to_date_p
16012 && !NILP (Vwindow_text_change_functions))
16013 {
16014 safe_run_hooks (Qwindow_text_change_functions);
16015 goto restart;
16016 }
16017
16018 beg_unchanged = BEG_UNCHANGED;
16019 end_unchanged = END_UNCHANGED;
16020
16021 SET_TEXT_POS (opoint, PT, PT_BYTE);
16022
16023 specbind (Qinhibit_point_motion_hooks, Qt);
16024
16025 buffer_unchanged_p
16026 = (w->window_end_valid
16027 && !current_buffer->clip_changed
16028 && !window_outdated (w));
16029
16030 /* When windows_or_buffers_changed is non-zero, we can't rely
16031 on the window end being valid, so set it to zero there. */
16032 if (windows_or_buffers_changed)
16033 {
16034 /* If window starts on a continuation line, maybe adjust the
16035 window start in case the window's width changed. */
16036 if (XMARKER (w->start)->buffer == current_buffer)
16037 compute_window_start_on_continuation_line (w);
16038
16039 w->window_end_valid = false;
16040 /* If so, we also can't rely on current matrix
16041 and should not fool try_cursor_movement below. */
16042 current_matrix_up_to_date_p = false;
16043 }
16044
16045 /* Some sanity checks. */
16046 CHECK_WINDOW_END (w);
16047 if (Z == Z_BYTE && CHARPOS (opoint) != BYTEPOS (opoint))
16048 emacs_abort ();
16049 if (BYTEPOS (opoint) < CHARPOS (opoint))
16050 emacs_abort ();
16051
16052 if (mode_line_update_needed (w))
16053 update_mode_line = true;
16054
16055 /* Point refers normally to the selected window. For any other
16056 window, set up appropriate value. */
16057 if (!EQ (window, selected_window))
16058 {
16059 ptrdiff_t new_pt = marker_position (w->pointm);
16060 ptrdiff_t new_pt_byte = marker_byte_position (w->pointm);
16061
16062 if (new_pt < BEGV)
16063 {
16064 new_pt = BEGV;
16065 new_pt_byte = BEGV_BYTE;
16066 set_marker_both (w->pointm, Qnil, BEGV, BEGV_BYTE);
16067 }
16068 else if (new_pt > (ZV - 1))
16069 {
16070 new_pt = ZV;
16071 new_pt_byte = ZV_BYTE;
16072 set_marker_both (w->pointm, Qnil, ZV, ZV_BYTE);
16073 }
16074
16075 /* We don't use SET_PT so that the point-motion hooks don't run. */
16076 TEMP_SET_PT_BOTH (new_pt, new_pt_byte);
16077 }
16078
16079 /* If any of the character widths specified in the display table
16080 have changed, invalidate the width run cache. It's true that
16081 this may be a bit late to catch such changes, but the rest of
16082 redisplay goes (non-fatally) haywire when the display table is
16083 changed, so why should we worry about doing any better? */
16084 if (current_buffer->width_run_cache
16085 || (current_buffer->base_buffer
16086 && current_buffer->base_buffer->width_run_cache))
16087 {
16088 struct Lisp_Char_Table *disptab = buffer_display_table ();
16089
16090 if (! disptab_matches_widthtab
16091 (disptab, XVECTOR (BVAR (current_buffer, width_table))))
16092 {
16093 struct buffer *buf = current_buffer;
16094
16095 if (buf->base_buffer)
16096 buf = buf->base_buffer;
16097 invalidate_region_cache (buf, buf->width_run_cache, BEG, Z);
16098 recompute_width_table (current_buffer, disptab);
16099 }
16100 }
16101
16102 /* If window-start is screwed up, choose a new one. */
16103 if (XMARKER (w->start)->buffer != current_buffer)
16104 goto recenter;
16105
16106 SET_TEXT_POS_FROM_MARKER (startp, w->start);
16107
16108 /* If someone specified a new starting point but did not insist,
16109 check whether it can be used. */
16110 if ((w->optional_new_start || window_frozen_p (w))
16111 && CHARPOS (startp) >= BEGV
16112 && CHARPOS (startp) <= ZV)
16113 {
16114 ptrdiff_t it_charpos;
16115
16116 w->optional_new_start = false;
16117 start_display (&it, w, startp);
16118 move_it_to (&it, PT, 0, it.last_visible_y, -1,
16119 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
16120 /* Record IT's position now, since line_bottom_y might change
16121 that. */
16122 it_charpos = IT_CHARPOS (it);
16123 /* Make sure we set the force_start flag only if the cursor row
16124 will be fully visible. Otherwise, the code under force_start
16125 label below will try to move point back into view, which is
16126 not what the code which sets optional_new_start wants. */
16127 if ((it.current_y == 0 || line_bottom_y (&it) < it.last_visible_y)
16128 && !w->force_start)
16129 {
16130 if (it_charpos == PT)
16131 w->force_start = true;
16132 /* IT may overshoot PT if text at PT is invisible. */
16133 else if (it_charpos > PT && CHARPOS (startp) <= PT)
16134 w->force_start = true;
16135 #ifdef GLYPH_DEBUG
16136 if (w->force_start)
16137 {
16138 if (window_frozen_p (w))
16139 debug_method_add (w, "set force_start from frozen window start");
16140 else
16141 debug_method_add (w, "set force_start from optional_new_start");
16142 }
16143 #endif
16144 }
16145 }
16146
16147 force_start:
16148
16149 /* Handle case where place to start displaying has been specified,
16150 unless the specified location is outside the accessible range. */
16151 if (w->force_start)
16152 {
16153 /* We set this later on if we have to adjust point. */
16154 int new_vpos = -1;
16155
16156 w->force_start = false;
16157 w->vscroll = 0;
16158 w->window_end_valid = false;
16159
16160 /* Forget any recorded base line for line number display. */
16161 if (!buffer_unchanged_p)
16162 w->base_line_number = 0;
16163
16164 /* Redisplay the mode line. Select the buffer properly for that.
16165 Also, run the hook window-scroll-functions
16166 because we have scrolled. */
16167 /* Note, we do this after clearing force_start because
16168 if there's an error, it is better to forget about force_start
16169 than to get into an infinite loop calling the hook functions
16170 and having them get more errors. */
16171 if (!update_mode_line
16172 || ! NILP (Vwindow_scroll_functions))
16173 {
16174 update_mode_line = true;
16175 w->update_mode_line = true;
16176 startp = run_window_scroll_functions (window, startp);
16177 }
16178
16179 if (CHARPOS (startp) < BEGV)
16180 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
16181 else if (CHARPOS (startp) > ZV)
16182 SET_TEXT_POS (startp, ZV, ZV_BYTE);
16183
16184 /* Redisplay, then check if cursor has been set during the
16185 redisplay. Give up if new fonts were loaded. */
16186 /* We used to issue a CHECK_MARGINS argument to try_window here,
16187 but this causes scrolling to fail when point begins inside
16188 the scroll margin (bug#148) -- cyd */
16189 if (!try_window (window, startp, 0))
16190 {
16191 w->force_start = true;
16192 clear_glyph_matrix (w->desired_matrix);
16193 goto need_larger_matrices;
16194 }
16195
16196 if (w->cursor.vpos < 0)
16197 {
16198 /* If point does not appear, try to move point so it does
16199 appear. The desired matrix has been built above, so we
16200 can use it here. */
16201 new_vpos = window_box_height (w) / 2;
16202 }
16203
16204 if (!cursor_row_fully_visible_p (w, false, false))
16205 {
16206 /* Point does appear, but on a line partly visible at end of window.
16207 Move it back to a fully-visible line. */
16208 new_vpos = window_box_height (w);
16209 /* But if window_box_height suggests a Y coordinate that is
16210 not less than we already have, that line will clearly not
16211 be fully visible, so give up and scroll the display.
16212 This can happen when the default face uses a font whose
16213 dimensions are different from the frame's default
16214 font. */
16215 if (new_vpos >= w->cursor.y)
16216 {
16217 w->cursor.vpos = -1;
16218 clear_glyph_matrix (w->desired_matrix);
16219 goto try_to_scroll;
16220 }
16221 }
16222 else if (w->cursor.vpos >= 0)
16223 {
16224 /* Some people insist on not letting point enter the scroll
16225 margin, even though this part handles windows that didn't
16226 scroll at all. */
16227 int window_total_lines
16228 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
16229 int margin = min (scroll_margin, window_total_lines / 4);
16230 int pixel_margin = margin * frame_line_height;
16231 bool header_line = WINDOW_WANTS_HEADER_LINE_P (w);
16232
16233 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16234 below, which finds the row to move point to, advances by
16235 the Y coordinate of the _next_ row, see the definition of
16236 MATRIX_ROW_BOTTOM_Y. */
16237 if (w->cursor.vpos < margin + header_line)
16238 {
16239 w->cursor.vpos = -1;
16240 clear_glyph_matrix (w->desired_matrix);
16241 goto try_to_scroll;
16242 }
16243 else
16244 {
16245 int window_height = window_box_height (w);
16246
16247 if (header_line)
16248 window_height += CURRENT_HEADER_LINE_HEIGHT (w);
16249 if (w->cursor.y >= window_height - pixel_margin)
16250 {
16251 w->cursor.vpos = -1;
16252 clear_glyph_matrix (w->desired_matrix);
16253 goto try_to_scroll;
16254 }
16255 }
16256 }
16257
16258 /* If we need to move point for either of the above reasons,
16259 now actually do it. */
16260 if (new_vpos >= 0)
16261 {
16262 struct glyph_row *row;
16263
16264 row = MATRIX_FIRST_TEXT_ROW (w->desired_matrix);
16265 while (MATRIX_ROW_BOTTOM_Y (row) < new_vpos)
16266 ++row;
16267
16268 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row),
16269 MATRIX_ROW_START_BYTEPOS (row));
16270
16271 if (w != XWINDOW (selected_window))
16272 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
16273 else if (current_buffer == old)
16274 SET_TEXT_POS (lpoint, PT, PT_BYTE);
16275
16276 set_cursor_from_row (w, row, w->desired_matrix, 0, 0, 0, 0);
16277
16278 /* Re-run pre-redisplay-function so it can update the region
16279 according to the new position of point. */
16280 /* Other than the cursor, w's redisplay is done so we can set its
16281 redisplay to false. Also the buffer's redisplay can be set to
16282 false, since propagate_buffer_redisplay should have already
16283 propagated its info to `w' anyway. */
16284 w->redisplay = false;
16285 XBUFFER (w->contents)->text->redisplay = false;
16286 safe__call1 (true, Vpre_redisplay_function, Fcons (window, Qnil));
16287
16288 if (w->redisplay || XBUFFER (w->contents)->text->redisplay)
16289 {
16290 /* pre-redisplay-function made changes (e.g. move the region)
16291 that require another round of redisplay. */
16292 clear_glyph_matrix (w->desired_matrix);
16293 if (!try_window (window, startp, 0))
16294 goto need_larger_matrices;
16295 }
16296 }
16297 if (w->cursor.vpos < 0 || !cursor_row_fully_visible_p (w, false, false))
16298 {
16299 clear_glyph_matrix (w->desired_matrix);
16300 goto try_to_scroll;
16301 }
16302
16303 #ifdef GLYPH_DEBUG
16304 debug_method_add (w, "forced window start");
16305 #endif
16306 goto done;
16307 }
16308
16309 /* Handle case where text has not changed, only point, and it has
16310 not moved off the frame, and we are not retrying after hscroll.
16311 (current_matrix_up_to_date_p is true when retrying.) */
16312 if (current_matrix_up_to_date_p
16313 && (rc = try_cursor_movement (window, startp, &temp_scroll_step),
16314 rc != CURSOR_MOVEMENT_CANNOT_BE_USED))
16315 {
16316 switch (rc)
16317 {
16318 case CURSOR_MOVEMENT_SUCCESS:
16319 used_current_matrix_p = true;
16320 goto done;
16321
16322 case CURSOR_MOVEMENT_MUST_SCROLL:
16323 goto try_to_scroll;
16324
16325 default:
16326 emacs_abort ();
16327 }
16328 }
16329 /* If current starting point was originally the beginning of a line
16330 but no longer is, find a new starting point. */
16331 else if (w->start_at_line_beg
16332 && !(CHARPOS (startp) <= BEGV
16333 || FETCH_BYTE (BYTEPOS (startp) - 1) == '\n'))
16334 {
16335 #ifdef GLYPH_DEBUG
16336 debug_method_add (w, "recenter 1");
16337 #endif
16338 goto recenter;
16339 }
16340
16341 /* Try scrolling with try_window_id. Value is > 0 if update has
16342 been done, it is -1 if we know that the same window start will
16343 not work. It is 0 if unsuccessful for some other reason. */
16344 else if ((tem = try_window_id (w)) != 0)
16345 {
16346 #ifdef GLYPH_DEBUG
16347 debug_method_add (w, "try_window_id %d", tem);
16348 #endif
16349
16350 if (f->fonts_changed)
16351 goto need_larger_matrices;
16352 if (tem > 0)
16353 goto done;
16354
16355 /* Otherwise try_window_id has returned -1 which means that we
16356 don't want the alternative below this comment to execute. */
16357 }
16358 else if (CHARPOS (startp) >= BEGV
16359 && CHARPOS (startp) <= ZV
16360 && PT >= CHARPOS (startp)
16361 && (CHARPOS (startp) < ZV
16362 /* Avoid starting at end of buffer. */
16363 || CHARPOS (startp) == BEGV
16364 || !window_outdated (w)))
16365 {
16366 int d1, d2, d5, d6;
16367 int rtop, rbot;
16368
16369 /* If first window line is a continuation line, and window start
16370 is inside the modified region, but the first change is before
16371 current window start, we must select a new window start.
16372
16373 However, if this is the result of a down-mouse event (e.g. by
16374 extending the mouse-drag-overlay), we don't want to select a
16375 new window start, since that would change the position under
16376 the mouse, resulting in an unwanted mouse-movement rather
16377 than a simple mouse-click. */
16378 if (!w->start_at_line_beg
16379 && NILP (do_mouse_tracking)
16380 && CHARPOS (startp) > BEGV
16381 && CHARPOS (startp) > BEG + beg_unchanged
16382 && CHARPOS (startp) <= Z - end_unchanged
16383 /* Even if w->start_at_line_beg is nil, a new window may
16384 start at a line_beg, since that's how set_buffer_window
16385 sets it. So, we need to check the return value of
16386 compute_window_start_on_continuation_line. (See also
16387 bug#197). */
16388 && XMARKER (w->start)->buffer == current_buffer
16389 && compute_window_start_on_continuation_line (w)
16390 /* It doesn't make sense to force the window start like we
16391 do at label force_start if it is already known that point
16392 will not be fully visible in the resulting window, because
16393 doing so will move point from its correct position
16394 instead of scrolling the window to bring point into view.
16395 See bug#9324. */
16396 && pos_visible_p (w, PT, &d1, &d2, &rtop, &rbot, &d5, &d6)
16397 /* A very tall row could need more than the window height,
16398 in which case we accept that it is partially visible. */
16399 && (rtop != 0) == (rbot != 0))
16400 {
16401 w->force_start = true;
16402 SET_TEXT_POS_FROM_MARKER (startp, w->start);
16403 #ifdef GLYPH_DEBUG
16404 debug_method_add (w, "recomputed window start in continuation line");
16405 #endif
16406 goto force_start;
16407 }
16408
16409 #ifdef GLYPH_DEBUG
16410 debug_method_add (w, "same window start");
16411 #endif
16412
16413 /* Try to redisplay starting at same place as before.
16414 If point has not moved off frame, accept the results. */
16415 if (!current_matrix_up_to_date_p
16416 /* Don't use try_window_reusing_current_matrix in this case
16417 because a window scroll function can have changed the
16418 buffer. */
16419 || !NILP (Vwindow_scroll_functions)
16420 || MINI_WINDOW_P (w)
16421 || !(used_current_matrix_p
16422 = try_window_reusing_current_matrix (w)))
16423 {
16424 IF_DEBUG (debug_method_add (w, "1"));
16425 if (try_window (window, startp, TRY_WINDOW_CHECK_MARGINS) < 0)
16426 /* -1 means we need to scroll.
16427 0 means we need new matrices, but fonts_changed
16428 is set in that case, so we will detect it below. */
16429 goto try_to_scroll;
16430 }
16431
16432 if (f->fonts_changed)
16433 goto need_larger_matrices;
16434
16435 if (w->cursor.vpos >= 0)
16436 {
16437 if (!just_this_one_p
16438 || current_buffer->clip_changed
16439 || BEG_UNCHANGED < CHARPOS (startp))
16440 /* Forget any recorded base line for line number display. */
16441 w->base_line_number = 0;
16442
16443 if (!cursor_row_fully_visible_p (w, true, false))
16444 {
16445 clear_glyph_matrix (w->desired_matrix);
16446 last_line_misfit = true;
16447 }
16448 /* Drop through and scroll. */
16449 else
16450 goto done;
16451 }
16452 else
16453 clear_glyph_matrix (w->desired_matrix);
16454 }
16455
16456 try_to_scroll:
16457
16458 /* Redisplay the mode line. Select the buffer properly for that. */
16459 if (!update_mode_line)
16460 {
16461 update_mode_line = true;
16462 w->update_mode_line = true;
16463 }
16464
16465 /* Try to scroll by specified few lines. */
16466 if ((scroll_conservatively
16467 || emacs_scroll_step
16468 || temp_scroll_step
16469 || NUMBERP (BVAR (current_buffer, scroll_up_aggressively))
16470 || NUMBERP (BVAR (current_buffer, scroll_down_aggressively)))
16471 && CHARPOS (startp) >= BEGV
16472 && CHARPOS (startp) <= ZV)
16473 {
16474 /* The function returns -1 if new fonts were loaded, 1 if
16475 successful, 0 if not successful. */
16476 int ss = try_scrolling (window, just_this_one_p,
16477 scroll_conservatively,
16478 emacs_scroll_step,
16479 temp_scroll_step, last_line_misfit);
16480 switch (ss)
16481 {
16482 case SCROLLING_SUCCESS:
16483 goto done;
16484
16485 case SCROLLING_NEED_LARGER_MATRICES:
16486 goto need_larger_matrices;
16487
16488 case SCROLLING_FAILED:
16489 break;
16490
16491 default:
16492 emacs_abort ();
16493 }
16494 }
16495
16496 /* Finally, just choose a place to start which positions point
16497 according to user preferences. */
16498
16499 recenter:
16500
16501 #ifdef GLYPH_DEBUG
16502 debug_method_add (w, "recenter");
16503 #endif
16504
16505 /* Forget any previously recorded base line for line number display. */
16506 if (!buffer_unchanged_p)
16507 w->base_line_number = 0;
16508
16509 /* Determine the window start relative to point. */
16510 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
16511 it.current_y = it.last_visible_y;
16512 if (centering_position < 0)
16513 {
16514 int window_total_lines
16515 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
16516 int margin
16517 = scroll_margin > 0
16518 ? min (scroll_margin, window_total_lines / 4)
16519 : 0;
16520 ptrdiff_t margin_pos = CHARPOS (startp);
16521 Lisp_Object aggressive;
16522 bool scrolling_up;
16523
16524 /* If there is a scroll margin at the top of the window, find
16525 its character position. */
16526 if (margin
16527 /* Cannot call start_display if startp is not in the
16528 accessible region of the buffer. This can happen when we
16529 have just switched to a different buffer and/or changed
16530 its restriction. In that case, startp is initialized to
16531 the character position 1 (BEGV) because we did not yet
16532 have chance to display the buffer even once. */
16533 && BEGV <= CHARPOS (startp) && CHARPOS (startp) <= ZV)
16534 {
16535 struct it it1;
16536 void *it1data = NULL;
16537
16538 SAVE_IT (it1, it, it1data);
16539 start_display (&it1, w, startp);
16540 move_it_vertically (&it1, margin * frame_line_height);
16541 margin_pos = IT_CHARPOS (it1);
16542 RESTORE_IT (&it, &it, it1data);
16543 }
16544 scrolling_up = PT > margin_pos;
16545 aggressive =
16546 scrolling_up
16547 ? BVAR (current_buffer, scroll_up_aggressively)
16548 : BVAR (current_buffer, scroll_down_aggressively);
16549
16550 if (!MINI_WINDOW_P (w)
16551 && (scroll_conservatively > SCROLL_LIMIT || NUMBERP (aggressive)))
16552 {
16553 int pt_offset = 0;
16554
16555 /* Setting scroll-conservatively overrides
16556 scroll-*-aggressively. */
16557 if (!scroll_conservatively && NUMBERP (aggressive))
16558 {
16559 double float_amount = XFLOATINT (aggressive);
16560
16561 pt_offset = float_amount * WINDOW_BOX_TEXT_HEIGHT (w);
16562 if (pt_offset == 0 && float_amount > 0)
16563 pt_offset = 1;
16564 if (pt_offset && margin > 0)
16565 margin -= 1;
16566 }
16567 /* Compute how much to move the window start backward from
16568 point so that point will be displayed where the user
16569 wants it. */
16570 if (scrolling_up)
16571 {
16572 centering_position = it.last_visible_y;
16573 if (pt_offset)
16574 centering_position -= pt_offset;
16575 centering_position -=
16576 (frame_line_height * (1 + margin + last_line_misfit)
16577 + WINDOW_HEADER_LINE_HEIGHT (w));
16578 /* Don't let point enter the scroll margin near top of
16579 the window. */
16580 if (centering_position < margin * frame_line_height)
16581 centering_position = margin * frame_line_height;
16582 }
16583 else
16584 centering_position = margin * frame_line_height + pt_offset;
16585 }
16586 else
16587 /* Set the window start half the height of the window backward
16588 from point. */
16589 centering_position = window_box_height (w) / 2;
16590 }
16591 move_it_vertically_backward (&it, centering_position);
16592
16593 eassert (IT_CHARPOS (it) >= BEGV);
16594
16595 /* The function move_it_vertically_backward may move over more
16596 than the specified y-distance. If it->w is small, e.g. a
16597 mini-buffer window, we may end up in front of the window's
16598 display area. Start displaying at the start of the line
16599 containing PT in this case. */
16600 if (it.current_y <= 0)
16601 {
16602 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
16603 move_it_vertically_backward (&it, 0);
16604 it.current_y = 0;
16605 }
16606
16607 it.current_x = it.hpos = 0;
16608
16609 /* Set the window start position here explicitly, to avoid an
16610 infinite loop in case the functions in window-scroll-functions
16611 get errors. */
16612 set_marker_both (w->start, Qnil, IT_CHARPOS (it), IT_BYTEPOS (it));
16613
16614 /* Run scroll hooks. */
16615 startp = run_window_scroll_functions (window, it.current.pos);
16616
16617 /* Redisplay the window. */
16618 if (!current_matrix_up_to_date_p
16619 || windows_or_buffers_changed
16620 || f->cursor_type_changed
16621 /* Don't use try_window_reusing_current_matrix in this case
16622 because it can have changed the buffer. */
16623 || !NILP (Vwindow_scroll_functions)
16624 || !just_this_one_p
16625 || MINI_WINDOW_P (w)
16626 || !(used_current_matrix_p
16627 = try_window_reusing_current_matrix (w)))
16628 try_window (window, startp, 0);
16629
16630 /* If new fonts have been loaded (due to fontsets), give up. We
16631 have to start a new redisplay since we need to re-adjust glyph
16632 matrices. */
16633 if (f->fonts_changed)
16634 goto need_larger_matrices;
16635
16636 /* If cursor did not appear assume that the middle of the window is
16637 in the first line of the window. Do it again with the next line.
16638 (Imagine a window of height 100, displaying two lines of height
16639 60. Moving back 50 from it->last_visible_y will end in the first
16640 line.) */
16641 if (w->cursor.vpos < 0)
16642 {
16643 if (w->window_end_valid && PT >= Z - w->window_end_pos)
16644 {
16645 clear_glyph_matrix (w->desired_matrix);
16646 move_it_by_lines (&it, 1);
16647 try_window (window, it.current.pos, 0);
16648 }
16649 else if (PT < IT_CHARPOS (it))
16650 {
16651 clear_glyph_matrix (w->desired_matrix);
16652 move_it_by_lines (&it, -1);
16653 try_window (window, it.current.pos, 0);
16654 }
16655 else
16656 {
16657 /* Not much we can do about it. */
16658 }
16659 }
16660
16661 /* Consider the following case: Window starts at BEGV, there is
16662 invisible, intangible text at BEGV, so that display starts at
16663 some point START > BEGV. It can happen that we are called with
16664 PT somewhere between BEGV and START. Try to handle that case,
16665 and similar ones. */
16666 if (w->cursor.vpos < 0)
16667 {
16668 /* First, try locating the proper glyph row for PT. */
16669 struct glyph_row *row =
16670 row_containing_pos (w, PT, w->current_matrix->rows, NULL, 0);
16671
16672 /* Sometimes point is at the beginning of invisible text that is
16673 before the 1st character displayed in the row. In that case,
16674 row_containing_pos fails to find the row, because no glyphs
16675 with appropriate buffer positions are present in the row.
16676 Therefore, we next try to find the row which shows the 1st
16677 position after the invisible text. */
16678 if (!row)
16679 {
16680 Lisp_Object val =
16681 get_char_property_and_overlay (make_number (PT), Qinvisible,
16682 Qnil, NULL);
16683
16684 if (TEXT_PROP_MEANS_INVISIBLE (val) != 0)
16685 {
16686 ptrdiff_t alt_pos;
16687 Lisp_Object invis_end =
16688 Fnext_single_char_property_change (make_number (PT), Qinvisible,
16689 Qnil, Qnil);
16690
16691 if (NATNUMP (invis_end))
16692 alt_pos = XFASTINT (invis_end);
16693 else
16694 alt_pos = ZV;
16695 row = row_containing_pos (w, alt_pos, w->current_matrix->rows,
16696 NULL, 0);
16697 }
16698 }
16699 /* Finally, fall back on the first row of the window after the
16700 header line (if any). This is slightly better than not
16701 displaying the cursor at all. */
16702 if (!row)
16703 {
16704 row = w->current_matrix->rows;
16705 if (row->mode_line_p)
16706 ++row;
16707 }
16708 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
16709 }
16710
16711 if (!cursor_row_fully_visible_p (w, false, false))
16712 {
16713 /* If vscroll is enabled, disable it and try again. */
16714 if (w->vscroll)
16715 {
16716 w->vscroll = 0;
16717 clear_glyph_matrix (w->desired_matrix);
16718 goto recenter;
16719 }
16720
16721 /* Users who set scroll-conservatively to a large number want
16722 point just above/below the scroll margin. If we ended up
16723 with point's row partially visible, move the window start to
16724 make that row fully visible and out of the margin. */
16725 if (scroll_conservatively > SCROLL_LIMIT)
16726 {
16727 int window_total_lines
16728 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) * frame_line_height;
16729 int margin =
16730 scroll_margin > 0
16731 ? min (scroll_margin, window_total_lines / 4)
16732 : 0;
16733 bool move_down = w->cursor.vpos >= window_total_lines / 2;
16734
16735 move_it_by_lines (&it, move_down ? margin + 1 : -(margin + 1));
16736 clear_glyph_matrix (w->desired_matrix);
16737 if (1 == try_window (window, it.current.pos,
16738 TRY_WINDOW_CHECK_MARGINS))
16739 goto done;
16740 }
16741
16742 /* If centering point failed to make the whole line visible,
16743 put point at the top instead. That has to make the whole line
16744 visible, if it can be done. */
16745 if (centering_position == 0)
16746 goto done;
16747
16748 clear_glyph_matrix (w->desired_matrix);
16749 centering_position = 0;
16750 goto recenter;
16751 }
16752
16753 done:
16754
16755 SET_TEXT_POS_FROM_MARKER (startp, w->start);
16756 w->start_at_line_beg = (CHARPOS (startp) == BEGV
16757 || FETCH_BYTE (BYTEPOS (startp) - 1) == '\n');
16758
16759 /* Display the mode line, if we must. */
16760 if ((update_mode_line
16761 /* If window not full width, must redo its mode line
16762 if (a) the window to its side is being redone and
16763 (b) we do a frame-based redisplay. This is a consequence
16764 of how inverted lines are drawn in frame-based redisplay. */
16765 || (!just_this_one_p
16766 && !FRAME_WINDOW_P (f)
16767 && !WINDOW_FULL_WIDTH_P (w))
16768 /* Line number to display. */
16769 || w->base_line_pos > 0
16770 /* Column number is displayed and different from the one displayed. */
16771 || (w->column_number_displayed != -1
16772 && (w->column_number_displayed != current_column ())))
16773 /* This means that the window has a mode line. */
16774 && (WINDOW_WANTS_MODELINE_P (w)
16775 || WINDOW_WANTS_HEADER_LINE_P (w)))
16776 {
16777
16778 display_mode_lines (w);
16779
16780 /* If mode line height has changed, arrange for a thorough
16781 immediate redisplay using the correct mode line height. */
16782 if (WINDOW_WANTS_MODELINE_P (w)
16783 && CURRENT_MODE_LINE_HEIGHT (w) != DESIRED_MODE_LINE_HEIGHT (w))
16784 {
16785 f->fonts_changed = true;
16786 w->mode_line_height = -1;
16787 MATRIX_MODE_LINE_ROW (w->current_matrix)->height
16788 = DESIRED_MODE_LINE_HEIGHT (w);
16789 }
16790
16791 /* If header line height has changed, arrange for a thorough
16792 immediate redisplay using the correct header line height. */
16793 if (WINDOW_WANTS_HEADER_LINE_P (w)
16794 && CURRENT_HEADER_LINE_HEIGHT (w) != DESIRED_HEADER_LINE_HEIGHT (w))
16795 {
16796 f->fonts_changed = true;
16797 w->header_line_height = -1;
16798 MATRIX_HEADER_LINE_ROW (w->current_matrix)->height
16799 = DESIRED_HEADER_LINE_HEIGHT (w);
16800 }
16801
16802 if (f->fonts_changed)
16803 goto need_larger_matrices;
16804 }
16805
16806 if (!line_number_displayed && w->base_line_pos != -1)
16807 {
16808 w->base_line_pos = 0;
16809 w->base_line_number = 0;
16810 }
16811
16812 finish_menu_bars:
16813
16814 /* When we reach a frame's selected window, redo the frame's menu bar. */
16815 if (update_mode_line
16816 && EQ (FRAME_SELECTED_WINDOW (f), window))
16817 {
16818 bool redisplay_menu_p;
16819
16820 if (FRAME_WINDOW_P (f))
16821 {
16822 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16823 || defined (HAVE_NS) || defined (USE_GTK)
16824 redisplay_menu_p = FRAME_EXTERNAL_MENU_BAR (f);
16825 #else
16826 redisplay_menu_p = FRAME_MENU_BAR_LINES (f) > 0;
16827 #endif
16828 }
16829 else
16830 redisplay_menu_p = FRAME_MENU_BAR_LINES (f) > 0;
16831
16832 if (redisplay_menu_p)
16833 display_menu_bar (w);
16834
16835 #ifdef HAVE_WINDOW_SYSTEM
16836 if (FRAME_WINDOW_P (f))
16837 {
16838 #if defined (USE_GTK) || defined (HAVE_NS)
16839 if (FRAME_EXTERNAL_TOOL_BAR (f))
16840 redisplay_tool_bar (f);
16841 #else
16842 if (WINDOWP (f->tool_bar_window)
16843 && (FRAME_TOOL_BAR_LINES (f) > 0
16844 || !NILP (Vauto_resize_tool_bars))
16845 && redisplay_tool_bar (f))
16846 ignore_mouse_drag_p = true;
16847 #endif
16848 }
16849 #endif
16850 }
16851
16852 #ifdef HAVE_WINDOW_SYSTEM
16853 if (FRAME_WINDOW_P (f)
16854 && update_window_fringes (w, (just_this_one_p
16855 || (!used_current_matrix_p && !overlay_arrow_seen)
16856 || w->pseudo_window_p)))
16857 {
16858 update_begin (f);
16859 block_input ();
16860 if (draw_window_fringes (w, true))
16861 {
16862 if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
16863 x_draw_right_divider (w);
16864 else
16865 x_draw_vertical_border (w);
16866 }
16867 unblock_input ();
16868 update_end (f);
16869 }
16870
16871 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w))
16872 x_draw_bottom_divider (w);
16873 #endif /* HAVE_WINDOW_SYSTEM */
16874
16875 /* We go to this label, with fonts_changed set, if it is
16876 necessary to try again using larger glyph matrices.
16877 We have to redeem the scroll bar even in this case,
16878 because the loop in redisplay_internal expects that. */
16879 need_larger_matrices:
16880 ;
16881 finish_scroll_bars:
16882
16883 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w))
16884 {
16885 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
16886 /* Set the thumb's position and size. */
16887 set_vertical_scroll_bar (w);
16888
16889 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w))
16890 /* Set the thumb's position and size. */
16891 set_horizontal_scroll_bar (w);
16892
16893 /* Note that we actually used the scroll bar attached to this
16894 window, so it shouldn't be deleted at the end of redisplay. */
16895 if (FRAME_TERMINAL (f)->redeem_scroll_bar_hook)
16896 (*FRAME_TERMINAL (f)->redeem_scroll_bar_hook) (w);
16897 }
16898
16899 /* Restore current_buffer and value of point in it. The window
16900 update may have changed the buffer, so first make sure `opoint'
16901 is still valid (Bug#6177). */
16902 if (CHARPOS (opoint) < BEGV)
16903 TEMP_SET_PT_BOTH (BEGV, BEGV_BYTE);
16904 else if (CHARPOS (opoint) > ZV)
16905 TEMP_SET_PT_BOTH (Z, Z_BYTE);
16906 else
16907 TEMP_SET_PT_BOTH (CHARPOS (opoint), BYTEPOS (opoint));
16908
16909 set_buffer_internal_1 (old);
16910 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16911 shorter. This can be caused by log truncation in *Messages*. */
16912 if (CHARPOS (lpoint) <= ZV)
16913 TEMP_SET_PT_BOTH (CHARPOS (lpoint), BYTEPOS (lpoint));
16914
16915 unbind_to (count, Qnil);
16916 }
16917
16918
16919 /* Build the complete desired matrix of WINDOW with a window start
16920 buffer position POS.
16921
16922 Value is 1 if successful. It is zero if fonts were loaded during
16923 redisplay which makes re-adjusting glyph matrices necessary, and -1
16924 if point would appear in the scroll margins.
16925 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16926 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16927 set in FLAGS.) */
16928
16929 int
16930 try_window (Lisp_Object window, struct text_pos pos, int flags)
16931 {
16932 struct window *w = XWINDOW (window);
16933 struct it it;
16934 struct glyph_row *last_text_row = NULL;
16935 struct frame *f = XFRAME (w->frame);
16936 int frame_line_height = default_line_pixel_height (w);
16937
16938 /* Make POS the new window start. */
16939 set_marker_both (w->start, Qnil, CHARPOS (pos), BYTEPOS (pos));
16940
16941 /* Mark cursor position as unknown. No overlay arrow seen. */
16942 w->cursor.vpos = -1;
16943 overlay_arrow_seen = false;
16944
16945 /* Initialize iterator and info to start at POS. */
16946 start_display (&it, w, pos);
16947 it.glyph_row->reversed_p = false;
16948
16949 /* Display all lines of W. */
16950 while (it.current_y < it.last_visible_y)
16951 {
16952 if (display_line (&it))
16953 last_text_row = it.glyph_row - 1;
16954 if (f->fonts_changed && !(flags & TRY_WINDOW_IGNORE_FONTS_CHANGE))
16955 return 0;
16956 }
16957
16958 /* Don't let the cursor end in the scroll margins. */
16959 if ((flags & TRY_WINDOW_CHECK_MARGINS)
16960 && !MINI_WINDOW_P (w))
16961 {
16962 int this_scroll_margin;
16963 int window_total_lines
16964 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
16965
16966 if (scroll_margin > 0)
16967 {
16968 this_scroll_margin = min (scroll_margin, window_total_lines / 4);
16969 this_scroll_margin *= frame_line_height;
16970 }
16971 else
16972 this_scroll_margin = 0;
16973
16974 if ((w->cursor.y >= 0 /* not vscrolled */
16975 && w->cursor.y < this_scroll_margin
16976 && CHARPOS (pos) > BEGV
16977 && IT_CHARPOS (it) < ZV)
16978 /* rms: considering make_cursor_line_fully_visible_p here
16979 seems to give wrong results. We don't want to recenter
16980 when the last line is partly visible, we want to allow
16981 that case to be handled in the usual way. */
16982 || w->cursor.y > it.last_visible_y - this_scroll_margin - 1)
16983 {
16984 w->cursor.vpos = -1;
16985 clear_glyph_matrix (w->desired_matrix);
16986 return -1;
16987 }
16988 }
16989
16990 /* If bottom moved off end of frame, change mode line percentage. */
16991 if (w->window_end_pos <= 0 && Z != IT_CHARPOS (it))
16992 w->update_mode_line = true;
16993
16994 /* Set window_end_pos to the offset of the last character displayed
16995 on the window from the end of current_buffer. Set
16996 window_end_vpos to its row number. */
16997 if (last_text_row)
16998 {
16999 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row));
17000 adjust_window_ends (w, last_text_row, false);
17001 eassert
17002 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w->desired_matrix,
17003 w->window_end_vpos)));
17004 }
17005 else
17006 {
17007 w->window_end_bytepos = Z_BYTE - ZV_BYTE;
17008 w->window_end_pos = Z - ZV;
17009 w->window_end_vpos = 0;
17010 }
17011
17012 /* But that is not valid info until redisplay finishes. */
17013 w->window_end_valid = false;
17014 return 1;
17015 }
17016
17017
17018 \f
17019 /************************************************************************
17020 Window redisplay reusing current matrix when buffer has not changed
17021 ************************************************************************/
17022
17023 /* Try redisplay of window W showing an unchanged buffer with a
17024 different window start than the last time it was displayed by
17025 reusing its current matrix. Value is true if successful.
17026 W->start is the new window start. */
17027
17028 static bool
17029 try_window_reusing_current_matrix (struct window *w)
17030 {
17031 struct frame *f = XFRAME (w->frame);
17032 struct glyph_row *bottom_row;
17033 struct it it;
17034 struct run run;
17035 struct text_pos start, new_start;
17036 int nrows_scrolled, i;
17037 struct glyph_row *last_text_row;
17038 struct glyph_row *last_reused_text_row;
17039 struct glyph_row *start_row;
17040 int start_vpos, min_y, max_y;
17041
17042 #ifdef GLYPH_DEBUG
17043 if (inhibit_try_window_reusing)
17044 return false;
17045 #endif
17046
17047 if (/* This function doesn't handle terminal frames. */
17048 !FRAME_WINDOW_P (f)
17049 /* Don't try to reuse the display if windows have been split
17050 or such. */
17051 || windows_or_buffers_changed
17052 || f->redisplay
17053 || f->cursor_type_changed)
17054 return false;
17055
17056 /* Can't do this if showing trailing whitespace. */
17057 if (!NILP (Vshow_trailing_whitespace))
17058 return false;
17059
17060 /* If top-line visibility has changed, give up. */
17061 if (WINDOW_WANTS_HEADER_LINE_P (w)
17062 != MATRIX_HEADER_LINE_ROW (w->current_matrix)->mode_line_p)
17063 return false;
17064
17065 /* Give up if old or new display is scrolled vertically. We could
17066 make this function handle this, but right now it doesn't. */
17067 start_row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
17068 if (w->vscroll || MATRIX_ROW_PARTIALLY_VISIBLE_P (w, start_row))
17069 return false;
17070
17071 /* The variable new_start now holds the new window start. The old
17072 start `start' can be determined from the current matrix. */
17073 SET_TEXT_POS_FROM_MARKER (new_start, w->start);
17074 start = start_row->minpos;
17075 start_vpos = MATRIX_ROW_VPOS (start_row, w->current_matrix);
17076
17077 /* Clear the desired matrix for the display below. */
17078 clear_glyph_matrix (w->desired_matrix);
17079
17080 if (CHARPOS (new_start) <= CHARPOS (start))
17081 {
17082 /* Don't use this method if the display starts with an ellipsis
17083 displayed for invisible text. It's not easy to handle that case
17084 below, and it's certainly not worth the effort since this is
17085 not a frequent case. */
17086 if (in_ellipses_for_invisible_text_p (&start_row->start, w))
17087 return false;
17088
17089 IF_DEBUG (debug_method_add (w, "twu1"));
17090
17091 /* Display up to a row that can be reused. The variable
17092 last_text_row is set to the last row displayed that displays
17093 text. Note that it.vpos == 0 if or if not there is a
17094 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17095 start_display (&it, w, new_start);
17096 w->cursor.vpos = -1;
17097 last_text_row = last_reused_text_row = NULL;
17098
17099 while (it.current_y < it.last_visible_y && !f->fonts_changed)
17100 {
17101 /* If we have reached into the characters in the START row,
17102 that means the line boundaries have changed. So we
17103 can't start copying with the row START. Maybe it will
17104 work to start copying with the following row. */
17105 while (IT_CHARPOS (it) > CHARPOS (start))
17106 {
17107 /* Advance to the next row as the "start". */
17108 start_row++;
17109 start = start_row->minpos;
17110 /* If there are no more rows to try, or just one, give up. */
17111 if (start_row == MATRIX_MODE_LINE_ROW (w->current_matrix) - 1
17112 || w->vscroll || MATRIX_ROW_PARTIALLY_VISIBLE_P (w, start_row)
17113 || CHARPOS (start) == ZV)
17114 {
17115 clear_glyph_matrix (w->desired_matrix);
17116 return false;
17117 }
17118
17119 start_vpos = MATRIX_ROW_VPOS (start_row, w->current_matrix);
17120 }
17121 /* If we have reached alignment, we can copy the rest of the
17122 rows. */
17123 if (IT_CHARPOS (it) == CHARPOS (start)
17124 /* Don't accept "alignment" inside a display vector,
17125 since start_row could have started in the middle of
17126 that same display vector (thus their character
17127 positions match), and we have no way of telling if
17128 that is the case. */
17129 && it.current.dpvec_index < 0)
17130 break;
17131
17132 it.glyph_row->reversed_p = false;
17133 if (display_line (&it))
17134 last_text_row = it.glyph_row - 1;
17135
17136 }
17137
17138 /* A value of current_y < last_visible_y means that we stopped
17139 at the previous window start, which in turn means that we
17140 have at least one reusable row. */
17141 if (it.current_y < it.last_visible_y)
17142 {
17143 struct glyph_row *row;
17144
17145 /* IT.vpos always starts from 0; it counts text lines. */
17146 nrows_scrolled = it.vpos - (start_row - MATRIX_FIRST_TEXT_ROW (w->current_matrix));
17147
17148 /* Find PT if not already found in the lines displayed. */
17149 if (w->cursor.vpos < 0)
17150 {
17151 int dy = it.current_y - start_row->y;
17152
17153 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
17154 row = row_containing_pos (w, PT, row, NULL, dy);
17155 if (row)
17156 set_cursor_from_row (w, row, w->current_matrix, 0, 0,
17157 dy, nrows_scrolled);
17158 else
17159 {
17160 clear_glyph_matrix (w->desired_matrix);
17161 return false;
17162 }
17163 }
17164
17165 /* Scroll the display. Do it before the current matrix is
17166 changed. The problem here is that update has not yet
17167 run, i.e. part of the current matrix is not up to date.
17168 scroll_run_hook will clear the cursor, and use the
17169 current matrix to get the height of the row the cursor is
17170 in. */
17171 run.current_y = start_row->y;
17172 run.desired_y = it.current_y;
17173 run.height = it.last_visible_y - it.current_y;
17174
17175 if (run.height > 0 && run.current_y != run.desired_y)
17176 {
17177 update_begin (f);
17178 FRAME_RIF (f)->update_window_begin_hook (w);
17179 FRAME_RIF (f)->clear_window_mouse_face (w);
17180 FRAME_RIF (f)->scroll_run_hook (w, &run);
17181 FRAME_RIF (f)->update_window_end_hook (w, false, false);
17182 update_end (f);
17183 }
17184
17185 /* Shift current matrix down by nrows_scrolled lines. */
17186 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
17187 rotate_matrix (w->current_matrix,
17188 start_vpos,
17189 MATRIX_ROW_VPOS (bottom_row, w->current_matrix),
17190 nrows_scrolled);
17191
17192 /* Disable lines that must be updated. */
17193 for (i = 0; i < nrows_scrolled; ++i)
17194 (start_row + i)->enabled_p = false;
17195
17196 /* Re-compute Y positions. */
17197 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
17198 max_y = it.last_visible_y;
17199 for (row = start_row + nrows_scrolled;
17200 row < bottom_row;
17201 ++row)
17202 {
17203 row->y = it.current_y;
17204 row->visible_height = row->height;
17205
17206 if (row->y < min_y)
17207 row->visible_height -= min_y - row->y;
17208 if (row->y + row->height > max_y)
17209 row->visible_height -= row->y + row->height - max_y;
17210 if (row->fringe_bitmap_periodic_p)
17211 row->redraw_fringe_bitmaps_p = true;
17212
17213 it.current_y += row->height;
17214
17215 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
17216 last_reused_text_row = row;
17217 if (MATRIX_ROW_BOTTOM_Y (row) >= it.last_visible_y)
17218 break;
17219 }
17220
17221 /* Disable lines in the current matrix which are now
17222 below the window. */
17223 for (++row; row < bottom_row; ++row)
17224 row->enabled_p = row->mode_line_p = false;
17225 }
17226
17227 /* Update window_end_pos etc.; last_reused_text_row is the last
17228 reused row from the current matrix containing text, if any.
17229 The value of last_text_row is the last displayed line
17230 containing text. */
17231 if (last_reused_text_row)
17232 adjust_window_ends (w, last_reused_text_row, true);
17233 else if (last_text_row)
17234 adjust_window_ends (w, last_text_row, false);
17235 else
17236 {
17237 /* This window must be completely empty. */
17238 w->window_end_bytepos = Z_BYTE - ZV_BYTE;
17239 w->window_end_pos = Z - ZV;
17240 w->window_end_vpos = 0;
17241 }
17242 w->window_end_valid = false;
17243
17244 /* Update hint: don't try scrolling again in update_window. */
17245 w->desired_matrix->no_scrolling_p = true;
17246
17247 #ifdef GLYPH_DEBUG
17248 debug_method_add (w, "try_window_reusing_current_matrix 1");
17249 #endif
17250 return true;
17251 }
17252 else if (CHARPOS (new_start) > CHARPOS (start))
17253 {
17254 struct glyph_row *pt_row, *row;
17255 struct glyph_row *first_reusable_row;
17256 struct glyph_row *first_row_to_display;
17257 int dy;
17258 int yb = window_text_bottom_y (w);
17259
17260 /* Find the row starting at new_start, if there is one. Don't
17261 reuse a partially visible line at the end. */
17262 first_reusable_row = start_row;
17263 while (first_reusable_row->enabled_p
17264 && MATRIX_ROW_BOTTOM_Y (first_reusable_row) < yb
17265 && (MATRIX_ROW_START_CHARPOS (first_reusable_row)
17266 < CHARPOS (new_start)))
17267 ++first_reusable_row;
17268
17269 /* Give up if there is no row to reuse. */
17270 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row) >= yb
17271 || !first_reusable_row->enabled_p
17272 || (MATRIX_ROW_START_CHARPOS (first_reusable_row)
17273 != CHARPOS (new_start)))
17274 return false;
17275
17276 /* We can reuse fully visible rows beginning with
17277 first_reusable_row to the end of the window. Set
17278 first_row_to_display to the first row that cannot be reused.
17279 Set pt_row to the row containing point, if there is any. */
17280 pt_row = NULL;
17281 for (first_row_to_display = first_reusable_row;
17282 MATRIX_ROW_BOTTOM_Y (first_row_to_display) < yb;
17283 ++first_row_to_display)
17284 {
17285 if (PT >= MATRIX_ROW_START_CHARPOS (first_row_to_display)
17286 && (PT < MATRIX_ROW_END_CHARPOS (first_row_to_display)
17287 || (PT == MATRIX_ROW_END_CHARPOS (first_row_to_display)
17288 && first_row_to_display->ends_at_zv_p
17289 && pt_row == NULL)))
17290 pt_row = first_row_to_display;
17291 }
17292
17293 /* Start displaying at the start of first_row_to_display. */
17294 eassert (first_row_to_display->y < yb);
17295 init_to_row_start (&it, w, first_row_to_display);
17296
17297 nrows_scrolled = (MATRIX_ROW_VPOS (first_reusable_row, w->current_matrix)
17298 - start_vpos);
17299 it.vpos = (MATRIX_ROW_VPOS (first_row_to_display, w->current_matrix)
17300 - nrows_scrolled);
17301 it.current_y = (first_row_to_display->y - first_reusable_row->y
17302 + WINDOW_HEADER_LINE_HEIGHT (w));
17303
17304 /* Display lines beginning with first_row_to_display in the
17305 desired matrix. Set last_text_row to the last row displayed
17306 that displays text. */
17307 it.glyph_row = MATRIX_ROW (w->desired_matrix, it.vpos);
17308 if (pt_row == NULL)
17309 w->cursor.vpos = -1;
17310 last_text_row = NULL;
17311 while (it.current_y < it.last_visible_y && !f->fonts_changed)
17312 if (display_line (&it))
17313 last_text_row = it.glyph_row - 1;
17314
17315 /* If point is in a reused row, adjust y and vpos of the cursor
17316 position. */
17317 if (pt_row)
17318 {
17319 w->cursor.vpos -= nrows_scrolled;
17320 w->cursor.y -= first_reusable_row->y - start_row->y;
17321 }
17322
17323 /* Give up if point isn't in a row displayed or reused. (This
17324 also handles the case where w->cursor.vpos < nrows_scrolled
17325 after the calls to display_line, which can happen with scroll
17326 margins. See bug#1295.) */
17327 if (w->cursor.vpos < 0)
17328 {
17329 clear_glyph_matrix (w->desired_matrix);
17330 return false;
17331 }
17332
17333 /* Scroll the display. */
17334 run.current_y = first_reusable_row->y;
17335 run.desired_y = WINDOW_HEADER_LINE_HEIGHT (w);
17336 run.height = it.last_visible_y - run.current_y;
17337 dy = run.current_y - run.desired_y;
17338
17339 if (run.height)
17340 {
17341 update_begin (f);
17342 FRAME_RIF (f)->update_window_begin_hook (w);
17343 FRAME_RIF (f)->clear_window_mouse_face (w);
17344 FRAME_RIF (f)->scroll_run_hook (w, &run);
17345 FRAME_RIF (f)->update_window_end_hook (w, false, false);
17346 update_end (f);
17347 }
17348
17349 /* Adjust Y positions of reused rows. */
17350 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
17351 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
17352 max_y = it.last_visible_y;
17353 for (row = first_reusable_row; row < first_row_to_display; ++row)
17354 {
17355 row->y -= dy;
17356 row->visible_height = row->height;
17357 if (row->y < min_y)
17358 row->visible_height -= min_y - row->y;
17359 if (row->y + row->height > max_y)
17360 row->visible_height -= row->y + row->height - max_y;
17361 if (row->fringe_bitmap_periodic_p)
17362 row->redraw_fringe_bitmaps_p = true;
17363 }
17364
17365 /* Scroll the current matrix. */
17366 eassert (nrows_scrolled > 0);
17367 rotate_matrix (w->current_matrix,
17368 start_vpos,
17369 MATRIX_ROW_VPOS (bottom_row, w->current_matrix),
17370 -nrows_scrolled);
17371
17372 /* Disable rows not reused. */
17373 for (row -= nrows_scrolled; row < bottom_row; ++row)
17374 row->enabled_p = false;
17375
17376 /* Point may have moved to a different line, so we cannot assume that
17377 the previous cursor position is valid; locate the correct row. */
17378 if (pt_row)
17379 {
17380 for (row = MATRIX_ROW (w->current_matrix, w->cursor.vpos);
17381 row < bottom_row
17382 && PT >= MATRIX_ROW_END_CHARPOS (row)
17383 && !row->ends_at_zv_p;
17384 row++)
17385 {
17386 w->cursor.vpos++;
17387 w->cursor.y = row->y;
17388 }
17389 if (row < bottom_row)
17390 {
17391 /* Can't simply scan the row for point with
17392 bidi-reordered glyph rows. Let set_cursor_from_row
17393 figure out where to put the cursor, and if it fails,
17394 give up. */
17395 if (!NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering)))
17396 {
17397 if (!set_cursor_from_row (w, row, w->current_matrix,
17398 0, 0, 0, 0))
17399 {
17400 clear_glyph_matrix (w->desired_matrix);
17401 return false;
17402 }
17403 }
17404 else
17405 {
17406 struct glyph *glyph = row->glyphs[TEXT_AREA] + w->cursor.hpos;
17407 struct glyph *end = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA];
17408
17409 for (; glyph < end
17410 && (!BUFFERP (glyph->object)
17411 || glyph->charpos < PT);
17412 glyph++)
17413 {
17414 w->cursor.hpos++;
17415 w->cursor.x += glyph->pixel_width;
17416 }
17417 }
17418 }
17419 }
17420
17421 /* Adjust window end. A null value of last_text_row means that
17422 the window end is in reused rows which in turn means that
17423 only its vpos can have changed. */
17424 if (last_text_row)
17425 adjust_window_ends (w, last_text_row, false);
17426 else
17427 w->window_end_vpos -= nrows_scrolled;
17428
17429 w->window_end_valid = false;
17430 w->desired_matrix->no_scrolling_p = true;
17431
17432 #ifdef GLYPH_DEBUG
17433 debug_method_add (w, "try_window_reusing_current_matrix 2");
17434 #endif
17435 return true;
17436 }
17437
17438 return false;
17439 }
17440
17441
17442 \f
17443 /************************************************************************
17444 Window redisplay reusing current matrix when buffer has changed
17445 ************************************************************************/
17446
17447 static struct glyph_row *find_last_unchanged_at_beg_row (struct window *);
17448 static struct glyph_row *find_first_unchanged_at_end_row (struct window *,
17449 ptrdiff_t *, ptrdiff_t *);
17450 static struct glyph_row *
17451 find_last_row_displaying_text (struct glyph_matrix *, struct it *,
17452 struct glyph_row *);
17453
17454
17455 /* Return the last row in MATRIX displaying text. If row START is
17456 non-null, start searching with that row. IT gives the dimensions
17457 of the display. Value is null if matrix is empty; otherwise it is
17458 a pointer to the row found. */
17459
17460 static struct glyph_row *
17461 find_last_row_displaying_text (struct glyph_matrix *matrix, struct it *it,
17462 struct glyph_row *start)
17463 {
17464 struct glyph_row *row, *row_found;
17465
17466 /* Set row_found to the last row in IT->w's current matrix
17467 displaying text. The loop looks funny but think of partially
17468 visible lines. */
17469 row_found = NULL;
17470 row = start ? start : MATRIX_FIRST_TEXT_ROW (matrix);
17471 while (MATRIX_ROW_DISPLAYS_TEXT_P (row))
17472 {
17473 eassert (row->enabled_p);
17474 row_found = row;
17475 if (MATRIX_ROW_BOTTOM_Y (row) >= it->last_visible_y)
17476 break;
17477 ++row;
17478 }
17479
17480 return row_found;
17481 }
17482
17483
17484 /* Return the last row in the current matrix of W that is not affected
17485 by changes at the start of current_buffer that occurred since W's
17486 current matrix was built. Value is null if no such row exists.
17487
17488 BEG_UNCHANGED us the number of characters unchanged at the start of
17489 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17490 first changed character in current_buffer. Characters at positions <
17491 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17492 when the current matrix was built. */
17493
17494 static struct glyph_row *
17495 find_last_unchanged_at_beg_row (struct window *w)
17496 {
17497 ptrdiff_t first_changed_pos = BEG + BEG_UNCHANGED;
17498 struct glyph_row *row;
17499 struct glyph_row *row_found = NULL;
17500 int yb = window_text_bottom_y (w);
17501
17502 /* Find the last row displaying unchanged text. */
17503 for (row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
17504 MATRIX_ROW_DISPLAYS_TEXT_P (row)
17505 && MATRIX_ROW_START_CHARPOS (row) < first_changed_pos;
17506 ++row)
17507 {
17508 if (/* If row ends before first_changed_pos, it is unchanged,
17509 except in some case. */
17510 MATRIX_ROW_END_CHARPOS (row) <= first_changed_pos
17511 /* When row ends in ZV and we write at ZV it is not
17512 unchanged. */
17513 && !row->ends_at_zv_p
17514 /* When first_changed_pos is the end of a continued line,
17515 row is not unchanged because it may be no longer
17516 continued. */
17517 && !(MATRIX_ROW_END_CHARPOS (row) == first_changed_pos
17518 && (row->continued_p
17519 || row->exact_window_width_line_p))
17520 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17521 needs to be recomputed, so don't consider this row as
17522 unchanged. This happens when the last line was
17523 bidi-reordered and was killed immediately before this
17524 redisplay cycle. In that case, ROW->end stores the
17525 buffer position of the first visual-order character of
17526 the killed text, which is now beyond ZV. */
17527 && CHARPOS (row->end.pos) <= ZV)
17528 row_found = row;
17529
17530 /* Stop if last visible row. */
17531 if (MATRIX_ROW_BOTTOM_Y (row) >= yb)
17532 break;
17533 }
17534
17535 return row_found;
17536 }
17537
17538
17539 /* Find the first glyph row in the current matrix of W that is not
17540 affected by changes at the end of current_buffer since the
17541 time W's current matrix was built.
17542
17543 Return in *DELTA the number of chars by which buffer positions in
17544 unchanged text at the end of current_buffer must be adjusted.
17545
17546 Return in *DELTA_BYTES the corresponding number of bytes.
17547
17548 Value is null if no such row exists, i.e. all rows are affected by
17549 changes. */
17550
17551 static struct glyph_row *
17552 find_first_unchanged_at_end_row (struct window *w,
17553 ptrdiff_t *delta, ptrdiff_t *delta_bytes)
17554 {
17555 struct glyph_row *row;
17556 struct glyph_row *row_found = NULL;
17557
17558 *delta = *delta_bytes = 0;
17559
17560 /* Display must not have been paused, otherwise the current matrix
17561 is not up to date. */
17562 eassert (w->window_end_valid);
17563
17564 /* A value of window_end_pos >= END_UNCHANGED means that the window
17565 end is in the range of changed text. If so, there is no
17566 unchanged row at the end of W's current matrix. */
17567 if (w->window_end_pos >= END_UNCHANGED)
17568 return NULL;
17569
17570 /* Set row to the last row in W's current matrix displaying text. */
17571 row = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
17572
17573 /* If matrix is entirely empty, no unchanged row exists. */
17574 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
17575 {
17576 /* The value of row is the last glyph row in the matrix having a
17577 meaningful buffer position in it. The end position of row
17578 corresponds to window_end_pos. This allows us to translate
17579 buffer positions in the current matrix to current buffer
17580 positions for characters not in changed text. */
17581 ptrdiff_t Z_old =
17582 MATRIX_ROW_END_CHARPOS (row) + w->window_end_pos;
17583 ptrdiff_t Z_BYTE_old =
17584 MATRIX_ROW_END_BYTEPOS (row) + w->window_end_bytepos;
17585 ptrdiff_t last_unchanged_pos, last_unchanged_pos_old;
17586 struct glyph_row *first_text_row
17587 = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
17588
17589 *delta = Z - Z_old;
17590 *delta_bytes = Z_BYTE - Z_BYTE_old;
17591
17592 /* Set last_unchanged_pos to the buffer position of the last
17593 character in the buffer that has not been changed. Z is the
17594 index + 1 of the last character in current_buffer, i.e. by
17595 subtracting END_UNCHANGED we get the index of the last
17596 unchanged character, and we have to add BEG to get its buffer
17597 position. */
17598 last_unchanged_pos = Z - END_UNCHANGED + BEG;
17599 last_unchanged_pos_old = last_unchanged_pos - *delta;
17600
17601 /* Search backward from ROW for a row displaying a line that
17602 starts at a minimum position >= last_unchanged_pos_old. */
17603 for (; row > first_text_row; --row)
17604 {
17605 /* This used to abort, but it can happen.
17606 It is ok to just stop the search instead here. KFS. */
17607 if (!row->enabled_p || !MATRIX_ROW_DISPLAYS_TEXT_P (row))
17608 break;
17609
17610 if (MATRIX_ROW_START_CHARPOS (row) >= last_unchanged_pos_old)
17611 row_found = row;
17612 }
17613 }
17614
17615 eassert (!row_found || MATRIX_ROW_DISPLAYS_TEXT_P (row_found));
17616
17617 return row_found;
17618 }
17619
17620
17621 /* Make sure that glyph rows in the current matrix of window W
17622 reference the same glyph memory as corresponding rows in the
17623 frame's frame matrix. This function is called after scrolling W's
17624 current matrix on a terminal frame in try_window_id and
17625 try_window_reusing_current_matrix. */
17626
17627 static void
17628 sync_frame_with_window_matrix_rows (struct window *w)
17629 {
17630 struct frame *f = XFRAME (w->frame);
17631 struct glyph_row *window_row, *window_row_end, *frame_row;
17632
17633 /* Preconditions: W must be a leaf window and full-width. Its frame
17634 must have a frame matrix. */
17635 eassert (BUFFERP (w->contents));
17636 eassert (WINDOW_FULL_WIDTH_P (w));
17637 eassert (!FRAME_WINDOW_P (f));
17638
17639 /* If W is a full-width window, glyph pointers in W's current matrix
17640 have, by definition, to be the same as glyph pointers in the
17641 corresponding frame matrix. Note that frame matrices have no
17642 marginal areas (see build_frame_matrix). */
17643 window_row = w->current_matrix->rows;
17644 window_row_end = window_row + w->current_matrix->nrows;
17645 frame_row = f->current_matrix->rows + WINDOW_TOP_EDGE_LINE (w);
17646 while (window_row < window_row_end)
17647 {
17648 struct glyph *start = window_row->glyphs[LEFT_MARGIN_AREA];
17649 struct glyph *end = window_row->glyphs[LAST_AREA];
17650
17651 frame_row->glyphs[LEFT_MARGIN_AREA] = start;
17652 frame_row->glyphs[TEXT_AREA] = start;
17653 frame_row->glyphs[RIGHT_MARGIN_AREA] = end;
17654 frame_row->glyphs[LAST_AREA] = end;
17655
17656 /* Disable frame rows whose corresponding window rows have
17657 been disabled in try_window_id. */
17658 if (!window_row->enabled_p)
17659 frame_row->enabled_p = false;
17660
17661 ++window_row, ++frame_row;
17662 }
17663 }
17664
17665
17666 /* Find the glyph row in window W containing CHARPOS. Consider all
17667 rows between START and END (not inclusive). END null means search
17668 all rows to the end of the display area of W. Value is the row
17669 containing CHARPOS or null. */
17670
17671 struct glyph_row *
17672 row_containing_pos (struct window *w, ptrdiff_t charpos,
17673 struct glyph_row *start, struct glyph_row *end, int dy)
17674 {
17675 struct glyph_row *row = start;
17676 struct glyph_row *best_row = NULL;
17677 ptrdiff_t mindif = BUF_ZV (XBUFFER (w->contents)) + 1;
17678 int last_y;
17679
17680 /* If we happen to start on a header-line, skip that. */
17681 if (row->mode_line_p)
17682 ++row;
17683
17684 if ((end && row >= end) || !row->enabled_p)
17685 return NULL;
17686
17687 last_y = window_text_bottom_y (w) - dy;
17688
17689 while (true)
17690 {
17691 /* Give up if we have gone too far. */
17692 if (end && row >= end)
17693 return NULL;
17694 /* This formerly returned if they were equal.
17695 I think that both quantities are of a "last plus one" type;
17696 if so, when they are equal, the row is within the screen. -- rms. */
17697 if (MATRIX_ROW_BOTTOM_Y (row) > last_y)
17698 return NULL;
17699
17700 /* If it is in this row, return this row. */
17701 if (! (MATRIX_ROW_END_CHARPOS (row) < charpos
17702 || (MATRIX_ROW_END_CHARPOS (row) == charpos
17703 /* The end position of a row equals the start
17704 position of the next row. If CHARPOS is there, we
17705 would rather consider it displayed in the next
17706 line, except when this line ends in ZV. */
17707 && !row_for_charpos_p (row, charpos)))
17708 && charpos >= MATRIX_ROW_START_CHARPOS (row))
17709 {
17710 struct glyph *g;
17711
17712 if (NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering))
17713 || (!best_row && !row->continued_p))
17714 return row;
17715 /* In bidi-reordered rows, there could be several rows whose
17716 edges surround CHARPOS, all of these rows belonging to
17717 the same continued line. We need to find the row which
17718 fits CHARPOS the best. */
17719 for (g = row->glyphs[TEXT_AREA];
17720 g < row->glyphs[TEXT_AREA] + row->used[TEXT_AREA];
17721 g++)
17722 {
17723 if (!STRINGP (g->object))
17724 {
17725 if (g->charpos > 0 && eabs (g->charpos - charpos) < mindif)
17726 {
17727 mindif = eabs (g->charpos - charpos);
17728 best_row = row;
17729 /* Exact match always wins. */
17730 if (mindif == 0)
17731 return best_row;
17732 }
17733 }
17734 }
17735 }
17736 else if (best_row && !row->continued_p)
17737 return best_row;
17738 ++row;
17739 }
17740 }
17741
17742
17743 /* Try to redisplay window W by reusing its existing display. W's
17744 current matrix must be up to date when this function is called,
17745 i.e., window_end_valid must be true.
17746
17747 Value is
17748
17749 >= 1 if successful, i.e. display has been updated
17750 specifically:
17751 1 means the changes were in front of a newline that precedes
17752 the window start, and the whole current matrix was reused
17753 2 means the changes were after the last position displayed
17754 in the window, and the whole current matrix was reused
17755 3 means portions of the current matrix were reused, while
17756 some of the screen lines were redrawn
17757 -1 if redisplay with same window start is known not to succeed
17758 0 if otherwise unsuccessful
17759
17760 The following steps are performed:
17761
17762 1. Find the last row in the current matrix of W that is not
17763 affected by changes at the start of current_buffer. If no such row
17764 is found, give up.
17765
17766 2. Find the first row in W's current matrix that is not affected by
17767 changes at the end of current_buffer. Maybe there is no such row.
17768
17769 3. Display lines beginning with the row + 1 found in step 1 to the
17770 row found in step 2 or, if step 2 didn't find a row, to the end of
17771 the window.
17772
17773 4. If cursor is not known to appear on the window, give up.
17774
17775 5. If display stopped at the row found in step 2, scroll the
17776 display and current matrix as needed.
17777
17778 6. Maybe display some lines at the end of W, if we must. This can
17779 happen under various circumstances, like a partially visible line
17780 becoming fully visible, or because newly displayed lines are displayed
17781 in smaller font sizes.
17782
17783 7. Update W's window end information. */
17784
17785 static int
17786 try_window_id (struct window *w)
17787 {
17788 struct frame *f = XFRAME (w->frame);
17789 struct glyph_matrix *current_matrix = w->current_matrix;
17790 struct glyph_matrix *desired_matrix = w->desired_matrix;
17791 struct glyph_row *last_unchanged_at_beg_row;
17792 struct glyph_row *first_unchanged_at_end_row;
17793 struct glyph_row *row;
17794 struct glyph_row *bottom_row;
17795 int bottom_vpos;
17796 struct it it;
17797 ptrdiff_t delta = 0, delta_bytes = 0, stop_pos;
17798 int dvpos, dy;
17799 struct text_pos start_pos;
17800 struct run run;
17801 int first_unchanged_at_end_vpos = 0;
17802 struct glyph_row *last_text_row, *last_text_row_at_end;
17803 struct text_pos start;
17804 ptrdiff_t first_changed_charpos, last_changed_charpos;
17805
17806 #ifdef GLYPH_DEBUG
17807 if (inhibit_try_window_id)
17808 return 0;
17809 #endif
17810
17811 /* This is handy for debugging. */
17812 #if false
17813 #define GIVE_UP(X) \
17814 do { \
17815 TRACE ((stderr, "try_window_id give up %d\n", (X))); \
17816 return 0; \
17817 } while (false)
17818 #else
17819 #define GIVE_UP(X) return 0
17820 #endif
17821
17822 SET_TEXT_POS_FROM_MARKER (start, w->start);
17823
17824 /* Don't use this for mini-windows because these can show
17825 messages and mini-buffers, and we don't handle that here. */
17826 if (MINI_WINDOW_P (w))
17827 GIVE_UP (1);
17828
17829 /* This flag is used to prevent redisplay optimizations. */
17830 if (windows_or_buffers_changed || f->cursor_type_changed || f->redisplay)
17831 GIVE_UP (2);
17832
17833 /* This function's optimizations cannot be used if overlays have
17834 changed in the buffer displayed by the window, so give up if they
17835 have. */
17836 if (w->last_overlay_modified != OVERLAY_MODIFF)
17837 GIVE_UP (200);
17838
17839 /* Verify that narrowing has not changed.
17840 Also verify that we were not told to prevent redisplay optimizations.
17841 It would be nice to further
17842 reduce the number of cases where this prevents try_window_id. */
17843 if (current_buffer->clip_changed
17844 || current_buffer->prevent_redisplay_optimizations_p)
17845 GIVE_UP (3);
17846
17847 /* Window must either use window-based redisplay or be full width. */
17848 if (!FRAME_WINDOW_P (f)
17849 && (!FRAME_LINE_INS_DEL_OK (f)
17850 || !WINDOW_FULL_WIDTH_P (w)))
17851 GIVE_UP (4);
17852
17853 /* Give up if point is known NOT to appear in W. */
17854 if (PT < CHARPOS (start))
17855 GIVE_UP (5);
17856
17857 /* Another way to prevent redisplay optimizations. */
17858 if (w->last_modified == 0)
17859 GIVE_UP (6);
17860
17861 /* Verify that window is not hscrolled. */
17862 if (w->hscroll != 0)
17863 GIVE_UP (7);
17864
17865 /* Verify that display wasn't paused. */
17866 if (!w->window_end_valid)
17867 GIVE_UP (8);
17868
17869 /* Likewise if highlighting trailing whitespace. */
17870 if (!NILP (Vshow_trailing_whitespace))
17871 GIVE_UP (11);
17872
17873 /* Can't use this if overlay arrow position and/or string have
17874 changed. */
17875 if (overlay_arrows_changed_p ())
17876 GIVE_UP (12);
17877
17878 /* When word-wrap is on, adding a space to the first word of a
17879 wrapped line can change the wrap position, altering the line
17880 above it. It might be worthwhile to handle this more
17881 intelligently, but for now just redisplay from scratch. */
17882 if (!NILP (BVAR (XBUFFER (w->contents), word_wrap)))
17883 GIVE_UP (21);
17884
17885 /* Under bidi reordering, adding or deleting a character in the
17886 beginning of a paragraph, before the first strong directional
17887 character, can change the base direction of the paragraph (unless
17888 the buffer specifies a fixed paragraph direction), which will
17889 require to redisplay the whole paragraph. It might be worthwhile
17890 to find the paragraph limits and widen the range of redisplayed
17891 lines to that, but for now just give up this optimization and
17892 redisplay from scratch. */
17893 if (!NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering))
17894 && NILP (BVAR (XBUFFER (w->contents), bidi_paragraph_direction)))
17895 GIVE_UP (22);
17896
17897 /* Give up if the buffer has line-spacing set, as Lisp-level changes
17898 to that variable require thorough redisplay. */
17899 if (!NILP (BVAR (XBUFFER (w->contents), extra_line_spacing)))
17900 GIVE_UP (23);
17901
17902 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17903 only if buffer has really changed. The reason is that the gap is
17904 initially at Z for freshly visited files. The code below would
17905 set end_unchanged to 0 in that case. */
17906 if (MODIFF > SAVE_MODIFF
17907 /* This seems to happen sometimes after saving a buffer. */
17908 || BEG_UNCHANGED + END_UNCHANGED > Z_BYTE)
17909 {
17910 if (GPT - BEG < BEG_UNCHANGED)
17911 BEG_UNCHANGED = GPT - BEG;
17912 if (Z - GPT < END_UNCHANGED)
17913 END_UNCHANGED = Z - GPT;
17914 }
17915
17916 /* The position of the first and last character that has been changed. */
17917 first_changed_charpos = BEG + BEG_UNCHANGED;
17918 last_changed_charpos = Z - END_UNCHANGED;
17919
17920 /* If window starts after a line end, and the last change is in
17921 front of that newline, then changes don't affect the display.
17922 This case happens with stealth-fontification. Note that although
17923 the display is unchanged, glyph positions in the matrix have to
17924 be adjusted, of course. */
17925 row = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
17926 if (MATRIX_ROW_DISPLAYS_TEXT_P (row)
17927 && ((last_changed_charpos < CHARPOS (start)
17928 && CHARPOS (start) == BEGV)
17929 || (last_changed_charpos < CHARPOS (start) - 1
17930 && FETCH_BYTE (BYTEPOS (start) - 1) == '\n')))
17931 {
17932 ptrdiff_t Z_old, Z_delta, Z_BYTE_old, Z_delta_bytes;
17933 struct glyph_row *r0;
17934
17935 /* Compute how many chars/bytes have been added to or removed
17936 from the buffer. */
17937 Z_old = MATRIX_ROW_END_CHARPOS (row) + w->window_end_pos;
17938 Z_BYTE_old = MATRIX_ROW_END_BYTEPOS (row) + w->window_end_bytepos;
17939 Z_delta = Z - Z_old;
17940 Z_delta_bytes = Z_BYTE - Z_BYTE_old;
17941
17942 /* Give up if PT is not in the window. Note that it already has
17943 been checked at the start of try_window_id that PT is not in
17944 front of the window start. */
17945 if (PT >= MATRIX_ROW_END_CHARPOS (row) + Z_delta)
17946 GIVE_UP (13);
17947
17948 /* If window start is unchanged, we can reuse the whole matrix
17949 as is, after adjusting glyph positions. No need to compute
17950 the window end again, since its offset from Z hasn't changed. */
17951 r0 = MATRIX_FIRST_TEXT_ROW (current_matrix);
17952 if (CHARPOS (start) == MATRIX_ROW_START_CHARPOS (r0) + Z_delta
17953 && BYTEPOS (start) == MATRIX_ROW_START_BYTEPOS (r0) + Z_delta_bytes
17954 /* PT must not be in a partially visible line. */
17955 && !(PT >= MATRIX_ROW_START_CHARPOS (row) + Z_delta
17956 && MATRIX_ROW_BOTTOM_Y (row) > window_text_bottom_y (w)))
17957 {
17958 /* Adjust positions in the glyph matrix. */
17959 if (Z_delta || Z_delta_bytes)
17960 {
17961 struct glyph_row *r1
17962 = MATRIX_BOTTOM_TEXT_ROW (current_matrix, w);
17963 increment_matrix_positions (w->current_matrix,
17964 MATRIX_ROW_VPOS (r0, current_matrix),
17965 MATRIX_ROW_VPOS (r1, current_matrix),
17966 Z_delta, Z_delta_bytes);
17967 }
17968
17969 /* Set the cursor. */
17970 row = row_containing_pos (w, PT, r0, NULL, 0);
17971 if (row)
17972 set_cursor_from_row (w, row, current_matrix, 0, 0, 0, 0);
17973 return 1;
17974 }
17975 }
17976
17977 /* Handle the case that changes are all below what is displayed in
17978 the window, and that PT is in the window. This shortcut cannot
17979 be taken if ZV is visible in the window, and text has been added
17980 there that is visible in the window. */
17981 if (first_changed_charpos >= MATRIX_ROW_END_CHARPOS (row)
17982 /* ZV is not visible in the window, or there are no
17983 changes at ZV, actually. */
17984 && (current_matrix->zv > MATRIX_ROW_END_CHARPOS (row)
17985 || first_changed_charpos == last_changed_charpos))
17986 {
17987 struct glyph_row *r0;
17988
17989 /* Give up if PT is not in the window. Note that it already has
17990 been checked at the start of try_window_id that PT is not in
17991 front of the window start. */
17992 if (PT >= MATRIX_ROW_END_CHARPOS (row))
17993 GIVE_UP (14);
17994
17995 /* If window start is unchanged, we can reuse the whole matrix
17996 as is, without changing glyph positions since no text has
17997 been added/removed in front of the window end. */
17998 r0 = MATRIX_FIRST_TEXT_ROW (current_matrix);
17999 if (TEXT_POS_EQUAL_P (start, r0->minpos)
18000 /* PT must not be in a partially visible line. */
18001 && !(PT >= MATRIX_ROW_START_CHARPOS (row)
18002 && MATRIX_ROW_BOTTOM_Y (row) > window_text_bottom_y (w)))
18003 {
18004 /* We have to compute the window end anew since text
18005 could have been added/removed after it. */
18006 w->window_end_pos = Z - MATRIX_ROW_END_CHARPOS (row);
18007 w->window_end_bytepos = Z_BYTE - MATRIX_ROW_END_BYTEPOS (row);
18008
18009 /* Set the cursor. */
18010 row = row_containing_pos (w, PT, r0, NULL, 0);
18011 if (row)
18012 set_cursor_from_row (w, row, current_matrix, 0, 0, 0, 0);
18013 return 2;
18014 }
18015 }
18016
18017 /* Give up if window start is in the changed area.
18018
18019 The condition used to read
18020
18021 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18022
18023 but why that was tested escapes me at the moment. */
18024 if (CHARPOS (start) >= first_changed_charpos
18025 && CHARPOS (start) <= last_changed_charpos)
18026 GIVE_UP (15);
18027
18028 /* Check that window start agrees with the start of the first glyph
18029 row in its current matrix. Check this after we know the window
18030 start is not in changed text, otherwise positions would not be
18031 comparable. */
18032 row = MATRIX_FIRST_TEXT_ROW (current_matrix);
18033 if (!TEXT_POS_EQUAL_P (start, row->minpos))
18034 GIVE_UP (16);
18035
18036 /* Give up if the window ends in strings. Overlay strings
18037 at the end are difficult to handle, so don't try. */
18038 row = MATRIX_ROW (current_matrix, w->window_end_vpos);
18039 if (MATRIX_ROW_START_CHARPOS (row) == MATRIX_ROW_END_CHARPOS (row))
18040 GIVE_UP (20);
18041
18042 /* Compute the position at which we have to start displaying new
18043 lines. Some of the lines at the top of the window might be
18044 reusable because they are not displaying changed text. Find the
18045 last row in W's current matrix not affected by changes at the
18046 start of current_buffer. Value is null if changes start in the
18047 first line of window. */
18048 last_unchanged_at_beg_row = find_last_unchanged_at_beg_row (w);
18049 if (last_unchanged_at_beg_row)
18050 {
18051 /* Avoid starting to display in the middle of a character, a TAB
18052 for instance. This is easier than to set up the iterator
18053 exactly, and it's not a frequent case, so the additional
18054 effort wouldn't really pay off. */
18055 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row)
18056 || last_unchanged_at_beg_row->ends_in_newline_from_string_p)
18057 && last_unchanged_at_beg_row > w->current_matrix->rows)
18058 --last_unchanged_at_beg_row;
18059
18060 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row))
18061 GIVE_UP (17);
18062
18063 if (! init_to_row_end (&it, w, last_unchanged_at_beg_row))
18064 GIVE_UP (18);
18065 start_pos = it.current.pos;
18066
18067 /* Start displaying new lines in the desired matrix at the same
18068 vpos we would use in the current matrix, i.e. below
18069 last_unchanged_at_beg_row. */
18070 it.vpos = 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row,
18071 current_matrix);
18072 it.glyph_row = MATRIX_ROW (desired_matrix, it.vpos);
18073 it.current_y = MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row);
18074
18075 eassert (it.hpos == 0 && it.current_x == 0);
18076 }
18077 else
18078 {
18079 /* There are no reusable lines at the start of the window.
18080 Start displaying in the first text line. */
18081 start_display (&it, w, start);
18082 it.vpos = it.first_vpos;
18083 start_pos = it.current.pos;
18084 }
18085
18086 /* Find the first row that is not affected by changes at the end of
18087 the buffer. Value will be null if there is no unchanged row, in
18088 which case we must redisplay to the end of the window. delta
18089 will be set to the value by which buffer positions beginning with
18090 first_unchanged_at_end_row have to be adjusted due to text
18091 changes. */
18092 first_unchanged_at_end_row
18093 = find_first_unchanged_at_end_row (w, &delta, &delta_bytes);
18094 IF_DEBUG (debug_delta = delta);
18095 IF_DEBUG (debug_delta_bytes = delta_bytes);
18096
18097 /* Set stop_pos to the buffer position up to which we will have to
18098 display new lines. If first_unchanged_at_end_row != NULL, this
18099 is the buffer position of the start of the line displayed in that
18100 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18101 that we don't stop at a buffer position. */
18102 stop_pos = 0;
18103 if (first_unchanged_at_end_row)
18104 {
18105 eassert (last_unchanged_at_beg_row == NULL
18106 || first_unchanged_at_end_row >= last_unchanged_at_beg_row);
18107
18108 /* If this is a continuation line, move forward to the next one
18109 that isn't. Changes in lines above affect this line.
18110 Caution: this may move first_unchanged_at_end_row to a row
18111 not displaying text. */
18112 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row)
18113 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row)
18114 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row)
18115 < it.last_visible_y))
18116 ++first_unchanged_at_end_row;
18117
18118 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row)
18119 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row)
18120 >= it.last_visible_y))
18121 first_unchanged_at_end_row = NULL;
18122 else
18123 {
18124 stop_pos = (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row)
18125 + delta);
18126 first_unchanged_at_end_vpos
18127 = MATRIX_ROW_VPOS (first_unchanged_at_end_row, current_matrix);
18128 eassert (stop_pos >= Z - END_UNCHANGED);
18129 }
18130 }
18131 else if (last_unchanged_at_beg_row == NULL)
18132 GIVE_UP (19);
18133
18134
18135 #ifdef GLYPH_DEBUG
18136
18137 /* Either there is no unchanged row at the end, or the one we have
18138 now displays text. This is a necessary condition for the window
18139 end pos calculation at the end of this function. */
18140 eassert (first_unchanged_at_end_row == NULL
18141 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row));
18142
18143 debug_last_unchanged_at_beg_vpos
18144 = (last_unchanged_at_beg_row
18145 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row, current_matrix)
18146 : -1);
18147 debug_first_unchanged_at_end_vpos = first_unchanged_at_end_vpos;
18148
18149 #endif /* GLYPH_DEBUG */
18150
18151
18152 /* Display new lines. Set last_text_row to the last new line
18153 displayed which has text on it, i.e. might end up as being the
18154 line where the window_end_vpos is. */
18155 w->cursor.vpos = -1;
18156 last_text_row = NULL;
18157 overlay_arrow_seen = false;
18158 if (it.current_y < it.last_visible_y
18159 && !f->fonts_changed
18160 && (first_unchanged_at_end_row == NULL
18161 || IT_CHARPOS (it) < stop_pos))
18162 it.glyph_row->reversed_p = false;
18163 while (it.current_y < it.last_visible_y
18164 && !f->fonts_changed
18165 && (first_unchanged_at_end_row == NULL
18166 || IT_CHARPOS (it) < stop_pos))
18167 {
18168 if (display_line (&it))
18169 last_text_row = it.glyph_row - 1;
18170 }
18171
18172 if (f->fonts_changed)
18173 return -1;
18174
18175 /* The redisplay iterations in display_line above could have
18176 triggered font-lock, which could have done something that
18177 invalidates IT->w window's end-point information, on which we
18178 rely below. E.g., one package, which will remain unnamed, used
18179 to install a font-lock-fontify-region-function that called
18180 bury-buffer, whose side effect is to switch the buffer displayed
18181 by IT->w, and that predictably resets IT->w's window_end_valid
18182 flag, which we already tested at the entry to this function.
18183 Amply punish such packages/modes by giving up on this
18184 optimization in those cases. */
18185 if (!w->window_end_valid)
18186 {
18187 clear_glyph_matrix (w->desired_matrix);
18188 return -1;
18189 }
18190
18191 /* Compute differences in buffer positions, y-positions etc. for
18192 lines reused at the bottom of the window. Compute what we can
18193 scroll. */
18194 if (first_unchanged_at_end_row
18195 /* No lines reused because we displayed everything up to the
18196 bottom of the window. */
18197 && it.current_y < it.last_visible_y)
18198 {
18199 dvpos = (it.vpos
18200 - MATRIX_ROW_VPOS (first_unchanged_at_end_row,
18201 current_matrix));
18202 dy = it.current_y - first_unchanged_at_end_row->y;
18203 run.current_y = first_unchanged_at_end_row->y;
18204 run.desired_y = run.current_y + dy;
18205 run.height = it.last_visible_y - max (run.current_y, run.desired_y);
18206 }
18207 else
18208 {
18209 delta = delta_bytes = dvpos = dy
18210 = run.current_y = run.desired_y = run.height = 0;
18211 first_unchanged_at_end_row = NULL;
18212 }
18213 IF_DEBUG ((debug_dvpos = dvpos, debug_dy = dy));
18214
18215
18216 /* Find the cursor if not already found. We have to decide whether
18217 PT will appear on this window (it sometimes doesn't, but this is
18218 not a very frequent case.) This decision has to be made before
18219 the current matrix is altered. A value of cursor.vpos < 0 means
18220 that PT is either in one of the lines beginning at
18221 first_unchanged_at_end_row or below the window. Don't care for
18222 lines that might be displayed later at the window end; as
18223 mentioned, this is not a frequent case. */
18224 if (w->cursor.vpos < 0)
18225 {
18226 /* Cursor in unchanged rows at the top? */
18227 if (PT < CHARPOS (start_pos)
18228 && last_unchanged_at_beg_row)
18229 {
18230 row = row_containing_pos (w, PT,
18231 MATRIX_FIRST_TEXT_ROW (w->current_matrix),
18232 last_unchanged_at_beg_row + 1, 0);
18233 if (row)
18234 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
18235 }
18236
18237 /* Start from first_unchanged_at_end_row looking for PT. */
18238 else if (first_unchanged_at_end_row)
18239 {
18240 row = row_containing_pos (w, PT - delta,
18241 first_unchanged_at_end_row, NULL, 0);
18242 if (row)
18243 set_cursor_from_row (w, row, w->current_matrix, delta,
18244 delta_bytes, dy, dvpos);
18245 }
18246
18247 /* Give up if cursor was not found. */
18248 if (w->cursor.vpos < 0)
18249 {
18250 clear_glyph_matrix (w->desired_matrix);
18251 return -1;
18252 }
18253 }
18254
18255 /* Don't let the cursor end in the scroll margins. */
18256 {
18257 int this_scroll_margin, cursor_height;
18258 int frame_line_height = default_line_pixel_height (w);
18259 int window_total_lines
18260 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (it.f) / frame_line_height;
18261
18262 this_scroll_margin =
18263 max (0, min (scroll_margin, window_total_lines / 4));
18264 this_scroll_margin *= frame_line_height;
18265 cursor_height = MATRIX_ROW (w->desired_matrix, w->cursor.vpos)->height;
18266
18267 if ((w->cursor.y < this_scroll_margin
18268 && CHARPOS (start) > BEGV)
18269 /* Old redisplay didn't take scroll margin into account at the bottom,
18270 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18271 || (w->cursor.y + (make_cursor_line_fully_visible_p
18272 ? cursor_height + this_scroll_margin
18273 : 1)) > it.last_visible_y)
18274 {
18275 w->cursor.vpos = -1;
18276 clear_glyph_matrix (w->desired_matrix);
18277 return -1;
18278 }
18279 }
18280
18281 /* Scroll the display. Do it before changing the current matrix so
18282 that xterm.c doesn't get confused about where the cursor glyph is
18283 found. */
18284 if (dy && run.height)
18285 {
18286 update_begin (f);
18287
18288 if (FRAME_WINDOW_P (f))
18289 {
18290 FRAME_RIF (f)->update_window_begin_hook (w);
18291 FRAME_RIF (f)->clear_window_mouse_face (w);
18292 FRAME_RIF (f)->scroll_run_hook (w, &run);
18293 FRAME_RIF (f)->update_window_end_hook (w, false, false);
18294 }
18295 else
18296 {
18297 /* Terminal frame. In this case, dvpos gives the number of
18298 lines to scroll by; dvpos < 0 means scroll up. */
18299 int from_vpos
18300 = MATRIX_ROW_VPOS (first_unchanged_at_end_row, w->current_matrix);
18301 int from = WINDOW_TOP_EDGE_LINE (w) + from_vpos;
18302 int end = (WINDOW_TOP_EDGE_LINE (w)
18303 + WINDOW_WANTS_HEADER_LINE_P (w)
18304 + window_internal_height (w));
18305
18306 #if defined (HAVE_GPM) || defined (MSDOS)
18307 x_clear_window_mouse_face (w);
18308 #endif
18309 /* Perform the operation on the screen. */
18310 if (dvpos > 0)
18311 {
18312 /* Scroll last_unchanged_at_beg_row to the end of the
18313 window down dvpos lines. */
18314 set_terminal_window (f, end);
18315
18316 /* On dumb terminals delete dvpos lines at the end
18317 before inserting dvpos empty lines. */
18318 if (!FRAME_SCROLL_REGION_OK (f))
18319 ins_del_lines (f, end - dvpos, -dvpos);
18320
18321 /* Insert dvpos empty lines in front of
18322 last_unchanged_at_beg_row. */
18323 ins_del_lines (f, from, dvpos);
18324 }
18325 else if (dvpos < 0)
18326 {
18327 /* Scroll up last_unchanged_at_beg_vpos to the end of
18328 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18329 set_terminal_window (f, end);
18330
18331 /* Delete dvpos lines in front of
18332 last_unchanged_at_beg_vpos. ins_del_lines will set
18333 the cursor to the given vpos and emit |dvpos| delete
18334 line sequences. */
18335 ins_del_lines (f, from + dvpos, dvpos);
18336
18337 /* On a dumb terminal insert dvpos empty lines at the
18338 end. */
18339 if (!FRAME_SCROLL_REGION_OK (f))
18340 ins_del_lines (f, end + dvpos, -dvpos);
18341 }
18342
18343 set_terminal_window (f, 0);
18344 }
18345
18346 update_end (f);
18347 }
18348
18349 /* Shift reused rows of the current matrix to the right position.
18350 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18351 text. */
18352 bottom_row = MATRIX_BOTTOM_TEXT_ROW (current_matrix, w);
18353 bottom_vpos = MATRIX_ROW_VPOS (bottom_row, current_matrix);
18354 if (dvpos < 0)
18355 {
18356 rotate_matrix (current_matrix, first_unchanged_at_end_vpos + dvpos,
18357 bottom_vpos, dvpos);
18358 clear_glyph_matrix_rows (current_matrix, bottom_vpos + dvpos,
18359 bottom_vpos);
18360 }
18361 else if (dvpos > 0)
18362 {
18363 rotate_matrix (current_matrix, first_unchanged_at_end_vpos,
18364 bottom_vpos, dvpos);
18365 clear_glyph_matrix_rows (current_matrix, first_unchanged_at_end_vpos,
18366 first_unchanged_at_end_vpos + dvpos);
18367 }
18368
18369 /* For frame-based redisplay, make sure that current frame and window
18370 matrix are in sync with respect to glyph memory. */
18371 if (!FRAME_WINDOW_P (f))
18372 sync_frame_with_window_matrix_rows (w);
18373
18374 /* Adjust buffer positions in reused rows. */
18375 if (delta || delta_bytes)
18376 increment_matrix_positions (current_matrix,
18377 first_unchanged_at_end_vpos + dvpos,
18378 bottom_vpos, delta, delta_bytes);
18379
18380 /* Adjust Y positions. */
18381 if (dy)
18382 shift_glyph_matrix (w, current_matrix,
18383 first_unchanged_at_end_vpos + dvpos,
18384 bottom_vpos, dy);
18385
18386 if (first_unchanged_at_end_row)
18387 {
18388 first_unchanged_at_end_row += dvpos;
18389 if (first_unchanged_at_end_row->y >= it.last_visible_y
18390 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row))
18391 first_unchanged_at_end_row = NULL;
18392 }
18393
18394 /* If scrolling up, there may be some lines to display at the end of
18395 the window. */
18396 last_text_row_at_end = NULL;
18397 if (dy < 0)
18398 {
18399 /* Scrolling up can leave for example a partially visible line
18400 at the end of the window to be redisplayed. */
18401 /* Set last_row to the glyph row in the current matrix where the
18402 window end line is found. It has been moved up or down in
18403 the matrix by dvpos. */
18404 int last_vpos = w->window_end_vpos + dvpos;
18405 struct glyph_row *last_row = MATRIX_ROW (current_matrix, last_vpos);
18406
18407 /* If last_row is the window end line, it should display text. */
18408 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row));
18409
18410 /* If window end line was partially visible before, begin
18411 displaying at that line. Otherwise begin displaying with the
18412 line following it. */
18413 if (MATRIX_ROW_BOTTOM_Y (last_row) - dy >= it.last_visible_y)
18414 {
18415 init_to_row_start (&it, w, last_row);
18416 it.vpos = last_vpos;
18417 it.current_y = last_row->y;
18418 }
18419 else
18420 {
18421 init_to_row_end (&it, w, last_row);
18422 it.vpos = 1 + last_vpos;
18423 it.current_y = MATRIX_ROW_BOTTOM_Y (last_row);
18424 ++last_row;
18425 }
18426
18427 /* We may start in a continuation line. If so, we have to
18428 get the right continuation_lines_width and current_x. */
18429 it.continuation_lines_width = last_row->continuation_lines_width;
18430 it.hpos = it.current_x = 0;
18431
18432 /* Display the rest of the lines at the window end. */
18433 it.glyph_row = MATRIX_ROW (desired_matrix, it.vpos);
18434 while (it.current_y < it.last_visible_y && !f->fonts_changed)
18435 {
18436 /* Is it always sure that the display agrees with lines in
18437 the current matrix? I don't think so, so we mark rows
18438 displayed invalid in the current matrix by setting their
18439 enabled_p flag to false. */
18440 SET_MATRIX_ROW_ENABLED_P (w->current_matrix, it.vpos, false);
18441 if (display_line (&it))
18442 last_text_row_at_end = it.glyph_row - 1;
18443 }
18444 }
18445
18446 /* Update window_end_pos and window_end_vpos. */
18447 if (first_unchanged_at_end_row && !last_text_row_at_end)
18448 {
18449 /* Window end line if one of the preserved rows from the current
18450 matrix. Set row to the last row displaying text in current
18451 matrix starting at first_unchanged_at_end_row, after
18452 scrolling. */
18453 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row));
18454 row = find_last_row_displaying_text (w->current_matrix, &it,
18455 first_unchanged_at_end_row);
18456 eassert (row && MATRIX_ROW_DISPLAYS_TEXT_P (row));
18457 adjust_window_ends (w, row, true);
18458 eassert (w->window_end_bytepos >= 0);
18459 IF_DEBUG (debug_method_add (w, "A"));
18460 }
18461 else if (last_text_row_at_end)
18462 {
18463 adjust_window_ends (w, last_text_row_at_end, false);
18464 eassert (w->window_end_bytepos >= 0);
18465 IF_DEBUG (debug_method_add (w, "B"));
18466 }
18467 else if (last_text_row)
18468 {
18469 /* We have displayed either to the end of the window or at the
18470 end of the window, i.e. the last row with text is to be found
18471 in the desired matrix. */
18472 adjust_window_ends (w, last_text_row, false);
18473 eassert (w->window_end_bytepos >= 0);
18474 }
18475 else if (first_unchanged_at_end_row == NULL
18476 && last_text_row == NULL
18477 && last_text_row_at_end == NULL)
18478 {
18479 /* Displayed to end of window, but no line containing text was
18480 displayed. Lines were deleted at the end of the window. */
18481 bool first_vpos = WINDOW_WANTS_HEADER_LINE_P (w);
18482 int vpos = w->window_end_vpos;
18483 struct glyph_row *current_row = current_matrix->rows + vpos;
18484 struct glyph_row *desired_row = desired_matrix->rows + vpos;
18485
18486 for (row = NULL;
18487 row == NULL && vpos >= first_vpos;
18488 --vpos, --current_row, --desired_row)
18489 {
18490 if (desired_row->enabled_p)
18491 {
18492 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row))
18493 row = desired_row;
18494 }
18495 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row))
18496 row = current_row;
18497 }
18498
18499 eassert (row != NULL);
18500 w->window_end_vpos = vpos + 1;
18501 w->window_end_pos = Z - MATRIX_ROW_END_CHARPOS (row);
18502 w->window_end_bytepos = Z_BYTE - MATRIX_ROW_END_BYTEPOS (row);
18503 eassert (w->window_end_bytepos >= 0);
18504 IF_DEBUG (debug_method_add (w, "C"));
18505 }
18506 else
18507 emacs_abort ();
18508
18509 IF_DEBUG ((debug_end_pos = w->window_end_pos,
18510 debug_end_vpos = w->window_end_vpos));
18511
18512 /* Record that display has not been completed. */
18513 w->window_end_valid = false;
18514 w->desired_matrix->no_scrolling_p = true;
18515 return 3;
18516
18517 #undef GIVE_UP
18518 }
18519
18520
18521 \f
18522 /***********************************************************************
18523 More debugging support
18524 ***********************************************************************/
18525
18526 #ifdef GLYPH_DEBUG
18527
18528 void dump_glyph_row (struct glyph_row *, int, int) EXTERNALLY_VISIBLE;
18529 void dump_glyph_matrix (struct glyph_matrix *, int) EXTERNALLY_VISIBLE;
18530 void dump_glyph (struct glyph_row *, struct glyph *, int) EXTERNALLY_VISIBLE;
18531
18532
18533 /* Dump the contents of glyph matrix MATRIX on stderr.
18534
18535 GLYPHS 0 means don't show glyph contents.
18536 GLYPHS 1 means show glyphs in short form
18537 GLYPHS > 1 means show glyphs in long form. */
18538
18539 void
18540 dump_glyph_matrix (struct glyph_matrix *matrix, int glyphs)
18541 {
18542 int i;
18543 for (i = 0; i < matrix->nrows; ++i)
18544 dump_glyph_row (MATRIX_ROW (matrix, i), i, glyphs);
18545 }
18546
18547
18548 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18549 the glyph row and area where the glyph comes from. */
18550
18551 void
18552 dump_glyph (struct glyph_row *row, struct glyph *glyph, int area)
18553 {
18554 if (glyph->type == CHAR_GLYPH
18555 || glyph->type == GLYPHLESS_GLYPH)
18556 {
18557 fprintf (stderr,
18558 " %5"pD"d %c %9"pI"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18559 glyph - row->glyphs[TEXT_AREA],
18560 (glyph->type == CHAR_GLYPH
18561 ? 'C'
18562 : 'G'),
18563 glyph->charpos,
18564 (BUFFERP (glyph->object)
18565 ? 'B'
18566 : (STRINGP (glyph->object)
18567 ? 'S'
18568 : (NILP (glyph->object)
18569 ? '0'
18570 : '-'))),
18571 glyph->pixel_width,
18572 glyph->u.ch,
18573 (glyph->u.ch < 0x80 && glyph->u.ch >= ' '
18574 ? glyph->u.ch
18575 : '.'),
18576 glyph->face_id,
18577 glyph->left_box_line_p,
18578 glyph->right_box_line_p);
18579 }
18580 else if (glyph->type == STRETCH_GLYPH)
18581 {
18582 fprintf (stderr,
18583 " %5"pD"d %c %9"pI"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18584 glyph - row->glyphs[TEXT_AREA],
18585 'S',
18586 glyph->charpos,
18587 (BUFFERP (glyph->object)
18588 ? 'B'
18589 : (STRINGP (glyph->object)
18590 ? 'S'
18591 : (NILP (glyph->object)
18592 ? '0'
18593 : '-'))),
18594 glyph->pixel_width,
18595 0,
18596 ' ',
18597 glyph->face_id,
18598 glyph->left_box_line_p,
18599 glyph->right_box_line_p);
18600 }
18601 else if (glyph->type == IMAGE_GLYPH)
18602 {
18603 fprintf (stderr,
18604 " %5"pD"d %c %9"pI"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18605 glyph - row->glyphs[TEXT_AREA],
18606 'I',
18607 glyph->charpos,
18608 (BUFFERP (glyph->object)
18609 ? 'B'
18610 : (STRINGP (glyph->object)
18611 ? 'S'
18612 : (NILP (glyph->object)
18613 ? '0'
18614 : '-'))),
18615 glyph->pixel_width,
18616 glyph->u.img_id,
18617 '.',
18618 glyph->face_id,
18619 glyph->left_box_line_p,
18620 glyph->right_box_line_p);
18621 }
18622 else if (glyph->type == COMPOSITE_GLYPH)
18623 {
18624 fprintf (stderr,
18625 " %5"pD"d %c %9"pI"d %c %3d 0x%06x",
18626 glyph - row->glyphs[TEXT_AREA],
18627 '+',
18628 glyph->charpos,
18629 (BUFFERP (glyph->object)
18630 ? 'B'
18631 : (STRINGP (glyph->object)
18632 ? 'S'
18633 : (NILP (glyph->object)
18634 ? '0'
18635 : '-'))),
18636 glyph->pixel_width,
18637 glyph->u.cmp.id);
18638 if (glyph->u.cmp.automatic)
18639 fprintf (stderr,
18640 "[%d-%d]",
18641 glyph->slice.cmp.from, glyph->slice.cmp.to);
18642 fprintf (stderr, " . %4d %1.1d%1.1d\n",
18643 glyph->face_id,
18644 glyph->left_box_line_p,
18645 glyph->right_box_line_p);
18646 }
18647 }
18648
18649
18650 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18651 GLYPHS 0 means don't show glyph contents.
18652 GLYPHS 1 means show glyphs in short form
18653 GLYPHS > 1 means show glyphs in long form. */
18654
18655 void
18656 dump_glyph_row (struct glyph_row *row, int vpos, int glyphs)
18657 {
18658 if (glyphs != 1)
18659 {
18660 fprintf (stderr, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18661 fprintf (stderr, "==============================================================================\n");
18662
18663 fprintf (stderr, "%3d %9"pI"d %9"pI"d %4d %1.1d%1.1d%1.1d%1.1d\
18664 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18665 vpos,
18666 MATRIX_ROW_START_CHARPOS (row),
18667 MATRIX_ROW_END_CHARPOS (row),
18668 row->used[TEXT_AREA],
18669 row->contains_overlapping_glyphs_p,
18670 row->enabled_p,
18671 row->truncated_on_left_p,
18672 row->truncated_on_right_p,
18673 row->continued_p,
18674 MATRIX_ROW_CONTINUATION_LINE_P (row),
18675 MATRIX_ROW_DISPLAYS_TEXT_P (row),
18676 row->ends_at_zv_p,
18677 row->fill_line_p,
18678 row->ends_in_middle_of_char_p,
18679 row->starts_in_middle_of_char_p,
18680 row->mouse_face_p,
18681 row->x,
18682 row->y,
18683 row->pixel_width,
18684 row->height,
18685 row->visible_height,
18686 row->ascent,
18687 row->phys_ascent);
18688 /* The next 3 lines should align to "Start" in the header. */
18689 fprintf (stderr, " %9"pD"d %9"pD"d\t%5d\n", row->start.overlay_string_index,
18690 row->end.overlay_string_index,
18691 row->continuation_lines_width);
18692 fprintf (stderr, " %9"pI"d %9"pI"d\n",
18693 CHARPOS (row->start.string_pos),
18694 CHARPOS (row->end.string_pos));
18695 fprintf (stderr, " %9d %9d\n", row->start.dpvec_index,
18696 row->end.dpvec_index);
18697 }
18698
18699 if (glyphs > 1)
18700 {
18701 int area;
18702
18703 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
18704 {
18705 struct glyph *glyph = row->glyphs[area];
18706 struct glyph *glyph_end = glyph + row->used[area];
18707
18708 /* Glyph for a line end in text. */
18709 if (area == TEXT_AREA && glyph == glyph_end && glyph->charpos > 0)
18710 ++glyph_end;
18711
18712 if (glyph < glyph_end)
18713 fprintf (stderr, " Glyph# Type Pos O W Code C Face LR\n");
18714
18715 for (; glyph < glyph_end; ++glyph)
18716 dump_glyph (row, glyph, area);
18717 }
18718 }
18719 else if (glyphs == 1)
18720 {
18721 int area;
18722 char s[SHRT_MAX + 4];
18723
18724 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
18725 {
18726 int i;
18727
18728 for (i = 0; i < row->used[area]; ++i)
18729 {
18730 struct glyph *glyph = row->glyphs[area] + i;
18731 if (i == row->used[area] - 1
18732 && area == TEXT_AREA
18733 && NILP (glyph->object)
18734 && glyph->type == CHAR_GLYPH
18735 && glyph->u.ch == ' ')
18736 {
18737 strcpy (&s[i], "[\\n]");
18738 i += 4;
18739 }
18740 else if (glyph->type == CHAR_GLYPH
18741 && glyph->u.ch < 0x80
18742 && glyph->u.ch >= ' ')
18743 s[i] = glyph->u.ch;
18744 else
18745 s[i] = '.';
18746 }
18747
18748 s[i] = '\0';
18749 fprintf (stderr, "%3d: (%d) '%s'\n", vpos, row->enabled_p, s);
18750 }
18751 }
18752 }
18753
18754
18755 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix,
18756 Sdump_glyph_matrix, 0, 1, "p",
18757 doc: /* Dump the current matrix of the selected window to stderr.
18758 Shows contents of glyph row structures. With non-nil
18759 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18760 glyphs in short form, otherwise show glyphs in long form.
18761
18762 Interactively, no argument means show glyphs in short form;
18763 with numeric argument, its value is passed as the GLYPHS flag. */)
18764 (Lisp_Object glyphs)
18765 {
18766 struct window *w = XWINDOW (selected_window);
18767 struct buffer *buffer = XBUFFER (w->contents);
18768
18769 fprintf (stderr, "PT = %"pI"d, BEGV = %"pI"d. ZV = %"pI"d\n",
18770 BUF_PT (buffer), BUF_BEGV (buffer), BUF_ZV (buffer));
18771 fprintf (stderr, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18772 w->cursor.x, w->cursor.y, w->cursor.hpos, w->cursor.vpos);
18773 fprintf (stderr, "=============================================\n");
18774 dump_glyph_matrix (w->current_matrix,
18775 TYPE_RANGED_INTEGERP (int, glyphs) ? XINT (glyphs) : 0);
18776 return Qnil;
18777 }
18778
18779
18780 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix,
18781 Sdump_frame_glyph_matrix, 0, 0, "", doc: /* Dump the current glyph matrix of the selected frame to stderr.
18782 Only text-mode frames have frame glyph matrices. */)
18783 (void)
18784 {
18785 struct frame *f = XFRAME (selected_frame);
18786
18787 if (f->current_matrix)
18788 dump_glyph_matrix (f->current_matrix, 1);
18789 else
18790 fprintf (stderr, "*** This frame doesn't have a frame glyph matrix ***\n");
18791 return Qnil;
18792 }
18793
18794
18795 DEFUN ("dump-glyph-row", Fdump_glyph_row, Sdump_glyph_row, 1, 2, "",
18796 doc: /* Dump glyph row ROW to stderr.
18797 GLYPH 0 means don't dump glyphs.
18798 GLYPH 1 means dump glyphs in short form.
18799 GLYPH > 1 or omitted means dump glyphs in long form. */)
18800 (Lisp_Object row, Lisp_Object glyphs)
18801 {
18802 struct glyph_matrix *matrix;
18803 EMACS_INT vpos;
18804
18805 CHECK_NUMBER (row);
18806 matrix = XWINDOW (selected_window)->current_matrix;
18807 vpos = XINT (row);
18808 if (vpos >= 0 && vpos < matrix->nrows)
18809 dump_glyph_row (MATRIX_ROW (matrix, vpos),
18810 vpos,
18811 TYPE_RANGED_INTEGERP (int, glyphs) ? XINT (glyphs) : 2);
18812 return Qnil;
18813 }
18814
18815
18816 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row, Sdump_tool_bar_row, 1, 2, "",
18817 doc: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18818 GLYPH 0 means don't dump glyphs.
18819 GLYPH 1 means dump glyphs in short form.
18820 GLYPH > 1 or omitted means dump glyphs in long form.
18821
18822 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18823 do nothing. */)
18824 (Lisp_Object row, Lisp_Object glyphs)
18825 {
18826 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18827 struct frame *sf = SELECTED_FRAME ();
18828 struct glyph_matrix *m = XWINDOW (sf->tool_bar_window)->current_matrix;
18829 EMACS_INT vpos;
18830
18831 CHECK_NUMBER (row);
18832 vpos = XINT (row);
18833 if (vpos >= 0 && vpos < m->nrows)
18834 dump_glyph_row (MATRIX_ROW (m, vpos), vpos,
18835 TYPE_RANGED_INTEGERP (int, glyphs) ? XINT (glyphs) : 2);
18836 #endif
18837 return Qnil;
18838 }
18839
18840
18841 DEFUN ("trace-redisplay", Ftrace_redisplay, Strace_redisplay, 0, 1, "P",
18842 doc: /* Toggle tracing of redisplay.
18843 With ARG, turn tracing on if and only if ARG is positive. */)
18844 (Lisp_Object arg)
18845 {
18846 if (NILP (arg))
18847 trace_redisplay_p = !trace_redisplay_p;
18848 else
18849 {
18850 arg = Fprefix_numeric_value (arg);
18851 trace_redisplay_p = XINT (arg) > 0;
18852 }
18853
18854 return Qnil;
18855 }
18856
18857
18858 DEFUN ("trace-to-stderr", Ftrace_to_stderr, Strace_to_stderr, 1, MANY, "",
18859 doc: /* Like `format', but print result to stderr.
18860 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18861 (ptrdiff_t nargs, Lisp_Object *args)
18862 {
18863 Lisp_Object s = Fformat (nargs, args);
18864 fwrite (SDATA (s), 1, SBYTES (s), stderr);
18865 return Qnil;
18866 }
18867
18868 #endif /* GLYPH_DEBUG */
18869
18870
18871 \f
18872 /***********************************************************************
18873 Building Desired Matrix Rows
18874 ***********************************************************************/
18875
18876 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18877 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18878
18879 static struct glyph_row *
18880 get_overlay_arrow_glyph_row (struct window *w, Lisp_Object overlay_arrow_string)
18881 {
18882 struct frame *f = XFRAME (WINDOW_FRAME (w));
18883 struct buffer *buffer = XBUFFER (w->contents);
18884 struct buffer *old = current_buffer;
18885 const unsigned char *arrow_string = SDATA (overlay_arrow_string);
18886 ptrdiff_t arrow_len = SCHARS (overlay_arrow_string);
18887 const unsigned char *arrow_end = arrow_string + arrow_len;
18888 const unsigned char *p;
18889 struct it it;
18890 bool multibyte_p;
18891 int n_glyphs_before;
18892
18893 set_buffer_temp (buffer);
18894 init_iterator (&it, w, -1, -1, &scratch_glyph_row, DEFAULT_FACE_ID);
18895 scratch_glyph_row.reversed_p = false;
18896 it.glyph_row->used[TEXT_AREA] = 0;
18897 SET_TEXT_POS (it.position, 0, 0);
18898
18899 multibyte_p = !NILP (BVAR (buffer, enable_multibyte_characters));
18900 p = arrow_string;
18901 while (p < arrow_end)
18902 {
18903 Lisp_Object face, ilisp;
18904
18905 /* Get the next character. */
18906 if (multibyte_p)
18907 it.c = it.char_to_display = string_char_and_length (p, &it.len);
18908 else
18909 {
18910 it.c = it.char_to_display = *p, it.len = 1;
18911 if (! ASCII_CHAR_P (it.c))
18912 it.char_to_display = BYTE8_TO_CHAR (it.c);
18913 }
18914 p += it.len;
18915
18916 /* Get its face. */
18917 ilisp = make_number (p - arrow_string);
18918 face = Fget_text_property (ilisp, Qface, overlay_arrow_string);
18919 it.face_id = compute_char_face (f, it.char_to_display, face);
18920
18921 /* Compute its width, get its glyphs. */
18922 n_glyphs_before = it.glyph_row->used[TEXT_AREA];
18923 SET_TEXT_POS (it.position, -1, -1);
18924 PRODUCE_GLYPHS (&it);
18925
18926 /* If this character doesn't fit any more in the line, we have
18927 to remove some glyphs. */
18928 if (it.current_x > it.last_visible_x)
18929 {
18930 it.glyph_row->used[TEXT_AREA] = n_glyphs_before;
18931 break;
18932 }
18933 }
18934
18935 set_buffer_temp (old);
18936 return it.glyph_row;
18937 }
18938
18939
18940 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18941 glyphs to insert is determined by produce_special_glyphs. */
18942
18943 static void
18944 insert_left_trunc_glyphs (struct it *it)
18945 {
18946 struct it truncate_it;
18947 struct glyph *from, *end, *to, *toend;
18948
18949 eassert (!FRAME_WINDOW_P (it->f)
18950 || (!it->glyph_row->reversed_p
18951 && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0)
18952 || (it->glyph_row->reversed_p
18953 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0));
18954
18955 /* Get the truncation glyphs. */
18956 truncate_it = *it;
18957 truncate_it.current_x = 0;
18958 truncate_it.face_id = DEFAULT_FACE_ID;
18959 truncate_it.glyph_row = &scratch_glyph_row;
18960 truncate_it.area = TEXT_AREA;
18961 truncate_it.glyph_row->used[TEXT_AREA] = 0;
18962 CHARPOS (truncate_it.position) = BYTEPOS (truncate_it.position) = -1;
18963 truncate_it.object = Qnil;
18964 produce_special_glyphs (&truncate_it, IT_TRUNCATION);
18965
18966 /* Overwrite glyphs from IT with truncation glyphs. */
18967 if (!it->glyph_row->reversed_p)
18968 {
18969 short tused = truncate_it.glyph_row->used[TEXT_AREA];
18970
18971 from = truncate_it.glyph_row->glyphs[TEXT_AREA];
18972 end = from + tused;
18973 to = it->glyph_row->glyphs[TEXT_AREA];
18974 toend = to + it->glyph_row->used[TEXT_AREA];
18975 if (FRAME_WINDOW_P (it->f))
18976 {
18977 /* On GUI frames, when variable-size fonts are displayed,
18978 the truncation glyphs may need more pixels than the row's
18979 glyphs they overwrite. We overwrite more glyphs to free
18980 enough screen real estate, and enlarge the stretch glyph
18981 on the right (see display_line), if there is one, to
18982 preserve the screen position of the truncation glyphs on
18983 the right. */
18984 int w = 0;
18985 struct glyph *g = to;
18986 short used;
18987
18988 /* The first glyph could be partially visible, in which case
18989 it->glyph_row->x will be negative. But we want the left
18990 truncation glyphs to be aligned at the left margin of the
18991 window, so we override the x coordinate at which the row
18992 will begin. */
18993 it->glyph_row->x = 0;
18994 while (g < toend && w < it->truncation_pixel_width)
18995 {
18996 w += g->pixel_width;
18997 ++g;
18998 }
18999 if (g - to - tused > 0)
19000 {
19001 memmove (to + tused, g, (toend - g) * sizeof(*g));
19002 it->glyph_row->used[TEXT_AREA] -= g - to - tused;
19003 }
19004 used = it->glyph_row->used[TEXT_AREA];
19005 if (it->glyph_row->truncated_on_right_p
19006 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0
19007 && it->glyph_row->glyphs[TEXT_AREA][used - 2].type
19008 == STRETCH_GLYPH)
19009 {
19010 int extra = w - it->truncation_pixel_width;
19011
19012 it->glyph_row->glyphs[TEXT_AREA][used - 2].pixel_width += extra;
19013 }
19014 }
19015
19016 while (from < end)
19017 *to++ = *from++;
19018
19019 /* There may be padding glyphs left over. Overwrite them too. */
19020 if (!FRAME_WINDOW_P (it->f))
19021 {
19022 while (to < toend && CHAR_GLYPH_PADDING_P (*to))
19023 {
19024 from = truncate_it.glyph_row->glyphs[TEXT_AREA];
19025 while (from < end)
19026 *to++ = *from++;
19027 }
19028 }
19029
19030 if (to > toend)
19031 it->glyph_row->used[TEXT_AREA] = to - it->glyph_row->glyphs[TEXT_AREA];
19032 }
19033 else
19034 {
19035 short tused = truncate_it.glyph_row->used[TEXT_AREA];
19036
19037 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19038 that back to front. */
19039 end = truncate_it.glyph_row->glyphs[TEXT_AREA];
19040 from = end + truncate_it.glyph_row->used[TEXT_AREA] - 1;
19041 toend = it->glyph_row->glyphs[TEXT_AREA];
19042 to = toend + it->glyph_row->used[TEXT_AREA] - 1;
19043 if (FRAME_WINDOW_P (it->f))
19044 {
19045 int w = 0;
19046 struct glyph *g = to;
19047
19048 while (g >= toend && w < it->truncation_pixel_width)
19049 {
19050 w += g->pixel_width;
19051 --g;
19052 }
19053 if (to - g - tused > 0)
19054 to = g + tused;
19055 if (it->glyph_row->truncated_on_right_p
19056 && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0
19057 && it->glyph_row->glyphs[TEXT_AREA][1].type == STRETCH_GLYPH)
19058 {
19059 int extra = w - it->truncation_pixel_width;
19060
19061 it->glyph_row->glyphs[TEXT_AREA][1].pixel_width += extra;
19062 }
19063 }
19064
19065 while (from >= end && to >= toend)
19066 *to-- = *from--;
19067 if (!FRAME_WINDOW_P (it->f))
19068 {
19069 while (to >= toend && CHAR_GLYPH_PADDING_P (*to))
19070 {
19071 from =
19072 truncate_it.glyph_row->glyphs[TEXT_AREA]
19073 + truncate_it.glyph_row->used[TEXT_AREA] - 1;
19074 while (from >= end && to >= toend)
19075 *to-- = *from--;
19076 }
19077 }
19078 if (from >= end)
19079 {
19080 /* Need to free some room before prepending additional
19081 glyphs. */
19082 int move_by = from - end + 1;
19083 struct glyph *g0 = it->glyph_row->glyphs[TEXT_AREA];
19084 struct glyph *g = g0 + it->glyph_row->used[TEXT_AREA] - 1;
19085
19086 for ( ; g >= g0; g--)
19087 g[move_by] = *g;
19088 while (from >= end)
19089 *to-- = *from--;
19090 it->glyph_row->used[TEXT_AREA] += move_by;
19091 }
19092 }
19093 }
19094
19095 /* Compute the hash code for ROW. */
19096 unsigned
19097 row_hash (struct glyph_row *row)
19098 {
19099 int area, k;
19100 unsigned hashval = 0;
19101
19102 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
19103 for (k = 0; k < row->used[area]; ++k)
19104 hashval = ((((hashval << 4) + (hashval >> 24)) & 0x0fffffff)
19105 + row->glyphs[area][k].u.val
19106 + row->glyphs[area][k].face_id
19107 + row->glyphs[area][k].padding_p
19108 + (row->glyphs[area][k].type << 2));
19109
19110 return hashval;
19111 }
19112
19113 /* Compute the pixel height and width of IT->glyph_row.
19114
19115 Most of the time, ascent and height of a display line will be equal
19116 to the max_ascent and max_height values of the display iterator
19117 structure. This is not the case if
19118
19119 1. We hit ZV without displaying anything. In this case, max_ascent
19120 and max_height will be zero.
19121
19122 2. We have some glyphs that don't contribute to the line height.
19123 (The glyph row flag contributes_to_line_height_p is for future
19124 pixmap extensions).
19125
19126 The first case is easily covered by using default values because in
19127 these cases, the line height does not really matter, except that it
19128 must not be zero. */
19129
19130 static void
19131 compute_line_metrics (struct it *it)
19132 {
19133 struct glyph_row *row = it->glyph_row;
19134
19135 if (FRAME_WINDOW_P (it->f))
19136 {
19137 int i, min_y, max_y;
19138
19139 /* The line may consist of one space only, that was added to
19140 place the cursor on it. If so, the row's height hasn't been
19141 computed yet. */
19142 if (row->height == 0)
19143 {
19144 if (it->max_ascent + it->max_descent == 0)
19145 it->max_descent = it->max_phys_descent = FRAME_LINE_HEIGHT (it->f);
19146 row->ascent = it->max_ascent;
19147 row->height = it->max_ascent + it->max_descent;
19148 row->phys_ascent = it->max_phys_ascent;
19149 row->phys_height = it->max_phys_ascent + it->max_phys_descent;
19150 row->extra_line_spacing = it->max_extra_line_spacing;
19151 }
19152
19153 /* Compute the width of this line. */
19154 row->pixel_width = row->x;
19155 for (i = 0; i < row->used[TEXT_AREA]; ++i)
19156 row->pixel_width += row->glyphs[TEXT_AREA][i].pixel_width;
19157
19158 eassert (row->pixel_width >= 0);
19159 eassert (row->ascent >= 0 && row->height > 0);
19160
19161 row->overlapping_p = (MATRIX_ROW_OVERLAPS_SUCC_P (row)
19162 || MATRIX_ROW_OVERLAPS_PRED_P (row));
19163
19164 /* If first line's physical ascent is larger than its logical
19165 ascent, use the physical ascent, and make the row taller.
19166 This makes accented characters fully visible. */
19167 if (row == MATRIX_FIRST_TEXT_ROW (it->w->desired_matrix)
19168 && row->phys_ascent > row->ascent)
19169 {
19170 row->height += row->phys_ascent - row->ascent;
19171 row->ascent = row->phys_ascent;
19172 }
19173
19174 /* Compute how much of the line is visible. */
19175 row->visible_height = row->height;
19176
19177 min_y = WINDOW_HEADER_LINE_HEIGHT (it->w);
19178 max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (it->w);
19179
19180 if (row->y < min_y)
19181 row->visible_height -= min_y - row->y;
19182 if (row->y + row->height > max_y)
19183 row->visible_height -= row->y + row->height - max_y;
19184 }
19185 else
19186 {
19187 row->pixel_width = row->used[TEXT_AREA];
19188 if (row->continued_p)
19189 row->pixel_width -= it->continuation_pixel_width;
19190 else if (row->truncated_on_right_p)
19191 row->pixel_width -= it->truncation_pixel_width;
19192 row->ascent = row->phys_ascent = 0;
19193 row->height = row->phys_height = row->visible_height = 1;
19194 row->extra_line_spacing = 0;
19195 }
19196
19197 /* Compute a hash code for this row. */
19198 row->hash = row_hash (row);
19199
19200 it->max_ascent = it->max_descent = 0;
19201 it->max_phys_ascent = it->max_phys_descent = 0;
19202 }
19203
19204
19205 /* Append one space to the glyph row of iterator IT if doing a
19206 window-based redisplay. The space has the same face as
19207 IT->face_id. Value is true if a space was added.
19208
19209 This function is called to make sure that there is always one glyph
19210 at the end of a glyph row that the cursor can be set on under
19211 window-systems. (If there weren't such a glyph we would not know
19212 how wide and tall a box cursor should be displayed).
19213
19214 At the same time this space let's a nicely handle clearing to the
19215 end of the line if the row ends in italic text. */
19216
19217 static bool
19218 append_space_for_newline (struct it *it, bool default_face_p)
19219 {
19220 if (FRAME_WINDOW_P (it->f))
19221 {
19222 int n = it->glyph_row->used[TEXT_AREA];
19223
19224 if (it->glyph_row->glyphs[TEXT_AREA] + n
19225 < it->glyph_row->glyphs[1 + TEXT_AREA])
19226 {
19227 /* Save some values that must not be changed.
19228 Must save IT->c and IT->len because otherwise
19229 ITERATOR_AT_END_P wouldn't work anymore after
19230 append_space_for_newline has been called. */
19231 enum display_element_type saved_what = it->what;
19232 int saved_c = it->c, saved_len = it->len;
19233 int saved_char_to_display = it->char_to_display;
19234 int saved_x = it->current_x;
19235 int saved_face_id = it->face_id;
19236 bool saved_box_end = it->end_of_box_run_p;
19237 struct text_pos saved_pos;
19238 Lisp_Object saved_object;
19239 struct face *face;
19240 struct glyph *g;
19241
19242 saved_object = it->object;
19243 saved_pos = it->position;
19244
19245 it->what = IT_CHARACTER;
19246 memset (&it->position, 0, sizeof it->position);
19247 it->object = Qnil;
19248 it->c = it->char_to_display = ' ';
19249 it->len = 1;
19250
19251 /* If the default face was remapped, be sure to use the
19252 remapped face for the appended newline. */
19253 if (default_face_p)
19254 it->face_id = lookup_basic_face (it->f, DEFAULT_FACE_ID);
19255 else if (it->face_before_selective_p)
19256 it->face_id = it->saved_face_id;
19257 face = FACE_FROM_ID (it->f, it->face_id);
19258 it->face_id = FACE_FOR_CHAR (it->f, face, 0, -1, Qnil);
19259 /* In R2L rows, we will prepend a stretch glyph that will
19260 have the end_of_box_run_p flag set for it, so there's no
19261 need for the appended newline glyph to have that flag
19262 set. */
19263 if (it->glyph_row->reversed_p
19264 /* But if the appended newline glyph goes all the way to
19265 the end of the row, there will be no stretch glyph,
19266 so leave the box flag set. */
19267 && saved_x + FRAME_COLUMN_WIDTH (it->f) < it->last_visible_x)
19268 it->end_of_box_run_p = false;
19269
19270 PRODUCE_GLYPHS (it);
19271
19272 #ifdef HAVE_WINDOW_SYSTEM
19273 /* Make sure this space glyph has the right ascent and
19274 descent values, or else cursor at end of line will look
19275 funny, and height of empty lines will be incorrect. */
19276 g = it->glyph_row->glyphs[TEXT_AREA] + n;
19277 struct font *font = face->font ? face->font : FRAME_FONT (it->f);
19278 if (n == 0)
19279 {
19280 Lisp_Object height, total_height;
19281 int extra_line_spacing = it->extra_line_spacing;
19282 int boff = font->baseline_offset;
19283
19284 if (font->vertical_centering)
19285 boff = VCENTER_BASELINE_OFFSET (font, it->f) - boff;
19286
19287 it->object = saved_object; /* get_it_property needs this */
19288 normal_char_ascent_descent (font, -1, &it->ascent, &it->descent);
19289 /* Must do a subset of line height processing from
19290 x_produce_glyph for newline characters. */
19291 height = get_it_property (it, Qline_height);
19292 if (CONSP (height)
19293 && CONSP (XCDR (height))
19294 && NILP (XCDR (XCDR (height))))
19295 {
19296 total_height = XCAR (XCDR (height));
19297 height = XCAR (height);
19298 }
19299 else
19300 total_height = Qnil;
19301 height = calc_line_height_property (it, height, font, boff, true);
19302
19303 if (it->override_ascent >= 0)
19304 {
19305 it->ascent = it->override_ascent;
19306 it->descent = it->override_descent;
19307 boff = it->override_boff;
19308 }
19309 if (EQ (height, Qt))
19310 extra_line_spacing = 0;
19311 else
19312 {
19313 Lisp_Object spacing;
19314
19315 it->phys_ascent = it->ascent;
19316 it->phys_descent = it->descent;
19317 if (!NILP (height)
19318 && XINT (height) > it->ascent + it->descent)
19319 it->ascent = XINT (height) - it->descent;
19320
19321 if (!NILP (total_height))
19322 spacing = calc_line_height_property (it, total_height, font,
19323 boff, false);
19324 else
19325 {
19326 spacing = get_it_property (it, Qline_spacing);
19327 spacing = calc_line_height_property (it, spacing, font,
19328 boff, false);
19329 }
19330 if (INTEGERP (spacing))
19331 {
19332 extra_line_spacing = XINT (spacing);
19333 if (!NILP (total_height))
19334 extra_line_spacing -= (it->phys_ascent + it->phys_descent);
19335 }
19336 }
19337 if (extra_line_spacing > 0)
19338 {
19339 it->descent += extra_line_spacing;
19340 if (extra_line_spacing > it->max_extra_line_spacing)
19341 it->max_extra_line_spacing = extra_line_spacing;
19342 }
19343 it->max_ascent = it->ascent;
19344 it->max_descent = it->descent;
19345 /* Make sure compute_line_metrics recomputes the row height. */
19346 it->glyph_row->height = 0;
19347 }
19348
19349 g->ascent = it->max_ascent;
19350 g->descent = it->max_descent;
19351 #endif
19352
19353 it->override_ascent = -1;
19354 it->constrain_row_ascent_descent_p = false;
19355 it->current_x = saved_x;
19356 it->object = saved_object;
19357 it->position = saved_pos;
19358 it->what = saved_what;
19359 it->face_id = saved_face_id;
19360 it->len = saved_len;
19361 it->c = saved_c;
19362 it->char_to_display = saved_char_to_display;
19363 it->end_of_box_run_p = saved_box_end;
19364 return true;
19365 }
19366 }
19367
19368 return false;
19369 }
19370
19371
19372 /* Extend the face of the last glyph in the text area of IT->glyph_row
19373 to the end of the display line. Called from display_line. If the
19374 glyph row is empty, add a space glyph to it so that we know the
19375 face to draw. Set the glyph row flag fill_line_p. If the glyph
19376 row is R2L, prepend a stretch glyph to cover the empty space to the
19377 left of the leftmost glyph. */
19378
19379 static void
19380 extend_face_to_end_of_line (struct it *it)
19381 {
19382 struct face *face, *default_face;
19383 struct frame *f = it->f;
19384
19385 /* If line is already filled, do nothing. Non window-system frames
19386 get a grace of one more ``pixel'' because their characters are
19387 1-``pixel'' wide, so they hit the equality too early. This grace
19388 is needed only for R2L rows that are not continued, to produce
19389 one extra blank where we could display the cursor. */
19390 if ((it->current_x >= it->last_visible_x
19391 + (!FRAME_WINDOW_P (f)
19392 && it->glyph_row->reversed_p
19393 && !it->glyph_row->continued_p))
19394 /* If the window has display margins, we will need to extend
19395 their face even if the text area is filled. */
19396 && !(WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
19397 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0))
19398 return;
19399
19400 /* The default face, possibly remapped. */
19401 default_face = FACE_FROM_ID (f, lookup_basic_face (f, DEFAULT_FACE_ID));
19402
19403 /* Face extension extends the background and box of IT->face_id
19404 to the end of the line. If the background equals the background
19405 of the frame, we don't have to do anything. */
19406 if (it->face_before_selective_p)
19407 face = FACE_FROM_ID (f, it->saved_face_id);
19408 else
19409 face = FACE_FROM_ID (f, it->face_id);
19410
19411 if (FRAME_WINDOW_P (f)
19412 && MATRIX_ROW_DISPLAYS_TEXT_P (it->glyph_row)
19413 && face->box == FACE_NO_BOX
19414 && face->background == FRAME_BACKGROUND_PIXEL (f)
19415 #ifdef HAVE_WINDOW_SYSTEM
19416 && !face->stipple
19417 #endif
19418 && !it->glyph_row->reversed_p)
19419 return;
19420
19421 /* Set the glyph row flag indicating that the face of the last glyph
19422 in the text area has to be drawn to the end of the text area. */
19423 it->glyph_row->fill_line_p = true;
19424
19425 /* If current character of IT is not ASCII, make sure we have the
19426 ASCII face. This will be automatically undone the next time
19427 get_next_display_element returns a multibyte character. Note
19428 that the character will always be single byte in unibyte
19429 text. */
19430 if (!ASCII_CHAR_P (it->c))
19431 {
19432 it->face_id = FACE_FOR_CHAR (f, face, 0, -1, Qnil);
19433 }
19434
19435 if (FRAME_WINDOW_P (f))
19436 {
19437 /* If the row is empty, add a space with the current face of IT,
19438 so that we know which face to draw. */
19439 if (it->glyph_row->used[TEXT_AREA] == 0)
19440 {
19441 it->glyph_row->glyphs[TEXT_AREA][0] = space_glyph;
19442 it->glyph_row->glyphs[TEXT_AREA][0].face_id = face->id;
19443 it->glyph_row->used[TEXT_AREA] = 1;
19444 }
19445 /* Mode line and the header line don't have margins, and
19446 likewise the frame's tool-bar window, if there is any. */
19447 if (!(it->glyph_row->mode_line_p
19448 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19449 || (WINDOWP (f->tool_bar_window)
19450 && it->w == XWINDOW (f->tool_bar_window))
19451 #endif
19452 ))
19453 {
19454 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
19455 && it->glyph_row->used[LEFT_MARGIN_AREA] == 0)
19456 {
19457 it->glyph_row->glyphs[LEFT_MARGIN_AREA][0] = space_glyph;
19458 it->glyph_row->glyphs[LEFT_MARGIN_AREA][0].face_id =
19459 default_face->id;
19460 it->glyph_row->used[LEFT_MARGIN_AREA] = 1;
19461 }
19462 if (WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0
19463 && it->glyph_row->used[RIGHT_MARGIN_AREA] == 0)
19464 {
19465 it->glyph_row->glyphs[RIGHT_MARGIN_AREA][0] = space_glyph;
19466 it->glyph_row->glyphs[RIGHT_MARGIN_AREA][0].face_id =
19467 default_face->id;
19468 it->glyph_row->used[RIGHT_MARGIN_AREA] = 1;
19469 }
19470 }
19471 #ifdef HAVE_WINDOW_SYSTEM
19472 if (it->glyph_row->reversed_p)
19473 {
19474 /* Prepend a stretch glyph to the row, such that the
19475 rightmost glyph will be drawn flushed all the way to the
19476 right margin of the window. The stretch glyph that will
19477 occupy the empty space, if any, to the left of the
19478 glyphs. */
19479 struct font *font = face->font ? face->font : FRAME_FONT (f);
19480 struct glyph *row_start = it->glyph_row->glyphs[TEXT_AREA];
19481 struct glyph *row_end = row_start + it->glyph_row->used[TEXT_AREA];
19482 struct glyph *g;
19483 int row_width, stretch_ascent, stretch_width;
19484 struct text_pos saved_pos;
19485 int saved_face_id;
19486 bool saved_avoid_cursor, saved_box_start;
19487
19488 for (row_width = 0, g = row_start; g < row_end; g++)
19489 row_width += g->pixel_width;
19490
19491 /* FIXME: There are various minor display glitches in R2L
19492 rows when only one of the fringes is missing. The
19493 strange condition below produces the least bad effect. */
19494 if ((WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0)
19495 == (WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0)
19496 || WINDOW_RIGHT_FRINGE_WIDTH (it->w) != 0)
19497 stretch_width = window_box_width (it->w, TEXT_AREA);
19498 else
19499 stretch_width = it->last_visible_x - it->first_visible_x;
19500 stretch_width -= row_width;
19501
19502 if (stretch_width > 0)
19503 {
19504 stretch_ascent =
19505 (((it->ascent + it->descent)
19506 * FONT_BASE (font)) / FONT_HEIGHT (font));
19507 saved_pos = it->position;
19508 memset (&it->position, 0, sizeof it->position);
19509 saved_avoid_cursor = it->avoid_cursor_p;
19510 it->avoid_cursor_p = true;
19511 saved_face_id = it->face_id;
19512 saved_box_start = it->start_of_box_run_p;
19513 /* The last row's stretch glyph should get the default
19514 face, to avoid painting the rest of the window with
19515 the region face, if the region ends at ZV. */
19516 if (it->glyph_row->ends_at_zv_p)
19517 it->face_id = default_face->id;
19518 else
19519 it->face_id = face->id;
19520 it->start_of_box_run_p = false;
19521 append_stretch_glyph (it, Qnil, stretch_width,
19522 it->ascent + it->descent, stretch_ascent);
19523 it->position = saved_pos;
19524 it->avoid_cursor_p = saved_avoid_cursor;
19525 it->face_id = saved_face_id;
19526 it->start_of_box_run_p = saved_box_start;
19527 }
19528 /* If stretch_width comes out negative, it means that the
19529 last glyph is only partially visible. In R2L rows, we
19530 want the leftmost glyph to be partially visible, so we
19531 need to give the row the corresponding left offset. */
19532 if (stretch_width < 0)
19533 it->glyph_row->x = stretch_width;
19534 }
19535 #endif /* HAVE_WINDOW_SYSTEM */
19536 }
19537 else
19538 {
19539 /* Save some values that must not be changed. */
19540 int saved_x = it->current_x;
19541 struct text_pos saved_pos;
19542 Lisp_Object saved_object;
19543 enum display_element_type saved_what = it->what;
19544 int saved_face_id = it->face_id;
19545
19546 saved_object = it->object;
19547 saved_pos = it->position;
19548
19549 it->what = IT_CHARACTER;
19550 memset (&it->position, 0, sizeof it->position);
19551 it->object = Qnil;
19552 it->c = it->char_to_display = ' ';
19553 it->len = 1;
19554
19555 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
19556 && (it->glyph_row->used[LEFT_MARGIN_AREA]
19557 < WINDOW_LEFT_MARGIN_WIDTH (it->w))
19558 && !it->glyph_row->mode_line_p
19559 && default_face->background != FRAME_BACKGROUND_PIXEL (f))
19560 {
19561 struct glyph *g = it->glyph_row->glyphs[LEFT_MARGIN_AREA];
19562 struct glyph *e = g + it->glyph_row->used[LEFT_MARGIN_AREA];
19563
19564 for (it->current_x = 0; g < e; g++)
19565 it->current_x += g->pixel_width;
19566
19567 it->area = LEFT_MARGIN_AREA;
19568 it->face_id = default_face->id;
19569 while (it->glyph_row->used[LEFT_MARGIN_AREA]
19570 < WINDOW_LEFT_MARGIN_WIDTH (it->w))
19571 {
19572 PRODUCE_GLYPHS (it);
19573 /* term.c:produce_glyphs advances it->current_x only for
19574 TEXT_AREA. */
19575 it->current_x += it->pixel_width;
19576 }
19577
19578 it->current_x = saved_x;
19579 it->area = TEXT_AREA;
19580 }
19581
19582 /* The last row's blank glyphs should get the default face, to
19583 avoid painting the rest of the window with the region face,
19584 if the region ends at ZV. */
19585 if (it->glyph_row->ends_at_zv_p)
19586 it->face_id = default_face->id;
19587 else
19588 it->face_id = face->id;
19589 PRODUCE_GLYPHS (it);
19590
19591 while (it->current_x <= it->last_visible_x)
19592 PRODUCE_GLYPHS (it);
19593
19594 if (WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0
19595 && (it->glyph_row->used[RIGHT_MARGIN_AREA]
19596 < WINDOW_RIGHT_MARGIN_WIDTH (it->w))
19597 && !it->glyph_row->mode_line_p
19598 && default_face->background != FRAME_BACKGROUND_PIXEL (f))
19599 {
19600 struct glyph *g = it->glyph_row->glyphs[RIGHT_MARGIN_AREA];
19601 struct glyph *e = g + it->glyph_row->used[RIGHT_MARGIN_AREA];
19602
19603 for ( ; g < e; g++)
19604 it->current_x += g->pixel_width;
19605
19606 it->area = RIGHT_MARGIN_AREA;
19607 it->face_id = default_face->id;
19608 while (it->glyph_row->used[RIGHT_MARGIN_AREA]
19609 < WINDOW_RIGHT_MARGIN_WIDTH (it->w))
19610 {
19611 PRODUCE_GLYPHS (it);
19612 it->current_x += it->pixel_width;
19613 }
19614
19615 it->area = TEXT_AREA;
19616 }
19617
19618 /* Don't count these blanks really. It would let us insert a left
19619 truncation glyph below and make us set the cursor on them, maybe. */
19620 it->current_x = saved_x;
19621 it->object = saved_object;
19622 it->position = saved_pos;
19623 it->what = saved_what;
19624 it->face_id = saved_face_id;
19625 }
19626 }
19627
19628
19629 /* Value is true if text starting at CHARPOS in current_buffer is
19630 trailing whitespace. */
19631
19632 static bool
19633 trailing_whitespace_p (ptrdiff_t charpos)
19634 {
19635 ptrdiff_t bytepos = CHAR_TO_BYTE (charpos);
19636 int c = 0;
19637
19638 while (bytepos < ZV_BYTE
19639 && (c = FETCH_CHAR (bytepos),
19640 c == ' ' || c == '\t'))
19641 ++bytepos;
19642
19643 if (bytepos >= ZV_BYTE || c == '\n' || c == '\r')
19644 {
19645 if (bytepos != PT_BYTE)
19646 return true;
19647 }
19648 return false;
19649 }
19650
19651
19652 /* Highlight trailing whitespace, if any, in ROW. */
19653
19654 static void
19655 highlight_trailing_whitespace (struct frame *f, struct glyph_row *row)
19656 {
19657 int used = row->used[TEXT_AREA];
19658
19659 if (used)
19660 {
19661 struct glyph *start = row->glyphs[TEXT_AREA];
19662 struct glyph *glyph = start + used - 1;
19663
19664 if (row->reversed_p)
19665 {
19666 /* Right-to-left rows need to be processed in the opposite
19667 direction, so swap the edge pointers. */
19668 glyph = start;
19669 start = row->glyphs[TEXT_AREA] + used - 1;
19670 }
19671
19672 /* Skip over glyphs inserted to display the cursor at the
19673 end of a line, for extending the face of the last glyph
19674 to the end of the line on terminals, and for truncation
19675 and continuation glyphs. */
19676 if (!row->reversed_p)
19677 {
19678 while (glyph >= start
19679 && glyph->type == CHAR_GLYPH
19680 && NILP (glyph->object))
19681 --glyph;
19682 }
19683 else
19684 {
19685 while (glyph <= start
19686 && glyph->type == CHAR_GLYPH
19687 && NILP (glyph->object))
19688 ++glyph;
19689 }
19690
19691 /* If last glyph is a space or stretch, and it's trailing
19692 whitespace, set the face of all trailing whitespace glyphs in
19693 IT->glyph_row to `trailing-whitespace'. */
19694 if ((row->reversed_p ? glyph <= start : glyph >= start)
19695 && BUFFERP (glyph->object)
19696 && (glyph->type == STRETCH_GLYPH
19697 || (glyph->type == CHAR_GLYPH
19698 && glyph->u.ch == ' '))
19699 && trailing_whitespace_p (glyph->charpos))
19700 {
19701 int face_id = lookup_named_face (f, Qtrailing_whitespace, false);
19702 if (face_id < 0)
19703 return;
19704
19705 if (!row->reversed_p)
19706 {
19707 while (glyph >= start
19708 && BUFFERP (glyph->object)
19709 && (glyph->type == STRETCH_GLYPH
19710 || (glyph->type == CHAR_GLYPH
19711 && glyph->u.ch == ' ')))
19712 (glyph--)->face_id = face_id;
19713 }
19714 else
19715 {
19716 while (glyph <= start
19717 && BUFFERP (glyph->object)
19718 && (glyph->type == STRETCH_GLYPH
19719 || (glyph->type == CHAR_GLYPH
19720 && glyph->u.ch == ' ')))
19721 (glyph++)->face_id = face_id;
19722 }
19723 }
19724 }
19725 }
19726
19727
19728 /* Value is true if glyph row ROW should be
19729 considered to hold the buffer position CHARPOS. */
19730
19731 static bool
19732 row_for_charpos_p (struct glyph_row *row, ptrdiff_t charpos)
19733 {
19734 bool result = true;
19735
19736 if (charpos == CHARPOS (row->end.pos)
19737 || charpos == MATRIX_ROW_END_CHARPOS (row))
19738 {
19739 /* Suppose the row ends on a string.
19740 Unless the row is continued, that means it ends on a newline
19741 in the string. If it's anything other than a display string
19742 (e.g., a before-string from an overlay), we don't want the
19743 cursor there. (This heuristic seems to give the optimal
19744 behavior for the various types of multi-line strings.)
19745 One exception: if the string has `cursor' property on one of
19746 its characters, we _do_ want the cursor there. */
19747 if (CHARPOS (row->end.string_pos) >= 0)
19748 {
19749 if (row->continued_p)
19750 result = true;
19751 else
19752 {
19753 /* Check for `display' property. */
19754 struct glyph *beg = row->glyphs[TEXT_AREA];
19755 struct glyph *end = beg + row->used[TEXT_AREA] - 1;
19756 struct glyph *glyph;
19757
19758 result = false;
19759 for (glyph = end; glyph >= beg; --glyph)
19760 if (STRINGP (glyph->object))
19761 {
19762 Lisp_Object prop
19763 = Fget_char_property (make_number (charpos),
19764 Qdisplay, Qnil);
19765 result =
19766 (!NILP (prop)
19767 && display_prop_string_p (prop, glyph->object));
19768 /* If there's a `cursor' property on one of the
19769 string's characters, this row is a cursor row,
19770 even though this is not a display string. */
19771 if (!result)
19772 {
19773 Lisp_Object s = glyph->object;
19774
19775 for ( ; glyph >= beg && EQ (glyph->object, s); --glyph)
19776 {
19777 ptrdiff_t gpos = glyph->charpos;
19778
19779 if (!NILP (Fget_char_property (make_number (gpos),
19780 Qcursor, s)))
19781 {
19782 result = true;
19783 break;
19784 }
19785 }
19786 }
19787 break;
19788 }
19789 }
19790 }
19791 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row))
19792 {
19793 /* If the row ends in middle of a real character,
19794 and the line is continued, we want the cursor here.
19795 That's because CHARPOS (ROW->end.pos) would equal
19796 PT if PT is before the character. */
19797 if (!row->ends_in_ellipsis_p)
19798 result = row->continued_p;
19799 else
19800 /* If the row ends in an ellipsis, then
19801 CHARPOS (ROW->end.pos) will equal point after the
19802 invisible text. We want that position to be displayed
19803 after the ellipsis. */
19804 result = false;
19805 }
19806 /* If the row ends at ZV, display the cursor at the end of that
19807 row instead of at the start of the row below. */
19808 else
19809 result = row->ends_at_zv_p;
19810 }
19811
19812 return result;
19813 }
19814
19815 /* Value is true if glyph row ROW should be
19816 used to hold the cursor. */
19817
19818 static bool
19819 cursor_row_p (struct glyph_row *row)
19820 {
19821 return row_for_charpos_p (row, PT);
19822 }
19823
19824 \f
19825
19826 /* Push the property PROP so that it will be rendered at the current
19827 position in IT. Return true if PROP was successfully pushed, false
19828 otherwise. Called from handle_line_prefix to handle the
19829 `line-prefix' and `wrap-prefix' properties. */
19830
19831 static bool
19832 push_prefix_prop (struct it *it, Lisp_Object prop)
19833 {
19834 struct text_pos pos =
19835 STRINGP (it->string) ? it->current.string_pos : it->current.pos;
19836
19837 eassert (it->method == GET_FROM_BUFFER
19838 || it->method == GET_FROM_DISPLAY_VECTOR
19839 || it->method == GET_FROM_STRING
19840 || it->method == GET_FROM_IMAGE);
19841
19842 /* We need to save the current buffer/string position, so it will be
19843 restored by pop_it, because iterate_out_of_display_property
19844 depends on that being set correctly, but some situations leave
19845 it->position not yet set when this function is called. */
19846 push_it (it, &pos);
19847
19848 if (STRINGP (prop))
19849 {
19850 if (SCHARS (prop) == 0)
19851 {
19852 pop_it (it);
19853 return false;
19854 }
19855
19856 it->string = prop;
19857 it->string_from_prefix_prop_p = true;
19858 it->multibyte_p = STRING_MULTIBYTE (it->string);
19859 it->current.overlay_string_index = -1;
19860 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = 0;
19861 it->end_charpos = it->string_nchars = SCHARS (it->string);
19862 it->method = GET_FROM_STRING;
19863 it->stop_charpos = 0;
19864 it->prev_stop = 0;
19865 it->base_level_stop = 0;
19866
19867 /* Force paragraph direction to be that of the parent
19868 buffer/string. */
19869 if (it->bidi_p && it->bidi_it.paragraph_dir == R2L)
19870 it->paragraph_embedding = it->bidi_it.paragraph_dir;
19871 else
19872 it->paragraph_embedding = L2R;
19873
19874 /* Set up the bidi iterator for this display string. */
19875 if (it->bidi_p)
19876 {
19877 it->bidi_it.string.lstring = it->string;
19878 it->bidi_it.string.s = NULL;
19879 it->bidi_it.string.schars = it->end_charpos;
19880 it->bidi_it.string.bufpos = IT_CHARPOS (*it);
19881 it->bidi_it.string.from_disp_str = it->string_from_display_prop_p;
19882 it->bidi_it.string.unibyte = !it->multibyte_p;
19883 it->bidi_it.w = it->w;
19884 bidi_init_it (0, 0, FRAME_WINDOW_P (it->f), &it->bidi_it);
19885 }
19886 }
19887 else if (CONSP (prop) && EQ (XCAR (prop), Qspace))
19888 {
19889 it->method = GET_FROM_STRETCH;
19890 it->object = prop;
19891 }
19892 #ifdef HAVE_WINDOW_SYSTEM
19893 else if (IMAGEP (prop))
19894 {
19895 it->what = IT_IMAGE;
19896 it->image_id = lookup_image (it->f, prop);
19897 it->method = GET_FROM_IMAGE;
19898 }
19899 #endif /* HAVE_WINDOW_SYSTEM */
19900 else
19901 {
19902 pop_it (it); /* bogus display property, give up */
19903 return false;
19904 }
19905
19906 return true;
19907 }
19908
19909 /* Return the character-property PROP at the current position in IT. */
19910
19911 static Lisp_Object
19912 get_it_property (struct it *it, Lisp_Object prop)
19913 {
19914 Lisp_Object position, object = it->object;
19915
19916 if (STRINGP (object))
19917 position = make_number (IT_STRING_CHARPOS (*it));
19918 else if (BUFFERP (object))
19919 {
19920 position = make_number (IT_CHARPOS (*it));
19921 object = it->window;
19922 }
19923 else
19924 return Qnil;
19925
19926 return Fget_char_property (position, prop, object);
19927 }
19928
19929 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19930
19931 static void
19932 handle_line_prefix (struct it *it)
19933 {
19934 Lisp_Object prefix;
19935
19936 if (it->continuation_lines_width > 0)
19937 {
19938 prefix = get_it_property (it, Qwrap_prefix);
19939 if (NILP (prefix))
19940 prefix = Vwrap_prefix;
19941 }
19942 else
19943 {
19944 prefix = get_it_property (it, Qline_prefix);
19945 if (NILP (prefix))
19946 prefix = Vline_prefix;
19947 }
19948 if (! NILP (prefix) && push_prefix_prop (it, prefix))
19949 {
19950 /* If the prefix is wider than the window, and we try to wrap
19951 it, it would acquire its own wrap prefix, and so on till the
19952 iterator stack overflows. So, don't wrap the prefix. */
19953 it->line_wrap = TRUNCATE;
19954 it->avoid_cursor_p = true;
19955 }
19956 }
19957
19958 \f
19959
19960 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19961 only for R2L lines from display_line and display_string, when they
19962 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19963 the line/string needs to be continued on the next glyph row. */
19964 static void
19965 unproduce_glyphs (struct it *it, int n)
19966 {
19967 struct glyph *glyph, *end;
19968
19969 eassert (it->glyph_row);
19970 eassert (it->glyph_row->reversed_p);
19971 eassert (it->area == TEXT_AREA);
19972 eassert (n <= it->glyph_row->used[TEXT_AREA]);
19973
19974 if (n > it->glyph_row->used[TEXT_AREA])
19975 n = it->glyph_row->used[TEXT_AREA];
19976 glyph = it->glyph_row->glyphs[TEXT_AREA] + n;
19977 end = it->glyph_row->glyphs[TEXT_AREA] + it->glyph_row->used[TEXT_AREA];
19978 for ( ; glyph < end; glyph++)
19979 glyph[-n] = *glyph;
19980 }
19981
19982 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19983 and ROW->maxpos. */
19984 static void
19985 find_row_edges (struct it *it, struct glyph_row *row,
19986 ptrdiff_t min_pos, ptrdiff_t min_bpos,
19987 ptrdiff_t max_pos, ptrdiff_t max_bpos)
19988 {
19989 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19990 lines' rows is implemented for bidi-reordered rows. */
19991
19992 /* ROW->minpos is the value of min_pos, the minimal buffer position
19993 we have in ROW, or ROW->start.pos if that is smaller. */
19994 if (min_pos <= ZV && min_pos < row->start.pos.charpos)
19995 SET_TEXT_POS (row->minpos, min_pos, min_bpos);
19996 else
19997 /* We didn't find buffer positions smaller than ROW->start, or
19998 didn't find _any_ valid buffer positions in any of the glyphs,
19999 so we must trust the iterator's computed positions. */
20000 row->minpos = row->start.pos;
20001 if (max_pos <= 0)
20002 {
20003 max_pos = CHARPOS (it->current.pos);
20004 max_bpos = BYTEPOS (it->current.pos);
20005 }
20006
20007 /* Here are the various use-cases for ending the row, and the
20008 corresponding values for ROW->maxpos:
20009
20010 Line ends in a newline from buffer eol_pos + 1
20011 Line is continued from buffer max_pos + 1
20012 Line is truncated on right it->current.pos
20013 Line ends in a newline from string max_pos + 1(*)
20014 (*) + 1 only when line ends in a forward scan
20015 Line is continued from string max_pos
20016 Line is continued from display vector max_pos
20017 Line is entirely from a string min_pos == max_pos
20018 Line is entirely from a display vector min_pos == max_pos
20019 Line that ends at ZV ZV
20020
20021 If you discover other use-cases, please add them here as
20022 appropriate. */
20023 if (row->ends_at_zv_p)
20024 row->maxpos = it->current.pos;
20025 else if (row->used[TEXT_AREA])
20026 {
20027 bool seen_this_string = false;
20028 struct glyph_row *r1 = row - 1;
20029
20030 /* Did we see the same display string on the previous row? */
20031 if (STRINGP (it->object)
20032 /* this is not the first row */
20033 && row > it->w->desired_matrix->rows
20034 /* previous row is not the header line */
20035 && !r1->mode_line_p
20036 /* previous row also ends in a newline from a string */
20037 && r1->ends_in_newline_from_string_p)
20038 {
20039 struct glyph *start, *end;
20040
20041 /* Search for the last glyph of the previous row that came
20042 from buffer or string. Depending on whether the row is
20043 L2R or R2L, we need to process it front to back or the
20044 other way round. */
20045 if (!r1->reversed_p)
20046 {
20047 start = r1->glyphs[TEXT_AREA];
20048 end = start + r1->used[TEXT_AREA];
20049 /* Glyphs inserted by redisplay have nil as their object. */
20050 while (end > start
20051 && NILP ((end - 1)->object)
20052 && (end - 1)->charpos <= 0)
20053 --end;
20054 if (end > start)
20055 {
20056 if (EQ ((end - 1)->object, it->object))
20057 seen_this_string = true;
20058 }
20059 else
20060 /* If all the glyphs of the previous row were inserted
20061 by redisplay, it means the previous row was
20062 produced from a single newline, which is only
20063 possible if that newline came from the same string
20064 as the one which produced this ROW. */
20065 seen_this_string = true;
20066 }
20067 else
20068 {
20069 end = r1->glyphs[TEXT_AREA] - 1;
20070 start = end + r1->used[TEXT_AREA];
20071 while (end < start
20072 && NILP ((end + 1)->object)
20073 && (end + 1)->charpos <= 0)
20074 ++end;
20075 if (end < start)
20076 {
20077 if (EQ ((end + 1)->object, it->object))
20078 seen_this_string = true;
20079 }
20080 else
20081 seen_this_string = true;
20082 }
20083 }
20084 /* Take note of each display string that covers a newline only
20085 once, the first time we see it. This is for when a display
20086 string includes more than one newline in it. */
20087 if (row->ends_in_newline_from_string_p && !seen_this_string)
20088 {
20089 /* If we were scanning the buffer forward when we displayed
20090 the string, we want to account for at least one buffer
20091 position that belongs to this row (position covered by
20092 the display string), so that cursor positioning will
20093 consider this row as a candidate when point is at the end
20094 of the visual line represented by this row. This is not
20095 required when scanning back, because max_pos will already
20096 have a much larger value. */
20097 if (CHARPOS (row->end.pos) > max_pos)
20098 INC_BOTH (max_pos, max_bpos);
20099 SET_TEXT_POS (row->maxpos, max_pos, max_bpos);
20100 }
20101 else if (CHARPOS (it->eol_pos) > 0)
20102 SET_TEXT_POS (row->maxpos,
20103 CHARPOS (it->eol_pos) + 1, BYTEPOS (it->eol_pos) + 1);
20104 else if (row->continued_p)
20105 {
20106 /* If max_pos is different from IT's current position, it
20107 means IT->method does not belong to the display element
20108 at max_pos. However, it also means that the display
20109 element at max_pos was displayed in its entirety on this
20110 line, which is equivalent to saying that the next line
20111 starts at the next buffer position. */
20112 if (IT_CHARPOS (*it) == max_pos && it->method != GET_FROM_BUFFER)
20113 SET_TEXT_POS (row->maxpos, max_pos, max_bpos);
20114 else
20115 {
20116 INC_BOTH (max_pos, max_bpos);
20117 SET_TEXT_POS (row->maxpos, max_pos, max_bpos);
20118 }
20119 }
20120 else if (row->truncated_on_right_p)
20121 /* display_line already called reseat_at_next_visible_line_start,
20122 which puts the iterator at the beginning of the next line, in
20123 the logical order. */
20124 row->maxpos = it->current.pos;
20125 else if (max_pos == min_pos && it->method != GET_FROM_BUFFER)
20126 /* A line that is entirely from a string/image/stretch... */
20127 row->maxpos = row->minpos;
20128 else
20129 emacs_abort ();
20130 }
20131 else
20132 row->maxpos = it->current.pos;
20133 }
20134
20135 /* Construct the glyph row IT->glyph_row in the desired matrix of
20136 IT->w from text at the current position of IT. See dispextern.h
20137 for an overview of struct it. Value is true if
20138 IT->glyph_row displays text, as opposed to a line displaying ZV
20139 only. */
20140
20141 static bool
20142 display_line (struct it *it)
20143 {
20144 struct glyph_row *row = it->glyph_row;
20145 Lisp_Object overlay_arrow_string;
20146 struct it wrap_it;
20147 void *wrap_data = NULL;
20148 bool may_wrap = false;
20149 int wrap_x IF_LINT (= 0);
20150 int wrap_row_used = -1;
20151 int wrap_row_ascent IF_LINT (= 0), wrap_row_height IF_LINT (= 0);
20152 int wrap_row_phys_ascent IF_LINT (= 0), wrap_row_phys_height IF_LINT (= 0);
20153 int wrap_row_extra_line_spacing IF_LINT (= 0);
20154 ptrdiff_t wrap_row_min_pos IF_LINT (= 0), wrap_row_min_bpos IF_LINT (= 0);
20155 ptrdiff_t wrap_row_max_pos IF_LINT (= 0), wrap_row_max_bpos IF_LINT (= 0);
20156 int cvpos;
20157 ptrdiff_t min_pos = ZV + 1, max_pos = 0;
20158 ptrdiff_t min_bpos IF_LINT (= 0), max_bpos IF_LINT (= 0);
20159 bool pending_handle_line_prefix = false;
20160
20161 /* We always start displaying at hpos zero even if hscrolled. */
20162 eassert (it->hpos == 0 && it->current_x == 0);
20163
20164 if (MATRIX_ROW_VPOS (row, it->w->desired_matrix)
20165 >= it->w->desired_matrix->nrows)
20166 {
20167 it->w->nrows_scale_factor++;
20168 it->f->fonts_changed = true;
20169 return false;
20170 }
20171
20172 /* Clear the result glyph row and enable it. */
20173 prepare_desired_row (it->w, row, false);
20174
20175 row->y = it->current_y;
20176 row->start = it->start;
20177 row->continuation_lines_width = it->continuation_lines_width;
20178 row->displays_text_p = true;
20179 row->starts_in_middle_of_char_p = it->starts_in_middle_of_char_p;
20180 it->starts_in_middle_of_char_p = false;
20181
20182 /* Arrange the overlays nicely for our purposes. Usually, we call
20183 display_line on only one line at a time, in which case this
20184 can't really hurt too much, or we call it on lines which appear
20185 one after another in the buffer, in which case all calls to
20186 recenter_overlay_lists but the first will be pretty cheap. */
20187 recenter_overlay_lists (current_buffer, IT_CHARPOS (*it));
20188
20189 /* Move over display elements that are not visible because we are
20190 hscrolled. This may stop at an x-position < IT->first_visible_x
20191 if the first glyph is partially visible or if we hit a line end. */
20192 if (it->current_x < it->first_visible_x)
20193 {
20194 enum move_it_result move_result;
20195
20196 this_line_min_pos = row->start.pos;
20197 move_result = move_it_in_display_line_to (it, ZV, it->first_visible_x,
20198 MOVE_TO_POS | MOVE_TO_X);
20199 /* If we are under a large hscroll, move_it_in_display_line_to
20200 could hit the end of the line without reaching
20201 it->first_visible_x. Pretend that we did reach it. This is
20202 especially important on a TTY, where we will call
20203 extend_face_to_end_of_line, which needs to know how many
20204 blank glyphs to produce. */
20205 if (it->current_x < it->first_visible_x
20206 && (move_result == MOVE_NEWLINE_OR_CR
20207 || move_result == MOVE_POS_MATCH_OR_ZV))
20208 it->current_x = it->first_visible_x;
20209
20210 /* Record the smallest positions seen while we moved over
20211 display elements that are not visible. This is needed by
20212 redisplay_internal for optimizing the case where the cursor
20213 stays inside the same line. The rest of this function only
20214 considers positions that are actually displayed, so
20215 RECORD_MAX_MIN_POS will not otherwise record positions that
20216 are hscrolled to the left of the left edge of the window. */
20217 min_pos = CHARPOS (this_line_min_pos);
20218 min_bpos = BYTEPOS (this_line_min_pos);
20219 }
20220 else if (it->area == TEXT_AREA)
20221 {
20222 /* We only do this when not calling move_it_in_display_line_to
20223 above, because that function calls itself handle_line_prefix. */
20224 handle_line_prefix (it);
20225 }
20226 else
20227 {
20228 /* Line-prefix and wrap-prefix are always displayed in the text
20229 area. But if this is the first call to display_line after
20230 init_iterator, the iterator might have been set up to write
20231 into a marginal area, e.g. if the line begins with some
20232 display property that writes to the margins. So we need to
20233 wait with the call to handle_line_prefix until whatever
20234 writes to the margin has done its job. */
20235 pending_handle_line_prefix = true;
20236 }
20237
20238 /* Get the initial row height. This is either the height of the
20239 text hscrolled, if there is any, or zero. */
20240 row->ascent = it->max_ascent;
20241 row->height = it->max_ascent + it->max_descent;
20242 row->phys_ascent = it->max_phys_ascent;
20243 row->phys_height = it->max_phys_ascent + it->max_phys_descent;
20244 row->extra_line_spacing = it->max_extra_line_spacing;
20245
20246 /* Utility macro to record max and min buffer positions seen until now. */
20247 #define RECORD_MAX_MIN_POS(IT) \
20248 do \
20249 { \
20250 bool composition_p \
20251 = !STRINGP ((IT)->string) && ((IT)->what == IT_COMPOSITION); \
20252 ptrdiff_t current_pos = \
20253 composition_p ? (IT)->cmp_it.charpos \
20254 : IT_CHARPOS (*(IT)); \
20255 ptrdiff_t current_bpos = \
20256 composition_p ? CHAR_TO_BYTE (current_pos) \
20257 : IT_BYTEPOS (*(IT)); \
20258 if (current_pos < min_pos) \
20259 { \
20260 min_pos = current_pos; \
20261 min_bpos = current_bpos; \
20262 } \
20263 if (IT_CHARPOS (*it) > max_pos) \
20264 { \
20265 max_pos = IT_CHARPOS (*it); \
20266 max_bpos = IT_BYTEPOS (*it); \
20267 } \
20268 } \
20269 while (false)
20270
20271 /* Loop generating characters. The loop is left with IT on the next
20272 character to display. */
20273 while (true)
20274 {
20275 int n_glyphs_before, hpos_before, x_before;
20276 int x, nglyphs;
20277 int ascent = 0, descent = 0, phys_ascent = 0, phys_descent = 0;
20278
20279 /* Retrieve the next thing to display. Value is false if end of
20280 buffer reached. */
20281 if (!get_next_display_element (it))
20282 {
20283 /* Maybe add a space at the end of this line that is used to
20284 display the cursor there under X. Set the charpos of the
20285 first glyph of blank lines not corresponding to any text
20286 to -1. */
20287 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
20288 row->exact_window_width_line_p = true;
20289 else if ((append_space_for_newline (it, true)
20290 && row->used[TEXT_AREA] == 1)
20291 || row->used[TEXT_AREA] == 0)
20292 {
20293 row->glyphs[TEXT_AREA]->charpos = -1;
20294 row->displays_text_p = false;
20295
20296 if (!NILP (BVAR (XBUFFER (it->w->contents), indicate_empty_lines))
20297 && (!MINI_WINDOW_P (it->w)
20298 || (minibuf_level && EQ (it->window, minibuf_window))))
20299 row->indicate_empty_line_p = true;
20300 }
20301
20302 it->continuation_lines_width = 0;
20303 row->ends_at_zv_p = true;
20304 /* A row that displays right-to-left text must always have
20305 its last face extended all the way to the end of line,
20306 even if this row ends in ZV, because we still write to
20307 the screen left to right. We also need to extend the
20308 last face if the default face is remapped to some
20309 different face, otherwise the functions that clear
20310 portions of the screen will clear with the default face's
20311 background color. */
20312 if (row->reversed_p
20313 || lookup_basic_face (it->f, DEFAULT_FACE_ID) != DEFAULT_FACE_ID)
20314 extend_face_to_end_of_line (it);
20315 break;
20316 }
20317
20318 /* Now, get the metrics of what we want to display. This also
20319 generates glyphs in `row' (which is IT->glyph_row). */
20320 n_glyphs_before = row->used[TEXT_AREA];
20321 x = it->current_x;
20322
20323 /* Remember the line height so far in case the next element doesn't
20324 fit on the line. */
20325 if (it->line_wrap != TRUNCATE)
20326 {
20327 ascent = it->max_ascent;
20328 descent = it->max_descent;
20329 phys_ascent = it->max_phys_ascent;
20330 phys_descent = it->max_phys_descent;
20331
20332 if (it->line_wrap == WORD_WRAP && it->area == TEXT_AREA)
20333 {
20334 if (IT_DISPLAYING_WHITESPACE (it))
20335 may_wrap = true;
20336 else if (may_wrap)
20337 {
20338 SAVE_IT (wrap_it, *it, wrap_data);
20339 wrap_x = x;
20340 wrap_row_used = row->used[TEXT_AREA];
20341 wrap_row_ascent = row->ascent;
20342 wrap_row_height = row->height;
20343 wrap_row_phys_ascent = row->phys_ascent;
20344 wrap_row_phys_height = row->phys_height;
20345 wrap_row_extra_line_spacing = row->extra_line_spacing;
20346 wrap_row_min_pos = min_pos;
20347 wrap_row_min_bpos = min_bpos;
20348 wrap_row_max_pos = max_pos;
20349 wrap_row_max_bpos = max_bpos;
20350 may_wrap = false;
20351 }
20352 }
20353 }
20354
20355 PRODUCE_GLYPHS (it);
20356
20357 /* If this display element was in marginal areas, continue with
20358 the next one. */
20359 if (it->area != TEXT_AREA)
20360 {
20361 row->ascent = max (row->ascent, it->max_ascent);
20362 row->height = max (row->height, it->max_ascent + it->max_descent);
20363 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
20364 row->phys_height = max (row->phys_height,
20365 it->max_phys_ascent + it->max_phys_descent);
20366 row->extra_line_spacing = max (row->extra_line_spacing,
20367 it->max_extra_line_spacing);
20368 set_iterator_to_next (it, true);
20369 /* If we didn't handle the line/wrap prefix above, and the
20370 call to set_iterator_to_next just switched to TEXT_AREA,
20371 process the prefix now. */
20372 if (it->area == TEXT_AREA && pending_handle_line_prefix)
20373 {
20374 pending_handle_line_prefix = false;
20375 handle_line_prefix (it);
20376 }
20377 continue;
20378 }
20379
20380 /* Does the display element fit on the line? If we truncate
20381 lines, we should draw past the right edge of the window. If
20382 we don't truncate, we want to stop so that we can display the
20383 continuation glyph before the right margin. If lines are
20384 continued, there are two possible strategies for characters
20385 resulting in more than 1 glyph (e.g. tabs): Display as many
20386 glyphs as possible in this line and leave the rest for the
20387 continuation line, or display the whole element in the next
20388 line. Original redisplay did the former, so we do it also. */
20389 nglyphs = row->used[TEXT_AREA] - n_glyphs_before;
20390 hpos_before = it->hpos;
20391 x_before = x;
20392
20393 if (/* Not a newline. */
20394 nglyphs > 0
20395 /* Glyphs produced fit entirely in the line. */
20396 && it->current_x < it->last_visible_x)
20397 {
20398 it->hpos += nglyphs;
20399 row->ascent = max (row->ascent, it->max_ascent);
20400 row->height = max (row->height, it->max_ascent + it->max_descent);
20401 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
20402 row->phys_height = max (row->phys_height,
20403 it->max_phys_ascent + it->max_phys_descent);
20404 row->extra_line_spacing = max (row->extra_line_spacing,
20405 it->max_extra_line_spacing);
20406 if (it->current_x - it->pixel_width < it->first_visible_x
20407 /* In R2L rows, we arrange in extend_face_to_end_of_line
20408 to add a right offset to the line, by a suitable
20409 change to the stretch glyph that is the leftmost
20410 glyph of the line. */
20411 && !row->reversed_p)
20412 row->x = x - it->first_visible_x;
20413 /* Record the maximum and minimum buffer positions seen so
20414 far in glyphs that will be displayed by this row. */
20415 if (it->bidi_p)
20416 RECORD_MAX_MIN_POS (it);
20417 }
20418 else
20419 {
20420 int i, new_x;
20421 struct glyph *glyph;
20422
20423 for (i = 0; i < nglyphs; ++i, x = new_x)
20424 {
20425 /* Identify the glyphs added by the last call to
20426 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20427 the previous glyphs. */
20428 if (!row->reversed_p)
20429 glyph = row->glyphs[TEXT_AREA] + n_glyphs_before + i;
20430 else
20431 glyph = row->glyphs[TEXT_AREA] + nglyphs - 1 - i;
20432 new_x = x + glyph->pixel_width;
20433
20434 if (/* Lines are continued. */
20435 it->line_wrap != TRUNCATE
20436 && (/* Glyph doesn't fit on the line. */
20437 new_x > it->last_visible_x
20438 /* Or it fits exactly on a window system frame. */
20439 || (new_x == it->last_visible_x
20440 && FRAME_WINDOW_P (it->f)
20441 && (row->reversed_p
20442 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20443 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)))))
20444 {
20445 /* End of a continued line. */
20446
20447 if (it->hpos == 0
20448 || (new_x == it->last_visible_x
20449 && FRAME_WINDOW_P (it->f)
20450 && (row->reversed_p
20451 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20452 : WINDOW_RIGHT_FRINGE_WIDTH (it->w))))
20453 {
20454 /* Current glyph is the only one on the line or
20455 fits exactly on the line. We must continue
20456 the line because we can't draw the cursor
20457 after the glyph. */
20458 row->continued_p = true;
20459 it->current_x = new_x;
20460 it->continuation_lines_width += new_x;
20461 ++it->hpos;
20462 if (i == nglyphs - 1)
20463 {
20464 /* If line-wrap is on, check if a previous
20465 wrap point was found. */
20466 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it)
20467 && wrap_row_used > 0
20468 /* Even if there is a previous wrap
20469 point, continue the line here as
20470 usual, if (i) the previous character
20471 was a space or tab AND (ii) the
20472 current character is not. */
20473 && (!may_wrap
20474 || IT_DISPLAYING_WHITESPACE (it)))
20475 goto back_to_wrap;
20476
20477 /* Record the maximum and minimum buffer
20478 positions seen so far in glyphs that will be
20479 displayed by this row. */
20480 if (it->bidi_p)
20481 RECORD_MAX_MIN_POS (it);
20482 set_iterator_to_next (it, true);
20483 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
20484 {
20485 if (!get_next_display_element (it))
20486 {
20487 row->exact_window_width_line_p = true;
20488 it->continuation_lines_width = 0;
20489 row->continued_p = false;
20490 row->ends_at_zv_p = true;
20491 }
20492 else if (ITERATOR_AT_END_OF_LINE_P (it))
20493 {
20494 row->continued_p = false;
20495 row->exact_window_width_line_p = true;
20496 }
20497 /* If line-wrap is on, check if a
20498 previous wrap point was found. */
20499 else if (wrap_row_used > 0
20500 /* Even if there is a previous wrap
20501 point, continue the line here as
20502 usual, if (i) the previous character
20503 was a space or tab AND (ii) the
20504 current character is not. */
20505 && (!may_wrap
20506 || IT_DISPLAYING_WHITESPACE (it)))
20507 goto back_to_wrap;
20508
20509 }
20510 }
20511 else if (it->bidi_p)
20512 RECORD_MAX_MIN_POS (it);
20513 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
20514 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0)
20515 extend_face_to_end_of_line (it);
20516 }
20517 else if (CHAR_GLYPH_PADDING_P (*glyph)
20518 && !FRAME_WINDOW_P (it->f))
20519 {
20520 /* A padding glyph that doesn't fit on this line.
20521 This means the whole character doesn't fit
20522 on the line. */
20523 if (row->reversed_p)
20524 unproduce_glyphs (it, row->used[TEXT_AREA]
20525 - n_glyphs_before);
20526 row->used[TEXT_AREA] = n_glyphs_before;
20527
20528 /* Fill the rest of the row with continuation
20529 glyphs like in 20.x. */
20530 while (row->glyphs[TEXT_AREA] + row->used[TEXT_AREA]
20531 < row->glyphs[1 + TEXT_AREA])
20532 produce_special_glyphs (it, IT_CONTINUATION);
20533
20534 row->continued_p = true;
20535 it->current_x = x_before;
20536 it->continuation_lines_width += x_before;
20537
20538 /* Restore the height to what it was before the
20539 element not fitting on the line. */
20540 it->max_ascent = ascent;
20541 it->max_descent = descent;
20542 it->max_phys_ascent = phys_ascent;
20543 it->max_phys_descent = phys_descent;
20544 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
20545 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0)
20546 extend_face_to_end_of_line (it);
20547 }
20548 else if (wrap_row_used > 0)
20549 {
20550 back_to_wrap:
20551 if (row->reversed_p)
20552 unproduce_glyphs (it,
20553 row->used[TEXT_AREA] - wrap_row_used);
20554 RESTORE_IT (it, &wrap_it, wrap_data);
20555 it->continuation_lines_width += wrap_x;
20556 row->used[TEXT_AREA] = wrap_row_used;
20557 row->ascent = wrap_row_ascent;
20558 row->height = wrap_row_height;
20559 row->phys_ascent = wrap_row_phys_ascent;
20560 row->phys_height = wrap_row_phys_height;
20561 row->extra_line_spacing = wrap_row_extra_line_spacing;
20562 min_pos = wrap_row_min_pos;
20563 min_bpos = wrap_row_min_bpos;
20564 max_pos = wrap_row_max_pos;
20565 max_bpos = wrap_row_max_bpos;
20566 row->continued_p = true;
20567 row->ends_at_zv_p = false;
20568 row->exact_window_width_line_p = false;
20569 it->continuation_lines_width += x;
20570
20571 /* Make sure that a non-default face is extended
20572 up to the right margin of the window. */
20573 extend_face_to_end_of_line (it);
20574 }
20575 else if (it->c == '\t' && FRAME_WINDOW_P (it->f))
20576 {
20577 /* A TAB that extends past the right edge of the
20578 window. This produces a single glyph on
20579 window system frames. We leave the glyph in
20580 this row and let it fill the row, but don't
20581 consume the TAB. */
20582 if ((row->reversed_p
20583 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20584 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0)
20585 produce_special_glyphs (it, IT_CONTINUATION);
20586 it->continuation_lines_width += it->last_visible_x;
20587 row->ends_in_middle_of_char_p = true;
20588 row->continued_p = true;
20589 glyph->pixel_width = it->last_visible_x - x;
20590 it->starts_in_middle_of_char_p = true;
20591 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
20592 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0)
20593 extend_face_to_end_of_line (it);
20594 }
20595 else
20596 {
20597 /* Something other than a TAB that draws past
20598 the right edge of the window. Restore
20599 positions to values before the element. */
20600 if (row->reversed_p)
20601 unproduce_glyphs (it, row->used[TEXT_AREA]
20602 - (n_glyphs_before + i));
20603 row->used[TEXT_AREA] = n_glyphs_before + i;
20604
20605 /* Display continuation glyphs. */
20606 it->current_x = x_before;
20607 it->continuation_lines_width += x;
20608 if (!FRAME_WINDOW_P (it->f)
20609 || (row->reversed_p
20610 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20611 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0)
20612 produce_special_glyphs (it, IT_CONTINUATION);
20613 row->continued_p = true;
20614
20615 extend_face_to_end_of_line (it);
20616
20617 if (nglyphs > 1 && i > 0)
20618 {
20619 row->ends_in_middle_of_char_p = true;
20620 it->starts_in_middle_of_char_p = true;
20621 }
20622
20623 /* Restore the height to what it was before the
20624 element not fitting on the line. */
20625 it->max_ascent = ascent;
20626 it->max_descent = descent;
20627 it->max_phys_ascent = phys_ascent;
20628 it->max_phys_descent = phys_descent;
20629 }
20630
20631 break;
20632 }
20633 else if (new_x > it->first_visible_x)
20634 {
20635 /* Increment number of glyphs actually displayed. */
20636 ++it->hpos;
20637
20638 /* Record the maximum and minimum buffer positions
20639 seen so far in glyphs that will be displayed by
20640 this row. */
20641 if (it->bidi_p)
20642 RECORD_MAX_MIN_POS (it);
20643
20644 if (x < it->first_visible_x && !row->reversed_p)
20645 /* Glyph is partially visible, i.e. row starts at
20646 negative X position. Don't do that in R2L
20647 rows, where we arrange to add a right offset to
20648 the line in extend_face_to_end_of_line, by a
20649 suitable change to the stretch glyph that is
20650 the leftmost glyph of the line. */
20651 row->x = x - it->first_visible_x;
20652 /* When the last glyph of an R2L row only fits
20653 partially on the line, we need to set row->x to a
20654 negative offset, so that the leftmost glyph is
20655 the one that is partially visible. But if we are
20656 going to produce the truncation glyph, this will
20657 be taken care of in produce_special_glyphs. */
20658 if (row->reversed_p
20659 && new_x > it->last_visible_x
20660 && !(it->line_wrap == TRUNCATE
20661 && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0))
20662 {
20663 eassert (FRAME_WINDOW_P (it->f));
20664 row->x = it->last_visible_x - new_x;
20665 }
20666 }
20667 else
20668 {
20669 /* Glyph is completely off the left margin of the
20670 window. This should not happen because of the
20671 move_it_in_display_line at the start of this
20672 function, unless the text display area of the
20673 window is empty. */
20674 eassert (it->first_visible_x <= it->last_visible_x);
20675 }
20676 }
20677 /* Even if this display element produced no glyphs at all,
20678 we want to record its position. */
20679 if (it->bidi_p && nglyphs == 0)
20680 RECORD_MAX_MIN_POS (it);
20681
20682 row->ascent = max (row->ascent, it->max_ascent);
20683 row->height = max (row->height, it->max_ascent + it->max_descent);
20684 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
20685 row->phys_height = max (row->phys_height,
20686 it->max_phys_ascent + it->max_phys_descent);
20687 row->extra_line_spacing = max (row->extra_line_spacing,
20688 it->max_extra_line_spacing);
20689
20690 /* End of this display line if row is continued. */
20691 if (row->continued_p || row->ends_at_zv_p)
20692 break;
20693 }
20694
20695 at_end_of_line:
20696 /* Is this a line end? If yes, we're also done, after making
20697 sure that a non-default face is extended up to the right
20698 margin of the window. */
20699 if (ITERATOR_AT_END_OF_LINE_P (it))
20700 {
20701 int used_before = row->used[TEXT_AREA];
20702
20703 row->ends_in_newline_from_string_p = STRINGP (it->object);
20704
20705 /* Add a space at the end of the line that is used to
20706 display the cursor there. */
20707 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
20708 append_space_for_newline (it, false);
20709
20710 /* Extend the face to the end of the line. */
20711 extend_face_to_end_of_line (it);
20712
20713 /* Make sure we have the position. */
20714 if (used_before == 0)
20715 row->glyphs[TEXT_AREA]->charpos = CHARPOS (it->position);
20716
20717 /* Record the position of the newline, for use in
20718 find_row_edges. */
20719 it->eol_pos = it->current.pos;
20720
20721 /* Consume the line end. This skips over invisible lines. */
20722 set_iterator_to_next (it, true);
20723 it->continuation_lines_width = 0;
20724 break;
20725 }
20726
20727 /* Proceed with next display element. Note that this skips
20728 over lines invisible because of selective display. */
20729 set_iterator_to_next (it, true);
20730
20731 /* If we truncate lines, we are done when the last displayed
20732 glyphs reach past the right margin of the window. */
20733 if (it->line_wrap == TRUNCATE
20734 && ((FRAME_WINDOW_P (it->f)
20735 /* Images are preprocessed in produce_image_glyph such
20736 that they are cropped at the right edge of the
20737 window, so an image glyph will always end exactly at
20738 last_visible_x, even if there's no right fringe. */
20739 && ((row->reversed_p
20740 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20741 : WINDOW_RIGHT_FRINGE_WIDTH (it->w))
20742 || it->what == IT_IMAGE))
20743 ? (it->current_x >= it->last_visible_x)
20744 : (it->current_x > it->last_visible_x)))
20745 {
20746 /* Maybe add truncation glyphs. */
20747 if (!FRAME_WINDOW_P (it->f)
20748 || (row->reversed_p
20749 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20750 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0)
20751 {
20752 int i, n;
20753
20754 if (!row->reversed_p)
20755 {
20756 for (i = row->used[TEXT_AREA] - 1; i > 0; --i)
20757 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][i]))
20758 break;
20759 }
20760 else
20761 {
20762 for (i = 0; i < row->used[TEXT_AREA]; i++)
20763 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][i]))
20764 break;
20765 /* Remove any padding glyphs at the front of ROW, to
20766 make room for the truncation glyphs we will be
20767 adding below. The loop below always inserts at
20768 least one truncation glyph, so also remove the
20769 last glyph added to ROW. */
20770 unproduce_glyphs (it, i + 1);
20771 /* Adjust i for the loop below. */
20772 i = row->used[TEXT_AREA] - (i + 1);
20773 }
20774
20775 /* produce_special_glyphs overwrites the last glyph, so
20776 we don't want that if we want to keep that last
20777 glyph, which means it's an image. */
20778 if (it->current_x > it->last_visible_x)
20779 {
20780 it->current_x = x_before;
20781 if (!FRAME_WINDOW_P (it->f))
20782 {
20783 for (n = row->used[TEXT_AREA]; i < n; ++i)
20784 {
20785 row->used[TEXT_AREA] = i;
20786 produce_special_glyphs (it, IT_TRUNCATION);
20787 }
20788 }
20789 else
20790 {
20791 row->used[TEXT_AREA] = i;
20792 produce_special_glyphs (it, IT_TRUNCATION);
20793 }
20794 it->hpos = hpos_before;
20795 }
20796 }
20797 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
20798 {
20799 /* Don't truncate if we can overflow newline into fringe. */
20800 if (!get_next_display_element (it))
20801 {
20802 it->continuation_lines_width = 0;
20803 row->ends_at_zv_p = true;
20804 row->exact_window_width_line_p = true;
20805 break;
20806 }
20807 if (ITERATOR_AT_END_OF_LINE_P (it))
20808 {
20809 row->exact_window_width_line_p = true;
20810 goto at_end_of_line;
20811 }
20812 it->current_x = x_before;
20813 it->hpos = hpos_before;
20814 }
20815
20816 row->truncated_on_right_p = true;
20817 it->continuation_lines_width = 0;
20818 reseat_at_next_visible_line_start (it, false);
20819 /* We insist below that IT's position be at ZV because in
20820 bidi-reordered lines the character at visible line start
20821 might not be the character that follows the newline in
20822 the logical order. */
20823 if (IT_BYTEPOS (*it) > BEG_BYTE)
20824 row->ends_at_zv_p =
20825 IT_BYTEPOS (*it) >= ZV_BYTE && FETCH_BYTE (ZV_BYTE - 1) != '\n';
20826 else
20827 row->ends_at_zv_p = false;
20828 break;
20829 }
20830 }
20831
20832 if (wrap_data)
20833 bidi_unshelve_cache (wrap_data, true);
20834
20835 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20836 at the left window margin. */
20837 if (it->first_visible_x
20838 && IT_CHARPOS (*it) != CHARPOS (row->start.pos))
20839 {
20840 if (!FRAME_WINDOW_P (it->f)
20841 || (((row->reversed_p
20842 ? WINDOW_RIGHT_FRINGE_WIDTH (it->w)
20843 : WINDOW_LEFT_FRINGE_WIDTH (it->w)) == 0)
20844 /* Don't let insert_left_trunc_glyphs overwrite the
20845 first glyph of the row if it is an image. */
20846 && row->glyphs[TEXT_AREA]->type != IMAGE_GLYPH))
20847 insert_left_trunc_glyphs (it);
20848 row->truncated_on_left_p = true;
20849 }
20850
20851 /* Remember the position at which this line ends.
20852
20853 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20854 cannot be before the call to find_row_edges below, since that is
20855 where these positions are determined. */
20856 row->end = it->current;
20857 if (!it->bidi_p)
20858 {
20859 row->minpos = row->start.pos;
20860 row->maxpos = row->end.pos;
20861 }
20862 else
20863 {
20864 /* ROW->minpos and ROW->maxpos must be the smallest and
20865 `1 + the largest' buffer positions in ROW. But if ROW was
20866 bidi-reordered, these two positions can be anywhere in the
20867 row, so we must determine them now. */
20868 find_row_edges (it, row, min_pos, min_bpos, max_pos, max_bpos);
20869 }
20870
20871 /* If the start of this line is the overlay arrow-position, then
20872 mark this glyph row as the one containing the overlay arrow.
20873 This is clearly a mess with variable size fonts. It would be
20874 better to let it be displayed like cursors under X. */
20875 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row) || !overlay_arrow_seen)
20876 && (overlay_arrow_string = overlay_arrow_at_row (it, row),
20877 !NILP (overlay_arrow_string)))
20878 {
20879 /* Overlay arrow in window redisplay is a fringe bitmap. */
20880 if (STRINGP (overlay_arrow_string))
20881 {
20882 struct glyph_row *arrow_row
20883 = get_overlay_arrow_glyph_row (it->w, overlay_arrow_string);
20884 struct glyph *glyph = arrow_row->glyphs[TEXT_AREA];
20885 struct glyph *arrow_end = glyph + arrow_row->used[TEXT_AREA];
20886 struct glyph *p = row->glyphs[TEXT_AREA];
20887 struct glyph *p2, *end;
20888
20889 /* Copy the arrow glyphs. */
20890 while (glyph < arrow_end)
20891 *p++ = *glyph++;
20892
20893 /* Throw away padding glyphs. */
20894 p2 = p;
20895 end = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA];
20896 while (p2 < end && CHAR_GLYPH_PADDING_P (*p2))
20897 ++p2;
20898 if (p2 > p)
20899 {
20900 while (p2 < end)
20901 *p++ = *p2++;
20902 row->used[TEXT_AREA] = p2 - row->glyphs[TEXT_AREA];
20903 }
20904 }
20905 else
20906 {
20907 eassert (INTEGERP (overlay_arrow_string));
20908 row->overlay_arrow_bitmap = XINT (overlay_arrow_string);
20909 }
20910 overlay_arrow_seen = true;
20911 }
20912
20913 /* Highlight trailing whitespace. */
20914 if (!NILP (Vshow_trailing_whitespace))
20915 highlight_trailing_whitespace (it->f, it->glyph_row);
20916
20917 /* Compute pixel dimensions of this line. */
20918 compute_line_metrics (it);
20919
20920 /* Implementation note: No changes in the glyphs of ROW or in their
20921 faces can be done past this point, because compute_line_metrics
20922 computes ROW's hash value and stores it within the glyph_row
20923 structure. */
20924
20925 /* Record whether this row ends inside an ellipsis. */
20926 row->ends_in_ellipsis_p
20927 = (it->method == GET_FROM_DISPLAY_VECTOR
20928 && it->ellipsis_p);
20929
20930 /* Save fringe bitmaps in this row. */
20931 row->left_user_fringe_bitmap = it->left_user_fringe_bitmap;
20932 row->left_user_fringe_face_id = it->left_user_fringe_face_id;
20933 row->right_user_fringe_bitmap = it->right_user_fringe_bitmap;
20934 row->right_user_fringe_face_id = it->right_user_fringe_face_id;
20935
20936 it->left_user_fringe_bitmap = 0;
20937 it->left_user_fringe_face_id = 0;
20938 it->right_user_fringe_bitmap = 0;
20939 it->right_user_fringe_face_id = 0;
20940
20941 /* Maybe set the cursor. */
20942 cvpos = it->w->cursor.vpos;
20943 if ((cvpos < 0
20944 /* In bidi-reordered rows, keep checking for proper cursor
20945 position even if one has been found already, because buffer
20946 positions in such rows change non-linearly with ROW->VPOS,
20947 when a line is continued. One exception: when we are at ZV,
20948 display cursor on the first suitable glyph row, since all
20949 the empty rows after that also have their position set to ZV. */
20950 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20951 lines' rows is implemented for bidi-reordered rows. */
20952 || (it->bidi_p
20953 && !MATRIX_ROW (it->w->desired_matrix, cvpos)->ends_at_zv_p))
20954 && PT >= MATRIX_ROW_START_CHARPOS (row)
20955 && PT <= MATRIX_ROW_END_CHARPOS (row)
20956 && cursor_row_p (row))
20957 set_cursor_from_row (it->w, row, it->w->desired_matrix, 0, 0, 0, 0);
20958
20959 /* Prepare for the next line. This line starts horizontally at (X
20960 HPOS) = (0 0). Vertical positions are incremented. As a
20961 convenience for the caller, IT->glyph_row is set to the next
20962 row to be used. */
20963 it->current_x = it->hpos = 0;
20964 it->current_y += row->height;
20965 SET_TEXT_POS (it->eol_pos, 0, 0);
20966 ++it->vpos;
20967 ++it->glyph_row;
20968 /* The next row should by default use the same value of the
20969 reversed_p flag as this one. set_iterator_to_next decides when
20970 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20971 the flag accordingly. */
20972 if (it->glyph_row < MATRIX_BOTTOM_TEXT_ROW (it->w->desired_matrix, it->w))
20973 it->glyph_row->reversed_p = row->reversed_p;
20974 it->start = row->end;
20975 return MATRIX_ROW_DISPLAYS_TEXT_P (row);
20976
20977 #undef RECORD_MAX_MIN_POS
20978 }
20979
20980 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction,
20981 Scurrent_bidi_paragraph_direction, 0, 1, 0,
20982 doc: /* Return paragraph direction at point in BUFFER.
20983 Value is either `left-to-right' or `right-to-left'.
20984 If BUFFER is omitted or nil, it defaults to the current buffer.
20985
20986 Paragraph direction determines how the text in the paragraph is displayed.
20987 In left-to-right paragraphs, text begins at the left margin of the window
20988 and the reading direction is generally left to right. In right-to-left
20989 paragraphs, text begins at the right margin and is read from right to left.
20990
20991 See also `bidi-paragraph-direction'. */)
20992 (Lisp_Object buffer)
20993 {
20994 struct buffer *buf = current_buffer;
20995 struct buffer *old = buf;
20996
20997 if (! NILP (buffer))
20998 {
20999 CHECK_BUFFER (buffer);
21000 buf = XBUFFER (buffer);
21001 }
21002
21003 if (NILP (BVAR (buf, bidi_display_reordering))
21004 || NILP (BVAR (buf, enable_multibyte_characters))
21005 /* When we are loading loadup.el, the character property tables
21006 needed for bidi iteration are not yet available. */
21007 || !NILP (Vpurify_flag))
21008 return Qleft_to_right;
21009 else if (!NILP (BVAR (buf, bidi_paragraph_direction)))
21010 return BVAR (buf, bidi_paragraph_direction);
21011 else
21012 {
21013 /* Determine the direction from buffer text. We could try to
21014 use current_matrix if it is up to date, but this seems fast
21015 enough as it is. */
21016 struct bidi_it itb;
21017 ptrdiff_t pos = BUF_PT (buf);
21018 ptrdiff_t bytepos = BUF_PT_BYTE (buf);
21019 int c;
21020 void *itb_data = bidi_shelve_cache ();
21021
21022 set_buffer_temp (buf);
21023 /* bidi_paragraph_init finds the base direction of the paragraph
21024 by searching forward from paragraph start. We need the base
21025 direction of the current or _previous_ paragraph, so we need
21026 to make sure we are within that paragraph. To that end, find
21027 the previous non-empty line. */
21028 if (pos >= ZV && pos > BEGV)
21029 DEC_BOTH (pos, bytepos);
21030 AUTO_STRING (trailing_white_space, "[\f\t ]*\n");
21031 if (fast_looking_at (trailing_white_space,
21032 pos, bytepos, ZV, ZV_BYTE, Qnil) > 0)
21033 {
21034 while ((c = FETCH_BYTE (bytepos)) == '\n'
21035 || c == ' ' || c == '\t' || c == '\f')
21036 {
21037 if (bytepos <= BEGV_BYTE)
21038 break;
21039 bytepos--;
21040 pos--;
21041 }
21042 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos)))
21043 bytepos--;
21044 }
21045 bidi_init_it (pos, bytepos, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb);
21046 itb.paragraph_dir = NEUTRAL_DIR;
21047 itb.string.s = NULL;
21048 itb.string.lstring = Qnil;
21049 itb.string.bufpos = 0;
21050 itb.string.from_disp_str = false;
21051 itb.string.unibyte = false;
21052 /* We have no window to use here for ignoring window-specific
21053 overlays. Using NULL for window pointer will cause
21054 compute_display_string_pos to use the current buffer. */
21055 itb.w = NULL;
21056 bidi_paragraph_init (NEUTRAL_DIR, &itb, true);
21057 bidi_unshelve_cache (itb_data, false);
21058 set_buffer_temp (old);
21059 switch (itb.paragraph_dir)
21060 {
21061 case L2R:
21062 return Qleft_to_right;
21063 break;
21064 case R2L:
21065 return Qright_to_left;
21066 break;
21067 default:
21068 emacs_abort ();
21069 }
21070 }
21071 }
21072
21073 DEFUN ("bidi-find-overridden-directionality",
21074 Fbidi_find_overridden_directionality,
21075 Sbidi_find_overridden_directionality, 2, 3, 0,
21076 doc: /* Return position between FROM and TO where directionality was overridden.
21077
21078 This function returns the first character position in the specified
21079 region of OBJECT where there is a character whose `bidi-class' property
21080 is `L', but which was forced to display as `R' by a directional
21081 override, and likewise with characters whose `bidi-class' is `R'
21082 or `AL' that were forced to display as `L'.
21083
21084 If no such character is found, the function returns nil.
21085
21086 OBJECT is a Lisp string or buffer to search for overridden
21087 directionality, and defaults to the current buffer if nil or omitted.
21088 OBJECT can also be a window, in which case the function will search
21089 the buffer displayed in that window. Passing the window instead of
21090 a buffer is preferable when the buffer is displayed in some window,
21091 because this function will then be able to correctly account for
21092 window-specific overlays, which can affect the results.
21093
21094 Strong directional characters `L', `R', and `AL' can have their
21095 intrinsic directionality overridden by directional override
21096 control characters RLO (u+202e) and LRO (u+202d). See the
21097 function `get-char-code-property' for a way to inquire about
21098 the `bidi-class' property of a character. */)
21099 (Lisp_Object from, Lisp_Object to, Lisp_Object object)
21100 {
21101 struct buffer *buf = current_buffer;
21102 struct buffer *old = buf;
21103 struct window *w = NULL;
21104 bool frame_window_p = FRAME_WINDOW_P (SELECTED_FRAME ());
21105 struct bidi_it itb;
21106 ptrdiff_t from_pos, to_pos, from_bpos;
21107 void *itb_data;
21108
21109 if (!NILP (object))
21110 {
21111 if (BUFFERP (object))
21112 buf = XBUFFER (object);
21113 else if (WINDOWP (object))
21114 {
21115 w = decode_live_window (object);
21116 buf = XBUFFER (w->contents);
21117 frame_window_p = FRAME_WINDOW_P (XFRAME (w->frame));
21118 }
21119 else
21120 CHECK_STRING (object);
21121 }
21122
21123 if (STRINGP (object))
21124 {
21125 /* Characters in unibyte strings are always treated by bidi.c as
21126 strong LTR. */
21127 if (!STRING_MULTIBYTE (object)
21128 /* When we are loading loadup.el, the character property
21129 tables needed for bidi iteration are not yet
21130 available. */
21131 || !NILP (Vpurify_flag))
21132 return Qnil;
21133
21134 validate_subarray (object, from, to, SCHARS (object), &from_pos, &to_pos);
21135 if (from_pos >= SCHARS (object))
21136 return Qnil;
21137
21138 /* Set up the bidi iterator. */
21139 itb_data = bidi_shelve_cache ();
21140 itb.paragraph_dir = NEUTRAL_DIR;
21141 itb.string.lstring = object;
21142 itb.string.s = NULL;
21143 itb.string.schars = SCHARS (object);
21144 itb.string.bufpos = 0;
21145 itb.string.from_disp_str = false;
21146 itb.string.unibyte = false;
21147 itb.w = w;
21148 bidi_init_it (0, 0, frame_window_p, &itb);
21149 }
21150 else
21151 {
21152 /* Nothing this fancy can happen in unibyte buffers, or in a
21153 buffer that disabled reordering, or if FROM is at EOB. */
21154 if (NILP (BVAR (buf, bidi_display_reordering))
21155 || NILP (BVAR (buf, enable_multibyte_characters))
21156 /* When we are loading loadup.el, the character property
21157 tables needed for bidi iteration are not yet
21158 available. */
21159 || !NILP (Vpurify_flag))
21160 return Qnil;
21161
21162 set_buffer_temp (buf);
21163 validate_region (&from, &to);
21164 from_pos = XINT (from);
21165 to_pos = XINT (to);
21166 if (from_pos >= ZV)
21167 return Qnil;
21168
21169 /* Set up the bidi iterator. */
21170 itb_data = bidi_shelve_cache ();
21171 from_bpos = CHAR_TO_BYTE (from_pos);
21172 if (from_pos == BEGV)
21173 {
21174 itb.charpos = BEGV;
21175 itb.bytepos = BEGV_BYTE;
21176 }
21177 else if (FETCH_CHAR (from_bpos - 1) == '\n')
21178 {
21179 itb.charpos = from_pos;
21180 itb.bytepos = from_bpos;
21181 }
21182 else
21183 itb.charpos = find_newline_no_quit (from_pos, CHAR_TO_BYTE (from_pos),
21184 -1, &itb.bytepos);
21185 itb.paragraph_dir = NEUTRAL_DIR;
21186 itb.string.s = NULL;
21187 itb.string.lstring = Qnil;
21188 itb.string.bufpos = 0;
21189 itb.string.from_disp_str = false;
21190 itb.string.unibyte = false;
21191 itb.w = w;
21192 bidi_init_it (itb.charpos, itb.bytepos, frame_window_p, &itb);
21193 }
21194
21195 ptrdiff_t found;
21196 do {
21197 /* For the purposes of this function, the actual base direction of
21198 the paragraph doesn't matter, so just set it to L2R. */
21199 bidi_paragraph_init (L2R, &itb, false);
21200 while ((found = bidi_find_first_overridden (&itb)) < from_pos)
21201 ;
21202 } while (found == ZV && itb.ch == '\n' && itb.charpos < to_pos);
21203
21204 bidi_unshelve_cache (itb_data, false);
21205 set_buffer_temp (old);
21206
21207 return (from_pos <= found && found < to_pos) ? make_number (found) : Qnil;
21208 }
21209
21210 DEFUN ("move-point-visually", Fmove_point_visually,
21211 Smove_point_visually, 1, 1, 0,
21212 doc: /* Move point in the visual order in the specified DIRECTION.
21213 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21214 left.
21215
21216 Value is the new character position of point. */)
21217 (Lisp_Object direction)
21218 {
21219 struct window *w = XWINDOW (selected_window);
21220 struct buffer *b = XBUFFER (w->contents);
21221 struct glyph_row *row;
21222 int dir;
21223 Lisp_Object paragraph_dir;
21224
21225 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21226 (!(ROW)->continued_p \
21227 && NILP ((GLYPH)->object) \
21228 && (GLYPH)->type == CHAR_GLYPH \
21229 && (GLYPH)->u.ch == ' ' \
21230 && (GLYPH)->charpos >= 0 \
21231 && !(GLYPH)->avoid_cursor_p)
21232
21233 CHECK_NUMBER (direction);
21234 dir = XINT (direction);
21235 if (dir > 0)
21236 dir = 1;
21237 else
21238 dir = -1;
21239
21240 /* If current matrix is up-to-date, we can use the information
21241 recorded in the glyphs, at least as long as the goal is on the
21242 screen. */
21243 if (w->window_end_valid
21244 && !windows_or_buffers_changed
21245 && b
21246 && !b->clip_changed
21247 && !b->prevent_redisplay_optimizations_p
21248 && !window_outdated (w)
21249 /* We rely below on the cursor coordinates to be up to date, but
21250 we cannot trust them if some command moved point since the
21251 last complete redisplay. */
21252 && w->last_point == BUF_PT (b)
21253 && w->cursor.vpos >= 0
21254 && w->cursor.vpos < w->current_matrix->nrows
21255 && (row = MATRIX_ROW (w->current_matrix, w->cursor.vpos))->enabled_p)
21256 {
21257 struct glyph *g = row->glyphs[TEXT_AREA];
21258 struct glyph *e = dir > 0 ? g + row->used[TEXT_AREA] : g - 1;
21259 struct glyph *gpt = g + w->cursor.hpos;
21260
21261 for (g = gpt + dir; (dir > 0 ? g < e : g > e); g += dir)
21262 {
21263 if (BUFFERP (g->object) && g->charpos != PT)
21264 {
21265 SET_PT (g->charpos);
21266 w->cursor.vpos = -1;
21267 return make_number (PT);
21268 }
21269 else if (!NILP (g->object) && !EQ (g->object, gpt->object))
21270 {
21271 ptrdiff_t new_pos;
21272
21273 if (BUFFERP (gpt->object))
21274 {
21275 new_pos = PT;
21276 if ((gpt->resolved_level - row->reversed_p) % 2 == 0)
21277 new_pos += (row->reversed_p ? -dir : dir);
21278 else
21279 new_pos -= (row->reversed_p ? -dir : dir);
21280 }
21281 else if (BUFFERP (g->object))
21282 new_pos = g->charpos;
21283 else
21284 break;
21285 SET_PT (new_pos);
21286 w->cursor.vpos = -1;
21287 return make_number (PT);
21288 }
21289 else if (ROW_GLYPH_NEWLINE_P (row, g))
21290 {
21291 /* Glyphs inserted at the end of a non-empty line for
21292 positioning the cursor have zero charpos, so we must
21293 deduce the value of point by other means. */
21294 if (g->charpos > 0)
21295 SET_PT (g->charpos);
21296 else if (row->ends_at_zv_p && PT != ZV)
21297 SET_PT (ZV);
21298 else if (PT != MATRIX_ROW_END_CHARPOS (row) - 1)
21299 SET_PT (MATRIX_ROW_END_CHARPOS (row) - 1);
21300 else
21301 break;
21302 w->cursor.vpos = -1;
21303 return make_number (PT);
21304 }
21305 }
21306 if (g == e || NILP (g->object))
21307 {
21308 if (row->truncated_on_left_p || row->truncated_on_right_p)
21309 goto simulate_display;
21310 if (!row->reversed_p)
21311 row += dir;
21312 else
21313 row -= dir;
21314 if (row < MATRIX_FIRST_TEXT_ROW (w->current_matrix)
21315 || row > MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w))
21316 goto simulate_display;
21317
21318 if (dir > 0)
21319 {
21320 if (row->reversed_p && !row->continued_p)
21321 {
21322 SET_PT (MATRIX_ROW_END_CHARPOS (row) - 1);
21323 w->cursor.vpos = -1;
21324 return make_number (PT);
21325 }
21326 g = row->glyphs[TEXT_AREA];
21327 e = g + row->used[TEXT_AREA];
21328 for ( ; g < e; g++)
21329 {
21330 if (BUFFERP (g->object)
21331 /* Empty lines have only one glyph, which stands
21332 for the newline, and whose charpos is the
21333 buffer position of the newline. */
21334 || ROW_GLYPH_NEWLINE_P (row, g)
21335 /* When the buffer ends in a newline, the line at
21336 EOB also has one glyph, but its charpos is -1. */
21337 || (row->ends_at_zv_p
21338 && !row->reversed_p
21339 && NILP (g->object)
21340 && g->type == CHAR_GLYPH
21341 && g->u.ch == ' '))
21342 {
21343 if (g->charpos > 0)
21344 SET_PT (g->charpos);
21345 else if (!row->reversed_p
21346 && row->ends_at_zv_p
21347 && PT != ZV)
21348 SET_PT (ZV);
21349 else
21350 continue;
21351 w->cursor.vpos = -1;
21352 return make_number (PT);
21353 }
21354 }
21355 }
21356 else
21357 {
21358 if (!row->reversed_p && !row->continued_p)
21359 {
21360 SET_PT (MATRIX_ROW_END_CHARPOS (row) - 1);
21361 w->cursor.vpos = -1;
21362 return make_number (PT);
21363 }
21364 e = row->glyphs[TEXT_AREA];
21365 g = e + row->used[TEXT_AREA] - 1;
21366 for ( ; g >= e; g--)
21367 {
21368 if (BUFFERP (g->object)
21369 || (ROW_GLYPH_NEWLINE_P (row, g)
21370 && g->charpos > 0)
21371 /* Empty R2L lines on GUI frames have the buffer
21372 position of the newline stored in the stretch
21373 glyph. */
21374 || g->type == STRETCH_GLYPH
21375 || (row->ends_at_zv_p
21376 && row->reversed_p
21377 && NILP (g->object)
21378 && g->type == CHAR_GLYPH
21379 && g->u.ch == ' '))
21380 {
21381 if (g->charpos > 0)
21382 SET_PT (g->charpos);
21383 else if (row->reversed_p
21384 && row->ends_at_zv_p
21385 && PT != ZV)
21386 SET_PT (ZV);
21387 else
21388 continue;
21389 w->cursor.vpos = -1;
21390 return make_number (PT);
21391 }
21392 }
21393 }
21394 }
21395 }
21396
21397 simulate_display:
21398
21399 /* If we wind up here, we failed to move by using the glyphs, so we
21400 need to simulate display instead. */
21401
21402 if (b)
21403 paragraph_dir = Fcurrent_bidi_paragraph_direction (w->contents);
21404 else
21405 paragraph_dir = Qleft_to_right;
21406 if (EQ (paragraph_dir, Qright_to_left))
21407 dir = -dir;
21408 if (PT <= BEGV && dir < 0)
21409 xsignal0 (Qbeginning_of_buffer);
21410 else if (PT >= ZV && dir > 0)
21411 xsignal0 (Qend_of_buffer);
21412 else
21413 {
21414 struct text_pos pt;
21415 struct it it;
21416 int pt_x, target_x, pixel_width, pt_vpos;
21417 bool at_eol_p;
21418 bool overshoot_expected = false;
21419 bool target_is_eol_p = false;
21420
21421 /* Setup the arena. */
21422 SET_TEXT_POS (pt, PT, PT_BYTE);
21423 start_display (&it, w, pt);
21424 /* When lines are truncated, we could be called with point
21425 outside of the windows edges, in which case move_it_*
21426 functions either prematurely stop at window's edge or jump to
21427 the next screen line, whereas we rely below on our ability to
21428 reach point, in order to start from its X coordinate. So we
21429 need to disregard the window's horizontal extent in that case. */
21430 if (it.line_wrap == TRUNCATE)
21431 it.last_visible_x = INFINITY;
21432
21433 if (it.cmp_it.id < 0
21434 && it.method == GET_FROM_STRING
21435 && it.area == TEXT_AREA
21436 && it.string_from_display_prop_p
21437 && (it.sp > 0 && it.stack[it.sp - 1].method == GET_FROM_BUFFER))
21438 overshoot_expected = true;
21439
21440 /* Find the X coordinate of point. We start from the beginning
21441 of this or previous line to make sure we are before point in
21442 the logical order (since the move_it_* functions can only
21443 move forward). */
21444 reseat:
21445 reseat_at_previous_visible_line_start (&it);
21446 it.current_x = it.hpos = it.current_y = it.vpos = 0;
21447 if (IT_CHARPOS (it) != PT)
21448 {
21449 move_it_to (&it, overshoot_expected ? PT - 1 : PT,
21450 -1, -1, -1, MOVE_TO_POS);
21451 /* If we missed point because the character there is
21452 displayed out of a display vector that has more than one
21453 glyph, retry expecting overshoot. */
21454 if (it.method == GET_FROM_DISPLAY_VECTOR
21455 && it.current.dpvec_index > 0
21456 && !overshoot_expected)
21457 {
21458 overshoot_expected = true;
21459 goto reseat;
21460 }
21461 else if (IT_CHARPOS (it) != PT && !overshoot_expected)
21462 move_it_in_display_line (&it, PT, -1, MOVE_TO_POS);
21463 }
21464 pt_x = it.current_x;
21465 pt_vpos = it.vpos;
21466 if (dir > 0 || overshoot_expected)
21467 {
21468 struct glyph_row *row = it.glyph_row;
21469
21470 /* When point is at beginning of line, we don't have
21471 information about the glyph there loaded into struct
21472 it. Calling get_next_display_element fixes that. */
21473 if (pt_x == 0)
21474 get_next_display_element (&it);
21475 at_eol_p = ITERATOR_AT_END_OF_LINE_P (&it);
21476 it.glyph_row = NULL;
21477 PRODUCE_GLYPHS (&it); /* compute it.pixel_width */
21478 it.glyph_row = row;
21479 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21480 it, lest it will become out of sync with it's buffer
21481 position. */
21482 it.current_x = pt_x;
21483 }
21484 else
21485 at_eol_p = ITERATOR_AT_END_OF_LINE_P (&it);
21486 pixel_width = it.pixel_width;
21487 if (overshoot_expected && at_eol_p)
21488 pixel_width = 0;
21489 else if (pixel_width <= 0)
21490 pixel_width = 1;
21491
21492 /* If there's a display string (or something similar) at point,
21493 we are actually at the glyph to the left of point, so we need
21494 to correct the X coordinate. */
21495 if (overshoot_expected)
21496 {
21497 if (it.bidi_p)
21498 pt_x += pixel_width * it.bidi_it.scan_dir;
21499 else
21500 pt_x += pixel_width;
21501 }
21502
21503 /* Compute target X coordinate, either to the left or to the
21504 right of point. On TTY frames, all characters have the same
21505 pixel width of 1, so we can use that. On GUI frames we don't
21506 have an easy way of getting at the pixel width of the
21507 character to the left of point, so we use a different method
21508 of getting to that place. */
21509 if (dir > 0)
21510 target_x = pt_x + pixel_width;
21511 else
21512 target_x = pt_x - (!FRAME_WINDOW_P (it.f)) * pixel_width;
21513
21514 /* Target X coordinate could be one line above or below the line
21515 of point, in which case we need to adjust the target X
21516 coordinate. Also, if moving to the left, we need to begin at
21517 the left edge of the point's screen line. */
21518 if (dir < 0)
21519 {
21520 if (pt_x > 0)
21521 {
21522 start_display (&it, w, pt);
21523 if (it.line_wrap == TRUNCATE)
21524 it.last_visible_x = INFINITY;
21525 reseat_at_previous_visible_line_start (&it);
21526 it.current_x = it.current_y = it.hpos = 0;
21527 if (pt_vpos != 0)
21528 move_it_by_lines (&it, pt_vpos);
21529 }
21530 else
21531 {
21532 move_it_by_lines (&it, -1);
21533 target_x = it.last_visible_x - !FRAME_WINDOW_P (it.f);
21534 target_is_eol_p = true;
21535 /* Under word-wrap, we don't know the x coordinate of
21536 the last character displayed on the previous line,
21537 which immediately precedes the wrap point. To find
21538 out its x coordinate, we try moving to the right
21539 margin of the window, which will stop at the wrap
21540 point, and then reset target_x to point at the
21541 character that precedes the wrap point. This is not
21542 needed on GUI frames, because (see below) there we
21543 move from the left margin one grapheme cluster at a
21544 time, and stop when we hit the wrap point. */
21545 if (!FRAME_WINDOW_P (it.f) && it.line_wrap == WORD_WRAP)
21546 {
21547 void *it_data = NULL;
21548 struct it it2;
21549
21550 SAVE_IT (it2, it, it_data);
21551 move_it_in_display_line_to (&it, ZV, target_x,
21552 MOVE_TO_POS | MOVE_TO_X);
21553 /* If we arrived at target_x, that _is_ the last
21554 character on the previous line. */
21555 if (it.current_x != target_x)
21556 target_x = it.current_x - 1;
21557 RESTORE_IT (&it, &it2, it_data);
21558 }
21559 }
21560 }
21561 else
21562 {
21563 if (at_eol_p
21564 || (target_x >= it.last_visible_x
21565 && it.line_wrap != TRUNCATE))
21566 {
21567 if (pt_x > 0)
21568 move_it_by_lines (&it, 0);
21569 move_it_by_lines (&it, 1);
21570 target_x = 0;
21571 }
21572 }
21573
21574 /* Move to the target X coordinate. */
21575 #ifdef HAVE_WINDOW_SYSTEM
21576 /* On GUI frames, as we don't know the X coordinate of the
21577 character to the left of point, moving point to the left
21578 requires walking, one grapheme cluster at a time, until we
21579 find ourself at a place immediately to the left of the
21580 character at point. */
21581 if (FRAME_WINDOW_P (it.f) && dir < 0)
21582 {
21583 struct text_pos new_pos;
21584 enum move_it_result rc = MOVE_X_REACHED;
21585
21586 if (it.current_x == 0)
21587 get_next_display_element (&it);
21588 if (it.what == IT_COMPOSITION)
21589 {
21590 new_pos.charpos = it.cmp_it.charpos;
21591 new_pos.bytepos = -1;
21592 }
21593 else
21594 new_pos = it.current.pos;
21595
21596 while (it.current_x + it.pixel_width <= target_x
21597 && (rc == MOVE_X_REACHED
21598 /* Under word-wrap, move_it_in_display_line_to
21599 stops at correct coordinates, but sometimes
21600 returns MOVE_POS_MATCH_OR_ZV. */
21601 || (it.line_wrap == WORD_WRAP
21602 && rc == MOVE_POS_MATCH_OR_ZV)))
21603 {
21604 int new_x = it.current_x + it.pixel_width;
21605
21606 /* For composed characters, we want the position of the
21607 first character in the grapheme cluster (usually, the
21608 composition's base character), whereas it.current
21609 might give us the position of the _last_ one, e.g. if
21610 the composition is rendered in reverse due to bidi
21611 reordering. */
21612 if (it.what == IT_COMPOSITION)
21613 {
21614 new_pos.charpos = it.cmp_it.charpos;
21615 new_pos.bytepos = -1;
21616 }
21617 else
21618 new_pos = it.current.pos;
21619 if (new_x == it.current_x)
21620 new_x++;
21621 rc = move_it_in_display_line_to (&it, ZV, new_x,
21622 MOVE_TO_POS | MOVE_TO_X);
21623 if (ITERATOR_AT_END_OF_LINE_P (&it) && !target_is_eol_p)
21624 break;
21625 }
21626 /* The previous position we saw in the loop is the one we
21627 want. */
21628 if (new_pos.bytepos == -1)
21629 new_pos.bytepos = CHAR_TO_BYTE (new_pos.charpos);
21630 it.current.pos = new_pos;
21631 }
21632 else
21633 #endif
21634 if (it.current_x != target_x)
21635 move_it_in_display_line_to (&it, ZV, target_x, MOVE_TO_POS | MOVE_TO_X);
21636
21637 /* If we ended up in a display string that covers point, move to
21638 buffer position to the right in the visual order. */
21639 if (dir > 0)
21640 {
21641 while (IT_CHARPOS (it) == PT)
21642 {
21643 set_iterator_to_next (&it, false);
21644 if (!get_next_display_element (&it))
21645 break;
21646 }
21647 }
21648
21649 /* Move point to that position. */
21650 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
21651 }
21652
21653 return make_number (PT);
21654
21655 #undef ROW_GLYPH_NEWLINE_P
21656 }
21657
21658 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels,
21659 Sbidi_resolved_levels, 0, 1, 0,
21660 doc: /* Return the resolved bidirectional levels of characters at VPOS.
21661
21662 The resolved levels are produced by the Emacs bidi reordering engine
21663 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21664 read the Unicode Standard Annex 9 (UAX#9) for background information
21665 about these levels.
21666
21667 VPOS is the zero-based number of the current window's screen line
21668 for which to produce the resolved levels. If VPOS is nil or omitted,
21669 it defaults to the screen line of point. If the window displays a
21670 header line, VPOS of zero will report on the header line, and first
21671 line of text in the window will have VPOS of 1.
21672
21673 Value is an array of resolved levels, indexed by glyph number.
21674 Glyphs are numbered from zero starting from the beginning of the
21675 screen line, i.e. the left edge of the window for left-to-right lines
21676 and from the right edge for right-to-left lines. The resolved levels
21677 are produced only for the window's text area; text in display margins
21678 is not included.
21679
21680 If the selected window's display is not up-to-date, or if the specified
21681 screen line does not display text, this function returns nil. It is
21682 highly recommended to bind this function to some simple key, like F8,
21683 in order to avoid these problems.
21684
21685 This function exists mainly for testing the correctness of the
21686 Emacs UBA implementation, in particular with the test suite. */)
21687 (Lisp_Object vpos)
21688 {
21689 struct window *w = XWINDOW (selected_window);
21690 struct buffer *b = XBUFFER (w->contents);
21691 int nrow;
21692 struct glyph_row *row;
21693
21694 if (NILP (vpos))
21695 {
21696 int d1, d2, d3, d4, d5;
21697
21698 pos_visible_p (w, PT, &d1, &d2, &d3, &d4, &d5, &nrow);
21699 }
21700 else
21701 {
21702 CHECK_NUMBER_COERCE_MARKER (vpos);
21703 nrow = XINT (vpos);
21704 }
21705
21706 /* We require up-to-date glyph matrix for this window. */
21707 if (w->window_end_valid
21708 && !windows_or_buffers_changed
21709 && b
21710 && !b->clip_changed
21711 && !b->prevent_redisplay_optimizations_p
21712 && !window_outdated (w)
21713 && nrow >= 0
21714 && nrow < w->current_matrix->nrows
21715 && (row = MATRIX_ROW (w->current_matrix, nrow))->enabled_p
21716 && MATRIX_ROW_DISPLAYS_TEXT_P (row))
21717 {
21718 struct glyph *g, *e, *g1;
21719 int nglyphs, i;
21720 Lisp_Object levels;
21721
21722 if (!row->reversed_p) /* Left-to-right glyph row. */
21723 {
21724 g = g1 = row->glyphs[TEXT_AREA];
21725 e = g + row->used[TEXT_AREA];
21726
21727 /* Skip over glyphs at the start of the row that was
21728 generated by redisplay for its own needs. */
21729 while (g < e
21730 && NILP (g->object)
21731 && g->charpos < 0)
21732 g++;
21733 g1 = g;
21734
21735 /* Count the "interesting" glyphs in this row. */
21736 for (nglyphs = 0; g < e && !NILP (g->object); g++)
21737 nglyphs++;
21738
21739 /* Create and fill the array. */
21740 levels = make_uninit_vector (nglyphs);
21741 for (i = 0; g1 < g; i++, g1++)
21742 ASET (levels, i, make_number (g1->resolved_level));
21743 }
21744 else /* Right-to-left glyph row. */
21745 {
21746 g = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1;
21747 e = row->glyphs[TEXT_AREA] - 1;
21748 while (g > e
21749 && NILP (g->object)
21750 && g->charpos < 0)
21751 g--;
21752 g1 = g;
21753 for (nglyphs = 0; g > e && !NILP (g->object); g--)
21754 nglyphs++;
21755 levels = make_uninit_vector (nglyphs);
21756 for (i = 0; g1 > g; i++, g1--)
21757 ASET (levels, i, make_number (g1->resolved_level));
21758 }
21759 return levels;
21760 }
21761 else
21762 return Qnil;
21763 }
21764
21765
21766 \f
21767 /***********************************************************************
21768 Menu Bar
21769 ***********************************************************************/
21770
21771 /* Redisplay the menu bar in the frame for window W.
21772
21773 The menu bar of X frames that don't have X toolkit support is
21774 displayed in a special window W->frame->menu_bar_window.
21775
21776 The menu bar of terminal frames is treated specially as far as
21777 glyph matrices are concerned. Menu bar lines are not part of
21778 windows, so the update is done directly on the frame matrix rows
21779 for the menu bar. */
21780
21781 static void
21782 display_menu_bar (struct window *w)
21783 {
21784 struct frame *f = XFRAME (WINDOW_FRAME (w));
21785 struct it it;
21786 Lisp_Object items;
21787 int i;
21788
21789 /* Don't do all this for graphical frames. */
21790 #ifdef HAVE_NTGUI
21791 if (FRAME_W32_P (f))
21792 return;
21793 #endif
21794 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21795 if (FRAME_X_P (f))
21796 return;
21797 #endif
21798
21799 #ifdef HAVE_NS
21800 if (FRAME_NS_P (f))
21801 return;
21802 #endif /* HAVE_NS */
21803
21804 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21805 eassert (!FRAME_WINDOW_P (f));
21806 init_iterator (&it, w, -1, -1, f->desired_matrix->rows, MENU_FACE_ID);
21807 it.first_visible_x = 0;
21808 it.last_visible_x = FRAME_PIXEL_WIDTH (f);
21809 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21810 if (FRAME_WINDOW_P (f))
21811 {
21812 /* Menu bar lines are displayed in the desired matrix of the
21813 dummy window menu_bar_window. */
21814 struct window *menu_w;
21815 menu_w = XWINDOW (f->menu_bar_window);
21816 init_iterator (&it, menu_w, -1, -1, menu_w->desired_matrix->rows,
21817 MENU_FACE_ID);
21818 it.first_visible_x = 0;
21819 it.last_visible_x = FRAME_PIXEL_WIDTH (f);
21820 }
21821 else
21822 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21823 {
21824 /* This is a TTY frame, i.e. character hpos/vpos are used as
21825 pixel x/y. */
21826 init_iterator (&it, w, -1, -1, f->desired_matrix->rows,
21827 MENU_FACE_ID);
21828 it.first_visible_x = 0;
21829 it.last_visible_x = FRAME_COLS (f);
21830 }
21831
21832 /* FIXME: This should be controlled by a user option. See the
21833 comments in redisplay_tool_bar and display_mode_line about
21834 this. */
21835 it.paragraph_embedding = L2R;
21836
21837 /* Clear all rows of the menu bar. */
21838 for (i = 0; i < FRAME_MENU_BAR_LINES (f); ++i)
21839 {
21840 struct glyph_row *row = it.glyph_row + i;
21841 clear_glyph_row (row);
21842 row->enabled_p = true;
21843 row->full_width_p = true;
21844 row->reversed_p = false;
21845 }
21846
21847 /* Display all items of the menu bar. */
21848 items = FRAME_MENU_BAR_ITEMS (it.f);
21849 for (i = 0; i < ASIZE (items); i += 4)
21850 {
21851 Lisp_Object string;
21852
21853 /* Stop at nil string. */
21854 string = AREF (items, i + 1);
21855 if (NILP (string))
21856 break;
21857
21858 /* Remember where item was displayed. */
21859 ASET (items, i + 3, make_number (it.hpos));
21860
21861 /* Display the item, pad with one space. */
21862 if (it.current_x < it.last_visible_x)
21863 display_string (NULL, string, Qnil, 0, 0, &it,
21864 SCHARS (string) + 1, 0, 0, -1);
21865 }
21866
21867 /* Fill out the line with spaces. */
21868 if (it.current_x < it.last_visible_x)
21869 display_string ("", Qnil, Qnil, 0, 0, &it, -1, 0, 0, -1);
21870
21871 /* Compute the total height of the lines. */
21872 compute_line_metrics (&it);
21873 }
21874
21875 /* Deep copy of a glyph row, including the glyphs. */
21876 static void
21877 deep_copy_glyph_row (struct glyph_row *to, struct glyph_row *from)
21878 {
21879 struct glyph *pointers[1 + LAST_AREA];
21880 int to_used = to->used[TEXT_AREA];
21881
21882 /* Save glyph pointers of TO. */
21883 memcpy (pointers, to->glyphs, sizeof to->glyphs);
21884
21885 /* Do a structure assignment. */
21886 *to = *from;
21887
21888 /* Restore original glyph pointers of TO. */
21889 memcpy (to->glyphs, pointers, sizeof to->glyphs);
21890
21891 /* Copy the glyphs. */
21892 memcpy (to->glyphs[TEXT_AREA], from->glyphs[TEXT_AREA],
21893 min (from->used[TEXT_AREA], to_used) * sizeof (struct glyph));
21894
21895 /* If we filled only part of the TO row, fill the rest with
21896 space_glyph (which will display as empty space). */
21897 if (to_used > from->used[TEXT_AREA])
21898 fill_up_frame_row_with_spaces (to, to_used);
21899 }
21900
21901 /* Display one menu item on a TTY, by overwriting the glyphs in the
21902 frame F's desired glyph matrix with glyphs produced from the menu
21903 item text. Called from term.c to display TTY drop-down menus one
21904 item at a time.
21905
21906 ITEM_TEXT is the menu item text as a C string.
21907
21908 FACE_ID is the face ID to be used for this menu item. FACE_ID
21909 could specify one of 3 faces: a face for an enabled item, a face
21910 for a disabled item, or a face for a selected item.
21911
21912 X and Y are coordinates of the first glyph in the frame's desired
21913 matrix to be overwritten by the menu item. Since this is a TTY, Y
21914 is the zero-based number of the glyph row and X is the zero-based
21915 glyph number in the row, starting from left, where to start
21916 displaying the item.
21917
21918 SUBMENU means this menu item drops down a submenu, which
21919 should be indicated by displaying a proper visual cue after the
21920 item text. */
21921
21922 void
21923 display_tty_menu_item (const char *item_text, int width, int face_id,
21924 int x, int y, bool submenu)
21925 {
21926 struct it it;
21927 struct frame *f = SELECTED_FRAME ();
21928 struct window *w = XWINDOW (f->selected_window);
21929 struct glyph_row *row;
21930 size_t item_len = strlen (item_text);
21931
21932 eassert (FRAME_TERMCAP_P (f));
21933
21934 /* Don't write beyond the matrix's last row. This can happen for
21935 TTY screens that are not high enough to show the entire menu.
21936 (This is actually a bit of defensive programming, as
21937 tty_menu_display already limits the number of menu items to one
21938 less than the number of screen lines.) */
21939 if (y >= f->desired_matrix->nrows)
21940 return;
21941
21942 init_iterator (&it, w, -1, -1, f->desired_matrix->rows + y, MENU_FACE_ID);
21943 it.first_visible_x = 0;
21944 it.last_visible_x = FRAME_COLS (f) - 1;
21945 row = it.glyph_row;
21946 /* Start with the row contents from the current matrix. */
21947 deep_copy_glyph_row (row, f->current_matrix->rows + y);
21948 bool saved_width = row->full_width_p;
21949 row->full_width_p = true;
21950 bool saved_reversed = row->reversed_p;
21951 row->reversed_p = false;
21952 row->enabled_p = true;
21953
21954 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21955 desired face. */
21956 eassert (x < f->desired_matrix->matrix_w);
21957 it.current_x = it.hpos = x;
21958 it.current_y = it.vpos = y;
21959 int saved_used = row->used[TEXT_AREA];
21960 bool saved_truncated = row->truncated_on_right_p;
21961 row->used[TEXT_AREA] = x;
21962 it.face_id = face_id;
21963 it.line_wrap = TRUNCATE;
21964
21965 /* FIXME: This should be controlled by a user option. See the
21966 comments in redisplay_tool_bar and display_mode_line about this.
21967 Also, if paragraph_embedding could ever be R2L, changes will be
21968 needed to avoid shifting to the right the row characters in
21969 term.c:append_glyph. */
21970 it.paragraph_embedding = L2R;
21971
21972 /* Pad with a space on the left. */
21973 display_string (" ", Qnil, Qnil, 0, 0, &it, 1, 0, FRAME_COLS (f) - 1, -1);
21974 width--;
21975 /* Display the menu item, pad with spaces to WIDTH. */
21976 if (submenu)
21977 {
21978 display_string (item_text, Qnil, Qnil, 0, 0, &it,
21979 item_len, 0, FRAME_COLS (f) - 1, -1);
21980 width -= item_len;
21981 /* Indicate with " >" that there's a submenu. */
21982 display_string (" >", Qnil, Qnil, 0, 0, &it, width, 0,
21983 FRAME_COLS (f) - 1, -1);
21984 }
21985 else
21986 display_string (item_text, Qnil, Qnil, 0, 0, &it,
21987 width, 0, FRAME_COLS (f) - 1, -1);
21988
21989 row->used[TEXT_AREA] = max (saved_used, row->used[TEXT_AREA]);
21990 row->truncated_on_right_p = saved_truncated;
21991 row->hash = row_hash (row);
21992 row->full_width_p = saved_width;
21993 row->reversed_p = saved_reversed;
21994 }
21995 \f
21996 /***********************************************************************
21997 Mode Line
21998 ***********************************************************************/
21999
22000 /* Redisplay mode lines in the window tree whose root is WINDOW.
22001 If FORCE, redisplay mode lines unconditionally.
22002 Otherwise, redisplay only mode lines that are garbaged. Value is
22003 the number of windows whose mode lines were redisplayed. */
22004
22005 static int
22006 redisplay_mode_lines (Lisp_Object window, bool force)
22007 {
22008 int nwindows = 0;
22009
22010 while (!NILP (window))
22011 {
22012 struct window *w = XWINDOW (window);
22013
22014 if (WINDOWP (w->contents))
22015 nwindows += redisplay_mode_lines (w->contents, force);
22016 else if (force
22017 || FRAME_GARBAGED_P (XFRAME (w->frame))
22018 || !MATRIX_MODE_LINE_ROW (w->current_matrix)->enabled_p)
22019 {
22020 struct text_pos lpoint;
22021 struct buffer *old = current_buffer;
22022
22023 /* Set the window's buffer for the mode line display. */
22024 SET_TEXT_POS (lpoint, PT, PT_BYTE);
22025 set_buffer_internal_1 (XBUFFER (w->contents));
22026
22027 /* Point refers normally to the selected window. For any
22028 other window, set up appropriate value. */
22029 if (!EQ (window, selected_window))
22030 {
22031 struct text_pos pt;
22032
22033 CLIP_TEXT_POS_FROM_MARKER (pt, w->pointm);
22034 TEMP_SET_PT_BOTH (CHARPOS (pt), BYTEPOS (pt));
22035 }
22036
22037 /* Display mode lines. */
22038 clear_glyph_matrix (w->desired_matrix);
22039 if (display_mode_lines (w))
22040 ++nwindows;
22041
22042 /* Restore old settings. */
22043 set_buffer_internal_1 (old);
22044 TEMP_SET_PT_BOTH (CHARPOS (lpoint), BYTEPOS (lpoint));
22045 }
22046
22047 window = w->next;
22048 }
22049
22050 return nwindows;
22051 }
22052
22053
22054 /* Display the mode and/or header line of window W. Value is the
22055 sum number of mode lines and header lines displayed. */
22056
22057 static int
22058 display_mode_lines (struct window *w)
22059 {
22060 Lisp_Object old_selected_window = selected_window;
22061 Lisp_Object old_selected_frame = selected_frame;
22062 Lisp_Object new_frame = w->frame;
22063 Lisp_Object old_frame_selected_window = XFRAME (new_frame)->selected_window;
22064 int n = 0;
22065
22066 selected_frame = new_frame;
22067 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22068 or window's point, then we'd need select_window_1 here as well. */
22069 XSETWINDOW (selected_window, w);
22070 XFRAME (new_frame)->selected_window = selected_window;
22071
22072 /* These will be set while the mode line specs are processed. */
22073 line_number_displayed = false;
22074 w->column_number_displayed = -1;
22075
22076 if (WINDOW_WANTS_MODELINE_P (w))
22077 {
22078 struct window *sel_w = XWINDOW (old_selected_window);
22079
22080 /* Select mode line face based on the real selected window. */
22081 display_mode_line (w, CURRENT_MODE_LINE_FACE_ID_3 (sel_w, sel_w, w),
22082 BVAR (current_buffer, mode_line_format));
22083 ++n;
22084 }
22085
22086 if (WINDOW_WANTS_HEADER_LINE_P (w))
22087 {
22088 display_mode_line (w, HEADER_LINE_FACE_ID,
22089 BVAR (current_buffer, header_line_format));
22090 ++n;
22091 }
22092
22093 XFRAME (new_frame)->selected_window = old_frame_selected_window;
22094 selected_frame = old_selected_frame;
22095 selected_window = old_selected_window;
22096 if (n > 0)
22097 w->must_be_updated_p = true;
22098 return n;
22099 }
22100
22101
22102 /* Display mode or header line of window W. FACE_ID specifies which
22103 line to display; it is either MODE_LINE_FACE_ID or
22104 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22105 display. Value is the pixel height of the mode/header line
22106 displayed. */
22107
22108 static int
22109 display_mode_line (struct window *w, enum face_id face_id, Lisp_Object format)
22110 {
22111 struct it it;
22112 struct face *face;
22113 ptrdiff_t count = SPECPDL_INDEX ();
22114
22115 init_iterator (&it, w, -1, -1, NULL, face_id);
22116 /* Don't extend on a previously drawn mode-line.
22117 This may happen if called from pos_visible_p. */
22118 it.glyph_row->enabled_p = false;
22119 prepare_desired_row (w, it.glyph_row, true);
22120
22121 it.glyph_row->mode_line_p = true;
22122
22123 /* FIXME: This should be controlled by a user option. But
22124 supporting such an option is not trivial, since the mode line is
22125 made up of many separate strings. */
22126 it.paragraph_embedding = L2R;
22127
22128 record_unwind_protect (unwind_format_mode_line,
22129 format_mode_line_unwind_data (NULL, NULL,
22130 Qnil, false));
22131
22132 mode_line_target = MODE_LINE_DISPLAY;
22133
22134 /* Temporarily make frame's keyboard the current kboard so that
22135 kboard-local variables in the mode_line_format will get the right
22136 values. */
22137 push_kboard (FRAME_KBOARD (it.f));
22138 record_unwind_save_match_data ();
22139 display_mode_element (&it, 0, 0, 0, format, Qnil, false);
22140 pop_kboard ();
22141
22142 unbind_to (count, Qnil);
22143
22144 /* Fill up with spaces. */
22145 display_string (" ", Qnil, Qnil, 0, 0, &it, 10000, -1, -1, 0);
22146
22147 compute_line_metrics (&it);
22148 it.glyph_row->full_width_p = true;
22149 it.glyph_row->continued_p = false;
22150 it.glyph_row->truncated_on_left_p = false;
22151 it.glyph_row->truncated_on_right_p = false;
22152
22153 /* Make a 3D mode-line have a shadow at its right end. */
22154 face = FACE_FROM_ID (it.f, face_id);
22155 extend_face_to_end_of_line (&it);
22156 if (face->box != FACE_NO_BOX)
22157 {
22158 struct glyph *last = (it.glyph_row->glyphs[TEXT_AREA]
22159 + it.glyph_row->used[TEXT_AREA] - 1);
22160 last->right_box_line_p = true;
22161 }
22162
22163 return it.glyph_row->height;
22164 }
22165
22166 /* Move element ELT in LIST to the front of LIST.
22167 Return the updated list. */
22168
22169 static Lisp_Object
22170 move_elt_to_front (Lisp_Object elt, Lisp_Object list)
22171 {
22172 register Lisp_Object tail, prev;
22173 register Lisp_Object tem;
22174
22175 tail = list;
22176 prev = Qnil;
22177 while (CONSP (tail))
22178 {
22179 tem = XCAR (tail);
22180
22181 if (EQ (elt, tem))
22182 {
22183 /* Splice out the link TAIL. */
22184 if (NILP (prev))
22185 list = XCDR (tail);
22186 else
22187 Fsetcdr (prev, XCDR (tail));
22188
22189 /* Now make it the first. */
22190 Fsetcdr (tail, list);
22191 return tail;
22192 }
22193 else
22194 prev = tail;
22195 tail = XCDR (tail);
22196 QUIT;
22197 }
22198
22199 /* Not found--return unchanged LIST. */
22200 return list;
22201 }
22202
22203 /* Contribute ELT to the mode line for window IT->w. How it
22204 translates into text depends on its data type.
22205
22206 IT describes the display environment in which we display, as usual.
22207
22208 DEPTH is the depth in recursion. It is used to prevent
22209 infinite recursion here.
22210
22211 FIELD_WIDTH is the number of characters the display of ELT should
22212 occupy in the mode line, and PRECISION is the maximum number of
22213 characters to display from ELT's representation. See
22214 display_string for details.
22215
22216 Returns the hpos of the end of the text generated by ELT.
22217
22218 PROPS is a property list to add to any string we encounter.
22219
22220 If RISKY, remove (disregard) any properties in any string
22221 we encounter, and ignore :eval and :propertize.
22222
22223 The global variable `mode_line_target' determines whether the
22224 output is passed to `store_mode_line_noprop',
22225 `store_mode_line_string', or `display_string'. */
22226
22227 static int
22228 display_mode_element (struct it *it, int depth, int field_width, int precision,
22229 Lisp_Object elt, Lisp_Object props, bool risky)
22230 {
22231 int n = 0, field, prec;
22232 bool literal = false;
22233
22234 tail_recurse:
22235 if (depth > 100)
22236 elt = build_string ("*too-deep*");
22237
22238 depth++;
22239
22240 switch (XTYPE (elt))
22241 {
22242 case Lisp_String:
22243 {
22244 /* A string: output it and check for %-constructs within it. */
22245 unsigned char c;
22246 ptrdiff_t offset = 0;
22247
22248 if (SCHARS (elt) > 0
22249 && (!NILP (props) || risky))
22250 {
22251 Lisp_Object oprops, aelt;
22252 oprops = Ftext_properties_at (make_number (0), elt);
22253
22254 /* If the starting string's properties are not what
22255 we want, translate the string. Also, if the string
22256 is risky, do that anyway. */
22257
22258 if (NILP (Fequal (props, oprops)) || risky)
22259 {
22260 /* If the starting string has properties,
22261 merge the specified ones onto the existing ones. */
22262 if (! NILP (oprops) && !risky)
22263 {
22264 Lisp_Object tem;
22265
22266 oprops = Fcopy_sequence (oprops);
22267 tem = props;
22268 while (CONSP (tem))
22269 {
22270 oprops = Fplist_put (oprops, XCAR (tem),
22271 XCAR (XCDR (tem)));
22272 tem = XCDR (XCDR (tem));
22273 }
22274 props = oprops;
22275 }
22276
22277 aelt = Fassoc (elt, mode_line_proptrans_alist);
22278 if (! NILP (aelt) && !NILP (Fequal (props, XCDR (aelt))))
22279 {
22280 /* AELT is what we want. Move it to the front
22281 without consing. */
22282 elt = XCAR (aelt);
22283 mode_line_proptrans_alist
22284 = move_elt_to_front (aelt, mode_line_proptrans_alist);
22285 }
22286 else
22287 {
22288 Lisp_Object tem;
22289
22290 /* If AELT has the wrong props, it is useless.
22291 so get rid of it. */
22292 if (! NILP (aelt))
22293 mode_line_proptrans_alist
22294 = Fdelq (aelt, mode_line_proptrans_alist);
22295
22296 elt = Fcopy_sequence (elt);
22297 Fset_text_properties (make_number (0), Flength (elt),
22298 props, elt);
22299 /* Add this item to mode_line_proptrans_alist. */
22300 mode_line_proptrans_alist
22301 = Fcons (Fcons (elt, props),
22302 mode_line_proptrans_alist);
22303 /* Truncate mode_line_proptrans_alist
22304 to at most 50 elements. */
22305 tem = Fnthcdr (make_number (50),
22306 mode_line_proptrans_alist);
22307 if (! NILP (tem))
22308 XSETCDR (tem, Qnil);
22309 }
22310 }
22311 }
22312
22313 offset = 0;
22314
22315 if (literal)
22316 {
22317 prec = precision - n;
22318 switch (mode_line_target)
22319 {
22320 case MODE_LINE_NOPROP:
22321 case MODE_LINE_TITLE:
22322 n += store_mode_line_noprop (SSDATA (elt), -1, prec);
22323 break;
22324 case MODE_LINE_STRING:
22325 n += store_mode_line_string (NULL, elt, true, 0, prec, Qnil);
22326 break;
22327 case MODE_LINE_DISPLAY:
22328 n += display_string (NULL, elt, Qnil, 0, 0, it,
22329 0, prec, 0, STRING_MULTIBYTE (elt));
22330 break;
22331 }
22332
22333 break;
22334 }
22335
22336 /* Handle the non-literal case. */
22337
22338 while ((precision <= 0 || n < precision)
22339 && SREF (elt, offset) != 0
22340 && (mode_line_target != MODE_LINE_DISPLAY
22341 || it->current_x < it->last_visible_x))
22342 {
22343 ptrdiff_t last_offset = offset;
22344
22345 /* Advance to end of string or next format specifier. */
22346 while ((c = SREF (elt, offset++)) != '\0' && c != '%')
22347 ;
22348
22349 if (offset - 1 != last_offset)
22350 {
22351 ptrdiff_t nchars, nbytes;
22352
22353 /* Output to end of string or up to '%'. Field width
22354 is length of string. Don't output more than
22355 PRECISION allows us. */
22356 offset--;
22357
22358 prec = c_string_width (SDATA (elt) + last_offset,
22359 offset - last_offset, precision - n,
22360 &nchars, &nbytes);
22361
22362 switch (mode_line_target)
22363 {
22364 case MODE_LINE_NOPROP:
22365 case MODE_LINE_TITLE:
22366 n += store_mode_line_noprop (SSDATA (elt) + last_offset, 0, prec);
22367 break;
22368 case MODE_LINE_STRING:
22369 {
22370 ptrdiff_t bytepos = last_offset;
22371 ptrdiff_t charpos = string_byte_to_char (elt, bytepos);
22372 ptrdiff_t endpos = (precision <= 0
22373 ? string_byte_to_char (elt, offset)
22374 : charpos + nchars);
22375 Lisp_Object mode_string
22376 = Fsubstring (elt, make_number (charpos),
22377 make_number (endpos));
22378 n += store_mode_line_string (NULL, mode_string, false,
22379 0, 0, Qnil);
22380 }
22381 break;
22382 case MODE_LINE_DISPLAY:
22383 {
22384 ptrdiff_t bytepos = last_offset;
22385 ptrdiff_t charpos = string_byte_to_char (elt, bytepos);
22386
22387 if (precision <= 0)
22388 nchars = string_byte_to_char (elt, offset) - charpos;
22389 n += display_string (NULL, elt, Qnil, 0, charpos,
22390 it, 0, nchars, 0,
22391 STRING_MULTIBYTE (elt));
22392 }
22393 break;
22394 }
22395 }
22396 else /* c == '%' */
22397 {
22398 ptrdiff_t percent_position = offset;
22399
22400 /* Get the specified minimum width. Zero means
22401 don't pad. */
22402 field = 0;
22403 while ((c = SREF (elt, offset++)) >= '0' && c <= '9')
22404 field = field * 10 + c - '0';
22405
22406 /* Don't pad beyond the total padding allowed. */
22407 if (field_width - n > 0 && field > field_width - n)
22408 field = field_width - n;
22409
22410 /* Note that either PRECISION <= 0 or N < PRECISION. */
22411 prec = precision - n;
22412
22413 if (c == 'M')
22414 n += display_mode_element (it, depth, field, prec,
22415 Vglobal_mode_string, props,
22416 risky);
22417 else if (c != 0)
22418 {
22419 bool multibyte;
22420 ptrdiff_t bytepos, charpos;
22421 const char *spec;
22422 Lisp_Object string;
22423
22424 bytepos = percent_position;
22425 charpos = (STRING_MULTIBYTE (elt)
22426 ? string_byte_to_char (elt, bytepos)
22427 : bytepos);
22428 spec = decode_mode_spec (it->w, c, field, &string);
22429 multibyte = STRINGP (string) && STRING_MULTIBYTE (string);
22430
22431 switch (mode_line_target)
22432 {
22433 case MODE_LINE_NOPROP:
22434 case MODE_LINE_TITLE:
22435 n += store_mode_line_noprop (spec, field, prec);
22436 break;
22437 case MODE_LINE_STRING:
22438 {
22439 Lisp_Object tem = build_string (spec);
22440 props = Ftext_properties_at (make_number (charpos), elt);
22441 /* Should only keep face property in props */
22442 n += store_mode_line_string (NULL, tem, false,
22443 field, prec, props);
22444 }
22445 break;
22446 case MODE_LINE_DISPLAY:
22447 {
22448 int nglyphs_before, nwritten;
22449
22450 nglyphs_before = it->glyph_row->used[TEXT_AREA];
22451 nwritten = display_string (spec, string, elt,
22452 charpos, 0, it,
22453 field, prec, 0,
22454 multibyte);
22455
22456 /* Assign to the glyphs written above the
22457 string where the `%x' came from, position
22458 of the `%'. */
22459 if (nwritten > 0)
22460 {
22461 struct glyph *glyph
22462 = (it->glyph_row->glyphs[TEXT_AREA]
22463 + nglyphs_before);
22464 int i;
22465
22466 for (i = 0; i < nwritten; ++i)
22467 {
22468 glyph[i].object = elt;
22469 glyph[i].charpos = charpos;
22470 }
22471
22472 n += nwritten;
22473 }
22474 }
22475 break;
22476 }
22477 }
22478 else /* c == 0 */
22479 break;
22480 }
22481 }
22482 }
22483 break;
22484
22485 case Lisp_Symbol:
22486 /* A symbol: process the value of the symbol recursively
22487 as if it appeared here directly. Avoid error if symbol void.
22488 Special case: if value of symbol is a string, output the string
22489 literally. */
22490 {
22491 register Lisp_Object tem;
22492
22493 /* If the variable is not marked as risky to set
22494 then its contents are risky to use. */
22495 if (NILP (Fget (elt, Qrisky_local_variable)))
22496 risky = true;
22497
22498 tem = Fboundp (elt);
22499 if (!NILP (tem))
22500 {
22501 tem = Fsymbol_value (elt);
22502 /* If value is a string, output that string literally:
22503 don't check for % within it. */
22504 if (STRINGP (tem))
22505 literal = true;
22506
22507 if (!EQ (tem, elt))
22508 {
22509 /* Give up right away for nil or t. */
22510 elt = tem;
22511 goto tail_recurse;
22512 }
22513 }
22514 }
22515 break;
22516
22517 case Lisp_Cons:
22518 {
22519 register Lisp_Object car, tem;
22520
22521 /* A cons cell: five distinct cases.
22522 If first element is :eval or :propertize, do something special.
22523 If first element is a string or a cons, process all the elements
22524 and effectively concatenate them.
22525 If first element is a negative number, truncate displaying cdr to
22526 at most that many characters. If positive, pad (with spaces)
22527 to at least that many characters.
22528 If first element is a symbol, process the cadr or caddr recursively
22529 according to whether the symbol's value is non-nil or nil. */
22530 car = XCAR (elt);
22531 if (EQ (car, QCeval))
22532 {
22533 /* An element of the form (:eval FORM) means evaluate FORM
22534 and use the result as mode line elements. */
22535
22536 if (risky)
22537 break;
22538
22539 if (CONSP (XCDR (elt)))
22540 {
22541 Lisp_Object spec;
22542 spec = safe__eval (true, XCAR (XCDR (elt)));
22543 n += display_mode_element (it, depth, field_width - n,
22544 precision - n, spec, props,
22545 risky);
22546 }
22547 }
22548 else if (EQ (car, QCpropertize))
22549 {
22550 /* An element of the form (:propertize ELT PROPS...)
22551 means display ELT but applying properties PROPS. */
22552
22553 if (risky)
22554 break;
22555
22556 if (CONSP (XCDR (elt)))
22557 n += display_mode_element (it, depth, field_width - n,
22558 precision - n, XCAR (XCDR (elt)),
22559 XCDR (XCDR (elt)), risky);
22560 }
22561 else if (SYMBOLP (car))
22562 {
22563 tem = Fboundp (car);
22564 elt = XCDR (elt);
22565 if (!CONSP (elt))
22566 goto invalid;
22567 /* elt is now the cdr, and we know it is a cons cell.
22568 Use its car if CAR has a non-nil value. */
22569 if (!NILP (tem))
22570 {
22571 tem = Fsymbol_value (car);
22572 if (!NILP (tem))
22573 {
22574 elt = XCAR (elt);
22575 goto tail_recurse;
22576 }
22577 }
22578 /* Symbol's value is nil (or symbol is unbound)
22579 Get the cddr of the original list
22580 and if possible find the caddr and use that. */
22581 elt = XCDR (elt);
22582 if (NILP (elt))
22583 break;
22584 else if (!CONSP (elt))
22585 goto invalid;
22586 elt = XCAR (elt);
22587 goto tail_recurse;
22588 }
22589 else if (INTEGERP (car))
22590 {
22591 register int lim = XINT (car);
22592 elt = XCDR (elt);
22593 if (lim < 0)
22594 {
22595 /* Negative int means reduce maximum width. */
22596 if (precision <= 0)
22597 precision = -lim;
22598 else
22599 precision = min (precision, -lim);
22600 }
22601 else if (lim > 0)
22602 {
22603 /* Padding specified. Don't let it be more than
22604 current maximum. */
22605 if (precision > 0)
22606 lim = min (precision, lim);
22607
22608 /* If that's more padding than already wanted, queue it.
22609 But don't reduce padding already specified even if
22610 that is beyond the current truncation point. */
22611 field_width = max (lim, field_width);
22612 }
22613 goto tail_recurse;
22614 }
22615 else if (STRINGP (car) || CONSP (car))
22616 {
22617 Lisp_Object halftail = elt;
22618 int len = 0;
22619
22620 while (CONSP (elt)
22621 && (precision <= 0 || n < precision))
22622 {
22623 n += display_mode_element (it, depth,
22624 /* Do padding only after the last
22625 element in the list. */
22626 (! CONSP (XCDR (elt))
22627 ? field_width - n
22628 : 0),
22629 precision - n, XCAR (elt),
22630 props, risky);
22631 elt = XCDR (elt);
22632 len++;
22633 if ((len & 1) == 0)
22634 halftail = XCDR (halftail);
22635 /* Check for cycle. */
22636 if (EQ (halftail, elt))
22637 break;
22638 }
22639 }
22640 }
22641 break;
22642
22643 default:
22644 invalid:
22645 elt = build_string ("*invalid*");
22646 goto tail_recurse;
22647 }
22648
22649 /* Pad to FIELD_WIDTH. */
22650 if (field_width > 0 && n < field_width)
22651 {
22652 switch (mode_line_target)
22653 {
22654 case MODE_LINE_NOPROP:
22655 case MODE_LINE_TITLE:
22656 n += store_mode_line_noprop ("", field_width - n, 0);
22657 break;
22658 case MODE_LINE_STRING:
22659 n += store_mode_line_string ("", Qnil, false, field_width - n, 0,
22660 Qnil);
22661 break;
22662 case MODE_LINE_DISPLAY:
22663 n += display_string ("", Qnil, Qnil, 0, 0, it, field_width - n,
22664 0, 0, 0);
22665 break;
22666 }
22667 }
22668
22669 return n;
22670 }
22671
22672 /* Store a mode-line string element in mode_line_string_list.
22673
22674 If STRING is non-null, display that C string. Otherwise, the Lisp
22675 string LISP_STRING is displayed.
22676
22677 FIELD_WIDTH is the minimum number of output glyphs to produce.
22678 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22679 with spaces. FIELD_WIDTH <= 0 means don't pad.
22680
22681 PRECISION is the maximum number of characters to output from
22682 STRING. PRECISION <= 0 means don't truncate the string.
22683
22684 If COPY_STRING, make a copy of LISP_STRING before adding
22685 properties to the string.
22686
22687 PROPS are the properties to add to the string.
22688 The mode_line_string_face face property is always added to the string.
22689 */
22690
22691 static int
22692 store_mode_line_string (const char *string, Lisp_Object lisp_string,
22693 bool copy_string,
22694 int field_width, int precision, Lisp_Object props)
22695 {
22696 ptrdiff_t len;
22697 int n = 0;
22698
22699 if (string != NULL)
22700 {
22701 len = strlen (string);
22702 if (precision > 0 && len > precision)
22703 len = precision;
22704 lisp_string = make_string (string, len);
22705 if (NILP (props))
22706 props = mode_line_string_face_prop;
22707 else if (!NILP (mode_line_string_face))
22708 {
22709 Lisp_Object face = Fplist_get (props, Qface);
22710 props = Fcopy_sequence (props);
22711 if (NILP (face))
22712 face = mode_line_string_face;
22713 else
22714 face = list2 (face, mode_line_string_face);
22715 props = Fplist_put (props, Qface, face);
22716 }
22717 Fadd_text_properties (make_number (0), make_number (len),
22718 props, lisp_string);
22719 }
22720 else
22721 {
22722 len = XFASTINT (Flength (lisp_string));
22723 if (precision > 0 && len > precision)
22724 {
22725 len = precision;
22726 lisp_string = Fsubstring (lisp_string, make_number (0), make_number (len));
22727 precision = -1;
22728 }
22729 if (!NILP (mode_line_string_face))
22730 {
22731 Lisp_Object face;
22732 if (NILP (props))
22733 props = Ftext_properties_at (make_number (0), lisp_string);
22734 face = Fplist_get (props, Qface);
22735 if (NILP (face))
22736 face = mode_line_string_face;
22737 else
22738 face = list2 (face, mode_line_string_face);
22739 props = list2 (Qface, face);
22740 if (copy_string)
22741 lisp_string = Fcopy_sequence (lisp_string);
22742 }
22743 if (!NILP (props))
22744 Fadd_text_properties (make_number (0), make_number (len),
22745 props, lisp_string);
22746 }
22747
22748 if (len > 0)
22749 {
22750 mode_line_string_list = Fcons (lisp_string, mode_line_string_list);
22751 n += len;
22752 }
22753
22754 if (field_width > len)
22755 {
22756 field_width -= len;
22757 lisp_string = Fmake_string (make_number (field_width), make_number (' '));
22758 if (!NILP (props))
22759 Fadd_text_properties (make_number (0), make_number (field_width),
22760 props, lisp_string);
22761 mode_line_string_list = Fcons (lisp_string, mode_line_string_list);
22762 n += field_width;
22763 }
22764
22765 return n;
22766 }
22767
22768
22769 DEFUN ("format-mode-line", Fformat_mode_line, Sformat_mode_line,
22770 1, 4, 0,
22771 doc: /* Format a string out of a mode line format specification.
22772 First arg FORMAT specifies the mode line format (see `mode-line-format'
22773 for details) to use.
22774
22775 By default, the format is evaluated for the currently selected window.
22776
22777 Optional second arg FACE specifies the face property to put on all
22778 characters for which no face is specified. The value nil means the
22779 default face. The value t means whatever face the window's mode line
22780 currently uses (either `mode-line' or `mode-line-inactive',
22781 depending on whether the window is the selected window or not).
22782 An integer value means the value string has no text
22783 properties.
22784
22785 Optional third and fourth args WINDOW and BUFFER specify the window
22786 and buffer to use as the context for the formatting (defaults
22787 are the selected window and the WINDOW's buffer). */)
22788 (Lisp_Object format, Lisp_Object face,
22789 Lisp_Object window, Lisp_Object buffer)
22790 {
22791 struct it it;
22792 int len;
22793 struct window *w;
22794 struct buffer *old_buffer = NULL;
22795 int face_id;
22796 bool no_props = INTEGERP (face);
22797 ptrdiff_t count = SPECPDL_INDEX ();
22798 Lisp_Object str;
22799 int string_start = 0;
22800
22801 w = decode_any_window (window);
22802 XSETWINDOW (window, w);
22803
22804 if (NILP (buffer))
22805 buffer = w->contents;
22806 CHECK_BUFFER (buffer);
22807
22808 /* Make formatting the modeline a non-op when noninteractive, otherwise
22809 there will be problems later caused by a partially initialized frame. */
22810 if (NILP (format) || noninteractive)
22811 return empty_unibyte_string;
22812
22813 if (no_props)
22814 face = Qnil;
22815
22816 face_id = (NILP (face) || EQ (face, Qdefault)) ? DEFAULT_FACE_ID
22817 : EQ (face, Qt) ? (EQ (window, selected_window)
22818 ? MODE_LINE_FACE_ID : MODE_LINE_INACTIVE_FACE_ID)
22819 : EQ (face, Qmode_line) ? MODE_LINE_FACE_ID
22820 : EQ (face, Qmode_line_inactive) ? MODE_LINE_INACTIVE_FACE_ID
22821 : EQ (face, Qheader_line) ? HEADER_LINE_FACE_ID
22822 : EQ (face, Qtool_bar) ? TOOL_BAR_FACE_ID
22823 : DEFAULT_FACE_ID;
22824
22825 old_buffer = current_buffer;
22826
22827 /* Save things including mode_line_proptrans_alist,
22828 and set that to nil so that we don't alter the outer value. */
22829 record_unwind_protect (unwind_format_mode_line,
22830 format_mode_line_unwind_data
22831 (XFRAME (WINDOW_FRAME (w)),
22832 old_buffer, selected_window, true));
22833 mode_line_proptrans_alist = Qnil;
22834
22835 Fselect_window (window, Qt);
22836 set_buffer_internal_1 (XBUFFER (buffer));
22837
22838 init_iterator (&it, w, -1, -1, NULL, face_id);
22839
22840 if (no_props)
22841 {
22842 mode_line_target = MODE_LINE_NOPROP;
22843 mode_line_string_face_prop = Qnil;
22844 mode_line_string_list = Qnil;
22845 string_start = MODE_LINE_NOPROP_LEN (0);
22846 }
22847 else
22848 {
22849 mode_line_target = MODE_LINE_STRING;
22850 mode_line_string_list = Qnil;
22851 mode_line_string_face = face;
22852 mode_line_string_face_prop
22853 = NILP (face) ? Qnil : list2 (Qface, face);
22854 }
22855
22856 push_kboard (FRAME_KBOARD (it.f));
22857 display_mode_element (&it, 0, 0, 0, format, Qnil, false);
22858 pop_kboard ();
22859
22860 if (no_props)
22861 {
22862 len = MODE_LINE_NOPROP_LEN (string_start);
22863 str = make_string (mode_line_noprop_buf + string_start, len);
22864 }
22865 else
22866 {
22867 mode_line_string_list = Fnreverse (mode_line_string_list);
22868 str = Fmapconcat (Qidentity, mode_line_string_list,
22869 empty_unibyte_string);
22870 }
22871
22872 unbind_to (count, Qnil);
22873 return str;
22874 }
22875
22876 /* Write a null-terminated, right justified decimal representation of
22877 the positive integer D to BUF using a minimal field width WIDTH. */
22878
22879 static void
22880 pint2str (register char *buf, register int width, register ptrdiff_t d)
22881 {
22882 register char *p = buf;
22883
22884 if (d <= 0)
22885 *p++ = '0';
22886 else
22887 {
22888 while (d > 0)
22889 {
22890 *p++ = d % 10 + '0';
22891 d /= 10;
22892 }
22893 }
22894
22895 for (width -= (int) (p - buf); width > 0; --width)
22896 *p++ = ' ';
22897 *p-- = '\0';
22898 while (p > buf)
22899 {
22900 d = *buf;
22901 *buf++ = *p;
22902 *p-- = d;
22903 }
22904 }
22905
22906 /* Write a null-terminated, right justified decimal and "human
22907 readable" representation of the nonnegative integer D to BUF using
22908 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22909
22910 static const char power_letter[] =
22911 {
22912 0, /* no letter */
22913 'k', /* kilo */
22914 'M', /* mega */
22915 'G', /* giga */
22916 'T', /* tera */
22917 'P', /* peta */
22918 'E', /* exa */
22919 'Z', /* zetta */
22920 'Y' /* yotta */
22921 };
22922
22923 static void
22924 pint2hrstr (char *buf, int width, ptrdiff_t d)
22925 {
22926 /* We aim to represent the nonnegative integer D as
22927 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22928 ptrdiff_t quotient = d;
22929 int remainder = 0;
22930 /* -1 means: do not use TENTHS. */
22931 int tenths = -1;
22932 int exponent = 0;
22933
22934 /* Length of QUOTIENT.TENTHS as a string. */
22935 int length;
22936
22937 char * psuffix;
22938 char * p;
22939
22940 if (quotient >= 1000)
22941 {
22942 /* Scale to the appropriate EXPONENT. */
22943 do
22944 {
22945 remainder = quotient % 1000;
22946 quotient /= 1000;
22947 exponent++;
22948 }
22949 while (quotient >= 1000);
22950
22951 /* Round to nearest and decide whether to use TENTHS or not. */
22952 if (quotient <= 9)
22953 {
22954 tenths = remainder / 100;
22955 if (remainder % 100 >= 50)
22956 {
22957 if (tenths < 9)
22958 tenths++;
22959 else
22960 {
22961 quotient++;
22962 if (quotient == 10)
22963 tenths = -1;
22964 else
22965 tenths = 0;
22966 }
22967 }
22968 }
22969 else
22970 if (remainder >= 500)
22971 {
22972 if (quotient < 999)
22973 quotient++;
22974 else
22975 {
22976 quotient = 1;
22977 exponent++;
22978 tenths = 0;
22979 }
22980 }
22981 }
22982
22983 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22984 if (tenths == -1 && quotient <= 99)
22985 if (quotient <= 9)
22986 length = 1;
22987 else
22988 length = 2;
22989 else
22990 length = 3;
22991 p = psuffix = buf + max (width, length);
22992
22993 /* Print EXPONENT. */
22994 *psuffix++ = power_letter[exponent];
22995 *psuffix = '\0';
22996
22997 /* Print TENTHS. */
22998 if (tenths >= 0)
22999 {
23000 *--p = '0' + tenths;
23001 *--p = '.';
23002 }
23003
23004 /* Print QUOTIENT. */
23005 do
23006 {
23007 int digit = quotient % 10;
23008 *--p = '0' + digit;
23009 }
23010 while ((quotient /= 10) != 0);
23011
23012 /* Print leading spaces. */
23013 while (buf < p)
23014 *--p = ' ';
23015 }
23016
23017 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
23018 If EOL_FLAG, set also a mnemonic character for end-of-line
23019 type of CODING_SYSTEM. Return updated pointer into BUF. */
23020
23021 static unsigned char invalid_eol_type[] = "(*invalid*)";
23022
23023 static char *
23024 decode_mode_spec_coding (Lisp_Object coding_system, char *buf, bool eol_flag)
23025 {
23026 Lisp_Object val;
23027 bool multibyte = !NILP (BVAR (current_buffer, enable_multibyte_characters));
23028 const unsigned char *eol_str;
23029 int eol_str_len;
23030 /* The EOL conversion we are using. */
23031 Lisp_Object eoltype;
23032
23033 val = CODING_SYSTEM_SPEC (coding_system);
23034 eoltype = Qnil;
23035
23036 if (!VECTORP (val)) /* Not yet decided. */
23037 {
23038 *buf++ = multibyte ? '-' : ' ';
23039 if (eol_flag)
23040 eoltype = eol_mnemonic_undecided;
23041 /* Don't mention EOL conversion if it isn't decided. */
23042 }
23043 else
23044 {
23045 Lisp_Object attrs;
23046 Lisp_Object eolvalue;
23047
23048 attrs = AREF (val, 0);
23049 eolvalue = AREF (val, 2);
23050
23051 *buf++ = multibyte
23052 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs))
23053 : ' ';
23054
23055 if (eol_flag)
23056 {
23057 /* The EOL conversion that is normal on this system. */
23058
23059 if (NILP (eolvalue)) /* Not yet decided. */
23060 eoltype = eol_mnemonic_undecided;
23061 else if (VECTORP (eolvalue)) /* Not yet decided. */
23062 eoltype = eol_mnemonic_undecided;
23063 else /* eolvalue is Qunix, Qdos, or Qmac. */
23064 eoltype = (EQ (eolvalue, Qunix)
23065 ? eol_mnemonic_unix
23066 : EQ (eolvalue, Qdos)
23067 ? eol_mnemonic_dos : eol_mnemonic_mac);
23068 }
23069 }
23070
23071 if (eol_flag)
23072 {
23073 /* Mention the EOL conversion if it is not the usual one. */
23074 if (STRINGP (eoltype))
23075 {
23076 eol_str = SDATA (eoltype);
23077 eol_str_len = SBYTES (eoltype);
23078 }
23079 else if (CHARACTERP (eoltype))
23080 {
23081 int c = XFASTINT (eoltype);
23082 return buf + CHAR_STRING (c, (unsigned char *) buf);
23083 }
23084 else
23085 {
23086 eol_str = invalid_eol_type;
23087 eol_str_len = sizeof (invalid_eol_type) - 1;
23088 }
23089 memcpy (buf, eol_str, eol_str_len);
23090 buf += eol_str_len;
23091 }
23092
23093 return buf;
23094 }
23095
23096 /* Return a string for the output of a mode line %-spec for window W,
23097 generated by character C. FIELD_WIDTH > 0 means pad the string
23098 returned with spaces to that value. Return a Lisp string in
23099 *STRING if the resulting string is taken from that Lisp string.
23100
23101 Note we operate on the current buffer for most purposes. */
23102
23103 static char lots_of_dashes[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23104
23105 static const char *
23106 decode_mode_spec (struct window *w, register int c, int field_width,
23107 Lisp_Object *string)
23108 {
23109 Lisp_Object obj;
23110 struct frame *f = XFRAME (WINDOW_FRAME (w));
23111 char *decode_mode_spec_buf = f->decode_mode_spec_buffer;
23112 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23113 produce strings from numerical values, so limit preposterously
23114 large values of FIELD_WIDTH to avoid overrunning the buffer's
23115 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23116 bytes plus the terminating null. */
23117 int width = min (field_width, FRAME_MESSAGE_BUF_SIZE (f));
23118 struct buffer *b = current_buffer;
23119
23120 obj = Qnil;
23121 *string = Qnil;
23122
23123 switch (c)
23124 {
23125 case '*':
23126 if (!NILP (BVAR (b, read_only)))
23127 return "%";
23128 if (BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
23129 return "*";
23130 return "-";
23131
23132 case '+':
23133 /* This differs from %* only for a modified read-only buffer. */
23134 if (BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
23135 return "*";
23136 if (!NILP (BVAR (b, read_only)))
23137 return "%";
23138 return "-";
23139
23140 case '&':
23141 /* This differs from %* in ignoring read-only-ness. */
23142 if (BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
23143 return "*";
23144 return "-";
23145
23146 case '%':
23147 return "%";
23148
23149 case '[':
23150 {
23151 int i;
23152 char *p;
23153
23154 if (command_loop_level > 5)
23155 return "[[[... ";
23156 p = decode_mode_spec_buf;
23157 for (i = 0; i < command_loop_level; i++)
23158 *p++ = '[';
23159 *p = 0;
23160 return decode_mode_spec_buf;
23161 }
23162
23163 case ']':
23164 {
23165 int i;
23166 char *p;
23167
23168 if (command_loop_level > 5)
23169 return " ...]]]";
23170 p = decode_mode_spec_buf;
23171 for (i = 0; i < command_loop_level; i++)
23172 *p++ = ']';
23173 *p = 0;
23174 return decode_mode_spec_buf;
23175 }
23176
23177 case '-':
23178 {
23179 register int i;
23180
23181 /* Let lots_of_dashes be a string of infinite length. */
23182 if (mode_line_target == MODE_LINE_NOPROP
23183 || mode_line_target == MODE_LINE_STRING)
23184 return "--";
23185 if (field_width <= 0
23186 || field_width > sizeof (lots_of_dashes))
23187 {
23188 for (i = 0; i < FRAME_MESSAGE_BUF_SIZE (f) - 1; ++i)
23189 decode_mode_spec_buf[i] = '-';
23190 decode_mode_spec_buf[i] = '\0';
23191 return decode_mode_spec_buf;
23192 }
23193 else
23194 return lots_of_dashes;
23195 }
23196
23197 case 'b':
23198 obj = BVAR (b, name);
23199 break;
23200
23201 case 'c':
23202 /* %c and %l are ignored in `frame-title-format'.
23203 (In redisplay_internal, the frame title is drawn _before_ the
23204 windows are updated, so the stuff which depends on actual
23205 window contents (such as %l) may fail to render properly, or
23206 even crash emacs.) */
23207 if (mode_line_target == MODE_LINE_TITLE)
23208 return "";
23209 else
23210 {
23211 ptrdiff_t col = current_column ();
23212 w->column_number_displayed = col;
23213 pint2str (decode_mode_spec_buf, width, col);
23214 return decode_mode_spec_buf;
23215 }
23216
23217 case 'e':
23218 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23219 {
23220 if (NILP (Vmemory_full))
23221 return "";
23222 else
23223 return "!MEM FULL! ";
23224 }
23225 #else
23226 return "";
23227 #endif
23228
23229 case 'F':
23230 /* %F displays the frame name. */
23231 if (!NILP (f->title))
23232 return SSDATA (f->title);
23233 if (f->explicit_name || ! FRAME_WINDOW_P (f))
23234 return SSDATA (f->name);
23235 return "Emacs";
23236
23237 case 'f':
23238 obj = BVAR (b, filename);
23239 break;
23240
23241 case 'i':
23242 {
23243 ptrdiff_t size = ZV - BEGV;
23244 pint2str (decode_mode_spec_buf, width, size);
23245 return decode_mode_spec_buf;
23246 }
23247
23248 case 'I':
23249 {
23250 ptrdiff_t size = ZV - BEGV;
23251 pint2hrstr (decode_mode_spec_buf, width, size);
23252 return decode_mode_spec_buf;
23253 }
23254
23255 case 'l':
23256 {
23257 ptrdiff_t startpos, startpos_byte, line, linepos, linepos_byte;
23258 ptrdiff_t topline, nlines, height;
23259 ptrdiff_t junk;
23260
23261 /* %c and %l are ignored in `frame-title-format'. */
23262 if (mode_line_target == MODE_LINE_TITLE)
23263 return "";
23264
23265 startpos = marker_position (w->start);
23266 startpos_byte = marker_byte_position (w->start);
23267 height = WINDOW_TOTAL_LINES (w);
23268
23269 /* If we decided that this buffer isn't suitable for line numbers,
23270 don't forget that too fast. */
23271 if (w->base_line_pos == -1)
23272 goto no_value;
23273
23274 /* If the buffer is very big, don't waste time. */
23275 if (INTEGERP (Vline_number_display_limit)
23276 && BUF_ZV (b) - BUF_BEGV (b) > XINT (Vline_number_display_limit))
23277 {
23278 w->base_line_pos = 0;
23279 w->base_line_number = 0;
23280 goto no_value;
23281 }
23282
23283 if (w->base_line_number > 0
23284 && w->base_line_pos > 0
23285 && w->base_line_pos <= startpos)
23286 {
23287 line = w->base_line_number;
23288 linepos = w->base_line_pos;
23289 linepos_byte = buf_charpos_to_bytepos (b, linepos);
23290 }
23291 else
23292 {
23293 line = 1;
23294 linepos = BUF_BEGV (b);
23295 linepos_byte = BUF_BEGV_BYTE (b);
23296 }
23297
23298 /* Count lines from base line to window start position. */
23299 nlines = display_count_lines (linepos_byte,
23300 startpos_byte,
23301 startpos, &junk);
23302
23303 topline = nlines + line;
23304
23305 /* Determine a new base line, if the old one is too close
23306 or too far away, or if we did not have one.
23307 "Too close" means it's plausible a scroll-down would
23308 go back past it. */
23309 if (startpos == BUF_BEGV (b))
23310 {
23311 w->base_line_number = topline;
23312 w->base_line_pos = BUF_BEGV (b);
23313 }
23314 else if (nlines < height + 25 || nlines > height * 3 + 50
23315 || linepos == BUF_BEGV (b))
23316 {
23317 ptrdiff_t limit = BUF_BEGV (b);
23318 ptrdiff_t limit_byte = BUF_BEGV_BYTE (b);
23319 ptrdiff_t position;
23320 ptrdiff_t distance =
23321 (height * 2 + 30) * line_number_display_limit_width;
23322
23323 if (startpos - distance > limit)
23324 {
23325 limit = startpos - distance;
23326 limit_byte = CHAR_TO_BYTE (limit);
23327 }
23328
23329 nlines = display_count_lines (startpos_byte,
23330 limit_byte,
23331 - (height * 2 + 30),
23332 &position);
23333 /* If we couldn't find the lines we wanted within
23334 line_number_display_limit_width chars per line,
23335 give up on line numbers for this window. */
23336 if (position == limit_byte && limit == startpos - distance)
23337 {
23338 w->base_line_pos = -1;
23339 w->base_line_number = 0;
23340 goto no_value;
23341 }
23342
23343 w->base_line_number = topline - nlines;
23344 w->base_line_pos = BYTE_TO_CHAR (position);
23345 }
23346
23347 /* Now count lines from the start pos to point. */
23348 nlines = display_count_lines (startpos_byte,
23349 PT_BYTE, PT, &junk);
23350
23351 /* Record that we did display the line number. */
23352 line_number_displayed = true;
23353
23354 /* Make the string to show. */
23355 pint2str (decode_mode_spec_buf, width, topline + nlines);
23356 return decode_mode_spec_buf;
23357 no_value:
23358 {
23359 char *p = decode_mode_spec_buf;
23360 int pad = width - 2;
23361 while (pad-- > 0)
23362 *p++ = ' ';
23363 *p++ = '?';
23364 *p++ = '?';
23365 *p = '\0';
23366 return decode_mode_spec_buf;
23367 }
23368 }
23369 break;
23370
23371 case 'm':
23372 obj = BVAR (b, mode_name);
23373 break;
23374
23375 case 'n':
23376 if (BUF_BEGV (b) > BUF_BEG (b) || BUF_ZV (b) < BUF_Z (b))
23377 return " Narrow";
23378 break;
23379
23380 case 'p':
23381 {
23382 ptrdiff_t pos = marker_position (w->start);
23383 ptrdiff_t total = BUF_ZV (b) - BUF_BEGV (b);
23384
23385 if (w->window_end_pos <= BUF_Z (b) - BUF_ZV (b))
23386 {
23387 if (pos <= BUF_BEGV (b))
23388 return "All";
23389 else
23390 return "Bottom";
23391 }
23392 else if (pos <= BUF_BEGV (b))
23393 return "Top";
23394 else
23395 {
23396 if (total > 1000000)
23397 /* Do it differently for a large value, to avoid overflow. */
23398 total = ((pos - BUF_BEGV (b)) + (total / 100) - 1) / (total / 100);
23399 else
23400 total = ((pos - BUF_BEGV (b)) * 100 + total - 1) / total;
23401 /* We can't normally display a 3-digit number,
23402 so get us a 2-digit number that is close. */
23403 if (total == 100)
23404 total = 99;
23405 sprintf (decode_mode_spec_buf, "%2"pD"d%%", total);
23406 return decode_mode_spec_buf;
23407 }
23408 }
23409
23410 /* Display percentage of size above the bottom of the screen. */
23411 case 'P':
23412 {
23413 ptrdiff_t toppos = marker_position (w->start);
23414 ptrdiff_t botpos = BUF_Z (b) - w->window_end_pos;
23415 ptrdiff_t total = BUF_ZV (b) - BUF_BEGV (b);
23416
23417 if (botpos >= BUF_ZV (b))
23418 {
23419 if (toppos <= BUF_BEGV (b))
23420 return "All";
23421 else
23422 return "Bottom";
23423 }
23424 else
23425 {
23426 if (total > 1000000)
23427 /* Do it differently for a large value, to avoid overflow. */
23428 total = ((botpos - BUF_BEGV (b)) + (total / 100) - 1) / (total / 100);
23429 else
23430 total = ((botpos - BUF_BEGV (b)) * 100 + total - 1) / total;
23431 /* We can't normally display a 3-digit number,
23432 so get us a 2-digit number that is close. */
23433 if (total == 100)
23434 total = 99;
23435 if (toppos <= BUF_BEGV (b))
23436 sprintf (decode_mode_spec_buf, "Top%2"pD"d%%", total);
23437 else
23438 sprintf (decode_mode_spec_buf, "%2"pD"d%%", total);
23439 return decode_mode_spec_buf;
23440 }
23441 }
23442
23443 case 's':
23444 /* status of process */
23445 obj = Fget_buffer_process (Fcurrent_buffer ());
23446 if (NILP (obj))
23447 return "no process";
23448 #ifndef MSDOS
23449 obj = Fsymbol_name (Fprocess_status (obj));
23450 #endif
23451 break;
23452
23453 case '@':
23454 {
23455 ptrdiff_t count = inhibit_garbage_collection ();
23456 Lisp_Object curdir = BVAR (current_buffer, directory);
23457 Lisp_Object val = Qnil;
23458
23459 if (STRINGP (curdir))
23460 val = call1 (intern ("file-remote-p"), curdir);
23461
23462 unbind_to (count, Qnil);
23463
23464 if (NILP (val))
23465 return "-";
23466 else
23467 return "@";
23468 }
23469
23470 case 'z':
23471 /* coding-system (not including end-of-line format) */
23472 case 'Z':
23473 /* coding-system (including end-of-line type) */
23474 {
23475 bool eol_flag = (c == 'Z');
23476 char *p = decode_mode_spec_buf;
23477
23478 if (! FRAME_WINDOW_P (f))
23479 {
23480 /* No need to mention EOL here--the terminal never needs
23481 to do EOL conversion. */
23482 p = decode_mode_spec_coding (CODING_ID_NAME
23483 (FRAME_KEYBOARD_CODING (f)->id),
23484 p, false);
23485 p = decode_mode_spec_coding (CODING_ID_NAME
23486 (FRAME_TERMINAL_CODING (f)->id),
23487 p, false);
23488 }
23489 p = decode_mode_spec_coding (BVAR (b, buffer_file_coding_system),
23490 p, eol_flag);
23491
23492 #if false /* This proves to be annoying; I think we can do without. -- rms. */
23493 #ifdef subprocesses
23494 obj = Fget_buffer_process (Fcurrent_buffer ());
23495 if (PROCESSP (obj))
23496 {
23497 p = decode_mode_spec_coding
23498 (XPROCESS (obj)->decode_coding_system, p, eol_flag);
23499 p = decode_mode_spec_coding
23500 (XPROCESS (obj)->encode_coding_system, p, eol_flag);
23501 }
23502 #endif /* subprocesses */
23503 #endif /* false */
23504 *p = 0;
23505 return decode_mode_spec_buf;
23506 }
23507 }
23508
23509 if (STRINGP (obj))
23510 {
23511 *string = obj;
23512 return SSDATA (obj);
23513 }
23514 else
23515 return "";
23516 }
23517
23518
23519 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23520 means count lines back from START_BYTE. But don't go beyond
23521 LIMIT_BYTE. Return the number of lines thus found (always
23522 nonnegative).
23523
23524 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23525 either the position COUNT lines after/before START_BYTE, if we
23526 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23527 COUNT lines. */
23528
23529 static ptrdiff_t
23530 display_count_lines (ptrdiff_t start_byte,
23531 ptrdiff_t limit_byte, ptrdiff_t count,
23532 ptrdiff_t *byte_pos_ptr)
23533 {
23534 register unsigned char *cursor;
23535 unsigned char *base;
23536
23537 register ptrdiff_t ceiling;
23538 register unsigned char *ceiling_addr;
23539 ptrdiff_t orig_count = count;
23540
23541 /* If we are not in selective display mode,
23542 check only for newlines. */
23543 bool selective_display
23544 = (!NILP (BVAR (current_buffer, selective_display))
23545 && !INTEGERP (BVAR (current_buffer, selective_display)));
23546
23547 if (count > 0)
23548 {
23549 while (start_byte < limit_byte)
23550 {
23551 ceiling = BUFFER_CEILING_OF (start_byte);
23552 ceiling = min (limit_byte - 1, ceiling);
23553 ceiling_addr = BYTE_POS_ADDR (ceiling) + 1;
23554 base = (cursor = BYTE_POS_ADDR (start_byte));
23555
23556 do
23557 {
23558 if (selective_display)
23559 {
23560 while (*cursor != '\n' && *cursor != 015
23561 && ++cursor != ceiling_addr)
23562 continue;
23563 if (cursor == ceiling_addr)
23564 break;
23565 }
23566 else
23567 {
23568 cursor = memchr (cursor, '\n', ceiling_addr - cursor);
23569 if (! cursor)
23570 break;
23571 }
23572
23573 cursor++;
23574
23575 if (--count == 0)
23576 {
23577 start_byte += cursor - base;
23578 *byte_pos_ptr = start_byte;
23579 return orig_count;
23580 }
23581 }
23582 while (cursor < ceiling_addr);
23583
23584 start_byte += ceiling_addr - base;
23585 }
23586 }
23587 else
23588 {
23589 while (start_byte > limit_byte)
23590 {
23591 ceiling = BUFFER_FLOOR_OF (start_byte - 1);
23592 ceiling = max (limit_byte, ceiling);
23593 ceiling_addr = BYTE_POS_ADDR (ceiling);
23594 base = (cursor = BYTE_POS_ADDR (start_byte - 1) + 1);
23595 while (true)
23596 {
23597 if (selective_display)
23598 {
23599 while (--cursor >= ceiling_addr
23600 && *cursor != '\n' && *cursor != 015)
23601 continue;
23602 if (cursor < ceiling_addr)
23603 break;
23604 }
23605 else
23606 {
23607 cursor = memrchr (ceiling_addr, '\n', cursor - ceiling_addr);
23608 if (! cursor)
23609 break;
23610 }
23611
23612 if (++count == 0)
23613 {
23614 start_byte += cursor - base + 1;
23615 *byte_pos_ptr = start_byte;
23616 /* When scanning backwards, we should
23617 not count the newline posterior to which we stop. */
23618 return - orig_count - 1;
23619 }
23620 }
23621 start_byte += ceiling_addr - base;
23622 }
23623 }
23624
23625 *byte_pos_ptr = limit_byte;
23626
23627 if (count < 0)
23628 return - orig_count + count;
23629 return orig_count - count;
23630
23631 }
23632
23633
23634 \f
23635 /***********************************************************************
23636 Displaying strings
23637 ***********************************************************************/
23638
23639 /* Display a NUL-terminated string, starting with index START.
23640
23641 If STRING is non-null, display that C string. Otherwise, the Lisp
23642 string LISP_STRING is displayed. There's a case that STRING is
23643 non-null and LISP_STRING is not nil. It means STRING is a string
23644 data of LISP_STRING. In that case, we display LISP_STRING while
23645 ignoring its text properties.
23646
23647 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23648 FACE_STRING. Display STRING or LISP_STRING with the face at
23649 FACE_STRING_POS in FACE_STRING:
23650
23651 Display the string in the environment given by IT, but use the
23652 standard display table, temporarily.
23653
23654 FIELD_WIDTH is the minimum number of output glyphs to produce.
23655 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23656 with spaces. If STRING has more characters, more than FIELD_WIDTH
23657 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23658
23659 PRECISION is the maximum number of characters to output from
23660 STRING. PRECISION < 0 means don't truncate the string.
23661
23662 This is roughly equivalent to printf format specifiers:
23663
23664 FIELD_WIDTH PRECISION PRINTF
23665 ----------------------------------------
23666 -1 -1 %s
23667 -1 10 %.10s
23668 10 -1 %10s
23669 20 10 %20.10s
23670
23671 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23672 display them, and < 0 means obey the current buffer's value of
23673 enable_multibyte_characters.
23674
23675 Value is the number of columns displayed. */
23676
23677 static int
23678 display_string (const char *string, Lisp_Object lisp_string, Lisp_Object face_string,
23679 ptrdiff_t face_string_pos, ptrdiff_t start, struct it *it,
23680 int field_width, int precision, int max_x, int multibyte)
23681 {
23682 int hpos_at_start = it->hpos;
23683 int saved_face_id = it->face_id;
23684 struct glyph_row *row = it->glyph_row;
23685 ptrdiff_t it_charpos;
23686
23687 /* Initialize the iterator IT for iteration over STRING beginning
23688 with index START. */
23689 reseat_to_string (it, NILP (lisp_string) ? string : NULL, lisp_string, start,
23690 precision, field_width, multibyte);
23691 if (string && STRINGP (lisp_string))
23692 /* LISP_STRING is the one returned by decode_mode_spec. We should
23693 ignore its text properties. */
23694 it->stop_charpos = it->end_charpos;
23695
23696 /* If displaying STRING, set up the face of the iterator from
23697 FACE_STRING, if that's given. */
23698 if (STRINGP (face_string))
23699 {
23700 ptrdiff_t endptr;
23701 struct face *face;
23702
23703 it->face_id
23704 = face_at_string_position (it->w, face_string, face_string_pos,
23705 0, &endptr, it->base_face_id, false);
23706 face = FACE_FROM_ID (it->f, it->face_id);
23707 it->face_box_p = face->box != FACE_NO_BOX;
23708 }
23709
23710 /* Set max_x to the maximum allowed X position. Don't let it go
23711 beyond the right edge of the window. */
23712 if (max_x <= 0)
23713 max_x = it->last_visible_x;
23714 else
23715 max_x = min (max_x, it->last_visible_x);
23716
23717 /* Skip over display elements that are not visible. because IT->w is
23718 hscrolled. */
23719 if (it->current_x < it->first_visible_x)
23720 move_it_in_display_line_to (it, 100000, it->first_visible_x,
23721 MOVE_TO_POS | MOVE_TO_X);
23722
23723 row->ascent = it->max_ascent;
23724 row->height = it->max_ascent + it->max_descent;
23725 row->phys_ascent = it->max_phys_ascent;
23726 row->phys_height = it->max_phys_ascent + it->max_phys_descent;
23727 row->extra_line_spacing = it->max_extra_line_spacing;
23728
23729 if (STRINGP (it->string))
23730 it_charpos = IT_STRING_CHARPOS (*it);
23731 else
23732 it_charpos = IT_CHARPOS (*it);
23733
23734 /* This condition is for the case that we are called with current_x
23735 past last_visible_x. */
23736 while (it->current_x < max_x)
23737 {
23738 int x_before, x, n_glyphs_before, i, nglyphs;
23739
23740 /* Get the next display element. */
23741 if (!get_next_display_element (it))
23742 break;
23743
23744 /* Produce glyphs. */
23745 x_before = it->current_x;
23746 n_glyphs_before = row->used[TEXT_AREA];
23747 PRODUCE_GLYPHS (it);
23748
23749 nglyphs = row->used[TEXT_AREA] - n_glyphs_before;
23750 i = 0;
23751 x = x_before;
23752 while (i < nglyphs)
23753 {
23754 struct glyph *glyph = row->glyphs[TEXT_AREA] + n_glyphs_before + i;
23755
23756 if (it->line_wrap != TRUNCATE
23757 && x + glyph->pixel_width > max_x)
23758 {
23759 /* End of continued line or max_x reached. */
23760 if (CHAR_GLYPH_PADDING_P (*glyph))
23761 {
23762 /* A wide character is unbreakable. */
23763 if (row->reversed_p)
23764 unproduce_glyphs (it, row->used[TEXT_AREA]
23765 - n_glyphs_before);
23766 row->used[TEXT_AREA] = n_glyphs_before;
23767 it->current_x = x_before;
23768 }
23769 else
23770 {
23771 if (row->reversed_p)
23772 unproduce_glyphs (it, row->used[TEXT_AREA]
23773 - (n_glyphs_before + i));
23774 row->used[TEXT_AREA] = n_glyphs_before + i;
23775 it->current_x = x;
23776 }
23777 break;
23778 }
23779 else if (x + glyph->pixel_width >= it->first_visible_x)
23780 {
23781 /* Glyph is at least partially visible. */
23782 ++it->hpos;
23783 if (x < it->first_visible_x)
23784 row->x = x - it->first_visible_x;
23785 }
23786 else
23787 {
23788 /* Glyph is off the left margin of the display area.
23789 Should not happen. */
23790 emacs_abort ();
23791 }
23792
23793 row->ascent = max (row->ascent, it->max_ascent);
23794 row->height = max (row->height, it->max_ascent + it->max_descent);
23795 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
23796 row->phys_height = max (row->phys_height,
23797 it->max_phys_ascent + it->max_phys_descent);
23798 row->extra_line_spacing = max (row->extra_line_spacing,
23799 it->max_extra_line_spacing);
23800 x += glyph->pixel_width;
23801 ++i;
23802 }
23803
23804 /* Stop if max_x reached. */
23805 if (i < nglyphs)
23806 break;
23807
23808 /* Stop at line ends. */
23809 if (ITERATOR_AT_END_OF_LINE_P (it))
23810 {
23811 it->continuation_lines_width = 0;
23812 break;
23813 }
23814
23815 set_iterator_to_next (it, true);
23816 if (STRINGP (it->string))
23817 it_charpos = IT_STRING_CHARPOS (*it);
23818 else
23819 it_charpos = IT_CHARPOS (*it);
23820
23821 /* Stop if truncating at the right edge. */
23822 if (it->line_wrap == TRUNCATE
23823 && it->current_x >= it->last_visible_x)
23824 {
23825 /* Add truncation mark, but don't do it if the line is
23826 truncated at a padding space. */
23827 if (it_charpos < it->string_nchars)
23828 {
23829 if (!FRAME_WINDOW_P (it->f))
23830 {
23831 int ii, n;
23832
23833 if (it->current_x > it->last_visible_x)
23834 {
23835 if (!row->reversed_p)
23836 {
23837 for (ii = row->used[TEXT_AREA] - 1; ii > 0; --ii)
23838 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][ii]))
23839 break;
23840 }
23841 else
23842 {
23843 for (ii = 0; ii < row->used[TEXT_AREA]; ii++)
23844 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][ii]))
23845 break;
23846 unproduce_glyphs (it, ii + 1);
23847 ii = row->used[TEXT_AREA] - (ii + 1);
23848 }
23849 for (n = row->used[TEXT_AREA]; ii < n; ++ii)
23850 {
23851 row->used[TEXT_AREA] = ii;
23852 produce_special_glyphs (it, IT_TRUNCATION);
23853 }
23854 }
23855 produce_special_glyphs (it, IT_TRUNCATION);
23856 }
23857 row->truncated_on_right_p = true;
23858 }
23859 break;
23860 }
23861 }
23862
23863 /* Maybe insert a truncation at the left. */
23864 if (it->first_visible_x
23865 && it_charpos > 0)
23866 {
23867 if (!FRAME_WINDOW_P (it->f)
23868 || (row->reversed_p
23869 ? WINDOW_RIGHT_FRINGE_WIDTH (it->w)
23870 : WINDOW_LEFT_FRINGE_WIDTH (it->w)) == 0)
23871 insert_left_trunc_glyphs (it);
23872 row->truncated_on_left_p = true;
23873 }
23874
23875 it->face_id = saved_face_id;
23876
23877 /* Value is number of columns displayed. */
23878 return it->hpos - hpos_at_start;
23879 }
23880
23881
23882 \f
23883 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23884 appears as an element of LIST or as the car of an element of LIST.
23885 If PROPVAL is a list, compare each element against LIST in that
23886 way, and return 1/2 if any element of PROPVAL is found in LIST.
23887 Otherwise return 0. This function cannot quit.
23888 The return value is 2 if the text is invisible but with an ellipsis
23889 and 1 if it's invisible and without an ellipsis. */
23890
23891 int
23892 invisible_prop (Lisp_Object propval, Lisp_Object list)
23893 {
23894 Lisp_Object tail, proptail;
23895
23896 for (tail = list; CONSP (tail); tail = XCDR (tail))
23897 {
23898 register Lisp_Object tem;
23899 tem = XCAR (tail);
23900 if (EQ (propval, tem))
23901 return 1;
23902 if (CONSP (tem) && EQ (propval, XCAR (tem)))
23903 return NILP (XCDR (tem)) ? 1 : 2;
23904 }
23905
23906 if (CONSP (propval))
23907 {
23908 for (proptail = propval; CONSP (proptail); proptail = XCDR (proptail))
23909 {
23910 Lisp_Object propelt;
23911 propelt = XCAR (proptail);
23912 for (tail = list; CONSP (tail); tail = XCDR (tail))
23913 {
23914 register Lisp_Object tem;
23915 tem = XCAR (tail);
23916 if (EQ (propelt, tem))
23917 return 1;
23918 if (CONSP (tem) && EQ (propelt, XCAR (tem)))
23919 return NILP (XCDR (tem)) ? 1 : 2;
23920 }
23921 }
23922 }
23923
23924 return 0;
23925 }
23926
23927 DEFUN ("invisible-p", Finvisible_p, Sinvisible_p, 1, 1, 0,
23928 doc: /* Non-nil if the property makes the text invisible.
23929 POS-OR-PROP can be a marker or number, in which case it is taken to be
23930 a position in the current buffer and the value of the `invisible' property
23931 is checked; or it can be some other value, which is then presumed to be the
23932 value of the `invisible' property of the text of interest.
23933 The non-nil value returned can be t for truly invisible text or something
23934 else if the text is replaced by an ellipsis. */)
23935 (Lisp_Object pos_or_prop)
23936 {
23937 Lisp_Object prop
23938 = (NATNUMP (pos_or_prop) || MARKERP (pos_or_prop)
23939 ? Fget_char_property (pos_or_prop, Qinvisible, Qnil)
23940 : pos_or_prop);
23941 int invis = TEXT_PROP_MEANS_INVISIBLE (prop);
23942 return (invis == 0 ? Qnil
23943 : invis == 1 ? Qt
23944 : make_number (invis));
23945 }
23946
23947 /* Calculate a width or height in pixels from a specification using
23948 the following elements:
23949
23950 SPEC ::=
23951 NUM - a (fractional) multiple of the default font width/height
23952 (NUM) - specifies exactly NUM pixels
23953 UNIT - a fixed number of pixels, see below.
23954 ELEMENT - size of a display element in pixels, see below.
23955 (NUM . SPEC) - equals NUM * SPEC
23956 (+ SPEC SPEC ...) - add pixel values
23957 (- SPEC SPEC ...) - subtract pixel values
23958 (- SPEC) - negate pixel value
23959
23960 NUM ::=
23961 INT or FLOAT - a number constant
23962 SYMBOL - use symbol's (buffer local) variable binding.
23963
23964 UNIT ::=
23965 in - pixels per inch *)
23966 mm - pixels per 1/1000 meter *)
23967 cm - pixels per 1/100 meter *)
23968 width - width of current font in pixels.
23969 height - height of current font in pixels.
23970
23971 *) using the ratio(s) defined in display-pixels-per-inch.
23972
23973 ELEMENT ::=
23974
23975 left-fringe - left fringe width in pixels
23976 right-fringe - right fringe width in pixels
23977
23978 left-margin - left margin width in pixels
23979 right-margin - right margin width in pixels
23980
23981 scroll-bar - scroll-bar area width in pixels
23982
23983 Examples:
23984
23985 Pixels corresponding to 5 inches:
23986 (5 . in)
23987
23988 Total width of non-text areas on left side of window (if scroll-bar is on left):
23989 '(space :width (+ left-fringe left-margin scroll-bar))
23990
23991 Align to first text column (in header line):
23992 '(space :align-to 0)
23993
23994 Align to middle of text area minus half the width of variable `my-image'
23995 containing a loaded image:
23996 '(space :align-to (0.5 . (- text my-image)))
23997
23998 Width of left margin minus width of 1 character in the default font:
23999 '(space :width (- left-margin 1))
24000
24001 Width of left margin minus width of 2 characters in the current font:
24002 '(space :width (- left-margin (2 . width)))
24003
24004 Center 1 character over left-margin (in header line):
24005 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
24006
24007 Different ways to express width of left fringe plus left margin minus one pixel:
24008 '(space :width (- (+ left-fringe left-margin) (1)))
24009 '(space :width (+ left-fringe left-margin (- (1))))
24010 '(space :width (+ left-fringe left-margin (-1)))
24011
24012 */
24013
24014 static bool
24015 calc_pixel_width_or_height (double *res, struct it *it, Lisp_Object prop,
24016 struct font *font, bool width_p, int *align_to)
24017 {
24018 double pixels;
24019
24020 # define OK_PIXELS(val) (*res = (val), true)
24021 # define OK_ALIGN_TO(val) (*align_to = (val), true)
24022
24023 if (NILP (prop))
24024 return OK_PIXELS (0);
24025
24026 eassert (FRAME_LIVE_P (it->f));
24027
24028 if (SYMBOLP (prop))
24029 {
24030 if (SCHARS (SYMBOL_NAME (prop)) == 2)
24031 {
24032 char *unit = SSDATA (SYMBOL_NAME (prop));
24033
24034 if (unit[0] == 'i' && unit[1] == 'n')
24035 pixels = 1.0;
24036 else if (unit[0] == 'm' && unit[1] == 'm')
24037 pixels = 25.4;
24038 else if (unit[0] == 'c' && unit[1] == 'm')
24039 pixels = 2.54;
24040 else
24041 pixels = 0;
24042 if (pixels > 0)
24043 {
24044 double ppi = (width_p ? FRAME_RES_X (it->f)
24045 : FRAME_RES_Y (it->f));
24046
24047 if (ppi > 0)
24048 return OK_PIXELS (ppi / pixels);
24049 return false;
24050 }
24051 }
24052
24053 #ifdef HAVE_WINDOW_SYSTEM
24054 if (EQ (prop, Qheight))
24055 return OK_PIXELS (font
24056 ? normal_char_height (font, -1)
24057 : FRAME_LINE_HEIGHT (it->f));
24058 if (EQ (prop, Qwidth))
24059 return OK_PIXELS (font
24060 ? FONT_WIDTH (font)
24061 : FRAME_COLUMN_WIDTH (it->f));
24062 #else
24063 if (EQ (prop, Qheight) || EQ (prop, Qwidth))
24064 return OK_PIXELS (1);
24065 #endif
24066
24067 if (EQ (prop, Qtext))
24068 return OK_PIXELS (width_p
24069 ? window_box_width (it->w, TEXT_AREA)
24070 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it->w));
24071
24072 if (align_to && *align_to < 0)
24073 {
24074 *res = 0;
24075 if (EQ (prop, Qleft))
24076 return OK_ALIGN_TO (window_box_left_offset (it->w, TEXT_AREA));
24077 if (EQ (prop, Qright))
24078 return OK_ALIGN_TO (window_box_right_offset (it->w, TEXT_AREA));
24079 if (EQ (prop, Qcenter))
24080 return OK_ALIGN_TO (window_box_left_offset (it->w, TEXT_AREA)
24081 + window_box_width (it->w, TEXT_AREA) / 2);
24082 if (EQ (prop, Qleft_fringe))
24083 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it->w)
24084 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it->w)
24085 : window_box_right_offset (it->w, LEFT_MARGIN_AREA));
24086 if (EQ (prop, Qright_fringe))
24087 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it->w)
24088 ? window_box_right_offset (it->w, RIGHT_MARGIN_AREA)
24089 : window_box_right_offset (it->w, TEXT_AREA));
24090 if (EQ (prop, Qleft_margin))
24091 return OK_ALIGN_TO (window_box_left_offset (it->w, LEFT_MARGIN_AREA));
24092 if (EQ (prop, Qright_margin))
24093 return OK_ALIGN_TO (window_box_left_offset (it->w, RIGHT_MARGIN_AREA));
24094 if (EQ (prop, Qscroll_bar))
24095 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it->w)
24096 ? 0
24097 : (window_box_right_offset (it->w, RIGHT_MARGIN_AREA)
24098 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it->w)
24099 ? WINDOW_RIGHT_FRINGE_WIDTH (it->w)
24100 : 0)));
24101 }
24102 else
24103 {
24104 if (EQ (prop, Qleft_fringe))
24105 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it->w));
24106 if (EQ (prop, Qright_fringe))
24107 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it->w));
24108 if (EQ (prop, Qleft_margin))
24109 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it->w));
24110 if (EQ (prop, Qright_margin))
24111 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it->w));
24112 if (EQ (prop, Qscroll_bar))
24113 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it->w));
24114 }
24115
24116 prop = buffer_local_value (prop, it->w->contents);
24117 if (EQ (prop, Qunbound))
24118 prop = Qnil;
24119 }
24120
24121 if (NUMBERP (prop))
24122 {
24123 int base_unit = (width_p
24124 ? FRAME_COLUMN_WIDTH (it->f)
24125 : FRAME_LINE_HEIGHT (it->f));
24126 return OK_PIXELS (XFLOATINT (prop) * base_unit);
24127 }
24128
24129 if (CONSP (prop))
24130 {
24131 Lisp_Object car = XCAR (prop);
24132 Lisp_Object cdr = XCDR (prop);
24133
24134 if (SYMBOLP (car))
24135 {
24136 #ifdef HAVE_WINDOW_SYSTEM
24137 if (FRAME_WINDOW_P (it->f)
24138 && valid_image_p (prop))
24139 {
24140 ptrdiff_t id = lookup_image (it->f, prop);
24141 struct image *img = IMAGE_FROM_ID (it->f, id);
24142
24143 return OK_PIXELS (width_p ? img->width : img->height);
24144 }
24145 #endif
24146 if (EQ (car, Qplus) || EQ (car, Qminus))
24147 {
24148 bool first = true;
24149 double px;
24150
24151 pixels = 0;
24152 while (CONSP (cdr))
24153 {
24154 if (!calc_pixel_width_or_height (&px, it, XCAR (cdr),
24155 font, width_p, align_to))
24156 return false;
24157 if (first)
24158 pixels = (EQ (car, Qplus) ? px : -px), first = false;
24159 else
24160 pixels += px;
24161 cdr = XCDR (cdr);
24162 }
24163 if (EQ (car, Qminus))
24164 pixels = -pixels;
24165 return OK_PIXELS (pixels);
24166 }
24167
24168 car = buffer_local_value (car, it->w->contents);
24169 if (EQ (car, Qunbound))
24170 car = Qnil;
24171 }
24172
24173 if (NUMBERP (car))
24174 {
24175 double fact;
24176 pixels = XFLOATINT (car);
24177 if (NILP (cdr))
24178 return OK_PIXELS (pixels);
24179 if (calc_pixel_width_or_height (&fact, it, cdr,
24180 font, width_p, align_to))
24181 return OK_PIXELS (pixels * fact);
24182 return false;
24183 }
24184
24185 return false;
24186 }
24187
24188 return false;
24189 }
24190
24191 void
24192 get_font_ascent_descent (struct font *font, int *ascent, int *descent)
24193 {
24194 #ifdef HAVE_WINDOW_SYSTEM
24195 normal_char_ascent_descent (font, -1, ascent, descent);
24196 #else
24197 *ascent = 1;
24198 *descent = 0;
24199 #endif
24200 }
24201
24202 \f
24203 /***********************************************************************
24204 Glyph Display
24205 ***********************************************************************/
24206
24207 #ifdef HAVE_WINDOW_SYSTEM
24208
24209 #ifdef GLYPH_DEBUG
24210
24211 void
24212 dump_glyph_string (struct glyph_string *s)
24213 {
24214 fprintf (stderr, "glyph string\n");
24215 fprintf (stderr, " x, y, w, h = %d, %d, %d, %d\n",
24216 s->x, s->y, s->width, s->height);
24217 fprintf (stderr, " ybase = %d\n", s->ybase);
24218 fprintf (stderr, " hl = %d\n", s->hl);
24219 fprintf (stderr, " left overhang = %d, right = %d\n",
24220 s->left_overhang, s->right_overhang);
24221 fprintf (stderr, " nchars = %d\n", s->nchars);
24222 fprintf (stderr, " extends to end of line = %d\n",
24223 s->extends_to_end_of_line_p);
24224 fprintf (stderr, " font height = %d\n", FONT_HEIGHT (s->font));
24225 fprintf (stderr, " bg width = %d\n", s->background_width);
24226 }
24227
24228 #endif /* GLYPH_DEBUG */
24229
24230 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24231 of XChar2b structures for S; it can't be allocated in
24232 init_glyph_string because it must be allocated via `alloca'. W
24233 is the window on which S is drawn. ROW and AREA are the glyph row
24234 and area within the row from which S is constructed. START is the
24235 index of the first glyph structure covered by S. HL is a
24236 face-override for drawing S. */
24237
24238 #ifdef HAVE_NTGUI
24239 #define OPTIONAL_HDC(hdc) HDC hdc,
24240 #define DECLARE_HDC(hdc) HDC hdc;
24241 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24242 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24243 #endif
24244
24245 #ifndef OPTIONAL_HDC
24246 #define OPTIONAL_HDC(hdc)
24247 #define DECLARE_HDC(hdc)
24248 #define ALLOCATE_HDC(hdc, f)
24249 #define RELEASE_HDC(hdc, f)
24250 #endif
24251
24252 static void
24253 init_glyph_string (struct glyph_string *s,
24254 OPTIONAL_HDC (hdc)
24255 XChar2b *char2b, struct window *w, struct glyph_row *row,
24256 enum glyph_row_area area, int start, enum draw_glyphs_face hl)
24257 {
24258 memset (s, 0, sizeof *s);
24259 s->w = w;
24260 s->f = XFRAME (w->frame);
24261 #ifdef HAVE_NTGUI
24262 s->hdc = hdc;
24263 #endif
24264 s->display = FRAME_X_DISPLAY (s->f);
24265 s->window = FRAME_X_WINDOW (s->f);
24266 s->char2b = char2b;
24267 s->hl = hl;
24268 s->row = row;
24269 s->area = area;
24270 s->first_glyph = row->glyphs[area] + start;
24271 s->height = row->height;
24272 s->y = WINDOW_TO_FRAME_PIXEL_Y (w, row->y);
24273 s->ybase = s->y + row->ascent;
24274 }
24275
24276
24277 /* Append the list of glyph strings with head H and tail T to the list
24278 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24279
24280 static void
24281 append_glyph_string_lists (struct glyph_string **head, struct glyph_string **tail,
24282 struct glyph_string *h, struct glyph_string *t)
24283 {
24284 if (h)
24285 {
24286 if (*head)
24287 (*tail)->next = h;
24288 else
24289 *head = h;
24290 h->prev = *tail;
24291 *tail = t;
24292 }
24293 }
24294
24295
24296 /* Prepend the list of glyph strings with head H and tail T to the
24297 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24298 result. */
24299
24300 static void
24301 prepend_glyph_string_lists (struct glyph_string **head, struct glyph_string **tail,
24302 struct glyph_string *h, struct glyph_string *t)
24303 {
24304 if (h)
24305 {
24306 if (*head)
24307 (*head)->prev = t;
24308 else
24309 *tail = t;
24310 t->next = *head;
24311 *head = h;
24312 }
24313 }
24314
24315
24316 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24317 Set *HEAD and *TAIL to the resulting list. */
24318
24319 static void
24320 append_glyph_string (struct glyph_string **head, struct glyph_string **tail,
24321 struct glyph_string *s)
24322 {
24323 s->next = s->prev = NULL;
24324 append_glyph_string_lists (head, tail, s, s);
24325 }
24326
24327
24328 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24329 The encoding of C is returned in *CHAR2B. DISPLAY_P means
24330 make sure that X resources for the face returned are allocated.
24331 Value is a pointer to a realized face that is ready for display if
24332 DISPLAY_P. */
24333
24334 static struct face *
24335 get_char_face_and_encoding (struct frame *f, int c, int face_id,
24336 XChar2b *char2b, bool display_p)
24337 {
24338 struct face *face = FACE_FROM_ID (f, face_id);
24339 unsigned code = 0;
24340
24341 if (face->font)
24342 {
24343 code = face->font->driver->encode_char (face->font, c);
24344
24345 if (code == FONT_INVALID_CODE)
24346 code = 0;
24347 }
24348 STORE_XCHAR2B (char2b, (code >> 8), (code & 0xFF));
24349
24350 /* Make sure X resources of the face are allocated. */
24351 #ifdef HAVE_X_WINDOWS
24352 if (display_p)
24353 #endif
24354 {
24355 eassert (face != NULL);
24356 prepare_face_for_display (f, face);
24357 }
24358
24359 return face;
24360 }
24361
24362
24363 /* Get face and two-byte form of character glyph GLYPH on frame F.
24364 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24365 a pointer to a realized face that is ready for display. */
24366
24367 static struct face *
24368 get_glyph_face_and_encoding (struct frame *f, struct glyph *glyph,
24369 XChar2b *char2b)
24370 {
24371 struct face *face;
24372 unsigned code = 0;
24373
24374 eassert (glyph->type == CHAR_GLYPH);
24375 face = FACE_FROM_ID (f, glyph->face_id);
24376
24377 /* Make sure X resources of the face are allocated. */
24378 eassert (face != NULL);
24379 prepare_face_for_display (f, face);
24380
24381 if (face->font)
24382 {
24383 if (CHAR_BYTE8_P (glyph->u.ch))
24384 code = CHAR_TO_BYTE8 (glyph->u.ch);
24385 else
24386 code = face->font->driver->encode_char (face->font, glyph->u.ch);
24387
24388 if (code == FONT_INVALID_CODE)
24389 code = 0;
24390 }
24391
24392 STORE_XCHAR2B (char2b, (code >> 8), (code & 0xFF));
24393 return face;
24394 }
24395
24396
24397 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24398 Return true iff FONT has a glyph for C. */
24399
24400 static bool
24401 get_char_glyph_code (int c, struct font *font, XChar2b *char2b)
24402 {
24403 unsigned code;
24404
24405 if (CHAR_BYTE8_P (c))
24406 code = CHAR_TO_BYTE8 (c);
24407 else
24408 code = font->driver->encode_char (font, c);
24409
24410 if (code == FONT_INVALID_CODE)
24411 return false;
24412 STORE_XCHAR2B (char2b, (code >> 8), (code & 0xFF));
24413 return true;
24414 }
24415
24416
24417 /* Fill glyph string S with composition components specified by S->cmp.
24418
24419 BASE_FACE is the base face of the composition.
24420 S->cmp_from is the index of the first component for S.
24421
24422 OVERLAPS non-zero means S should draw the foreground only, and use
24423 its physical height for clipping. See also draw_glyphs.
24424
24425 Value is the index of a component not in S. */
24426
24427 static int
24428 fill_composite_glyph_string (struct glyph_string *s, struct face *base_face,
24429 int overlaps)
24430 {
24431 int i;
24432 /* For all glyphs of this composition, starting at the offset
24433 S->cmp_from, until we reach the end of the definition or encounter a
24434 glyph that requires the different face, add it to S. */
24435 struct face *face;
24436
24437 eassert (s);
24438
24439 s->for_overlaps = overlaps;
24440 s->face = NULL;
24441 s->font = NULL;
24442 for (i = s->cmp_from; i < s->cmp->glyph_len; i++)
24443 {
24444 int c = COMPOSITION_GLYPH (s->cmp, i);
24445
24446 /* TAB in a composition means display glyphs with padding space
24447 on the left or right. */
24448 if (c != '\t')
24449 {
24450 int face_id = FACE_FOR_CHAR (s->f, base_face->ascii_face, c,
24451 -1, Qnil);
24452
24453 face = get_char_face_and_encoding (s->f, c, face_id,
24454 s->char2b + i, true);
24455 if (face)
24456 {
24457 if (! s->face)
24458 {
24459 s->face = face;
24460 s->font = s->face->font;
24461 }
24462 else if (s->face != face)
24463 break;
24464 }
24465 }
24466 ++s->nchars;
24467 }
24468 s->cmp_to = i;
24469
24470 if (s->face == NULL)
24471 {
24472 s->face = base_face->ascii_face;
24473 s->font = s->face->font;
24474 }
24475
24476 /* All glyph strings for the same composition has the same width,
24477 i.e. the width set for the first component of the composition. */
24478 s->width = s->first_glyph->pixel_width;
24479
24480 /* If the specified font could not be loaded, use the frame's
24481 default font, but record the fact that we couldn't load it in
24482 the glyph string so that we can draw rectangles for the
24483 characters of the glyph string. */
24484 if (s->font == NULL)
24485 {
24486 s->font_not_found_p = true;
24487 s->font = FRAME_FONT (s->f);
24488 }
24489
24490 /* Adjust base line for subscript/superscript text. */
24491 s->ybase += s->first_glyph->voffset;
24492
24493 return s->cmp_to;
24494 }
24495
24496 static int
24497 fill_gstring_glyph_string (struct glyph_string *s, int face_id,
24498 int start, int end, int overlaps)
24499 {
24500 struct glyph *glyph, *last;
24501 Lisp_Object lgstring;
24502 int i;
24503
24504 s->for_overlaps = overlaps;
24505 glyph = s->row->glyphs[s->area] + start;
24506 last = s->row->glyphs[s->area] + end;
24507 s->cmp_id = glyph->u.cmp.id;
24508 s->cmp_from = glyph->slice.cmp.from;
24509 s->cmp_to = glyph->slice.cmp.to + 1;
24510 s->face = FACE_FROM_ID (s->f, face_id);
24511 lgstring = composition_gstring_from_id (s->cmp_id);
24512 s->font = XFONT_OBJECT (LGSTRING_FONT (lgstring));
24513 glyph++;
24514 while (glyph < last
24515 && glyph->u.cmp.automatic
24516 && glyph->u.cmp.id == s->cmp_id
24517 && s->cmp_to == glyph->slice.cmp.from)
24518 s->cmp_to = (glyph++)->slice.cmp.to + 1;
24519
24520 for (i = s->cmp_from; i < s->cmp_to; i++)
24521 {
24522 Lisp_Object lglyph = LGSTRING_GLYPH (lgstring, i);
24523 unsigned code = LGLYPH_CODE (lglyph);
24524
24525 STORE_XCHAR2B ((s->char2b + i), code >> 8, code & 0xFF);
24526 }
24527 s->width = composition_gstring_width (lgstring, s->cmp_from, s->cmp_to, NULL);
24528 return glyph - s->row->glyphs[s->area];
24529 }
24530
24531
24532 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24533 See the comment of fill_glyph_string for arguments.
24534 Value is the index of the first glyph not in S. */
24535
24536
24537 static int
24538 fill_glyphless_glyph_string (struct glyph_string *s, int face_id,
24539 int start, int end, int overlaps)
24540 {
24541 struct glyph *glyph, *last;
24542 int voffset;
24543
24544 eassert (s->first_glyph->type == GLYPHLESS_GLYPH);
24545 s->for_overlaps = overlaps;
24546 glyph = s->row->glyphs[s->area] + start;
24547 last = s->row->glyphs[s->area] + end;
24548 voffset = glyph->voffset;
24549 s->face = FACE_FROM_ID (s->f, face_id);
24550 s->font = s->face->font ? s->face->font : FRAME_FONT (s->f);
24551 s->nchars = 1;
24552 s->width = glyph->pixel_width;
24553 glyph++;
24554 while (glyph < last
24555 && glyph->type == GLYPHLESS_GLYPH
24556 && glyph->voffset == voffset
24557 && glyph->face_id == face_id)
24558 {
24559 s->nchars++;
24560 s->width += glyph->pixel_width;
24561 glyph++;
24562 }
24563 s->ybase += voffset;
24564 return glyph - s->row->glyphs[s->area];
24565 }
24566
24567
24568 /* Fill glyph string S from a sequence of character glyphs.
24569
24570 FACE_ID is the face id of the string. START is the index of the
24571 first glyph to consider, END is the index of the last + 1.
24572 OVERLAPS non-zero means S should draw the foreground only, and use
24573 its physical height for clipping. See also draw_glyphs.
24574
24575 Value is the index of the first glyph not in S. */
24576
24577 static int
24578 fill_glyph_string (struct glyph_string *s, int face_id,
24579 int start, int end, int overlaps)
24580 {
24581 struct glyph *glyph, *last;
24582 int voffset;
24583 bool glyph_not_available_p;
24584
24585 eassert (s->f == XFRAME (s->w->frame));
24586 eassert (s->nchars == 0);
24587 eassert (start >= 0 && end > start);
24588
24589 s->for_overlaps = overlaps;
24590 glyph = s->row->glyphs[s->area] + start;
24591 last = s->row->glyphs[s->area] + end;
24592 voffset = glyph->voffset;
24593 s->padding_p = glyph->padding_p;
24594 glyph_not_available_p = glyph->glyph_not_available_p;
24595
24596 while (glyph < last
24597 && glyph->type == CHAR_GLYPH
24598 && glyph->voffset == voffset
24599 /* Same face id implies same font, nowadays. */
24600 && glyph->face_id == face_id
24601 && glyph->glyph_not_available_p == glyph_not_available_p)
24602 {
24603 s->face = get_glyph_face_and_encoding (s->f, glyph,
24604 s->char2b + s->nchars);
24605 ++s->nchars;
24606 eassert (s->nchars <= end - start);
24607 s->width += glyph->pixel_width;
24608 if (glyph++->padding_p != s->padding_p)
24609 break;
24610 }
24611
24612 s->font = s->face->font;
24613
24614 /* If the specified font could not be loaded, use the frame's font,
24615 but record the fact that we couldn't load it in
24616 S->font_not_found_p so that we can draw rectangles for the
24617 characters of the glyph string. */
24618 if (s->font == NULL || glyph_not_available_p)
24619 {
24620 s->font_not_found_p = true;
24621 s->font = FRAME_FONT (s->f);
24622 }
24623
24624 /* Adjust base line for subscript/superscript text. */
24625 s->ybase += voffset;
24626
24627 eassert (s->face && s->face->gc);
24628 return glyph - s->row->glyphs[s->area];
24629 }
24630
24631
24632 /* Fill glyph string S from image glyph S->first_glyph. */
24633
24634 static void
24635 fill_image_glyph_string (struct glyph_string *s)
24636 {
24637 eassert (s->first_glyph->type == IMAGE_GLYPH);
24638 s->img = IMAGE_FROM_ID (s->f, s->first_glyph->u.img_id);
24639 eassert (s->img);
24640 s->slice = s->first_glyph->slice.img;
24641 s->face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
24642 s->font = s->face->font;
24643 s->width = s->first_glyph->pixel_width;
24644
24645 /* Adjust base line for subscript/superscript text. */
24646 s->ybase += s->first_glyph->voffset;
24647 }
24648
24649
24650 /* Fill glyph string S from a sequence of stretch glyphs.
24651
24652 START is the index of the first glyph to consider,
24653 END is the index of the last + 1.
24654
24655 Value is the index of the first glyph not in S. */
24656
24657 static int
24658 fill_stretch_glyph_string (struct glyph_string *s, int start, int end)
24659 {
24660 struct glyph *glyph, *last;
24661 int voffset, face_id;
24662
24663 eassert (s->first_glyph->type == STRETCH_GLYPH);
24664
24665 glyph = s->row->glyphs[s->area] + start;
24666 last = s->row->glyphs[s->area] + end;
24667 face_id = glyph->face_id;
24668 s->face = FACE_FROM_ID (s->f, face_id);
24669 s->font = s->face->font;
24670 s->width = glyph->pixel_width;
24671 s->nchars = 1;
24672 voffset = glyph->voffset;
24673
24674 for (++glyph;
24675 (glyph < last
24676 && glyph->type == STRETCH_GLYPH
24677 && glyph->voffset == voffset
24678 && glyph->face_id == face_id);
24679 ++glyph)
24680 s->width += glyph->pixel_width;
24681
24682 /* Adjust base line for subscript/superscript text. */
24683 s->ybase += voffset;
24684
24685 /* The case that face->gc == 0 is handled when drawing the glyph
24686 string by calling prepare_face_for_display. */
24687 eassert (s->face);
24688 return glyph - s->row->glyphs[s->area];
24689 }
24690
24691 static struct font_metrics *
24692 get_per_char_metric (struct font *font, XChar2b *char2b)
24693 {
24694 static struct font_metrics metrics;
24695 unsigned code;
24696
24697 if (! font)
24698 return NULL;
24699 code = (XCHAR2B_BYTE1 (char2b) << 8) | XCHAR2B_BYTE2 (char2b);
24700 if (code == FONT_INVALID_CODE)
24701 return NULL;
24702 font->driver->text_extents (font, &code, 1, &metrics);
24703 return &metrics;
24704 }
24705
24706 /* A subroutine that computes "normal" values of ASCENT and DESCENT
24707 for FONT. Values are taken from font-global ones, except for fonts
24708 that claim preposterously large values, but whose glyphs actually
24709 have reasonable dimensions. C is the character to use for metrics
24710 if the font-global values are too large; if C is negative, the
24711 function selects a default character. */
24712 static void
24713 normal_char_ascent_descent (struct font *font, int c, int *ascent, int *descent)
24714 {
24715 *ascent = FONT_BASE (font);
24716 *descent = FONT_DESCENT (font);
24717
24718 if (FONT_TOO_HIGH (font))
24719 {
24720 XChar2b char2b;
24721
24722 /* Get metrics of C, defaulting to a reasonably sized ASCII
24723 character. */
24724 if (get_char_glyph_code (c >= 0 ? c : '{', font, &char2b))
24725 {
24726 struct font_metrics *pcm = get_per_char_metric (font, &char2b);
24727
24728 if (!(pcm->width == 0 && pcm->rbearing == 0 && pcm->lbearing == 0))
24729 {
24730 /* We add 1 pixel to character dimensions as heuristics
24731 that produces nicer display, e.g. when the face has
24732 the box attribute. */
24733 *ascent = pcm->ascent + 1;
24734 *descent = pcm->descent + 1;
24735 }
24736 }
24737 }
24738 }
24739
24740 /* A subroutine that computes a reasonable "normal character height"
24741 for fonts that claim preposterously large vertical dimensions, but
24742 whose glyphs are actually reasonably sized. C is the character
24743 whose metrics to use for those fonts, or -1 for default
24744 character. */
24745 static int
24746 normal_char_height (struct font *font, int c)
24747 {
24748 int ascent, descent;
24749
24750 normal_char_ascent_descent (font, c, &ascent, &descent);
24751
24752 return ascent + descent;
24753 }
24754
24755 /* EXPORT for RIF:
24756 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24757 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24758 assumed to be zero. */
24759
24760 void
24761 x_get_glyph_overhangs (struct glyph *glyph, struct frame *f, int *left, int *right)
24762 {
24763 *left = *right = 0;
24764
24765 if (glyph->type == CHAR_GLYPH)
24766 {
24767 XChar2b char2b;
24768 struct face *face = get_glyph_face_and_encoding (f, glyph, &char2b);
24769 if (face->font)
24770 {
24771 struct font_metrics *pcm = get_per_char_metric (face->font, &char2b);
24772 if (pcm)
24773 {
24774 if (pcm->rbearing > pcm->width)
24775 *right = pcm->rbearing - pcm->width;
24776 if (pcm->lbearing < 0)
24777 *left = -pcm->lbearing;
24778 }
24779 }
24780 }
24781 else if (glyph->type == COMPOSITE_GLYPH)
24782 {
24783 if (! glyph->u.cmp.automatic)
24784 {
24785 struct composition *cmp = composition_table[glyph->u.cmp.id];
24786
24787 if (cmp->rbearing > cmp->pixel_width)
24788 *right = cmp->rbearing - cmp->pixel_width;
24789 if (cmp->lbearing < 0)
24790 *left = - cmp->lbearing;
24791 }
24792 else
24793 {
24794 Lisp_Object gstring = composition_gstring_from_id (glyph->u.cmp.id);
24795 struct font_metrics metrics;
24796
24797 composition_gstring_width (gstring, glyph->slice.cmp.from,
24798 glyph->slice.cmp.to + 1, &metrics);
24799 if (metrics.rbearing > metrics.width)
24800 *right = metrics.rbearing - metrics.width;
24801 if (metrics.lbearing < 0)
24802 *left = - metrics.lbearing;
24803 }
24804 }
24805 }
24806
24807
24808 /* Return the index of the first glyph preceding glyph string S that
24809 is overwritten by S because of S's left overhang. Value is -1
24810 if no glyphs are overwritten. */
24811
24812 static int
24813 left_overwritten (struct glyph_string *s)
24814 {
24815 int k;
24816
24817 if (s->left_overhang)
24818 {
24819 int x = 0, i;
24820 struct glyph *glyphs = s->row->glyphs[s->area];
24821 int first = s->first_glyph - glyphs;
24822
24823 for (i = first - 1; i >= 0 && x > -s->left_overhang; --i)
24824 x -= glyphs[i].pixel_width;
24825
24826 k = i + 1;
24827 }
24828 else
24829 k = -1;
24830
24831 return k;
24832 }
24833
24834
24835 /* Return the index of the first glyph preceding glyph string S that
24836 is overwriting S because of its right overhang. Value is -1 if no
24837 glyph in front of S overwrites S. */
24838
24839 static int
24840 left_overwriting (struct glyph_string *s)
24841 {
24842 int i, k, x;
24843 struct glyph *glyphs = s->row->glyphs[s->area];
24844 int first = s->first_glyph - glyphs;
24845
24846 k = -1;
24847 x = 0;
24848 for (i = first - 1; i >= 0; --i)
24849 {
24850 int left, right;
24851 x_get_glyph_overhangs (glyphs + i, s->f, &left, &right);
24852 if (x + right > 0)
24853 k = i;
24854 x -= glyphs[i].pixel_width;
24855 }
24856
24857 return k;
24858 }
24859
24860
24861 /* Return the index of the last glyph following glyph string S that is
24862 overwritten by S because of S's right overhang. Value is -1 if
24863 no such glyph is found. */
24864
24865 static int
24866 right_overwritten (struct glyph_string *s)
24867 {
24868 int k = -1;
24869
24870 if (s->right_overhang)
24871 {
24872 int x = 0, i;
24873 struct glyph *glyphs = s->row->glyphs[s->area];
24874 int first = (s->first_glyph - glyphs
24875 + (s->first_glyph->type == COMPOSITE_GLYPH ? 1 : s->nchars));
24876 int end = s->row->used[s->area];
24877
24878 for (i = first; i < end && s->right_overhang > x; ++i)
24879 x += glyphs[i].pixel_width;
24880
24881 k = i;
24882 }
24883
24884 return k;
24885 }
24886
24887
24888 /* Return the index of the last glyph following glyph string S that
24889 overwrites S because of its left overhang. Value is negative
24890 if no such glyph is found. */
24891
24892 static int
24893 right_overwriting (struct glyph_string *s)
24894 {
24895 int i, k, x;
24896 int end = s->row->used[s->area];
24897 struct glyph *glyphs = s->row->glyphs[s->area];
24898 int first = (s->first_glyph - glyphs
24899 + (s->first_glyph->type == COMPOSITE_GLYPH ? 1 : s->nchars));
24900
24901 k = -1;
24902 x = 0;
24903 for (i = first; i < end; ++i)
24904 {
24905 int left, right;
24906 x_get_glyph_overhangs (glyphs + i, s->f, &left, &right);
24907 if (x - left < 0)
24908 k = i;
24909 x += glyphs[i].pixel_width;
24910 }
24911
24912 return k;
24913 }
24914
24915
24916 /* Set background width of glyph string S. START is the index of the
24917 first glyph following S. LAST_X is the right-most x-position + 1
24918 in the drawing area. */
24919
24920 static void
24921 set_glyph_string_background_width (struct glyph_string *s, int start, int last_x)
24922 {
24923 /* If the face of this glyph string has to be drawn to the end of
24924 the drawing area, set S->extends_to_end_of_line_p. */
24925
24926 if (start == s->row->used[s->area]
24927 && ((s->row->fill_line_p
24928 && (s->hl == DRAW_NORMAL_TEXT
24929 || s->hl == DRAW_IMAGE_RAISED
24930 || s->hl == DRAW_IMAGE_SUNKEN))
24931 || s->hl == DRAW_MOUSE_FACE))
24932 s->extends_to_end_of_line_p = true;
24933
24934 /* If S extends its face to the end of the line, set its
24935 background_width to the distance to the right edge of the drawing
24936 area. */
24937 if (s->extends_to_end_of_line_p)
24938 s->background_width = last_x - s->x + 1;
24939 else
24940 s->background_width = s->width;
24941 }
24942
24943
24944 /* Compute overhangs and x-positions for glyph string S and its
24945 predecessors, or successors. X is the starting x-position for S.
24946 BACKWARD_P means process predecessors. */
24947
24948 static void
24949 compute_overhangs_and_x (struct glyph_string *s, int x, bool backward_p)
24950 {
24951 if (backward_p)
24952 {
24953 while (s)
24954 {
24955 if (FRAME_RIF (s->f)->compute_glyph_string_overhangs)
24956 FRAME_RIF (s->f)->compute_glyph_string_overhangs (s);
24957 x -= s->width;
24958 s->x = x;
24959 s = s->prev;
24960 }
24961 }
24962 else
24963 {
24964 while (s)
24965 {
24966 if (FRAME_RIF (s->f)->compute_glyph_string_overhangs)
24967 FRAME_RIF (s->f)->compute_glyph_string_overhangs (s);
24968 s->x = x;
24969 x += s->width;
24970 s = s->next;
24971 }
24972 }
24973 }
24974
24975
24976
24977 /* The following macros are only called from draw_glyphs below.
24978 They reference the following parameters of that function directly:
24979 `w', `row', `area', and `overlap_p'
24980 as well as the following local variables:
24981 `s', `f', and `hdc' (in W32) */
24982
24983 #ifdef HAVE_NTGUI
24984 /* On W32, silently add local `hdc' variable to argument list of
24985 init_glyph_string. */
24986 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24987 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24988 #else
24989 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24990 init_glyph_string (s, char2b, w, row, area, start, hl)
24991 #endif
24992
24993 /* Add a glyph string for a stretch glyph to the list of strings
24994 between HEAD and TAIL. START is the index of the stretch glyph in
24995 row area AREA of glyph row ROW. END is the index of the last glyph
24996 in that glyph row area. X is the current output position assigned
24997 to the new glyph string constructed. HL overrides that face of the
24998 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24999 is the right-most x-position of the drawing area. */
25000
25001 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
25002 and below -- keep them on one line. */
25003 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25004 do \
25005 { \
25006 s = alloca (sizeof *s); \
25007 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25008 START = fill_stretch_glyph_string (s, START, END); \
25009 append_glyph_string (&HEAD, &TAIL, s); \
25010 s->x = (X); \
25011 } \
25012 while (false)
25013
25014
25015 /* Add a glyph string for an image glyph to the list of strings
25016 between HEAD and TAIL. START is the index of the image glyph in
25017 row area AREA of glyph row ROW. END is the index of the last glyph
25018 in that glyph row area. X is the current output position assigned
25019 to the new glyph string constructed. HL overrides that face of the
25020 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25021 is the right-most x-position of the drawing area. */
25022
25023 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25024 do \
25025 { \
25026 s = alloca (sizeof *s); \
25027 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25028 fill_image_glyph_string (s); \
25029 append_glyph_string (&HEAD, &TAIL, s); \
25030 ++START; \
25031 s->x = (X); \
25032 } \
25033 while (false)
25034
25035
25036 /* Add a glyph string for a sequence of character glyphs to the list
25037 of strings between HEAD and TAIL. START is the index of the first
25038 glyph in row area AREA of glyph row ROW that is part of the new
25039 glyph string. END is the index of the last glyph in that glyph row
25040 area. X is the current output position assigned to the new glyph
25041 string constructed. HL overrides that face of the glyph; e.g. it
25042 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
25043 right-most x-position of the drawing area. */
25044
25045 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25046 do \
25047 { \
25048 int face_id; \
25049 XChar2b *char2b; \
25050 \
25051 face_id = (row)->glyphs[area][START].face_id; \
25052 \
25053 s = alloca (sizeof *s); \
25054 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
25055 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25056 append_glyph_string (&HEAD, &TAIL, s); \
25057 s->x = (X); \
25058 START = fill_glyph_string (s, face_id, START, END, overlaps); \
25059 } \
25060 while (false)
25061
25062
25063 /* Add a glyph string for a composite sequence to the list of strings
25064 between HEAD and TAIL. START is the index of the first glyph in
25065 row area AREA of glyph row ROW that is part of the new glyph
25066 string. END is the index of the last glyph in that glyph row area.
25067 X is the current output position assigned to the new glyph string
25068 constructed. HL overrides that face of the glyph; e.g. it is
25069 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
25070 x-position of the drawing area. */
25071
25072 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25073 do { \
25074 int face_id = (row)->glyphs[area][START].face_id; \
25075 struct face *base_face = FACE_FROM_ID (f, face_id); \
25076 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
25077 struct composition *cmp = composition_table[cmp_id]; \
25078 XChar2b *char2b; \
25079 struct glyph_string *first_s = NULL; \
25080 int n; \
25081 \
25082 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25083 \
25084 /* Make glyph_strings for each glyph sequence that is drawable by \
25085 the same face, and append them to HEAD/TAIL. */ \
25086 for (n = 0; n < cmp->glyph_len;) \
25087 { \
25088 s = alloca (sizeof *s); \
25089 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25090 append_glyph_string (&(HEAD), &(TAIL), s); \
25091 s->cmp = cmp; \
25092 s->cmp_from = n; \
25093 s->x = (X); \
25094 if (n == 0) \
25095 first_s = s; \
25096 n = fill_composite_glyph_string (s, base_face, overlaps); \
25097 } \
25098 \
25099 ++START; \
25100 s = first_s; \
25101 } while (false)
25102
25103
25104 /* Add a glyph string for a glyph-string sequence to the list of strings
25105 between HEAD and TAIL. */
25106
25107 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25108 do { \
25109 int face_id; \
25110 XChar2b *char2b; \
25111 Lisp_Object gstring; \
25112 \
25113 face_id = (row)->glyphs[area][START].face_id; \
25114 gstring = (composition_gstring_from_id \
25115 ((row)->glyphs[area][START].u.cmp.id)); \
25116 s = alloca (sizeof *s); \
25117 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25118 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25119 append_glyph_string (&(HEAD), &(TAIL), s); \
25120 s->x = (X); \
25121 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25122 } while (false)
25123
25124
25125 /* Add a glyph string for a sequence of glyphless character's glyphs
25126 to the list of strings between HEAD and TAIL. The meanings of
25127 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25128
25129 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25130 do \
25131 { \
25132 int face_id; \
25133 \
25134 face_id = (row)->glyphs[area][START].face_id; \
25135 \
25136 s = alloca (sizeof *s); \
25137 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25138 append_glyph_string (&HEAD, &TAIL, s); \
25139 s->x = (X); \
25140 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25141 overlaps); \
25142 } \
25143 while (false)
25144
25145
25146 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25147 of AREA of glyph row ROW on window W between indices START and END.
25148 HL overrides the face for drawing glyph strings, e.g. it is
25149 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25150 x-positions of the drawing area.
25151
25152 This is an ugly monster macro construct because we must use alloca
25153 to allocate glyph strings (because draw_glyphs can be called
25154 asynchronously). */
25155
25156 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25157 do \
25158 { \
25159 HEAD = TAIL = NULL; \
25160 while (START < END) \
25161 { \
25162 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25163 switch (first_glyph->type) \
25164 { \
25165 case CHAR_GLYPH: \
25166 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25167 HL, X, LAST_X); \
25168 break; \
25169 \
25170 case COMPOSITE_GLYPH: \
25171 if (first_glyph->u.cmp.automatic) \
25172 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25173 HL, X, LAST_X); \
25174 else \
25175 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25176 HL, X, LAST_X); \
25177 break; \
25178 \
25179 case STRETCH_GLYPH: \
25180 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25181 HL, X, LAST_X); \
25182 break; \
25183 \
25184 case IMAGE_GLYPH: \
25185 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25186 HL, X, LAST_X); \
25187 break; \
25188 \
25189 case GLYPHLESS_GLYPH: \
25190 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25191 HL, X, LAST_X); \
25192 break; \
25193 \
25194 default: \
25195 emacs_abort (); \
25196 } \
25197 \
25198 if (s) \
25199 { \
25200 set_glyph_string_background_width (s, START, LAST_X); \
25201 (X) += s->width; \
25202 } \
25203 } \
25204 } while (false)
25205
25206
25207 /* Draw glyphs between START and END in AREA of ROW on window W,
25208 starting at x-position X. X is relative to AREA in W. HL is a
25209 face-override with the following meaning:
25210
25211 DRAW_NORMAL_TEXT draw normally
25212 DRAW_CURSOR draw in cursor face
25213 DRAW_MOUSE_FACE draw in mouse face.
25214 DRAW_INVERSE_VIDEO draw in mode line face
25215 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25216 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25217
25218 If OVERLAPS is non-zero, draw only the foreground of characters and
25219 clip to the physical height of ROW. Non-zero value also defines
25220 the overlapping part to be drawn:
25221
25222 OVERLAPS_PRED overlap with preceding rows
25223 OVERLAPS_SUCC overlap with succeeding rows
25224 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25225 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25226
25227 Value is the x-position reached, relative to AREA of W. */
25228
25229 static int
25230 draw_glyphs (struct window *w, int x, struct glyph_row *row,
25231 enum glyph_row_area area, ptrdiff_t start, ptrdiff_t end,
25232 enum draw_glyphs_face hl, int overlaps)
25233 {
25234 struct glyph_string *head, *tail;
25235 struct glyph_string *s;
25236 struct glyph_string *clip_head = NULL, *clip_tail = NULL;
25237 int i, j, x_reached, last_x, area_left = 0;
25238 struct frame *f = XFRAME (WINDOW_FRAME (w));
25239 DECLARE_HDC (hdc);
25240
25241 ALLOCATE_HDC (hdc, f);
25242
25243 /* Let's rather be paranoid than getting a SEGV. */
25244 end = min (end, row->used[area]);
25245 start = clip_to_bounds (0, start, end);
25246
25247 /* Translate X to frame coordinates. Set last_x to the right
25248 end of the drawing area. */
25249 if (row->full_width_p)
25250 {
25251 /* X is relative to the left edge of W, without scroll bars
25252 or fringes. */
25253 area_left = WINDOW_LEFT_EDGE_X (w);
25254 last_x = (WINDOW_LEFT_EDGE_X (w) + WINDOW_PIXEL_WIDTH (w)
25255 - (row->mode_line_p ? WINDOW_RIGHT_DIVIDER_WIDTH (w) : 0));
25256 }
25257 else
25258 {
25259 area_left = window_box_left (w, area);
25260 last_x = area_left + window_box_width (w, area);
25261 }
25262 x += area_left;
25263
25264 /* Build a doubly-linked list of glyph_string structures between
25265 head and tail from what we have to draw. Note that the macro
25266 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25267 the reason we use a separate variable `i'. */
25268 i = start;
25269 USE_SAFE_ALLOCA;
25270 BUILD_GLYPH_STRINGS (i, end, head, tail, hl, x, last_x);
25271 if (tail)
25272 x_reached = tail->x + tail->background_width;
25273 else
25274 x_reached = x;
25275
25276 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25277 the row, redraw some glyphs in front or following the glyph
25278 strings built above. */
25279 if (head && !overlaps && row->contains_overlapping_glyphs_p)
25280 {
25281 struct glyph_string *h, *t;
25282 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
25283 int mouse_beg_col IF_LINT (= 0), mouse_end_col IF_LINT (= 0);
25284 bool check_mouse_face = false;
25285 int dummy_x = 0;
25286
25287 /* If mouse highlighting is on, we may need to draw adjacent
25288 glyphs using mouse-face highlighting. */
25289 if (area == TEXT_AREA && row->mouse_face_p
25290 && hlinfo->mouse_face_beg_row >= 0
25291 && hlinfo->mouse_face_end_row >= 0)
25292 {
25293 ptrdiff_t row_vpos = MATRIX_ROW_VPOS (row, w->current_matrix);
25294
25295 if (row_vpos >= hlinfo->mouse_face_beg_row
25296 && row_vpos <= hlinfo->mouse_face_end_row)
25297 {
25298 check_mouse_face = true;
25299 mouse_beg_col = (row_vpos == hlinfo->mouse_face_beg_row)
25300 ? hlinfo->mouse_face_beg_col : 0;
25301 mouse_end_col = (row_vpos == hlinfo->mouse_face_end_row)
25302 ? hlinfo->mouse_face_end_col
25303 : row->used[TEXT_AREA];
25304 }
25305 }
25306
25307 /* Compute overhangs for all glyph strings. */
25308 if (FRAME_RIF (f)->compute_glyph_string_overhangs)
25309 for (s = head; s; s = s->next)
25310 FRAME_RIF (f)->compute_glyph_string_overhangs (s);
25311
25312 /* Prepend glyph strings for glyphs in front of the first glyph
25313 string that are overwritten because of the first glyph
25314 string's left overhang. The background of all strings
25315 prepended must be drawn because the first glyph string
25316 draws over it. */
25317 i = left_overwritten (head);
25318 if (i >= 0)
25319 {
25320 enum draw_glyphs_face overlap_hl;
25321
25322 /* If this row contains mouse highlighting, attempt to draw
25323 the overlapped glyphs with the correct highlight. This
25324 code fails if the overlap encompasses more than one glyph
25325 and mouse-highlight spans only some of these glyphs.
25326 However, making it work perfectly involves a lot more
25327 code, and I don't know if the pathological case occurs in
25328 practice, so we'll stick to this for now. --- cyd */
25329 if (check_mouse_face
25330 && mouse_beg_col < start && mouse_end_col > i)
25331 overlap_hl = DRAW_MOUSE_FACE;
25332 else
25333 overlap_hl = DRAW_NORMAL_TEXT;
25334
25335 if (hl != overlap_hl)
25336 clip_head = head;
25337 j = i;
25338 BUILD_GLYPH_STRINGS (j, start, h, t,
25339 overlap_hl, dummy_x, last_x);
25340 start = i;
25341 compute_overhangs_and_x (t, head->x, true);
25342 prepend_glyph_string_lists (&head, &tail, h, t);
25343 if (clip_head == NULL)
25344 clip_head = head;
25345 }
25346
25347 /* Prepend glyph strings for glyphs in front of the first glyph
25348 string that overwrite that glyph string because of their
25349 right overhang. For these strings, only the foreground must
25350 be drawn, because it draws over the glyph string at `head'.
25351 The background must not be drawn because this would overwrite
25352 right overhangs of preceding glyphs for which no glyph
25353 strings exist. */
25354 i = left_overwriting (head);
25355 if (i >= 0)
25356 {
25357 enum draw_glyphs_face overlap_hl;
25358
25359 if (check_mouse_face
25360 && mouse_beg_col < start && mouse_end_col > i)
25361 overlap_hl = DRAW_MOUSE_FACE;
25362 else
25363 overlap_hl = DRAW_NORMAL_TEXT;
25364
25365 if (hl == overlap_hl || clip_head == NULL)
25366 clip_head = head;
25367 BUILD_GLYPH_STRINGS (i, start, h, t,
25368 overlap_hl, dummy_x, last_x);
25369 for (s = h; s; s = s->next)
25370 s->background_filled_p = true;
25371 compute_overhangs_and_x (t, head->x, true);
25372 prepend_glyph_string_lists (&head, &tail, h, t);
25373 }
25374
25375 /* Append glyphs strings for glyphs following the last glyph
25376 string tail that are overwritten by tail. The background of
25377 these strings has to be drawn because tail's foreground draws
25378 over it. */
25379 i = right_overwritten (tail);
25380 if (i >= 0)
25381 {
25382 enum draw_glyphs_face overlap_hl;
25383
25384 if (check_mouse_face
25385 && mouse_beg_col < i && mouse_end_col > end)
25386 overlap_hl = DRAW_MOUSE_FACE;
25387 else
25388 overlap_hl = DRAW_NORMAL_TEXT;
25389
25390 if (hl != overlap_hl)
25391 clip_tail = tail;
25392 BUILD_GLYPH_STRINGS (end, i, h, t,
25393 overlap_hl, x, last_x);
25394 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25395 we don't have `end = i;' here. */
25396 compute_overhangs_and_x (h, tail->x + tail->width, false);
25397 append_glyph_string_lists (&head, &tail, h, t);
25398 if (clip_tail == NULL)
25399 clip_tail = tail;
25400 }
25401
25402 /* Append glyph strings for glyphs following the last glyph
25403 string tail that overwrite tail. The foreground of such
25404 glyphs has to be drawn because it writes into the background
25405 of tail. The background must not be drawn because it could
25406 paint over the foreground of following glyphs. */
25407 i = right_overwriting (tail);
25408 if (i >= 0)
25409 {
25410 enum draw_glyphs_face overlap_hl;
25411 if (check_mouse_face
25412 && mouse_beg_col < i && mouse_end_col > end)
25413 overlap_hl = DRAW_MOUSE_FACE;
25414 else
25415 overlap_hl = DRAW_NORMAL_TEXT;
25416
25417 if (hl == overlap_hl || clip_tail == NULL)
25418 clip_tail = tail;
25419 i++; /* We must include the Ith glyph. */
25420 BUILD_GLYPH_STRINGS (end, i, h, t,
25421 overlap_hl, x, last_x);
25422 for (s = h; s; s = s->next)
25423 s->background_filled_p = true;
25424 compute_overhangs_and_x (h, tail->x + tail->width, false);
25425 append_glyph_string_lists (&head, &tail, h, t);
25426 }
25427 if (clip_head || clip_tail)
25428 for (s = head; s; s = s->next)
25429 {
25430 s->clip_head = clip_head;
25431 s->clip_tail = clip_tail;
25432 }
25433 }
25434
25435 /* Draw all strings. */
25436 for (s = head; s; s = s->next)
25437 FRAME_RIF (f)->draw_glyph_string (s);
25438
25439 #ifndef HAVE_NS
25440 /* When focus a sole frame and move horizontally, this clears on_p
25441 causing a failure to erase prev cursor position. */
25442 if (area == TEXT_AREA
25443 && !row->full_width_p
25444 /* When drawing overlapping rows, only the glyph strings'
25445 foreground is drawn, which doesn't erase a cursor
25446 completely. */
25447 && !overlaps)
25448 {
25449 int x0 = clip_head ? clip_head->x : (head ? head->x : x);
25450 int x1 = (clip_tail ? clip_tail->x + clip_tail->background_width
25451 : (tail ? tail->x + tail->background_width : x));
25452 x0 -= area_left;
25453 x1 -= area_left;
25454
25455 notice_overwritten_cursor (w, TEXT_AREA, x0, x1,
25456 row->y, MATRIX_ROW_BOTTOM_Y (row));
25457 }
25458 #endif
25459
25460 /* Value is the x-position up to which drawn, relative to AREA of W.
25461 This doesn't include parts drawn because of overhangs. */
25462 if (row->full_width_p)
25463 x_reached = FRAME_TO_WINDOW_PIXEL_X (w, x_reached);
25464 else
25465 x_reached -= area_left;
25466
25467 RELEASE_HDC (hdc, f);
25468
25469 SAFE_FREE ();
25470 return x_reached;
25471 }
25472
25473 /* Expand row matrix if too narrow. Don't expand if area
25474 is not present. */
25475
25476 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25477 { \
25478 if (!it->f->fonts_changed \
25479 && (it->glyph_row->glyphs[area] \
25480 < it->glyph_row->glyphs[area + 1])) \
25481 { \
25482 it->w->ncols_scale_factor++; \
25483 it->f->fonts_changed = true; \
25484 } \
25485 }
25486
25487 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25488 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25489
25490 static void
25491 append_glyph (struct it *it)
25492 {
25493 struct glyph *glyph;
25494 enum glyph_row_area area = it->area;
25495
25496 eassert (it->glyph_row);
25497 eassert (it->char_to_display != '\n' && it->char_to_display != '\t');
25498
25499 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
25500 if (glyph < it->glyph_row->glyphs[area + 1])
25501 {
25502 /* If the glyph row is reversed, we need to prepend the glyph
25503 rather than append it. */
25504 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25505 {
25506 struct glyph *g;
25507
25508 /* Make room for the additional glyph. */
25509 for (g = glyph - 1; g >= it->glyph_row->glyphs[area]; g--)
25510 g[1] = *g;
25511 glyph = it->glyph_row->glyphs[area];
25512 }
25513 glyph->charpos = CHARPOS (it->position);
25514 glyph->object = it->object;
25515 if (it->pixel_width > 0)
25516 {
25517 glyph->pixel_width = it->pixel_width;
25518 glyph->padding_p = false;
25519 }
25520 else
25521 {
25522 /* Assure at least 1-pixel width. Otherwise, cursor can't
25523 be displayed correctly. */
25524 glyph->pixel_width = 1;
25525 glyph->padding_p = true;
25526 }
25527 glyph->ascent = it->ascent;
25528 glyph->descent = it->descent;
25529 glyph->voffset = it->voffset;
25530 glyph->type = CHAR_GLYPH;
25531 glyph->avoid_cursor_p = it->avoid_cursor_p;
25532 glyph->multibyte_p = it->multibyte_p;
25533 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25534 {
25535 /* In R2L rows, the left and the right box edges need to be
25536 drawn in reverse direction. */
25537 glyph->right_box_line_p = it->start_of_box_run_p;
25538 glyph->left_box_line_p = it->end_of_box_run_p;
25539 }
25540 else
25541 {
25542 glyph->left_box_line_p = it->start_of_box_run_p;
25543 glyph->right_box_line_p = it->end_of_box_run_p;
25544 }
25545 glyph->overlaps_vertically_p = (it->phys_ascent > it->ascent
25546 || it->phys_descent > it->descent);
25547 glyph->glyph_not_available_p = it->glyph_not_available_p;
25548 glyph->face_id = it->face_id;
25549 glyph->u.ch = it->char_to_display;
25550 glyph->slice.img = null_glyph_slice;
25551 glyph->font_type = FONT_TYPE_UNKNOWN;
25552 if (it->bidi_p)
25553 {
25554 glyph->resolved_level = it->bidi_it.resolved_level;
25555 eassert ((it->bidi_it.type & 7) == it->bidi_it.type);
25556 glyph->bidi_type = it->bidi_it.type;
25557 }
25558 else
25559 {
25560 glyph->resolved_level = 0;
25561 glyph->bidi_type = UNKNOWN_BT;
25562 }
25563 ++it->glyph_row->used[area];
25564 }
25565 else
25566 IT_EXPAND_MATRIX_WIDTH (it, area);
25567 }
25568
25569 /* Store one glyph for the composition IT->cmp_it.id in
25570 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25571 non-null. */
25572
25573 static void
25574 append_composite_glyph (struct it *it)
25575 {
25576 struct glyph *glyph;
25577 enum glyph_row_area area = it->area;
25578
25579 eassert (it->glyph_row);
25580
25581 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
25582 if (glyph < it->glyph_row->glyphs[area + 1])
25583 {
25584 /* If the glyph row is reversed, we need to prepend the glyph
25585 rather than append it. */
25586 if (it->glyph_row->reversed_p && it->area == TEXT_AREA)
25587 {
25588 struct glyph *g;
25589
25590 /* Make room for the new glyph. */
25591 for (g = glyph - 1; g >= it->glyph_row->glyphs[it->area]; g--)
25592 g[1] = *g;
25593 glyph = it->glyph_row->glyphs[it->area];
25594 }
25595 glyph->charpos = it->cmp_it.charpos;
25596 glyph->object = it->object;
25597 glyph->pixel_width = it->pixel_width;
25598 glyph->ascent = it->ascent;
25599 glyph->descent = it->descent;
25600 glyph->voffset = it->voffset;
25601 glyph->type = COMPOSITE_GLYPH;
25602 if (it->cmp_it.ch < 0)
25603 {
25604 glyph->u.cmp.automatic = false;
25605 glyph->u.cmp.id = it->cmp_it.id;
25606 glyph->slice.cmp.from = glyph->slice.cmp.to = 0;
25607 }
25608 else
25609 {
25610 glyph->u.cmp.automatic = true;
25611 glyph->u.cmp.id = it->cmp_it.id;
25612 glyph->slice.cmp.from = it->cmp_it.from;
25613 glyph->slice.cmp.to = it->cmp_it.to - 1;
25614 }
25615 glyph->avoid_cursor_p = it->avoid_cursor_p;
25616 glyph->multibyte_p = it->multibyte_p;
25617 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25618 {
25619 /* In R2L rows, the left and the right box edges need to be
25620 drawn in reverse direction. */
25621 glyph->right_box_line_p = it->start_of_box_run_p;
25622 glyph->left_box_line_p = it->end_of_box_run_p;
25623 }
25624 else
25625 {
25626 glyph->left_box_line_p = it->start_of_box_run_p;
25627 glyph->right_box_line_p = it->end_of_box_run_p;
25628 }
25629 glyph->overlaps_vertically_p = (it->phys_ascent > it->ascent
25630 || it->phys_descent > it->descent);
25631 glyph->padding_p = false;
25632 glyph->glyph_not_available_p = false;
25633 glyph->face_id = it->face_id;
25634 glyph->font_type = FONT_TYPE_UNKNOWN;
25635 if (it->bidi_p)
25636 {
25637 glyph->resolved_level = it->bidi_it.resolved_level;
25638 eassert ((it->bidi_it.type & 7) == it->bidi_it.type);
25639 glyph->bidi_type = it->bidi_it.type;
25640 }
25641 ++it->glyph_row->used[area];
25642 }
25643 else
25644 IT_EXPAND_MATRIX_WIDTH (it, area);
25645 }
25646
25647
25648 /* Change IT->ascent and IT->height according to the setting of
25649 IT->voffset. */
25650
25651 static void
25652 take_vertical_position_into_account (struct it *it)
25653 {
25654 if (it->voffset)
25655 {
25656 if (it->voffset < 0)
25657 /* Increase the ascent so that we can display the text higher
25658 in the line. */
25659 it->ascent -= it->voffset;
25660 else
25661 /* Increase the descent so that we can display the text lower
25662 in the line. */
25663 it->descent += it->voffset;
25664 }
25665 }
25666
25667
25668 /* Produce glyphs/get display metrics for the image IT is loaded with.
25669 See the description of struct display_iterator in dispextern.h for
25670 an overview of struct display_iterator. */
25671
25672 static void
25673 produce_image_glyph (struct it *it)
25674 {
25675 struct image *img;
25676 struct face *face;
25677 int glyph_ascent, crop;
25678 struct glyph_slice slice;
25679
25680 eassert (it->what == IT_IMAGE);
25681
25682 face = FACE_FROM_ID (it->f, it->face_id);
25683 eassert (face);
25684 /* Make sure X resources of the face is loaded. */
25685 prepare_face_for_display (it->f, face);
25686
25687 if (it->image_id < 0)
25688 {
25689 /* Fringe bitmap. */
25690 it->ascent = it->phys_ascent = 0;
25691 it->descent = it->phys_descent = 0;
25692 it->pixel_width = 0;
25693 it->nglyphs = 0;
25694 return;
25695 }
25696
25697 img = IMAGE_FROM_ID (it->f, it->image_id);
25698 eassert (img);
25699 /* Make sure X resources of the image is loaded. */
25700 prepare_image_for_display (it->f, img);
25701
25702 slice.x = slice.y = 0;
25703 slice.width = img->width;
25704 slice.height = img->height;
25705
25706 if (INTEGERP (it->slice.x))
25707 slice.x = XINT (it->slice.x);
25708 else if (FLOATP (it->slice.x))
25709 slice.x = XFLOAT_DATA (it->slice.x) * img->width;
25710
25711 if (INTEGERP (it->slice.y))
25712 slice.y = XINT (it->slice.y);
25713 else if (FLOATP (it->slice.y))
25714 slice.y = XFLOAT_DATA (it->slice.y) * img->height;
25715
25716 if (INTEGERP (it->slice.width))
25717 slice.width = XINT (it->slice.width);
25718 else if (FLOATP (it->slice.width))
25719 slice.width = XFLOAT_DATA (it->slice.width) * img->width;
25720
25721 if (INTEGERP (it->slice.height))
25722 slice.height = XINT (it->slice.height);
25723 else if (FLOATP (it->slice.height))
25724 slice.height = XFLOAT_DATA (it->slice.height) * img->height;
25725
25726 if (slice.x >= img->width)
25727 slice.x = img->width;
25728 if (slice.y >= img->height)
25729 slice.y = img->height;
25730 if (slice.x + slice.width >= img->width)
25731 slice.width = img->width - slice.x;
25732 if (slice.y + slice.height > img->height)
25733 slice.height = img->height - slice.y;
25734
25735 if (slice.width == 0 || slice.height == 0)
25736 return;
25737
25738 it->ascent = it->phys_ascent = glyph_ascent = image_ascent (img, face, &slice);
25739
25740 it->descent = slice.height - glyph_ascent;
25741 if (slice.y == 0)
25742 it->descent += img->vmargin;
25743 if (slice.y + slice.height == img->height)
25744 it->descent += img->vmargin;
25745 it->phys_descent = it->descent;
25746
25747 it->pixel_width = slice.width;
25748 if (slice.x == 0)
25749 it->pixel_width += img->hmargin;
25750 if (slice.x + slice.width == img->width)
25751 it->pixel_width += img->hmargin;
25752
25753 /* It's quite possible for images to have an ascent greater than
25754 their height, so don't get confused in that case. */
25755 if (it->descent < 0)
25756 it->descent = 0;
25757
25758 it->nglyphs = 1;
25759
25760 if (face->box != FACE_NO_BOX)
25761 {
25762 if (face->box_line_width > 0)
25763 {
25764 if (slice.y == 0)
25765 it->ascent += face->box_line_width;
25766 if (slice.y + slice.height == img->height)
25767 it->descent += face->box_line_width;
25768 }
25769
25770 if (it->start_of_box_run_p && slice.x == 0)
25771 it->pixel_width += eabs (face->box_line_width);
25772 if (it->end_of_box_run_p && slice.x + slice.width == img->width)
25773 it->pixel_width += eabs (face->box_line_width);
25774 }
25775
25776 take_vertical_position_into_account (it);
25777
25778 /* Automatically crop wide image glyphs at right edge so we can
25779 draw the cursor on same display row. */
25780 if ((crop = it->pixel_width - (it->last_visible_x - it->current_x), crop > 0)
25781 && (it->hpos == 0 || it->pixel_width > it->last_visible_x / 4))
25782 {
25783 it->pixel_width -= crop;
25784 slice.width -= crop;
25785 }
25786
25787 if (it->glyph_row)
25788 {
25789 struct glyph *glyph;
25790 enum glyph_row_area area = it->area;
25791
25792 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
25793 if (it->glyph_row->reversed_p)
25794 {
25795 struct glyph *g;
25796
25797 /* Make room for the new glyph. */
25798 for (g = glyph - 1; g >= it->glyph_row->glyphs[it->area]; g--)
25799 g[1] = *g;
25800 glyph = it->glyph_row->glyphs[it->area];
25801 }
25802 if (glyph < it->glyph_row->glyphs[area + 1])
25803 {
25804 glyph->charpos = CHARPOS (it->position);
25805 glyph->object = it->object;
25806 glyph->pixel_width = it->pixel_width;
25807 glyph->ascent = glyph_ascent;
25808 glyph->descent = it->descent;
25809 glyph->voffset = it->voffset;
25810 glyph->type = IMAGE_GLYPH;
25811 glyph->avoid_cursor_p = it->avoid_cursor_p;
25812 glyph->multibyte_p = it->multibyte_p;
25813 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25814 {
25815 /* In R2L rows, the left and the right box edges need to be
25816 drawn in reverse direction. */
25817 glyph->right_box_line_p = it->start_of_box_run_p;
25818 glyph->left_box_line_p = it->end_of_box_run_p;
25819 }
25820 else
25821 {
25822 glyph->left_box_line_p = it->start_of_box_run_p;
25823 glyph->right_box_line_p = it->end_of_box_run_p;
25824 }
25825 glyph->overlaps_vertically_p = false;
25826 glyph->padding_p = false;
25827 glyph->glyph_not_available_p = false;
25828 glyph->face_id = it->face_id;
25829 glyph->u.img_id = img->id;
25830 glyph->slice.img = slice;
25831 glyph->font_type = FONT_TYPE_UNKNOWN;
25832 if (it->bidi_p)
25833 {
25834 glyph->resolved_level = it->bidi_it.resolved_level;
25835 eassert ((it->bidi_it.type & 7) == it->bidi_it.type);
25836 glyph->bidi_type = it->bidi_it.type;
25837 }
25838 ++it->glyph_row->used[area];
25839 }
25840 else
25841 IT_EXPAND_MATRIX_WIDTH (it, area);
25842 }
25843 }
25844
25845
25846 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25847 of the glyph, WIDTH and HEIGHT are the width and height of the
25848 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25849
25850 static void
25851 append_stretch_glyph (struct it *it, Lisp_Object object,
25852 int width, int height, int ascent)
25853 {
25854 struct glyph *glyph;
25855 enum glyph_row_area area = it->area;
25856
25857 eassert (ascent >= 0 && ascent <= height);
25858
25859 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
25860 if (glyph < it->glyph_row->glyphs[area + 1])
25861 {
25862 /* If the glyph row is reversed, we need to prepend the glyph
25863 rather than append it. */
25864 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25865 {
25866 struct glyph *g;
25867
25868 /* Make room for the additional glyph. */
25869 for (g = glyph - 1; g >= it->glyph_row->glyphs[area]; g--)
25870 g[1] = *g;
25871 glyph = it->glyph_row->glyphs[area];
25872
25873 /* Decrease the width of the first glyph of the row that
25874 begins before first_visible_x (e.g., due to hscroll).
25875 This is so the overall width of the row becomes smaller
25876 by the scroll amount, and the stretch glyph appended by
25877 extend_face_to_end_of_line will be wider, to shift the
25878 row glyphs to the right. (In L2R rows, the corresponding
25879 left-shift effect is accomplished by setting row->x to a
25880 negative value, which won't work with R2L rows.)
25881
25882 This must leave us with a positive value of WIDTH, since
25883 otherwise the call to move_it_in_display_line_to at the
25884 beginning of display_line would have got past the entire
25885 first glyph, and then it->current_x would have been
25886 greater or equal to it->first_visible_x. */
25887 if (it->current_x < it->first_visible_x)
25888 width -= it->first_visible_x - it->current_x;
25889 eassert (width > 0);
25890 }
25891 glyph->charpos = CHARPOS (it->position);
25892 glyph->object = object;
25893 glyph->pixel_width = width;
25894 glyph->ascent = ascent;
25895 glyph->descent = height - ascent;
25896 glyph->voffset = it->voffset;
25897 glyph->type = STRETCH_GLYPH;
25898 glyph->avoid_cursor_p = it->avoid_cursor_p;
25899 glyph->multibyte_p = it->multibyte_p;
25900 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25901 {
25902 /* In R2L rows, the left and the right box edges need to be
25903 drawn in reverse direction. */
25904 glyph->right_box_line_p = it->start_of_box_run_p;
25905 glyph->left_box_line_p = it->end_of_box_run_p;
25906 }
25907 else
25908 {
25909 glyph->left_box_line_p = it->start_of_box_run_p;
25910 glyph->right_box_line_p = it->end_of_box_run_p;
25911 }
25912 glyph->overlaps_vertically_p = false;
25913 glyph->padding_p = false;
25914 glyph->glyph_not_available_p = false;
25915 glyph->face_id = it->face_id;
25916 glyph->u.stretch.ascent = ascent;
25917 glyph->u.stretch.height = height;
25918 glyph->slice.img = null_glyph_slice;
25919 glyph->font_type = FONT_TYPE_UNKNOWN;
25920 if (it->bidi_p)
25921 {
25922 glyph->resolved_level = it->bidi_it.resolved_level;
25923 eassert ((it->bidi_it.type & 7) == it->bidi_it.type);
25924 glyph->bidi_type = it->bidi_it.type;
25925 }
25926 else
25927 {
25928 glyph->resolved_level = 0;
25929 glyph->bidi_type = UNKNOWN_BT;
25930 }
25931 ++it->glyph_row->used[area];
25932 }
25933 else
25934 IT_EXPAND_MATRIX_WIDTH (it, area);
25935 }
25936
25937 #endif /* HAVE_WINDOW_SYSTEM */
25938
25939 /* Produce a stretch glyph for iterator IT. IT->object is the value
25940 of the glyph property displayed. The value must be a list
25941 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25942 being recognized:
25943
25944 1. `:width WIDTH' specifies that the space should be WIDTH *
25945 canonical char width wide. WIDTH may be an integer or floating
25946 point number.
25947
25948 2. `:relative-width FACTOR' specifies that the width of the stretch
25949 should be computed from the width of the first character having the
25950 `glyph' property, and should be FACTOR times that width.
25951
25952 3. `:align-to HPOS' specifies that the space should be wide enough
25953 to reach HPOS, a value in canonical character units.
25954
25955 Exactly one of the above pairs must be present.
25956
25957 4. `:height HEIGHT' specifies that the height of the stretch produced
25958 should be HEIGHT, measured in canonical character units.
25959
25960 5. `:relative-height FACTOR' specifies that the height of the
25961 stretch should be FACTOR times the height of the characters having
25962 the glyph property.
25963
25964 Either none or exactly one of 4 or 5 must be present.
25965
25966 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25967 of the stretch should be used for the ascent of the stretch.
25968 ASCENT must be in the range 0 <= ASCENT <= 100. */
25969
25970 void
25971 produce_stretch_glyph (struct it *it)
25972 {
25973 /* (space :width WIDTH :height HEIGHT ...) */
25974 Lisp_Object prop, plist;
25975 int width = 0, height = 0, align_to = -1;
25976 bool zero_width_ok_p = false;
25977 double tem;
25978 struct font *font = NULL;
25979
25980 #ifdef HAVE_WINDOW_SYSTEM
25981 int ascent = 0;
25982 bool zero_height_ok_p = false;
25983
25984 if (FRAME_WINDOW_P (it->f))
25985 {
25986 struct face *face = FACE_FROM_ID (it->f, it->face_id);
25987 font = face->font ? face->font : FRAME_FONT (it->f);
25988 prepare_face_for_display (it->f, face);
25989 }
25990 #endif
25991
25992 /* List should start with `space'. */
25993 eassert (CONSP (it->object) && EQ (XCAR (it->object), Qspace));
25994 plist = XCDR (it->object);
25995
25996 /* Compute the width of the stretch. */
25997 if ((prop = Fplist_get (plist, QCwidth), !NILP (prop))
25998 && calc_pixel_width_or_height (&tem, it, prop, font, true, 0))
25999 {
26000 /* Absolute width `:width WIDTH' specified and valid. */
26001 zero_width_ok_p = true;
26002 width = (int)tem;
26003 }
26004 else if (prop = Fplist_get (plist, QCrelative_width), NUMVAL (prop) > 0)
26005 {
26006 /* Relative width `:relative-width FACTOR' specified and valid.
26007 Compute the width of the characters having the `glyph'
26008 property. */
26009 struct it it2;
26010 unsigned char *p = BYTE_POS_ADDR (IT_BYTEPOS (*it));
26011
26012 it2 = *it;
26013 if (it->multibyte_p)
26014 it2.c = it2.char_to_display = STRING_CHAR_AND_LENGTH (p, it2.len);
26015 else
26016 {
26017 it2.c = it2.char_to_display = *p, it2.len = 1;
26018 if (! ASCII_CHAR_P (it2.c))
26019 it2.char_to_display = BYTE8_TO_CHAR (it2.c);
26020 }
26021
26022 it2.glyph_row = NULL;
26023 it2.what = IT_CHARACTER;
26024 PRODUCE_GLYPHS (&it2);
26025 width = NUMVAL (prop) * it2.pixel_width;
26026 }
26027 else if ((prop = Fplist_get (plist, QCalign_to), !NILP (prop))
26028 && calc_pixel_width_or_height (&tem, it, prop, font, true,
26029 &align_to))
26030 {
26031 if (it->glyph_row == NULL || !it->glyph_row->mode_line_p)
26032 align_to = (align_to < 0
26033 ? 0
26034 : align_to - window_box_left_offset (it->w, TEXT_AREA));
26035 else if (align_to < 0)
26036 align_to = window_box_left_offset (it->w, TEXT_AREA);
26037 width = max (0, (int)tem + align_to - it->current_x);
26038 zero_width_ok_p = true;
26039 }
26040 else
26041 /* Nothing specified -> width defaults to canonical char width. */
26042 width = FRAME_COLUMN_WIDTH (it->f);
26043
26044 if (width <= 0 && (width < 0 || !zero_width_ok_p))
26045 width = 1;
26046
26047 #ifdef HAVE_WINDOW_SYSTEM
26048 /* Compute height. */
26049 if (FRAME_WINDOW_P (it->f))
26050 {
26051 int default_height = normal_char_height (font, ' ');
26052
26053 if ((prop = Fplist_get (plist, QCheight), !NILP (prop))
26054 && calc_pixel_width_or_height (&tem, it, prop, font, false, 0))
26055 {
26056 height = (int)tem;
26057 zero_height_ok_p = true;
26058 }
26059 else if (prop = Fplist_get (plist, QCrelative_height),
26060 NUMVAL (prop) > 0)
26061 height = default_height * NUMVAL (prop);
26062 else
26063 height = default_height;
26064
26065 if (height <= 0 && (height < 0 || !zero_height_ok_p))
26066 height = 1;
26067
26068 /* Compute percentage of height used for ascent. If
26069 `:ascent ASCENT' is present and valid, use that. Otherwise,
26070 derive the ascent from the font in use. */
26071 if (prop = Fplist_get (plist, QCascent),
26072 NUMVAL (prop) > 0 && NUMVAL (prop) <= 100)
26073 ascent = height * NUMVAL (prop) / 100.0;
26074 else if (!NILP (prop)
26075 && calc_pixel_width_or_height (&tem, it, prop, font, false, 0))
26076 ascent = min (max (0, (int)tem), height);
26077 else
26078 ascent = (height * FONT_BASE (font)) / FONT_HEIGHT (font);
26079 }
26080 else
26081 #endif /* HAVE_WINDOW_SYSTEM */
26082 height = 1;
26083
26084 if (width > 0 && it->line_wrap != TRUNCATE
26085 && it->current_x + width > it->last_visible_x)
26086 {
26087 width = it->last_visible_x - it->current_x;
26088 #ifdef HAVE_WINDOW_SYSTEM
26089 /* Subtract one more pixel from the stretch width, but only on
26090 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26091 width -= FRAME_WINDOW_P (it->f);
26092 #endif
26093 }
26094
26095 if (width > 0 && height > 0 && it->glyph_row)
26096 {
26097 Lisp_Object o_object = it->object;
26098 Lisp_Object object = it->stack[it->sp - 1].string;
26099 int n = width;
26100
26101 if (!STRINGP (object))
26102 object = it->w->contents;
26103 #ifdef HAVE_WINDOW_SYSTEM
26104 if (FRAME_WINDOW_P (it->f))
26105 append_stretch_glyph (it, object, width, height, ascent);
26106 else
26107 #endif
26108 {
26109 it->object = object;
26110 it->char_to_display = ' ';
26111 it->pixel_width = it->len = 1;
26112 while (n--)
26113 tty_append_glyph (it);
26114 it->object = o_object;
26115 }
26116 }
26117
26118 it->pixel_width = width;
26119 #ifdef HAVE_WINDOW_SYSTEM
26120 if (FRAME_WINDOW_P (it->f))
26121 {
26122 it->ascent = it->phys_ascent = ascent;
26123 it->descent = it->phys_descent = height - it->ascent;
26124 it->nglyphs = width > 0 && height > 0;
26125 take_vertical_position_into_account (it);
26126 }
26127 else
26128 #endif
26129 it->nglyphs = width;
26130 }
26131
26132 /* Get information about special display element WHAT in an
26133 environment described by IT. WHAT is one of IT_TRUNCATION or
26134 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26135 non-null glyph_row member. This function ensures that fields like
26136 face_id, c, len of IT are left untouched. */
26137
26138 static void
26139 produce_special_glyphs (struct it *it, enum display_element_type what)
26140 {
26141 struct it temp_it;
26142 Lisp_Object gc;
26143 GLYPH glyph;
26144
26145 temp_it = *it;
26146 temp_it.object = Qnil;
26147 memset (&temp_it.current, 0, sizeof temp_it.current);
26148
26149 if (what == IT_CONTINUATION)
26150 {
26151 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26152 if (it->bidi_it.paragraph_dir == R2L)
26153 SET_GLYPH_FROM_CHAR (glyph, '/');
26154 else
26155 SET_GLYPH_FROM_CHAR (glyph, '\\');
26156 if (it->dp
26157 && (gc = DISP_CONTINUE_GLYPH (it->dp), GLYPH_CODE_P (gc)))
26158 {
26159 /* FIXME: Should we mirror GC for R2L lines? */
26160 SET_GLYPH_FROM_GLYPH_CODE (glyph, gc);
26161 spec_glyph_lookup_face (XWINDOW (it->window), &glyph);
26162 }
26163 }
26164 else if (what == IT_TRUNCATION)
26165 {
26166 /* Truncation glyph. */
26167 SET_GLYPH_FROM_CHAR (glyph, '$');
26168 if (it->dp
26169 && (gc = DISP_TRUNC_GLYPH (it->dp), GLYPH_CODE_P (gc)))
26170 {
26171 /* FIXME: Should we mirror GC for R2L lines? */
26172 SET_GLYPH_FROM_GLYPH_CODE (glyph, gc);
26173 spec_glyph_lookup_face (XWINDOW (it->window), &glyph);
26174 }
26175 }
26176 else
26177 emacs_abort ();
26178
26179 #ifdef HAVE_WINDOW_SYSTEM
26180 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26181 is turned off, we precede the truncation/continuation glyphs by a
26182 stretch glyph whose width is computed such that these special
26183 glyphs are aligned at the window margin, even when very different
26184 fonts are used in different glyph rows. */
26185 if (FRAME_WINDOW_P (temp_it.f)
26186 /* init_iterator calls this with it->glyph_row == NULL, and it
26187 wants only the pixel width of the truncation/continuation
26188 glyphs. */
26189 && temp_it.glyph_row
26190 /* insert_left_trunc_glyphs calls us at the beginning of the
26191 row, and it has its own calculation of the stretch glyph
26192 width. */
26193 && temp_it.glyph_row->used[TEXT_AREA] > 0
26194 && (temp_it.glyph_row->reversed_p
26195 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it.w)
26196 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it.w)) == 0)
26197 {
26198 int stretch_width = temp_it.last_visible_x - temp_it.current_x;
26199
26200 if (stretch_width > 0)
26201 {
26202 struct face *face = FACE_FROM_ID (temp_it.f, temp_it.face_id);
26203 struct font *font =
26204 face->font ? face->font : FRAME_FONT (temp_it.f);
26205 int stretch_ascent =
26206 (((temp_it.ascent + temp_it.descent)
26207 * FONT_BASE (font)) / FONT_HEIGHT (font));
26208
26209 append_stretch_glyph (&temp_it, Qnil, stretch_width,
26210 temp_it.ascent + temp_it.descent,
26211 stretch_ascent);
26212 }
26213 }
26214 #endif
26215
26216 temp_it.dp = NULL;
26217 temp_it.what = IT_CHARACTER;
26218 temp_it.c = temp_it.char_to_display = GLYPH_CHAR (glyph);
26219 temp_it.face_id = GLYPH_FACE (glyph);
26220 temp_it.len = CHAR_BYTES (temp_it.c);
26221
26222 PRODUCE_GLYPHS (&temp_it);
26223 it->pixel_width = temp_it.pixel_width;
26224 it->nglyphs = temp_it.nglyphs;
26225 }
26226
26227 #ifdef HAVE_WINDOW_SYSTEM
26228
26229 /* Calculate line-height and line-spacing properties.
26230 An integer value specifies explicit pixel value.
26231 A float value specifies relative value to current face height.
26232 A cons (float . face-name) specifies relative value to
26233 height of specified face font.
26234
26235 Returns height in pixels, or nil. */
26236
26237 static Lisp_Object
26238 calc_line_height_property (struct it *it, Lisp_Object val, struct font *font,
26239 int boff, bool override)
26240 {
26241 Lisp_Object face_name = Qnil;
26242 int ascent, descent, height;
26243
26244 if (NILP (val) || INTEGERP (val) || (override && EQ (val, Qt)))
26245 return val;
26246
26247 if (CONSP (val))
26248 {
26249 face_name = XCAR (val);
26250 val = XCDR (val);
26251 if (!NUMBERP (val))
26252 val = make_number (1);
26253 if (NILP (face_name))
26254 {
26255 height = it->ascent + it->descent;
26256 goto scale;
26257 }
26258 }
26259
26260 if (NILP (face_name))
26261 {
26262 font = FRAME_FONT (it->f);
26263 boff = FRAME_BASELINE_OFFSET (it->f);
26264 }
26265 else if (EQ (face_name, Qt))
26266 {
26267 override = false;
26268 }
26269 else
26270 {
26271 int face_id;
26272 struct face *face;
26273
26274 face_id = lookup_named_face (it->f, face_name, false);
26275 if (face_id < 0)
26276 return make_number (-1);
26277
26278 face = FACE_FROM_ID (it->f, face_id);
26279 font = face->font;
26280 if (font == NULL)
26281 return make_number (-1);
26282 boff = font->baseline_offset;
26283 if (font->vertical_centering)
26284 boff = VCENTER_BASELINE_OFFSET (font, it->f) - boff;
26285 }
26286
26287 normal_char_ascent_descent (font, -1, &ascent, &descent);
26288
26289 if (override)
26290 {
26291 it->override_ascent = ascent;
26292 it->override_descent = descent;
26293 it->override_boff = boff;
26294 }
26295
26296 height = ascent + descent;
26297
26298 scale:
26299 if (FLOATP (val))
26300 height = (int)(XFLOAT_DATA (val) * height);
26301 else if (INTEGERP (val))
26302 height *= XINT (val);
26303
26304 return make_number (height);
26305 }
26306
26307
26308 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26309 is a face ID to be used for the glyph. FOR_NO_FONT is true if
26310 and only if this is for a character for which no font was found.
26311
26312 If the display method (it->glyphless_method) is
26313 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26314 length of the acronym or the hexadecimal string, UPPER_XOFF and
26315 UPPER_YOFF are pixel offsets for the upper part of the string,
26316 LOWER_XOFF and LOWER_YOFF are for the lower part.
26317
26318 For the other display methods, LEN through LOWER_YOFF are zero. */
26319
26320 static void
26321 append_glyphless_glyph (struct it *it, int face_id, bool for_no_font, int len,
26322 short upper_xoff, short upper_yoff,
26323 short lower_xoff, short lower_yoff)
26324 {
26325 struct glyph *glyph;
26326 enum glyph_row_area area = it->area;
26327
26328 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
26329 if (glyph < it->glyph_row->glyphs[area + 1])
26330 {
26331 /* If the glyph row is reversed, we need to prepend the glyph
26332 rather than append it. */
26333 if (it->glyph_row->reversed_p && area == TEXT_AREA)
26334 {
26335 struct glyph *g;
26336
26337 /* Make room for the additional glyph. */
26338 for (g = glyph - 1; g >= it->glyph_row->glyphs[area]; g--)
26339 g[1] = *g;
26340 glyph = it->glyph_row->glyphs[area];
26341 }
26342 glyph->charpos = CHARPOS (it->position);
26343 glyph->object = it->object;
26344 glyph->pixel_width = it->pixel_width;
26345 glyph->ascent = it->ascent;
26346 glyph->descent = it->descent;
26347 glyph->voffset = it->voffset;
26348 glyph->type = GLYPHLESS_GLYPH;
26349 glyph->u.glyphless.method = it->glyphless_method;
26350 glyph->u.glyphless.for_no_font = for_no_font;
26351 glyph->u.glyphless.len = len;
26352 glyph->u.glyphless.ch = it->c;
26353 glyph->slice.glyphless.upper_xoff = upper_xoff;
26354 glyph->slice.glyphless.upper_yoff = upper_yoff;
26355 glyph->slice.glyphless.lower_xoff = lower_xoff;
26356 glyph->slice.glyphless.lower_yoff = lower_yoff;
26357 glyph->avoid_cursor_p = it->avoid_cursor_p;
26358 glyph->multibyte_p = it->multibyte_p;
26359 if (it->glyph_row->reversed_p && area == TEXT_AREA)
26360 {
26361 /* In R2L rows, the left and the right box edges need to be
26362 drawn in reverse direction. */
26363 glyph->right_box_line_p = it->start_of_box_run_p;
26364 glyph->left_box_line_p = it->end_of_box_run_p;
26365 }
26366 else
26367 {
26368 glyph->left_box_line_p = it->start_of_box_run_p;
26369 glyph->right_box_line_p = it->end_of_box_run_p;
26370 }
26371 glyph->overlaps_vertically_p = (it->phys_ascent > it->ascent
26372 || it->phys_descent > it->descent);
26373 glyph->padding_p = false;
26374 glyph->glyph_not_available_p = false;
26375 glyph->face_id = face_id;
26376 glyph->font_type = FONT_TYPE_UNKNOWN;
26377 if (it->bidi_p)
26378 {
26379 glyph->resolved_level = it->bidi_it.resolved_level;
26380 eassert ((it->bidi_it.type & 7) == it->bidi_it.type);
26381 glyph->bidi_type = it->bidi_it.type;
26382 }
26383 ++it->glyph_row->used[area];
26384 }
26385 else
26386 IT_EXPAND_MATRIX_WIDTH (it, area);
26387 }
26388
26389
26390 /* Produce a glyph for a glyphless character for iterator IT.
26391 IT->glyphless_method specifies which method to use for displaying
26392 the character. See the description of enum
26393 glyphless_display_method in dispextern.h for the detail.
26394
26395 FOR_NO_FONT is true if and only if this is for a character for
26396 which no font was found. ACRONYM, if non-nil, is an acronym string
26397 for the character. */
26398
26399 static void
26400 produce_glyphless_glyph (struct it *it, bool for_no_font, Lisp_Object acronym)
26401 {
26402 int face_id;
26403 struct face *face;
26404 struct font *font;
26405 int base_width, base_height, width, height;
26406 short upper_xoff, upper_yoff, lower_xoff, lower_yoff;
26407 int len;
26408
26409 /* Get the metrics of the base font. We always refer to the current
26410 ASCII face. */
26411 face = FACE_FROM_ID (it->f, it->face_id)->ascii_face;
26412 font = face->font ? face->font : FRAME_FONT (it->f);
26413 normal_char_ascent_descent (font, -1, &it->ascent, &it->descent);
26414 it->ascent += font->baseline_offset;
26415 it->descent -= font->baseline_offset;
26416 base_height = it->ascent + it->descent;
26417 base_width = font->average_width;
26418
26419 face_id = merge_glyphless_glyph_face (it);
26420
26421 if (it->glyphless_method == GLYPHLESS_DISPLAY_THIN_SPACE)
26422 {
26423 it->pixel_width = THIN_SPACE_WIDTH;
26424 len = 0;
26425 upper_xoff = upper_yoff = lower_xoff = lower_yoff = 0;
26426 }
26427 else if (it->glyphless_method == GLYPHLESS_DISPLAY_EMPTY_BOX)
26428 {
26429 width = CHAR_WIDTH (it->c);
26430 if (width == 0)
26431 width = 1;
26432 else if (width > 4)
26433 width = 4;
26434 it->pixel_width = base_width * width;
26435 len = 0;
26436 upper_xoff = upper_yoff = lower_xoff = lower_yoff = 0;
26437 }
26438 else
26439 {
26440 char buf[7];
26441 const char *str;
26442 unsigned int code[6];
26443 int upper_len;
26444 int ascent, descent;
26445 struct font_metrics metrics_upper, metrics_lower;
26446
26447 face = FACE_FROM_ID (it->f, face_id);
26448 font = face->font ? face->font : FRAME_FONT (it->f);
26449 prepare_face_for_display (it->f, face);
26450
26451 if (it->glyphless_method == GLYPHLESS_DISPLAY_ACRONYM)
26452 {
26453 if (! STRINGP (acronym) && CHAR_TABLE_P (Vglyphless_char_display))
26454 acronym = CHAR_TABLE_REF (Vglyphless_char_display, it->c);
26455 if (CONSP (acronym))
26456 acronym = XCAR (acronym);
26457 str = STRINGP (acronym) ? SSDATA (acronym) : "";
26458 }
26459 else
26460 {
26461 eassert (it->glyphless_method == GLYPHLESS_DISPLAY_HEX_CODE);
26462 sprintf (buf, "%0*X", it->c < 0x10000 ? 4 : 6, it->c + 0u);
26463 str = buf;
26464 }
26465 for (len = 0; str[len] && ASCII_CHAR_P (str[len]) && len < 6; len++)
26466 code[len] = font->driver->encode_char (font, str[len]);
26467 upper_len = (len + 1) / 2;
26468 font->driver->text_extents (font, code, upper_len,
26469 &metrics_upper);
26470 font->driver->text_extents (font, code + upper_len, len - upper_len,
26471 &metrics_lower);
26472
26473
26474
26475 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26476 width = max (metrics_upper.width, metrics_lower.width) + 4;
26477 upper_xoff = upper_yoff = 2; /* the typical case */
26478 if (base_width >= width)
26479 {
26480 /* Align the upper to the left, the lower to the right. */
26481 it->pixel_width = base_width;
26482 lower_xoff = base_width - 2 - metrics_lower.width;
26483 }
26484 else
26485 {
26486 /* Center the shorter one. */
26487 it->pixel_width = width;
26488 if (metrics_upper.width >= metrics_lower.width)
26489 lower_xoff = (width - metrics_lower.width) / 2;
26490 else
26491 {
26492 /* FIXME: This code doesn't look right. It formerly was
26493 missing the "lower_xoff = 0;", which couldn't have
26494 been right since it left lower_xoff uninitialized. */
26495 lower_xoff = 0;
26496 upper_xoff = (width - metrics_upper.width) / 2;
26497 }
26498 }
26499
26500 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26501 top, bottom, and between upper and lower strings. */
26502 height = (metrics_upper.ascent + metrics_upper.descent
26503 + metrics_lower.ascent + metrics_lower.descent) + 5;
26504 /* Center vertically.
26505 H:base_height, D:base_descent
26506 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26507
26508 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26509 descent = D - H/2 + h/2;
26510 lower_yoff = descent - 2 - ld;
26511 upper_yoff = lower_yoff - la - 1 - ud; */
26512 ascent = - (it->descent - (base_height + height + 1) / 2);
26513 descent = it->descent - (base_height - height) / 2;
26514 lower_yoff = descent - 2 - metrics_lower.descent;
26515 upper_yoff = (lower_yoff - metrics_lower.ascent - 1
26516 - metrics_upper.descent);
26517 /* Don't make the height shorter than the base height. */
26518 if (height > base_height)
26519 {
26520 it->ascent = ascent;
26521 it->descent = descent;
26522 }
26523 }
26524
26525 it->phys_ascent = it->ascent;
26526 it->phys_descent = it->descent;
26527 if (it->glyph_row)
26528 append_glyphless_glyph (it, face_id, for_no_font, len,
26529 upper_xoff, upper_yoff,
26530 lower_xoff, lower_yoff);
26531 it->nglyphs = 1;
26532 take_vertical_position_into_account (it);
26533 }
26534
26535
26536 /* RIF:
26537 Produce glyphs/get display metrics for the display element IT is
26538 loaded with. See the description of struct it in dispextern.h
26539 for an overview of struct it. */
26540
26541 void
26542 x_produce_glyphs (struct it *it)
26543 {
26544 int extra_line_spacing = it->extra_line_spacing;
26545
26546 it->glyph_not_available_p = false;
26547
26548 if (it->what == IT_CHARACTER)
26549 {
26550 XChar2b char2b;
26551 struct face *face = FACE_FROM_ID (it->f, it->face_id);
26552 struct font *font = face->font;
26553 struct font_metrics *pcm = NULL;
26554 int boff; /* Baseline offset. */
26555
26556 if (font == NULL)
26557 {
26558 /* When no suitable font is found, display this character by
26559 the method specified in the first extra slot of
26560 Vglyphless_char_display. */
26561 Lisp_Object acronym = lookup_glyphless_char_display (-1, it);
26562
26563 eassert (it->what == IT_GLYPHLESS);
26564 produce_glyphless_glyph (it, true,
26565 STRINGP (acronym) ? acronym : Qnil);
26566 goto done;
26567 }
26568
26569 boff = font->baseline_offset;
26570 if (font->vertical_centering)
26571 boff = VCENTER_BASELINE_OFFSET (font, it->f) - boff;
26572
26573 if (it->char_to_display != '\n' && it->char_to_display != '\t')
26574 {
26575 it->nglyphs = 1;
26576
26577 if (it->override_ascent >= 0)
26578 {
26579 it->ascent = it->override_ascent;
26580 it->descent = it->override_descent;
26581 boff = it->override_boff;
26582 }
26583 else
26584 {
26585 it->ascent = FONT_BASE (font) + boff;
26586 it->descent = FONT_DESCENT (font) - boff;
26587 }
26588
26589 if (get_char_glyph_code (it->char_to_display, font, &char2b))
26590 {
26591 pcm = get_per_char_metric (font, &char2b);
26592 if (pcm->width == 0
26593 && pcm->rbearing == 0 && pcm->lbearing == 0)
26594 pcm = NULL;
26595 }
26596
26597 if (pcm)
26598 {
26599 it->phys_ascent = pcm->ascent + boff;
26600 it->phys_descent = pcm->descent - boff;
26601 it->pixel_width = pcm->width;
26602 /* Don't use font-global values for ascent and descent
26603 if they result in an exceedingly large line height. */
26604 if (it->override_ascent < 0)
26605 {
26606 if (FONT_TOO_HIGH (font))
26607 {
26608 it->ascent = it->phys_ascent;
26609 it->descent = it->phys_descent;
26610 /* These limitations are enforced by an
26611 assertion near the end of this function. */
26612 if (it->ascent < 0)
26613 it->ascent = 0;
26614 if (it->descent < 0)
26615 it->descent = 0;
26616 }
26617 }
26618 }
26619 else
26620 {
26621 it->glyph_not_available_p = true;
26622 it->phys_ascent = it->ascent;
26623 it->phys_descent = it->descent;
26624 it->pixel_width = font->space_width;
26625 }
26626
26627 if (it->constrain_row_ascent_descent_p)
26628 {
26629 if (it->descent > it->max_descent)
26630 {
26631 it->ascent += it->descent - it->max_descent;
26632 it->descent = it->max_descent;
26633 }
26634 if (it->ascent > it->max_ascent)
26635 {
26636 it->descent = min (it->max_descent, it->descent + it->ascent - it->max_ascent);
26637 it->ascent = it->max_ascent;
26638 }
26639 it->phys_ascent = min (it->phys_ascent, it->ascent);
26640 it->phys_descent = min (it->phys_descent, it->descent);
26641 extra_line_spacing = 0;
26642 }
26643
26644 /* If this is a space inside a region of text with
26645 `space-width' property, change its width. */
26646 bool stretched_p
26647 = it->char_to_display == ' ' && !NILP (it->space_width);
26648 if (stretched_p)
26649 it->pixel_width *= XFLOATINT (it->space_width);
26650
26651 /* If face has a box, add the box thickness to the character
26652 height. If character has a box line to the left and/or
26653 right, add the box line width to the character's width. */
26654 if (face->box != FACE_NO_BOX)
26655 {
26656 int thick = face->box_line_width;
26657
26658 if (thick > 0)
26659 {
26660 it->ascent += thick;
26661 it->descent += thick;
26662 }
26663 else
26664 thick = -thick;
26665
26666 if (it->start_of_box_run_p)
26667 it->pixel_width += thick;
26668 if (it->end_of_box_run_p)
26669 it->pixel_width += thick;
26670 }
26671
26672 /* If face has an overline, add the height of the overline
26673 (1 pixel) and a 1 pixel margin to the character height. */
26674 if (face->overline_p)
26675 it->ascent += overline_margin;
26676
26677 if (it->constrain_row_ascent_descent_p)
26678 {
26679 if (it->ascent > it->max_ascent)
26680 it->ascent = it->max_ascent;
26681 if (it->descent > it->max_descent)
26682 it->descent = it->max_descent;
26683 }
26684
26685 take_vertical_position_into_account (it);
26686
26687 /* If we have to actually produce glyphs, do it. */
26688 if (it->glyph_row)
26689 {
26690 if (stretched_p)
26691 {
26692 /* Translate a space with a `space-width' property
26693 into a stretch glyph. */
26694 int ascent = (((it->ascent + it->descent) * FONT_BASE (font))
26695 / FONT_HEIGHT (font));
26696 append_stretch_glyph (it, it->object, it->pixel_width,
26697 it->ascent + it->descent, ascent);
26698 }
26699 else
26700 append_glyph (it);
26701
26702 /* If characters with lbearing or rbearing are displayed
26703 in this line, record that fact in a flag of the
26704 glyph row. This is used to optimize X output code. */
26705 if (pcm && (pcm->lbearing < 0 || pcm->rbearing > pcm->width))
26706 it->glyph_row->contains_overlapping_glyphs_p = true;
26707 }
26708 if (! stretched_p && it->pixel_width == 0)
26709 /* We assure that all visible glyphs have at least 1-pixel
26710 width. */
26711 it->pixel_width = 1;
26712 }
26713 else if (it->char_to_display == '\n')
26714 {
26715 /* A newline has no width, but we need the height of the
26716 line. But if previous part of the line sets a height,
26717 don't increase that height. */
26718
26719 Lisp_Object height;
26720 Lisp_Object total_height = Qnil;
26721
26722 it->override_ascent = -1;
26723 it->pixel_width = 0;
26724 it->nglyphs = 0;
26725
26726 height = get_it_property (it, Qline_height);
26727 /* Split (line-height total-height) list. */
26728 if (CONSP (height)
26729 && CONSP (XCDR (height))
26730 && NILP (XCDR (XCDR (height))))
26731 {
26732 total_height = XCAR (XCDR (height));
26733 height = XCAR (height);
26734 }
26735 height = calc_line_height_property (it, height, font, boff, true);
26736
26737 if (it->override_ascent >= 0)
26738 {
26739 it->ascent = it->override_ascent;
26740 it->descent = it->override_descent;
26741 boff = it->override_boff;
26742 }
26743 else
26744 {
26745 if (FONT_TOO_HIGH (font))
26746 {
26747 it->ascent = font->pixel_size + boff - 1;
26748 it->descent = -boff + 1;
26749 if (it->descent < 0)
26750 it->descent = 0;
26751 }
26752 else
26753 {
26754 it->ascent = FONT_BASE (font) + boff;
26755 it->descent = FONT_DESCENT (font) - boff;
26756 }
26757 }
26758
26759 if (EQ (height, Qt))
26760 {
26761 if (it->descent > it->max_descent)
26762 {
26763 it->ascent += it->descent - it->max_descent;
26764 it->descent = it->max_descent;
26765 }
26766 if (it->ascent > it->max_ascent)
26767 {
26768 it->descent = min (it->max_descent, it->descent + it->ascent - it->max_ascent);
26769 it->ascent = it->max_ascent;
26770 }
26771 it->phys_ascent = min (it->phys_ascent, it->ascent);
26772 it->phys_descent = min (it->phys_descent, it->descent);
26773 it->constrain_row_ascent_descent_p = true;
26774 extra_line_spacing = 0;
26775 }
26776 else
26777 {
26778 Lisp_Object spacing;
26779
26780 it->phys_ascent = it->ascent;
26781 it->phys_descent = it->descent;
26782
26783 if ((it->max_ascent > 0 || it->max_descent > 0)
26784 && face->box != FACE_NO_BOX
26785 && face->box_line_width > 0)
26786 {
26787 it->ascent += face->box_line_width;
26788 it->descent += face->box_line_width;
26789 }
26790 if (!NILP (height)
26791 && XINT (height) > it->ascent + it->descent)
26792 it->ascent = XINT (height) - it->descent;
26793
26794 if (!NILP (total_height))
26795 spacing = calc_line_height_property (it, total_height, font,
26796 boff, false);
26797 else
26798 {
26799 spacing = get_it_property (it, Qline_spacing);
26800 spacing = calc_line_height_property (it, spacing, font,
26801 boff, false);
26802 }
26803 if (INTEGERP (spacing))
26804 {
26805 extra_line_spacing = XINT (spacing);
26806 if (!NILP (total_height))
26807 extra_line_spacing -= (it->phys_ascent + it->phys_descent);
26808 }
26809 }
26810 }
26811 else /* i.e. (it->char_to_display == '\t') */
26812 {
26813 if (font->space_width > 0)
26814 {
26815 int tab_width = it->tab_width * font->space_width;
26816 int x = it->current_x + it->continuation_lines_width;
26817 int next_tab_x = ((1 + x + tab_width - 1) / tab_width) * tab_width;
26818
26819 /* If the distance from the current position to the next tab
26820 stop is less than a space character width, use the
26821 tab stop after that. */
26822 if (next_tab_x - x < font->space_width)
26823 next_tab_x += tab_width;
26824
26825 it->pixel_width = next_tab_x - x;
26826 it->nglyphs = 1;
26827 if (FONT_TOO_HIGH (font))
26828 {
26829 if (get_char_glyph_code (' ', font, &char2b))
26830 {
26831 pcm = get_per_char_metric (font, &char2b);
26832 if (pcm->width == 0
26833 && pcm->rbearing == 0 && pcm->lbearing == 0)
26834 pcm = NULL;
26835 }
26836
26837 if (pcm)
26838 {
26839 it->ascent = pcm->ascent + boff;
26840 it->descent = pcm->descent - boff;
26841 }
26842 else
26843 {
26844 it->ascent = font->pixel_size + boff - 1;
26845 it->descent = -boff + 1;
26846 }
26847 if (it->ascent < 0)
26848 it->ascent = 0;
26849 if (it->descent < 0)
26850 it->descent = 0;
26851 }
26852 else
26853 {
26854 it->ascent = FONT_BASE (font) + boff;
26855 it->descent = FONT_DESCENT (font) - boff;
26856 }
26857 it->phys_ascent = it->ascent;
26858 it->phys_descent = it->descent;
26859
26860 if (it->glyph_row)
26861 {
26862 append_stretch_glyph (it, it->object, it->pixel_width,
26863 it->ascent + it->descent, it->ascent);
26864 }
26865 }
26866 else
26867 {
26868 it->pixel_width = 0;
26869 it->nglyphs = 1;
26870 }
26871 }
26872
26873 if (FONT_TOO_HIGH (font))
26874 {
26875 int font_ascent, font_descent;
26876
26877 /* For very large fonts, where we ignore the declared font
26878 dimensions, and go by per-character metrics instead,
26879 don't let the row ascent and descent values (and the row
26880 height computed from them) be smaller than the "normal"
26881 character metrics. This avoids unpleasant effects
26882 whereby lines on display would change their height
26883 depending on which characters are shown. */
26884 normal_char_ascent_descent (font, -1, &font_ascent, &font_descent);
26885 it->max_ascent = max (it->max_ascent, font_ascent);
26886 it->max_descent = max (it->max_descent, font_descent);
26887 }
26888 }
26889 else if (it->what == IT_COMPOSITION && it->cmp_it.ch < 0)
26890 {
26891 /* A static composition.
26892
26893 Note: A composition is represented as one glyph in the
26894 glyph matrix. There are no padding glyphs.
26895
26896 Important note: pixel_width, ascent, and descent are the
26897 values of what is drawn by draw_glyphs (i.e. the values of
26898 the overall glyphs composed). */
26899 struct face *face = FACE_FROM_ID (it->f, it->face_id);
26900 int boff; /* baseline offset */
26901 struct composition *cmp = composition_table[it->cmp_it.id];
26902 int glyph_len = cmp->glyph_len;
26903 struct font *font = face->font;
26904
26905 it->nglyphs = 1;
26906
26907 /* If we have not yet calculated pixel size data of glyphs of
26908 the composition for the current face font, calculate them
26909 now. Theoretically, we have to check all fonts for the
26910 glyphs, but that requires much time and memory space. So,
26911 here we check only the font of the first glyph. This may
26912 lead to incorrect display, but it's very rare, and C-l
26913 (recenter-top-bottom) can correct the display anyway. */
26914 if (! cmp->font || cmp->font != font)
26915 {
26916 /* Ascent and descent of the font of the first character
26917 of this composition (adjusted by baseline offset).
26918 Ascent and descent of overall glyphs should not be less
26919 than these, respectively. */
26920 int font_ascent, font_descent, font_height;
26921 /* Bounding box of the overall glyphs. */
26922 int leftmost, rightmost, lowest, highest;
26923 int lbearing, rbearing;
26924 int i, width, ascent, descent;
26925 int c IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26926 XChar2b char2b;
26927 struct font_metrics *pcm;
26928 ptrdiff_t pos;
26929
26930 for (glyph_len = cmp->glyph_len; glyph_len > 0; glyph_len--)
26931 if ((c = COMPOSITION_GLYPH (cmp, glyph_len - 1)) != '\t')
26932 break;
26933 bool right_padded = glyph_len < cmp->glyph_len;
26934 for (i = 0; i < glyph_len; i++)
26935 {
26936 if ((c = COMPOSITION_GLYPH (cmp, i)) != '\t')
26937 break;
26938 cmp->offsets[i * 2] = cmp->offsets[i * 2 + 1] = 0;
26939 }
26940 bool left_padded = i > 0;
26941
26942 pos = (STRINGP (it->string) ? IT_STRING_CHARPOS (*it)
26943 : IT_CHARPOS (*it));
26944 /* If no suitable font is found, use the default font. */
26945 bool font_not_found_p = font == NULL;
26946 if (font_not_found_p)
26947 {
26948 face = face->ascii_face;
26949 font = face->font;
26950 }
26951 boff = font->baseline_offset;
26952 if (font->vertical_centering)
26953 boff = VCENTER_BASELINE_OFFSET (font, it->f) - boff;
26954 normal_char_ascent_descent (font, -1, &font_ascent, &font_descent);
26955 font_ascent += boff;
26956 font_descent -= boff;
26957 font_height = font_ascent + font_descent;
26958
26959 cmp->font = font;
26960
26961 pcm = NULL;
26962 if (! font_not_found_p)
26963 {
26964 get_char_face_and_encoding (it->f, c, it->face_id,
26965 &char2b, false);
26966 pcm = get_per_char_metric (font, &char2b);
26967 }
26968
26969 /* Initialize the bounding box. */
26970 if (pcm)
26971 {
26972 width = cmp->glyph_len > 0 ? pcm->width : 0;
26973 ascent = pcm->ascent;
26974 descent = pcm->descent;
26975 lbearing = pcm->lbearing;
26976 rbearing = pcm->rbearing;
26977 }
26978 else
26979 {
26980 width = cmp->glyph_len > 0 ? font->space_width : 0;
26981 ascent = FONT_BASE (font);
26982 descent = FONT_DESCENT (font);
26983 lbearing = 0;
26984 rbearing = width;
26985 }
26986
26987 rightmost = width;
26988 leftmost = 0;
26989 lowest = - descent + boff;
26990 highest = ascent + boff;
26991
26992 if (! font_not_found_p
26993 && font->default_ascent
26994 && CHAR_TABLE_P (Vuse_default_ascent)
26995 && !NILP (Faref (Vuse_default_ascent,
26996 make_number (it->char_to_display))))
26997 highest = font->default_ascent + boff;
26998
26999 /* Draw the first glyph at the normal position. It may be
27000 shifted to right later if some other glyphs are drawn
27001 at the left. */
27002 cmp->offsets[i * 2] = 0;
27003 cmp->offsets[i * 2 + 1] = boff;
27004 cmp->lbearing = lbearing;
27005 cmp->rbearing = rbearing;
27006
27007 /* Set cmp->offsets for the remaining glyphs. */
27008 for (i++; i < glyph_len; i++)
27009 {
27010 int left, right, btm, top;
27011 int ch = COMPOSITION_GLYPH (cmp, i);
27012 int face_id;
27013 struct face *this_face;
27014
27015 if (ch == '\t')
27016 ch = ' ';
27017 face_id = FACE_FOR_CHAR (it->f, face, ch, pos, it->string);
27018 this_face = FACE_FROM_ID (it->f, face_id);
27019 font = this_face->font;
27020
27021 if (font == NULL)
27022 pcm = NULL;
27023 else
27024 {
27025 get_char_face_and_encoding (it->f, ch, face_id,
27026 &char2b, false);
27027 pcm = get_per_char_metric (font, &char2b);
27028 }
27029 if (! pcm)
27030 cmp->offsets[i * 2] = cmp->offsets[i * 2 + 1] = 0;
27031 else
27032 {
27033 width = pcm->width;
27034 ascent = pcm->ascent;
27035 descent = pcm->descent;
27036 lbearing = pcm->lbearing;
27037 rbearing = pcm->rbearing;
27038 if (cmp->method != COMPOSITION_WITH_RULE_ALTCHARS)
27039 {
27040 /* Relative composition with or without
27041 alternate chars. */
27042 left = (leftmost + rightmost - width) / 2;
27043 btm = - descent + boff;
27044 if (font->relative_compose
27045 && (! CHAR_TABLE_P (Vignore_relative_composition)
27046 || NILP (Faref (Vignore_relative_composition,
27047 make_number (ch)))))
27048 {
27049
27050 if (- descent >= font->relative_compose)
27051 /* One extra pixel between two glyphs. */
27052 btm = highest + 1;
27053 else if (ascent <= 0)
27054 /* One extra pixel between two glyphs. */
27055 btm = lowest - 1 - ascent - descent;
27056 }
27057 }
27058 else
27059 {
27060 /* A composition rule is specified by an integer
27061 value that encodes global and new reference
27062 points (GREF and NREF). GREF and NREF are
27063 specified by numbers as below:
27064
27065 0---1---2 -- ascent
27066 | |
27067 | |
27068 | |
27069 9--10--11 -- center
27070 | |
27071 ---3---4---5--- baseline
27072 | |
27073 6---7---8 -- descent
27074 */
27075 int rule = COMPOSITION_RULE (cmp, i);
27076 int gref, nref, grefx, grefy, nrefx, nrefy, xoff, yoff;
27077
27078 COMPOSITION_DECODE_RULE (rule, gref, nref, xoff, yoff);
27079 grefx = gref % 3, nrefx = nref % 3;
27080 grefy = gref / 3, nrefy = nref / 3;
27081 if (xoff)
27082 xoff = font_height * (xoff - 128) / 256;
27083 if (yoff)
27084 yoff = font_height * (yoff - 128) / 256;
27085
27086 left = (leftmost
27087 + grefx * (rightmost - leftmost) / 2
27088 - nrefx * width / 2
27089 + xoff);
27090
27091 btm = ((grefy == 0 ? highest
27092 : grefy == 1 ? 0
27093 : grefy == 2 ? lowest
27094 : (highest + lowest) / 2)
27095 - (nrefy == 0 ? ascent + descent
27096 : nrefy == 1 ? descent - boff
27097 : nrefy == 2 ? 0
27098 : (ascent + descent) / 2)
27099 + yoff);
27100 }
27101
27102 cmp->offsets[i * 2] = left;
27103 cmp->offsets[i * 2 + 1] = btm + descent;
27104
27105 /* Update the bounding box of the overall glyphs. */
27106 if (width > 0)
27107 {
27108 right = left + width;
27109 if (left < leftmost)
27110 leftmost = left;
27111 if (right > rightmost)
27112 rightmost = right;
27113 }
27114 top = btm + descent + ascent;
27115 if (top > highest)
27116 highest = top;
27117 if (btm < lowest)
27118 lowest = btm;
27119
27120 if (cmp->lbearing > left + lbearing)
27121 cmp->lbearing = left + lbearing;
27122 if (cmp->rbearing < left + rbearing)
27123 cmp->rbearing = left + rbearing;
27124 }
27125 }
27126
27127 /* If there are glyphs whose x-offsets are negative,
27128 shift all glyphs to the right and make all x-offsets
27129 non-negative. */
27130 if (leftmost < 0)
27131 {
27132 for (i = 0; i < cmp->glyph_len; i++)
27133 cmp->offsets[i * 2] -= leftmost;
27134 rightmost -= leftmost;
27135 cmp->lbearing -= leftmost;
27136 cmp->rbearing -= leftmost;
27137 }
27138
27139 if (left_padded && cmp->lbearing < 0)
27140 {
27141 for (i = 0; i < cmp->glyph_len; i++)
27142 cmp->offsets[i * 2] -= cmp->lbearing;
27143 rightmost -= cmp->lbearing;
27144 cmp->rbearing -= cmp->lbearing;
27145 cmp->lbearing = 0;
27146 }
27147 if (right_padded && rightmost < cmp->rbearing)
27148 {
27149 rightmost = cmp->rbearing;
27150 }
27151
27152 cmp->pixel_width = rightmost;
27153 cmp->ascent = highest;
27154 cmp->descent = - lowest;
27155 if (cmp->ascent < font_ascent)
27156 cmp->ascent = font_ascent;
27157 if (cmp->descent < font_descent)
27158 cmp->descent = font_descent;
27159 }
27160
27161 if (it->glyph_row
27162 && (cmp->lbearing < 0
27163 || cmp->rbearing > cmp->pixel_width))
27164 it->glyph_row->contains_overlapping_glyphs_p = true;
27165
27166 it->pixel_width = cmp->pixel_width;
27167 it->ascent = it->phys_ascent = cmp->ascent;
27168 it->descent = it->phys_descent = cmp->descent;
27169 if (face->box != FACE_NO_BOX)
27170 {
27171 int thick = face->box_line_width;
27172
27173 if (thick > 0)
27174 {
27175 it->ascent += thick;
27176 it->descent += thick;
27177 }
27178 else
27179 thick = - thick;
27180
27181 if (it->start_of_box_run_p)
27182 it->pixel_width += thick;
27183 if (it->end_of_box_run_p)
27184 it->pixel_width += thick;
27185 }
27186
27187 /* If face has an overline, add the height of the overline
27188 (1 pixel) and a 1 pixel margin to the character height. */
27189 if (face->overline_p)
27190 it->ascent += overline_margin;
27191
27192 take_vertical_position_into_account (it);
27193 if (it->ascent < 0)
27194 it->ascent = 0;
27195 if (it->descent < 0)
27196 it->descent = 0;
27197
27198 if (it->glyph_row && cmp->glyph_len > 0)
27199 append_composite_glyph (it);
27200 }
27201 else if (it->what == IT_COMPOSITION)
27202 {
27203 /* A dynamic (automatic) composition. */
27204 struct face *face = FACE_FROM_ID (it->f, it->face_id);
27205 Lisp_Object gstring;
27206 struct font_metrics metrics;
27207
27208 it->nglyphs = 1;
27209
27210 gstring = composition_gstring_from_id (it->cmp_it.id);
27211 it->pixel_width
27212 = composition_gstring_width (gstring, it->cmp_it.from, it->cmp_it.to,
27213 &metrics);
27214 if (it->glyph_row
27215 && (metrics.lbearing < 0 || metrics.rbearing > metrics.width))
27216 it->glyph_row->contains_overlapping_glyphs_p = true;
27217 it->ascent = it->phys_ascent = metrics.ascent;
27218 it->descent = it->phys_descent = metrics.descent;
27219 if (face->box != FACE_NO_BOX)
27220 {
27221 int thick = face->box_line_width;
27222
27223 if (thick > 0)
27224 {
27225 it->ascent += thick;
27226 it->descent += thick;
27227 }
27228 else
27229 thick = - thick;
27230
27231 if (it->start_of_box_run_p)
27232 it->pixel_width += thick;
27233 if (it->end_of_box_run_p)
27234 it->pixel_width += thick;
27235 }
27236 /* If face has an overline, add the height of the overline
27237 (1 pixel) and a 1 pixel margin to the character height. */
27238 if (face->overline_p)
27239 it->ascent += overline_margin;
27240 take_vertical_position_into_account (it);
27241 if (it->ascent < 0)
27242 it->ascent = 0;
27243 if (it->descent < 0)
27244 it->descent = 0;
27245
27246 if (it->glyph_row)
27247 append_composite_glyph (it);
27248 }
27249 else if (it->what == IT_GLYPHLESS)
27250 produce_glyphless_glyph (it, false, Qnil);
27251 else if (it->what == IT_IMAGE)
27252 produce_image_glyph (it);
27253 else if (it->what == IT_STRETCH)
27254 produce_stretch_glyph (it);
27255
27256 done:
27257 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27258 because this isn't true for images with `:ascent 100'. */
27259 eassert (it->ascent >= 0 && it->descent >= 0);
27260 if (it->area == TEXT_AREA)
27261 it->current_x += it->pixel_width;
27262
27263 if (extra_line_spacing > 0)
27264 {
27265 it->descent += extra_line_spacing;
27266 if (extra_line_spacing > it->max_extra_line_spacing)
27267 it->max_extra_line_spacing = extra_line_spacing;
27268 }
27269
27270 it->max_ascent = max (it->max_ascent, it->ascent);
27271 it->max_descent = max (it->max_descent, it->descent);
27272 it->max_phys_ascent = max (it->max_phys_ascent, it->phys_ascent);
27273 it->max_phys_descent = max (it->max_phys_descent, it->phys_descent);
27274 }
27275
27276 /* EXPORT for RIF:
27277 Output LEN glyphs starting at START at the nominal cursor position.
27278 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27279 being updated, and UPDATED_AREA is the area of that row being updated. */
27280
27281 void
27282 x_write_glyphs (struct window *w, struct glyph_row *updated_row,
27283 struct glyph *start, enum glyph_row_area updated_area, int len)
27284 {
27285 int x, hpos, chpos = w->phys_cursor.hpos;
27286
27287 eassert (updated_row);
27288 /* When the window is hscrolled, cursor hpos can legitimately be out
27289 of bounds, but we draw the cursor at the corresponding window
27290 margin in that case. */
27291 if (!updated_row->reversed_p && chpos < 0)
27292 chpos = 0;
27293 if (updated_row->reversed_p && chpos >= updated_row->used[TEXT_AREA])
27294 chpos = updated_row->used[TEXT_AREA] - 1;
27295
27296 block_input ();
27297
27298 /* Write glyphs. */
27299
27300 hpos = start - updated_row->glyphs[updated_area];
27301 x = draw_glyphs (w, w->output_cursor.x,
27302 updated_row, updated_area,
27303 hpos, hpos + len,
27304 DRAW_NORMAL_TEXT, 0);
27305
27306 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27307 if (updated_area == TEXT_AREA
27308 && w->phys_cursor_on_p
27309 && w->phys_cursor.vpos == w->output_cursor.vpos
27310 && chpos >= hpos
27311 && chpos < hpos + len)
27312 w->phys_cursor_on_p = false;
27313
27314 unblock_input ();
27315
27316 /* Advance the output cursor. */
27317 w->output_cursor.hpos += len;
27318 w->output_cursor.x = x;
27319 }
27320
27321
27322 /* EXPORT for RIF:
27323 Insert LEN glyphs from START at the nominal cursor position. */
27324
27325 void
27326 x_insert_glyphs (struct window *w, struct glyph_row *updated_row,
27327 struct glyph *start, enum glyph_row_area updated_area, int len)
27328 {
27329 struct frame *f;
27330 int line_height, shift_by_width, shifted_region_width;
27331 struct glyph_row *row;
27332 struct glyph *glyph;
27333 int frame_x, frame_y;
27334 ptrdiff_t hpos;
27335
27336 eassert (updated_row);
27337 block_input ();
27338 f = XFRAME (WINDOW_FRAME (w));
27339
27340 /* Get the height of the line we are in. */
27341 row = updated_row;
27342 line_height = row->height;
27343
27344 /* Get the width of the glyphs to insert. */
27345 shift_by_width = 0;
27346 for (glyph = start; glyph < start + len; ++glyph)
27347 shift_by_width += glyph->pixel_width;
27348
27349 /* Get the width of the region to shift right. */
27350 shifted_region_width = (window_box_width (w, updated_area)
27351 - w->output_cursor.x
27352 - shift_by_width);
27353
27354 /* Shift right. */
27355 frame_x = window_box_left (w, updated_area) + w->output_cursor.x;
27356 frame_y = WINDOW_TO_FRAME_PIXEL_Y (w, w->output_cursor.y);
27357
27358 FRAME_RIF (f)->shift_glyphs_for_insert (f, frame_x, frame_y, shifted_region_width,
27359 line_height, shift_by_width);
27360
27361 /* Write the glyphs. */
27362 hpos = start - row->glyphs[updated_area];
27363 draw_glyphs (w, w->output_cursor.x, row, updated_area,
27364 hpos, hpos + len,
27365 DRAW_NORMAL_TEXT, 0);
27366
27367 /* Advance the output cursor. */
27368 w->output_cursor.hpos += len;
27369 w->output_cursor.x += shift_by_width;
27370 unblock_input ();
27371 }
27372
27373
27374 /* EXPORT for RIF:
27375 Erase the current text line from the nominal cursor position
27376 (inclusive) to pixel column TO_X (exclusive). The idea is that
27377 everything from TO_X onward is already erased.
27378
27379 TO_X is a pixel position relative to UPDATED_AREA of currently
27380 updated window W. TO_X == -1 means clear to the end of this area. */
27381
27382 void
27383 x_clear_end_of_line (struct window *w, struct glyph_row *updated_row,
27384 enum glyph_row_area updated_area, int to_x)
27385 {
27386 struct frame *f;
27387 int max_x, min_y, max_y;
27388 int from_x, from_y, to_y;
27389
27390 eassert (updated_row);
27391 f = XFRAME (w->frame);
27392
27393 if (updated_row->full_width_p)
27394 max_x = (WINDOW_PIXEL_WIDTH (w)
27395 - (updated_row->mode_line_p ? WINDOW_RIGHT_DIVIDER_WIDTH (w) : 0));
27396 else
27397 max_x = window_box_width (w, updated_area);
27398 max_y = window_text_bottom_y (w);
27399
27400 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27401 of window. For TO_X > 0, truncate to end of drawing area. */
27402 if (to_x == 0)
27403 return;
27404 else if (to_x < 0)
27405 to_x = max_x;
27406 else
27407 to_x = min (to_x, max_x);
27408
27409 to_y = min (max_y, w->output_cursor.y + updated_row->height);
27410
27411 /* Notice if the cursor will be cleared by this operation. */
27412 if (!updated_row->full_width_p)
27413 notice_overwritten_cursor (w, updated_area,
27414 w->output_cursor.x, -1,
27415 updated_row->y,
27416 MATRIX_ROW_BOTTOM_Y (updated_row));
27417
27418 from_x = w->output_cursor.x;
27419
27420 /* Translate to frame coordinates. */
27421 if (updated_row->full_width_p)
27422 {
27423 from_x = WINDOW_TO_FRAME_PIXEL_X (w, from_x);
27424 to_x = WINDOW_TO_FRAME_PIXEL_X (w, to_x);
27425 }
27426 else
27427 {
27428 int area_left = window_box_left (w, updated_area);
27429 from_x += area_left;
27430 to_x += area_left;
27431 }
27432
27433 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
27434 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, max (min_y, w->output_cursor.y));
27435 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, to_y);
27436
27437 /* Prevent inadvertently clearing to end of the X window. */
27438 if (to_x > from_x && to_y > from_y)
27439 {
27440 block_input ();
27441 FRAME_RIF (f)->clear_frame_area (f, from_x, from_y,
27442 to_x - from_x, to_y - from_y);
27443 unblock_input ();
27444 }
27445 }
27446
27447 #endif /* HAVE_WINDOW_SYSTEM */
27448
27449
27450 \f
27451 /***********************************************************************
27452 Cursor types
27453 ***********************************************************************/
27454
27455 /* Value is the internal representation of the specified cursor type
27456 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27457 of the bar cursor. */
27458
27459 static enum text_cursor_kinds
27460 get_specified_cursor_type (Lisp_Object arg, int *width)
27461 {
27462 enum text_cursor_kinds type;
27463
27464 if (NILP (arg))
27465 return NO_CURSOR;
27466
27467 if (EQ (arg, Qbox))
27468 return FILLED_BOX_CURSOR;
27469
27470 if (EQ (arg, Qhollow))
27471 return HOLLOW_BOX_CURSOR;
27472
27473 if (EQ (arg, Qbar))
27474 {
27475 *width = 2;
27476 return BAR_CURSOR;
27477 }
27478
27479 if (CONSP (arg)
27480 && EQ (XCAR (arg), Qbar)
27481 && RANGED_INTEGERP (0, XCDR (arg), INT_MAX))
27482 {
27483 *width = XINT (XCDR (arg));
27484 return BAR_CURSOR;
27485 }
27486
27487 if (EQ (arg, Qhbar))
27488 {
27489 *width = 2;
27490 return HBAR_CURSOR;
27491 }
27492
27493 if (CONSP (arg)
27494 && EQ (XCAR (arg), Qhbar)
27495 && RANGED_INTEGERP (0, XCDR (arg), INT_MAX))
27496 {
27497 *width = XINT (XCDR (arg));
27498 return HBAR_CURSOR;
27499 }
27500
27501 /* Treat anything unknown as "hollow box cursor".
27502 It was bad to signal an error; people have trouble fixing
27503 .Xdefaults with Emacs, when it has something bad in it. */
27504 type = HOLLOW_BOX_CURSOR;
27505
27506 return type;
27507 }
27508
27509 /* Set the default cursor types for specified frame. */
27510 void
27511 set_frame_cursor_types (struct frame *f, Lisp_Object arg)
27512 {
27513 int width = 1;
27514 Lisp_Object tem;
27515
27516 FRAME_DESIRED_CURSOR (f) = get_specified_cursor_type (arg, &width);
27517 FRAME_CURSOR_WIDTH (f) = width;
27518
27519 /* By default, set up the blink-off state depending on the on-state. */
27520
27521 tem = Fassoc (arg, Vblink_cursor_alist);
27522 if (!NILP (tem))
27523 {
27524 FRAME_BLINK_OFF_CURSOR (f)
27525 = get_specified_cursor_type (XCDR (tem), &width);
27526 FRAME_BLINK_OFF_CURSOR_WIDTH (f) = width;
27527 }
27528 else
27529 FRAME_BLINK_OFF_CURSOR (f) = DEFAULT_CURSOR;
27530
27531 /* Make sure the cursor gets redrawn. */
27532 f->cursor_type_changed = true;
27533 }
27534
27535
27536 #ifdef HAVE_WINDOW_SYSTEM
27537
27538 /* Return the cursor we want to be displayed in window W. Return
27539 width of bar/hbar cursor through WIDTH arg. Return with
27540 ACTIVE_CURSOR arg set to true if cursor in window W is `active'
27541 (i.e. if the `system caret' should track this cursor).
27542
27543 In a mini-buffer window, we want the cursor only to appear if we
27544 are reading input from this window. For the selected window, we
27545 want the cursor type given by the frame parameter or buffer local
27546 setting of cursor-type. If explicitly marked off, draw no cursor.
27547 In all other cases, we want a hollow box cursor. */
27548
27549 static enum text_cursor_kinds
27550 get_window_cursor_type (struct window *w, struct glyph *glyph, int *width,
27551 bool *active_cursor)
27552 {
27553 struct frame *f = XFRAME (w->frame);
27554 struct buffer *b = XBUFFER (w->contents);
27555 int cursor_type = DEFAULT_CURSOR;
27556 Lisp_Object alt_cursor;
27557 bool non_selected = false;
27558
27559 *active_cursor = true;
27560
27561 /* Echo area */
27562 if (cursor_in_echo_area
27563 && FRAME_HAS_MINIBUF_P (f)
27564 && EQ (FRAME_MINIBUF_WINDOW (f), echo_area_window))
27565 {
27566 if (w == XWINDOW (echo_area_window))
27567 {
27568 if (EQ (BVAR (b, cursor_type), Qt) || NILP (BVAR (b, cursor_type)))
27569 {
27570 *width = FRAME_CURSOR_WIDTH (f);
27571 return FRAME_DESIRED_CURSOR (f);
27572 }
27573 else
27574 return get_specified_cursor_type (BVAR (b, cursor_type), width);
27575 }
27576
27577 *active_cursor = false;
27578 non_selected = true;
27579 }
27580
27581 /* Detect a nonselected window or nonselected frame. */
27582 else if (w != XWINDOW (f->selected_window)
27583 || f != FRAME_DISPLAY_INFO (f)->x_highlight_frame)
27584 {
27585 *active_cursor = false;
27586
27587 if (MINI_WINDOW_P (w) && minibuf_level == 0)
27588 return NO_CURSOR;
27589
27590 non_selected = true;
27591 }
27592
27593 /* Never display a cursor in a window in which cursor-type is nil. */
27594 if (NILP (BVAR (b, cursor_type)))
27595 return NO_CURSOR;
27596
27597 /* Get the normal cursor type for this window. */
27598 if (EQ (BVAR (b, cursor_type), Qt))
27599 {
27600 cursor_type = FRAME_DESIRED_CURSOR (f);
27601 *width = FRAME_CURSOR_WIDTH (f);
27602 }
27603 else
27604 cursor_type = get_specified_cursor_type (BVAR (b, cursor_type), width);
27605
27606 /* Use cursor-in-non-selected-windows instead
27607 for non-selected window or frame. */
27608 if (non_selected)
27609 {
27610 alt_cursor = BVAR (b, cursor_in_non_selected_windows);
27611 if (!EQ (Qt, alt_cursor))
27612 return get_specified_cursor_type (alt_cursor, width);
27613 /* t means modify the normal cursor type. */
27614 if (cursor_type == FILLED_BOX_CURSOR)
27615 cursor_type = HOLLOW_BOX_CURSOR;
27616 else if (cursor_type == BAR_CURSOR && *width > 1)
27617 --*width;
27618 return cursor_type;
27619 }
27620
27621 /* Use normal cursor if not blinked off. */
27622 if (!w->cursor_off_p)
27623 {
27624 if (glyph != NULL && glyph->type == IMAGE_GLYPH)
27625 {
27626 if (cursor_type == FILLED_BOX_CURSOR)
27627 {
27628 /* Using a block cursor on large images can be very annoying.
27629 So use a hollow cursor for "large" images.
27630 If image is not transparent (no mask), also use hollow cursor. */
27631 struct image *img = IMAGE_FROM_ID (f, glyph->u.img_id);
27632 if (img != NULL && IMAGEP (img->spec))
27633 {
27634 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27635 where N = size of default frame font size.
27636 This should cover most of the "tiny" icons people may use. */
27637 if (!img->mask
27638 || img->width > max (32, WINDOW_FRAME_COLUMN_WIDTH (w))
27639 || img->height > max (32, WINDOW_FRAME_LINE_HEIGHT (w)))
27640 cursor_type = HOLLOW_BOX_CURSOR;
27641 }
27642 }
27643 else if (cursor_type != NO_CURSOR)
27644 {
27645 /* Display current only supports BOX and HOLLOW cursors for images.
27646 So for now, unconditionally use a HOLLOW cursor when cursor is
27647 not a solid box cursor. */
27648 cursor_type = HOLLOW_BOX_CURSOR;
27649 }
27650 }
27651 return cursor_type;
27652 }
27653
27654 /* Cursor is blinked off, so determine how to "toggle" it. */
27655
27656 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27657 if ((alt_cursor = Fassoc (BVAR (b, cursor_type), Vblink_cursor_alist), !NILP (alt_cursor)))
27658 return get_specified_cursor_type (XCDR (alt_cursor), width);
27659
27660 /* Then see if frame has specified a specific blink off cursor type. */
27661 if (FRAME_BLINK_OFF_CURSOR (f) != DEFAULT_CURSOR)
27662 {
27663 *width = FRAME_BLINK_OFF_CURSOR_WIDTH (f);
27664 return FRAME_BLINK_OFF_CURSOR (f);
27665 }
27666
27667 #if false
27668 /* Some people liked having a permanently visible blinking cursor,
27669 while others had very strong opinions against it. So it was
27670 decided to remove it. KFS 2003-09-03 */
27671
27672 /* Finally perform built-in cursor blinking:
27673 filled box <-> hollow box
27674 wide [h]bar <-> narrow [h]bar
27675 narrow [h]bar <-> no cursor
27676 other type <-> no cursor */
27677
27678 if (cursor_type == FILLED_BOX_CURSOR)
27679 return HOLLOW_BOX_CURSOR;
27680
27681 if ((cursor_type == BAR_CURSOR || cursor_type == HBAR_CURSOR) && *width > 1)
27682 {
27683 *width = 1;
27684 return cursor_type;
27685 }
27686 #endif
27687
27688 return NO_CURSOR;
27689 }
27690
27691
27692 /* Notice when the text cursor of window W has been completely
27693 overwritten by a drawing operation that outputs glyphs in AREA
27694 starting at X0 and ending at X1 in the line starting at Y0 and
27695 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27696 the rest of the line after X0 has been written. Y coordinates
27697 are window-relative. */
27698
27699 static void
27700 notice_overwritten_cursor (struct window *w, enum glyph_row_area area,
27701 int x0, int x1, int y0, int y1)
27702 {
27703 int cx0, cx1, cy0, cy1;
27704 struct glyph_row *row;
27705
27706 if (!w->phys_cursor_on_p)
27707 return;
27708 if (area != TEXT_AREA)
27709 return;
27710
27711 if (w->phys_cursor.vpos < 0
27712 || w->phys_cursor.vpos >= w->current_matrix->nrows
27713 || (row = w->current_matrix->rows + w->phys_cursor.vpos,
27714 !(row->enabled_p && MATRIX_ROW_DISPLAYS_TEXT_P (row))))
27715 return;
27716
27717 if (row->cursor_in_fringe_p)
27718 {
27719 row->cursor_in_fringe_p = false;
27720 draw_fringe_bitmap (w, row, row->reversed_p);
27721 w->phys_cursor_on_p = false;
27722 return;
27723 }
27724
27725 cx0 = w->phys_cursor.x;
27726 cx1 = cx0 + w->phys_cursor_width;
27727 if (x0 > cx0 || (x1 >= 0 && x1 < cx1))
27728 return;
27729
27730 /* The cursor image will be completely removed from the
27731 screen if the output area intersects the cursor area in
27732 y-direction. When we draw in [y0 y1[, and some part of
27733 the cursor is at y < y0, that part must have been drawn
27734 before. When scrolling, the cursor is erased before
27735 actually scrolling, so we don't come here. When not
27736 scrolling, the rows above the old cursor row must have
27737 changed, and in this case these rows must have written
27738 over the cursor image.
27739
27740 Likewise if part of the cursor is below y1, with the
27741 exception of the cursor being in the first blank row at
27742 the buffer and window end because update_text_area
27743 doesn't draw that row. (Except when it does, but
27744 that's handled in update_text_area.) */
27745
27746 cy0 = w->phys_cursor.y;
27747 cy1 = cy0 + w->phys_cursor_height;
27748 if ((y0 < cy0 || y0 >= cy1) && (y1 <= cy0 || y1 >= cy1))
27749 return;
27750
27751 w->phys_cursor_on_p = false;
27752 }
27753
27754 #endif /* HAVE_WINDOW_SYSTEM */
27755
27756 \f
27757 /************************************************************************
27758 Mouse Face
27759 ************************************************************************/
27760
27761 #ifdef HAVE_WINDOW_SYSTEM
27762
27763 /* EXPORT for RIF:
27764 Fix the display of area AREA of overlapping row ROW in window W
27765 with respect to the overlapping part OVERLAPS. */
27766
27767 void
27768 x_fix_overlapping_area (struct window *w, struct glyph_row *row,
27769 enum glyph_row_area area, int overlaps)
27770 {
27771 int i, x;
27772
27773 block_input ();
27774
27775 x = 0;
27776 for (i = 0; i < row->used[area];)
27777 {
27778 if (row->glyphs[area][i].overlaps_vertically_p)
27779 {
27780 int start = i, start_x = x;
27781
27782 do
27783 {
27784 x += row->glyphs[area][i].pixel_width;
27785 ++i;
27786 }
27787 while (i < row->used[area]
27788 && row->glyphs[area][i].overlaps_vertically_p);
27789
27790 draw_glyphs (w, start_x, row, area,
27791 start, i,
27792 DRAW_NORMAL_TEXT, overlaps);
27793 }
27794 else
27795 {
27796 x += row->glyphs[area][i].pixel_width;
27797 ++i;
27798 }
27799 }
27800
27801 unblock_input ();
27802 }
27803
27804
27805 /* EXPORT:
27806 Draw the cursor glyph of window W in glyph row ROW. See the
27807 comment of draw_glyphs for the meaning of HL. */
27808
27809 void
27810 draw_phys_cursor_glyph (struct window *w, struct glyph_row *row,
27811 enum draw_glyphs_face hl)
27812 {
27813 /* If cursor hpos is out of bounds, don't draw garbage. This can
27814 happen in mini-buffer windows when switching between echo area
27815 glyphs and mini-buffer. */
27816 if ((row->reversed_p
27817 ? (w->phys_cursor.hpos >= 0)
27818 : (w->phys_cursor.hpos < row->used[TEXT_AREA])))
27819 {
27820 bool on_p = w->phys_cursor_on_p;
27821 int x1;
27822 int hpos = w->phys_cursor.hpos;
27823
27824 /* When the window is hscrolled, cursor hpos can legitimately be
27825 out of bounds, but we draw the cursor at the corresponding
27826 window margin in that case. */
27827 if (!row->reversed_p && hpos < 0)
27828 hpos = 0;
27829 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
27830 hpos = row->used[TEXT_AREA] - 1;
27831
27832 x1 = draw_glyphs (w, w->phys_cursor.x, row, TEXT_AREA, hpos, hpos + 1,
27833 hl, 0);
27834 w->phys_cursor_on_p = on_p;
27835
27836 if (hl == DRAW_CURSOR)
27837 w->phys_cursor_width = x1 - w->phys_cursor.x;
27838 /* When we erase the cursor, and ROW is overlapped by other
27839 rows, make sure that these overlapping parts of other rows
27840 are redrawn. */
27841 else if (hl == DRAW_NORMAL_TEXT && row->overlapped_p)
27842 {
27843 w->phys_cursor_width = x1 - w->phys_cursor.x;
27844
27845 if (row > w->current_matrix->rows
27846 && MATRIX_ROW_OVERLAPS_SUCC_P (row - 1))
27847 x_fix_overlapping_area (w, row - 1, TEXT_AREA,
27848 OVERLAPS_ERASED_CURSOR);
27849
27850 if (MATRIX_ROW_BOTTOM_Y (row) < window_text_bottom_y (w)
27851 && MATRIX_ROW_OVERLAPS_PRED_P (row + 1))
27852 x_fix_overlapping_area (w, row + 1, TEXT_AREA,
27853 OVERLAPS_ERASED_CURSOR);
27854 }
27855 }
27856 }
27857
27858
27859 /* Erase the image of a cursor of window W from the screen. */
27860
27861 void
27862 erase_phys_cursor (struct window *w)
27863 {
27864 struct frame *f = XFRAME (w->frame);
27865 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
27866 int hpos = w->phys_cursor.hpos;
27867 int vpos = w->phys_cursor.vpos;
27868 bool mouse_face_here_p = false;
27869 struct glyph_matrix *active_glyphs = w->current_matrix;
27870 struct glyph_row *cursor_row;
27871 struct glyph *cursor_glyph;
27872 enum draw_glyphs_face hl;
27873
27874 /* No cursor displayed or row invalidated => nothing to do on the
27875 screen. */
27876 if (w->phys_cursor_type == NO_CURSOR)
27877 goto mark_cursor_off;
27878
27879 /* VPOS >= active_glyphs->nrows means that window has been resized.
27880 Don't bother to erase the cursor. */
27881 if (vpos >= active_glyphs->nrows)
27882 goto mark_cursor_off;
27883
27884 /* If row containing cursor is marked invalid, there is nothing we
27885 can do. */
27886 cursor_row = MATRIX_ROW (active_glyphs, vpos);
27887 if (!cursor_row->enabled_p)
27888 goto mark_cursor_off;
27889
27890 /* If line spacing is > 0, old cursor may only be partially visible in
27891 window after split-window. So adjust visible height. */
27892 cursor_row->visible_height = min (cursor_row->visible_height,
27893 window_text_bottom_y (w) - cursor_row->y);
27894
27895 /* If row is completely invisible, don't attempt to delete a cursor which
27896 isn't there. This can happen if cursor is at top of a window, and
27897 we switch to a buffer with a header line in that window. */
27898 if (cursor_row->visible_height <= 0)
27899 goto mark_cursor_off;
27900
27901 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27902 if (cursor_row->cursor_in_fringe_p)
27903 {
27904 cursor_row->cursor_in_fringe_p = false;
27905 draw_fringe_bitmap (w, cursor_row, cursor_row->reversed_p);
27906 goto mark_cursor_off;
27907 }
27908
27909 /* This can happen when the new row is shorter than the old one.
27910 In this case, either draw_glyphs or clear_end_of_line
27911 should have cleared the cursor. Note that we wouldn't be
27912 able to erase the cursor in this case because we don't have a
27913 cursor glyph at hand. */
27914 if ((cursor_row->reversed_p
27915 ? (w->phys_cursor.hpos < 0)
27916 : (w->phys_cursor.hpos >= cursor_row->used[TEXT_AREA])))
27917 goto mark_cursor_off;
27918
27919 /* When the window is hscrolled, cursor hpos can legitimately be out
27920 of bounds, but we draw the cursor at the corresponding window
27921 margin in that case. */
27922 if (!cursor_row->reversed_p && hpos < 0)
27923 hpos = 0;
27924 if (cursor_row->reversed_p && hpos >= cursor_row->used[TEXT_AREA])
27925 hpos = cursor_row->used[TEXT_AREA] - 1;
27926
27927 /* If the cursor is in the mouse face area, redisplay that when
27928 we clear the cursor. */
27929 if (! NILP (hlinfo->mouse_face_window)
27930 && coords_in_mouse_face_p (w, hpos, vpos)
27931 /* Don't redraw the cursor's spot in mouse face if it is at the
27932 end of a line (on a newline). The cursor appears there, but
27933 mouse highlighting does not. */
27934 && cursor_row->used[TEXT_AREA] > hpos && hpos >= 0)
27935 mouse_face_here_p = true;
27936
27937 /* Maybe clear the display under the cursor. */
27938 if (w->phys_cursor_type == HOLLOW_BOX_CURSOR)
27939 {
27940 int x, y;
27941 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
27942 int width;
27943
27944 cursor_glyph = get_phys_cursor_glyph (w);
27945 if (cursor_glyph == NULL)
27946 goto mark_cursor_off;
27947
27948 width = cursor_glyph->pixel_width;
27949 x = w->phys_cursor.x;
27950 if (x < 0)
27951 {
27952 width += x;
27953 x = 0;
27954 }
27955 width = min (width, window_box_width (w, TEXT_AREA) - x);
27956 y = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height, cursor_row->y));
27957 x = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, x);
27958
27959 if (width > 0)
27960 FRAME_RIF (f)->clear_frame_area (f, x, y, width, cursor_row->visible_height);
27961 }
27962
27963 /* Erase the cursor by redrawing the character underneath it. */
27964 if (mouse_face_here_p)
27965 hl = DRAW_MOUSE_FACE;
27966 else
27967 hl = DRAW_NORMAL_TEXT;
27968 draw_phys_cursor_glyph (w, cursor_row, hl);
27969
27970 mark_cursor_off:
27971 w->phys_cursor_on_p = false;
27972 w->phys_cursor_type = NO_CURSOR;
27973 }
27974
27975
27976 /* Display or clear cursor of window W. If !ON, clear the cursor.
27977 If ON, display the cursor; where to put the cursor is specified by
27978 HPOS, VPOS, X and Y. */
27979
27980 void
27981 display_and_set_cursor (struct window *w, bool on,
27982 int hpos, int vpos, int x, int y)
27983 {
27984 struct frame *f = XFRAME (w->frame);
27985 int new_cursor_type;
27986 int new_cursor_width;
27987 bool active_cursor;
27988 struct glyph_row *glyph_row;
27989 struct glyph *glyph;
27990
27991 /* This is pointless on invisible frames, and dangerous on garbaged
27992 windows and frames; in the latter case, the frame or window may
27993 be in the midst of changing its size, and x and y may be off the
27994 window. */
27995 if (! FRAME_VISIBLE_P (f)
27996 || FRAME_GARBAGED_P (f)
27997 || vpos >= w->current_matrix->nrows
27998 || hpos >= w->current_matrix->matrix_w)
27999 return;
28000
28001 /* If cursor is off and we want it off, return quickly. */
28002 if (!on && !w->phys_cursor_on_p)
28003 return;
28004
28005 glyph_row = MATRIX_ROW (w->current_matrix, vpos);
28006 /* If cursor row is not enabled, we don't really know where to
28007 display the cursor. */
28008 if (!glyph_row->enabled_p)
28009 {
28010 w->phys_cursor_on_p = false;
28011 return;
28012 }
28013
28014 glyph = NULL;
28015 if (!glyph_row->exact_window_width_line_p
28016 || (0 <= hpos && hpos < glyph_row->used[TEXT_AREA]))
28017 glyph = glyph_row->glyphs[TEXT_AREA] + hpos;
28018
28019 eassert (input_blocked_p ());
28020
28021 /* Set new_cursor_type to the cursor we want to be displayed. */
28022 new_cursor_type = get_window_cursor_type (w, glyph,
28023 &new_cursor_width, &active_cursor);
28024
28025 /* If cursor is currently being shown and we don't want it to be or
28026 it is in the wrong place, or the cursor type is not what we want,
28027 erase it. */
28028 if (w->phys_cursor_on_p
28029 && (!on
28030 || w->phys_cursor.x != x
28031 || w->phys_cursor.y != y
28032 /* HPOS can be negative in R2L rows whose
28033 exact_window_width_line_p flag is set (i.e. their newline
28034 would "overflow into the fringe"). */
28035 || hpos < 0
28036 || new_cursor_type != w->phys_cursor_type
28037 || ((new_cursor_type == BAR_CURSOR || new_cursor_type == HBAR_CURSOR)
28038 && new_cursor_width != w->phys_cursor_width)))
28039 erase_phys_cursor (w);
28040
28041 /* Don't check phys_cursor_on_p here because that flag is only set
28042 to false in some cases where we know that the cursor has been
28043 completely erased, to avoid the extra work of erasing the cursor
28044 twice. In other words, phys_cursor_on_p can be true and the cursor
28045 still not be visible, or it has only been partly erased. */
28046 if (on)
28047 {
28048 w->phys_cursor_ascent = glyph_row->ascent;
28049 w->phys_cursor_height = glyph_row->height;
28050
28051 /* Set phys_cursor_.* before x_draw_.* is called because some
28052 of them may need the information. */
28053 w->phys_cursor.x = x;
28054 w->phys_cursor.y = glyph_row->y;
28055 w->phys_cursor.hpos = hpos;
28056 w->phys_cursor.vpos = vpos;
28057 }
28058
28059 FRAME_RIF (f)->draw_window_cursor (w, glyph_row, x, y,
28060 new_cursor_type, new_cursor_width,
28061 on, active_cursor);
28062 }
28063
28064
28065 /* Switch the display of W's cursor on or off, according to the value
28066 of ON. */
28067
28068 static void
28069 update_window_cursor (struct window *w, bool on)
28070 {
28071 /* Don't update cursor in windows whose frame is in the process
28072 of being deleted. */
28073 if (w->current_matrix)
28074 {
28075 int hpos = w->phys_cursor.hpos;
28076 int vpos = w->phys_cursor.vpos;
28077 struct glyph_row *row;
28078
28079 if (vpos >= w->current_matrix->nrows
28080 || hpos >= w->current_matrix->matrix_w)
28081 return;
28082
28083 row = MATRIX_ROW (w->current_matrix, vpos);
28084
28085 /* When the window is hscrolled, cursor hpos can legitimately be
28086 out of bounds, but we draw the cursor at the corresponding
28087 window margin in that case. */
28088 if (!row->reversed_p && hpos < 0)
28089 hpos = 0;
28090 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
28091 hpos = row->used[TEXT_AREA] - 1;
28092
28093 block_input ();
28094 display_and_set_cursor (w, on, hpos, vpos,
28095 w->phys_cursor.x, w->phys_cursor.y);
28096 unblock_input ();
28097 }
28098 }
28099
28100
28101 /* Call update_window_cursor with parameter ON_P on all leaf windows
28102 in the window tree rooted at W. */
28103
28104 static void
28105 update_cursor_in_window_tree (struct window *w, bool on_p)
28106 {
28107 while (w)
28108 {
28109 if (WINDOWP (w->contents))
28110 update_cursor_in_window_tree (XWINDOW (w->contents), on_p);
28111 else
28112 update_window_cursor (w, on_p);
28113
28114 w = NILP (w->next) ? 0 : XWINDOW (w->next);
28115 }
28116 }
28117
28118
28119 /* EXPORT:
28120 Display the cursor on window W, or clear it, according to ON_P.
28121 Don't change the cursor's position. */
28122
28123 void
28124 x_update_cursor (struct frame *f, bool on_p)
28125 {
28126 update_cursor_in_window_tree (XWINDOW (f->root_window), on_p);
28127 }
28128
28129
28130 /* EXPORT:
28131 Clear the cursor of window W to background color, and mark the
28132 cursor as not shown. This is used when the text where the cursor
28133 is about to be rewritten. */
28134
28135 void
28136 x_clear_cursor (struct window *w)
28137 {
28138 if (FRAME_VISIBLE_P (XFRAME (w->frame)) && w->phys_cursor_on_p)
28139 update_window_cursor (w, false);
28140 }
28141
28142 #endif /* HAVE_WINDOW_SYSTEM */
28143
28144 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28145 and MSDOS. */
28146 static void
28147 draw_row_with_mouse_face (struct window *w, int start_x, struct glyph_row *row,
28148 int start_hpos, int end_hpos,
28149 enum draw_glyphs_face draw)
28150 {
28151 #ifdef HAVE_WINDOW_SYSTEM
28152 if (FRAME_WINDOW_P (XFRAME (w->frame)))
28153 {
28154 draw_glyphs (w, start_x, row, TEXT_AREA, start_hpos, end_hpos, draw, 0);
28155 return;
28156 }
28157 #endif
28158 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28159 tty_draw_row_with_mouse_face (w, row, start_hpos, end_hpos, draw);
28160 #endif
28161 }
28162
28163 /* Display the active region described by mouse_face_* according to DRAW. */
28164
28165 static void
28166 show_mouse_face (Mouse_HLInfo *hlinfo, enum draw_glyphs_face draw)
28167 {
28168 struct window *w = XWINDOW (hlinfo->mouse_face_window);
28169 struct frame *f = XFRAME (WINDOW_FRAME (w));
28170
28171 if (/* If window is in the process of being destroyed, don't bother
28172 to do anything. */
28173 w->current_matrix != NULL
28174 /* Don't update mouse highlight if hidden. */
28175 && (draw != DRAW_MOUSE_FACE || !hlinfo->mouse_face_hidden)
28176 /* Recognize when we are called to operate on rows that don't exist
28177 anymore. This can happen when a window is split. */
28178 && hlinfo->mouse_face_end_row < w->current_matrix->nrows)
28179 {
28180 bool phys_cursor_on_p = w->phys_cursor_on_p;
28181 struct glyph_row *row, *first, *last;
28182
28183 first = MATRIX_ROW (w->current_matrix, hlinfo->mouse_face_beg_row);
28184 last = MATRIX_ROW (w->current_matrix, hlinfo->mouse_face_end_row);
28185
28186 for (row = first; row <= last && row->enabled_p; ++row)
28187 {
28188 int start_hpos, end_hpos, start_x;
28189
28190 /* For all but the first row, the highlight starts at column 0. */
28191 if (row == first)
28192 {
28193 /* R2L rows have BEG and END in reversed order, but the
28194 screen drawing geometry is always left to right. So
28195 we need to mirror the beginning and end of the
28196 highlighted area in R2L rows. */
28197 if (!row->reversed_p)
28198 {
28199 start_hpos = hlinfo->mouse_face_beg_col;
28200 start_x = hlinfo->mouse_face_beg_x;
28201 }
28202 else if (row == last)
28203 {
28204 start_hpos = hlinfo->mouse_face_end_col;
28205 start_x = hlinfo->mouse_face_end_x;
28206 }
28207 else
28208 {
28209 start_hpos = 0;
28210 start_x = 0;
28211 }
28212 }
28213 else if (row->reversed_p && row == last)
28214 {
28215 start_hpos = hlinfo->mouse_face_end_col;
28216 start_x = hlinfo->mouse_face_end_x;
28217 }
28218 else
28219 {
28220 start_hpos = 0;
28221 start_x = 0;
28222 }
28223
28224 if (row == last)
28225 {
28226 if (!row->reversed_p)
28227 end_hpos = hlinfo->mouse_face_end_col;
28228 else if (row == first)
28229 end_hpos = hlinfo->mouse_face_beg_col;
28230 else
28231 {
28232 end_hpos = row->used[TEXT_AREA];
28233 if (draw == DRAW_NORMAL_TEXT)
28234 row->fill_line_p = true; /* Clear to end of line. */
28235 }
28236 }
28237 else if (row->reversed_p && row == first)
28238 end_hpos = hlinfo->mouse_face_beg_col;
28239 else
28240 {
28241 end_hpos = row->used[TEXT_AREA];
28242 if (draw == DRAW_NORMAL_TEXT)
28243 row->fill_line_p = true; /* Clear to end of line. */
28244 }
28245
28246 if (end_hpos > start_hpos)
28247 {
28248 draw_row_with_mouse_face (w, start_x, row,
28249 start_hpos, end_hpos, draw);
28250
28251 row->mouse_face_p
28252 = draw == DRAW_MOUSE_FACE || draw == DRAW_IMAGE_RAISED;
28253 }
28254 }
28255
28256 #ifdef HAVE_WINDOW_SYSTEM
28257 /* When we've written over the cursor, arrange for it to
28258 be displayed again. */
28259 if (FRAME_WINDOW_P (f)
28260 && phys_cursor_on_p && !w->phys_cursor_on_p)
28261 {
28262 int hpos = w->phys_cursor.hpos;
28263
28264 /* When the window is hscrolled, cursor hpos can legitimately be
28265 out of bounds, but we draw the cursor at the corresponding
28266 window margin in that case. */
28267 if (!row->reversed_p && hpos < 0)
28268 hpos = 0;
28269 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
28270 hpos = row->used[TEXT_AREA] - 1;
28271
28272 block_input ();
28273 display_and_set_cursor (w, true, hpos, w->phys_cursor.vpos,
28274 w->phys_cursor.x, w->phys_cursor.y);
28275 unblock_input ();
28276 }
28277 #endif /* HAVE_WINDOW_SYSTEM */
28278 }
28279
28280 #ifdef HAVE_WINDOW_SYSTEM
28281 /* Change the mouse cursor. */
28282 if (FRAME_WINDOW_P (f) && NILP (do_mouse_tracking))
28283 {
28284 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28285 if (draw == DRAW_NORMAL_TEXT
28286 && !EQ (hlinfo->mouse_face_window, f->tool_bar_window))
28287 FRAME_RIF (f)->define_frame_cursor (f, FRAME_X_OUTPUT (f)->text_cursor);
28288 else
28289 #endif
28290 if (draw == DRAW_MOUSE_FACE)
28291 FRAME_RIF (f)->define_frame_cursor (f, FRAME_X_OUTPUT (f)->hand_cursor);
28292 else
28293 FRAME_RIF (f)->define_frame_cursor (f, FRAME_X_OUTPUT (f)->nontext_cursor);
28294 }
28295 #endif /* HAVE_WINDOW_SYSTEM */
28296 }
28297
28298 /* EXPORT:
28299 Clear out the mouse-highlighted active region.
28300 Redraw it un-highlighted first. Value is true if mouse
28301 face was actually drawn unhighlighted. */
28302
28303 bool
28304 clear_mouse_face (Mouse_HLInfo *hlinfo)
28305 {
28306 bool cleared
28307 = !hlinfo->mouse_face_hidden && !NILP (hlinfo->mouse_face_window);
28308 if (cleared)
28309 show_mouse_face (hlinfo, DRAW_NORMAL_TEXT);
28310 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
28311 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
28312 hlinfo->mouse_face_window = Qnil;
28313 hlinfo->mouse_face_overlay = Qnil;
28314 return cleared;
28315 }
28316
28317 /* Return true if the coordinates HPOS and VPOS on windows W are
28318 within the mouse face on that window. */
28319 static bool
28320 coords_in_mouse_face_p (struct window *w, int hpos, int vpos)
28321 {
28322 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
28323
28324 /* Quickly resolve the easy cases. */
28325 if (!(WINDOWP (hlinfo->mouse_face_window)
28326 && XWINDOW (hlinfo->mouse_face_window) == w))
28327 return false;
28328 if (vpos < hlinfo->mouse_face_beg_row
28329 || vpos > hlinfo->mouse_face_end_row)
28330 return false;
28331 if (vpos > hlinfo->mouse_face_beg_row
28332 && vpos < hlinfo->mouse_face_end_row)
28333 return true;
28334
28335 if (!MATRIX_ROW (w->current_matrix, vpos)->reversed_p)
28336 {
28337 if (hlinfo->mouse_face_beg_row == hlinfo->mouse_face_end_row)
28338 {
28339 if (hlinfo->mouse_face_beg_col <= hpos && hpos < hlinfo->mouse_face_end_col)
28340 return true;
28341 }
28342 else if ((vpos == hlinfo->mouse_face_beg_row
28343 && hpos >= hlinfo->mouse_face_beg_col)
28344 || (vpos == hlinfo->mouse_face_end_row
28345 && hpos < hlinfo->mouse_face_end_col))
28346 return true;
28347 }
28348 else
28349 {
28350 if (hlinfo->mouse_face_beg_row == hlinfo->mouse_face_end_row)
28351 {
28352 if (hlinfo->mouse_face_end_col < hpos && hpos <= hlinfo->mouse_face_beg_col)
28353 return true;
28354 }
28355 else if ((vpos == hlinfo->mouse_face_beg_row
28356 && hpos <= hlinfo->mouse_face_beg_col)
28357 || (vpos == hlinfo->mouse_face_end_row
28358 && hpos > hlinfo->mouse_face_end_col))
28359 return true;
28360 }
28361 return false;
28362 }
28363
28364
28365 /* EXPORT:
28366 True if physical cursor of window W is within mouse face. */
28367
28368 bool
28369 cursor_in_mouse_face_p (struct window *w)
28370 {
28371 int hpos = w->phys_cursor.hpos;
28372 int vpos = w->phys_cursor.vpos;
28373 struct glyph_row *row = MATRIX_ROW (w->current_matrix, vpos);
28374
28375 /* When the window is hscrolled, cursor hpos can legitimately be out
28376 of bounds, but we draw the cursor at the corresponding window
28377 margin in that case. */
28378 if (!row->reversed_p && hpos < 0)
28379 hpos = 0;
28380 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
28381 hpos = row->used[TEXT_AREA] - 1;
28382
28383 return coords_in_mouse_face_p (w, hpos, vpos);
28384 }
28385
28386
28387 \f
28388 /* Find the glyph rows START_ROW and END_ROW of window W that display
28389 characters between buffer positions START_CHARPOS and END_CHARPOS
28390 (excluding END_CHARPOS). DISP_STRING is a display string that
28391 covers these buffer positions. This is similar to
28392 row_containing_pos, but is more accurate when bidi reordering makes
28393 buffer positions change non-linearly with glyph rows. */
28394 static void
28395 rows_from_pos_range (struct window *w,
28396 ptrdiff_t start_charpos, ptrdiff_t end_charpos,
28397 Lisp_Object disp_string,
28398 struct glyph_row **start, struct glyph_row **end)
28399 {
28400 struct glyph_row *first = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
28401 int last_y = window_text_bottom_y (w);
28402 struct glyph_row *row;
28403
28404 *start = NULL;
28405 *end = NULL;
28406
28407 while (!first->enabled_p
28408 && first < MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w))
28409 first++;
28410
28411 /* Find the START row. */
28412 for (row = first;
28413 row->enabled_p && MATRIX_ROW_BOTTOM_Y (row) <= last_y;
28414 row++)
28415 {
28416 /* A row can potentially be the START row if the range of the
28417 characters it displays intersects the range
28418 [START_CHARPOS..END_CHARPOS). */
28419 if (! ((start_charpos < MATRIX_ROW_START_CHARPOS (row)
28420 && end_charpos < MATRIX_ROW_START_CHARPOS (row))
28421 /* See the commentary in row_containing_pos, for the
28422 explanation of the complicated way to check whether
28423 some position is beyond the end of the characters
28424 displayed by a row. */
28425 || ((start_charpos > MATRIX_ROW_END_CHARPOS (row)
28426 || (start_charpos == MATRIX_ROW_END_CHARPOS (row)
28427 && !row->ends_at_zv_p
28428 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row)))
28429 && (end_charpos > MATRIX_ROW_END_CHARPOS (row)
28430 || (end_charpos == MATRIX_ROW_END_CHARPOS (row)
28431 && !row->ends_at_zv_p
28432 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row))))))
28433 {
28434 /* Found a candidate row. Now make sure at least one of the
28435 glyphs it displays has a charpos from the range
28436 [START_CHARPOS..END_CHARPOS).
28437
28438 This is not obvious because bidi reordering could make
28439 buffer positions of a row be 1,2,3,102,101,100, and if we
28440 want to highlight characters in [50..60), we don't want
28441 this row, even though [50..60) does intersect [1..103),
28442 the range of character positions given by the row's start
28443 and end positions. */
28444 struct glyph *g = row->glyphs[TEXT_AREA];
28445 struct glyph *e = g + row->used[TEXT_AREA];
28446
28447 while (g < e)
28448 {
28449 if (((BUFFERP (g->object) || NILP (g->object))
28450 && start_charpos <= g->charpos && g->charpos < end_charpos)
28451 /* A glyph that comes from DISP_STRING is by
28452 definition to be highlighted. */
28453 || EQ (g->object, disp_string))
28454 *start = row;
28455 g++;
28456 }
28457 if (*start)
28458 break;
28459 }
28460 }
28461
28462 /* Find the END row. */
28463 if (!*start
28464 /* If the last row is partially visible, start looking for END
28465 from that row, instead of starting from FIRST. */
28466 && !(row->enabled_p
28467 && row->y < last_y && MATRIX_ROW_BOTTOM_Y (row) > last_y))
28468 row = first;
28469 for ( ; row->enabled_p && MATRIX_ROW_BOTTOM_Y (row) <= last_y; row++)
28470 {
28471 struct glyph_row *next = row + 1;
28472 ptrdiff_t next_start = MATRIX_ROW_START_CHARPOS (next);
28473
28474 if (!next->enabled_p
28475 || next >= MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w)
28476 /* The first row >= START whose range of displayed characters
28477 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28478 is the row END + 1. */
28479 || (start_charpos < next_start
28480 && end_charpos < next_start)
28481 || ((start_charpos > MATRIX_ROW_END_CHARPOS (next)
28482 || (start_charpos == MATRIX_ROW_END_CHARPOS (next)
28483 && !next->ends_at_zv_p
28484 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next)))
28485 && (end_charpos > MATRIX_ROW_END_CHARPOS (next)
28486 || (end_charpos == MATRIX_ROW_END_CHARPOS (next)
28487 && !next->ends_at_zv_p
28488 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next)))))
28489 {
28490 *end = row;
28491 break;
28492 }
28493 else
28494 {
28495 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28496 but none of the characters it displays are in the range, it is
28497 also END + 1. */
28498 struct glyph *g = next->glyphs[TEXT_AREA];
28499 struct glyph *s = g;
28500 struct glyph *e = g + next->used[TEXT_AREA];
28501
28502 while (g < e)
28503 {
28504 if (((BUFFERP (g->object) || NILP (g->object))
28505 && ((start_charpos <= g->charpos && g->charpos < end_charpos)
28506 /* If the buffer position of the first glyph in
28507 the row is equal to END_CHARPOS, it means
28508 the last character to be highlighted is the
28509 newline of ROW, and we must consider NEXT as
28510 END, not END+1. */
28511 || (((!next->reversed_p && g == s)
28512 || (next->reversed_p && g == e - 1))
28513 && (g->charpos == end_charpos
28514 /* Special case for when NEXT is an
28515 empty line at ZV. */
28516 || (g->charpos == -1
28517 && !row->ends_at_zv_p
28518 && next_start == end_charpos)))))
28519 /* A glyph that comes from DISP_STRING is by
28520 definition to be highlighted. */
28521 || EQ (g->object, disp_string))
28522 break;
28523 g++;
28524 }
28525 if (g == e)
28526 {
28527 *end = row;
28528 break;
28529 }
28530 /* The first row that ends at ZV must be the last to be
28531 highlighted. */
28532 else if (next->ends_at_zv_p)
28533 {
28534 *end = next;
28535 break;
28536 }
28537 }
28538 }
28539 }
28540
28541 /* This function sets the mouse_face_* elements of HLINFO, assuming
28542 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28543 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28544 for the overlay or run of text properties specifying the mouse
28545 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28546 before-string and after-string that must also be highlighted.
28547 DISP_STRING, if non-nil, is a display string that may cover some
28548 or all of the highlighted text. */
28549
28550 static void
28551 mouse_face_from_buffer_pos (Lisp_Object window,
28552 Mouse_HLInfo *hlinfo,
28553 ptrdiff_t mouse_charpos,
28554 ptrdiff_t start_charpos,
28555 ptrdiff_t end_charpos,
28556 Lisp_Object before_string,
28557 Lisp_Object after_string,
28558 Lisp_Object disp_string)
28559 {
28560 struct window *w = XWINDOW (window);
28561 struct glyph_row *first = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
28562 struct glyph_row *r1, *r2;
28563 struct glyph *glyph, *end;
28564 ptrdiff_t ignore, pos;
28565 int x;
28566
28567 eassert (NILP (disp_string) || STRINGP (disp_string));
28568 eassert (NILP (before_string) || STRINGP (before_string));
28569 eassert (NILP (after_string) || STRINGP (after_string));
28570
28571 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28572 rows_from_pos_range (w, start_charpos, end_charpos, disp_string, &r1, &r2);
28573 if (r1 == NULL)
28574 r1 = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
28575 /* If the before-string or display-string contains newlines,
28576 rows_from_pos_range skips to its last row. Move back. */
28577 if (!NILP (before_string) || !NILP (disp_string))
28578 {
28579 struct glyph_row *prev;
28580 while ((prev = r1 - 1, prev >= first)
28581 && MATRIX_ROW_END_CHARPOS (prev) == start_charpos
28582 && prev->used[TEXT_AREA] > 0)
28583 {
28584 struct glyph *beg = prev->glyphs[TEXT_AREA];
28585 glyph = beg + prev->used[TEXT_AREA];
28586 while (--glyph >= beg && NILP (glyph->object));
28587 if (glyph < beg
28588 || !(EQ (glyph->object, before_string)
28589 || EQ (glyph->object, disp_string)))
28590 break;
28591 r1 = prev;
28592 }
28593 }
28594 if (r2 == NULL)
28595 {
28596 r2 = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
28597 hlinfo->mouse_face_past_end = true;
28598 }
28599 else if (!NILP (after_string))
28600 {
28601 /* If the after-string has newlines, advance to its last row. */
28602 struct glyph_row *next;
28603 struct glyph_row *last
28604 = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
28605
28606 for (next = r2 + 1;
28607 next <= last
28608 && next->used[TEXT_AREA] > 0
28609 && EQ (next->glyphs[TEXT_AREA]->object, after_string);
28610 ++next)
28611 r2 = next;
28612 }
28613 /* The rest of the display engine assumes that mouse_face_beg_row is
28614 either above mouse_face_end_row or identical to it. But with
28615 bidi-reordered continued lines, the row for START_CHARPOS could
28616 be below the row for END_CHARPOS. If so, swap the rows and store
28617 them in correct order. */
28618 if (r1->y > r2->y)
28619 {
28620 struct glyph_row *tem = r2;
28621
28622 r2 = r1;
28623 r1 = tem;
28624 }
28625
28626 hlinfo->mouse_face_beg_row = MATRIX_ROW_VPOS (r1, w->current_matrix);
28627 hlinfo->mouse_face_end_row = MATRIX_ROW_VPOS (r2, w->current_matrix);
28628
28629 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28630 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28631 could be anywhere in the row and in any order. The strategy
28632 below is to find the leftmost and the rightmost glyph that
28633 belongs to either of these 3 strings, or whose position is
28634 between START_CHARPOS and END_CHARPOS, and highlight all the
28635 glyphs between those two. This may cover more than just the text
28636 between START_CHARPOS and END_CHARPOS if the range of characters
28637 strides the bidi level boundary, e.g. if the beginning is in R2L
28638 text while the end is in L2R text or vice versa. */
28639 if (!r1->reversed_p)
28640 {
28641 /* This row is in a left to right paragraph. Scan it left to
28642 right. */
28643 glyph = r1->glyphs[TEXT_AREA];
28644 end = glyph + r1->used[TEXT_AREA];
28645 x = r1->x;
28646
28647 /* Skip truncation glyphs at the start of the glyph row. */
28648 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1))
28649 for (; glyph < end
28650 && NILP (glyph->object)
28651 && glyph->charpos < 0;
28652 ++glyph)
28653 x += glyph->pixel_width;
28654
28655 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28656 or DISP_STRING, and the first glyph from buffer whose
28657 position is between START_CHARPOS and END_CHARPOS. */
28658 for (; glyph < end
28659 && !NILP (glyph->object)
28660 && !EQ (glyph->object, disp_string)
28661 && !(BUFFERP (glyph->object)
28662 && (glyph->charpos >= start_charpos
28663 && glyph->charpos < end_charpos));
28664 ++glyph)
28665 {
28666 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28667 are present at buffer positions between START_CHARPOS and
28668 END_CHARPOS, or if they come from an overlay. */
28669 if (EQ (glyph->object, before_string))
28670 {
28671 pos = string_buffer_position (before_string,
28672 start_charpos);
28673 /* If pos == 0, it means before_string came from an
28674 overlay, not from a buffer position. */
28675 if (!pos || (pos >= start_charpos && pos < end_charpos))
28676 break;
28677 }
28678 else if (EQ (glyph->object, after_string))
28679 {
28680 pos = string_buffer_position (after_string, end_charpos);
28681 if (!pos || (pos >= start_charpos && pos < end_charpos))
28682 break;
28683 }
28684 x += glyph->pixel_width;
28685 }
28686 hlinfo->mouse_face_beg_x = x;
28687 hlinfo->mouse_face_beg_col = glyph - r1->glyphs[TEXT_AREA];
28688 }
28689 else
28690 {
28691 /* This row is in a right to left paragraph. Scan it right to
28692 left. */
28693 struct glyph *g;
28694
28695 end = r1->glyphs[TEXT_AREA] - 1;
28696 glyph = end + r1->used[TEXT_AREA];
28697
28698 /* Skip truncation glyphs at the start of the glyph row. */
28699 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1))
28700 for (; glyph > end
28701 && NILP (glyph->object)
28702 && glyph->charpos < 0;
28703 --glyph)
28704 ;
28705
28706 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28707 or DISP_STRING, and the first glyph from buffer whose
28708 position is between START_CHARPOS and END_CHARPOS. */
28709 for (; glyph > end
28710 && !NILP (glyph->object)
28711 && !EQ (glyph->object, disp_string)
28712 && !(BUFFERP (glyph->object)
28713 && (glyph->charpos >= start_charpos
28714 && glyph->charpos < end_charpos));
28715 --glyph)
28716 {
28717 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28718 are present at buffer positions between START_CHARPOS and
28719 END_CHARPOS, or if they come from an overlay. */
28720 if (EQ (glyph->object, before_string))
28721 {
28722 pos = string_buffer_position (before_string, start_charpos);
28723 /* If pos == 0, it means before_string came from an
28724 overlay, not from a buffer position. */
28725 if (!pos || (pos >= start_charpos && pos < end_charpos))
28726 break;
28727 }
28728 else if (EQ (glyph->object, after_string))
28729 {
28730 pos = string_buffer_position (after_string, end_charpos);
28731 if (!pos || (pos >= start_charpos && pos < end_charpos))
28732 break;
28733 }
28734 }
28735
28736 glyph++; /* first glyph to the right of the highlighted area */
28737 for (g = r1->glyphs[TEXT_AREA], x = r1->x; g < glyph; g++)
28738 x += g->pixel_width;
28739 hlinfo->mouse_face_beg_x = x;
28740 hlinfo->mouse_face_beg_col = glyph - r1->glyphs[TEXT_AREA];
28741 }
28742
28743 /* If the highlight ends in a different row, compute GLYPH and END
28744 for the end row. Otherwise, reuse the values computed above for
28745 the row where the highlight begins. */
28746 if (r2 != r1)
28747 {
28748 if (!r2->reversed_p)
28749 {
28750 glyph = r2->glyphs[TEXT_AREA];
28751 end = glyph + r2->used[TEXT_AREA];
28752 x = r2->x;
28753 }
28754 else
28755 {
28756 end = r2->glyphs[TEXT_AREA] - 1;
28757 glyph = end + r2->used[TEXT_AREA];
28758 }
28759 }
28760
28761 if (!r2->reversed_p)
28762 {
28763 /* Skip truncation and continuation glyphs near the end of the
28764 row, and also blanks and stretch glyphs inserted by
28765 extend_face_to_end_of_line. */
28766 while (end > glyph
28767 && NILP ((end - 1)->object))
28768 --end;
28769 /* Scan the rest of the glyph row from the end, looking for the
28770 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28771 DISP_STRING, or whose position is between START_CHARPOS
28772 and END_CHARPOS */
28773 for (--end;
28774 end > glyph
28775 && !NILP (end->object)
28776 && !EQ (end->object, disp_string)
28777 && !(BUFFERP (end->object)
28778 && (end->charpos >= start_charpos
28779 && end->charpos < end_charpos));
28780 --end)
28781 {
28782 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28783 are present at buffer positions between START_CHARPOS and
28784 END_CHARPOS, or if they come from an overlay. */
28785 if (EQ (end->object, before_string))
28786 {
28787 pos = string_buffer_position (before_string, start_charpos);
28788 if (!pos || (pos >= start_charpos && pos < end_charpos))
28789 break;
28790 }
28791 else if (EQ (end->object, after_string))
28792 {
28793 pos = string_buffer_position (after_string, end_charpos);
28794 if (!pos || (pos >= start_charpos && pos < end_charpos))
28795 break;
28796 }
28797 }
28798 /* Find the X coordinate of the last glyph to be highlighted. */
28799 for (; glyph <= end; ++glyph)
28800 x += glyph->pixel_width;
28801
28802 hlinfo->mouse_face_end_x = x;
28803 hlinfo->mouse_face_end_col = glyph - r2->glyphs[TEXT_AREA];
28804 }
28805 else
28806 {
28807 /* Skip truncation and continuation glyphs near the end of the
28808 row, and also blanks and stretch glyphs inserted by
28809 extend_face_to_end_of_line. */
28810 x = r2->x;
28811 end++;
28812 while (end < glyph
28813 && NILP (end->object))
28814 {
28815 x += end->pixel_width;
28816 ++end;
28817 }
28818 /* Scan the rest of the glyph row from the end, looking for the
28819 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28820 DISP_STRING, or whose position is between START_CHARPOS
28821 and END_CHARPOS */
28822 for ( ;
28823 end < glyph
28824 && !NILP (end->object)
28825 && !EQ (end->object, disp_string)
28826 && !(BUFFERP (end->object)
28827 && (end->charpos >= start_charpos
28828 && end->charpos < end_charpos));
28829 ++end)
28830 {
28831 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28832 are present at buffer positions between START_CHARPOS and
28833 END_CHARPOS, or if they come from an overlay. */
28834 if (EQ (end->object, before_string))
28835 {
28836 pos = string_buffer_position (before_string, start_charpos);
28837 if (!pos || (pos >= start_charpos && pos < end_charpos))
28838 break;
28839 }
28840 else if (EQ (end->object, after_string))
28841 {
28842 pos = string_buffer_position (after_string, end_charpos);
28843 if (!pos || (pos >= start_charpos && pos < end_charpos))
28844 break;
28845 }
28846 x += end->pixel_width;
28847 }
28848 /* If we exited the above loop because we arrived at the last
28849 glyph of the row, and its buffer position is still not in
28850 range, it means the last character in range is the preceding
28851 newline. Bump the end column and x values to get past the
28852 last glyph. */
28853 if (end == glyph
28854 && BUFFERP (end->object)
28855 && (end->charpos < start_charpos
28856 || end->charpos >= end_charpos))
28857 {
28858 x += end->pixel_width;
28859 ++end;
28860 }
28861 hlinfo->mouse_face_end_x = x;
28862 hlinfo->mouse_face_end_col = end - r2->glyphs[TEXT_AREA];
28863 }
28864
28865 hlinfo->mouse_face_window = window;
28866 hlinfo->mouse_face_face_id
28867 = face_at_buffer_position (w, mouse_charpos, &ignore,
28868 mouse_charpos + 1,
28869 !hlinfo->mouse_face_hidden, -1);
28870 show_mouse_face (hlinfo, DRAW_MOUSE_FACE);
28871 }
28872
28873 /* The following function is not used anymore (replaced with
28874 mouse_face_from_string_pos), but I leave it here for the time
28875 being, in case someone would. */
28876
28877 #if false /* not used */
28878
28879 /* Find the position of the glyph for position POS in OBJECT in
28880 window W's current matrix, and return in *X, *Y the pixel
28881 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28882
28883 RIGHT_P means return the position of the right edge of the glyph.
28884 !RIGHT_P means return the left edge position.
28885
28886 If no glyph for POS exists in the matrix, return the position of
28887 the glyph with the next smaller position that is in the matrix, if
28888 RIGHT_P is false. If RIGHT_P, and no glyph for POS
28889 exists in the matrix, return the position of the glyph with the
28890 next larger position in OBJECT.
28891
28892 Value is true if a glyph was found. */
28893
28894 static bool
28895 fast_find_string_pos (struct window *w, ptrdiff_t pos, Lisp_Object object,
28896 int *hpos, int *vpos, int *x, int *y, bool right_p)
28897 {
28898 int yb = window_text_bottom_y (w);
28899 struct glyph_row *r;
28900 struct glyph *best_glyph = NULL;
28901 struct glyph_row *best_row = NULL;
28902 int best_x = 0;
28903
28904 for (r = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
28905 r->enabled_p && r->y < yb;
28906 ++r)
28907 {
28908 struct glyph *g = r->glyphs[TEXT_AREA];
28909 struct glyph *e = g + r->used[TEXT_AREA];
28910 int gx;
28911
28912 for (gx = r->x; g < e; gx += g->pixel_width, ++g)
28913 if (EQ (g->object, object))
28914 {
28915 if (g->charpos == pos)
28916 {
28917 best_glyph = g;
28918 best_x = gx;
28919 best_row = r;
28920 goto found;
28921 }
28922 else if (best_glyph == NULL
28923 || ((eabs (g->charpos - pos)
28924 < eabs (best_glyph->charpos - pos))
28925 && (right_p
28926 ? g->charpos < pos
28927 : g->charpos > pos)))
28928 {
28929 best_glyph = g;
28930 best_x = gx;
28931 best_row = r;
28932 }
28933 }
28934 }
28935
28936 found:
28937
28938 if (best_glyph)
28939 {
28940 *x = best_x;
28941 *hpos = best_glyph - best_row->glyphs[TEXT_AREA];
28942
28943 if (right_p)
28944 {
28945 *x += best_glyph->pixel_width;
28946 ++*hpos;
28947 }
28948
28949 *y = best_row->y;
28950 *vpos = MATRIX_ROW_VPOS (best_row, w->current_matrix);
28951 }
28952
28953 return best_glyph != NULL;
28954 }
28955 #endif /* not used */
28956
28957 /* Find the positions of the first and the last glyphs in window W's
28958 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28959 (assumed to be a string), and return in HLINFO's mouse_face_*
28960 members the pixel and column/row coordinates of those glyphs. */
28961
28962 static void
28963 mouse_face_from_string_pos (struct window *w, Mouse_HLInfo *hlinfo,
28964 Lisp_Object object,
28965 ptrdiff_t startpos, ptrdiff_t endpos)
28966 {
28967 int yb = window_text_bottom_y (w);
28968 struct glyph_row *r;
28969 struct glyph *g, *e;
28970 int gx;
28971 bool found = false;
28972
28973 /* Find the glyph row with at least one position in the range
28974 [STARTPOS..ENDPOS), and the first glyph in that row whose
28975 position belongs to that range. */
28976 for (r = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
28977 r->enabled_p && r->y < yb;
28978 ++r)
28979 {
28980 if (!r->reversed_p)
28981 {
28982 g = r->glyphs[TEXT_AREA];
28983 e = g + r->used[TEXT_AREA];
28984 for (gx = r->x; g < e; gx += g->pixel_width, ++g)
28985 if (EQ (g->object, object)
28986 && startpos <= g->charpos && g->charpos < endpos)
28987 {
28988 hlinfo->mouse_face_beg_row
28989 = MATRIX_ROW_VPOS (r, w->current_matrix);
28990 hlinfo->mouse_face_beg_col = g - r->glyphs[TEXT_AREA];
28991 hlinfo->mouse_face_beg_x = gx;
28992 found = true;
28993 break;
28994 }
28995 }
28996 else
28997 {
28998 struct glyph *g1;
28999
29000 e = r->glyphs[TEXT_AREA];
29001 g = e + r->used[TEXT_AREA];
29002 for ( ; g > e; --g)
29003 if (EQ ((g-1)->object, object)
29004 && startpos <= (g-1)->charpos && (g-1)->charpos < endpos)
29005 {
29006 hlinfo->mouse_face_beg_row
29007 = MATRIX_ROW_VPOS (r, w->current_matrix);
29008 hlinfo->mouse_face_beg_col = g - r->glyphs[TEXT_AREA];
29009 for (gx = r->x, g1 = r->glyphs[TEXT_AREA]; g1 < g; ++g1)
29010 gx += g1->pixel_width;
29011 hlinfo->mouse_face_beg_x = gx;
29012 found = true;
29013 break;
29014 }
29015 }
29016 if (found)
29017 break;
29018 }
29019
29020 if (!found)
29021 return;
29022
29023 /* Starting with the next row, look for the first row which does NOT
29024 include any glyphs whose positions are in the range. */
29025 for (++r; r->enabled_p && r->y < yb; ++r)
29026 {
29027 g = r->glyphs[TEXT_AREA];
29028 e = g + r->used[TEXT_AREA];
29029 found = false;
29030 for ( ; g < e; ++g)
29031 if (EQ (g->object, object)
29032 && startpos <= g->charpos && g->charpos < endpos)
29033 {
29034 found = true;
29035 break;
29036 }
29037 if (!found)
29038 break;
29039 }
29040
29041 /* The highlighted region ends on the previous row. */
29042 r--;
29043
29044 /* Set the end row. */
29045 hlinfo->mouse_face_end_row = MATRIX_ROW_VPOS (r, w->current_matrix);
29046
29047 /* Compute and set the end column and the end column's horizontal
29048 pixel coordinate. */
29049 if (!r->reversed_p)
29050 {
29051 g = r->glyphs[TEXT_AREA];
29052 e = g + r->used[TEXT_AREA];
29053 for ( ; e > g; --e)
29054 if (EQ ((e-1)->object, object)
29055 && startpos <= (e-1)->charpos && (e-1)->charpos < endpos)
29056 break;
29057 hlinfo->mouse_face_end_col = e - g;
29058
29059 for (gx = r->x; g < e; ++g)
29060 gx += g->pixel_width;
29061 hlinfo->mouse_face_end_x = gx;
29062 }
29063 else
29064 {
29065 e = r->glyphs[TEXT_AREA];
29066 g = e + r->used[TEXT_AREA];
29067 for (gx = r->x ; e < g; ++e)
29068 {
29069 if (EQ (e->object, object)
29070 && startpos <= e->charpos && e->charpos < endpos)
29071 break;
29072 gx += e->pixel_width;
29073 }
29074 hlinfo->mouse_face_end_col = e - r->glyphs[TEXT_AREA];
29075 hlinfo->mouse_face_end_x = gx;
29076 }
29077 }
29078
29079 #ifdef HAVE_WINDOW_SYSTEM
29080
29081 /* See if position X, Y is within a hot-spot of an image. */
29082
29083 static bool
29084 on_hot_spot_p (Lisp_Object hot_spot, int x, int y)
29085 {
29086 if (!CONSP (hot_spot))
29087 return false;
29088
29089 if (EQ (XCAR (hot_spot), Qrect))
29090 {
29091 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29092 Lisp_Object rect = XCDR (hot_spot);
29093 Lisp_Object tem;
29094 if (!CONSP (rect))
29095 return false;
29096 if (!CONSP (XCAR (rect)))
29097 return false;
29098 if (!CONSP (XCDR (rect)))
29099 return false;
29100 if (!(tem = XCAR (XCAR (rect)), INTEGERP (tem) && x >= XINT (tem)))
29101 return false;
29102 if (!(tem = XCDR (XCAR (rect)), INTEGERP (tem) && y >= XINT (tem)))
29103 return false;
29104 if (!(tem = XCAR (XCDR (rect)), INTEGERP (tem) && x <= XINT (tem)))
29105 return false;
29106 if (!(tem = XCDR (XCDR (rect)), INTEGERP (tem) && y <= XINT (tem)))
29107 return false;
29108 return true;
29109 }
29110 else if (EQ (XCAR (hot_spot), Qcircle))
29111 {
29112 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29113 Lisp_Object circ = XCDR (hot_spot);
29114 Lisp_Object lr, lx0, ly0;
29115 if (CONSP (circ)
29116 && CONSP (XCAR (circ))
29117 && (lr = XCDR (circ), NUMBERP (lr))
29118 && (lx0 = XCAR (XCAR (circ)), INTEGERP (lx0))
29119 && (ly0 = XCDR (XCAR (circ)), INTEGERP (ly0)))
29120 {
29121 double r = XFLOATINT (lr);
29122 double dx = XINT (lx0) - x;
29123 double dy = XINT (ly0) - y;
29124 return (dx * dx + dy * dy <= r * r);
29125 }
29126 }
29127 else if (EQ (XCAR (hot_spot), Qpoly))
29128 {
29129 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29130 if (VECTORP (XCDR (hot_spot)))
29131 {
29132 struct Lisp_Vector *v = XVECTOR (XCDR (hot_spot));
29133 Lisp_Object *poly = v->contents;
29134 ptrdiff_t n = v->header.size;
29135 ptrdiff_t i;
29136 bool inside = false;
29137 Lisp_Object lx, ly;
29138 int x0, y0;
29139
29140 /* Need an even number of coordinates, and at least 3 edges. */
29141 if (n < 6 || n & 1)
29142 return false;
29143
29144 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29145 If count is odd, we are inside polygon. Pixels on edges
29146 may or may not be included depending on actual geometry of the
29147 polygon. */
29148 if ((lx = poly[n-2], !INTEGERP (lx))
29149 || (ly = poly[n-1], !INTEGERP (lx)))
29150 return false;
29151 x0 = XINT (lx), y0 = XINT (ly);
29152 for (i = 0; i < n; i += 2)
29153 {
29154 int x1 = x0, y1 = y0;
29155 if ((lx = poly[i], !INTEGERP (lx))
29156 || (ly = poly[i+1], !INTEGERP (ly)))
29157 return false;
29158 x0 = XINT (lx), y0 = XINT (ly);
29159
29160 /* Does this segment cross the X line? */
29161 if (x0 >= x)
29162 {
29163 if (x1 >= x)
29164 continue;
29165 }
29166 else if (x1 < x)
29167 continue;
29168 if (y > y0 && y > y1)
29169 continue;
29170 if (y < y0 + ((y1 - y0) * (x - x0)) / (x1 - x0))
29171 inside = !inside;
29172 }
29173 return inside;
29174 }
29175 }
29176 return false;
29177 }
29178
29179 Lisp_Object
29180 find_hot_spot (Lisp_Object map, int x, int y)
29181 {
29182 while (CONSP (map))
29183 {
29184 if (CONSP (XCAR (map))
29185 && on_hot_spot_p (XCAR (XCAR (map)), x, y))
29186 return XCAR (map);
29187 map = XCDR (map);
29188 }
29189
29190 return Qnil;
29191 }
29192
29193 DEFUN ("lookup-image-map", Flookup_image_map, Slookup_image_map,
29194 3, 3, 0,
29195 doc: /* Lookup in image map MAP coordinates X and Y.
29196 An image map is an alist where each element has the format (AREA ID PLIST).
29197 An AREA is specified as either a rectangle, a circle, or a polygon:
29198 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29199 pixel coordinates of the upper left and bottom right corners.
29200 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29201 and the radius of the circle; r may be a float or integer.
29202 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29203 vector describes one corner in the polygon.
29204 Returns the alist element for the first matching AREA in MAP. */)
29205 (Lisp_Object map, Lisp_Object x, Lisp_Object y)
29206 {
29207 if (NILP (map))
29208 return Qnil;
29209
29210 CHECK_NUMBER (x);
29211 CHECK_NUMBER (y);
29212
29213 return find_hot_spot (map,
29214 clip_to_bounds (INT_MIN, XINT (x), INT_MAX),
29215 clip_to_bounds (INT_MIN, XINT (y), INT_MAX));
29216 }
29217
29218
29219 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29220 static void
29221 define_frame_cursor1 (struct frame *f, Cursor cursor, Lisp_Object pointer)
29222 {
29223 /* Do not change cursor shape while dragging mouse. */
29224 if (EQ (do_mouse_tracking, Qdragging))
29225 return;
29226
29227 if (!NILP (pointer))
29228 {
29229 if (EQ (pointer, Qarrow))
29230 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29231 else if (EQ (pointer, Qhand))
29232 cursor = FRAME_X_OUTPUT (f)->hand_cursor;
29233 else if (EQ (pointer, Qtext))
29234 cursor = FRAME_X_OUTPUT (f)->text_cursor;
29235 else if (EQ (pointer, intern ("hdrag")))
29236 cursor = FRAME_X_OUTPUT (f)->horizontal_drag_cursor;
29237 else if (EQ (pointer, intern ("nhdrag")))
29238 cursor = FRAME_X_OUTPUT (f)->vertical_drag_cursor;
29239 #ifdef HAVE_X_WINDOWS
29240 else if (EQ (pointer, intern ("vdrag")))
29241 cursor = FRAME_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
29242 #endif
29243 else if (EQ (pointer, intern ("hourglass")))
29244 cursor = FRAME_X_OUTPUT (f)->hourglass_cursor;
29245 else if (EQ (pointer, Qmodeline))
29246 cursor = FRAME_X_OUTPUT (f)->modeline_cursor;
29247 else
29248 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29249 }
29250
29251 if (cursor != No_Cursor)
29252 FRAME_RIF (f)->define_frame_cursor (f, cursor);
29253 }
29254
29255 #endif /* HAVE_WINDOW_SYSTEM */
29256
29257 /* Take proper action when mouse has moved to the mode or header line
29258 or marginal area AREA of window W, x-position X and y-position Y.
29259 X is relative to the start of the text display area of W, so the
29260 width of bitmap areas and scroll bars must be subtracted to get a
29261 position relative to the start of the mode line. */
29262
29263 static void
29264 note_mode_line_or_margin_highlight (Lisp_Object window, int x, int y,
29265 enum window_part area)
29266 {
29267 struct window *w = XWINDOW (window);
29268 struct frame *f = XFRAME (w->frame);
29269 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
29270 #ifdef HAVE_WINDOW_SYSTEM
29271 Display_Info *dpyinfo;
29272 #endif
29273 Cursor cursor = No_Cursor;
29274 Lisp_Object pointer = Qnil;
29275 int dx, dy, width, height;
29276 ptrdiff_t charpos;
29277 Lisp_Object string, object = Qnil;
29278 Lisp_Object pos IF_LINT (= Qnil), help;
29279
29280 Lisp_Object mouse_face;
29281 int original_x_pixel = x;
29282 struct glyph * glyph = NULL, * row_start_glyph = NULL;
29283 struct glyph_row *row IF_LINT (= 0);
29284
29285 if (area == ON_MODE_LINE || area == ON_HEADER_LINE)
29286 {
29287 int x0;
29288 struct glyph *end;
29289
29290 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29291 returns them in row/column units! */
29292 string = mode_line_string (w, area, &x, &y, &charpos,
29293 &object, &dx, &dy, &width, &height);
29294
29295 row = (area == ON_MODE_LINE
29296 ? MATRIX_MODE_LINE_ROW (w->current_matrix)
29297 : MATRIX_HEADER_LINE_ROW (w->current_matrix));
29298
29299 /* Find the glyph under the mouse pointer. */
29300 if (row->mode_line_p && row->enabled_p)
29301 {
29302 glyph = row_start_glyph = row->glyphs[TEXT_AREA];
29303 end = glyph + row->used[TEXT_AREA];
29304
29305 for (x0 = original_x_pixel;
29306 glyph < end && x0 >= glyph->pixel_width;
29307 ++glyph)
29308 x0 -= glyph->pixel_width;
29309
29310 if (glyph >= end)
29311 glyph = NULL;
29312 }
29313 }
29314 else
29315 {
29316 x -= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w);
29317 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29318 returns them in row/column units! */
29319 string = marginal_area_string (w, area, &x, &y, &charpos,
29320 &object, &dx, &dy, &width, &height);
29321 }
29322
29323 help = Qnil;
29324
29325 #ifdef HAVE_WINDOW_SYSTEM
29326 if (IMAGEP (object))
29327 {
29328 Lisp_Object image_map, hotspot;
29329 if ((image_map = Fplist_get (XCDR (object), QCmap),
29330 !NILP (image_map))
29331 && (hotspot = find_hot_spot (image_map, dx, dy),
29332 CONSP (hotspot))
29333 && (hotspot = XCDR (hotspot), CONSP (hotspot)))
29334 {
29335 Lisp_Object plist;
29336
29337 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29338 If so, we could look for mouse-enter, mouse-leave
29339 properties in PLIST (and do something...). */
29340 hotspot = XCDR (hotspot);
29341 if (CONSP (hotspot)
29342 && (plist = XCAR (hotspot), CONSP (plist)))
29343 {
29344 pointer = Fplist_get (plist, Qpointer);
29345 if (NILP (pointer))
29346 pointer = Qhand;
29347 help = Fplist_get (plist, Qhelp_echo);
29348 if (!NILP (help))
29349 {
29350 help_echo_string = help;
29351 XSETWINDOW (help_echo_window, w);
29352 help_echo_object = w->contents;
29353 help_echo_pos = charpos;
29354 }
29355 }
29356 }
29357 if (NILP (pointer))
29358 pointer = Fplist_get (XCDR (object), QCpointer);
29359 }
29360 #endif /* HAVE_WINDOW_SYSTEM */
29361
29362 if (STRINGP (string))
29363 pos = make_number (charpos);
29364
29365 /* Set the help text and mouse pointer. If the mouse is on a part
29366 of the mode line without any text (e.g. past the right edge of
29367 the mode line text), use the default help text and pointer. */
29368 if (STRINGP (string) || area == ON_MODE_LINE)
29369 {
29370 /* Arrange to display the help by setting the global variables
29371 help_echo_string, help_echo_object, and help_echo_pos. */
29372 if (NILP (help))
29373 {
29374 if (STRINGP (string))
29375 help = Fget_text_property (pos, Qhelp_echo, string);
29376
29377 if (!NILP (help))
29378 {
29379 help_echo_string = help;
29380 XSETWINDOW (help_echo_window, w);
29381 help_echo_object = string;
29382 help_echo_pos = charpos;
29383 }
29384 else if (area == ON_MODE_LINE)
29385 {
29386 Lisp_Object default_help
29387 = buffer_local_value (Qmode_line_default_help_echo,
29388 w->contents);
29389
29390 if (STRINGP (default_help))
29391 {
29392 help_echo_string = default_help;
29393 XSETWINDOW (help_echo_window, w);
29394 help_echo_object = Qnil;
29395 help_echo_pos = -1;
29396 }
29397 }
29398 }
29399
29400 #ifdef HAVE_WINDOW_SYSTEM
29401 /* Change the mouse pointer according to what is under it. */
29402 if (FRAME_WINDOW_P (f))
29403 {
29404 bool draggable = (! WINDOW_BOTTOMMOST_P (w)
29405 || minibuf_level
29406 || NILP (Vresize_mini_windows));
29407
29408 dpyinfo = FRAME_DISPLAY_INFO (f);
29409 if (STRINGP (string))
29410 {
29411 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29412
29413 if (NILP (pointer))
29414 pointer = Fget_text_property (pos, Qpointer, string);
29415
29416 /* Change the mouse pointer according to what is under X/Y. */
29417 if (NILP (pointer)
29418 && ((area == ON_MODE_LINE) || (area == ON_HEADER_LINE)))
29419 {
29420 Lisp_Object map;
29421 map = Fget_text_property (pos, Qlocal_map, string);
29422 if (!KEYMAPP (map))
29423 map = Fget_text_property (pos, Qkeymap, string);
29424 if (!KEYMAPP (map) && draggable)
29425 cursor = dpyinfo->vertical_scroll_bar_cursor;
29426 }
29427 }
29428 else if (draggable)
29429 /* Default mode-line pointer. */
29430 cursor = FRAME_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
29431 }
29432 #endif
29433 }
29434
29435 /* Change the mouse face according to what is under X/Y. */
29436 bool mouse_face_shown = false;
29437 if (STRINGP (string))
29438 {
29439 mouse_face = Fget_text_property (pos, Qmouse_face, string);
29440 if (!NILP (Vmouse_highlight) && !NILP (mouse_face)
29441 && ((area == ON_MODE_LINE) || (area == ON_HEADER_LINE))
29442 && glyph)
29443 {
29444 Lisp_Object b, e;
29445
29446 struct glyph * tmp_glyph;
29447
29448 int gpos;
29449 int gseq_length;
29450 int total_pixel_width;
29451 ptrdiff_t begpos, endpos, ignore;
29452
29453 int vpos, hpos;
29454
29455 b = Fprevious_single_property_change (make_number (charpos + 1),
29456 Qmouse_face, string, Qnil);
29457 if (NILP (b))
29458 begpos = 0;
29459 else
29460 begpos = XINT (b);
29461
29462 e = Fnext_single_property_change (pos, Qmouse_face, string, Qnil);
29463 if (NILP (e))
29464 endpos = SCHARS (string);
29465 else
29466 endpos = XINT (e);
29467
29468 /* Calculate the glyph position GPOS of GLYPH in the
29469 displayed string, relative to the beginning of the
29470 highlighted part of the string.
29471
29472 Note: GPOS is different from CHARPOS. CHARPOS is the
29473 position of GLYPH in the internal string object. A mode
29474 line string format has structures which are converted to
29475 a flattened string by the Emacs Lisp interpreter. The
29476 internal string is an element of those structures. The
29477 displayed string is the flattened string. */
29478 tmp_glyph = row_start_glyph;
29479 while (tmp_glyph < glyph
29480 && (!(EQ (tmp_glyph->object, glyph->object)
29481 && begpos <= tmp_glyph->charpos
29482 && tmp_glyph->charpos < endpos)))
29483 tmp_glyph++;
29484 gpos = glyph - tmp_glyph;
29485
29486 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29487 the highlighted part of the displayed string to which
29488 GLYPH belongs. Note: GSEQ_LENGTH is different from
29489 SCHARS (STRING), because the latter returns the length of
29490 the internal string. */
29491 for (tmp_glyph = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1;
29492 tmp_glyph > glyph
29493 && (!(EQ (tmp_glyph->object, glyph->object)
29494 && begpos <= tmp_glyph->charpos
29495 && tmp_glyph->charpos < endpos));
29496 tmp_glyph--)
29497 ;
29498 gseq_length = gpos + (tmp_glyph - glyph) + 1;
29499
29500 /* Calculate the total pixel width of all the glyphs between
29501 the beginning of the highlighted area and GLYPH. */
29502 total_pixel_width = 0;
29503 for (tmp_glyph = glyph - gpos; tmp_glyph != glyph; tmp_glyph++)
29504 total_pixel_width += tmp_glyph->pixel_width;
29505
29506 /* Pre calculation of re-rendering position. Note: X is in
29507 column units here, after the call to mode_line_string or
29508 marginal_area_string. */
29509 hpos = x - gpos;
29510 vpos = (area == ON_MODE_LINE
29511 ? (w->current_matrix)->nrows - 1
29512 : 0);
29513
29514 /* If GLYPH's position is included in the region that is
29515 already drawn in mouse face, we have nothing to do. */
29516 if ( EQ (window, hlinfo->mouse_face_window)
29517 && (!row->reversed_p
29518 ? (hlinfo->mouse_face_beg_col <= hpos
29519 && hpos < hlinfo->mouse_face_end_col)
29520 /* In R2L rows we swap BEG and END, see below. */
29521 : (hlinfo->mouse_face_end_col <= hpos
29522 && hpos < hlinfo->mouse_face_beg_col))
29523 && hlinfo->mouse_face_beg_row == vpos )
29524 return;
29525
29526 if (clear_mouse_face (hlinfo))
29527 cursor = No_Cursor;
29528
29529 if (!row->reversed_p)
29530 {
29531 hlinfo->mouse_face_beg_col = hpos;
29532 hlinfo->mouse_face_beg_x = original_x_pixel
29533 - (total_pixel_width + dx);
29534 hlinfo->mouse_face_end_col = hpos + gseq_length;
29535 hlinfo->mouse_face_end_x = 0;
29536 }
29537 else
29538 {
29539 /* In R2L rows, show_mouse_face expects BEG and END
29540 coordinates to be swapped. */
29541 hlinfo->mouse_face_end_col = hpos;
29542 hlinfo->mouse_face_end_x = original_x_pixel
29543 - (total_pixel_width + dx);
29544 hlinfo->mouse_face_beg_col = hpos + gseq_length;
29545 hlinfo->mouse_face_beg_x = 0;
29546 }
29547
29548 hlinfo->mouse_face_beg_row = vpos;
29549 hlinfo->mouse_face_end_row = hlinfo->mouse_face_beg_row;
29550 hlinfo->mouse_face_past_end = false;
29551 hlinfo->mouse_face_window = window;
29552
29553 hlinfo->mouse_face_face_id = face_at_string_position (w, string,
29554 charpos,
29555 0, &ignore,
29556 glyph->face_id,
29557 true);
29558 show_mouse_face (hlinfo, DRAW_MOUSE_FACE);
29559 mouse_face_shown = true;
29560
29561 if (NILP (pointer))
29562 pointer = Qhand;
29563 }
29564 }
29565
29566 /* If mouse-face doesn't need to be shown, clear any existing
29567 mouse-face. */
29568 if ((area == ON_MODE_LINE || area == ON_HEADER_LINE) && !mouse_face_shown)
29569 clear_mouse_face (hlinfo);
29570
29571 #ifdef HAVE_WINDOW_SYSTEM
29572 if (FRAME_WINDOW_P (f))
29573 define_frame_cursor1 (f, cursor, pointer);
29574 #endif
29575 }
29576
29577
29578 /* EXPORT:
29579 Take proper action when the mouse has moved to position X, Y on
29580 frame F with regards to highlighting portions of display that have
29581 mouse-face properties. Also de-highlight portions of display where
29582 the mouse was before, set the mouse pointer shape as appropriate
29583 for the mouse coordinates, and activate help echo (tooltips).
29584 X and Y can be negative or out of range. */
29585
29586 void
29587 note_mouse_highlight (struct frame *f, int x, int y)
29588 {
29589 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
29590 enum window_part part = ON_NOTHING;
29591 Lisp_Object window;
29592 struct window *w;
29593 Cursor cursor = No_Cursor;
29594 Lisp_Object pointer = Qnil; /* Takes precedence over cursor! */
29595 struct buffer *b;
29596
29597 /* When a menu is active, don't highlight because this looks odd. */
29598 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29599 if (popup_activated ())
29600 return;
29601 #endif
29602
29603 if (!f->glyphs_initialized_p
29604 || f->pointer_invisible)
29605 return;
29606
29607 hlinfo->mouse_face_mouse_x = x;
29608 hlinfo->mouse_face_mouse_y = y;
29609 hlinfo->mouse_face_mouse_frame = f;
29610
29611 if (hlinfo->mouse_face_defer)
29612 return;
29613
29614 /* Which window is that in? */
29615 window = window_from_coordinates (f, x, y, &part, true);
29616
29617 /* If displaying active text in another window, clear that. */
29618 if (! EQ (window, hlinfo->mouse_face_window)
29619 /* Also clear if we move out of text area in same window. */
29620 || (!NILP (hlinfo->mouse_face_window)
29621 && !NILP (window)
29622 && part != ON_TEXT
29623 && part != ON_MODE_LINE
29624 && part != ON_HEADER_LINE))
29625 clear_mouse_face (hlinfo);
29626
29627 /* Not on a window -> return. */
29628 if (!WINDOWP (window))
29629 return;
29630
29631 /* Reset help_echo_string. It will get recomputed below. */
29632 help_echo_string = Qnil;
29633
29634 /* Convert to window-relative pixel coordinates. */
29635 w = XWINDOW (window);
29636 frame_to_window_pixel_xy (w, &x, &y);
29637
29638 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29639 /* Handle tool-bar window differently since it doesn't display a
29640 buffer. */
29641 if (EQ (window, f->tool_bar_window))
29642 {
29643 note_tool_bar_highlight (f, x, y);
29644 return;
29645 }
29646 #endif
29647
29648 /* Mouse is on the mode, header line or margin? */
29649 if (part == ON_MODE_LINE || part == ON_HEADER_LINE
29650 || part == ON_LEFT_MARGIN || part == ON_RIGHT_MARGIN)
29651 {
29652 note_mode_line_or_margin_highlight (window, x, y, part);
29653
29654 #ifdef HAVE_WINDOW_SYSTEM
29655 if (part == ON_LEFT_MARGIN || part == ON_RIGHT_MARGIN)
29656 {
29657 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29658 /* Show non-text cursor (Bug#16647). */
29659 goto set_cursor;
29660 }
29661 else
29662 #endif
29663 return;
29664 }
29665
29666 #ifdef HAVE_WINDOW_SYSTEM
29667 if (part == ON_VERTICAL_BORDER)
29668 {
29669 cursor = FRAME_X_OUTPUT (f)->horizontal_drag_cursor;
29670 help_echo_string = build_string ("drag-mouse-1: resize");
29671 }
29672 else if (part == ON_RIGHT_DIVIDER)
29673 {
29674 cursor = FRAME_X_OUTPUT (f)->horizontal_drag_cursor;
29675 help_echo_string = build_string ("drag-mouse-1: resize");
29676 }
29677 else if (part == ON_BOTTOM_DIVIDER)
29678 if (! WINDOW_BOTTOMMOST_P (w)
29679 || minibuf_level
29680 || NILP (Vresize_mini_windows))
29681 {
29682 cursor = FRAME_X_OUTPUT (f)->vertical_drag_cursor;
29683 help_echo_string = build_string ("drag-mouse-1: resize");
29684 }
29685 else
29686 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29687 else if (part == ON_LEFT_FRINGE || part == ON_RIGHT_FRINGE
29688 || part == ON_VERTICAL_SCROLL_BAR
29689 || part == ON_HORIZONTAL_SCROLL_BAR)
29690 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29691 else
29692 cursor = FRAME_X_OUTPUT (f)->text_cursor;
29693 #endif
29694
29695 /* Are we in a window whose display is up to date?
29696 And verify the buffer's text has not changed. */
29697 b = XBUFFER (w->contents);
29698 if (part == ON_TEXT && w->window_end_valid && !window_outdated (w))
29699 {
29700 int hpos, vpos, dx, dy, area = LAST_AREA;
29701 ptrdiff_t pos;
29702 struct glyph *glyph;
29703 Lisp_Object object;
29704 Lisp_Object mouse_face = Qnil, position;
29705 Lisp_Object *overlay_vec = NULL;
29706 ptrdiff_t i, noverlays;
29707 struct buffer *obuf;
29708 ptrdiff_t obegv, ozv;
29709 bool same_region;
29710
29711 /* Find the glyph under X/Y. */
29712 glyph = x_y_to_hpos_vpos (w, x, y, &hpos, &vpos, &dx, &dy, &area);
29713
29714 #ifdef HAVE_WINDOW_SYSTEM
29715 /* Look for :pointer property on image. */
29716 if (glyph != NULL && glyph->type == IMAGE_GLYPH)
29717 {
29718 struct image *img = IMAGE_FROM_ID (f, glyph->u.img_id);
29719 if (img != NULL && IMAGEP (img->spec))
29720 {
29721 Lisp_Object image_map, hotspot;
29722 if ((image_map = Fplist_get (XCDR (img->spec), QCmap),
29723 !NILP (image_map))
29724 && (hotspot = find_hot_spot (image_map,
29725 glyph->slice.img.x + dx,
29726 glyph->slice.img.y + dy),
29727 CONSP (hotspot))
29728 && (hotspot = XCDR (hotspot), CONSP (hotspot)))
29729 {
29730 Lisp_Object plist;
29731
29732 /* Could check XCAR (hotspot) to see if we enter/leave
29733 this hot-spot.
29734 If so, we could look for mouse-enter, mouse-leave
29735 properties in PLIST (and do something...). */
29736 hotspot = XCDR (hotspot);
29737 if (CONSP (hotspot)
29738 && (plist = XCAR (hotspot), CONSP (plist)))
29739 {
29740 pointer = Fplist_get (plist, Qpointer);
29741 if (NILP (pointer))
29742 pointer = Qhand;
29743 help_echo_string = Fplist_get (plist, Qhelp_echo);
29744 if (!NILP (help_echo_string))
29745 {
29746 help_echo_window = window;
29747 help_echo_object = glyph->object;
29748 help_echo_pos = glyph->charpos;
29749 }
29750 }
29751 }
29752 if (NILP (pointer))
29753 pointer = Fplist_get (XCDR (img->spec), QCpointer);
29754 }
29755 }
29756 #endif /* HAVE_WINDOW_SYSTEM */
29757
29758 /* Clear mouse face if X/Y not over text. */
29759 if (glyph == NULL
29760 || area != TEXT_AREA
29761 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w->current_matrix, vpos))
29762 /* Glyph's OBJECT is nil for glyphs inserted by the
29763 display engine for its internal purposes, like truncation
29764 and continuation glyphs and blanks beyond the end of
29765 line's text on text terminals. If we are over such a
29766 glyph, we are not over any text. */
29767 || NILP (glyph->object)
29768 /* R2L rows have a stretch glyph at their front, which
29769 stands for no text, whereas L2R rows have no glyphs at
29770 all beyond the end of text. Treat such stretch glyphs
29771 like we do with NULL glyphs in L2R rows. */
29772 || (MATRIX_ROW (w->current_matrix, vpos)->reversed_p
29773 && glyph == MATRIX_ROW_GLYPH_START (w->current_matrix, vpos)
29774 && glyph->type == STRETCH_GLYPH
29775 && glyph->avoid_cursor_p))
29776 {
29777 if (clear_mouse_face (hlinfo))
29778 cursor = No_Cursor;
29779 #ifdef HAVE_WINDOW_SYSTEM
29780 if (FRAME_WINDOW_P (f) && NILP (pointer))
29781 {
29782 if (area != TEXT_AREA)
29783 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29784 else
29785 pointer = Vvoid_text_area_pointer;
29786 }
29787 #endif
29788 goto set_cursor;
29789 }
29790
29791 pos = glyph->charpos;
29792 object = glyph->object;
29793 if (!STRINGP (object) && !BUFFERP (object))
29794 goto set_cursor;
29795
29796 /* If we get an out-of-range value, return now; avoid an error. */
29797 if (BUFFERP (object) && pos > BUF_Z (b))
29798 goto set_cursor;
29799
29800 /* Make the window's buffer temporarily current for
29801 overlays_at and compute_char_face. */
29802 obuf = current_buffer;
29803 current_buffer = b;
29804 obegv = BEGV;
29805 ozv = ZV;
29806 BEGV = BEG;
29807 ZV = Z;
29808
29809 /* Is this char mouse-active or does it have help-echo? */
29810 position = make_number (pos);
29811
29812 USE_SAFE_ALLOCA;
29813
29814 if (BUFFERP (object))
29815 {
29816 /* Put all the overlays we want in a vector in overlay_vec. */
29817 GET_OVERLAYS_AT (pos, overlay_vec, noverlays, NULL, false);
29818 /* Sort overlays into increasing priority order. */
29819 noverlays = sort_overlays (overlay_vec, noverlays, w);
29820 }
29821 else
29822 noverlays = 0;
29823
29824 if (NILP (Vmouse_highlight))
29825 {
29826 clear_mouse_face (hlinfo);
29827 goto check_help_echo;
29828 }
29829
29830 same_region = coords_in_mouse_face_p (w, hpos, vpos);
29831
29832 if (same_region)
29833 cursor = No_Cursor;
29834
29835 /* Check mouse-face highlighting. */
29836 if (! same_region
29837 /* If there exists an overlay with mouse-face overlapping
29838 the one we are currently highlighting, we have to
29839 check if we enter the overlapping overlay, and then
29840 highlight only that. */
29841 || (OVERLAYP (hlinfo->mouse_face_overlay)
29842 && mouse_face_overlay_overlaps (hlinfo->mouse_face_overlay)))
29843 {
29844 /* Find the highest priority overlay with a mouse-face. */
29845 Lisp_Object overlay = Qnil;
29846 for (i = noverlays - 1; i >= 0 && NILP (overlay); --i)
29847 {
29848 mouse_face = Foverlay_get (overlay_vec[i], Qmouse_face);
29849 if (!NILP (mouse_face))
29850 overlay = overlay_vec[i];
29851 }
29852
29853 /* If we're highlighting the same overlay as before, there's
29854 no need to do that again. */
29855 if (!NILP (overlay) && EQ (overlay, hlinfo->mouse_face_overlay))
29856 goto check_help_echo;
29857 hlinfo->mouse_face_overlay = overlay;
29858
29859 /* Clear the display of the old active region, if any. */
29860 if (clear_mouse_face (hlinfo))
29861 cursor = No_Cursor;
29862
29863 /* If no overlay applies, get a text property. */
29864 if (NILP (overlay))
29865 mouse_face = Fget_text_property (position, Qmouse_face, object);
29866
29867 /* Next, compute the bounds of the mouse highlighting and
29868 display it. */
29869 if (!NILP (mouse_face) && STRINGP (object))
29870 {
29871 /* The mouse-highlighting comes from a display string
29872 with a mouse-face. */
29873 Lisp_Object s, e;
29874 ptrdiff_t ignore;
29875
29876 s = Fprevious_single_property_change
29877 (make_number (pos + 1), Qmouse_face, object, Qnil);
29878 e = Fnext_single_property_change
29879 (position, Qmouse_face, object, Qnil);
29880 if (NILP (s))
29881 s = make_number (0);
29882 if (NILP (e))
29883 e = make_number (SCHARS (object));
29884 mouse_face_from_string_pos (w, hlinfo, object,
29885 XINT (s), XINT (e));
29886 hlinfo->mouse_face_past_end = false;
29887 hlinfo->mouse_face_window = window;
29888 hlinfo->mouse_face_face_id
29889 = face_at_string_position (w, object, pos, 0, &ignore,
29890 glyph->face_id, true);
29891 show_mouse_face (hlinfo, DRAW_MOUSE_FACE);
29892 cursor = No_Cursor;
29893 }
29894 else
29895 {
29896 /* The mouse-highlighting, if any, comes from an overlay
29897 or text property in the buffer. */
29898 Lisp_Object buffer IF_LINT (= Qnil);
29899 Lisp_Object disp_string IF_LINT (= Qnil);
29900
29901 if (STRINGP (object))
29902 {
29903 /* If we are on a display string with no mouse-face,
29904 check if the text under it has one. */
29905 struct glyph_row *r = MATRIX_ROW (w->current_matrix, vpos);
29906 ptrdiff_t start = MATRIX_ROW_START_CHARPOS (r);
29907 pos = string_buffer_position (object, start);
29908 if (pos > 0)
29909 {
29910 mouse_face = get_char_property_and_overlay
29911 (make_number (pos), Qmouse_face, w->contents, &overlay);
29912 buffer = w->contents;
29913 disp_string = object;
29914 }
29915 }
29916 else
29917 {
29918 buffer = object;
29919 disp_string = Qnil;
29920 }
29921
29922 if (!NILP (mouse_face))
29923 {
29924 Lisp_Object before, after;
29925 Lisp_Object before_string, after_string;
29926 /* To correctly find the limits of mouse highlight
29927 in a bidi-reordered buffer, we must not use the
29928 optimization of limiting the search in
29929 previous-single-property-change and
29930 next-single-property-change, because
29931 rows_from_pos_range needs the real start and end
29932 positions to DTRT in this case. That's because
29933 the first row visible in a window does not
29934 necessarily display the character whose position
29935 is the smallest. */
29936 Lisp_Object lim1
29937 = NILP (BVAR (XBUFFER (buffer), bidi_display_reordering))
29938 ? Fmarker_position (w->start)
29939 : Qnil;
29940 Lisp_Object lim2
29941 = NILP (BVAR (XBUFFER (buffer), bidi_display_reordering))
29942 ? make_number (BUF_Z (XBUFFER (buffer))
29943 - w->window_end_pos)
29944 : Qnil;
29945
29946 if (NILP (overlay))
29947 {
29948 /* Handle the text property case. */
29949 before = Fprevious_single_property_change
29950 (make_number (pos + 1), Qmouse_face, buffer, lim1);
29951 after = Fnext_single_property_change
29952 (make_number (pos), Qmouse_face, buffer, lim2);
29953 before_string = after_string = Qnil;
29954 }
29955 else
29956 {
29957 /* Handle the overlay case. */
29958 before = Foverlay_start (overlay);
29959 after = Foverlay_end (overlay);
29960 before_string = Foverlay_get (overlay, Qbefore_string);
29961 after_string = Foverlay_get (overlay, Qafter_string);
29962
29963 if (!STRINGP (before_string)) before_string = Qnil;
29964 if (!STRINGP (after_string)) after_string = Qnil;
29965 }
29966
29967 mouse_face_from_buffer_pos (window, hlinfo, pos,
29968 NILP (before)
29969 ? 1
29970 : XFASTINT (before),
29971 NILP (after)
29972 ? BUF_Z (XBUFFER (buffer))
29973 : XFASTINT (after),
29974 before_string, after_string,
29975 disp_string);
29976 cursor = No_Cursor;
29977 }
29978 }
29979 }
29980
29981 check_help_echo:
29982
29983 /* Look for a `help-echo' property. */
29984 if (NILP (help_echo_string)) {
29985 Lisp_Object help, overlay;
29986
29987 /* Check overlays first. */
29988 help = overlay = Qnil;
29989 for (i = noverlays - 1; i >= 0 && NILP (help); --i)
29990 {
29991 overlay = overlay_vec[i];
29992 help = Foverlay_get (overlay, Qhelp_echo);
29993 }
29994
29995 if (!NILP (help))
29996 {
29997 help_echo_string = help;
29998 help_echo_window = window;
29999 help_echo_object = overlay;
30000 help_echo_pos = pos;
30001 }
30002 else
30003 {
30004 Lisp_Object obj = glyph->object;
30005 ptrdiff_t charpos = glyph->charpos;
30006
30007 /* Try text properties. */
30008 if (STRINGP (obj)
30009 && charpos >= 0
30010 && charpos < SCHARS (obj))
30011 {
30012 help = Fget_text_property (make_number (charpos),
30013 Qhelp_echo, obj);
30014 if (NILP (help))
30015 {
30016 /* If the string itself doesn't specify a help-echo,
30017 see if the buffer text ``under'' it does. */
30018 struct glyph_row *r
30019 = MATRIX_ROW (w->current_matrix, vpos);
30020 ptrdiff_t start = MATRIX_ROW_START_CHARPOS (r);
30021 ptrdiff_t p = string_buffer_position (obj, start);
30022 if (p > 0)
30023 {
30024 help = Fget_char_property (make_number (p),
30025 Qhelp_echo, w->contents);
30026 if (!NILP (help))
30027 {
30028 charpos = p;
30029 obj = w->contents;
30030 }
30031 }
30032 }
30033 }
30034 else if (BUFFERP (obj)
30035 && charpos >= BEGV
30036 && charpos < ZV)
30037 help = Fget_text_property (make_number (charpos), Qhelp_echo,
30038 obj);
30039
30040 if (!NILP (help))
30041 {
30042 help_echo_string = help;
30043 help_echo_window = window;
30044 help_echo_object = obj;
30045 help_echo_pos = charpos;
30046 }
30047 }
30048 }
30049
30050 #ifdef HAVE_WINDOW_SYSTEM
30051 /* Look for a `pointer' property. */
30052 if (FRAME_WINDOW_P (f) && NILP (pointer))
30053 {
30054 /* Check overlays first. */
30055 for (i = noverlays - 1; i >= 0 && NILP (pointer); --i)
30056 pointer = Foverlay_get (overlay_vec[i], Qpointer);
30057
30058 if (NILP (pointer))
30059 {
30060 Lisp_Object obj = glyph->object;
30061 ptrdiff_t charpos = glyph->charpos;
30062
30063 /* Try text properties. */
30064 if (STRINGP (obj)
30065 && charpos >= 0
30066 && charpos < SCHARS (obj))
30067 {
30068 pointer = Fget_text_property (make_number (charpos),
30069 Qpointer, obj);
30070 if (NILP (pointer))
30071 {
30072 /* If the string itself doesn't specify a pointer,
30073 see if the buffer text ``under'' it does. */
30074 struct glyph_row *r
30075 = MATRIX_ROW (w->current_matrix, vpos);
30076 ptrdiff_t start = MATRIX_ROW_START_CHARPOS (r);
30077 ptrdiff_t p = string_buffer_position (obj, start);
30078 if (p > 0)
30079 pointer = Fget_char_property (make_number (p),
30080 Qpointer, w->contents);
30081 }
30082 }
30083 else if (BUFFERP (obj)
30084 && charpos >= BEGV
30085 && charpos < ZV)
30086 pointer = Fget_text_property (make_number (charpos),
30087 Qpointer, obj);
30088 }
30089 }
30090 #endif /* HAVE_WINDOW_SYSTEM */
30091
30092 BEGV = obegv;
30093 ZV = ozv;
30094 current_buffer = obuf;
30095 SAFE_FREE ();
30096 }
30097
30098 set_cursor:
30099
30100 #ifdef HAVE_WINDOW_SYSTEM
30101 if (FRAME_WINDOW_P (f))
30102 define_frame_cursor1 (f, cursor, pointer);
30103 #else
30104 /* This is here to prevent a compiler error, about "label at end of
30105 compound statement". */
30106 return;
30107 #endif
30108 }
30109
30110
30111 /* EXPORT for RIF:
30112 Clear any mouse-face on window W. This function is part of the
30113 redisplay interface, and is called from try_window_id and similar
30114 functions to ensure the mouse-highlight is off. */
30115
30116 void
30117 x_clear_window_mouse_face (struct window *w)
30118 {
30119 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
30120 Lisp_Object window;
30121
30122 block_input ();
30123 XSETWINDOW (window, w);
30124 if (EQ (window, hlinfo->mouse_face_window))
30125 clear_mouse_face (hlinfo);
30126 unblock_input ();
30127 }
30128
30129
30130 /* EXPORT:
30131 Just discard the mouse face information for frame F, if any.
30132 This is used when the size of F is changed. */
30133
30134 void
30135 cancel_mouse_face (struct frame *f)
30136 {
30137 Lisp_Object window;
30138 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
30139
30140 window = hlinfo->mouse_face_window;
30141 if (! NILP (window) && XFRAME (XWINDOW (window)->frame) == f)
30142 reset_mouse_highlight (hlinfo);
30143 }
30144
30145
30146 \f
30147 /***********************************************************************
30148 Exposure Events
30149 ***********************************************************************/
30150
30151 #ifdef HAVE_WINDOW_SYSTEM
30152
30153 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30154 which intersects rectangle R. R is in window-relative coordinates. */
30155
30156 static void
30157 expose_area (struct window *w, struct glyph_row *row, XRectangle *r,
30158 enum glyph_row_area area)
30159 {
30160 struct glyph *first = row->glyphs[area];
30161 struct glyph *end = row->glyphs[area] + row->used[area];
30162 struct glyph *last;
30163 int first_x, start_x, x;
30164
30165 if (area == TEXT_AREA && row->fill_line_p)
30166 /* If row extends face to end of line write the whole line. */
30167 draw_glyphs (w, 0, row, area,
30168 0, row->used[area],
30169 DRAW_NORMAL_TEXT, 0);
30170 else
30171 {
30172 /* Set START_X to the window-relative start position for drawing glyphs of
30173 AREA. The first glyph of the text area can be partially visible.
30174 The first glyphs of other areas cannot. */
30175 start_x = window_box_left_offset (w, area);
30176 x = start_x;
30177 if (area == TEXT_AREA)
30178 x += row->x;
30179
30180 /* Find the first glyph that must be redrawn. */
30181 while (first < end
30182 && x + first->pixel_width < r->x)
30183 {
30184 x += first->pixel_width;
30185 ++first;
30186 }
30187
30188 /* Find the last one. */
30189 last = first;
30190 first_x = x;
30191 /* Use a signed int intermediate value to avoid catastrophic
30192 failures due to comparison between signed and unsigned, when
30193 x is negative (can happen for wide images that are hscrolled). */
30194 int r_end = r->x + r->width;
30195 while (last < end && x < r_end)
30196 {
30197 x += last->pixel_width;
30198 ++last;
30199 }
30200
30201 /* Repaint. */
30202 if (last > first)
30203 draw_glyphs (w, first_x - start_x, row, area,
30204 first - row->glyphs[area], last - row->glyphs[area],
30205 DRAW_NORMAL_TEXT, 0);
30206 }
30207 }
30208
30209
30210 /* Redraw the parts of the glyph row ROW on window W intersecting
30211 rectangle R. R is in window-relative coordinates. Value is
30212 true if mouse-face was overwritten. */
30213
30214 static bool
30215 expose_line (struct window *w, struct glyph_row *row, XRectangle *r)
30216 {
30217 eassert (row->enabled_p);
30218
30219 if (row->mode_line_p || w->pseudo_window_p)
30220 draw_glyphs (w, 0, row, TEXT_AREA,
30221 0, row->used[TEXT_AREA],
30222 DRAW_NORMAL_TEXT, 0);
30223 else
30224 {
30225 if (row->used[LEFT_MARGIN_AREA])
30226 expose_area (w, row, r, LEFT_MARGIN_AREA);
30227 if (row->used[TEXT_AREA])
30228 expose_area (w, row, r, TEXT_AREA);
30229 if (row->used[RIGHT_MARGIN_AREA])
30230 expose_area (w, row, r, RIGHT_MARGIN_AREA);
30231 draw_row_fringe_bitmaps (w, row);
30232 }
30233
30234 return row->mouse_face_p;
30235 }
30236
30237
30238 /* Redraw those parts of glyphs rows during expose event handling that
30239 overlap other rows. Redrawing of an exposed line writes over parts
30240 of lines overlapping that exposed line; this function fixes that.
30241
30242 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30243 row in W's current matrix that is exposed and overlaps other rows.
30244 LAST_OVERLAPPING_ROW is the last such row. */
30245
30246 static void
30247 expose_overlaps (struct window *w,
30248 struct glyph_row *first_overlapping_row,
30249 struct glyph_row *last_overlapping_row,
30250 XRectangle *r)
30251 {
30252 struct glyph_row *row;
30253
30254 for (row = first_overlapping_row; row <= last_overlapping_row; ++row)
30255 if (row->overlapping_p)
30256 {
30257 eassert (row->enabled_p && !row->mode_line_p);
30258
30259 row->clip = r;
30260 if (row->used[LEFT_MARGIN_AREA])
30261 x_fix_overlapping_area (w, row, LEFT_MARGIN_AREA, OVERLAPS_BOTH);
30262
30263 if (row->used[TEXT_AREA])
30264 x_fix_overlapping_area (w, row, TEXT_AREA, OVERLAPS_BOTH);
30265
30266 if (row->used[RIGHT_MARGIN_AREA])
30267 x_fix_overlapping_area (w, row, RIGHT_MARGIN_AREA, OVERLAPS_BOTH);
30268 row->clip = NULL;
30269 }
30270 }
30271
30272
30273 /* Return true if W's cursor intersects rectangle R. */
30274
30275 static bool
30276 phys_cursor_in_rect_p (struct window *w, XRectangle *r)
30277 {
30278 XRectangle cr, result;
30279 struct glyph *cursor_glyph;
30280 struct glyph_row *row;
30281
30282 if (w->phys_cursor.vpos >= 0
30283 && w->phys_cursor.vpos < w->current_matrix->nrows
30284 && (row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos),
30285 row->enabled_p)
30286 && row->cursor_in_fringe_p)
30287 {
30288 /* Cursor is in the fringe. */
30289 cr.x = window_box_right_offset (w,
30290 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
30291 ? RIGHT_MARGIN_AREA
30292 : TEXT_AREA));
30293 cr.y = row->y;
30294 cr.width = WINDOW_RIGHT_FRINGE_WIDTH (w);
30295 cr.height = row->height;
30296 return x_intersect_rectangles (&cr, r, &result);
30297 }
30298
30299 cursor_glyph = get_phys_cursor_glyph (w);
30300 if (cursor_glyph)
30301 {
30302 /* r is relative to W's box, but w->phys_cursor.x is relative
30303 to left edge of W's TEXT area. Adjust it. */
30304 cr.x = window_box_left_offset (w, TEXT_AREA) + w->phys_cursor.x;
30305 cr.y = w->phys_cursor.y;
30306 cr.width = cursor_glyph->pixel_width;
30307 cr.height = w->phys_cursor_height;
30308 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30309 I assume the effect is the same -- and this is portable. */
30310 return x_intersect_rectangles (&cr, r, &result);
30311 }
30312 /* If we don't understand the format, pretend we're not in the hot-spot. */
30313 return false;
30314 }
30315
30316
30317 /* EXPORT:
30318 Draw a vertical window border to the right of window W if W doesn't
30319 have vertical scroll bars. */
30320
30321 void
30322 x_draw_vertical_border (struct window *w)
30323 {
30324 struct frame *f = XFRAME (WINDOW_FRAME (w));
30325
30326 /* We could do better, if we knew what type of scroll-bar the adjacent
30327 windows (on either side) have... But we don't :-(
30328 However, I think this works ok. ++KFS 2003-04-25 */
30329
30330 /* Redraw borders between horizontally adjacent windows. Don't
30331 do it for frames with vertical scroll bars because either the
30332 right scroll bar of a window, or the left scroll bar of its
30333 neighbor will suffice as a border. */
30334 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f) || FRAME_RIGHT_DIVIDER_WIDTH (f))
30335 return;
30336
30337 /* Note: It is necessary to redraw both the left and the right
30338 borders, for when only this single window W is being
30339 redisplayed. */
30340 if (!WINDOW_RIGHTMOST_P (w)
30341 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
30342 {
30343 int x0, x1, y0, y1;
30344
30345 window_box_edges (w, &x0, &y0, &x1, &y1);
30346 y1 -= 1;
30347
30348 if (WINDOW_LEFT_FRINGE_WIDTH (w) == 0)
30349 x1 -= 1;
30350
30351 FRAME_RIF (f)->draw_vertical_window_border (w, x1, y0, y1);
30352 }
30353
30354 if (!WINDOW_LEFTMOST_P (w)
30355 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
30356 {
30357 int x0, x1, y0, y1;
30358
30359 window_box_edges (w, &x0, &y0, &x1, &y1);
30360 y1 -= 1;
30361
30362 if (WINDOW_LEFT_FRINGE_WIDTH (w) == 0)
30363 x0 -= 1;
30364
30365 FRAME_RIF (f)->draw_vertical_window_border (w, x0, y0, y1);
30366 }
30367 }
30368
30369
30370 /* Draw window dividers for window W. */
30371
30372 void
30373 x_draw_right_divider (struct window *w)
30374 {
30375 struct frame *f = WINDOW_XFRAME (w);
30376
30377 if (w->mini || w->pseudo_window_p)
30378 return;
30379 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
30380 {
30381 int x0 = WINDOW_RIGHT_EDGE_X (w) - WINDOW_RIGHT_DIVIDER_WIDTH (w);
30382 int x1 = WINDOW_RIGHT_EDGE_X (w);
30383 int y0 = WINDOW_TOP_EDGE_Y (w);
30384 /* The bottom divider prevails. */
30385 int y1 = WINDOW_BOTTOM_EDGE_Y (w) - WINDOW_BOTTOM_DIVIDER_WIDTH (w);
30386
30387 FRAME_RIF (f)->draw_window_divider (w, x0, x1, y0, y1);
30388 }
30389 }
30390
30391 static void
30392 x_draw_bottom_divider (struct window *w)
30393 {
30394 struct frame *f = XFRAME (WINDOW_FRAME (w));
30395
30396 if (w->mini || w->pseudo_window_p)
30397 return;
30398 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w))
30399 {
30400 int x0 = WINDOW_LEFT_EDGE_X (w);
30401 int x1 = WINDOW_RIGHT_EDGE_X (w);
30402 int y0 = WINDOW_BOTTOM_EDGE_Y (w) - WINDOW_BOTTOM_DIVIDER_WIDTH (w);
30403 int y1 = WINDOW_BOTTOM_EDGE_Y (w);
30404
30405 FRAME_RIF (f)->draw_window_divider (w, x0, x1, y0, y1);
30406 }
30407 }
30408
30409 /* Redraw the part of window W intersection rectangle FR. Pixel
30410 coordinates in FR are frame-relative. Call this function with
30411 input blocked. Value is true if the exposure overwrites
30412 mouse-face. */
30413
30414 static bool
30415 expose_window (struct window *w, XRectangle *fr)
30416 {
30417 struct frame *f = XFRAME (w->frame);
30418 XRectangle wr, r;
30419 bool mouse_face_overwritten_p = false;
30420
30421 /* If window is not yet fully initialized, do nothing. This can
30422 happen when toolkit scroll bars are used and a window is split.
30423 Reconfiguring the scroll bar will generate an expose for a newly
30424 created window. */
30425 if (w->current_matrix == NULL)
30426 return false;
30427
30428 /* When we're currently updating the window, display and current
30429 matrix usually don't agree. Arrange for a thorough display
30430 later. */
30431 if (w->must_be_updated_p)
30432 {
30433 SET_FRAME_GARBAGED (f);
30434 return false;
30435 }
30436
30437 /* Frame-relative pixel rectangle of W. */
30438 wr.x = WINDOW_LEFT_EDGE_X (w);
30439 wr.y = WINDOW_TOP_EDGE_Y (w);
30440 wr.width = WINDOW_PIXEL_WIDTH (w);
30441 wr.height = WINDOW_PIXEL_HEIGHT (w);
30442
30443 if (x_intersect_rectangles (fr, &wr, &r))
30444 {
30445 int yb = window_text_bottom_y (w);
30446 struct glyph_row *row;
30447 struct glyph_row *first_overlapping_row, *last_overlapping_row;
30448
30449 TRACE ((stderr, "expose_window (%d, %d, %d, %d)\n",
30450 r.x, r.y, r.width, r.height));
30451
30452 /* Convert to window coordinates. */
30453 r.x -= WINDOW_LEFT_EDGE_X (w);
30454 r.y -= WINDOW_TOP_EDGE_Y (w);
30455
30456 /* Turn off the cursor. */
30457 bool cursor_cleared_p = (!w->pseudo_window_p
30458 && phys_cursor_in_rect_p (w, &r));
30459 if (cursor_cleared_p)
30460 x_clear_cursor (w);
30461
30462 /* If the row containing the cursor extends face to end of line,
30463 then expose_area might overwrite the cursor outside the
30464 rectangle and thus notice_overwritten_cursor might clear
30465 w->phys_cursor_on_p. We remember the original value and
30466 check later if it is changed. */
30467 bool phys_cursor_on_p = w->phys_cursor_on_p;
30468
30469 /* Use a signed int intermediate value to avoid catastrophic
30470 failures due to comparison between signed and unsigned, when
30471 y0 or y1 is negative (can happen for tall images). */
30472 int r_bottom = r.y + r.height;
30473
30474 /* Update lines intersecting rectangle R. */
30475 first_overlapping_row = last_overlapping_row = NULL;
30476 for (row = w->current_matrix->rows;
30477 row->enabled_p;
30478 ++row)
30479 {
30480 int y0 = row->y;
30481 int y1 = MATRIX_ROW_BOTTOM_Y (row);
30482
30483 if ((y0 >= r.y && y0 < r_bottom)
30484 || (y1 > r.y && y1 < r_bottom)
30485 || (r.y >= y0 && r.y < y1)
30486 || (r_bottom > y0 && r_bottom < y1))
30487 {
30488 /* A header line may be overlapping, but there is no need
30489 to fix overlapping areas for them. KFS 2005-02-12 */
30490 if (row->overlapping_p && !row->mode_line_p)
30491 {
30492 if (first_overlapping_row == NULL)
30493 first_overlapping_row = row;
30494 last_overlapping_row = row;
30495 }
30496
30497 row->clip = fr;
30498 if (expose_line (w, row, &r))
30499 mouse_face_overwritten_p = true;
30500 row->clip = NULL;
30501 }
30502 else if (row->overlapping_p)
30503 {
30504 /* We must redraw a row overlapping the exposed area. */
30505 if (y0 < r.y
30506 ? y0 + row->phys_height > r.y
30507 : y0 + row->ascent - row->phys_ascent < r.y +r.height)
30508 {
30509 if (first_overlapping_row == NULL)
30510 first_overlapping_row = row;
30511 last_overlapping_row = row;
30512 }
30513 }
30514
30515 if (y1 >= yb)
30516 break;
30517 }
30518
30519 /* Display the mode line if there is one. */
30520 if (WINDOW_WANTS_MODELINE_P (w)
30521 && (row = MATRIX_MODE_LINE_ROW (w->current_matrix),
30522 row->enabled_p)
30523 && row->y < r_bottom)
30524 {
30525 if (expose_line (w, row, &r))
30526 mouse_face_overwritten_p = true;
30527 }
30528
30529 if (!w->pseudo_window_p)
30530 {
30531 /* Fix the display of overlapping rows. */
30532 if (first_overlapping_row)
30533 expose_overlaps (w, first_overlapping_row, last_overlapping_row,
30534 fr);
30535
30536 /* Draw border between windows. */
30537 if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
30538 x_draw_right_divider (w);
30539 else
30540 x_draw_vertical_border (w);
30541
30542 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w))
30543 x_draw_bottom_divider (w);
30544
30545 /* Turn the cursor on again. */
30546 if (cursor_cleared_p
30547 || (phys_cursor_on_p && !w->phys_cursor_on_p))
30548 update_window_cursor (w, true);
30549 }
30550 }
30551
30552 return mouse_face_overwritten_p;
30553 }
30554
30555
30556
30557 /* Redraw (parts) of all windows in the window tree rooted at W that
30558 intersect R. R contains frame pixel coordinates. Value is
30559 true if the exposure overwrites mouse-face. */
30560
30561 static bool
30562 expose_window_tree (struct window *w, XRectangle *r)
30563 {
30564 struct frame *f = XFRAME (w->frame);
30565 bool mouse_face_overwritten_p = false;
30566
30567 while (w && !FRAME_GARBAGED_P (f))
30568 {
30569 mouse_face_overwritten_p
30570 |= (WINDOWP (w->contents)
30571 ? expose_window_tree (XWINDOW (w->contents), r)
30572 : expose_window (w, r));
30573
30574 w = NILP (w->next) ? NULL : XWINDOW (w->next);
30575 }
30576
30577 return mouse_face_overwritten_p;
30578 }
30579
30580
30581 /* EXPORT:
30582 Redisplay an exposed area of frame F. X and Y are the upper-left
30583 corner of the exposed rectangle. W and H are width and height of
30584 the exposed area. All are pixel values. W or H zero means redraw
30585 the entire frame. */
30586
30587 void
30588 expose_frame (struct frame *f, int x, int y, int w, int h)
30589 {
30590 XRectangle r;
30591 bool mouse_face_overwritten_p = false;
30592
30593 TRACE ((stderr, "expose_frame "));
30594
30595 /* No need to redraw if frame will be redrawn soon. */
30596 if (FRAME_GARBAGED_P (f))
30597 {
30598 TRACE ((stderr, " garbaged\n"));
30599 return;
30600 }
30601
30602 /* If basic faces haven't been realized yet, there is no point in
30603 trying to redraw anything. This can happen when we get an expose
30604 event while Emacs is starting, e.g. by moving another window. */
30605 if (FRAME_FACE_CACHE (f) == NULL
30606 || FRAME_FACE_CACHE (f)->used < BASIC_FACE_ID_SENTINEL)
30607 {
30608 TRACE ((stderr, " no faces\n"));
30609 return;
30610 }
30611
30612 if (w == 0 || h == 0)
30613 {
30614 r.x = r.y = 0;
30615 r.width = FRAME_TEXT_WIDTH (f);
30616 r.height = FRAME_TEXT_HEIGHT (f);
30617 }
30618 else
30619 {
30620 r.x = x;
30621 r.y = y;
30622 r.width = w;
30623 r.height = h;
30624 }
30625
30626 TRACE ((stderr, "(%d, %d, %d, %d)\n", r.x, r.y, r.width, r.height));
30627 mouse_face_overwritten_p = expose_window_tree (XWINDOW (f->root_window), &r);
30628
30629 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30630 if (WINDOWP (f->tool_bar_window))
30631 mouse_face_overwritten_p
30632 |= expose_window (XWINDOW (f->tool_bar_window), &r);
30633 #endif
30634
30635 #ifdef HAVE_X_WINDOWS
30636 #ifndef MSDOS
30637 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30638 if (WINDOWP (f->menu_bar_window))
30639 mouse_face_overwritten_p
30640 |= expose_window (XWINDOW (f->menu_bar_window), &r);
30641 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30642 #endif
30643 #endif
30644
30645 /* Some window managers support a focus-follows-mouse style with
30646 delayed raising of frames. Imagine a partially obscured frame,
30647 and moving the mouse into partially obscured mouse-face on that
30648 frame. The visible part of the mouse-face will be highlighted,
30649 then the WM raises the obscured frame. With at least one WM, KDE
30650 2.1, Emacs is not getting any event for the raising of the frame
30651 (even tried with SubstructureRedirectMask), only Expose events.
30652 These expose events will draw text normally, i.e. not
30653 highlighted. Which means we must redo the highlight here.
30654 Subsume it under ``we love X''. --gerd 2001-08-15 */
30655 /* Included in Windows version because Windows most likely does not
30656 do the right thing if any third party tool offers
30657 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30658 if (mouse_face_overwritten_p && !FRAME_GARBAGED_P (f))
30659 {
30660 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
30661 if (f == hlinfo->mouse_face_mouse_frame)
30662 {
30663 int mouse_x = hlinfo->mouse_face_mouse_x;
30664 int mouse_y = hlinfo->mouse_face_mouse_y;
30665 clear_mouse_face (hlinfo);
30666 note_mouse_highlight (f, mouse_x, mouse_y);
30667 }
30668 }
30669 }
30670
30671
30672 /* EXPORT:
30673 Determine the intersection of two rectangles R1 and R2. Return
30674 the intersection in *RESULT. Value is true if RESULT is not
30675 empty. */
30676
30677 bool
30678 x_intersect_rectangles (XRectangle *r1, XRectangle *r2, XRectangle *result)
30679 {
30680 XRectangle *left, *right;
30681 XRectangle *upper, *lower;
30682 bool intersection_p = false;
30683
30684 /* Rearrange so that R1 is the left-most rectangle. */
30685 if (r1->x < r2->x)
30686 left = r1, right = r2;
30687 else
30688 left = r2, right = r1;
30689
30690 /* X0 of the intersection is right.x0, if this is inside R1,
30691 otherwise there is no intersection. */
30692 if (right->x <= left->x + left->width)
30693 {
30694 result->x = right->x;
30695
30696 /* The right end of the intersection is the minimum of
30697 the right ends of left and right. */
30698 result->width = (min (left->x + left->width, right->x + right->width)
30699 - result->x);
30700
30701 /* Same game for Y. */
30702 if (r1->y < r2->y)
30703 upper = r1, lower = r2;
30704 else
30705 upper = r2, lower = r1;
30706
30707 /* The upper end of the intersection is lower.y0, if this is inside
30708 of upper. Otherwise, there is no intersection. */
30709 if (lower->y <= upper->y + upper->height)
30710 {
30711 result->y = lower->y;
30712
30713 /* The lower end of the intersection is the minimum of the lower
30714 ends of upper and lower. */
30715 result->height = (min (lower->y + lower->height,
30716 upper->y + upper->height)
30717 - result->y);
30718 intersection_p = true;
30719 }
30720 }
30721
30722 return intersection_p;
30723 }
30724
30725 #endif /* HAVE_WINDOW_SYSTEM */
30726
30727 \f
30728 /***********************************************************************
30729 Initialization
30730 ***********************************************************************/
30731
30732 void
30733 syms_of_xdisp (void)
30734 {
30735 Vwith_echo_area_save_vector = Qnil;
30736 staticpro (&Vwith_echo_area_save_vector);
30737
30738 Vmessage_stack = Qnil;
30739 staticpro (&Vmessage_stack);
30740
30741 /* Non-nil means don't actually do any redisplay. */
30742 DEFSYM (Qinhibit_redisplay, "inhibit-redisplay");
30743
30744 DEFSYM (Qredisplay_internal, "redisplay_internal (C function)");
30745
30746 DEFVAR_BOOL("inhibit-message", inhibit_message,
30747 doc: /* Non-nil means calls to `message' are not displayed.
30748 They are still logged to the *Messages* buffer. */);
30749 inhibit_message = 0;
30750
30751 message_dolog_marker1 = Fmake_marker ();
30752 staticpro (&message_dolog_marker1);
30753 message_dolog_marker2 = Fmake_marker ();
30754 staticpro (&message_dolog_marker2);
30755 message_dolog_marker3 = Fmake_marker ();
30756 staticpro (&message_dolog_marker3);
30757
30758 #ifdef GLYPH_DEBUG
30759 defsubr (&Sdump_frame_glyph_matrix);
30760 defsubr (&Sdump_glyph_matrix);
30761 defsubr (&Sdump_glyph_row);
30762 defsubr (&Sdump_tool_bar_row);
30763 defsubr (&Strace_redisplay);
30764 defsubr (&Strace_to_stderr);
30765 #endif
30766 #ifdef HAVE_WINDOW_SYSTEM
30767 defsubr (&Stool_bar_height);
30768 defsubr (&Slookup_image_map);
30769 #endif
30770 defsubr (&Sline_pixel_height);
30771 defsubr (&Sformat_mode_line);
30772 defsubr (&Sinvisible_p);
30773 defsubr (&Scurrent_bidi_paragraph_direction);
30774 defsubr (&Swindow_text_pixel_size);
30775 defsubr (&Smove_point_visually);
30776 defsubr (&Sbidi_find_overridden_directionality);
30777
30778 DEFSYM (Qmenu_bar_update_hook, "menu-bar-update-hook");
30779 DEFSYM (Qoverriding_terminal_local_map, "overriding-terminal-local-map");
30780 DEFSYM (Qoverriding_local_map, "overriding-local-map");
30781 DEFSYM (Qwindow_scroll_functions, "window-scroll-functions");
30782 DEFSYM (Qwindow_text_change_functions, "window-text-change-functions");
30783 DEFSYM (Qredisplay_end_trigger_functions, "redisplay-end-trigger-functions");
30784 DEFSYM (Qinhibit_point_motion_hooks, "inhibit-point-motion-hooks");
30785 DEFSYM (Qeval, "eval");
30786 DEFSYM (QCdata, ":data");
30787
30788 /* Names of text properties relevant for redisplay. */
30789 DEFSYM (Qdisplay, "display");
30790 DEFSYM (Qspace_width, "space-width");
30791 DEFSYM (Qraise, "raise");
30792 DEFSYM (Qslice, "slice");
30793 DEFSYM (Qspace, "space");
30794 DEFSYM (Qmargin, "margin");
30795 DEFSYM (Qpointer, "pointer");
30796 DEFSYM (Qleft_margin, "left-margin");
30797 DEFSYM (Qright_margin, "right-margin");
30798 DEFSYM (Qcenter, "center");
30799 DEFSYM (Qline_height, "line-height");
30800 DEFSYM (QCalign_to, ":align-to");
30801 DEFSYM (QCrelative_width, ":relative-width");
30802 DEFSYM (QCrelative_height, ":relative-height");
30803 DEFSYM (QCeval, ":eval");
30804 DEFSYM (QCpropertize, ":propertize");
30805 DEFSYM (QCfile, ":file");
30806 DEFSYM (Qfontified, "fontified");
30807 DEFSYM (Qfontification_functions, "fontification-functions");
30808
30809 /* Name of the face used to highlight trailing whitespace. */
30810 DEFSYM (Qtrailing_whitespace, "trailing-whitespace");
30811
30812 /* Name and number of the face used to highlight escape glyphs. */
30813 DEFSYM (Qescape_glyph, "escape-glyph");
30814
30815 /* Name and number of the face used to highlight non-breaking spaces. */
30816 DEFSYM (Qnobreak_space, "nobreak-space");
30817
30818 /* The symbol 'image' which is the car of the lists used to represent
30819 images in Lisp. Also a tool bar style. */
30820 DEFSYM (Qimage, "image");
30821
30822 /* Tool bar styles. */
30823 DEFSYM (Qtext, "text");
30824 DEFSYM (Qboth, "both");
30825 DEFSYM (Qboth_horiz, "both-horiz");
30826 DEFSYM (Qtext_image_horiz, "text-image-horiz");
30827
30828 /* The image map types. */
30829 DEFSYM (QCmap, ":map");
30830 DEFSYM (QCpointer, ":pointer");
30831 DEFSYM (Qrect, "rect");
30832 DEFSYM (Qcircle, "circle");
30833 DEFSYM (Qpoly, "poly");
30834
30835 DEFSYM (Qinhibit_menubar_update, "inhibit-menubar-update");
30836
30837 DEFSYM (Qgrow_only, "grow-only");
30838 DEFSYM (Qinhibit_eval_during_redisplay, "inhibit-eval-during-redisplay");
30839 DEFSYM (Qposition, "position");
30840 DEFSYM (Qbuffer_position, "buffer-position");
30841 DEFSYM (Qobject, "object");
30842
30843 /* Cursor shapes. */
30844 DEFSYM (Qbar, "bar");
30845 DEFSYM (Qhbar, "hbar");
30846 DEFSYM (Qbox, "box");
30847 DEFSYM (Qhollow, "hollow");
30848
30849 /* Pointer shapes. */
30850 DEFSYM (Qhand, "hand");
30851 DEFSYM (Qarrow, "arrow");
30852 /* also Qtext */
30853
30854 DEFSYM (Qdragging, "dragging");
30855
30856 DEFSYM (Qinhibit_free_realized_faces, "inhibit-free-realized-faces");
30857
30858 list_of_error = list1 (list2 (Qerror, Qvoid_variable));
30859 staticpro (&list_of_error);
30860
30861 /* Values of those variables at last redisplay are stored as
30862 properties on 'overlay-arrow-position' symbol. However, if
30863 Voverlay_arrow_position is a marker, last-arrow-position is its
30864 numerical position. */
30865 DEFSYM (Qlast_arrow_position, "last-arrow-position");
30866 DEFSYM (Qlast_arrow_string, "last-arrow-string");
30867
30868 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
30869 properties on a symbol in overlay-arrow-variable-list. */
30870 DEFSYM (Qoverlay_arrow_string, "overlay-arrow-string");
30871 DEFSYM (Qoverlay_arrow_bitmap, "overlay-arrow-bitmap");
30872
30873 echo_buffer[0] = echo_buffer[1] = Qnil;
30874 staticpro (&echo_buffer[0]);
30875 staticpro (&echo_buffer[1]);
30876
30877 echo_area_buffer[0] = echo_area_buffer[1] = Qnil;
30878 staticpro (&echo_area_buffer[0]);
30879 staticpro (&echo_area_buffer[1]);
30880
30881 Vmessages_buffer_name = build_pure_c_string ("*Messages*");
30882 staticpro (&Vmessages_buffer_name);
30883
30884 mode_line_proptrans_alist = Qnil;
30885 staticpro (&mode_line_proptrans_alist);
30886 mode_line_string_list = Qnil;
30887 staticpro (&mode_line_string_list);
30888 mode_line_string_face = Qnil;
30889 staticpro (&mode_line_string_face);
30890 mode_line_string_face_prop = Qnil;
30891 staticpro (&mode_line_string_face_prop);
30892 Vmode_line_unwind_vector = Qnil;
30893 staticpro (&Vmode_line_unwind_vector);
30894
30895 DEFSYM (Qmode_line_default_help_echo, "mode-line-default-help-echo");
30896
30897 help_echo_string = Qnil;
30898 staticpro (&help_echo_string);
30899 help_echo_object = Qnil;
30900 staticpro (&help_echo_object);
30901 help_echo_window = Qnil;
30902 staticpro (&help_echo_window);
30903 previous_help_echo_string = Qnil;
30904 staticpro (&previous_help_echo_string);
30905 help_echo_pos = -1;
30906
30907 DEFSYM (Qright_to_left, "right-to-left");
30908 DEFSYM (Qleft_to_right, "left-to-right");
30909 defsubr (&Sbidi_resolved_levels);
30910
30911 #ifdef HAVE_WINDOW_SYSTEM
30912 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p,
30913 doc: /* Non-nil means draw block cursor as wide as the glyph under it.
30914 For example, if a block cursor is over a tab, it will be drawn as
30915 wide as that tab on the display. */);
30916 x_stretch_cursor_p = 0;
30917 #endif
30918
30919 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace,
30920 doc: /* Non-nil means highlight trailing whitespace.
30921 The face used for trailing whitespace is `trailing-whitespace'. */);
30922 Vshow_trailing_whitespace = Qnil;
30923
30924 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display,
30925 doc: /* Control highlighting of non-ASCII space and hyphen chars.
30926 If the value is t, Emacs highlights non-ASCII chars which have the
30927 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30928 or `escape-glyph' face respectively.
30929
30930 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30931 U+2011 (non-breaking hyphen) are affected.
30932
30933 Any other non-nil value means to display these characters as a escape
30934 glyph followed by an ordinary space or hyphen.
30935
30936 A value of nil means no special handling of these characters. */);
30937 Vnobreak_char_display = Qt;
30938
30939 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer,
30940 doc: /* The pointer shape to show in void text areas.
30941 A value of nil means to show the text pointer. Other options are
30942 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
30943 `hourglass'. */);
30944 Vvoid_text_area_pointer = Qarrow;
30945
30946 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay,
30947 doc: /* Non-nil means don't actually do any redisplay.
30948 This is used for internal purposes. */);
30949 Vinhibit_redisplay = Qnil;
30950
30951 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string,
30952 doc: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30953 Vglobal_mode_string = Qnil;
30954
30955 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position,
30956 doc: /* Marker for where to display an arrow on top of the buffer text.
30957 This must be the beginning of a line in order to work.
30958 See also `overlay-arrow-string'. */);
30959 Voverlay_arrow_position = Qnil;
30960
30961 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string,
30962 doc: /* String to display as an arrow in non-window frames.
30963 See also `overlay-arrow-position'. */);
30964 Voverlay_arrow_string = build_pure_c_string ("=>");
30965
30966 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list,
30967 doc: /* List of variables (symbols) which hold markers for overlay arrows.
30968 The symbols on this list are examined during redisplay to determine
30969 where to display overlay arrows. */);
30970 Voverlay_arrow_variable_list
30971 = list1 (intern_c_string ("overlay-arrow-position"));
30972
30973 DEFVAR_INT ("scroll-step", emacs_scroll_step,
30974 doc: /* The number of lines to try scrolling a window by when point moves out.
30975 If that fails to bring point back on frame, point is centered instead.
30976 If this is zero, point is always centered after it moves off frame.
30977 If you want scrolling to always be a line at a time, you should set
30978 `scroll-conservatively' to a large value rather than set this to 1. */);
30979
30980 DEFVAR_INT ("scroll-conservatively", scroll_conservatively,
30981 doc: /* Scroll up to this many lines, to bring point back on screen.
30982 If point moves off-screen, redisplay will scroll by up to
30983 `scroll-conservatively' lines in order to bring point just barely
30984 onto the screen again. If that cannot be done, then redisplay
30985 recenters point as usual.
30986
30987 If the value is greater than 100, redisplay will never recenter point,
30988 but will always scroll just enough text to bring point into view, even
30989 if you move far away.
30990
30991 A value of zero means always recenter point if it moves off screen. */);
30992 scroll_conservatively = 0;
30993
30994 DEFVAR_INT ("scroll-margin", scroll_margin,
30995 doc: /* Number of lines of margin at the top and bottom of a window.
30996 Recenter the window whenever point gets within this many lines
30997 of the top or bottom of the window. */);
30998 scroll_margin = 0;
30999
31000 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch,
31001 doc: /* Pixels per inch value for non-window system displays.
31002 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
31003 Vdisplay_pixels_per_inch = make_float (72.0);
31004
31005 #ifdef GLYPH_DEBUG
31006 DEFVAR_INT ("debug-end-pos", debug_end_pos, doc: /* Don't ask. */);
31007 #endif
31008
31009 DEFVAR_LISP ("truncate-partial-width-windows",
31010 Vtruncate_partial_width_windows,
31011 doc: /* Non-nil means truncate lines in windows narrower than the frame.
31012 For an integer value, truncate lines in each window narrower than the
31013 full frame width, provided the window width is less than that integer;
31014 otherwise, respect the value of `truncate-lines'.
31015
31016 For any other non-nil value, truncate lines in all windows that do
31017 not span the full frame width.
31018
31019 A value of nil means to respect the value of `truncate-lines'.
31020
31021 If `word-wrap' is enabled, you might want to reduce this. */);
31022 Vtruncate_partial_width_windows = make_number (50);
31023
31024 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit,
31025 doc: /* Maximum buffer size for which line number should be displayed.
31026 If the buffer is bigger than this, the line number does not appear
31027 in the mode line. A value of nil means no limit. */);
31028 Vline_number_display_limit = Qnil;
31029
31030 DEFVAR_INT ("line-number-display-limit-width",
31031 line_number_display_limit_width,
31032 doc: /* Maximum line width (in characters) for line number display.
31033 If the average length of the lines near point is bigger than this, then the
31034 line number may be omitted from the mode line. */);
31035 line_number_display_limit_width = 200;
31036
31037 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows,
31038 doc: /* Non-nil means highlight region even in nonselected windows. */);
31039 highlight_nonselected_windows = false;
31040
31041 DEFVAR_BOOL ("multiple-frames", multiple_frames,
31042 doc: /* Non-nil if more than one frame is visible on this display.
31043 Minibuffer-only frames don't count, but iconified frames do.
31044 This variable is not guaranteed to be accurate except while processing
31045 `frame-title-format' and `icon-title-format'. */);
31046
31047 DEFVAR_LISP ("frame-title-format", Vframe_title_format,
31048 doc: /* Template for displaying the title bar of visible frames.
31049 (Assuming the window manager supports this feature.)
31050
31051 This variable has the same structure as `mode-line-format', except that
31052 the %c and %l constructs are ignored. It is used only on frames for
31053 which no explicit name has been set (see `modify-frame-parameters'). */);
31054
31055 DEFVAR_LISP ("icon-title-format", Vicon_title_format,
31056 doc: /* Template for displaying the title bar of an iconified frame.
31057 (Assuming the window manager supports this feature.)
31058 This variable has the same structure as `mode-line-format' (which see),
31059 and is used only on frames for which no explicit name has been set
31060 (see `modify-frame-parameters'). */);
31061 Vicon_title_format
31062 = Vframe_title_format
31063 = listn (CONSTYPE_PURE, 3,
31064 intern_c_string ("multiple-frames"),
31065 build_pure_c_string ("%b"),
31066 listn (CONSTYPE_PURE, 4,
31067 empty_unibyte_string,
31068 intern_c_string ("invocation-name"),
31069 build_pure_c_string ("@"),
31070 intern_c_string ("system-name")));
31071
31072 DEFVAR_LISP ("message-log-max", Vmessage_log_max,
31073 doc: /* Maximum number of lines to keep in the message log buffer.
31074 If nil, disable message logging. If t, log messages but don't truncate
31075 the buffer when it becomes large. */);
31076 Vmessage_log_max = make_number (1000);
31077
31078 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions,
31079 doc: /* Functions called before redisplay, if window sizes have changed.
31080 The value should be a list of functions that take one argument.
31081 Just before redisplay, for each frame, if any of its windows have changed
31082 size since the last redisplay, or have been split or deleted,
31083 all the functions in the list are called, with the frame as argument. */);
31084 Vwindow_size_change_functions = Qnil;
31085
31086 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions,
31087 doc: /* List of functions to call before redisplaying a window with scrolling.
31088 Each function is called with two arguments, the window and its new
31089 display-start position.
31090 These functions are called whenever the `window-start' marker is modified,
31091 either to point into another buffer (e.g. via `set-window-buffer') or another
31092 place in the same buffer.
31093 Note that the value of `window-end' is not valid when these functions are
31094 called.
31095
31096 Warning: Do not use this feature to alter the way the window
31097 is scrolled. It is not designed for that, and such use probably won't
31098 work. */);
31099 Vwindow_scroll_functions = Qnil;
31100
31101 DEFVAR_LISP ("window-text-change-functions",
31102 Vwindow_text_change_functions,
31103 doc: /* Functions to call in redisplay when text in the window might change. */);
31104 Vwindow_text_change_functions = Qnil;
31105
31106 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions,
31107 doc: /* Functions called when redisplay of a window reaches the end trigger.
31108 Each function is called with two arguments, the window and the end trigger value.
31109 See `set-window-redisplay-end-trigger'. */);
31110 Vredisplay_end_trigger_functions = Qnil;
31111
31112 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window,
31113 doc: /* Non-nil means autoselect window with mouse pointer.
31114 If nil, do not autoselect windows.
31115 A positive number means delay autoselection by that many seconds: a
31116 window is autoselected only after the mouse has remained in that
31117 window for the duration of the delay.
31118 A negative number has a similar effect, but causes windows to be
31119 autoselected only after the mouse has stopped moving. (Because of
31120 the way Emacs compares mouse events, you will occasionally wait twice
31121 that time before the window gets selected.)
31122 Any other value means to autoselect window instantaneously when the
31123 mouse pointer enters it.
31124
31125 Autoselection selects the minibuffer only if it is active, and never
31126 unselects the minibuffer if it is active.
31127
31128 When customizing this variable make sure that the actual value of
31129 `focus-follows-mouse' matches the behavior of your window manager. */);
31130 Vmouse_autoselect_window = Qnil;
31131
31132 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars,
31133 doc: /* Non-nil means automatically resize tool-bars.
31134 This dynamically changes the tool-bar's height to the minimum height
31135 that is needed to make all tool-bar items visible.
31136 If value is `grow-only', the tool-bar's height is only increased
31137 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31138 Vauto_resize_tool_bars = Qt;
31139
31140 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p,
31141 doc: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31142 auto_raise_tool_bar_buttons_p = true;
31143
31144 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p,
31145 doc: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31146 make_cursor_line_fully_visible_p = true;
31147
31148 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border,
31149 doc: /* Border below tool-bar in pixels.
31150 If an integer, use it as the height of the border.
31151 If it is one of `internal-border-width' or `border-width', use the
31152 value of the corresponding frame parameter.
31153 Otherwise, no border is added below the tool-bar. */);
31154 Vtool_bar_border = Qinternal_border_width;
31155
31156 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin,
31157 doc: /* Margin around tool-bar buttons in pixels.
31158 If an integer, use that for both horizontal and vertical margins.
31159 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31160 HORZ specifying the horizontal margin, and VERT specifying the
31161 vertical margin. */);
31162 Vtool_bar_button_margin = make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN);
31163
31164 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief,
31165 doc: /* Relief thickness of tool-bar buttons. */);
31166 tool_bar_button_relief = DEFAULT_TOOL_BAR_BUTTON_RELIEF;
31167
31168 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style,
31169 doc: /* Tool bar style to use.
31170 It can be one of
31171 image - show images only
31172 text - show text only
31173 both - show both, text below image
31174 both-horiz - show text to the right of the image
31175 text-image-horiz - show text to the left of the image
31176 any other - use system default or image if no system default.
31177
31178 This variable only affects the GTK+ toolkit version of Emacs. */);
31179 Vtool_bar_style = Qnil;
31180
31181 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size,
31182 doc: /* Maximum number of characters a label can have to be shown.
31183 The tool bar style must also show labels for this to have any effect, see
31184 `tool-bar-style'. */);
31185 tool_bar_max_label_size = DEFAULT_TOOL_BAR_LABEL_SIZE;
31186
31187 DEFVAR_LISP ("fontification-functions", Vfontification_functions,
31188 doc: /* List of functions to call to fontify regions of text.
31189 Each function is called with one argument POS. Functions must
31190 fontify a region starting at POS in the current buffer, and give
31191 fontified regions the property `fontified'. */);
31192 Vfontification_functions = Qnil;
31193 Fmake_variable_buffer_local (Qfontification_functions);
31194
31195 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31196 unibyte_display_via_language_environment,
31197 doc: /* Non-nil means display unibyte text according to language environment.
31198 Specifically, this means that raw bytes in the range 160-255 decimal
31199 are displayed by converting them to the equivalent multibyte characters
31200 according to the current language environment. As a result, they are
31201 displayed according to the current fontset.
31202
31203 Note that this variable affects only how these bytes are displayed,
31204 but does not change the fact they are interpreted as raw bytes. */);
31205 unibyte_display_via_language_environment = false;
31206
31207 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height,
31208 doc: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31209 If a float, it specifies a fraction of the mini-window frame's height.
31210 If an integer, it specifies a number of lines. */);
31211 Vmax_mini_window_height = make_float (0.25);
31212
31213 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows,
31214 doc: /* How to resize mini-windows (the minibuffer and the echo area).
31215 A value of nil means don't automatically resize mini-windows.
31216 A value of t means resize them to fit the text displayed in them.
31217 A value of `grow-only', the default, means let mini-windows grow only;
31218 they return to their normal size when the minibuffer is closed, or the
31219 echo area becomes empty. */);
31220 Vresize_mini_windows = Qgrow_only;
31221
31222 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist,
31223 doc: /* Alist specifying how to blink the cursor off.
31224 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31225 `cursor-type' frame-parameter or variable equals ON-STATE,
31226 comparing using `equal', Emacs uses OFF-STATE to specify
31227 how to blink it off. ON-STATE and OFF-STATE are values for
31228 the `cursor-type' frame parameter.
31229
31230 If a frame's ON-STATE has no entry in this list,
31231 the frame's other specifications determine how to blink the cursor off. */);
31232 Vblink_cursor_alist = Qnil;
31233
31234 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p,
31235 doc: /* Allow or disallow automatic horizontal scrolling of windows.
31236 If non-nil, windows are automatically scrolled horizontally to make
31237 point visible. */);
31238 automatic_hscrolling_p = true;
31239 DEFSYM (Qauto_hscroll_mode, "auto-hscroll-mode");
31240
31241 DEFVAR_INT ("hscroll-margin", hscroll_margin,
31242 doc: /* How many columns away from the window edge point is allowed to get
31243 before automatic hscrolling will horizontally scroll the window. */);
31244 hscroll_margin = 5;
31245
31246 DEFVAR_LISP ("hscroll-step", Vhscroll_step,
31247 doc: /* How many columns to scroll the window when point gets too close to the edge.
31248 When point is less than `hscroll-margin' columns from the window
31249 edge, automatic hscrolling will scroll the window by the amount of columns
31250 determined by this variable. If its value is a positive integer, scroll that
31251 many columns. If it's a positive floating-point number, it specifies the
31252 fraction of the window's width to scroll. If it's nil or zero, point will be
31253 centered horizontally after the scroll. Any other value, including negative
31254 numbers, are treated as if the value were zero.
31255
31256 Automatic hscrolling always moves point outside the scroll margin, so if
31257 point was more than scroll step columns inside the margin, the window will
31258 scroll more than the value given by the scroll step.
31259
31260 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31261 and `scroll-right' overrides this variable's effect. */);
31262 Vhscroll_step = make_number (0);
31263
31264 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines,
31265 doc: /* If non-nil, messages are truncated instead of resizing the echo area.
31266 Bind this around calls to `message' to let it take effect. */);
31267 message_truncate_lines = false;
31268
31269 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook,
31270 doc: /* Normal hook run to update the menu bar definitions.
31271 Redisplay runs this hook before it redisplays the menu bar.
31272 This is used to update menus such as Buffers, whose contents depend on
31273 various data. */);
31274 Vmenu_bar_update_hook = Qnil;
31275
31276 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame,
31277 doc: /* Frame for which we are updating a menu.
31278 The enable predicate for a menu binding should check this variable. */);
31279 Vmenu_updating_frame = Qnil;
31280
31281 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update,
31282 doc: /* Non-nil means don't update menu bars. Internal use only. */);
31283 inhibit_menubar_update = false;
31284
31285 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix,
31286 doc: /* Prefix prepended to all continuation lines at display time.
31287 The value may be a string, an image, or a stretch-glyph; it is
31288 interpreted in the same way as the value of a `display' text property.
31289
31290 This variable is overridden by any `wrap-prefix' text or overlay
31291 property.
31292
31293 To add a prefix to non-continuation lines, use `line-prefix'. */);
31294 Vwrap_prefix = Qnil;
31295 DEFSYM (Qwrap_prefix, "wrap-prefix");
31296 Fmake_variable_buffer_local (Qwrap_prefix);
31297
31298 DEFVAR_LISP ("line-prefix", Vline_prefix,
31299 doc: /* Prefix prepended to all non-continuation lines at display time.
31300 The value may be a string, an image, or a stretch-glyph; it is
31301 interpreted in the same way as the value of a `display' text property.
31302
31303 This variable is overridden by any `line-prefix' text or overlay
31304 property.
31305
31306 To add a prefix to continuation lines, use `wrap-prefix'. */);
31307 Vline_prefix = Qnil;
31308 DEFSYM (Qline_prefix, "line-prefix");
31309 Fmake_variable_buffer_local (Qline_prefix);
31310
31311 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay,
31312 doc: /* Non-nil means don't eval Lisp during redisplay. */);
31313 inhibit_eval_during_redisplay = false;
31314
31315 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces,
31316 doc: /* Non-nil means don't free realized faces. Internal use only. */);
31317 inhibit_free_realized_faces = false;
31318
31319 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring,
31320 doc: /* Non-nil means don't mirror characters even when bidi context requires that.
31321 Intended for use during debugging and for testing bidi display;
31322 see biditest.el in the test suite. */);
31323 inhibit_bidi_mirroring = false;
31324
31325 #ifdef GLYPH_DEBUG
31326 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id,
31327 doc: /* Inhibit try_window_id display optimization. */);
31328 inhibit_try_window_id = false;
31329
31330 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing,
31331 doc: /* Inhibit try_window_reusing display optimization. */);
31332 inhibit_try_window_reusing = false;
31333
31334 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement,
31335 doc: /* Inhibit try_cursor_movement display optimization. */);
31336 inhibit_try_cursor_movement = false;
31337 #endif /* GLYPH_DEBUG */
31338
31339 DEFVAR_INT ("overline-margin", overline_margin,
31340 doc: /* Space between overline and text, in pixels.
31341 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31342 margin to the character height. */);
31343 overline_margin = 2;
31344
31345 DEFVAR_INT ("underline-minimum-offset",
31346 underline_minimum_offset,
31347 doc: /* Minimum distance between baseline and underline.
31348 This can improve legibility of underlined text at small font sizes,
31349 particularly when using variable `x-use-underline-position-properties'
31350 with fonts that specify an UNDERLINE_POSITION relatively close to the
31351 baseline. The default value is 1. */);
31352 underline_minimum_offset = 1;
31353
31354 DEFVAR_BOOL ("display-hourglass", display_hourglass_p,
31355 doc: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31356 This feature only works when on a window system that can change
31357 cursor shapes. */);
31358 display_hourglass_p = true;
31359
31360 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay,
31361 doc: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31362 Vhourglass_delay = make_number (DEFAULT_HOURGLASS_DELAY);
31363
31364 #ifdef HAVE_WINDOW_SYSTEM
31365 hourglass_atimer = NULL;
31366 hourglass_shown_p = false;
31367 #endif /* HAVE_WINDOW_SYSTEM */
31368
31369 /* Name of the face used to display glyphless characters. */
31370 DEFSYM (Qglyphless_char, "glyphless-char");
31371
31372 /* Method symbols for Vglyphless_char_display. */
31373 DEFSYM (Qhex_code, "hex-code");
31374 DEFSYM (Qempty_box, "empty-box");
31375 DEFSYM (Qthin_space, "thin-space");
31376 DEFSYM (Qzero_width, "zero-width");
31377
31378 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function,
31379 doc: /* Function run just before redisplay.
31380 It is called with one argument, which is the set of windows that are to
31381 be redisplayed. This set can be nil (meaning, only the selected window),
31382 or t (meaning all windows). */);
31383 Vpre_redisplay_function = intern ("ignore");
31384
31385 /* Symbol for the purpose of Vglyphless_char_display. */
31386 DEFSYM (Qglyphless_char_display, "glyphless-char-display");
31387 Fput (Qglyphless_char_display, Qchar_table_extra_slots, make_number (1));
31388
31389 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display,
31390 doc: /* Char-table defining glyphless characters.
31391 Each element, if non-nil, should be one of the following:
31392 an ASCII acronym string: display this string in a box
31393 `hex-code': display the hexadecimal code of a character in a box
31394 `empty-box': display as an empty box
31395 `thin-space': display as 1-pixel width space
31396 `zero-width': don't display
31397 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31398 display method for graphical terminals and text terminals respectively.
31399 GRAPHICAL and TEXT should each have one of the values listed above.
31400
31401 The char-table has one extra slot to control the display of a character for
31402 which no font is found. This slot only takes effect on graphical terminals.
31403 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31404 `thin-space'. The default is `empty-box'.
31405
31406 If a character has a non-nil entry in an active display table, the
31407 display table takes effect; in this case, Emacs does not consult
31408 `glyphless-char-display' at all. */);
31409 Vglyphless_char_display = Fmake_char_table (Qglyphless_char_display, Qnil);
31410 Fset_char_table_extra_slot (Vglyphless_char_display, make_number (0),
31411 Qempty_box);
31412
31413 DEFVAR_LISP ("debug-on-message", Vdebug_on_message,
31414 doc: /* If non-nil, debug if a message matching this regexp is displayed. */);
31415 Vdebug_on_message = Qnil;
31416
31417 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause,
31418 doc: /* */);
31419 Vredisplay__all_windows_cause = Fmake_hash_table (0, NULL);
31420
31421 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause,
31422 doc: /* */);
31423 Vredisplay__mode_lines_cause = Fmake_hash_table (0, NULL);
31424 }
31425
31426
31427 /* Initialize this module when Emacs starts. */
31428
31429 void
31430 init_xdisp (void)
31431 {
31432 CHARPOS (this_line_start_pos) = 0;
31433
31434 if (!noninteractive)
31435 {
31436 struct window *m = XWINDOW (minibuf_window);
31437 Lisp_Object frame = m->frame;
31438 struct frame *f = XFRAME (frame);
31439 Lisp_Object root = FRAME_ROOT_WINDOW (f);
31440 struct window *r = XWINDOW (root);
31441 int i;
31442
31443 echo_area_window = minibuf_window;
31444
31445 r->top_line = FRAME_TOP_MARGIN (f);
31446 r->pixel_top = r->top_line * FRAME_LINE_HEIGHT (f);
31447 r->total_cols = FRAME_COLS (f);
31448 r->pixel_width = r->total_cols * FRAME_COLUMN_WIDTH (f);
31449 r->total_lines = FRAME_TOTAL_LINES (f) - 1 - FRAME_TOP_MARGIN (f);
31450 r->pixel_height = r->total_lines * FRAME_LINE_HEIGHT (f);
31451
31452 m->top_line = FRAME_TOTAL_LINES (f) - 1;
31453 m->pixel_top = m->top_line * FRAME_LINE_HEIGHT (f);
31454 m->total_cols = FRAME_COLS (f);
31455 m->pixel_width = m->total_cols * FRAME_COLUMN_WIDTH (f);
31456 m->total_lines = 1;
31457 m->pixel_height = m->total_lines * FRAME_LINE_HEIGHT (f);
31458
31459 scratch_glyph_row.glyphs[TEXT_AREA] = scratch_glyphs;
31460 scratch_glyph_row.glyphs[TEXT_AREA + 1]
31461 = scratch_glyphs + MAX_SCRATCH_GLYPHS;
31462
31463 /* The default ellipsis glyphs `...'. */
31464 for (i = 0; i < 3; ++i)
31465 default_invis_vector[i] = make_number ('.');
31466 }
31467
31468 {
31469 /* Allocate the buffer for frame titles.
31470 Also used for `format-mode-line'. */
31471 int size = 100;
31472 mode_line_noprop_buf = xmalloc (size);
31473 mode_line_noprop_buf_end = mode_line_noprop_buf + size;
31474 mode_line_noprop_ptr = mode_line_noprop_buf;
31475 mode_line_target = MODE_LINE_DISPLAY;
31476 }
31477
31478 help_echo_showing_p = false;
31479 }
31480
31481 #ifdef HAVE_WINDOW_SYSTEM
31482
31483 /* Platform-independent portion of hourglass implementation. */
31484
31485 /* Timer function of hourglass_atimer. */
31486
31487 static void
31488 show_hourglass (struct atimer *timer)
31489 {
31490 /* The timer implementation will cancel this timer automatically
31491 after this function has run. Set hourglass_atimer to null
31492 so that we know the timer doesn't have to be canceled. */
31493 hourglass_atimer = NULL;
31494
31495 if (!hourglass_shown_p)
31496 {
31497 Lisp_Object tail, frame;
31498
31499 block_input ();
31500
31501 FOR_EACH_FRAME (tail, frame)
31502 {
31503 struct frame *f = XFRAME (frame);
31504
31505 if (FRAME_LIVE_P (f) && FRAME_WINDOW_P (f)
31506 && FRAME_RIF (f)->show_hourglass)
31507 FRAME_RIF (f)->show_hourglass (f);
31508 }
31509
31510 hourglass_shown_p = true;
31511 unblock_input ();
31512 }
31513 }
31514
31515 /* Cancel a currently active hourglass timer, and start a new one. */
31516
31517 void
31518 start_hourglass (void)
31519 {
31520 struct timespec delay;
31521
31522 cancel_hourglass ();
31523
31524 if (INTEGERP (Vhourglass_delay)
31525 && XINT (Vhourglass_delay) > 0)
31526 delay = make_timespec (min (XINT (Vhourglass_delay),
31527 TYPE_MAXIMUM (time_t)),
31528 0);
31529 else if (FLOATP (Vhourglass_delay)
31530 && XFLOAT_DATA (Vhourglass_delay) > 0)
31531 delay = dtotimespec (XFLOAT_DATA (Vhourglass_delay));
31532 else
31533 delay = make_timespec (DEFAULT_HOURGLASS_DELAY, 0);
31534
31535 hourglass_atimer = start_atimer (ATIMER_RELATIVE, delay,
31536 show_hourglass, NULL);
31537 }
31538
31539 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31540 shown. */
31541
31542 void
31543 cancel_hourglass (void)
31544 {
31545 if (hourglass_atimer)
31546 {
31547 cancel_atimer (hourglass_atimer);
31548 hourglass_atimer = NULL;
31549 }
31550
31551 if (hourglass_shown_p)
31552 {
31553 Lisp_Object tail, frame;
31554
31555 block_input ();
31556
31557 FOR_EACH_FRAME (tail, frame)
31558 {
31559 struct frame *f = XFRAME (frame);
31560
31561 if (FRAME_LIVE_P (f) && FRAME_WINDOW_P (f)
31562 && FRAME_RIF (f)->hide_hourglass)
31563 FRAME_RIF (f)->hide_hourglass (f);
31564 #ifdef HAVE_NTGUI
31565 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31566 else if (!FRAME_W32_P (f))
31567 w32_arrow_cursor ();
31568 #endif
31569 }
31570
31571 hourglass_shown_p = false;
31572 unblock_input ();
31573 }
31574 }
31575
31576 #endif /* HAVE_WINDOW_SYSTEM */